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
2020-08-18 19:09:43 +09:00
.github .github/workflows/compilers.yml: clang-12 2020-08-11 16:51:07 +09:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark Improved Enumerable::Lazy#zip 2020-07-23 16:57:26 +09:00
bin Removed the old executables of racc 2020-01-01 07:42:42 +09:00
bootstraptest display stderr output even if core dump files 2020-07-29 18:45:39 +09:00
ccan
coroutine Prefix export symbol prefix to coroutine_transfer 2020-07-05 17:27:12 +09:00
coverage
cygwin Merged recipes for the same target 2020-05-27 13:13:12 +09:00
defs Escape # for GNU make 3 2020-07-05 19:15:03 +09:00
doc [DOC] fixed the method name 2020-08-14 16:33:47 +09:00
enc Use https instead of http 2020-07-28 19:51:54 +09:00
ext Fix method name escaping in ObjectSpace.dump 2020-08-17 09:47:53 -07:00
gems Updated bundled gems 2020-07-05 19:00:46 +09:00
include RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
internal Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
lib [ruby/reline] Use the standard SPDX ID for license in gemspec 2020-08-18 19:09:43 +09:00
libexec Sync Bundler PR #3624 with HEAD commits 2020-05-22 20:32:30 +09:00
man [rubygems/rubygems] July man pages 2020-07-15 16:05:12 +09:00
misc lldb_cruby.py: show the sign of Bignum [ci skip] 2020-06-23 15:56:59 +09:00
missing sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
sample Use https instead of http 2020-07-28 19:51:54 +09:00
spec [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
template template/prelude.c.tmpl: suppress clang-12 warning 2020-08-11 16:51:07 +09:00
test [ruby/reline] Keep original characters in inputrc 2020-08-18 19:08:40 +09:00
tool Use colorize.rb for non-capable terminals 2020-08-11 18:35:08 +09:00
util [rubygems/rubygems] Extend the script to allow reverting the patch when tried locally 2020-07-31 21:07:19 +09:00
win32 Use https instead of http 2020-07-28 19:51:54 +09:00
.dir-locals.el emacs mode addition 2020-02-06 11:46:51 +09:00
.document Make Integer#zero? a separated method and builtin (#3226) 2020-06-20 14:55:09 -07:00
.editorconfig
.gdbinit .gdbinit: struct RHash::basic is not a pointer 2020-06-12 10:35:44 +09:00
.gitattributes
.gitignore Ignore rbenv version file, and moved dot files [ci skip] 2020-07-04 22:04:46 +09:00
.rspec_parallel
.travis.yml Just update sources in CI without fetching 2020-06-16 12:15:55 +09:00
aclocal.m4 Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
addr2line.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
addr2line.h add #include guard hack 2020-04-13 16:06:00 +09:00
appveyor.yml Just update sources in CI without fetching 2020-06-16 12:15:55 +09:00
array.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
array.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
ast.c Hoisted out functions for no name rest argument symbol 2020-07-08 18:35:46 +09:00
ast.rb Fix RubyVM::AbstractSyntaxTree document 2020-06-24 15:17:53 +09:00
bignum.c Use https instead of http 2020-07-28 19:51:54 +09:00
BSDL [ruby/irb] Reformat LICENSE.txt [ci skip] 2020-02-02 03:22:51 +09:00
builtin.c builtin_lookup: do not goto into a branch 2020-06-29 11:05:41 +09:00
builtin.h skip inlining cexpr! that are not attr! inline 2020-07-16 11:49:09 +09:00
class.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
common.mk tool/update-deps --fix 2020-08-15 12:09:26 +09:00
compar.c cmp_clamp: do not goto into a branch 2020-06-29 11:05:41 +09:00
compile.c procnames-start-lines [ci skip] 2020-08-17 14:27:34 +09:00
complex.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
configure.ac Share the size for sigaltstack between configure.ac and signal.c 2020-07-22 21:28:23 +09:00
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c Expose ec -> backtrace (internal) and use it to implement fiber backtrace. 2020-08-18 00:56:35 +12:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c ruby_debug_log: suppress warning 2020-08-13 10:14:20 +09:00
debug_counter.c Avoid doubly showing debug counters 2020-03-15 02:25:47 -07:00
debug_counter.h Explicit conversion to boolean to suppress shorten-64-to-32 warnings 2020-07-10 13:02:31 +09:00
dir.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
dir.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
dln.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
dln.h dln.h: delete unused codes 2020-07-23 14:30:12 +09:00
dln_find.c dln_find_1: do not goto into a branch 2020-06-29 11:05:41 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h add #include guard hack 2020-04-13 16:06:00 +09:00
encoding.c Fallback to built-in UTF-8 for miniruby 2020-05-16 17:36:30 +09:00
enum.c Respect visibility in non-array Enumerable#inject [Bug #13592] 2020-07-24 21:08:50 +09:00
enumerator.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
error.c add UNREACHABLE_RETURN 2020-06-29 11:05:41 +09:00
eval.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
eval_error.c Fixed infinite loop at error in printing cause [Bug #17033] 2020-07-15 21:39:20 +09:00
eval_intern.h Create backtrace location array directly 2019-12-13 20:47:07 +09:00
eval_jump.c
file.c Get rid of the redundant stat() in rb_check_realpath_internal 2020-07-07 00:26:37 +09:00
gc.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
gc.h Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
gc.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +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
goruby.c goruby_options: do not goto into a branch 2020-06-29 11:05:41 +09:00
GPL
hash.c Fix links to Dig Methods document (#3421) 2020-08-14 18:55:04 -05:00
hrtime.h
id_table.c Suppress unused-variable warning 2020-08-10 17:49:08 +09:00
id_table.h sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
inits.c Make Integer#zero? a separated method and builtin (#3226) 2020-06-20 14:55:09 -07:00
insns.def precalc invokebuiltin destinations 2020-07-13 08:56:18 +09:00
integer.rb inline Primitive.cexpr! 2020-07-13 08:56:18 +09:00
internal.h RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
io.c Fix corruption in ARGF.inplace 2020-08-12 17:54:09 +09:00
io.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c Remove unused field in rb_iseq_constant_body 2020-07-23 01:17:59 -04:00
iseq.h add #include guard hack 2020-04-13 16:06:00 +09:00
kernel.rb Make Kernel#then, #yield_self, #frozen? builtin (#3283) 2020-07-03 18:02:43 -07:00
KNOWNBUGS.rb
LEGAL Clarify coroutine implementation license. 2020-08-17 20:57:04 +12:00
lex.c.blt
load.c Document that Kernel#load will load relative to current directory [ci skip] 2020-07-09 14:47:13 -07:00
loadpath.c
localeinit.c
main.c
marshal.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
math.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
method.h Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
mini_builtin.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
miniinit.c
mjit.c mjit_mark_cc_entries: should consider VM_CALLCACHE_UNMARKABLE 2020-06-09 12:40:50 +09:00
mjit.h Do not JIT inline builtin methods 2020-06-24 22:59:34 -07:00
mjit_compile.c Merge ivar guards on JIT (#3284) 2020-07-03 17:52:52 -07:00
mjit_worker.c sed -i s/RUBY3/RBIMPL/g 2020-05-11 09:24:08 +09:00
NEWS.md Avoid duplicated "when"s [ci skip] 2020-06-26 01:40:20 -07:00
node.c rb_{ary,fnd}_pattern_info: Remove imemo member to reduce memory usage 2020-08-02 01:04:06 +09:00
node.h Remove unused struct member 2020-08-03 17:01:13 -07:00
numeric.c [DOC] Use oracle url instead of sun url 2020-08-05 08:04:58 +09:00
object.c [skip-ci] Clarification for dup vs clone docs 2020-07-30 18:34:17 +09:00
pack.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
pack.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
parse.y rb_{ary,fnd}_pattern_info: Remove imemo member to reduce memory usage 2020-08-02 01:04:06 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d
probes_helper.h internal/vm.h rework 2019-12-26 20:45:12 +09:00
proc.c add UNREACHABLE_RETURN 2020-06-29 11:05:41 +09:00
process.c Rename rb_current_thread_scheduler to rb_thread_scheduler_if_nonblocking. 2020-07-20 13:20:58 +12:00
random.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
range.c Special case Range#max for integer beginning and Float::Infinity end 2020-07-19 10:25:55 -04:00
rational.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
re.c RSTRING_LEN was not used 2020-08-14 16:12:58 +09:00
README.EXT
README.EXT.ja
README.ja.md README*.md: defines.h moved [ci skip] 2020-02-01 00:38:38 +09:00
README.md Fix bundled gems installation on a fresh clone 2020-03-14 18:16:47 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h
regsyntax.c
ruby-runner.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
ruby.c feature_option: do not goto into a branch 2020-06-29 11:05:41 +09:00
ruby_assert.h Use RUBY_DEBUG instead of NDEBUG 2020-05-26 03:21:14 +09:00
ruby_atomic.h Solaris does not provide atomic_sub family 2020-04-26 22:39:36 +09:00
rubystub.c
signal.c Share the size for sigaltstack between configure.ac and signal.c 2020-07-22 21:28:23 +09:00
siphash.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
siphash.h
sparc.c
sprintf.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
st.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
strftime.c rb_strftime_with_timespec: do not goto into a branch 2020-06-29 11:05:41 +09:00
string.c [DOC] fixed a missing markup 2020-08-15 14:17:02 +09:00
struct.c Fix links to Dig Methods document (#3421) 2020-08-14 18:55:04 -05:00
symbol.c rb_encoding is defined as const 2020-08-01 17:58:24 +09:00
symbol.h add #include guard hack 2020-04-13 16:06:00 +09:00
thread.c procnames-start-lines [ci skip] 2020-08-17 14:27:34 +09:00
thread_pthread.c Get rid of -Wgnu-folding-constant errors 2020-05-01 19:28:23 +09:00
thread_pthread.h add #include guard hack 2020-04-13 16:06:00 +09:00
thread_sync.c rb_szqueue_push: do not goto into a branch 2020-06-29 11:05:41 +09:00
thread_win32.c
thread_win32.h add #include guard hack 2020-04-13 16:06:00 +09:00
time.c Fix Time#ceil when result should be the same as the receiver 2020-07-28 12:53:37 -07:00
timev.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
trace_point.rb [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
transcode.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
transcode_data.h add #include guard hack 2020-04-13 16:06:00 +09:00
transient_heap.c transient_heap_status_cstr() is used only for debugging 2020-07-29 21:08:48 +09:00
transient_heap.h add #include guard hack 2020-04-13 16:06:00 +09:00
util.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
variable.c Ensure the shortcut cached in the class 2020-08-17 22:57:40 +09:00
variable.h add #include guard hack 2020-04-13 16:06:00 +09:00
version.c
version.h * 2020-08-18 [ci skip] 2020-08-18 01:48:14 +09:00
vm.c vm_exec_handle_exception: do not goto into a branch 2020-06-29 11:05:41 +09:00
vm_args.c Run method_missing in the same execution context 2020-07-06 10:47:11 +09:00
vm_backtrace.c Expose ec -> backtrace (internal) and use it to implement fiber backtrace. 2020-08-18 00:56:35 +12:00
vm_callinfo.h VM_CI_NEW_ID: USE_EMBED_CI could be false 2020-06-09 09:52:46 +09:00
vm_core.h Remove unused field in rb_iseq_constant_body 2020-07-23 01:17:59 -04:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c Prefer configured printf format for mingw gcc 10 2020-05-26 16:58:28 +09:00
vm_eval.c Run method_missing in the same execution context 2020-07-06 10:47:11 +09:00
vm_exec.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
vm_exec.h RUBY_CONST_ASSERT: use STATIC_ASSERT instead 2020-07-10 12:23:41 +09:00
vm_insnhelper.c Prevent SystemStackError when calling super in module with activated refinement 2020-07-27 08:18:11 -07:00
vm_insnhelper.h Extracted METHOD_ENTRY_CACHEABLE macro 2020-06-30 19:12:02 +09:00
vm_method.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
vm_opts.h Remove obsoleted opt_call_c_function insn (#3232) 2020-06-17 09:16:01 -07:00
vm_trace.c [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
vsnprintf.c [win32] suppress false warning by mingw gcc 2020-03-04 23:13:18 +09:00
warning.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00

Build Status Build status Actions Status Actions Status Actions Status Actions Status Actions 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 include/ruby/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. 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