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-09-11 08:48:03 +09:00
.github .github/workflows/compilers.yml: disable shared for LTO 2021-09-10 20:00:06 +09:00
basictest
benchmark Support tracing of attr_reader and attr_writer 2021-08-29 07:23:39 -07:00
bin Remove probably unintented symlinks 2021-07-27 18:49:28 +09:00
bootstraptest [Bug #18117] Fix Ractor race condition with GC 2021-08-24 09:47:42 -04:00
ccan [Doc] Fix a typo s/oher/other/ 2021-04-25 19:46:00 +12:00
coroutine Ignore dead threads in coroutine_join. 2021-07-02 12:36:14 +12:00
coverage Fix Typo 2021-06-07 10:22:55 +09:00
cygwin Share variables defined in common GNUmakefile also in cygwin/mingw 2021-03-21 17:57:44 +09:00
defs Fix rubyspec_capiext dependency and flags 2021-08-30 12:03:44 +09:00
doc Need # 2021-09-10 13:51:50 +09:00
enc Remove no longer needed include files (Unicode Version 12.1.0) 2021-07-09 16:22:38 +09:00
ext [ruby/date] Ignore warned variables 2021-09-09 13:56:13 +09:00
gems Bundle RBS 1.6.2 (#4817) 2021-09-09 21:45:14 +09:00
include Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
internal suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
lib [ruby/irb] Ignore invalid 3 colons in completion 2021-09-11 04:41:20 +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 Add --autocomplete / --noautocomplete options 2021-08-30 02:45:13 +09:00
misc [Feature #18045] Implement size classes for GC 2021-08-25 09:28:21 -04: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 spec/ruby/optional/capi/ext: must support GCC 5 2021-09-10 20:00:06 +09:00
template template/Doxyfile.tmpl: EXTRACT_ALL=NO 2021-09-10 20:00:06 +09:00
test Use Test::Unit::Runner instead of MiniTest::Unit 2021-09-11 08:48:03 +09:00
tool Surpressing the noisy messages 2021-09-11 08:48:03 +09:00
win32 Add missing empty macro [ci skip] 2021-08-25 18:28:27 +09:00
.dir-locals.el
.document Add nilclass.rb to .document 2021-06-23 10:23:10 +09:00
.editorconfig
.gdbinit .gdbinit: Fix indentation in print_id [ci skip] 2021-02-06 13:03:40 -05:00
.gitattributes
.gitignore
.rspec_parallel
.travis.yml Reduce the amount of false positive notifications 2021-08-13 10:26:12 -07:00
aclocal.m4 get rid of aclocal (#4280) 2021-03-17 18:52:53 +09:00
addr2line.c addr2line: DragonFlyBSD build update. 2021-08-31 20:52:49 +09:00
addr2line.h
appveyor.yml [Win32] Skip over source update just after clone on AppVeyor 2021-08-14 22:09:50 +09:00
array.c include/ruby/internal/intern/array.h: add doxygen 2021-09-10 20:00:06 +09:00
array.rb
ast.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
ast.rb ast.c: Rename "save_script_lines" to "keep_script_lines" 2021-08-20 16:18:36 +09:00
autogen.sh autogen.sh: Make it work with sh (not bash) 2021-03-17 23:13:22 +09:00
bignum.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
BSDL
builtin.c Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
builtin.h Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
class.c include/ruby/internal/intern/class.h: add doxygen 2021-09-10 20:00:06 +09:00
common.mk Removed minitest dir from make task 2021-09-11 08:48:03 +09:00
compar.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
compile.c Remove unused argument 2021-09-10 21:26:16 +09:00
complex.c include/ruby/internal/intern/complex.h: add doxygen 2021-09-10 20:00:06 +09:00
configure.ac Remove stale DLEXT2 2021-09-10 14:51:56 +09:00
constant.h
cont.c Suppress format-pedantic warnings 2021-09-02 08:47:47 +09:00
CONTRIBUTING.md [Doc] Link to doc/contributing.rdoc from CONTRIBUTING.md (#4266) 2021-04-03 14:45:18 +09:00
COPYING
COPYING.ja
debug.c Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
debug_counter.c
debug_counter.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
dir.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
dir.rb Match parens for hidden files parenthetical 2021-08-31 21:02:13 +09:00
dln.c dln.c: add missing dependency 2021-09-10 20:00:06 +09:00
dln.h Removed dln_a_out 2021-03-24 20:13:55 +09:00
dln_find.c Removed an unused declaration 2021-03-12 19:28:17 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Add rb_encoding_check function 2021-08-22 10:39:14 +09:00
enum.c Enhanced RDoc for Enumerable (#4808) 2021-09-10 17:21:21 -05:00
enumerator.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
error.c suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
eval.c include/ruby/internal/intern/eval.h: add doxygen 2021-09-10 20:00:06 +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 Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
file.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
gc.c suppress GCC's -Wnonnull-compare 2021-09-10 20:00:06 +09:00
gc.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
gc.rb
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 Free previously used tables [Bug #18134] 2021-08-29 17:18:58 +09:00
hrtime.h
id_table.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
id_table.h
inits.c Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
insns.def Add a cache for class variables 2021-06-18 10:02:44 -07:00
internal.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
io.c Fix Marshal.dump(closed_io) to raise TypeError and allow encoding on closed IO 2021-08-22 10:33:22 +09:00
io.rb
iseq.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
iseq.h Allow tracing of optimized methods 2021-08-21 10:15:01 -07:00
kernel.rb [DOC] Use URI#read instead of URI.open for better compatibility 2021-01-12 22:12:02 +09:00
KNOWNBUGS.rb
LEGAL Added core_assertions.rb to LEGAL 2021-09-11 08:48:03 +09:00
lex.c.blt
load.c Remove stale DLEXT2 2021-09-10 14:51:56 +09:00
loadpath.c
localeinit.c
main.c stdlib.h is always included in include/ruby/defines.h 2021-01-05 01:06:33 +09:00
marshal.c Remove unneeded declarations 2021-03-20 21:00:29 +09:00
math.c Use C99-defined signbit macro 2021-08-27 12:42:23 +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 Suppress redefinition warnings of GET_SELF() 2021-08-30 09:06:36 +09:00
mjit_worker.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
NEWS.md Fix links [ci skip] 2021-08-22 22:27:29 +09:00
nilclass.rb Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
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 [DOC] Move rdoc of Integer#abs to numeric.rb [ci skip] 2021-08-30 13:33:52 +09:00
numeric.rb Replace RBOOL macro 2021-09-05 23:01:27 +09:00
object.c include/ruby/ruby.h: add doxygen 2021-09-10 20:00:06 +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 [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
parse.y Replace RBOOL macro 2021-09-05 23:01:27 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c Assert not to be UNDEF visibility 2021-09-01 19:28:54 +09:00
process.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
ractor.c [Bug #18117] Fix Ractor race condition with GC 2021-08-24 09:47:42 -04:00
ractor.rb Replace RBOOL macro 2021-09-05 23:01:27 +09:00
ractor_core.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
random.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
range.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
rational.c Make internal predicate functions to return simple boolean 2021-09-02 17:43:10 +09:00
re.c Show default argument explicitly for Rexexp#match? [ci skip] 2021-09-01 09:37:13 +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 Update the Travis badge URL in README. [ci skip] 2021-09-09 16:56:28 +02:00
regcomp.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regenc.c
regenc.h
regerror.c
regexec.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
ruby_assert.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
ruby_atomic.h Expose atomic operation macros with RUBY prefix 2020-12-24 11:43:21 +09:00
rubystub.c
scheduler.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
signal.c Use free instead of xfree to free altstack 2021-09-06 14:22:24 +09:00
siphash.c Fix compilation error in mingw 2021-05-04 20:38:03 -04:00
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 Moved exported symbols in internal/util.h to ruby/util.h 2021-08-24 10:37:41 +09:00
string.c Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
struct.c Make Struct#keyword_init? return nil by default [Feature #18008] 2021-07-15 22:24:02 +09:00
symbol.c include/ruby/internal/symbol.h: add doxygen 2021-09-10 20:00:06 +09:00
symbol.h
thread.c Fix potential hang when joining threads. 2021-08-03 22:23:48 +12:00
thread_pthread.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
thread_pthread.h Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
thread_sync.c Using RBOOL macro 2021-08-02 12:06:44 +09:00
thread_win32.c Replace copy coroutine with pthread implementation. 2021-07-01 11:23:03 +12:00
thread_win32.h Get rid of duplicate typedef 2021-09-03 22:47:58 +09:00
time.c include/ruby/internal/intern/time.h: add doxygen 2021-09-10 20:00:06 +09:00
timev.h
timev.rb [DOC] Match each Time.now for comparison [ci skip] 2021-08-23 14:12:21 +09:00
trace_point.rb Tweak description of TracePoint :line event 2021-06-19 13:55:28 +12:00
transcode.c Replace RBOOL macro 2021-09-05 23:01:27 +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 Use Module#ancestors order in recursive constant lookup 2021-06-30 10:49:27 +09: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-09-11 [ci skip] 2021-09-11 04:41:38 +09:00
vm.c Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_args.c Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_backtrace.c Make backtrace generation work outward from current frame 2021-08-06 10:15:01 -07:00
vm_callinfo.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_core.h suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
vm_debug.h suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
vm_dump.c Crash more nicely when the VM isn't fully set up 2021-06-10 16:31:29 -07:00
vm_eval.c include/ruby/internal/intern/vm.h: add doxygen 2021-09-10 20:00:06 +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 Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_insnhelper.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_method.c Get rid of type-punning pointer casts [Bug #18062] 2021-08-11 12:07:44 +09:00
vm_opts.h
vm_sync.c Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_sync.h Adjusted indent [ci skip] 2021-02-09 08:41:06 +09:00
vm_trace.c include/ruby/debug.h: add doxygen 2021-09-10 20:00:06 +09:00
vsnprintf.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
warning.rb

Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis 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