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
Takashi Kokubun 41e3c204fd
Reduce ISeq size of mjit_exec benchmark
to avoid unwanted memory pressure
2019-09-26 22:13:31 +09:00
.github/workflows Revert the accidentally commits related GitHub Actions 2019-09-26 19:22:30 +09:00
basictest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
benchmark Reduce ISeq size of mjit_exec benchmark 2019-09-26 22:13:31 +09:00
bin Added binstub for racc executables. 2019-06-19 18:18:17 +09:00
bootstraptest Changed numbered parameter prefix 2019-09-24 21:57:54 +09:00
ccan
coroutine Add assertions to coroutine_initialize_main. 2019-07-19 15:55:34 +12:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Removed idNUMPARAM_0 2019-09-25 13:52:53 +09:00
doc [DOC] DOT is not a part of a receiver [ci skip] 2019-09-20 16:43:39 +09:00
enc Init function is need to link statically 2019-08-10 01:41:50 +09:00
ext [ruby/io-console] Defer creating VT query string 2019-09-26 09:59:27 +09:00
gems Update power_assert to 1.1.5 2019-08-11 11:01:39 +09:00
include include/ruby/ruby.h: suppress a false-positive warning of GCC 2019-09-26 11:35:01 +09:00
lib [rubygems/rubygems] Make sure our modifications to kernel.warn work 2019-09-26 17:48:01 +09:00
libexec [bundler/bundler] Require relatively from exe/ when possible 2019-08-18 13:45:05 +09:00
man Update the latest documentation of bundler 2019-09-18 18:26:33 +09:00
misc lldb_inspect: removed unnecessary newline and end option 2019-09-25 16:58:24 +09:00
missing missing/memcmp.c: suppress a -Wparentheses warning 2019-08-19 14:43:55 +09:00
sample Fix sample/drb/http0serv.rb 2019-08-25 10:56:47 -07:00
spec [EXPERIMENTAL] Make Module#name return a frozen String 2019-09-26 13:25:23 +02:00
template Fixed wrong usage of file2lastrev.rb 2019-09-07 11:59:19 +09:00
test Suppress assert_match warnings. 2019-09-26 18:24:20 +09:00
tool make-snapshot: store timestamps in UTC for zip which lacks timezone 2019-09-23 01:25:17 +09:00
win32 [EXPERIMENTAL] MakeMakefile::CXX for C++ 2019-09-18 18:47:02 +09:00
.dir-locals.el
.document
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Prefix global_symbols with ruby_ 2019-05-16 15:43:16 +09:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Only ignore build directories. 2019-06-20 23:12:48 +12:00
.indent.pro
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Try using Ruby 1.9.3 on Travis xenial 2019-09-18 18:54:09 +09:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c retrieve current path on macOS 2019-08-20 02:05:10 +09:00
addr2line.h
appveyor.yml appveyor.yml - msys2 update code 2019-09-07 10:48:40 +09:00
array.c check ARY_SHARED_ROOT_P(). 2019-09-25 17:12:55 +09:00
ast.c Rename NODE_ARRAY to NODE_LIST to reflect its actual use cases 2019-09-07 13:56:29 +09:00
bignum.c Unused LONG_MAX_as_double 2019-09-10 17:20:31 +09:00
BSDL
class.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
common.mk Use benchmark-driver v0.15.6 2019-09-19 18:04:47 +09:00
compar.c Clarify requirements of <=> 2019-04-22 17:15:49 +09:00
compile.c Allows calling a private method only with bare self 2019-09-20 22:05:54 +09:00
complex.c Make Kernel#{Pathname,BigDecimal,Complex} return argument if given correct type 2019-09-21 16:10:37 -07:00
configure.ac oops 2019-09-10 16:04:17 +09:00
constant.h Module#constant_source_location [Feature #10771] 2019-06-23 01:46:38 +09:00
cont.c Add VM_NO_KEYWORDS 2019-09-05 17:47:12 -07:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
debug_counter.c Fix rb_define_singleton_method warning 2019-09-20 17:44:48 +09:00
debug_counter.h introduce obj_ary_extracapa. 2019-09-25 17:01:54 +09:00
dir.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
dln.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Better wording for __ENCODING__ 2019-08-04 09:03:46 +09:00
enum.c rb_rescue / rb_rescue2 now free from ANYARGS 2019-08-27 15:52:26 +09:00
enumerator.c Handle keyword argument separation for Enumerator#size 2019-09-20 07:45:18 -07:00
error.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
eval.c Revert eval.c in e81a3e6df5 2019-09-21 01:57:29 +09:00
eval_error.c Renamed ruby_finalize_{0,1} 2019-08-13 09:47:08 +09:00
eval_intern.h solve "duplicate :raise event" [Bug #15877] 2019-08-08 17:56:04 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c Add File.absolute_path? (#2198) 2019-09-05 20:00:50 +09:00
gc.c Allow non-finalizable objects in ObjectSpace::WeakMap 2019-08-29 20:40:52 +09:00
gc.h Rename rb_gc_mark_no_pin -> rb_gc_mark_movable 2019-08-12 16:44:54 -04:00
gem_prelude.rb
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c
GPL
hash.c Fix documentation for ENV.each to return ENV 2019-09-20 12:18:07 -07:00
hrtime.h
id_table.c Add GC.compact again. 2019-04-20 01:19:47 +00:00
id_table.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
inits.c Explicitly initialise encodings on init to remove branches on encoding lookup 2019-07-23 16:45:54 +09:00
insns.def reuse cc->call 2019-09-19 15:18:10 +09:00
internal.h Add Module#ruby2_keywords for passing keywords through regular argument splats 2019-09-25 12:33:52 -07:00
io.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
iseq.c Make Method/Proc#parameters handle **nil syntax 2019-08-30 12:39:31 -07:00
iseq.h Unify SUPPORT_JOKE and OPT_SUPPORT_JOKE 2019-09-03 21:12:31 +09:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
loadpath.c
localeinit.c
main.c main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c drop-in type check for rb_define_module_function 2019-08-29 18:34:09 +09:00
math.c Add word "Euler's number" to Math::E docs 2019-08-29 11:57:23 -07:00
method.h Stop packing rb_method_definition_t 2019-07-23 05:20:04 +09:00
miniinit.c
mjit.c RubyVM::MJIT.pause(wait: true) should wait 2019-09-26 16:28:34 +09:00
mjit.h Rename mjit_gc_finish_hook to mjit_gc_exit_hook 2019-05-15 23:14:07 -07:00
mjit_compile.c Just disable inlining with local varaible for now 2019-07-03 10:39:22 +09:00
mjit_worker.c RubyVM::MJIT.pause(wait: true) should wait 2019-09-26 16:28:34 +09:00
NEWS * remove trailing spaces. [ci skip] 2019-09-26 20:25:42 +09:00
node.c NODE_MATCH needs to be marked / allocated from marking bucket 2019-09-10 10:44:49 -07:00
node.h Allows calling a private method only with bare self 2019-09-20 22:05:54 +09:00
numeric.c Inspect dynamic symbol as well as static symbol 2019-08-25 11:39:20 +09:00
object.c Make passing empty keywords to dig pass empty keywords to next dig method 2019-09-20 07:45:11 -07:00
pack.c Added some examples to the documentation for String#unpack1 because 2019-08-09 17:06:07 -07:00
parse.y [EXPERIMENTAL] Expression with modifier in 2019-09-26 15:10:48 +09:00
prelude.rb Document that non-blocking mode isn't always supported on Windows [ci skip] 2019-07-23 07:17:21 -07:00
probes.d
probes_helper.h
proc.c Only set RB_PASS_CALLED_KEYWORDS in C functions called directly from Ruby 2019-09-14 01:49:33 -07:00
process.c Add version that FreeBSD supports CLOCK_PROCESS_CPUTIME_ID [ci skip] 2019-09-05 22:09:15 +09:00
random.c drop-in type check for rb_define_singleton_method 2019-08-29 18:34:09 +09:00
range.c Make Range#=== operate like cover? instead of include? for string ranges 2019-08-14 14:14:49 -07:00
rational.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
re.c drop-in type check for rb_define_singleton_method 2019-08-29 18:34:09 +09:00
README.EXT
README.EXT.ja
README.ja.md Add badges of GitHub Actions [ci skip] 2019-09-18 22:46:05 +09:00
README.md Add badges of GitHub Actions [ci skip] 2019-09-18 22:46:05 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h
regparse.c st_foreach now free from ANYARGS 2019-08-27 15:52:26 +09:00
regparse.h
regsyntax.c
ruby-runner.c Fix warnings 2019-08-28 16:51:48 +09:00
ruby.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
ruby_assert.h respect NDEBUG. 2019-07-19 12:04:32 +09:00
ruby_atomic.h
rubystub.c
safe.c rb_define_hooked_variable now free from ANYARGS 2019-08-27 15:52:26 +09:00
signal.c move docs around [ci skip] 2019-08-29 18:34:09 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c move docs around [ci skip] 2019-08-29 18:34:09 +09:00
st.c st.c: Use rb_st_* prefix instead of st_* (#2479) 2019-09-22 22:12:18 +09:00
strftime.c
string.c [EXPERIMENTAL] Make Symbol#to_s return a frozen String 2019-09-26 10:23:02 +02:00
struct.c Do not turn on keyword_init for Struct subclass if keyword hash is empty 2019-09-03 14:02:24 -07:00
symbol.c Fix a use-after-free bug by avoiding rb_str_new_frozen 2019-09-06 23:35:20 +09:00
symbol.h Add RB_ID_SERIAL_MAX 2019-04-25 13:22:06 +09:00
thread.c Adjusted directives order of a function [ci skip] 2019-09-23 02:21:54 +09:00
thread_pthread.c rb_thread_create now free from ANYARGS 2019-08-27 15:52:26 +09:00
thread_pthread.h
thread_sync.c fix arity of rb_mutex_synchronize_m 2019-08-29 18:34:09 +09:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c Specify encoding explicitly for sprintf 2019-09-19 20:45:24 +09:00
timev.h timev.h: dummy definition for TAGS 2019-04-10 12:43:31 +00:00
transcode.c transcode.c (rb_econv_open0): remove unused code 2019-07-24 04:49:51 +09:00
transcode_data.h
transient_heap.c prefix ASAN related inline functions asan_ 2019-05-23 17:24:53 +09:00
transient_heap.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
util.c
variable.c [EXPERIMENTAL] Make Module#name return a frozen String 2019-09-26 13:25:23 +02:00
version.c Update RDoc of RUBY_REVISION 2019-06-06 08:21:40 +09:00
version.h * 2019-09-26 [ci skip] 2019-09-26 00:27:40 +09:00
vm.c suppress meddlesome clang10 warrning 2019-09-24 11:50:38 +09:00
vm_args.c Add Module#ruby2_keywords for passing keywords through regular argument splats 2019-09-25 12:33:52 -07:00
vm_backtrace.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
vm_core.h Add Module#ruby2_keywords for passing keywords through regular argument splats 2019-09-25 12:33:52 -07:00
vm_debug.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +09:00
vm_dump.c crash report on mac little update 2019-08-19 17:36:28 +09:00
vm_eval.c Make public_send and rb_f_send handle keyword argument separation 2019-09-23 09:28:27 -07:00
vm_exec.c
vm_exec.h Fixed format specifiers 2019-09-20 23:57:20 +09:00
vm_insnhelper.c Add Module#ruby2_keywords for passing keywords through regular argument splats 2019-09-25 12:33:52 -07:00
vm_insnhelper.h Merge pull request #2422 from jeremyevans/rb_keyword_given_p 2019-09-03 11:32:02 -07:00
vm_method.c Add Module#ruby2_keywords for passing keywords through regular argument splats 2019-09-25 12:33:52 -07:00
vm_opts.h Unify SUPPORT_JOKE and OPT_SUPPORT_JOKE 2019-09-03 21:12:31 +09:00
vm_trace.c Renamed ruby_finalize_{0,1} 2019-08-13 09:47:08 +09:00
vsnprintf.c Use array indexing with considering clang's feeling 2019-08-27 14:25:58 +09:00
wercker.yml Generalize timeout_scale 2019-06-11 23:15:46 +09:00

Build Status wercker status Build status Build 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 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. Optionally, run make update-gems and make extract-gems.

    If you want to install bundled gems, run make update-gems and make extract-gems before running make install.

  9. 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