The Ruby Programming Language [mirror]
Go to file
nagachika 6847ee089d merge revision(s) 856a9701fd13edbb9d5f0fa773082d312195df90:
Get rid of multibyte prefix to tmpdir

	---
	 test/ruby/test_require.rb | 12 ++++++------
	 1 file changed, 6 insertions(+), 6 deletions(-)
2021-04-05 21:39:38 +09:00
.github I gave up tentatively to support autoconf 2.70 in ruby_2_7 and remove failing build on GitHub Actions MinGW 2021-03-21 14:43:16 +09:00
basictest Fixed misspellings 2019-12-20 09:32:42 +09:00
benchmark Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
bin Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
bootstraptest merge revision(s) 21d8e6924844d592ff2d5a2e7309457eb92e66f6: 2020-07-09 20:54:28 +09:00
ccan
coroutine merge revision(s) 15e23312f6abcbf1afc6fbbf7917a57a0637f680: [Backport #16809] 2021-03-20 14:57:33 +09:00
coverage
cygwin
defs Fixed misspellings 2019-12-20 09:32:42 +09:00
doc Update documentation for Array/Hash Argument section of methods.rdoc 2020-03-13 21:31:10 +09:00
enc enc/x_emoji.h: fixed dead-links [ci skip] 2019-12-24 10:33:32 +09:00
ext merge revision(s) 9241211538189a58b477bd55b539357617fd42ed: [Backport #17589] 2021-02-20 18:06:43 +09:00
gems Use power_assert 1.1.7 2020-03-26 21:18:25 +09:00
include merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
lib Backport a tmpdir fix. 2021-04-05 20:48:25 +09:00
libexec Fixed misspellings 2019-12-20 12:19:45 +09:00
man Merge bundler-2.1.4 2020-03-27 14:43:20 +09:00
misc Fixed misspellings 2019-12-20 09:32:42 +09:00
missing Get rid of false positive misspellings 2019-12-24 10:33:32 +09:00
sample Fixed misspellings 2019-12-20 09:32:42 +09:00
spec merge revision(s) ed549f80b645aafd62376f65c3a27b66bafa2a38,eff0c5bf2ad47d10a440c5211be5eddb3bbf4028,f6b6a7ad345c50eeb3f7206ceabdf41ba94b7d85,5b48686691c2443d8d7113e593494c4d9302da0e,2af4c1fc5b19fc96203c2d7e917e689510d3527e,c9213aa864fb8527388679c21f1ea8ce129e2f1a,224f29c8e92094af10bc666c474b81a3545d6adf: 2020-12-31 18:34:09 +09:00
template remove prelude.c 2019-12-11 11:24:42 +09:00
test merge revision(s) 856a9701fd13edbb9d5f0fa773082d312195df90: 2021-04-05 21:39:38 +09:00
tool Revert "merge revision(s) c32375883a696fcf8e9e99875f1339ee5474a255:" 2021-03-21 14:27:23 +09:00
win32 Fixed misspellings 2019-12-20 09:32:42 +09:00
.dir-locals.el
.document Added warning.rb to .document 2019-12-24 13:12:28 +09:00
.editorconfig
.gdbinit
.gitattributes
.gitignore Check -1 arity for C++ 2019-11-22 18:42:49 +09:00
.rspec_parallel
.travis.yml Fix .travis.yml to keep s390x-linux as allow_features 2019-12-11 21:54:18 +09:00
BSDL
CONTRIBUTING.md
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb
LEGAL
NEWS Add readline and readline-ext to default gems list in NEWS 2019-12-25 12:55:53 +09:00
README.EXT
README.EXT.ja
README.ja.md Add badge of Cygwin 2019-12-09 16:08:12 +09:00
README.md Add badge of Cygwin 2019-12-09 16:08:12 +09:00
aclocal.m4
addr2line.c
addr2line.h
appveyor.yml Drop MinGW build from AppVeyor 2020-03-14 16:32:29 +09:00
array.c merge revision(s) 1b1ea7b3bc9484e6e59d716fce2965a2f39d1e3d,b6e6807993c770c5d2e069d8741f5dadf0b38069: [Backport #17092] 2021-02-20 12:12:35 +09:00
ast.c merge revision(s) ff5e66034006a875125581114cce19d46843b32a: [Backport #17015] 2020-09-06 11:16:29 +09:00
ast.rb Improve highlighting in RubyVM::AbstractSyntaxTree docs when using `ri` 2019-12-14 12:26:30 +01:00
bignum.c make functions static 2019-11-19 12:36:19 +09:00
builtin.c take care of USE_LAZY_LOAD=1. 2019-12-25 14:12:33 +09:00
builtin.h readable function names for inline functions. 2019-12-13 17:55:45 +09:00
class.c merge revision(s) ebb96fa8808317ad53a4977bff26cf755d68077e: [Backport #17321] 2021-03-20 14:26:30 +09:00
common.mk Fixed symbol misused as ID 2020-03-14 16:00:46 +09:00
compar.c [DOC] Improve readability of requirements for <=> 2019-12-23 15:02:59 +01:00
compile.c merge revision(s) 555bd83a8e8b1e859f698089cbbd9ad938159a0e: [Backport #17192] 2021-02-11 13:51:09 +09:00
complex.c Improve consistency of bool/true/false 2019-11-25 15:09:09 +09:00
configure.ac Revert "merge revision(s) c32375883a696fcf8e9e99875f1339ee5474a255:" 2021-03-21 14:27:23 +09:00
constant.h delete unused functions 2019-11-14 20:35:48 +09:00
cont.c merge revision(s) 4bff8e84232594ecb9914e2a8437b7c40a63b799: [Backport #16814] 2021-03-20 15:54:03 +09:00
debug.c add additional CF info for CI env 2019-12-05 14:47:31 +09:00
debug_counter.c add debug_counter access functions. 2019-12-25 01:34:41 +09:00
debug_counter.h add debug_counter access functions. 2019-12-25 01:34:41 +09:00
dir.c [DOC] Added File::FNM_SYSCASE example [Bug #16391] [ci skip] 2019-12-04 21:52:29 +09:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c [Doc] Fix sample in Encoding#names 2019-12-22 23:01:45 +09:00
enum.c merge revision(s) a85ed626f18d1014d09fb37eb0a703976c3d2b53: [Backport #17731] 2021-03-20 16:16:45 +09:00
enumerator.c merge revision(s) 254bed302752a401b5fcc3b6c65a9c93711d91d6,fad3023e94c45e7f03478732f7641b6f39ba9d12,3156fb0f2c3ebf8229f392c8502c08fe165ab181: [Backport #17218] 2021-03-20 15:35:30 +09:00
error.c merge revision(s) 996af2ce086249e904b2ce95ab2fcd1de7d757be: [Backport #16345] [Backport #17000] 2020-09-29 22:43:25 +09:00
eval.c Clear all trace events during teardown 2020-03-30 19:15:11 +09:00
eval_error.c merge revision(s) 579645d9f870fa4116dcd3200bbbb6e2c0b7f400: [Backport #17033] 2020-07-23 12:13:30 +09:00
eval_intern.h merge revision(s) f748b911c9157a0bb86f38280ddfba72a55049b6: [Backport #17729] 2021-03-20 16:15:35 +09:00
eval_jump.c
file.c merge revision(s) c15cddd1d515c5bd8dfe8fb2725e3f723aec63b8: [Backport #16787] 2021-03-20 13:56:13 +09:00
gc.c merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
gc.h merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
gc.rb fix line break code (fix to LF) 2019-11-08 15:32:01 +09:00
gem_prelude.rb Do not call 'gem "did_you_mean"' for now 2019-11-30 21:08:19 -05:00
golf_prelude.rb
goruby.c
hash.c merge revision(s) df14c758fc705c49c2aaf4c9276a8f7229438fbf: [Backport #17181] 2020-09-29 20:33:06 +09:00
hrtime.h
id_table.c
id_table.h
inits.c Moved Kernel#warn to warning.rb 2019-12-13 20:47:07 +09:00
insns.def merge revision(s) 3e02cd518fbe4d91c2aca7fbc3c5aafa387d3cb7: [Backport #17149] 2020-09-06 11:05:52 +09:00
internal.h merge revision(s) 254bed302752a401b5fcc3b6c65a9c93711d91d6,fad3023e94c45e7f03478732f7641b6f39ba9d12,3156fb0f2c3ebf8229f392c8502c08fe165ab181: [Backport #17218] 2021-03-20 15:35:30 +09:00
io.c Pass keyword arguments to IOs properly [Bug #16639] 2020-03-13 23:27:19 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c merge revision(s) 737da8d383e116c83fb356386322626f039deb06: 2021-03-20 16:41:13 +09:00
iseq.h vm_args.c (rb_warn_check): Use iseq_unique_id instead of its pointer 2019-12-09 15:22:48 +09:00
lex.c.blt
load.c Add the loaded feature after no exception raised 2020-03-13 22:34:09 +09:00
loadpath.c
localeinit.c
main.c
marshal.c merge revision(s) b23fd59cbb3f097bcd559d0c85a86ff7a1eeeb7e: [Backport #16501] 2020-07-23 16:59:03 +09:00
math.c [DOC] Fix wording in Math::E documentation 2019-12-24 00:13:46 +01:00
method.h per-method serial number 2019-12-18 12:52:28 +09:00
mini_builtin.c readable function names for inline functions. 2019-12-13 17:55:45 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c Prevent unloading methods used in root_fiber while calling another Fiber (#2939) 2020-03-15 19:35:24 +09:00
mjit.h Constified mjit_init 2019-12-01 20:26:28 +09:00
mjit_compile.c Add a proper cast to pass JIT tests on mswin. 2019-11-21 04:38:40 +09:00
mjit_worker.c Allow specifying arbitrary MJIT flags by --jit-debug 2019-12-01 00:58:47 -08:00
node.c merge revision(s) 35ba2783fe6b3316a6bbc6f00bf975ad7185d6e0,e8edc34f0abe176b24975a1fed1f2c3782f0a252: [Backport #16807] 2020-10-01 21:02:05 +09:00
node.h merge revision(s) 35ba2783fe6b3316a6bbc6f00bf975ad7185d6e0,e8edc34f0abe176b24975a1fed1f2c3782f0a252: [Backport #16807] 2020-10-01 21:02:05 +09:00
numeric.c merge revision(s) 254bed302752a401b5fcc3b6c65a9c93711d91d6,fad3023e94c45e7f03478732f7641b6f39ba9d12,3156fb0f2c3ebf8229f392c8502c08fe165ab181: [Backport #17218] 2021-03-20 15:35:30 +09:00
object.c `Object#=~` warning also obeys `Warning[:deprecated]` 2019-12-24 18:53:14 +09:00
pack.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y merge revision(s) 0036648a420f945624898568bb82bc5f83195d12: [Backport #17533] 2021-02-20 17:56:14 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d
probes_helper.h
proc.c merge revision(s) c60aaed1856b2b6f90de0992c34771830019e021: [Backport #17130] 2021-03-20 13:29:39 +09:00
process.c merge revision(s) c15cddd1d515c5bd8dfe8fb2725e3f723aec63b8: [Backport #16787] 2021-03-20 13:56:13 +09:00
random.c merge revision(s) e033c9d7db02a4e8d2973364ecb47744b63aecd3: [Backport #17549] 2021-02-11 13:51:43 +09:00
range.c merge revision(s) bf1a6771f305ea286a3ae575676924551c03e857,c1463625555b061a2b94c3b6c5581730b482a285: [Backport #17012] [Backport #17014] 2020-07-19 12:16:37 +09:00
rational.c merge revision(s) 254bed302752a401b5fcc3b6c65a9c93711d91d6,fad3023e94c45e7f03478732f7641b6f39ba9d12,3156fb0f2c3ebf8229f392c8502c08fe165ab181: [Backport #17218] 2021-03-20 15:35:30 +09:00
re.c `Regexp` in `MatchData` can be `nil` 2020-01-16 15:26:28 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h
regsyntax.c
ruby-runner.c
ruby.c merge revision(s) 6f6dfdcc685077f0f85dcdd63843ecfc0f6fbfb6: [Backport #17523] 2021-02-20 17:29:32 +09:00
ruby_assert.h
ruby_atomic.h Revert "statement experssion is a GCCism" to pass ICC CI. 2020-09-20 20:23:12 +09:00
rubystub.c
safe.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
signal.c Deprecate rb_eval_cmd, add rb_eval_cmd_kw 2019-11-18 01:00:25 +02:00
siphash.c merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
siphash.h
sparc.c
sprintf.c Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
st.c merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
strftime.c merge revision(s) 2f1895fa15386fb3cdc91c5604171290828b9da8: [Backport #16767] 2020-07-25 11:56:28 +09:00
string.c Refined the warning message for $, and $; 2019-12-20 15:09:23 +09:00
struct.c partially merge revision adf709a78534c1483ba851ccb0490464ca31503c: [Backport #16801] 2020-07-26 17:45:31 +09:00
symbol.c delete unused functions 2019-11-14 20:35:48 +09:00
symbol.h
thread.c merge revision(s) 2a83650b0fd25719fb6c03bfec7bd895734d3ceb: [Backport #15852] 2021-03-20 12:49:24 +09:00
thread_pthread.c
thread_pthread.h Partially merged 79df14c04b to suppress compiler warning. 2021-03-20 16:38:26 +09:00
thread_sync.c merge revision(s) 2a6bfd22468343003463e0cbf91953a01b0dbba5,3ac28de5414c81a0da8c8ec969ea74db5a0f1b0f: [Backport #17645] 2021-03-20 13:02:33 +09:00
thread_win32.c
thread_win32.h Partially merged 79df14c04b to suppress compiler warning. 2021-03-20 16:38:26 +09:00
time.c merge revision(s) 276f6a225d18561cbe5282b798cb4e416c66079f,95bef7b69a6fb42687a6200b338060be307259f5: [Backport #17352] 2021-03-20 14:43:10 +09:00
timev.h
trace_point.rb Make TracePoint.stat a singleton method again (#2726) 2019-12-04 21:02:21 -05:00
transcode.c Fixed symbol misused as ID 2020-03-14 16:00:46 +09:00
transcode_data.h
transient_heap.c rb_aligned_malloc can return NULL 2019-11-01 16:58:19 +09:00
transient_heap.h
util.c
variable.c merge revision(s) 927308108cced69cae478798004524b9a5d2f252: [Backport #16764] 2020-07-23 17:47:12 +09:00
variable.h fastpath for ivar read of FL_EXIVAR objects. 2019-11-29 03:11:04 +09:00
version.c
version.h merge revision(s) 856a9701fd13edbb9d5f0fa773082d312195df90: 2021-04-05 21:39:38 +09:00
vm.c merge revision(s) 2a83650b0fd25719fb6c03bfec7bd895734d3ceb: [Backport #15852] 2021-03-20 12:49:24 +09:00
vm_args.c Do not autosplat when calling proc with empty keyword splat 2020-03-15 20:52:43 +09:00
vm_backtrace.c merge revision(s) cbe4f75ef802f13d05f94e42274b65a062bd3666: [Backport #16834] 2020-07-25 14:17:35 +09:00
vm_core.h Kernel#lambda: return forwarded block as non-lambda proc 2019-12-21 09:08:52 -05:00
vm_debug.h
vm_dump.c Fixed misspellings 2019-12-20 09:32:42 +09:00
vm_eval.c script_compiled event on compile error. 2020-01-16 15:08:36 +09:00
vm_exec.c merge revision(s) 511b55bcefc81c036294dc9a544d14bd342acd3b: [Backport #17215] 2021-03-20 14:23:45 +09:00
vm_exec.h
vm_insnhelper.c merge revision(s) c60aaed1856b2b6f90de0992c34771830019e021: [Backport #17130] 2021-03-20 13:29:39 +09:00
vm_insnhelper.h per-method serial number 2019-12-18 12:52:28 +09:00
vm_method.c merge revision(s) 58660e943488778563b9e41005a601e9660ce21f: [Backport #17519] 2021-03-20 16:14:18 +09:00
vm_opts.h
vm_trace.c Clear all trace events during teardown 2020-03-30 19:15:11 +09:00
vsnprintf.c
warning.rb Fix visibility as module_function 2019-12-13 20:51:58 +09:00

README.md

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