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-07-02 15:02:16 +09:00
basictest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
benchmark Use realpath(3) instead of custom realpath implementation if available 2019-07-01 11:46:30 -07:00
bin Added binstub for racc executables. 2019-06-19 18:18:17 +09:00
bootstraptest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
ccan
coroutine Restore updated implementation of arm32 coroutine code, but prefer ucontext. 2019-06-26 22:02:28 +12:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Removed test-almost from TEST_TARGETS 2019-07-02 09:49:57 +09:00
doc Prefer master rather than trunk in doc/contributing.rdoc [ci skip] 2019-07-02 09:35:11 +09:00
enc remove UNREACHABLE 2019-06-24 16:01:46 +09:00
ext Fixed inadvertent ID creation in rb_iv_get 2019-07-01 13:56:55 +09:00
gems Update test-unit 2019-05-19 16:47:53 +09:00
include Remove IA64 support. 2019-06-19 23:30:04 +12:00
lib Keyword token that follows EXPR_FNAME must be a method name 2019-07-02 03:34:15 +09:00
libexec Backport racc-1.4.15 from upstream. 2019-06-19 18:17:25 +09:00
man Merge bundler master from upstream. 2019-06-09 12:44:10 +09:00
misc add FROZEN to lldb debug output 2019-05-09 12:27:44 -07:00
missing Split procstat_vm.c 2019-02-07 08:53:13 +00:00
sample For this may be a syntax error (instead of LocalJumpError) in Ruby 2.7 2019-02-04 06:28:57 +00:00
spec Prefer master rather than trunk in README [ci skip] 2019-07-01 01:05:29 +09:00
template Substitue suffixes with dot 2019-07-01 21:31:18 +09:00
test Clean up temporary directory for racc 2019-07-02 15:02:16 +09:00
tool Use GitHub ruby.git for make-snapshot 2019-07-02 10:40:41 +09:00
win32 Remove IA64 support. 2019-06-19 23:30:04 +12:00
.dir-locals.el add .dir-locals.el [ci skip] 2018-12-27 06:11:09 +00:00
.document Include LEGAL in .document [ci skip] 2018-12-01 12:05:37 +00:00
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Prefix global_symbols with ruby_ 2019-05-16 15:43:16 +09:00
.gitattributes Add tool/format-release to .gitattributes 2019-04-23 14:09:45 +09:00
.gitignore Only ignore build directories. 2019-06-20 23:12:48 +12:00
.indent.pro
.travis.yml The default branch is changed to master 2019-07-01 00:14:12 +09:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c Suppress warnings by gcc 9.1 2019-06-08 19:46:32 +09:00
addr2line.h
appveyor.yml Build AppVeyor only on master 2019-07-01 00:24:14 +09:00
array.c array.c: Wrong heap size given to ruby_sized_xfree when freeing shared roots 2019-06-24 13:34:30 +09:00
ast.c ast.c: update inspect results in the documents 2019-05-22 16:33:03 +09:00
azure-pipelines.yml Now test-bundler is not working on macOS either 2019-06-18 21:22:07 +09:00
bignum.c [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00:00
BSDL
class.c Eagerly name modules and classes 2019-05-22 15:46:47 +09:00
common.mk ${} does not work with nmake.exe 2019-07-02 11:46:58 +09:00
compar.c Clarify requirements of <=> 2019-04-22 17:15:49 +09:00
compile.c * expand tabs. 2019-06-16 23:01:46 +09:00
complex.c * expand tabs. 2019-06-20 04:07:31 +09:00
configure.ac Use realpath(3) instead of custom realpath implementation if available 2019-07-01 11:46:30 -07:00
constant.h Module#constant_source_location [Feature #10771] 2019-06-23 01:46:38 +09:00
cont.c Use native coroutine implementation on OpenBSD-amd64 2019-06-26 16:23:11 -07:00
CONTRIBUTING.md
COPYING COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
COPYING.ja COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
debug.c
debug_counter.c Add debug counter for MJIT stale_units 2019-04-14 07:12:44 +00:00
debug_counter.h Reduce ONIG_NREGION from 10 to 4: power of 2 and testing revealed most pattern matches are less than or equal to 4 results 2019-05-07 21:58:55 +09:00
dir.c [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00: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 [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00:00
enum.c squeeze space [ci skip] 2019-06-13 16:42:31 +09:00
enumerator.c Remove duplicate functions 2019-06-21 17:53:32 +09:00
error.c * expand tabs. 2019-06-13 18:07:19 +09:00
eval.c Include inspect value of object in FrozenError messages 2019-06-04 19:25:03 -07:00
eval_error.c eval_error.c: should not escapce newline and tab 2019-01-24 10:10:18 +00:00
eval_intern.h Use UNALIGNED_MEMBER_PTR 2019-05-31 16:04:16 +09:00
eval_jump.c
file.c Don't use native realpath(3) on Solaris 2019-07-01 15:33:13 -07:00
gc.c Frozen objects in WeakMap 2019-06-23 00:31:16 +09:00
gc.h don't need to sweep rest. 2019-05-16 17:18:50 +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 Raise TypeError if calling ENV.freeze 2019-07-01 12:39:06 -07:00
hrtime.h
id_table.c Add GC.compact again. 2019-04-20 01:19:47 +00:00
id_table.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
inits.c Defer setting gc_stress until inits done 2019-04-24 13:02:01 +09:00
insns.def add definemethod/definesmethod insn. 2019-04-05 08:15:11 +00:00
internal.h Turned recur into int [Feature #15777] 2019-06-21 17:28:37 +09:00
io.c O_EXCL has no meaning for fdopen 2019-06-28 12:02:33 +09:00
iseq.c Use UNALIGNED_MEMBER_PTR 2019-05-31 16:04:16 +09:00
iseq.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
KNOWNBUGS.rb
LEGAL Split procstat_vm.c 2019-02-07 08:53:13 +00:00
lex.c.blt
load.c Turned recur into int [Feature #15777] 2019-06-21 17:28:37 +09:00
loadpath.c
localeinit.c
main.c
Makefile.in Dummy Makefile.in for CIs 2019-06-07 10:05:42 +09:00
marshal.c * expand tabs. 2019-07-01 16:25:56 +09:00
math.c
method.h STATIC_ASSERT for VM_METHOD_TYPE_MINIMUM_BITS 2019-05-31 10:55:38 +09:00
miniinit.c
mjit.c Rename rb_gc_new_location to rb_gc_location 2019-05-18 12:24:28 +03:00
mjit.h Rename mjit_gc_finish_hook to mjit_gc_exit_hook 2019-05-15 23:14:07 -07:00
mjit_compile.c Revert "Try dropping const qualifier to suppress msiwn warning" 2019-04-21 03:35:07 +00:00
mjit_worker.c Do not use rb_iseq_path() while moving ISeq pointers 2019-05-30 04:12:11 +09:00
NEWS [DOC] Fix typos [ci skip] 2019-07-01 00:48:11 +09:00
node.c Fix grammar of macro name: ECCESSED -> ECCESSIVE 2019-06-05 14:03:50 +09:00
node.h Fix grammar of macro name: ECCESSED -> ECCESSIVE 2019-06-05 14:03:50 +09:00
numeric.c Make opt_aref instruction support Integer#[] 2019-06-01 13:15:43 +09:00
object.c * expand tabs. 2019-06-23 01:47:40 +09:00
pack.c [DOC] fix markups [ci skip] 2019-03-28 03:33:35 +00:00
parse.y Hoisted out f_rest_marg 2019-06-30 10:57:24 +09:00
prelude.rb [DOC] update target_thread to TracePoint#enable 2019-06-30 21:23:54 +09:00
probes.d
probes_helper.h
proc.c * expand tabs. 2019-06-12 01:16:45 +09:00
process.c process.c: [DOC] remove extra quotes [ci skip] 2019-03-30 12:37:23 +00:00
random.c * expand tabs. 2019-06-04 19:55:04 +09:00
range.c range.c (inspect_range): omit beginless "nil" 2019-05-23 00:48:32 +09:00
rational.c No TypeError at nil if exception: false 2019-01-12 05:02:58 +00:00
re.c Remove member char_offset_updated from struct rmatch as member char_offset_num_allocated can serve the same purpose as that predicate 2019-04-24 02:02:05 +09:00
README.EXT
README.EXT.ja
README.ja.md Prefer master rather than trunk in README [ci skip] 2019-07-01 01:05:29 +09:00
README.md Prefer master rather than trunk in README [ci skip] 2019-07-01 01:05:29 +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 Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h
regparse.c Fixed String#grapheme_clusters with wide encodings 2019-06-29 10:10:17 +09:00
regparse.h
regsyntax.c
ruby-runner.c Give the MJIT header path name 2018-12-08 01:50:39 +00:00
ruby.c * expand tabs. 2019-06-04 09:36:32 +09:00
ruby_assert.h
ruby_atomic.h
rubystub.c
safe.c
signal.c [DOC] fix markups [ci skip] 2019-03-28 03:33:35 +00:00
siphash.c
siphash.h blacklist UBSAN's unsigned integer overflow 2018-11-07 04:09:05 +00:00
sparc.c
sprintf.c
st.c Add GC.compact again. 2019-04-20 01:19:47 +00:00
strftime.c
string.c * expand tabs. 2019-06-29 10:17:37 +09:00
struct.c Define Struct#deconstruct 2019-04-17 06:48:05 +00:00
symbol.c Prefix global_symbols with ruby_ 2019-05-16 15:43:16 +09:00
symbol.h Add RB_ID_SERIAL_MAX 2019-04-25 13:22:06 +09:00
thread.c [DOC] Re-apply r11000, 41256fd432 2019-06-28 23:21:25 +09:00
thread_pthread.c * expand tabs. 2019-06-19 20:33:24 +09:00
thread_pthread.h
thread_sync.c do_mutex_lock: release mutex before checking for interrupts (fixes issue 15360) 2019-06-11 15:44:11 -07:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c Marshal distant past/future 2019-06-19 15:26:53 +09:00
timev.h timev.h: dummy definition for TAGS 2019-04-10 12:43:31 +00:00
transcode.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
transcode_data.h
transient_heap.c prefix ASAN related inline functions asan_ 2019-05-23 17:24:53 +09:00
transient_heap.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
util.c Split dtoa.c 2019-02-07 08:53:11 +00:00
variable.c * expand tabs. 2019-07-01 14:00:37 +09:00
version.c Update RDoc of RUBY_REVISION 2019-06-06 08:21:40 +09:00
version.h * 2019-07-02 2019-07-02 03:35:08 +09:00
vm.c Ensure that vm_stack is cleared in thread_cleanup_func_before_exec. 2019-06-20 16:44:50 +12:00
vm_args.c update Array's length correctly. 2019-05-23 11:26:33 +09:00
vm_backtrace.c Handle (empty) backtrace when thread is not born yet. 2019-06-19 20:39:10 +12:00
vm_core.h Ensure that vm_stack is cleared in thread_cleanup_func_before_exec. 2019-06-20 16:44:50 +12:00
vm_debug.h
vm_dump.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
vm_eval.c Use UNALIGNED_MEMBER_PTR 2019-05-31 16:04:16 +09:00
vm_exec.c
vm_exec.h use __GNUC__ instead of __GCC__. 2019-03-08 00:35:53 +00:00
vm_insnhelper.c Fix SystemStackError when calling a method in an unused refinement 2019-06-11 09:43:38 -07:00
vm_insnhelper.h Share vm_call_iseq_optimizable_p to reduce copy-paste 2019-03-21 06:25:09 +00:00
vm_method.c * expand tabs. 2019-04-10 09:16:00 +00:00
vm_opts.h
vm_trace.c Suppress warnings by gcc 9.1 2019-06-08 19:46:32 +09:00
vsnprintf.c give up sanitizing BSD_vfprintf 2019-04-26 15:59:40 +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