The Ruby Programming Language [mirror]
Go to file
Burdette Lamar b074bc3d61
[DOC] Enhanced RDoc for MatchData (#5819)
Treats:
    #begin
    #end
    #match
    #match_length
2022-04-18 13:02:35 -05:00
.github Fix build errors with development version of Clang 2022-04-14 15:47:27 -04:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark Finer-grained constant cache invalidation (take 2) 2022-04-01 14:48:22 -04:00
bin
bootstraptest Raise RuntimeError if Kernel#binding is called from a non-Ruby frame 2022-04-06 19:14:03 -07:00
ccan Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
coroutine [wasm] add coroutine/asyncify implementation 2022-01-19 11:19:06 +09:00
coverage
cygwin
defs Obey spec file locations to rubygems 2022-04-07 09:47:10 +09:00
doc [DOC] Enhanced RDoc for MatchData (#5819) 2022-04-18 13:02:35 -05:00
enc Remove Unicode 13.0.0 related files 2022-03-16 08:30:04 +09:00
ext [ruby/bigdecimal] Fix docs 2022-04-18 10:29:25 +09:00
gems Bundle RBS 2.3.2 (#5762) 2022-04-06 23:57:00 +09:00
include [DOC] add missing size params in fiber scheduler.h (#5441) 2022-04-14 07:34:49 +12:00
internal Finer-grained constant cache invalidation (take 2) 2022-04-01 14:48:22 -04:00
lib [ruby/tsort] Small tweaks for easier vendoring 2022-04-18 09:40:07 +09:00
libexec [rubygems/rubygems] Remove extra closing bracket in version warning 2022-03-14 05:43:17 +09:00
man
misc Make heap page sizes 64KiB by default 2022-04-04 09:27:14 -04:00
missing Fix dtoa buffer overrun 2022-04-12 21:30:49 +09:00
sample Remove obsolete Fixnum and Bignum 2021-12-28 18:35:03 +09:00
spec Fix a typo 2022-04-17 20:57:46 +09:00
template Fix fake.rb RUBY_DESCRIPTION faking for JITs 2022-04-11 13:28:07 -04:00
test Fix class ancestry checks for duped classes 2022-04-16 11:40:56 -07:00
tool Extract `pipe_readlines` method which reads from the pipeline 2022-04-16 17:13:24 +09:00
wasm wasm/README.md: add manual config.guess download and autoconf steps 2022-03-15 10:25:12 +09:00
win32 [Win32] Fix mode of character/pipe device stat [Bug #18732] 2022-04-15 17:14:29 +09:00
.appveyor.yml Update zlib version to 1.2.12 2022-03-28 17:28:01 +09:00
.cirrus.yml [DOC] Fix ghcr link 2022-03-31 08:35:39 +09:00
.dir-locals.el
.document All-in-one RDoc for class String (#5777) 2022-04-07 14:29:04 -05:00
.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
.rdoc_options [DOC] Set the documentation title and main page 2022-02-21 13:08:06 +09:00
.rspec_parallel
.travis.yml Remove gdbm related code from Travis CI 2022-03-04 18:09:34 +09:00
BSDL
CONTRIBUTING.md
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb
LEGAL
NEWS.md Update default gems list at 2aca566a10 [ci skip] 2022-04-15 21:35:19 +00:00
README.EXT
README.EXT.ja
README.ja.md Update badges from README.md [ci skip] 2021-12-24 09:05:12 +09:00
README.md Fixes grammar 2022-04-18 09:18:23 +09:00
aclocal.m4
addr2line.c
addr2line.h
array.c Correct whitespace in array.c (#5791) 2022-04-11 15:23:25 -05:00
array.rb
ast.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
ast.rb
autogen.sh
bignum.c [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
builtin.c
builtin.h
class.c Fix class ancestry checks for duped classes 2022-04-16 11:40:56 -07:00
common.mk Obey spec file locations to rubygems 2022-04-07 09:47:10 +09:00
compar.c [DOC] Use simple references to operator methods 2022-03-30 10:54:52 +09:00
compile.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
complex.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
configure.ac [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
constant.h
cont.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
darray.h Change feature_index from fake Array to darray 2022-02-16 09:50:29 -05:00
debug.c `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
debug_counter.c
debug_counter.h
dir.c dir.c: refresh pathtype when emulating `IFTODT` in `glob_helper` 2022-04-03 01:13:16 +09:00
dir.rb Repair format for What's Here in Dir (#5737) 2022-03-30 14:14:36 -05:00
dln.c Only define RUBY_DLN_CHECK_ABI when supported 2022-03-01 09:44:39 -05:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c [DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc (#5748) 2022-04-01 20:41:04 -05:00
enum.c [DOC] Repair format and links in What's Here sections (#5711) 2022-03-25 10:52:06 -05:00
enumerator.c
error.c Factor a "highlight" symbol out 2022-02-22 11:55:40 +09:00
eval.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
eval_error.c Remove unneeded newline from detailed_message 2022-02-22 11:55:40 +09:00
eval_intern.h `rb_fiber_terminate` must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
eval_jump.c
file.c [DOC] Use consistent terms [Bug #18680] 2022-04-18 17:53:05 +09:00
gc.c Parenthize macro arguments 2022-04-13 22:55:20 +09:00
gc.h Add the size pool slot size to the output of ObjectSpace.dump/dump_all 2022-02-03 15:07:35 -05:00
gc.rb [Feature #18364] Add GC.stat_heap to get stats for memory heaps 2022-01-04 09:46:36 -05:00
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c [DOC] Use simple references to operator methods 2022-03-26 21:13:16 +09:00
hrtime.h thread.c: Move double2hrtime and hrtime2double to hrtime.h 2022-03-30 16:50:46 +09:00
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 RubyVM.stat constant cache metrics (#5766) 2022-04-05 16:37:00 -04:00
internal.h
io.c [ci skip] Fix docs 2022-04-13 10:43:23 -04:00
io.rb
io_buffer.c io_buffer.c: use mremap based resizing only when mremap available 2022-01-07 02:13:19 +09:00
iseq.c Adjust indent [ci skip] 2022-04-02 14:54:37 +09:00
iseq.h Finer-grained constant cache invalidation (take 2) 2022-04-01 14:48:22 -04:00
kernel.rb
lex.c.blt
load.c rb_provide_feature: Prevent $LOADED_FEATURES from being copied 2022-02-23 16:58:48 +01:00
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 Fix typos [ci skip] 2021-12-25 10:33:49 +09:00
marshal.rb [DOC] Document Marshal#load parameter freeze: (#5332) 2021-12-24 09:55:09 +01:00
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 Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
mjit.h Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
mjit_compile.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
mjit_worker.c Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
nilclass.rb
node.c
node.h
numeric.c Use correct capitalization of "NaN" in docs 2022-04-13 15:44:36 -04:00
numeric.rb Add examples for Integer.try_convert [ci skip] 2021-12-15 02:12:37 +09:00
object.c [DOC] Enhance documentation for `Module#<` & `Module#>` 2022-04-14 08:52:22 -04:00
pack.c
pack.rb [DOC] Repair format and links in What's Here sections (#5711) 2022-03-25 10:52:06 -05:00
parse.y Fix the wrong index of the previous component [Bug #18739] 2022-04-18 18:37:09 +09:00
prelude.rb Make Set a builtin feature [Feature #16989] 2022-02-18 11:56:24 +09:00
probes.d
probes_helper.h
proc.c [DOC] Move the documentations of moved Symbol methods 2022-04-14 11:17:37 +09:00
process.c [ci skip] Fix docs 2022-04-13 10:43:23 -04:00
ractor.c Get rid of type-punning pointer casts 2022-04-07 19:19:13 +09:00
ractor.rb
ractor_core.h internal/ractor.h: Added 2022-03-30 16:50:46 +09:00
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 Repaired What's Here sections for Range, String, Symbol, Struct (#5735) 2022-03-30 13:46:24 -05:00
rational.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
re.c [DOC] Enhanced RDoc for MatchData (#5819) 2022-04-18 13:02:35 -05:00
regcomp.c Just free compiled pattern if no space is used 2022-04-12 20:24:14 +09:00
regenc.c
regenc.h Move ruby.h in `#ifdef RUBY` block 2022-03-11 15:08:23 +09:00
regerror.c
regexec.c re.c: Add Regexp.timeout= and Regexp.timeout 2022-03-30 16:50:46 +09:00
regint.h re.c: Add Regexp.timeout= and Regexp.timeout 2022-03-30 16:50:46 +09:00
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 Add fiber scheduler hooks for `pread`/`pwrite`, and add support to `IO::Buffer`. 2021-12-23 12:20:09 +13:00
signal.c
siphash.c
siphash.h
sparc.c [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
sprintf.c
st.c st.c: Fix a typo in a comment 2022-02-28 11:40:25 +09:00
strftime.c
string.c [DOC] Move the documentations of moved Symbol methods 2022-04-14 11:17:37 +09:00
string.rb All-in-one RDoc for class String (#5777) 2022-04-07 14:29:04 -05:00
struct.c [ci skip] Fix docs 2022-04-13 10:43:23 -04:00
symbol.c [DOC] Move the documentations of moved Symbol methods 2022-04-14 11:17:37 +09:00
symbol.h
thread.c [DOC] Fix SymbolVariantsRelNotes link 2022-04-14 10:16:45 +09: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 fix to use `node.gvl` instead of `node.ubf` 2022-04-14 21:22:47 +09:00
thread_pthread.h Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
thread_sync.c Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
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 [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
timev.h
timev.rb [DOC] prefer rdoc references over generated URLs 2022-02-19 15:14:01 +09:00
trace_point.rb Fix comment 2022-03-29 18:14:33 -07:00
transcode.c [DOC] Place a non-US-ASCII document in a document-specific script 2022-02-26 16:23:04 +09:00
transcode_data.h
transient_heap.c `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
transient_heap.h
util.c
variable.c call `const_added` after `autoload` 2022-04-08 21:30:32 +09:00
variable.h
version.c
version.h * 2022-04-19 [ci skip] 2022-04-19 00:45:58 +09:00
vm.c Raise RuntimeError if Kernel#binding is called from a non-Ruby frame 2022-04-06 19:14:03 -07:00
vm_args.c Unflag a splatted flagged hash if the method doesn't use ruby2_keywords 2022-04-05 11:42:02 +02:00
vm_backtrace.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
vm_callinfo.h Remove a typo hash [ci skip] 2022-01-29 15:33:13 +09:00
vm_core.h Finer-grained constant cache invalidation (take 2) 2022-04-01 14:48:22 -04:00
vm_debug.h `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
vm_dump.c [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
vm_eval.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
vm_exec.c
vm_exec.h Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
vm_insnhelper.c sync `vm->constant_cache` 2022-04-08 13:31:28 +09:00
vm_insnhelper.h RubyVM.stat constant cache metrics (#5766) 2022-04-05 16:37:00 -04:00
vm_method.c Get rid of type-punning pointer casts 2022-04-07 19:19:13 +09:00
vm_opts.h
vm_sync.c Prefix ccan headers (#4568) 2022-03-30 20:36:31 +13:00
vm_sync.h `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
vm_trace.c Raise RuntimeError if Kernel#binding is called from a non-Ruby frame 2022-04-06 19:14:03 -07:00
vsnprintf.c [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
warning.rb
yjit.c YJIT: Add support for ruby array cfuncs (argc=-2) 2022-01-08 11:40:55 -08:00
yjit.h re-enabled YJIT on x64-mswin64 2021-12-31 20:13:11 +09:00
yjit.rb Prefer RBOOL 2022-01-01 17:02:04 +09:00
yjit_asm.c Tiny mmap emulation for Windows 2021-12-27 15:56:23 +09:00
yjit_asm.h
yjit_codegen.c Get rid of type-punning pointer casts 2022-04-07 19:19:13 +09:00
yjit_codegen.h
yjit_core.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
yjit_core.h YJIT: Remove unused branch_t::src_ctx field 2021-12-15 16:13:23 -05:00
yjit_iface.c Add ISEQ_BODY macro 2022-03-24 10:03:51 -04:00
yjit_iface.h
yjit_utils.c

README.md

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

What is 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. You will need to run 'make distclean-ext' to remove old configuration after installing them in such a 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