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
2019-11-10 22:34:49 +09:00
.github/workflows Set $JOBS to Tests for parallel tests 2019-11-05 10:28:44 +09:00
basictest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
benchmark Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
bin [ruby/date] Added update-zonetab target 2019-11-01 17:30:17 +09:00
bootstraptest Use a monotonically increasing number for object_id 2019-11-07 09:31:07 -08:00
ccan Fix typos [ci skip] 2019-10-14 17:30:04 +09:00
coroutine Fix coroutine support on win32 2019-11-05 15:31:21 +09:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Added refresh-gems 2019-10-24 01:42:48 +09:00
doc Revert "Promote uri to default gems" 2019-11-09 20:16:03 +09:00
enc Init function is need to link statically 2019-08-10 01:41:50 +09:00
ext Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
gems Updated minitest to 5.13.0 2019-11-05 02:14:31 +09:00
include Remove duplicate code 2019-11-06 16:31:55 -08:00
lib Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
libexec [bundler/bundler] Require relatively from exe/ when possible 2019-08-18 13:45:05 +09:00
man Update the latest documentation of bundler 2019-09-18 18:26:33 +09:00
misc Refined rp output [ci skip] 2019-10-24 23:38:27 +09:00
missing missing/setproctitle.c: remove nonsense NULL check 2019-10-12 21:14:20 +09:00
sample Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
spec Removed trial and errors 2019-11-09 23:00:32 +09:00
template Get rid of FreeBSD make incompatibility [Bug #16331] 2019-11-10 09:26:19 +09:00
test Disallow omission of parentheses/brackets in single line pattern matching [Feature #16182] 2019-11-10 22:34:49 +09:00
tool Remove unneeded exec bits from some files 2019-11-09 21:36:30 +09:00
win32 Define NULLCMD as printing NUL [Bug #16331] 2019-11-10 10:52:12 +09:00
.dir-locals.el
.document Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
.drone.yml Remove arm64 build from Drone 2019-10-15 22:56:20 -07:00
.editorconfig
.gdbinit Prefix global_symbols with ruby_ 2019-05-16 15:43:16 +09:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Ignore timestamp file for the expected failure [ci skip] 2019-10-22 21:33:24 +09:00
.indent.pro
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Change requirements of BASERUBY. 2019-11-08 10:10:37 +09:00
aclocal.m4
addr2line.c retrieve current path on macOS 2019-08-20 02:05:10 +09:00
addr2line.h
appveyor.yml appveyor.yml - remove timezone & tzinfo gems from MSVC builds 2019-10-22 14:06:39 +09:00
array.c Prefer st_is_member over st_lookup with 0 2019-10-09 23:46:50 +09:00
ast.c Renamed load_*.inc as *.rbinc to utilize a suffix rule 2019-11-08 16:30:28 +09:00
ast.rb fix line break code (fix to LF) 2019-11-08 09:30:11 +09:00
bignum.c bignum.c (estimate_initial_sqrt): prevent integer overflow 2019-10-21 21:24:21 +09:00
BSDL
builtin.c Full-path of builtin scripts no longer needed 2019-11-09 19:43:14 +09:00
builtin.h Full-path of builtin scripts no longer needed 2019-11-09 19:43:14 +09:00
class.c Let the arrays for the singleton and instance method reflection helpers be initialized to the methods count 2019-10-29 11:32:46 +09:00
common.mk Get rid of FreeBSD make incompatibility [Bug #16331] 2019-11-10 09:26:19 +09:00
compar.c Raise on end-exclusive ranges [Feature #14784] 2019-10-26 12:52:50 +09:00
compile.c Make prefix static 2019-11-08 23:00:36 +09:00
complex.c Make Kernel#{Pathname,BigDecimal,Complex} return argument if given correct type 2019-09-21 16:10:37 -07:00
configure.ac Improve string literal concatenation for C++11 2019-11-06 00:31:52 +09:00
constant.h Module#constant_source_location [Feature #10771] 2019-06-23 01:46:38 +09:00
cont.c Fix a typo [ci skip] 2019-11-04 17:12:18 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
debug_counter.c Fix rb_define_singleton_method warning 2019-09-20 17:44:48 +09:00
debug_counter.h add debug counters for vm_search_method_slowpath() 2019-10-03 15:24:09 +09:00
dir.c dir.c (join_path_from_pattern): check NULL from malloc 2019-10-13 00:51:50 +09:00
dln.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Moved Init_encoding from wrong place [Bug #16292] 2019-11-05 10:28:01 +09:00
enum.c rb_rescue / rb_rescue2 now free from ANYARGS 2019-08-27 15:52:26 +09:00
enumerator.c Right size the Enumerator internal lazy_use_super_method hash 2019-10-29 11:31:34 +09:00
error.c forgot to delete unused #incude line 2019-10-10 18:15:33 +09:00
eval.c Suppress "clobbered" warnings by gcc 9.2.0 2019-10-12 18:14:15 +09:00
eval_error.c Renamed ruby_finalize_{0,1} 2019-08-13 09:47:08 +09:00
eval_intern.h solve "duplicate :raise event" [Bug #15877] 2019-08-08 17:56:04 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c [DOC] no change on Windows [Bug #15267] [ci skip] 2019-10-17 19:43:10 +09:00
gc.c Fix passing actual object_id to finalizer 2019-11-08 12:41:05 -08:00
gc.h Rename rb_gc_mark_no_pin -> rb_gc_mark_movable 2019-08-12 16:44:54 -04:00
gc.rb fix line break code (fix to LF) 2019-11-08 15:32:01 +09:00
gem_prelude.rb
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c
GPL
hash.c Use a monotonically increasing number for object_id 2019-11-07 09:31:07 -08: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 Revert https://github.com/ruby/ruby/pull/2486 2019-10-03 12:45:24 +09:00
inits.c Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
insns.def use STACK_ADDR_FROM_TOP() 2019-11-09 16:18:58 +09:00
internal.h delete cc->aux.inc_sp 2019-11-08 16:38:06 +09:00
io.c builtin.h must be included *AFTER* vm_core.h 2019-11-08 16:31:57 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c Support RB_BUILTIN in ISeq#to_a 2019-11-09 21:40:38 -08:00
iseq.h cstr -> bytes 2019-11-08 16:16:25 +09:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
loadpath.c
localeinit.c
main.c main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c drop-in type check for rb_define_module_function 2019-08-29 18:34:09 +09:00
math.c Add word "Euler's number" to Math::E docs 2019-08-29 11:57:23 -07:00
method.h * expand tabs. [ci skip] 2019-10-03 12:48:20 +09:00
mini_builtin.c Fix a typo 2019-11-10 22:21:40 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c Combine call info and cache to speed up method invocation 2019-10-24 18:03:42 +09:00
mjit.h
mjit_compile.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit_worker.c Eliminate the possibility to leave freed ISeq 2019-10-13 19:31:18 -07:00
NEWS Revert "[EXPERIMENTAL] Make Symbol#to_s return a frozen String [Feature #16150]" 2019-11-05 17:30:54 +09:00
node.c Use an identity hash for pinning Ripper objects 2019-11-05 08:24:14 -08:00
node.h Define arguments forwarding as ruby2_keywords style 2019-10-25 01:16:05 +09:00
numeric.c Use FIX2LONG instead of FIX2INT like 26843cbcd0 2019-11-07 18:53:51 +09:00
object.c Prohibit calling undefined allocator [Bug #16297] 2019-11-06 11:17:09 +09:00
pack.c Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y Disallow omission of parentheses/brackets in single line pattern matching [Feature #16182] 2019-11-10 22:34:49 +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 Documentation improvements for Ruby core 2019-10-26 14:58:08 +09:00
process.c Use the dedicated function rb_io_check_io 2019-11-04 09:14:18 +09:00
random.c Adjusted spaces [ci skip] 2019-09-27 10:20:56 +09:00
range.c Make Range#=== operate like cover? instead of include? for string ranges 2019-08-14 14:14:49 -07:00
rational.c Make rb_scan_args handle keywords more similar to Ruby methods (#2460) 2019-09-25 11:18:49 -07:00
re.c Undefine MatchData.allocate [Feature #16294] 2019-11-06 08:54:32 +09:00
README.EXT
README.EXT.ja
README.ja.md Add badges of GitHub Actions [ci skip] 2019-09-18 22:46:05 +09:00
README.md Add badges of GitHub Actions [ci skip] 2019-09-18 22:46:05 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c
regint.h
regparse.c st_foreach now free from ANYARGS 2019-08-27 15:52:26 +09:00
regparse.h
regsyntax.c
ruby-runner.c Fix warnings 2019-08-28 16:51:48 +09:00
ruby.c Refactor parser_params by removing "in_main" flag 2019-10-04 02:30:36 +09:00
ruby_assert.h respect NDEBUG. 2019-07-19 12:04:32 +09:00
ruby_atomic.h
rubystub.c
safe.c rb_define_hooked_variable now free from ANYARGS 2019-08-27 15:52:26 +09:00
signal.c Share ruby_sighandler_t definition 2019-10-09 23:39:58 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c move docs around [ci skip] 2019-08-29 18:34:09 +09:00
st.c st: Do error check only on non-Ruby 2019-10-21 11:14:36 +09:00
strftime.c
string.c Revert "[EXPERIMENTAL] Make Symbol#to_s return a frozen String [Feature #16150]" 2019-11-05 17:30:54 +09:00
struct.c Define Struct#deconstruct_keys 2019-11-08 11:37:46 +09:00
symbol.c Fix a use-after-free bug by avoiding rb_str_new_frozen 2019-09-06 23:35:20 +09:00
symbol.h
thread.c Use ident hash for top-level recursion check 2019-11-04 15:27:15 -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 Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c time.c: Fix some bugs about WIDEVALUE 2019-10-06 11:39:01 +09:00
timev.h
trace_point.rb use builtin for TracePoint. 2019-11-08 09:09:29 +09:00
transcode.c transcode.c (rb_econv_open0): remove unused code 2019-07-24 04:49:51 +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 Prefer st_is_member over st_lookup with 0 2019-10-09 23:46:50 +09:00
version.c Provides ruby2_keywords 2019-10-23 00:19:25 +09:00
version.h * 2019-11-10 [ci skip] 2019-11-10 06:23:55 +09:00
vm.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
vm_args.c Handle case where ruby2_keywords method splats to ruby2_keywords method 2019-10-24 17:25:43 -07:00
vm_backtrace.c Let the backtrace array constructed in backtrace_collect be initialized with the size already given 2019-10-29 11:32:09 +09:00
vm_core.h support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
vm_debug.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +09:00
vm_dump.c Adjusted spaces [ci skip] 2019-09-27 10:20:56 +09:00
vm_eval.c extend rb_call_cache 2019-11-07 17:41:30 +09:00
vm_exec.c
vm_exec.h Fixed format specifiers 2019-09-20 23:57:20 +09:00
vm_insnhelper.c use STACK_ADDR_FROM_TOP() 2019-11-09 16:18:58 +09:00
vm_insnhelper.h Combine call info and cache to speed up method invocation 2019-10-24 18:03:42 +09:00
vm_method.c rb_method_basic_definition_p with CC 2019-11-05 11:39:35 +09:00
vm_opts.h Use cppflags to pass preprocessor options 2019-10-23 02:53:36 +09:00
vm_trace.c Renamed load_*.inc as *.rbinc to utilize a suffix rule 2019-11-08 16:30:28 +09:00
vsnprintf.c Use array indexing with considering clang's feeling 2019-08-27 14:25:58 +09:00
wercker.yml Generalize timeout_scale 2019-06-11 23:15:46 +09:00

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