1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
2022-02-01 20:04:15 +09:00
.github [wasm] skip pull-requests labeled as Documentation [ci skip] 2022-01-20 13:18:33 +09:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark
bin
bootstraptest refactoring btest output 2022-01-26 09:56:27 +09:00
ccan
coroutine [wasm] add coroutine/asyncify implementation 2022-01-19 11:19:06 +09:00
coverage
cygwin
defs Add a Module#const_added callback 2022-01-14 11:30:07 +01:00
doc [DOC] Fix case for new sentence. 2022-01-31 07:59:10 +09:00
enc
ext [ruby/io-wait] Exclude rake files from packages 2022-02-01 20:04:15 +09:00
gems Update RBS test for Gem::Version#<=> update 2022-01-14 15:26:49 +09:00
include Mark rb_clear_constant_cache as internal use only 2022-01-20 13:54:37 +09:00
internal Mark rb_clear_constant_cache as internal use only 2022-01-20 13:54:37 +09:00
lib Sync latest Bundler & RubyGems 2022-02-01 08:09:23 +09:00
libexec [ruby/irb] require_relative can't be used for default gems' exe files 2022-01-18 15:56:48 +09:00
man
misc [lldb] Handle MacOS 64Kb heap pages in the lldb helpers 2022-01-26 15:28:09 -05:00
missing [wasm] wasm/missing.{c,h}: add missing libc stubs for wasi-libc 2022-01-19 11:19:06 +09:00
sample
spec Sync latest Bundler & RubyGems 2022-02-01 08:09:23 +09:00
template [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
test Restore workaround for test_rubygems.rb, It still fails with chkbuild encironment 2022-02-01 12:21:53 +09:00
tool Sync latest Bundler & RubyGems 2022-02-01 08:09:23 +09:00
wasm * expand tabs. [ci skip] 2022-01-19 11:19:20 +09:00
win32 Fixed an missing percent in the batch file 2022-01-24 18:10:17 +09:00
.appveyor.yml
.cirrus.yml
.dir-locals.el
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore [wasm] add unit test suite for fiber, register scan, sjlj in platform dir 2022-01-19 11:19:06 +09:00
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c
addr2line.h
array.c
array.rb
ast.c
ast.rb
autogen.sh
bignum.c
BSDL
builtin.c
builtin.h
class.c Fix the placeholder subclass entry skipping [Bug #18489] 2022-01-17 21:23:40 +09:00
common.mk Try make this more readable and consistent with other targets 2022-02-01 08:09:23 +09:00
compar.c
compile.c Fix constant assignment evaluation order 2022-01-14 11:00:26 -08:00
complex.c
configure.ac Check if execv is available for ruby/missing.h 2022-01-26 18:23:51 +09:00
constant.h
cont.c rb_fiber_terminate must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
darray.h
debug.c
debug_counter.c
debug_counter.h
dir.c dir.c: ignore ENOTCAPABLE while glob similar to EACCES 2022-01-19 11:19:06 +09:00
dir.rb
dln.c Fix warnings 2022-01-20 10:03:59 +09:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c
enumerator.c
error.c
eval.c
eval_error.c
eval_intern.h rb_fiber_terminate must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
eval_jump.c
file.c File rdoc (#5438) 2022-01-13 18:00:24 -06:00
gc.c Fix heap page iteration in gc_verify_heap_page 2022-01-31 09:42:20 -05:00
gc.h
gc.rb
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Make Hash#shift return nil for empty hash 2022-01-14 12:17:57 -08:00
hrtime.h
id_table.c Support ID_TABLE_STOP for replace function 2022-01-25 16:51:16 -05:00
id_table.h Rename rb_id_table_foreach_with_replace 2022-01-25 16:51:16 -05:00
inits.c
insns.def
internal.h
io.c [DOC] Enhanced RDoc for io.c (#5460) 2022-01-30 16:17:53 -06:00
io.rb
io_buffer.c
iseq.c
iseq.h
kernel.rb
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
loadpath.c
localeinit.c
main.c [wasm] add asyncify based setjmp, fiber, register scan emulation 2022-01-19 11:19:06 +09:00
marshal.c
marshal.rb
math.c
memory_view.c
method.h Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
mini_builtin.c
miniinit.c
mjit.c Transfer the responsibility for MJIT options to mjit.c 2022-01-15 18:57:33 +09:00
mjit.h
mjit_compile.c
mjit_worker.c
NEWS.md Update default gems list at fc4fbeef28 [ci skip] 2022-02-01 04:22:40 +00:00
nilclass.rb
node.c
node.h
numeric.c Shifting zero always results in zero [Bug #18517] 2022-01-27 14:00:33 +09:00
numeric.rb
object.c Add a Module#const_added callback 2022-01-14 11:30:07 +01:00
pack.c
pack.rb
parse.y
prelude.rb
probes.d
probes_helper.h
proc.c Fix {Method,UnboundMethod}#{public?,private?,protected?} for ZSUPER methods 2022-01-14 13:46:18 -08:00
process.c Accurately report VM memsize 2022-01-21 14:34:53 -08:00
ractor.c
ractor.rb
ractor_core.h
random.c [DOC] Mark up the code for Kernel#rand as the same as Random#rand 2022-01-13 11:34:09 +09:00
range.c
rational.c
re.c Replace to RBOOL macro 2022-01-17 13:49:37 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c ruby.c: initialize extra optional extensions linked statically 2022-01-19 11:19:06 +09:00
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c
struct.c
symbol.c
symbol.h
thread.c Accurately report VM memsize 2022-01-21 14:34:53 -08:00
thread_none.c [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_none.h [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_pthread.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +09:00
thread_pthread.h
thread_sync.c
thread_win32.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +09:00
thread_win32.h
time.c
timev.h
timev.rb
trace_point.rb
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h
util.c
variable.c variable.c: Fix incorrect identation in const_added 2022-01-14 16:22:57 +01:00
variable.h
version.c
version.h * 2022-02-01 [ci skip] 2022-02-01 05:20:53 +09:00
vm.c Fix error: old-style function definition 2022-01-22 15:48:05 +09:00
vm_args.c
vm_backtrace.c
vm_callinfo.h Remove a typo hash [ci skip] 2022-01-29 15:33:13 +09:00
vm_core.h [wasm] eval_inter.h gc.c vm_core.h: include wasm/setjmp.h instead of sysroot header 2022-01-19 11:19:06 +09:00
vm_debug.h
vm_dump.c enable RUBY_ON_BUG on release build 2022-01-25 16:43:57 +09:00
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c Streamline cached attr reader / writer indexes 2022-01-26 09:02:59 -08:00
vm_insnhelper.h
vm_method.c Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
vm_opts.h
vm_sync.c
vm_sync.h
vm_trace.c Fix error: old-style function definition 2022-01-22 15:48:05 +09:00
vsnprintf.c [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
warning.rb
yjit.c
yjit.h
yjit.rb
yjit_asm.c
yjit_asm.h
yjit_codegen.c Suppress unary minus operator to unsigned type warnings 2022-01-14 13:46:12 +09:00
yjit_codegen.h
yjit_core.c
yjit_core.h
yjit_iface.c
yjit_iface.h
yjit_utils.c

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus Status

What's Ruby

Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. mix-in, singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers

How to get Ruby

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

https://www.ruby-lang.org/en/downloads/

Git

The mirror of the Ruby source tree can be checked out with the following command:

$ git clone https://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

$ git ls-remote https://github.com/ruby/ruby.git

You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.

Subversion

Stable branches for older Ruby versions can be checked out with also the following command:

$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby

Try the following command to see the list of branches:

$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/

Ruby home page

https://www.ruby-lang.org/

Mailing list

There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

How to compile and install

  1. If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.

  2. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

  3. Run ./configure, which will generate config.h and Makefile.

    Some C compiler flags may be added by default depending on your environment. Specify optflags=.. and warnflags=.. as necessary to override them.

  4. Edit include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (probably on architectures which do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

    • On Mac, set RUBY_CODESIGN environment variable with a signing identity. It uses the identity to sign ruby binary. See also codesign(1).
  7. Optionally, run 'make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your Ruby works as it should (hopefully).

  8. Run 'make install'.

    This command will create the following directories and install files into them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib
    • ${DESTDIR}${prefix}/lib/ruby
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
    • ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/share/man/man1
    • ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system

    If Ruby's API version is 'x.y.z', the ${MAJOR} is 'x', the ${MINOR} is 'y', and the ${TEENY} is 'z'.

    NOTE: teeny of the API version may be different from one of Ruby's program version

    You may have to be a super user to install Ruby.

If you fail to compile Ruby, please send the detailed error report with the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of necessary external libraries and/or headers, then you will need to run 'make distclean-ext' to remove old configuration after installing them in such case.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.

Bugs should be reported at https://bugs.ruby-lang.org. Read HowToReport for more information.

Contributing

See the file CONTRIBUTING.md

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

matz@ruby-lang.org