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
Kazuhiro NISHIYAMA d0a7189f26 Fix ObjectSpace.dump(obj, output: :stdout)
RDoc says `ObjectSpace.dump(obj, output: :stdout)   # => nil`,
but it returns STDOUT since fbba6bd4e3.

I think it is unintentional change.
2020-10-03 00:00:01 +09:00
.github Remove outdated comment [ci skip] 2020-09-27 14:26:38 +09:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark Improve the performance of super 2020-09-23 11:52:36 -07:00
bin Promote erb to default gems 2020-08-21 20:18:44 +09:00
bootstraptest fix typo [ci skip] 2020-09-27 09:49:16 +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 Fixed installation failure [Bug #17191] 2020-09-29 13:41:59 +09:00
doc Update marshal.rdoc 2020-10-02 02:04:24 -04:00
enc sed -i '/rmodule.h/d' 2020-08-27 16:42:06 +09:00
ext Fix ObjectSpace.dump(obj, output: :stdout) 2020-10-03 00:00:01 +09:00
gems Bundle rbs gem as bundled gems (#3496) 2020-09-23 10:59:49 +09:00
include memory_view.c: Use ssize_t for ndim in memory_view (#3615) 2020-10-02 08:04:25 +09:00
internal Disable deprecation warning by the default [Feature #16345] 2020-09-25 09:50:33 +09:00
lib [ruby/ostruct] Tweak doc 2020-09-30 18:11:24 -04:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man bundle-package.* was removed at upstream repo 2020-09-23 20:28:38 +09:00
misc bit table information when printing an object 2020-09-28 16:45:19 -07:00
missing sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
sample Use own mutex instead of Thread.exclusive 2020-08-27 14:37:03 +09:00
spec Removed meaningless system dependent tests 2020-10-02 08:43:33 +09:00
template DEPRECATED_TYPE: is deprecated 2020-08-27 15:02:52 +09:00
test Fix ObjectSpace.dump(obj, output: :stdout) 2020-10-03 00:00:01 +09:00
tool Pass ASAN options to child environments 2020-09-28 09:45:04 -07:00
util [rubygems/rubygems] Extend the script to allow reverting the patch when tried locally 2020-07-31 21:07:19 +09:00
win32 DEPRECATED_TYPE: is deprecated 2020-08-27 15:02:52 +09:00
.dir-locals.el
.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 .travis.yml: prefer gcc 2020-08-22 11:12:24 +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 Comply with guide for method doc: array.c (#3506) 2020-09-02 14:02:34 -05:00
array.rb Comply with guide for method doc: array.c (#3506) 2020-09-02 14:02:34 -05:00
ast.c Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +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
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 include/ruby/backward/2/rmodule.h: deprecate 2020-08-27 16:42:06 +09:00
common.mk Fixed installation failure [Bug #17191] 2020-09-29 13:41:59 +09:00
compar.c cmp_clamp: do not goto into a branch 2020-06-29 11:05:41 +09:00
compile.c Put same frozen Range literal if possible 2020-10-02 09:22:17 +09:00
complex.c Fix assertion failed in Complex.polar without NDEBUG (#3551) 2020-09-16 19:27:16 +09:00
configure.ac Do not use clang on cygwin 2020-09-28 13:42:04 +09:00
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c Fix a use-after-free bug reported by ASAN 2020-10-01 08:42:52 -07:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
debug_counter.c
debug_counter.h Explicit conversion to boolean to suppress shorten-64-to-32 warnings 2020-07-10 13:02:31 +09:00
dir.c Switch conflicting chdir warning to RuntimeError 2020-09-28 08:34:04 -07: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 rb_category_warn{,ing} for warning messages with categories 2020-09-28 08:38:06 -07:00
eval.c Rework rb_ec_scheduler_finalize to ensure exceptions are printed. 2020-10-01 16:56:05 +13: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
eval_jump.c
file.c Removed rb_find_file_ext_safe and rb_find_file_safe 2020-09-23 09:09:36 +09:00
gc.c Fix ASAN and don't check SPECIAL_CONST_P 2020-09-28 09:45:04 -07:00
gc.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
gc.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
gem_prelude.rb
golf_prelude.rb
goruby.c goruby_options: do not goto into a branch 2020-06-29 11:05:41 +09:00
GPL
hash.c Add call-seq of [Feature #16274] 2020-09-29 22:49:44 +09: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 Buffer protocol proposal (#3261) 2020-09-25 20:32:02 +09:00
insns.def Interpolated strings are no longer frozen with frozen-string-literal: true 2020-09-15 21:32:35 +02:00
integer.rb inline Primitive.cexpr! 2020-07-13 08:56:18 +09:00
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c Prefer to use prep_io for temporary IO instances. 2020-09-17 00:31:04 +12: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 KNOWNBUGS.rb: use-after-poison since b9007b6c54 2020-08-30 16:07:12 +09:00
LEGAL Added did_you_mean entry because did_you_mean uses MIT license 2020-08-19 19:36:16 +09: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 Removed useless casts 2020-09-05 17:34:12 +09:00
math.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
memory_view.c memory_view.c: Use ssize_t for ndim in memory_view (#3615) 2020-10-02 08:04:25 +09:00
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c
miniinit.c
mjit.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
mjit.h Do not JIT inline builtin methods 2020-06-24 22:59:34 -07:00
mjit_compile.c Use size_t for MJIT's max_ivar_index 2020-09-08 09:22:34 -07:00
mjit_worker.c Suppress warnings 2020-09-30 13:37:07 +09:00
NEWS.md Add links to the tickets [ci skip] 2020-10-01 13:27:00 +09:00
node.c Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +09:00
node.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
numeric.c Hoisted out ensure_cmp which checks the comparison succeeded 2020-10-02 21:30:07 +09:00
object.c Initialize new T_OBJECT as ROBJECT_EMBED 2020-09-02 14:54:29 -07: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 Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d
probes_helper.h
proc.c Warn on a finalizer that captures the object to be finalized 2020-09-16 13:52:24 -07:00
process.c Prefer rb_thread_current_scheduler. 2020-09-14 16:44:09 +12:00
ractor.c Frozen Struct can be shareable. 2020-09-25 16:00:13 +09:00
ractor.h Ractor#close_outgoping cancel Ractor.yield 2020-09-25 00:25:38 +09:00
ractor.rb Add status to Ractor#inspect 2020-09-20 23:10:44 +09:00
ractor_pub.h check multi_ractor mode at main_p 2020-09-04 14:18:48 +09:00
random.c Added rb_random_base_init 2020-09-07 20:08:01 +09:00
range.c freeze all Range objects. 2020-09-25 22:16:55 +09:00
rational.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
re.c Try to fix compile error on windows 2020-08-28 22:03:06 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md
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
regparse.h
regsyntax.c
ruby-runner.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
ruby.c Disable deprecation warning by the default [Feature #16345] 2020-09-25 09:50:33 +09:00
ruby_assert.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
ruby_atomic.h fix typo [Bug #17194] 2020-09-26 18:24:28 +09:00
rubystub.c
scheduler.c Added a fallback return 2020-10-01 13:46:13 +09:00
signal.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +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 sprintf.c: Removed conflicting definition 2020-09-28 12:51:53 +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 Enhanced RDoc for String#[] (#3607) 2020-09-30 14:58:12 -05:00
struct.c RHASH_TBL: is now ext-only 2020-08-19 15:10:53 +09:00
symbol.c sync ruby_global_symbols 2020-09-18 14:17:49 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c Don't use th->scheduler directly because it's not always valid to do so. 2020-10-01 21:38:36 +13:00
thread_pthread.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
thread_pthread.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
thread_sync.c Make Thread#join non-blocking. 2020-09-21 11:48:44 +12:00
thread_win32.c thread_win32.c: native_mutex_trylock is not used right now 2020-09-28 12:51:20 +09:00
thread_win32.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +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
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 Unpoison THEAP header before reading 2020-09-28 10:18:15 -07: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 Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
variable.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
version.c
version.h * 2020-10-02 [ci skip] 2020-10-02 00:43:14 +09:00
vm.c Update the thread's self / wrapper address 2020-10-01 18:14:43 -07:00
vm_args.c Run method_missing in the same execution context 2020-07-06 10:47:11 +09:00
vm_backtrace.c Document difference between Thread::Backtrace::Location#{,absolute_}path 2020-09-23 15:55:58 -07: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 Make Thread#join non-blocking. 2020-09-21 11:48:44 +12:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
vm_eval.c Deprecate iterator? method 2020-08-31 22:14:14 +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 Make minor improvements to super 2020-10-01 10:11:02 -07:00
vm_insnhelper.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
vm_method.c Fix ASAN support when invalidating CCs 2020-09-28 08:20:23 -07:00
vm_opts.h Remove obsoleted opt_call_c_function insn (#3232) 2020-06-17 09:16:01 -07:00
vm_sync.c relax dependency 2020-09-15 00:04:59 +09:00
vm_sync.h relax dependency 2020-09-15 00:04:59 +09:00
vm_trace.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
vsnprintf.c
warning.rb Add rb_category_warn{,ing} for warning messages with categories 2020-09-28 08:38:06 -07: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