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
Use amazing-print instead e7a831de8e Improve the wording surrounding Proc#isolate
This change moves the statement that `Proc#isolate` isn't yet exposed for Ruby users to the first time the method is mentioned. This is so that readers don't waste time trying to look it up in Ruby docs.

There was also unnecessary duplication:
```
Paragraph 1: "Given block will be isolated from outer scope by Proc#isolate."
Paragraph 2: "Given block will be isolated by Proc#isolate method"
```
So I combined the two sentences and slightly improved the wording for clarity.
2021-02-09 08:22:37 -05:00
.github Stop disabling firewall 2021-02-06 13:13:58 +09:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark Improve performance Float#positive? and Float#negative? [Feature #17614] (#4160) 2021-02-08 20:29:42 -08:00
bin Promote erb to default gems 2020-08-21 20:18:44 +09:00
bootstraptest Implement NameError::message#clone for Ractor 2021-02-01 19:54:21 +09:00
ccan
coroutine coroutine/emscripten/: Experimentally support emscripten fiber API 2021-01-23 18:56:06 +09:00
coverage
cygwin Fix for windres 2.36 [Bug #17602] 2021-02-01 14:59:47 +09:00
defs gmake.mk: renamed BUNDLED_GEMS as bundled-gems 2020-12-02 17:04:33 +09:00
doc Improve the wording surrounding Proc#isolate 2021-02-09 08:22:37 -05:00
enc transcode-tblgen.rb: make silent a little when just -v 2020-12-29 17:45:19 +09:00
ext [ruby/console] Updated depend 2021-02-09 17:49:28 +09:00
gems Update bundled_gems 2021-01-31 11:27:51 +09:00
include Define macro for fiber/scheduler.h 2021-02-09 17:15:29 +09:00
internal Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
lib [ruby/benchmark] Adds Tms#to_h 2021-02-07 23:06:17 -05:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
misc Promote webrick to bundled gems 2020-12-10 18:06:25 +09:00
missing dtoa.c: make thread-safe by using atomic CAS 2021-01-10 18:19:53 +09:00
sample Remove samples for test-unit 2021-01-17 06:08:21 +09:00
spec Fix failures with EditLine 2021-02-03 14:38:31 +09:00
template Support coroutine on universal binary 2021-01-22 23:41:52 +09:00
test Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
tool vcs.rb: update the given option to VCS.detect by keyword arguments 2021-02-08 23:56:19 +09:00
win32 win32/win32.c:getcwd_value: delete OBJ_TAINT 2021-01-27 09:30:15 +09:00
.dir-locals.el
.document Sort filenames [ci skip] 2021-01-15 12:29:39 +09:00
.editorconfig
.gdbinit .gdbinit: Fix indentation in print_id [ci skip] 2021-02-06 13:03:40 -05:00
.gitattributes
.gitignore Ignore static-ruby [ci skip] 2020-11-24 08:38:06 +09:00
.rspec_parallel
.travis.yml .travis.yml: delete x86_64 2020-11-04 12:11:13 +09:00
aclocal.m4 ruby_type_attribute is not used for now 2021-01-18 16:22:09 +09:00
addr2line.c addr2line.c: DW_LNS_fixed_advance_pc takes a single uhalf operand 2021-02-04 17:45:54 +09:00
addr2line.h
appveyor.yml Add some git configurations in CIs 2021-02-02 14:54:53 +09:00
array.c [DOC] {Array,MatchData}#values_at understand ranges [ci skip] 2021-02-07 10:30:43 +09:00
array.rb array.rb: Remove unnecessary phrase from rdoc 2020-11-12 16:59:59 +09:00
ast.c Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +09:00
ast.rb Fix RubyVM::AbstractSyntaxTree document 2020-06-24 15:17:53 +09:00
bignum.c bignum.c: Make sure the argument of LONG2FIX is long 2021-01-23 16:05:33 +09:00
BSDL
builtin.c builtin_lookup: do not goto into a branch 2020-06-29 11:05:41 +09:00
builtin.h skip inlining cexpr! that are not attr! inline 2020-07-16 11:49:09 +09:00
class.c Add RCLASS_SUBCLASSES Macro 2021-02-01 08:42:54 -08:00
common.mk Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
compar.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
compile.c Mark pattern labels as unremoveable 2021-01-19 08:34:01 +09:00
complex.c Follow the NDEBUG given to the whole 2021-01-07 16:52:10 +09:00
configure.ac Fixed default coroutine selection for musl. 2021-02-09 18:48:03 +13:00
constant.h
cont.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c USE_RUBY_DEBUG_LOG is not defined !devel build 2020-12-25 09:52:18 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
dir.c Check stack overflow in recursive glob_helper [Bug #17162] 2021-01-13 12:16:00 +09:00
dir.rb [DOC] more precise description of "**" in Dir.glob pattern [ci skip] 2020-10-27 08:55:10 +09:00
dln.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
dln.h dln.h: delete unused codes 2020-07-23 14:30:12 +09:00
dln_find.c dln_find_1: do not goto into a branch 2020-06-29 11:05:41 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c No sync on ASCII/US_ASCCII/UTF-8 2020-12-17 03:44:23 +09:00
enum.c RDoc: Enhanced introduction for Enumerable (#4004) 2021-01-04 23:39:13 -05:00
enumerator.c Replace Kernel.#open with URI.open in doc 2021-01-08 07:31:27 -08:00
error.c Fix grammatical error 2021-02-06 13:02:17 -05:00
eval.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
eval_error.c Limit bactrace length from Exception#full_message 2020-12-27 20:50:15 +09:00
eval_intern.h Threads in a ractor will be killed with the ractor 2020-11-11 15:49:02 +09:00
eval_jump.c
file.c Keep encoding in the result of File.expand_path [Bug #17517] 2021-01-15 17:46:48 +09:00
gc.c Don't register non-heap allocated objects 2021-02-04 09:49:00 -08:00
gc.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
gc.rb Add documentation about GC.compact 2020-12-17 13:26:53 -08:00
gem_prelude.rb Removed needless .rb 2020-12-02 13:32:43 +09:00
golf_prelude.rb
goruby.c goruby_options: do not goto into a branch 2020-06-29 11:05:41 +09:00
GPL
hash.c Explicit references to Enumerable 2021-01-20 09:33:41 -08:00
hrtime.h
id_table.c Suppress unused-variable warning 2020-08-10 17:49:08 +09:00
id_table.h sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
inits.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
insns.def enable constant cache on ractors 2021-01-05 02:27:58 +09:00
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
io.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c remove invalidated cc 2021-01-06 14:57:48 +09:00
iseq.h check isolated Proc more strictly 2020-10-29 23:42:55 +09:00
kernel.rb [DOC] Use URI#read instead of URI.open for better compatibility 2021-01-12 22:12:02 +09:00
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL Added did_you_mean entry because did_you_mean uses MIT license 2020-08-19 19:36:16 +09:00
lex.c.blt
load.c Suppress a "clobbered" warning by gcc on macOS 2020-12-11 01:17:15 +09:00
loadpath.c
localeinit.c win32: Use UTF-8 as filesystem encoding [Feature #12654] 2020-12-20 18:34:04 +09:00
main.c stdlib.h is always included in include/ruby/defines.h 2021-01-05 01:06:33 +09:00
marshal.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
math.c [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
memory_view.c [memory_view] Acquire VM lock while running exported_object_registry_free 2020-12-23 09:24:55 +09:00
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c
miniinit.c
mjit.c enable constant cache on ractors 2021-01-05 02:27:58 +09:00
mjit.h enable constant cache on ractors 2021-01-05 02:27:58 +09:00
mjit_compile.c Prefer stdbool in vm_exec 2020-12-21 21:16:39 -08:00
mjit_worker.c Avoid hanging on --jit-wait after MJIT.pause 2021-01-03 00:05:38 -08:00
NEWS.md Update NEWS.md about deprecation 2021-01-20 22:02:52 -08:00
node.c NODE markability should not change by nd_set_type 2021-01-14 16:12:02 +09:00
node.h NODE markability should not change by nd_set_type 2021-01-14 16:12:02 +09:00
numeric.c Improve performance Float#positive? and Float#negative? [Feature #17614] (#4160) 2021-02-08 20:29:42 -08:00
numeric.rb Improve performance Float#positive? and Float#negative? [Feature #17614] (#4160) 2021-02-08 20:29:42 -08:00
object.c [DOC] Modified prefixes to get rid of conflicts 2021-02-07 23:35:06 +09:00
pack.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
pack.rb [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
parse.y Removed YYUSE [Bug #17582] 2021-01-26 21:57:09 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d remove method__cache__clear 2020-12-24 01:59:36 +09:00
probes_helper.h
proc.c Split mnew into unbound and callable 2021-01-31 18:48:28 +09:00
process.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
ractor.c fix Ractor.yield(obj, move: true) 2021-01-22 12:16:37 +09:00
ractor.rb Fix ractor docs (#4048) [doc] 2021-01-10 15:39:37 -05:00
ractor_core.h fix Ractor.yield(obj, move: true) 2021-01-22 12:16:37 +09:00
random.c Do not allocate ractor-local storage in dfree function during GC 2021-02-09 01:00:00 +09:00
range.c Use public allocators for creating new T_OBJECT objects 2020-10-28 18:35:22 -07:00
rational.c Rationalize floats in coerce [Bug #17572] 2021-01-23 11:13:21 +09:00
re.c [DOC] {Array,MatchData}#values_at understand ranges [ci skip] 2021-02-07 10:30:43 +09:00
README.EXT
README.EXT.ja
README.ja.md Update labels of badges [ci skip] 2020-12-26 18:31:50 +09:00
README.md Update labels of badges [ci skip] 2020-12-26 18:31:50 +09:00
regcomp.c Right size literal regular expression buffers on compile 2020-12-10 18:15:26 +09:00
regenc.c
regenc.h
regerror.c
regexec.c
regint.h Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
regparse.c Do not reduce quantifiers if it affects which text will be matched 2020-12-02 18:42:02 +01:00
regparse.h
regsyntax.c
ruby-runner.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
ruby.c Moved --verbose, --verbose and --help options to last [ci skip] 2021-01-24 14:59:41 +09:00
ruby_assert.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11: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 strip trailing spaces [ci skip] 2021-02-09 16:59:15 +09:00
signal.c Replace "iff" with "if and only if" 2021-01-19 12:06:45 -08:00
siphash.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
siphash.h
sparc.c
sprintf.c sprintf.c: Removed conflicting definition 2020-09-28 12:51:53 +09:00
st.c Replace "iff" with "if and only if" 2021-01-19 12:06:45 -08:00
strftime.c rb_strftime_with_timespec: do not goto into a branch 2020-06-29 11:05:41 +09:00
string.c Remove unsued str_new_shared function declaration 2021-02-04 16:25:55 +09:00
struct.c Warn Struct#initialize with only keyword args (#4070) 2021-01-17 01:35:54 -08:00
symbol.c sync ruby_global_symbols 2020-09-18 14:17:49 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
thread_pthread.c add debug code for timer_posix 2021-02-02 20:20:39 +09:00
thread_pthread.h fix public interface 2020-11-18 03:52:41 +09:00
thread_sync.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
thread_win32.c fix public interface 2020-11-18 03:52:41 +09:00
thread_win32.h fix public interface 2020-11-18 03:52:41 +09:00
time.c Added in: timezone option to Time.new [Feature #17485] 2021-01-13 18:15:50 +09:00
timev.h
timev.rb Positional and keyword arguments for timezone are exclusive 2021-01-13 18:37:36 +09:00
trace_point.rb [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
transcode.c fix result of example [ci skip] 2021-01-06 21:58:34 +09:00
transcode_data.h
transient_heap.c cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
transient_heap.h cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
util.c dtoa.c: make thread-safe by using atomic CAS 2021-01-10 18:19:53 +09:00
variable.c Revert "Don't pin val passed in to rb_define_const." 2021-02-03 12:48:37 -08:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2021-02-09 [ci skip] 2021-02-09 00:07:27 +09:00
vm.c global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_args.c remove unused decl 2021-01-08 14:39:05 +09:00
vm_backtrace.c Ignore <internal: entries from core library methods for Kernel#warn(message, uplevel: n) 2020-10-26 08:47:33 +01:00
vm_callinfo.h global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_core.h global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c Revert "vm_dump.c: Do not show C backtrace on riscv" 2021-02-04 17:47:12 +09:00
vm_eval.c Removed unnecessary parentheses at case [ci skip] 2021-02-08 10:35:51 +09:00
vm_exec.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
vm_exec.h RUBY_CONST_ASSERT: use STATIC_ASSERT instead 2020-07-10 12:23:41 +09:00
vm_insnhelper.c global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_insnhelper.h Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_method.c Make alias for aliased original method 2021-02-03 19:59:35 +09:00
vm_opts.h Remove obsoleted opt_call_c_function insn (#3232) 2020-06-17 09:16:01 -07:00
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 Replace "iff" with "if and only if" 2021-01-19 12:06:45 -08:00
vsnprintf.c Replace "iff" with "if and only if" 2021-01-19 12:06:45 -08:00
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00

Build Status Build status Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows

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