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
Nobuyoshi Nakada b369f5e8a2
Fixed up 0eeed5bcc5
`Binding#source_location` returns the `__FILE__` when created, and
may not be an absolute or real path.  And in the `eval` context
with an explicit file name, `__dir__` also returns that name.
On the other hand, `__FILE__` in `require`d script file has been
expanded at searching the library.
2020-01-09 10:13:08 +09:00
.github Slightly change the job wording [ci skip] 2020-01-06 01:52:20 -08:00
basictest Fixed misspellings 2019-12-20 09:32:42 +09:00
benchmark Speeds up fallback to Hash#default_proc in rb_hash_aref by removing a method call 2020-01-08 18:09:52 +09:00
bin Removed the old executables of racc 2020-01-01 07:42:42 +09:00
bootstraptest Show the failed message too 2019-12-12 23:26:35 +09:00
ccan Fix typos [ci skip] 2019-10-14 17:30:04 +09:00
coroutine Remove "All Rights Reserved." from Copyright statement. 2019-12-28 12:45:37 +13:00
coverage
cygwin
defs config.status should be newer than config.cache if exists 2020-01-08 18:35:21 +09:00
doc Redmine /projects/ruby-trunk is now redirected 2019-12-31 22:06:19 -08:00
enc update dependencies 2019-12-26 20:45:12 +09:00
ext [flori/json] Add :nodoc: for GeneratorMethods 2020-01-06 15:13:50 +09:00
gems Promote did_you_mean to default gem 2019-11-30 21:08:19 -05:00
include include/ruby/ruby.h: remove a variable tmp_buffer as it does not change 2020-01-05 11:39:35 +09:00
internal Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
lib lib/net/imap.rb: use &blk instead of Kernel#proc with no block 2020-01-09 08:21:42 +09:00
libexec Removed the old executables of racc 2020-01-01 07:42:42 +09:00
man Merge bundler-2.1.4 2020-01-08 18:00:32 +09:00
misc Fixed misspellings 2019-12-20 09:32:42 +09:00
missing internal/stdbool.h rework 2019-12-26 20:45:12 +09:00
sample Fixed misspellings 2019-12-20 09:32:42 +09:00
spec Merge bundler-2.1.4 2020-01-08 18:00:32 +09:00
template decouple internal.h headers 2019-12-26 20:45:12 +09:00
test Fixed up 0eeed5bcc5 2020-01-09 10:13:08 +09:00
tool vcs.rb: Get rid of Kernel#open 2020-01-09 10:04:22 +09:00
win32 decouple internal.h headers 2019-12-26 20:45:12 +09:00
.dir-locals.el
.document Added warning.rb to .document 2019-12-24 13:12:28 +09:00
.editorconfig
.gdbinit Redmine /projects/ruby-trunk is now redirected 2019-12-31 22:06:19 -08:00
.gitattributes
.gitignore Check -1 arity for C++ 2019-11-22 18:42:49 +09:00
.rspec_parallel
.travis.yml Disable IPv6 on Travis s390x case. (#2819) 2020-01-07 12:23:04 +09:00
aclocal.m4
addr2line.c internal/stdbool.h rework 2019-12-26 20:45:12 +09:00
addr2line.h
appveyor.yml Remove code to prevent double build on trunk 2019-12-31 22:03:21 -08:00
array.c Optimize Array#rotate!(n) for n = 1 and n = -1 2019-12-29 13:12:42 +09:00
ast.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
ast.rb Fix variable name and add more example [ci skip] 2020-01-03 01:27:25 +09:00
bignum.c bignum.c: extract bdigits_to_mpz and bdigits_from_mpz (#2805) 2020-01-01 22:55:12 +09:00
BSDL
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 Remove unused tmp_buffer in class.c 2020-01-05 12:26:48 +09:00
common.mk Bump benchmark-driver to v0.15.7 (#2811) 2020-01-02 14:26:20 -08:00
compar.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
compile.c move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
complex.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
configure.ac modify MJIT_CC only on RUBY_DEBUG=ci 2020-01-03 04:39:34 +09:00
constant.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
cont.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
debug_counter.c add debug_counter access functions. 2019-12-25 01:34:41 +09:00
debug_counter.h debug_counter.h must be self-contained 2019-12-26 20:45:12 +09:00
dir.c Fix documentation of Dir#each_child 2019-12-29 12:59:23 +09:00
dln.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
dln.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
encoding.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
enum.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
enumerator.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
error.c support RUBY_ON_BUG envval on assert failure. 2020-01-06 15:06:03 +09:00
eval.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
eval_error.c
eval_intern.h Create backtrace location array directly 2019-12-13 20:47:07 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
gc.c Introduce BIGNUM_EMBED_P to check BIGNUM_EMBED_FLAG (#2802) 2019-12-31 22:48:23 +09:00
gc.h decouple internal.h headers 2019-12-26 20:45:12 +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
GPL
hash.c Hoisted out call_default_proc 2020-01-08 18:14:04 +09:00
hrtime.h
id_table.c Revert https://github.com/ruby/ruby/pull/2486 2019-10-03 12:45:24 +09:00
id_table.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
inits.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
insns.def Introduce an "Inline IVAR cache" struct 2019-12-05 13:37:02 -08:00
internal.h move internal/debug.h definitions to internal.h 2020-01-03 04:46:51 +09:00
io.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
iseq.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
loadpath.c
localeinit.c
main.c
marshal.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
math.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
method.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
mini_builtin.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit_compile.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
mjit_worker.c Allow specifying arbitrary MJIT flags by --jit-debug 2019-12-01 00:58:47 -08:00
NEWS Update NEWS for Ruby 2.8.0 (tentative; to be 3.0.0) 2019-12-31 18:18:21 +09:00
node.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
node.h Deprecate taint/trust and related methods, and make the methods no-ops 2019-11-18 01:00:25 +02:00
numeric.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
object.c Call initialize_clone with freeze: false if clone called with freeze: false 2020-01-03 20:13:09 -08:00
pack.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y parse.y: fix a wrong sizeof argument for ruby_sized_xfree 2020-01-05 11:39:35 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d
probes_helper.h internal/vm.h rework 2019-12-26 20:45:12 +09:00
proc.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
process.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
random.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
range.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
rational.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
re.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
README.EXT
README.EXT.ja
README.ja.md Update GitHub Actions Badges 2020-01-01 00:02:01 +09:00
README.md Update GitHub Actions Badges 2020-01-01 00:02:01 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h
regsyntax.c
ruby-runner.c Fix warnings 2019-08-28 16:51:48 +09:00
ruby.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
ruby_assert.h
ruby_atomic.h add several __has_something macro 2019-12-26 20:45: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 decouple internal.h headers 2019-12-26 20:45:12 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
st.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
strftime.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
string.c [DOC] Improve docs for String#match 2020-01-08 20:53:31 +01:00
struct.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
symbol.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
symbol.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
thread.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08: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 add assertion for mutex_lock. 2019-10-28 12:19:18 +09:00
thread_win32.c
thread_win32.h
time.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
timev.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
trace_point.rb Fix output of example [ci skip] 2020-01-05 00:52:43 +09:00
transcode.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
transcode_data.h
transient_heap.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
transient_heap.h
util.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
variable.c always expand ivar arrays to max width 2020-01-06 12:41:33 -08:00
variable.h fastpath for ivar read of FL_EXIVAR objects. 2019-11-29 03:11:04 +09:00
version.c Provides ruby2_keywords 2019-10-23 00:19:25 +09:00
version.h * 2020-01-09 [ci skip] 2020-01-09 04:51:11 +09:00
vm.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_args.c Fix unused warnings 2020-01-03 14:53:25 +09:00
vm_backtrace.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
vm_core.h Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_debug.h
vm_dump.c support RUBY_ON_BUG envval on assert failure. 2020-01-06 15:06:03 +09:00
vm_eval.c script_compiled event on compile error. 2020-01-06 11:36:51 +09:00
vm_exec.c Add VM insns counter like debug_counter (#2789) 2019-12-28 00:44:09 -08:00
vm_exec.h Add VM insns counter like debug_counter (#2789) 2019-12-28 00:44:09 -08:00
vm_insnhelper.c Fully separate positional arguments and keyword arguments 2020-01-02 18:40:45 -08:00
vm_insnhelper.h per-method serial number 2019-12-18 12:52:28 +09:00
vm_method.c Check Module#ruby2_keywords arity 2020-01-02 10:41:24 +09:00
vm_opts.h Use cppflags to pass preprocessor options 2019-10-23 02:53:36 +09:00
vm_trace.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
vsnprintf.c
warning.rb Fix a typo [ci skip] 2020-01-02 12:12:05 +09:00

Build Status Build status Actions 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 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