development fork of ruby/ruby
Перейти к файлу
Matt Valentine-House b6390a21eb [ci skip] More docs for InstructionSequence.compile
This commit documents that you can also pass a `File` object to
`RubyVM::InstructionSequence.compile`, instead of a string, and this
will behave in a similar way to
`RubyVM::InstructionSequence.compile_file`

e.g.

```
❯ ./ruby -e "puts RubyVM::InstructionSequence.compile(File.open('test.rb')).disasm"
== disasm: #<ISeq:<compiled>@<compiled>:1 (1,0)-(2,21)>
local table (size: 1, argc: 0 [opts: 0, rest: -1, post: 0, block: -1, kw: -1@-1, kwrest: -1])
[ 1] name@0
0000 putstring                              "Ruby"                    (   1)[Li]
0002 setlocal_WC_0                          name@0
0004 putself                                                          (   2)[Li]
0005 putobject                              "Hello, "
0007 getlocal_WC_0                          name@0
0009 dup
0010 objtostring                            <calldata!mid:to_s, argc:0, FCALL|ARGS_SIMPLE>
0012 anytostring
0013 concatstrings                          2
0015 opt_send_without_block                 <calldata!mid:puts, argc:1, FCALL|ARGS_SIMPLE>
0017 leave

~/git/ruby master* ≡ ⇡
❯ ./ruby -e "puts RubyVM::InstructionSequence.compile(File.open('test.rb').read).disasm"
== disasm: #<ISeq:<compiled>@<compiled>:1 (1,0)-(2,21)>
local table (size: 1, argc: 0 [opts: 0, rest: -1, post: 0, block: -1, kw: -1@-1, kwrest: -1])
[ 1] name@0
0000 putstring                              "Ruby"                    (   1)[Li]
0002 setlocal_WC_0                          name@0
0004 putself                                                          (   2)[Li]
0005 putobject                              "Hello, "
0007 getlocal_WC_0                          name@0
0009 dup
0010 objtostring                            <calldata!mid:to_s, argc:0, FCALL|ARGS_SIMPLE>
0012 anytostring
0013 concatstrings                          2
0015 opt_send_without_block                 <calldata!mid:puts, argc:1, FCALL|ARGS_SIMPLE>
0017 leave
```

This is explicitly allowed by this code path in
`rb_iseq_compile_with_option` so we should document it.

```
    if (RB_TYPE_P(src, T_FILE)) {
        parse = rb_parser_compile_file_path;
    }
    else {
        parse = rb_parser_compile_string_path;
        StringValue(src);
    }
```
2023-10-02 12:31:34 +01:00
.github [CI] Fix conditional for `RUBYOPT` 2023-09-28 10:10:11 +09:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark Add benchmarks for Range#bsearch 2023-09-26 17:31:10 +09:00
bin Revert "[ruby/syntax_suggest] Introduce binstubs to set RUBYOPT for development" 2023-04-06 16:36:09 +09:00
bootstraptest YJIT: Chain-guard opt_mult overflow (#8554) 2023-09-29 21:55:48 -04:00
ccan Fix -Wundef warnings 2022-10-26 18:57:26 +09:00
coroutine Avoid memory dependency between instructions. (#8284) 2023-08-25 13:28:33 +12:00
coverage
cygwin leaked-globals: check leaked symbols in libruby.so if enable-shared 2023-07-08 11:31:17 +09:00
defs Download Unicode files once [ci skip] 2023-09-26 02:09:57 +09:00
doc [DOC] Correction for doc guide + TOC fix in File (#8505) 2023-09-24 17:57:21 -04:00
enc Add `modencs` target to build encodings/transcoders as modules 2023-09-11 11:06:49 +09:00
ext [ruby/psych] Update SnakeYAML Engine to 2.7 2023-10-02 11:47:36 +09:00
gems Requires ruby/rbs#1550 2023-09-28 17:53:02 +09:00
include Fix documentation for rb_warn() and friends 2023-09-29 12:53:40 +02:00
internal Move IO#readline to Ruby 2023-09-28 10:43:45 -07:00
lib [rubygems/rubygems] Support Ruby's preview version format (Ex: 3.3.0-preview2) in Gemfile 2023-10-02 02:19:43 +00:00
libexec Removed executable of racc 2023-06-08 17:25:38 +09:00
man [Feature #19790] [DOC] Fix the manual page as crash report 2023-09-25 23:22:52 +09:00
misc Fix RBignum print [ci skip] 2023-09-30 02:09:29 +09:00
missing Dump backtraces to an arbitrary stream when using libprocstat 2023-09-26 09:02:37 +09:00
prism [ruby/prism] remove `peek_string` to avoid subtle memory issues 2023-09-29 20:41:23 +00:00
sample Add all-ruby-quine as a sample code 2023-02-27 11:20:42 +09:00
spec [rubygems/rubygems] Support Ruby's preview version format (Ex: 3.3.0-preview2) in Gemfile 2023-10-02 02:19:43 +00:00
template Move YARP_BUILD_DIR to common.mk 2023-09-21 18:18:27 +09:00
test [ruby/psych] Add test for code_point_limit 2023-10-02 11:47:35 +09:00
tool Use the hexdigit character class 2023-10-02 00:49:05 +09:00
wasm Simplify try-rescue loop 2023-08-08 08:34:53 +09:00
win32 Rename YARP symbols to prism 2023-09-27 13:57:38 -04:00
yjit YJIT: Chain-guard opt_mult overflow (#8554) 2023-09-29 21:55:48 -04:00
.appveyor.yml Revert vcpkg.exe to previous release [ci skip] 2023-09-19 18:52:21 +09:00
.cirrus.yml Do not auto-cancel builds on pull requests 2023-08-01 15:36:27 -07:00
.dir-locals.el
.document [DOC] No document under win32 2023-05-27 02:07:47 +09:00
.editorconfig
.gdbinit Remove nd_entry from NODE_GASGN and NODE_GVAR 2023-08-23 07:59:54 +09:00
.git-blame-ignore-revs Add indentation to ignore revs [ci skip] 2023-09-29 00:57:09 +09:00
.gitattributes
.gitignore Rename YARP filepaths to prism filepaths 2023-09-27 13:57:38 -04:00
.indent.pro Update .indent.pro [ci skip] 2022-07-22 21:59:58 +09:00
.rdoc_options [DOC] Set the documentation title and main page 2022-02-21 13:08:06 +09:00
.rspec_parallel
.travis.yml .travis.yml: Upgrade the used Ubuntu s390x to 22.04 (Jammy). (#8401) 2023-09-29 18:16:58 +02:00
BSDL
CONTRIBUTING.md Improve documentation on contributing to Ruby 2022-05-11 10:59:24 -04:00
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb
LEGAL Remove about ext/psych/yaml which is no longer bundled [ci skip] 2023-01-11 18:05:15 +09:00
NEWS.md Update default gems list at be63e2515b [ci skip] 2023-09-29 15:22:54 +00:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Fixes for link fragments (#7981) 2023-06-28 09:05:43 -04:00
README.md [DOC] Fixes for link fragments (#7981) 2023-06-28 09:05:43 -04:00
aclocal.m4
addr2line.c Fix build on FreeBSD 2023-09-26 02:07:32 +09:00
addr2line.h Dump backtraces to an arbitrary stream 2023-09-25 22:57:28 +09:00
array.c Keep write-barrier status after splicing array 2023-09-04 08:50:27 -04:00
array.rb [DOC] Improve doc guide compliance (#8221) 2023-08-15 14:43:58 -04:00
ast.c Use rb_node_args_t and rb_node_args_aux_t instead of NODE 2023-10-01 19:38:03 +09:00
ast.rb Move SCRIPT_LINES__ away from parse.y 2023-08-25 18:23:05 +09:00
autogen.sh
bignum.c * expand tabs. [ci skip] 2023-06-30 14:59:34 +00:00
builtin.c `rb_bug` prints a newline after the message 2023-05-20 21:43:30 +09:00
builtin.h Remove MJIT's builtin function compiler 2023-03-07 23:16:24 -08:00
class.c [Bug #19901] 2023-09-23 23:10:46 +02:00
common.mk Move CRuby-specific prism files to top level 2023-09-28 09:44:16 -04:00
compar.c [DOC] Correct docs for Comparable 2023-04-10 01:09:03 +09:00
compile.c Check the result of get_nd_recv before node type check for safety 2023-10-02 09:41:45 +09:00
complex.c [Feature #19474] Refactor NEWOBJ macros 2023-04-06 11:07:16 +01:00
configure.ac [Bug #19778] Pass additional include options to INCFLAGS in common.mk 2023-09-17 19:18:23 +09:00
constant.h Stop exporting symbols for MJIT 2023-03-06 21:59:23 -08:00
cont.c Fix support for dynamic keys. (#8273) 2023-08-24 15:19:33 +12:00
darray.h Implement weak references in the GC 2023-08-25 09:01:21 -04:00
debug.c Hide the usage of `rb_io_t` where possible. (#7880) 2023-06-01 14:23:30 +09:00
debug_counter.c Stop exporting symbols for MJIT 2023-03-06 21:59:23 -08:00
debug_counter.h Add Missing Counters to `rb_debug_counter_type` enum (#8297) 2023-08-25 15:27:56 -07:00
dir.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
dir.rb [rubygems/rubygems] Bundler: Update bundle-outdated(1) man 2023-07-24 23:58:06 +00:00
dln.c Update dln.c to fix error output from `dln_open()` 2023-03-21 19:10:19 +09:00
dln.h
dln_find.c Don't check for null pointer in calls to free 2023-06-30 09:13:31 -04:00
dmydln.c
dmyenc.c Expand tabs [ci skip] 2022-07-21 09:42:04 -07:00
dmyext.c
encindex.h Rename ENCINDEX_ASCII to ENCINDEX_ASCII_8BIT 2022-07-19 08:48:56 +02:00
encoding.c Mark Encoding as Write Barrier protected 2023-02-07 11:48:57 +01:00
enum.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
enumerator.c Fix stack trace for rescued StopIteration 2023-07-15 15:24:43 +09:00
error.c [Feature #19790] Rename BUGREPORT_PATH as CRASH_REPORT 2023-09-25 22:57:28 +09:00
eval.c Add Refinement#target and deprecate Refinement#refined_class 2023-07-31 17:23:17 +09:00
eval_error.c [Bug #19774] Fix segfault at `return` in `END` 2023-07-19 03:40:05 +09:00
eval_intern.h Add hints of tag jumps for optimization 2023-08-07 10:32:47 +09:00
eval_jump.c [Bug #19016] re-order error handling at cleanup 2022-11-22 00:33:19 +09:00
file.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
gc.c Use reference counting to avoid memory leak in kwargs 2023-10-01 10:55:19 -04:00
gc.rb Add stat force_incremental_marking_finish_count 2023-08-15 15:18:05 -04:00
gem_prelude.rb Warn default gems which will be gemified in future 2023-07-28 14:57:10 +09:00
golf_prelude.rb
goruby.c Expand tabs [ci skip] 2022-07-21 09:42:04 -07:00
hash.c [DOC] Missing comment marker 2023-09-27 15:50:37 +09:00
hrtime.h Fix per-instance Regexp timeout (#6621) 2022-10-24 18:03:26 +09:00
id_table.c Stop exporting symbols for MJIT 2023-03-06 21:59:23 -08:00
id_table.h Transition complex objects to "too complex" shape 2022-12-15 10:06:04 -08:00
inits.c Rename YARP symbols to prism 2023-09-27 13:57:38 -04:00
insns.def Remove unused opt_call_c_function insn (#7750) 2023-04-21 23:58:07 -07:00
internal.h Don't redefine RB_OBJ_WRITE 2023-01-18 08:49:32 -05:00
io.c Move IO#readline to Ruby 2023-09-28 10:43:45 -07:00
io.rb Move IO#readline to Ruby 2023-09-28 10:43:45 -07:00
io_buffer.c Fix `io_buffer_get_string` default length computation. (#8427) 2023-09-14 20:37:43 +12:00
iseq.c [ci skip] More docs for InstructionSequence.compile 2023-10-02 12:31:34 +01:00
iseq.h support `rescue` event for TracePoint 2023-08-01 22:46:17 +09:00
kernel.rb Update documentation for `yield_self` and `then` 2023-09-29 19:32:12 +09:00
lex.c.blt reserved_word: just use gperf 3.1 declaration 2022-09-21 11:44:09 +09:00
load.c Add notes and name a magic number 2023-08-22 23:46:32 +09:00
loadpath.c
localeinit.c Expand tabs [ci skip] 2022-07-21 09:42:04 -07:00
main.c Enable DEBUG_LOG feature on USE_RUBY_DEBUG_LOG 2023-03-01 17:18:43 +09:00
marshal.c Align the type of `num_entries` to `st_table` 2023-08-20 20:12:44 +09:00
marshal.rb
math.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
memory_view.c Expand tabs [ci skip] 2022-07-21 09:42:04 -07:00
method.h Try to fix compilation on m68k 2023-09-22 16:14:09 -04:00
mini_builtin.c Clean up OPT_STACK_CACHING (#8132) 2023-07-27 17:27:05 -07:00
miniinit.c
nilclass.rb
node.c Expand pattern_info struct into ARYPTN Node and FNDPTN Node 2023-09-30 13:11:32 +09:00
node.h Change RNode structure from union to struct 2023-09-28 11:58:10 +09:00
node_dump.c Use rb_node_opt_arg_t and rb_node_kw_arg_t instead of NODE 2023-10-01 09:19:42 +09:00
numeric.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
numeric.rb Rewrite Integer#times in Ruby (#8388) 2023-09-07 10:57:52 -07:00
object.c [Bug #19349] Respect `#to_int` of `base` argument 2023-08-31 16:49:58 +09:00
pack.c Fix a typo in BUG message [ci skip] 2023-01-20 00:20:27 +09:00
pack.rb [DOC] Link to packed data doc (#6567) 2022-10-18 10:16:22 -05:00
parse.y Include new node types into %printer 2023-10-02 13:49:57 +09:00
parser_bits.h [Feature #19719] Universal Parser 2023-06-12 18:23:48 +09:00
parser_node.h Change RNode structure from union to struct 2023-09-28 11:58:10 +09:00
parser_st.c Define `NO_SANITIZE` with reference to ext/bigdecimal/missing.c 2023-07-01 23:16:54 +09:00
parser_st.h Fix memory leak when copying ST tables 2023-06-29 11:16:50 -04:00
parser_value.h [Feature #19719] Universal Parser 2023-06-12 18:23:48 +09:00
prelude.rb Fix ruby_testoptions on RubyCI 2023-03-08 12:00:14 -08:00
prism_compile.c Move more things through pm_static_literal_value 2023-09-29 09:51:23 -04:00
prism_init.c Move CRuby-specific prism files to top level 2023-09-28 09:44:16 -04:00
probes.d
probes_helper.h Stop exporting symbols for MJIT 2023-03-06 21:59:23 -08:00
proc.c Make Kernel#lambda raise when given non-literal block 2023-09-12 11:25:07 -04:00
process.c [DOC] Another example for spawn (#8575) 2023-10-01 19:37:40 -04:00
ractor.c [Feature #19730] Remove transient heap 2023-07-13 09:27:33 -04:00
ractor.rb `Ractor::Selector#empty?` 2023-03-03 00:08:02 +09:00
ractor_core.h macos: symbols for `rb_execution_context_t` should be internal 2023-07-08 11:31:17 +09:00
random.c [DOC] Improve Random::Formatter docs 2022-12-11 18:49:56 +02:00
range.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
rational.c [Feature #19474] Refactor NEWOBJ macros 2023-04-06 11:07:16 +01:00
re.c Reuse Regexp ptr when recompiling 2023-07-31 09:17:18 -04:00
regcomp.c Use onig_new_without_alloc for onig_new 2023-07-27 15:39:05 -04:00
regenc.c Prevent potential buffer overrun in onigmo 2022-10-25 17:02:43 +09:00
regenc.h Prevent potential buffer overflow on enclen 2022-12-12 16:21:31 +09:00
regerror.c
regexec.c Add function rb_reg_onig_match 2023-07-27 13:33:40 -04:00
regint.h Delay start of the match cache optimization (#7738) 2023-05-04 13:15:51 +09:00
regparse.c Don't check for null pointer in calls to free 2023-06-30 09:13:31 -04:00
regparse.h
regsyntax.c
rjit.c RJIT: Tweak the default call threshold 2023-04-26 18:19:48 -07:00
rjit.h RJIT: Add --rjit-verify-ctx option 2023-04-04 00:35:29 -07:00
rjit.rb RJIT: Implement --rjit-trace-exits 2023-03-12 15:15:08 -07:00
rjit_c.c `rb_bug` prints a newline after the message 2023-05-20 21:43:30 +09:00
rjit_c.h RJIT: Support entry with different PCs 2023-04-02 15:27:40 -07:00
rjit_c.rb Use reference counting to avoid memory leak in kwargs 2023-10-01 10:55:19 -04:00
ruby-runner.c Stop building mjit_build_dir.so 2023-03-06 22:14:44 -08:00
ruby.c [Feature #19790] Rename BUGREPORT_PATH as CRASH_REPORT 2023-09-25 22:57:28 +09:00
ruby_assert.h
ruby_atomic.h
ruby_parser.c Change RNode structure from union to struct 2023-09-28 11:58:10 +09:00
rubyparser.h Remove not used fields from call nodes 2023-10-02 09:41:45 +09:00
rubystub.c `ruby_init_setproctitle` declaration has moved to internal/missing.h 2022-08-31 15:31:47 +09:00
scheduler.c [DOC] Fix method docs of scheduler#io_read and scheduler#io_write 2023-09-10 19:39:28 +09:00
shape.c `rb_bug` prints a newline after the message 2023-05-20 21:43:30 +09:00
shape.h Move shape ID to flags for classes on 32 bit 2023-04-16 11:06:31 -04:00
signal.c Reset signal handler before aborting due to sanitizer 2023-07-19 00:06:53 +09:00
siphash.c Fix and improve coroutines for Darwin (macOS) ppc/ppc64. (#5975) 2022-10-19 23:49:45 +13:00
siphash.h
sparc.c [DOC]Some link prefix replace 2022-04-09 17:43:46 +09:00
sprintf.c [Bug #19167] Remove useless conversion of classes for special const 2022-12-09 22:11:44 +09:00
st.c Define `NO_SANITIZE` with reference to ext/bigdecimal/missing.c 2023-07-01 23:16:54 +09:00
strftime.c Introduce encoding check macro 2022-12-02 01:31:27 +09:00
string.c [DOC] Missing comment markers 2023-09-27 16:18:05 +09:00
string.rb [DOC] Improve doc guide compliance (#8221) 2023-08-15 14:43:58 -04:00
struct.c [DOC] Improve doc guide compliance (#8221) 2023-08-15 14:43:58 -04:00
symbol.c Compile debugging code for symbol and ID always 2023-06-30 23:59:05 +09:00
symbol.h [Bug #19882] Reject tokens invalid as symbols 2023-09-15 17:27:36 +09:00
symbol.rb Remove (newly unneeded) remarks about aliases 2023-02-19 14:26:34 -08:00
thread.c Optimize handle_interrupt(Exception => ..) as a common case 2023-09-07 13:51:15 -07:00
thread_none.c Compile disabled code for thread cache always 2023-06-30 23:59:05 +09:00
thread_none.h introduce struct `rb_native_thread` 2022-04-23 03:08:27 +09:00
thread_pthread.c Fix Thread#native_thread_id being cached across fork (#8418) 2023-09-15 10:33:32 +09:00
thread_pthread.h macos: symbols for `rb_execution_context_t` should be internal 2023-07-08 11:31:17 +09:00
thread_sync.c Make {Queue,SizedQueue}#freeze raise TypeError 2023-09-27 19:57:50 +01:00
thread_sync.rb thread_sync.c: Clarify and document the behavior of timeout == 0 2022-10-17 16:56:00 +02:00
thread_win32.c Compile disabled code for thread cache always 2023-06-30 23:59:05 +09:00
thread_win32.h Move rb_thread_cond_struct definition into thread_native.h 2023-05-26 14:51:23 +09:00
time.c [DOC] Specify the unit of return value for `Time#-` 2023-08-16 22:51:17 +09:00
timev.h Fix crash in Time on 32-bit systems 2023-04-04 11:12:07 -04:00
timev.rb [DOC] Improve doc guide compliance (#8221) 2023-08-15 14:43:58 -04:00
trace_point.rb [DOC] Remove Document-class from trace_point.rb 2023-08-14 11:48:39 -04:00
transcode.c Don't check for null pointer in calls to free 2023-06-30 09:13:31 -04:00
transcode_data.h Expand tabs [ci skip] 2022-07-21 09:42:04 -07:00
universal_parser.c Directly free structure managed by imemo tmpbuf 2023-09-22 11:25:53 +09:00
util.c Remove duplicate `#include <string.h>` [ci skip] 2023-08-27 23:21:20 +09:00
variable.c Refactor rb_ensure_iv_list_size 2023-08-21 09:13:36 -04:00
variable.h Remove dependancy of vm_core.h on shape.h 2023-04-06 11:07:16 +01:00
version.c Move `MKSTR` markers for fake.rb into coments 2023-08-20 13:29:42 +09:00
version.h Auto-generate the release date on version.h from git CommitDate (#6382) 2022-09-17 21:16:06 +09:00
vm.c Move IO#readline to Ruby 2023-09-28 10:43:45 -07:00
vm_args.c Make Kernel#lambda raise when given non-literal block 2023-09-12 11:25:07 -04:00
vm_backtrace.c Dump backtraces to an arbitrary stream 2023-09-25 22:57:28 +09:00
vm_callinfo.h Use reference counting to avoid memory leak in kwargs 2023-10-01 10:55:19 -04:00
vm_core.h Abort dumping when output failed 2023-09-25 22:57:28 +09:00
vm_debug.h Allow `RUBY_DEBUG_LOG` format to be empty 2022-08-06 10:52:00 +09:00
vm_dump.c Dump backtraces to an arbitrary stream when using libprocstat 2023-09-26 09:02:37 +09:00
vm_eval.c Fix typo in "refinements" 2023-09-19 19:34:50 -04:00
vm_exec.c Remove an unused argument in vm_exec_core 2023-07-27 17:31:27 -07:00
vm_exec.h Clean up OPT_STACK_CACHING (#8132) 2023-07-27 17:27:05 -07:00
vm_insnhelper.c [Bug #19896] 2023-09-22 09:44:58 -04:00
vm_insnhelper.h Move the PC regardless of the leaf flag (#8232) 2023-08-16 20:28:33 -07:00
vm_method.c [Bug #19896] 2023-09-22 09:44:58 -04:00
vm_opts.h Clean up OPT_STACK_CACHING (#8132) 2023-07-27 17:27:05 -07:00
vm_sync.c Move RB_VM_SAVE_MACHINE_CONTEXT to internal/thread.h 2023-03-15 21:26:26 +00:00
vm_sync.h `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
vm_trace.c [Bug #18487] [DOC] Remove stale note in `set_trace_func` document 2023-09-04 10:35:26 +09:00
vsnprintf.c Fix compiler warning with compiling on 32 bit 2023-04-13 16:44:01 -04:00
warning.rb [DOC] [Bug #19290] fix formatting 2023-01-01 14:50:39 +09:00
weakmap.c Fix crash in WeakMap during compaction 2023-09-06 14:20:23 -04:00
yjit.c YJIT: Quiet mode when running with `--yjit-stats` (#8251) 2023-08-18 18:27:59 -04:00
yjit.h YJIT: Compile exception handlers (#8171) 2023-08-08 16:06:22 -07:00
yjit.rb YJIT: Report all insn exit reasons (#8541) 2023-09-29 10:03:02 -04:00

README.md

Actions Status: MinGW Actions Status: RJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus Status

What is 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://docs.ruby-lang.org/en/master/maintainers_md.html#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/

You can download release packages and the snapshot of the repository. If you want to download whole versions of Ruby, please visit https://www.ruby-lang.org/en/downloads/releases/.

Download with 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.

How to build

See Building Ruby

Ruby home page

https://www.ruby-lang.org/

Documentation

Mailing list

There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:

join

in the mail subject (not body) to the address ruby-talk-request@ml.ruby-lang.org.

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 "Reporting Issues" for more information.

Contributing

See "Contributing to Ruby", which includes setup and build instructions.

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

matz@ruby-lang.org