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
Jeremy Evans 52fb696ee7 Switch rb_category_warn{,ing} to accept an rb_warning_category_t
Since we decided to only allowing specific warning categories,
there is no reason to have an API that accepts a general string,
as it is more error-prone.  Switch to only allowing the specific
warning categories.

As rb_category_warn{,ing} are public API, this requires making
rb_warning_category_t public API as well.
2020-12-18 09:54:11 -08:00
.github Remove --jit-save-temps from MJIT 2020-12-17 21:36:26 -08:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark fix duplicated name 2020-12-16 10:29:48 +09:00
bin Promote erb to default gems 2020-08-21 20:18:44 +09:00
bootstraptest strip trailing spaces [ci skip] 2020-12-16 20:33:31 +09:00
ccan
coroutine Fix "Ruby is not properly fortified on armv7hl". 2020-12-08 23:37:42 +13:00
coverage
cygwin Merged recipes for the same target 2020-05-27 13:13:12 +09:00
defs gmake.mk: renamed BUNDLED_GEMS as bundled-gems 2020-12-02 17:04:33 +09:00
doc Fix a typo [ci skip] 2020-12-14 10:26:04 +09:00
enc Add string encoding IBM720 alias CP720 (#3803) 2020-11-22 22:23:40 +09:00
ext [bigdecimal] Use rb_undef_alloc_func to undefine allocate 2020-12-19 02:29:31 +09:00
gems Update TypeProf to 0.10.0 2020-12-19 00:53:47 +09:00
include Switch rb_category_warn{,ing} to accept an rb_warning_category_t 2020-12-18 09:54:11 -08:00
internal Switch rb_category_warn{,ing} to accept an rb_warning_category_t 2020-12-18 09:54:11 -08:00
lib [ruby/reline] Use cached prompt list when just moved the cursor 2020-12-19 02:12:11 +09:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man Merge prepare version of Bundler 2.2.0 2020-12-08 17:30:02 +09:00
misc Promote webrick to bundled gems 2020-12-10 18:06:25 +09:00
missing Removed obsolete autoconf checks 2020-12-12 17:23:44 +09:00
sample webrick was removed from ruby repo 2020-12-10 18:06:25 +09:00
spec Revert "Better cooperation between public/protected/private with attr* and alias_method" 2020-12-18 16:08:55 +09:00
template fix inline method cache sync bug 2020-12-15 13:29:30 +09:00
test [bigdecimal] Fix test for d5ab8e8562 2020-12-19 02:44:20 +09:00
tool test/ruby: Check warning messages at a finer granularity 2020-12-17 20:06:18 +09:00
util [rubygems/rubygems] Extend the script to allow reverting the patch when tried locally 2020-07-31 21:07:19 +09:00
win32 Made LARGEFILE_SUPPORT mandatory 2020-12-16 19:10:37 +09:00
.dir-locals.el
.document Make Integer#zero? a separated method and builtin (#3226) 2020-06-20 14:55:09 -07:00
.editorconfig
.gdbinit Add T_MOVED to rp command of GDB 2020-12-04 08:43:32 -08: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 Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
addr2line.c addr2line.c: support debuglink by build_id 2020-12-11 14:08:33 +09:00
addr2line.h add #include guard hack 2020-04-13 16:06:00 +09:00
appveyor.yml Keep patched zlib files 2020-11-26 09:37:38 +09:00
array.c tuning trial: newobj with current ec 2020-12-07 08:28:36 +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 (bary_sparse_p): do not comsume Random::DEFAULT 2020-10-12 13:45:32 +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 Prefer rb_module_new() over rb_define_module_id() 2020-11-25 17:05:06 -05:00
common.mk make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
compar.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
compile.c Skip defined check in NODE_OP_ASGN_OR with ivar 2020-12-14 19:38:59 -08:00
complex.c Removed canonicalization for mathn 2020-11-10 11:14:15 +09:00
configure.ac configure.ac: avoid squashing CXX=g++ 2020-12-16 08:47:49 +09:00
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c Let Fiber#raise work with transferring fibers 2020-12-12 10:18:19 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c show ractor info on non-single ractor mode 2020-12-07 08:28:36 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h add debug counters for gc start events 2020-12-17 17:03:05 +09:00
dir.c Revert "Removed deprecated Dir.exists? and File.exists?" 2020-12-02 19:11:01 +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 add #include guard hack 2020-04-13 16:06:00 +09:00
encoding.c No sync on ASCII/US_ASCCII/UTF-8 2020-12-17 03:44:23 +09:00
enum.c Removed leading spaces [ci skip] 2020-12-16 12:14:30 +09:00
enumerator.c Fix ArithmeticSequence#last and ArithmeticSequence#each for non-integer sequences (#3870) 2020-12-09 18:48:59 +09:00
error.c Switch rb_category_warn{,ing} to accept an rb_warning_category_t 2020-12-18 09:54:11 -08:00
eval.c Remove obsoleted internal/mjit.h inclusion 2020-11-22 20:28:34 -08:00
eval_error.c Fixed infinite loop at error in printing cause [Bug #17033] 2020-07-15 21:39:20 +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 Revert "Removed deprecated Dir.exists? and File.exists?" 2020-12-02 19:11:01 +09:00
gc.c finalizing should be checked before VM lock 2020-12-18 17:59:26 +09: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 Document Hash#transform_keys with hash. Amend NEWS [DOC] [ci skip] 2020-12-15 17:09:01 -05: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 Buffer protocol proposal (#3261) 2020-09-25 20:32:02 +09:00
insns.def encourage inlining for vm_sendish() 2020-12-17 16:53:41 +09:00
integer.rb Move docs for Integer#bit_length [ci skip] 2020-12-14 20:01:55 -05:00
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c Tweaked Process::Status.wait 2020-12-09 11:51:57 +09:00
io.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c Make RubyVM::InstructionSequence.compile_file use same encoding as load 2020-11-19 07:12:50 +09:00
iseq.h check isolated Proc more strictly 2020-10-29 23:42:55 +09:00
kernel.rb Make Kernel#then, #yield_self, #frozen? builtin (#3283) 2020-07-03 18:02:43 -07: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
main.c
marshal.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
math.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
memory_view.c [memory_view] Make MemoryView API Ractor-safe (#3911) 2020-12-16 13:43:56 +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 Do not access jit_unit if NULL 2020-12-16 19:43:43 -08:00
mjit.h Inline getconstant on JIT (#3906) 2020-12-16 06:24:07 -08:00
mjit_compile.c Inline getconstant on JIT (#3906) 2020-12-16 06:24:07 -08:00
mjit_worker.c Lazily move units from active_units to stale_units 2020-12-16 00:22:50 -08:00
NEWS.md Revert "Better cooperation between public/protected/private with attr* and alias_method" 2020-12-18 16:08:55 +09:00
node.c Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
node.h Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
numeric.c Move docs for Integer#bit_length [ci skip] 2020-12-14 20:01:55 -05:00
object.c Revert "Better cooperation between public/protected/private with attr* and alias_method" 2020-12-18 16:08:55 +09:00
pack.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
pack.rb [DOC] Fixed a typo [ci skip] 2020-11-16 22:14:59 +09:00
parse.y Fixed not to make non-literal expression shareable [Feature #17273] 2020-12-19 00:34:14 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d
probes_helper.h
proc.c fix lambda's warning and tests 2020-12-12 06:29:11 +09:00
process.c Remove unused variable 2020-12-19 00:04:19 +09:00
ractor.c fix timing bug 2020-12-17 00:34:30 +09:00
ractor.rb Make Ractor#receive_if private 2020-12-16 10:42:17 -05:00
ractor_core.h Ractor#receive_if to receive only matched messages 2020-12-16 19:12:48 +09:00
random.c Deprecate Random::DEFAULT 2020-12-14 20:29:50 +01:00
range.c Use public allocators for creating new T_OBJECT objects 2020-10-28 18:35:22 -07:00
rational.c Fix ArithmeticSequence#last and ArithmeticSequence#each for non-integer sequences (#3870) 2020-12-09 18:48:59 +09:00
re.c [Feature #17136] Remove special behavior from $KCODE 2020-11-28 18:51:36 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md Fix bundled gems installation on a fresh clone 2020-03-14 18:16:47 +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 Ignore failure on unsupported fcntl to drop non-blocking mode 2020-12-16 17:54:43 +09:00
ruby_assert.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
ruby_atomic.h fix typo [Bug #17194] 2020-09-26 18:24:28 +09:00
rubystub.c
scheduler.c Add support for non-blocking Process.wait. 2020-12-09 08:55:35 +13:00
signal.c Signal handler type should be void 2020-12-12 17:02:42 +09: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 [DOC] Fixed st_udpate comment [ci skip] 2020-11-30 12:18:21 +09:00
strftime.c rb_strftime_with_timespec: do not goto into a branch 2020-06-29 11:05:41 +09:00
string.c tuning trial: newobj with current ec 2020-12-07 08:28:36 +09:00
struct.c RHASH_TBL: is now ext-only 2020-08-19 15:10:53 +09: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 Introduce negative method cache 2020-12-14 11:57:46 +09:00
thread_pthread.c introduce USE_VM_CLOCK for windows. 2020-11-11 15:49:02 +09:00
thread_pthread.h fix public interface 2020-11-18 03:52:41 +09:00
thread_sync.c Proposed method for dealing with stack locals which have non-local lifetime. 2020-12-05 11:38: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 Removed deprecated Time#succ 2020-12-07 18:38:59 +09:00
timev.h
trace_point.rb [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
transcode.c Update documentation for String#encode{,!} [ci skip] 2020-12-03 12:47:34 -08:00
transcode_data.h add #include guard hack 2020-04-13 16:06:00 +09:00
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 sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
variable.c tuning ivar set 2020-12-16 13:06:13 +09:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2020-12-19 [ci skip] 2020-12-19 00:04:41 +09:00
vm.c Support shareable_constant_value: literal 2020-12-14 19:19:16 +09:00
vm_args.c Run method_missing in the same execution context 2020-07-06 10:47:11 +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 fix inline method cache sync bug 2020-12-15 13:29:30 +09:00
vm_core.h fix inline method cache sync bug 2020-12-15 13:29:30 +09:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c vm debug: dump registers on ARM too. (#3900) 2020-12-16 15:32:11 +09:00
vm_eval.c add several debug counters 2020-12-15 13:29:30 +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 encourage inlining for vm_sendish() 2020-12-17 16:53:41 +09:00
vm_insnhelper.h Functions defined in headers should be static inline 2020-11-15 09:59:29 +09:00
vm_method.c Revert "Better cooperation between public/protected/private with attr* and alias_method" 2020-12-18 16:08:55 +09:00
vm_opts.h Remove obsoleted opt_call_c_function insn (#3232) 2020-06-17 09:16:01 -07:00
vm_sync.c add vm_sync debug counters 2020-12-16 10:38:12 +09:00
vm_sync.h add vm_sync debug counters 2020-12-16 10:38:12 +09:00
vm_trace.c Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
vsnprintf.c [win32] suppress false warning by mingw gcc 2020-03-04 23:13:18 +09:00
warning.rb [DOC] mentioned category option 2020-12-08 22:13:04 +09:00

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