You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
git 3ced77a82a * 2020-06-04 [ci skip] 3 days ago
.github Respect BIGNUM_DEBUG defined by command line option 1 week ago
basictest Fixed misspellings 5 months ago
benchmark add benchmark for different block handlers 3 days ago
bin Removed the old executables of racc 5 months ago
bootstraptest Moved already resolved test 1 month ago
ccan Fix typos [ci skip] 7 months ago
coroutine Patch assembly so that it aligns properly 2 months ago
coverage Fix typo 1 year ago
cygwin Merged recipes for the same target 1 week ago
defs Pass MAKE value to configure for non-default name case 3 weeks ago
doc Update extension.rdoc for Ruby 3 keyword argument separation [ci skip] 5 days ago
enc sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
ext Allow references to $$ in Ripper DSL 1 week ago
gems power_assert repository is transferred to ruby/power_assert 1 month ago
include RUBY_ASSERT_NOASSUME 1 week ago
internal Ensure origins for all included, prepended, and refined modules 3 days ago
lib Fix error raised by Net::HTTPResponse#inflater if the block raises 6 days ago
libexec Sync Bundler PR #3624 with HEAD commits 2 weeks ago
man Sync Bundler PR #3624 2 weeks ago
misc Add T_IMEMO support to lldb 1 month ago
missing sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
sample [ruby/openssl] Look up digest by name instead of constant 3 weeks ago
spec Ensure origins for all included, prepended, and refined modules 3 days ago
template Build auxiliary program files early 3 weeks ago
test Ensure origins for all included, prepended, and refined modules 3 days ago
tool Fixed up 56ca006784d 3 days ago
win32 Get rid of redefinition of memcpy on mingw 1 week ago
.dir-locals.el emacs mode addition 4 months ago
.document Moved `Dir.open` and `Dir#initialize` to dir.rb 2 months ago
.editorconfig Remove duplicated and change order 1 year ago
.gdbinit Redmine /projects/ruby-trunk is now redirected 5 months ago
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 10 months ago
.gitignore Revert "Moved aclocal.m4 to macro directory" 2 months ago
.rspec_parallel Introduce test-bundler-parallel task. 9 months ago
.travis.yml Travis s390x-linux is too unstable 1 month ago
BSDL [ruby/irb] Reformat LICENSE.txt [ci skip] 4 months ago
CONTRIBUTING.md [DOC] Please see _the_ official issue tracker... [ci skip] 6 years ago
COPYING COPYING: reformat as RDoc 1 year ago
COPYING.ja COPYING: reformat as RDoc 1 year ago
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328] 8 years ago
KNOWNBUGS.rb compile.c: fix positions encode 2 years ago
LEGAL [DOC] Use note-list to pretend original plain-text looks [ci skip] 1 week ago
NEWS.md Update NEWS / documentation with GC.start(compact:true) 1 week ago
README.EXT README.EXT: add redirect [ruby-core:68631] 5 years ago
README.EXT.ja README.EXT.ja: add redirect [ruby-core:68631] 5 years ago
README.ja.md README*.md: `defines.h` moved [ci skip] 4 months ago
README.md Fix bundled gems installation on a fresh clone 2 months ago
aclocal.m4 Merge pull request #2991 from shyouhei/ruby.h 1 month ago
addr2line.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
addr2line.h add #include guard hack 1 month ago
appveyor.yml Fix AppVeyor pull request CI (#2983) 2 months ago
array.c Fix max, min, minmax documentation (#3131) 1 week ago
array.rb Removed useless shebang and executable bit [ci skip] 4 months ago
ast.c Separate builtin initialization calls 5 months ago
ast.rb Fix variable name and add more example [ci skip] 5 months ago
bignum.c Respect BIGNUM_DEBUG defined by command line option 1 week ago
builtin.c take care of USE_LAZY_LOAD=1. 5 months ago
builtin.h Get rid of redefinition of `rb_execution_context_t` 2 months ago
class.c Ensure origins for all included, prepended, and refined modules 3 days ago
common.mk Remove platform directory when distclean or more [ci skip] 1 week ago
compar.c decouple internal.h headers 5 months ago
compile.c compile.c: Mark cursor in debug list 1 week ago
complex.c Ensure origins for all included, prepended, and refined modules 3 days ago
configure.ac Check that BASERUBY is at least Ruby 2.2 in configure 1 week ago
constant.h add #include guard hack 1 month ago
cont.c Fix documentation for Fiber#raise [ci skip] 1 week ago
debug.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
debug_counter.c Avoid doubly showing debug counters 2 months ago
debug_counter.h Add a debug_counter for JIT cancel on leave 1 week ago
dir.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
dir.rb Moved `Dir.[]` to dir.rb 2 months ago
dln.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
dln.h add #include guard hack 1 month ago
dln_find.c dln_find.c: MAXPATHLEN is not used already 4 years ago
dmydln.c UNREACHABLE_RETURN 1 year ago
dmyenc.c load.c: tweak the return value 5 years ago
dmyext.c dmyenc.c: separate 5 years ago
encindex.h add #include guard hack 1 month ago
encoding.c Fallback to built-in UTF-8 for miniruby 3 weeks ago
enum.c Fix max, min, minmax documentation (#3131) 1 week ago
enumerator.c Update Enumerable::Yielder#to_proc document (#3142) 1 week ago
error.c Use receiver #name rather than #inspect to build NameError message 1 week ago
eval.c Ensure origins for all included, prepended, and refined modules 3 days ago
eval_error.c Merge pull request #3047 from mame/suppress-backtrace 3 weeks ago
eval_intern.h Create backtrace location array directly 5 months ago
eval_jump.c drop-in type check for rb_define_global_function 9 months ago
file.c Allow Dir.home to work for non-login procs when $HOME not set 2 weeks ago
gc.c Combine sweeping and moving 1 week ago
gc.h Rename RUBY_MARK_NO_PIN_UNLESS_NULL to RUBY_MARK_MOVABLE_UNLESS_NULL 4 months ago
gc.rb Update NEWS / documentation with GC.start(compact:true) 1 week ago
gem_prelude.rb Do not call 'gem "did_you_mean"' for now 6 months ago
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 11 months ago
goruby.c goruby.c: FD leak [ci skip] 3 years ago
hash.c [ci skip] Enhanced Rdoc for Hash (#3162) 4 days ago
hrtime.h hrtime.h: fix typo in non-builtin overflow check 1 year ago
id_table.c reroute redefinition of NDEBUG 1 month ago
id_table.h sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
inits.c Defer initialization 3 weeks ago
insns.def vm_insnhelper.c: merge opt_eq_func / opt_eql_func 4 days ago
internal.h export debug utility functions 1 week ago
io.c Fixed a variable name [Bug #16903] 2 weeks ago
io.rb Define IO#read/write_nonblock with builtins. 7 months ago
iseq.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
iseq.h add #include guard hack 1 month ago
kernel.rb support builtin for Kernel#Float 1 month ago
lex.c.blt keywords: shrink struct kwtable 2 years ago
load.c [DOC] relative filename `Kernel#.require` and `Kernel#.load` [ci skip] 5 days ago
loadpath.c -Wno-overlength-strings 2 years ago
localeinit.c internal.h: remove dependecy on ruby/encoding.h 2 years ago
main.c main.c: Add doxygen mainpage 10 months ago
marshal.c Ensure origins for all included, prepended, and refined modules 3 days ago
math.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
method.h add #include guard hack 1 month ago
mini_builtin.c decouple internal.h headers 5 months ago
miniinit.c support builtin features with Ruby and C. 7 months ago
mjit.c Eliminate a call instruction on JIT cancel path 1 week ago
mjit.h Carve out mjit_exec_slowpath 1 week ago
mjit_compile.c Eliminate a call instruction on JIT cancel path 1 week ago
mjit_worker.c sed -i s/RUBY3/RBIMPL/g 3 weeks ago
node.c decouple internal.h headers 5 months ago
node.h Constified code_loc_gen 3 weeks ago
numeric.c numeric.c: optimize `float ** 2` case by fastpath 3 weeks ago
object.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
pack.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
pack.rb Rubified the APIs of pack.c 7 months ago
parse.y Include the entire lambda expression in lambda rule 4 days ago
prelude.rb Define IO#read/write_nonblock with builtins. 7 months ago
probes.d change lingering dtrace probe documentation from function- to method- 5 years ago
probes_helper.h internal/vm.h rework 5 months ago
proc.c [DOC] Separated Method#[] from Method#call [Bug #16813] [ci skip] 1 month ago
process.c Allow Dir.home to work for non-login procs when $HOME not set 2 weeks ago
random.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
range.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
rational.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
re.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 1 year ago
regenc.c Merge Onigmo 6.1.1 3 years ago
regenc.h initializer paren-string `{("str")}` is a C99ism 2 years ago
regerror.c Escape control codes in regexp warning message 11 months ago
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 1 year ago
regint.h Merge Onigmo 6.1.1 3 years ago
regparse.c Fixed misspellings 5 months ago
regparse.h Fix typos. 2 years ago
regsyntax.c Merge Onigmo 6.0.0 3 years ago
ruby-runner.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
ruby.c Defer initialization 3 weeks ago
ruby_assert.h Use RUBY_DEBUG instead of NDEBUG 1 week ago
ruby_atomic.h Solaris does not provide atomic_sub family 1 month ago
rubystub.c rubystub.c: sys/param.h for MAXPATHLEN 3 years ago
signal.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
siphash.c switch SipHash from SipHash24 to SipHash13 variant 3 years ago
siphash.h blacklist UBSAN's unsigned integer overflow 1 year ago
sparc.c configure.ac 2 years ago
sprintf.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
st.c Adjusted indents [ci skip] 2 months ago
strftime.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
string.c add static modifier for rb_str_ord func 1 week ago
struct.c Added GC guard for splatted array 4 weeks ago
symbol.c [DOC] Added document for rb_check_symbol() [ci skip] 1 week ago
symbol.h add #include guard hack 1 month ago
thread.c Make Thread#thread_variable? similar to #thread_variable_get 1 week ago
thread_pthread.c Get rid of -Wgnu-folding-constant errors 1 month ago
thread_pthread.h add #include guard hack 1 month ago
thread_sync.c Thread scheduler for light weight concurrency. 3 weeks ago
thread_win32.c Remove IA64 support. 11 months ago
thread_win32.h add #include guard hack 1 month ago
time.c Append subsec part instead of creating new string 3 days ago
timev.h decouple internal.h headers 5 months ago
trace_point.rb Fix output of example [ci skip] 5 months ago
transcode.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
transcode_data.h add #include guard hack 1 month ago
transient_heap.c decouple internal.h headers 5 months ago
transient_heap.h add #include guard hack 1 month ago
util.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
variable.c sed -i 's|ruby/impl|ruby/internal|' 3 weeks ago
variable.h add #include guard hack 1 month ago
version.c Provides ruby2_keywords 7 months ago
version.h * 2020-06-04 [ci skip] 3 days ago
vm.c Fix origin iclass pointer for modules 2 weeks ago
vm_args.c Suppress probably impossible maybe-uninitialized warning 3 weeks ago
vm_backtrace.c Add compaction support for backtrace objects 1 month ago
vm_callinfo.h add #include guard hack 1 month ago
vm_core.h Thread scheduler for light weight concurrency. 3 weeks ago
vm_debug.h add #include guard hack 1 month ago
vm_dump.c Prefer configured printf format for mingw gcc 10 1 week ago
vm_eval.c drop varargs.h support 3 weeks ago
vm_exec.c Add VM insns counter like debug_counter (#2789) 5 months ago
vm_exec.h add #include guard hack 1 month ago
vm_insnhelper.c vm_invoke_proc_block: reduce recursion 3 days ago
vm_insnhelper.h Suppress warnings no inline ruby debug (#3107) 2 weeks ago
vm_method.c Ensure origins for all included, prepended, and refined modules 3 days ago
vm_opts.h add #include guard hack 1 month ago
vm_trace.c Clear all trace events during teardown 2 months ago
vsnprintf.c [win32] suppress false warning by mingw gcc 3 months ago
warning.rb Fix a typo [ci skip] 5 months ago

README.md

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