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
2021-10-14 20:09:41 +09:00
.github Relax time-out for bundler 2021-10-04 12:37:11 +09:00
basictest
benchmark Use faster any_hash logic in rb_hash 2021-09-30 13:06:53 -07:00
bin Remove probably unintented symlinks 2021-07-27 18:49:28 +09:00
bootstraptest Fix Ractor.make_shareable changing locals for Procs 2021-10-06 15:38:33 -04:00
ccan
coroutine Ignore dead threads in coroutine_join. 2021-07-02 12:36:14 +12:00
coverage
cygwin Suppress maybe-uninitialized warning on mingw 2021-10-02 08:02:57 +09:00
defs Fix rubyspec_capiext dependency and flags 2021-08-30 12:03:44 +09:00
doc [DOC] fix small mistake in doc/marshal.rdoc [ci skip] 2021-10-03 11:09:08 +09:00
enc ruby tool/update-deps --fix 2021-10-05 14:18:23 +09:00
ext [ruby/etc] Get rid of alloca in the loop 2021-10-14 18:44:27 +09:00
gems Update bundled_gems 2021-10-12 12:53:56 +09:00
include Remove duplicate type qualifiers 2021-10-06 14:01:43 +09:00
internal Restore Hash#compare_by_identity mode [Bug #18171] 2021-10-02 11:43:35 +09:00
lib [ruby/cgi] Bump up cgi version to 0.3.0 2021-10-14 20:09:41 +09:00
libexec [ruby/irb] Move IRB::TOPLEVEL_BINDING from exe/irb to lib/irb/workspace.rb 2021-09-10 06:37:07 +09:00
man [ruby/irb] Add help about extra doc dir option 2021-10-11 21:12:58 +09:00
misc lldb: Get rid of error at unpreserved encodings [ci skip] 2021-09-29 22:31:24 +09:00
missing Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
sample Clean up lambda output from exyacc.rb 2021-08-25 18:23:56 -07:00
spec [rubygems/rubygems] Improve error messages in gem helpers 2021-10-13 23:30:11 +09:00
template Add the dependency of GNUmakefile itself [ci skip] 2021-10-06 15:42:37 +09:00
test [rubygems/rubygems] Remove save_loaded_features 2021-10-14 05:03:36 +09:00
tool Removed redundant digest namespace 2021-10-14 14:07:50 +09:00
win32 Clang never evaluates expr in __builtin_assume 2021-10-04 08:13:37 +09:00
.appveyor.yml Dot-prefix appveyor.yml 2021-09-25 15:44:14 +09:00
.cirrus.yml Set the locale encoding to UTF-8 2021-09-28 00:52:18 +09:00
.dir-locals.el
.document marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
.editorconfig
.gdbinit
.gitattributes
.gitignore
.rspec_parallel
.travis.yml Revert "Shallow clone on TravisCI" 2021-10-13 19:04:46 +09:00
aclocal.m4
addr2line.c Use the correct address size 2021-09-23 12:29:07 -07:00
addr2line.h
array.c Remove repeated 'the' (#4966) 2021-10-13 23:05:44 -07:00
array.rb [DOC] Additional to Array#sample [ci skip] 2021-09-22 14:17:09 +09:00
ast.c ast.c: AST.of against C method should return nil (as Ruby 2.6--3.0) 2021-09-18 21:52:18 +09:00
ast.rb ast.c: Rename "save_script_lines" to "keep_script_lines" 2021-08-20 16:18:36 +09:00
autogen.sh
bignum.c bary_mul_balance_with_mulfunc: move working buffer allocation 2021-10-12 00:45:14 +09:00
BSDL
builtin.c
builtin.h
class.c Use the flag for uninitialized module [Bug #18185] 2021-09-24 08:29:00 +09:00
common.mk Suppress some messages on building mjit header 2021-10-12 18:07:55 +09:00
compar.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
compile.c Dump outer variables tables when dumping an iseq to binary 2021-10-07 15:39:47 -07:00
complex.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
configure.ac Do not allow configuration where neither static or shared library is installed 2021-10-08 14:01:54 -09:00
constant.h
cont.c rb_fiber_raise(): add doxygen 2021-09-30 20:55:23 +13:00
CONTRIBUTING.md [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
COPYING
COPYING.ja
debug.c lldb: Show encoding of String [ci skip] 2021-09-28 20:03:54 +09:00
debug_counter.c
debug_counter.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
dir.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
dir.rb Links for What's Here sections (#4827) 2021-09-13 10:37:15 -05:00
dln.c dln.c: add missing dependency 2021-09-10 20:00:06 +09:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c include/ruby/encoding.h: convert macros into inline functions 2021-10-05 14:18:23 +09:00
enum.c Accommondate earlier reviews of RDoc for Enumerable (#4943) 2021-10-06 19:06:17 -05:00
enumerator.c Introduce RBIMPL_NONNULL_ARG macro 2021-09-27 14:47:52 +09:00
error.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
eval.c Consider modified modules initialized [Bug #18185] 2021-09-24 08:29:00 +09:00
eval_error.c Trim extra whitespace in inaccesible error message 2021-09-01 13:18:55 +09:00
eval_intern.h Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
eval_jump.c
file.c rb_encoding is already const 2021-10-14 10:23:33 +09:00
gc.c Move rb_ractor_p definition 2021-10-04 08:21:40 +09:00
gc.h Enable inline assembly of SET_MACHINE_STACK_END on AIX 2021-10-04 23:06:43 -05:00
gc.rb Enhance documentation on GC.stat (#4843) 2021-09-20 14:40:55 -04:00
gem_prelude.rb Silence LoadError only if it is for rubygems itself 2021-08-18 21:37:31 +09:00
golf_prelude.rb
goruby.c goruby.c: include golf_prelude.c to get rid of overwriting EXTOBJS 2021-07-03 22:39:14 +09:00
GPL
hash.c Restore Hash#compare_by_identity mode [Bug #18171] 2021-10-02 11:43:35 +09:00
hrtime.h
id_table.c Qundef is not for ID 2021-10-13 12:07:57 +09:00
id_table.h
inits.c marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
insns.def Make Array#min/max optimization respect refined methods 2021-09-30 15:18:14 -07:00
internal.h Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
io.c Reuse ractor stderr 2021-10-07 19:57:09 +09:00
io.rb
iseq.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
iseq.h Allow tracing of optimized methods 2021-08-21 10:15:01 -07:00
kernel.rb
KNOWNBUGS.rb
LEGAL [DOC] Separate paragraph in LEGAL instead of break lines [ci skip] 2021-09-11 19:09:37 +09:00
lex.c.blt
load.c Pass the VM pointer as an argument 2021-10-10 23:34:16 +09:00
loadpath.c
localeinit.c
main.c
marshal.c marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
marshal.rb marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
math.c Using RB_FLOAT_TYPE_P macro 2021-09-12 11:16:31 +09:00
memory_view.c memory_view.c: Rename private to private_data for C++ (#4812) 2021-09-06 16:01:52 +09:00
method.h
mini_builtin.c * expand tabs. [ci skip] 2021-06-17 06:09:26 +09:00
miniinit.c
mjit.c Revert "Pause an MJIT worker when JIT is cancelled" 2021-08-13 09:13:09 -07:00
mjit.h Print JIT cancel when all JIT-ed code is cancelled 2021-08-12 23:11:38 -07:00
mjit_compile.c Extract precompile_inlinable_child_iseq to separate alloca for each iseq 2021-10-12 17:12:01 +09:00
mjit_worker.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
NEWS.md add NEWS entry for https://github.com/ruby/ruby/pull/4815 2021-09-22 17:59:28 +09:00
nilclass.rb
node.c Show node IDs in dump 2021-07-12 12:10:16 +09:00
node.h node.h: Reduce struct size to fit with Ruby object size (five VALUEs) 2021-06-18 02:34:27 +09:00
numeric.c Enhanced RDoc for Numeric#% (#4954) 2021-10-12 08:06:05 -05:00
numeric.rb Replace RBOOL macro 2021-09-05 23:01:27 +09:00
object.c Fix a typo [Bug #17048] 2021-09-19 22:39:18 +09:00
pack.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
pack.rb
parse.y Remove duplicate value checks on mrhs which always has the value 2021-10-08 00:11:22 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c Refactor rb_proc_call function 2021-10-10 09:31:25 +09:00
process.c Rework order of operations to better handle last_status. 2021-09-22 18:50:26 +12:00
ractor.c Cast to void pointer to suppress -Wformat-pedantic in RUBY_DEBUG_LOG 2021-10-03 13:59:48 +09:00
ractor.rb [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
ractor_core.h Move rb_ractor_p definition 2021-10-04 08:21:40 +09:00
random.c [Win32] Prefer Cryptography Next Generation API 2021-10-02 21:22:33 +09:00
range.c Unify iteration arguments 2021-10-10 11:45:50 +09:00
rational.c Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
re.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Move mailing-list URLs to footnotes [ci skip] 2021-07-11 20:12:45 +09:00
README.md .cirrus.yml: Add Cirrus CI for Arm64 tests. 2021-09-22 09:01:43 +02:00
regcomp.c Cast up to get rid of the potential overflow posibility 2021-10-14 18:43:32 +09:00
regenc.c
regenc.h
regerror.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regexec.c
regint.h Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.h
regsyntax.c
ruby-runner.c
ruby.c Skip broken strings as the locale encoding 2021-10-01 20:28:44 +09:00
ruby_assert.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
ruby_atomic.h
rubystub.c
scheduler.c Add gvl and fiber assertions to scheduler interface to catch invalid usage. 2021-09-20 23:16:45 +12:00
signal.c Use free instead of xfree to free altstack 2021-09-06 14:22:24 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
st.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
strftime.c Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
string.c Add tests for the edge caces of String#end_with? 2021-10-08 14:08:03 +09:00
struct.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
symbol.c Fix STATIC_SYM2ID for large ID on IL32LLP64 platforms 2021-10-14 01:11:31 +09:00
symbol.h
thread.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
thread_pthread.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
thread_pthread.h
thread_sync.c Add WB_PROTECTED to mutexes 2021-09-17 10:03:39 +09:00
thread_win32.c Function w32_error does not return 2021-10-04 08:15:52 +09:00
thread_win32.h Get rid of duplicate typedef 2021-09-03 22:47:58 +09:00
time.c Include the invalid value in invalid_utc_offset error 2021-09-18 18:03:54 +09:00
timev.h
timev.rb Links for What's Here sections (#4827) 2021-09-13 10:37:15 -05:00
trace_point.rb Tweak description of TracePoint :line event 2021-06-19 13:55:28 +12:00
transcode.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
transcode_data.h
transient_heap.c
transient_heap.h
util.c include/ruby/internal/ctype.h: add doxygen 2021-09-10 20:00:06 +09:00
variable.c Remove autoload for constant if the autoload fails 2021-10-08 14:54:26 -07:00
variable.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
version.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
version.h * 2021-10-14 [ci skip] 2021-10-14 00:20:31 +09:00
vm.c Moved the common code 2021-10-13 13:00:57 +09:00
vm_args.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
vm_backtrace.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
vm_callinfo.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_core.h Do not load file with same realpath twice when requiring 2021-10-02 05:51:29 -09:00
vm_debug.h suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
vm_dump.c Shorten register names on arm64-darwin not to be truncated 2021-10-10 21:58:56 +09:00
vm_eval.c Introduce rb_vm_call_with_refinements to DRY up a few calls 2021-10-01 08:12:46 -09:00
vm_exec.c Suppress unused-function warning when OPT_THREADED_CODE != 1 2021-08-09 11:21:56 +09:00
vm_exec.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_insnhelper.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
vm_insnhelper.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_method.c Fix typo in static function name 2021-10-01 08:12:46 -09:00
vm_opts.h
vm_sync.c
vm_sync.h
vm_trace.c Refactor rb_add_event_hook function 2021-09-29 09:16:53 +13:00
vsnprintf.c
warning.rb

Actions Status: macOS 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/contributing.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