The Ruby Programming Language https://www.ruby-lang.org/
Find a file
Yusuke Endoh bad7ab35d1 test/lib/jit_support.rb: Let JIT tests skip on centos8
It has the same issue as RHEL 8.  k0kubun said he will fix later
2020-07-11 16:23:59 +09:00
.github Use brew upgrade instead of brew update 2020-02-20 17:08:45 +09:00
basictest Fixed misspellings 2019-12-20 09:32:42 +09:00
benchmark Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
bin Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
bootstraptest merge revision(s) 21d8e69248: 2020-07-09 20:54:28 +09:00
ccan Fix typos [ci skip] 2019-10-14 17:30:04 +09:00
coroutine coroutine/ucontext/Context.c: define __EXTENSIONS__ explicitly 2019-12-05 22:24:58 +09:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Fixed misspellings 2019-12-20 09:32:42 +09:00
doc Update documentation for Array/Hash Argument section of methods.rdoc 2020-03-13 21:31:10 +09:00
enc enc/x_emoji.h: fixed dead-links [ci skip] 2019-12-24 10:33:32 +09:00
ext OpenSSL 1.1.1 introduces a new '.include' directive. Update our config 2020-07-11 16:10:41 +09:00
gems Use power_assert 1.1.7 2020-03-26 21:18:25 +09:00
include Reword keyword arguments warning messages to convey these are deprecation warnings 2019-12-23 16:47:33 -05:00
lib merge revision(s) a19228f878: [Backport #16979] 2020-06-27 12:29:42 +09:00
libexec Fixed misspellings 2019-12-20 12:19:45 +09:00
man Merge bundler-2.1.4 2020-03-27 14:43:20 +09:00
misc Fixed misspellings 2019-12-20 09:32:42 +09:00
missing Get rid of false positive misspellings 2019-12-24 10:33:32 +09:00
sample Fixed misspellings 2019-12-20 09:32:42 +09:00
spec Merge bundler-2.1.4 2020-03-27 14:43:20 +09:00
template remove prelude.c 2019-12-11 11:24:42 +09:00
test test/lib/jit_support.rb: Let JIT tests skip on centos8 2020-07-11 16:23:59 +09:00
tool Bison 3.59.1 folds yydestruct function header 2020-07-10 08:50:41 +09:00
win32 Fixed misspellings 2019-12-20 09:32:42 +09:00
.dir-locals.el add .dir-locals.el [ci skip] 2018-12-27 06:11:09 +00:00
.document Added warning.rb to .document 2019-12-24 13:12:28 +09:00
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Prefix global_symbols with ruby_ 2019-05-16 15:43:16 +09:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Check -1 arity for C++ 2019-11-22 18:42:49 +09:00
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Fix .travis.yml to keep s390x-linux as allow_features 2019-12-11 21:54:18 +09:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c retrieve current path on macOS 2019-08-20 02:05:10 +09:00
addr2line.h Support Mach-O on backtrace with DWARF 2018-10-20 06:35:25 +00:00
appveyor.yml Drop MinGW build from AppVeyor 2020-03-14 16:32:29 +09:00
array.c make functions static 2019-11-19 12:36:19 +09:00
ast.c Revert "Method reference operator" 2019-11-12 17:24:48 +09:00
ast.rb Improve highlighting in RubyVM::AbstractSyntaxTree docs when using ri 2019-12-14 12:26:30 +01:00
bignum.c make functions static 2019-11-19 12:36:19 +09:00
BSDL
builtin.c take care of USE_LAZY_LOAD=1. 2019-12-25 14:12:33 +09:00
builtin.h readable function names for inline functions. 2019-12-13 17:55:45 +09:00
class.c Reword keyword arguments warning messages to convey these are deprecation warnings 2019-12-23 16:47:33 -05:00
common.mk Fixed symbol misused as ID 2020-03-14 16:00:46 +09:00
compar.c [DOC] Improve readability of requirements for <=> 2019-12-23 15:02:59 +01:00
compile.c export a function for MJIT. 2019-12-25 14:37:53 +09:00
complex.c Improve consistency of bool/true/false 2019-11-25 15:09:09 +09:00
configure.ac merge revision(s) 75802bcff1: 2020-07-05 07:03:14 +09:00
constant.h delete unused functions 2019-11-14 20:35:48 +09:00
cont.c Prevent unloading methods used in root_fiber while calling another Fiber (#2939) 2020-03-15 19:35:24 +09:00
CONTRIBUTING.md
COPYING COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
COPYING.ja COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
debug.c add additional CF info for CI env 2019-12-05 14:47:31 +09:00
debug_counter.c add debug_counter access functions. 2019-12-25 01:34:41 +09:00
debug_counter.h add debug_counter access functions. 2019-12-25 01:34:41 +09:00
dir.c [DOC] Added File::FNM_SYSCASE example [Bug #16391] [ci skip] 2019-12-04 21:52:29 +09:00
dln.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c [Doc] Fix sample in Encoding#names 2019-12-22 23:01:45 +09:00
enum.c [DOC] Improve documentation for Enumerable#tally 2019-12-22 22:36:14 +01:00
enumerator.c [DOC] Improve docs for Enumerator.produce, Enumerator.new 2019-12-24 09:03:42 +01:00
error.c Fix FrozenError#receiver and #initialize docs 2019-12-22 23:17:39 +09:00
eval.c Clear all trace events during teardown 2020-03-30 19:15:11 +09:00
eval_error.c Renamed ruby_finalize_{0,1} 2019-08-13 09:47:08 +09:00
eval_intern.h Create backtrace location array directly 2019-12-13 20:47:07 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c Revert "Should return "." for File.extname("file.") also on Windows" 2019-12-23 11:54:25 +09:00
gc.c Separate objspace argument for rb_gc_disable and rb_gc_enable 2020-03-13 22:08:42 +09:00
gc.h gc.h: Add SET_MACHINE_STACK_END specific for Powerpc64 (#1767) 2019-12-16 10:05:21 +09:00
gc.rb fix line break code (fix to LF) 2019-11-08 15:32:01 +09:00
gem_prelude.rb Do not call 'gem "did_you_mean"' for now 2019-11-30 21:08:19 -05:00
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c
GPL
hash.c check ar_table first. 2020-03-26 21:18:26 +09:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
id_table.c Revert https://github.com/ruby/ruby/pull/2486 2019-10-03 12:45:24 +09:00
id_table.h Revert https://github.com/ruby/ruby/pull/2486 2019-10-03 12:45:24 +09:00
inits.c Moved Kernel#warn to warning.rb 2019-12-13 20:47:07 +09:00
insns.def Introduce an "Inline IVAR cache" struct 2019-12-05 13:37:02 -08:00
internal.h Prevent unloading methods used in root_fiber while calling another Fiber (#2939) 2020-03-15 19:35:24 +09:00
io.c Pass keyword arguments to IOs properly [Bug #16639] 2020-03-13 23:27:19 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c Fixed misspellings 2019-12-20 09:32:42 +09:00
iseq.h vm_args.c (rb_warn_check): Use iseq_unique_id instead of its pointer 2019-12-09 15:22:48 +09:00
KNOWNBUGS.rb
LEGAL Split procstat_vm.c 2019-02-07 08:53:13 +00:00
lex.c.blt
load.c Add the loaded feature after no exception raised 2020-03-13 22:34:09 +09:00
loadpath.c
localeinit.c
main.c main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
math.c [DOC] Fix wording in Math::E documentation 2019-12-24 00:13:46 +01:00
method.h per-method serial number 2019-12-18 12:52:28 +09:00
mini_builtin.c readable function names for inline functions. 2019-12-13 17:55:45 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c Prevent unloading methods used in root_fiber while calling another Fiber (#2939) 2020-03-15 19:35:24 +09:00
mjit.h Constified mjit_init 2019-12-01 20:26:28 +09:00
mjit_compile.c Add a proper cast to pass JIT tests on mswin. 2019-11-21 04:38:40 +09:00
mjit_worker.c Allow specifying arbitrary MJIT flags by --jit-debug 2019-12-01 00:58:47 -08:00
NEWS Add readline and readline-ext to default gems list in NEWS 2019-12-25 12:55:53 +09:00
node.c Revert "Method reference operator" 2019-11-12 17:24:48 +09:00
node.h Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
numeric.c make functions static 2019-11-19 12:36:19 +09:00
object.c Object#=~ warning also obeys Warning[:deprecated] 2019-12-24 18:53:14 +09:00
pack.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y Bison 3.5.91 now defaults parse.error to "simple" 2020-07-10 08:50:41 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d
probes_helper.h
proc.c merge revision(s) ac2106acc276854ae2ac8cc5fa6859aa28362f2f,cf90df22c74da2f87421749e8d065cfbd3812afd: [Backport #16813] 2020-06-07 12:04:23 +09:00
process.c Restart timer thread even after preparation failed 2020-02-13 13:50:57 +09:00
random.c rand(beginless_range) raise Errno::EDOM instead of TypeError 2019-12-15 14:47:36 +09:00
range.c range.c: Range#min with a beginless one now raise an explicit exception 2019-12-25 13:36:23 +09:00
rational.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
re.c Regexp in MatchData can be nil 2020-01-16 15:26:28 +09:00
README.EXT
README.EXT.ja
README.ja.md Add badge of Cygwin 2019-12-09 16:08:12 +09:00
README.md Add badge of Cygwin 2019-12-09 16:08:12 +09:00
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 2018-09-15 09:59:14 +00:00
regenc.c
regenc.h
regerror.c Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h
regsyntax.c
ruby-runner.c Fix warnings 2019-08-28 16:51:48 +09:00
ruby.c Added -W:experimental to --help [Feature #16420] 2019-12-24 12:11:42 +09:00
ruby_assert.h respect NDEBUG. 2019-07-19 12:04:32 +09:00
ruby_atomic.h
rubystub.c
safe.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
signal.c Deprecate rb_eval_cmd, add rb_eval_cmd_kw 2019-11-18 01:00:25 +02:00
siphash.c
siphash.h blacklist UBSAN's unsigned integer overflow 2018-11-07 04:09:05 +00:00
sparc.c
sprintf.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
st.c Fixed misspellings 2019-12-20 09:32:42 +09:00
strftime.c Prefer rb_fstring_lit over rb_fstring_cstr 2018-10-13 09:59:22 +00:00
string.c Refined the warning message for $, and $; 2019-12-20 15:09:23 +09:00
struct.c Avoid needless object allocation 2019-11-19 08:53:01 -06:00
symbol.c delete unused functions 2019-11-14 20:35:48 +09:00
symbol.h Add RB_ID_SERIAL_MAX 2019-04-25 13:22:06 +09:00
thread.c check flags passed to rb_nogvl() 2020-03-26 21:18:26 +09:00
thread_pthread.c rb_thread_create now free from ANYARGS 2019-08-27 15:52:26 +09:00
thread_pthread.h thread_pthread.h: rename gvl.acquired' to gvl.owner' and document 2018-08-28 00:24:08 +00:00
thread_sync.c add assertion for mutex_lock. 2019-10-28 12:19:18 +09:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c [DOC] Fix typo in Time#inspect 2019-12-24 21:50:27 +01:00
timev.h timev.h: dummy definition for TAGS 2019-04-10 12:43:31 +00:00
trace_point.rb Make TracePoint.stat a singleton method again (#2726) 2019-12-04 21:02:21 -05:00
transcode.c Fixed symbol misused as ID 2020-03-14 16:00:46 +09:00
transcode_data.h
transient_heap.c rb_aligned_malloc can return NULL 2019-11-01 16:58:19 +09:00
transient_heap.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
util.c Split dtoa.c 2019-02-07 08:53:11 +00:00
variable.c Enhance docs for Module#deprecate_constant 2019-12-22 23:17:39 +09:00
variable.h fastpath for ivar read of FL_EXIVAR objects. 2019-11-29 03:11:04 +09:00
version.c Provides ruby2_keywords 2019-10-23 00:19:25 +09:00
version.h OpenSSL 1.1.1 introduces a new '.include' directive. Update our config 2020-07-11 16:10:41 +09:00
vm.c Disable GC until VM objects get initialized [Bug #16616] 2020-03-13 21:51:06 +09:00
vm_args.c Do not autosplat when calling proc with empty keyword splat 2020-03-15 20:52:43 +09:00
vm_backtrace.c Create backtrace location array directly 2019-12-13 20:47:07 +09:00
vm_core.h Kernel#lambda: return forwarded block as non-lambda proc 2019-12-21 09:08:52 -05:00
vm_debug.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +09:00
vm_dump.c Fixed misspellings 2019-12-20 09:32:42 +09:00
vm_eval.c script_compiled event on compile error. 2020-01-16 15:08:36 +09:00
vm_exec.c
vm_exec.h Fixed format specifiers 2019-09-20 23:57:20 +09:00
vm_insnhelper.c Fixed misspellings 2019-12-20 09:32:42 +09:00
vm_insnhelper.h per-method serial number 2019-12-18 12:52:28 +09:00
vm_method.c per-method serial number 2019-12-18 12:52:28 +09:00
vm_opts.h Use cppflags to pass preprocessor options 2019-10-23 02:53:36 +09:00
vm_trace.c Clear all trace events during teardown 2020-03-30 19:15:11 +09:00
vsnprintf.c Use array indexing with considering clang's feeling 2019-08-27 14:25:58 +09:00
warning.rb Fix visibility as module_function 2019-12-13 20:51:58 +09:00

Build Status Build 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, Haiku, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#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 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.

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. If ./configure does not exist or is older than configure.ac, run autoconf to (re)generate configure.

  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 defines.h if you need. Usually this step will not be needed.

  5. Remove comment mark(#) before the module names from ext/Setup (or add module names if not present), if you want to link modules statically.

    If you don't want to compile non static extension modules (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. Optionally, run make update-gems and make extract-gems.

    If you want to install bundled gems, run make update-gems and make extract-gems before running make install.

  9. 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 (https://www.ruby-lang.org/en/community/mailing-lists) 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