The Ruby Programming Language [mirror]
Go to file
svn da1330c85a * 2015-02-05
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@49497 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-02-04 16:24:29 +00:00
benchmark benchmark/bm_marshal_dump_flo.rb: new benchmark for [Bug #10761] 2015-01-23 08:13:59 +00:00
bin erb: suppress warnings 2014-12-12 19:59:22 +00:00
bootstraptest parse.y: condition node 2015-01-29 13:22:39 +00:00
ccan
coverage
cygwin GNUmakefile.in: append resources always 2014-12-28 07:25:15 +00:00
defs id.def: move IDs for exception 2014-11-16 08:33:35 +00:00
doc * doc/security.rdoc: [DOC] update symbols section [ci-skip] 2015-02-04 16:24:16 +00:00
enc common.mk: make enc/trans 2015-01-18 13:12:15 +00:00
ext * ext/win32ole/win32ole.c (Init_win32ole): should not use atexit to 2015-02-04 11:30:37 +00:00
gems * gems/bundled_gems: update test-unit to 3.0.9. 2015-01-12 14:22:28 +00:00
include intern.h: rb_str_new_literal 2015-01-03 10:52:14 +00:00
lib mkmf.rb: avoid interference 2015-02-03 08:15:47 +00:00
man GC documentation update 2014-12-15 22:39:33 +00:00
misc * misc/ruby-electric.el: Import version 2.2.2 from 2015-01-26 09:06:54 +00:00
missing missing/setproctitle.c: Avoid invalidating argv[1], argv[2], etc. until the first call to Process.setproctitle, because the ps command of AIX refers to the argv array. [Bug #10090] 2014-10-08 22:31:53 +00:00
nacl Fix PNaCl configure/link errors. 2014-10-22 12:19:21 +00:00
sample fix a typo in comment [ci skip] 2014-11-09 13:12:21 +00:00
spec
template configure.in: fix --with-ruby-version [ci skip] 2014-12-05 21:14:25 +00:00
test * class.c (method_entry_i, class_instance_method_list, 2015-02-04 07:45:29 +00:00
tool rbinstall.rb: no batch installation 2015-02-01 04:46:55 +00:00
win32 rmdirs.bat: remove last "." 2015-01-22 00:14:40 +00:00
.document README files renamed 2015-01-18 08:47:15 +00:00
.editorconfig
.gdbinit .gdbinit: update for r47913 2014-11-17 21:08:23 +00:00
.gitignore * .gitignore: ignored temporary file with git. 2015-01-26 13:09:50 +00:00
.indent.pro
.travis.yml .travis.yml: for r49326 2015-01-19 13:44:32 +00:00
BSDL
CONTRIBUTING.md
COPYING
COPYING.ja
ChangeLog * ext/win32ole/win32ole.c (Init_win32ole): should not use atexit to 2015-02-04 11:30:37 +00:00
GPL
KNOWNBUGS.rb
LEGAL
Makefile.in Makefile.in: do not rebuild unnecessarily 2015-02-04 02:12:45 +00:00
NEWS array.c: reduce to_ary call 2015-01-25 03:04:10 +00:00
README.EXT README.EXT: fix typo 2014-11-27 20:38:51 +00:00
README.EXT.ja ruby.h: export keyword argument functions 2014-11-26 13:28:15 +00:00
README.ja.md * README.ja.md: add guidance of mailing list and bugs.r-l.o. 2015-01-03 15:46:05 +00:00
README.md
addr2line.c
addr2line.h
array.c array.c: reduce to_ary call 2015-01-25 03:04:10 +00:00
bignum.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
class.c * class.c (method_entry_i, class_instance_method_list, 2015-02-04 07:45:29 +00:00
common.mk Makefile.in: do not rebuild unnecessarily 2015-02-04 02:12:45 +00:00
compar.c compar.c: fix message 2015-01-13 12:07:04 +00:00
compile.c parse.y: eliminate empty hashes 2015-01-09 02:13:03 +00:00
complex.c * complex.c: removed commented-out code. 2015-01-10 01:58:59 +00:00
configure.in Makefile.in: do not rebuild unnecessarily 2015-02-04 02:12:45 +00:00
constant.h constant.h: constant visibilities 2014-10-08 08:27:51 +00:00
cont.c * vm_core.h: introduce new field 2014-12-10 19:35:07 +00:00
debug.c rb_id2str over rb_id2name 2014-11-25 18:44:22 +00:00
dir.c remove duplication in warning 2015-02-03 06:15:51 +00:00
dln.c Merges a patch form naclports. 2014-10-11 02:11:53 +00:00
dln.h
dln_find.c dln_find.c: define S_ISREG 2015-01-24 14:59:13 +00:00
dmydln.c
dmyenc.c load.c: tweak the return value 2014-12-03 06:13:58 +00:00
dmyext.c dmyenc.c: separate 2014-11-27 20:02:32 +00:00
encoding.c encoding.c: load by rb_require_internal 2014-12-03 08:13:26 +00:00
enum.c [DOC] 2014-12-12 03:15:56 +00:00
enumerator.c use 0 for reserved 2014-12-01 06:38:04 +00:00
error.c error.c: fix r49479 2015-02-03 08:23:39 +00:00
eval.c * eval.c (ruby_init): Print ruby_setup() error only in debug mode. 2015-01-02 09:49:56 +00:00
eval_error.c * eval_error.c (error_print): pos and len parameters of rb_str_substr() 2015-01-10 03:35:11 +00:00
eval_intern.h * eval_intern.h, vm.c, vm_eval.c, vm_insnhelper.c: 2015-01-16 02:54:22 +00:00
eval_jump.c
file.c ruby.c: replace with real path 2015-01-24 12:24:27 +00:00
gc.c gc.c: ensure GC state is consistent during VM shutdown 2015-02-02 20:58:32 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c marshal.c: indetity tables 2015-01-23 11:01:02 +00:00
ia64.s
inits.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
insns.def insns.def (opt_succ): remove Time#succ optimization 2014-11-13 21:55:28 +00:00
internal.h marshal.c: indetity tables 2015-01-23 11:01:02 +00:00
io.c * io.c (rb_io_close_m): Don't raise when the IO object is closed. 2015-01-15 15:26:03 +00:00
iseq.c compile.c: struct accessors 2014-12-17 03:20:58 +00:00
iseq.h mostly fix rb_iseq_load 2014-12-03 22:16:58 +00:00
lex.c.blt
load.c load.c: reset errinfo 2014-12-03 19:20:36 +00:00
loadpath.c
localeinit.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
main.c
marshal.c marshal.c: indetity tables 2015-01-23 11:01:02 +00:00
math.c math.c: optimization for Bignum 2015-01-30 08:28:32 +00:00
method.h method.h: UNDEFINED_REFINED_METHOD_P 2015-01-12 08:18:10 +00:00
miniinit.c
node.c * st.c (numberof): unused. internal.h has same macro. 2014-09-21 09:22:42 +00:00
node.h * Avoid undefined behaviors found by gcc -fsanitize=undefined. 2014-10-17 08:50:01 +00:00
numeric.c numeric.c: fix message 2015-01-13 12:07:14 +00:00
object.c object.c: [DOC] Revise documentation 2014-12-09 09:20:05 +00:00
pack.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
parse.y parse.y: no optimization in defined? 2015-01-29 13:22:45 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c proc.c: singleton_method should not use refinements 2015-01-15 12:35:00 +00:00
process.c process.c: missing parenthesis 2014-12-29 01:37:07 +00:00
random.c use 0 for reserved 2014-12-01 06:38:04 +00:00
range.c range.c: trivial optimizations 2015-01-13 03:51:35 +00:00
rational.c * rational.c: removed commented-out code. 2015-01-10 01:57:26 +00:00
re.c re.c: append excape sequence as-is 2014-12-29 09:58:48 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c uninitialized variable 2014-12-26 06:09:11 +00:00
regint.h * Avoid undefined behaviors found by gcc -fsanitize=undefined. 2014-10-17 08:50:01 +00:00
regparse.c
regparse.h
regsyntax.c
ruby.c ruby.c: only for load-relative 2015-01-24 13:06:58 +00:00
ruby_atomic.h ruby_atomic.h (ATOMIC_OR): should return previous value 2014-10-19 17:34:02 +00:00
safe.c safe.c: preserve encoding 2014-11-25 18:43:58 +00:00
signal.c signal.c: SIGBUS by stack overflow on Funtoo 2015-02-01 00:29:02 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
st.c hash.c: move Hash specific functions 2015-01-23 02:36:50 +00:00
strftime.c
string.c * string.c: [DOC] Specify to_s on subclasses [ci skip] 2015-01-29 15:56:58 +00:00
struct.c iseq.c: struct accessors 2014-12-16 06:18:25 +00:00
symbol.c symbol.c: fix memory leak from global fstr hash 2015-01-01 02:18:40 +00:00
symbol.h symbol.c: symbol type predicate functions 2014-11-17 18:20:22 +00:00
thread.c thread.c: micro-optimize thread create/join 2015-01-28 17:06:40 +00:00
thread_pthread.c thread_pthread.c: Fix intermittent SIGBUS on Linux 2015-01-31 03:06:26 +00:00
thread_pthread.h
thread_win32.c
thread_win32.h
time.c * time.c (timelocalw): Set tm_isdst field -1 if vtm->isdst is 2015-01-06 12:41:20 +00:00
timev.h
transcode.c use 0 for reserved 2014-12-01 06:38:04 +00:00
transcode_data.h
util.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
variable.c use 0 for reserved 2014-12-01 06:38:04 +00:00
version.c
version.h * 2015-02-05 2015-02-04 16:24:29 +00:00
vm.c vm.c, vm_core.h: constify VM_CF_LEP, VM_CF_PREV_EP, VM_CF_BLOCK_PTR 2015-01-16 08:21:49 +00:00
vm_args.c vm_args.c: fix non-symbol keys hash 2015-01-01 00:14:23 +00:00
vm_backtrace.c use 0 for reserved 2014-12-01 06:38:04 +00:00
vm_core.h vm.c, vm_core.h: constify VM_CF_LEP, VM_CF_PREV_EP, VM_CF_BLOCK_PTR 2015-01-16 08:21:49 +00:00
vm_debug.h
vm_dump.c vm_dump.c: check by configured result 2015-01-18 06:50:41 +00:00
vm_eval.c * eval_intern.h, vm.c, vm_eval.c, vm_insnhelper.c: 2015-01-16 02:54:22 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c vm_insnhelper.c: break from nested rescue 2015-01-23 14:57:08 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (remove_method): When remove refined 2015-02-03 06:26:48 +00:00
vm_opts.h
vm_trace.c vm_trace.c: defer interrupts while postponed jobs 2014-12-13 11:41:57 +00:00
vsnprintf.c ruby.h: add mark to PRIsVALUE 2014-11-04 03:51:33 +00:00

README.md

What's Ruby

Ruby is the interpreted scripting language for quick and easy object-oriented programming. It has many features to process text files and to do system management tasks (as in Perl). It is simple, straight-forward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-Oriented features(ex. class, method calls)
  • Advanced Object-Oriented features(ex. Mix-in, Singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object files(on some architecture)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, Mac OS X, BeOS etc.) cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms

How to get Ruby

For a complete list of ways to install Ruby, including using third party tools like rvm, see:

http://www.ruby-lang.org/en/downloads/

The Ruby distribution files can be found in the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

The trunk of the Ruby source tree can be checked out with the following command:

$ svn co http://svn.ruby-lang.org/repos/ruby/trunk/ ruby

Or if you are using git then use the following command:

$ git clone git://github.com/ruby/ruby.git

There are some other branches under development. Try the following command and see the list of branches:

$ svn ls http://svn.ruby-lang.org/repos/ruby/branches/

Or if you are using git then use the following command:

$ git ls-remote git://github.com/ruby/ruby.git

Ruby home-page

The URL of the Ruby home-page is:

http://www.ruby-lang.org/

Mailing list

There is a mailing list to talk about Ruby. To subscribe this list, please send the following phrase

subscribe

in the mail body (not subject) to the address mailto:ruby-talk-request@ruby-lang.org.

How to compile and install

This is what you need to do to compile and install Ruby:

  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.in, 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.

  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 following directories and install files onto them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFOR M}
    • ${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}/${P LATFORM}
    • ${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 (http://www.ruby-lang.org/en/community/mailing-lists) or on websites like (http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

mailto:matz@ruby-lang.org