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
2022-02-20 20:39:48 +09:00
.github [MSWin] Reduce duplicate configurations 2022-02-20 20:39:48 +09:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark Speed up and avoid kwarg hash alloc in Time.now 2022-01-12 12:55:14 -08:00
bin
bootstraptest Reuse -v option result as target_platform 2022-02-17 20:12:38 +09:00
ccan
coroutine [wasm] add coroutine/asyncify implementation 2022-01-19 11:19:06 +09:00
coverage
cygwin
defs Add a Module#const_added callback 2022-01-14 11:30:07 +01:00
doc New doc about encoding (#5572) 2022-02-18 13:33:18 -06:00
enc
ext objspace: Hide identhash containing internal objs 2022-02-09 17:32:43 -08:00
gems Update RBS (#5515) 2022-02-02 13:25:47 +09:00
include Check if __assume is supported 2022-02-19 23:32:52 +09:00
internal Change darray size to size_t and add functions that use GC malloc 2022-02-16 09:50:29 -05:00
lib Make Set a builtin feature [Feature #16989] 2022-02-18 11:56:24 +09:00
libexec [ruby/rdoc] Relative loading for easier development (https://github.com/ruby/rdoc/pull/821) 2022-02-12 15:06:06 +09:00
man
misc Treat TS_ICVARC cache as separate from TS_IVC cache 2022-02-02 09:20:34 -08:00
missing [wasm] wasm/missing.{c,h}: add missing libc stubs for wasi-libc 2022-01-19 11:19:06 +09:00
sample Remove obsolete Fixnum and Bignum 2021-12-28 18:35:03 +09:00
spec [rubygems/rubygems] Fix corrupted lockfile when using gemspec and multiple sources 2022-02-11 18:20:20 +09:00
template [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
test Add String#byteindex, String#byterindex, and MatchData#byteoffset (#5518) 2022-02-19 19:10:00 +09:00
tool RUBY_REPLACE_TYPE: check if the target type is a pointer 2022-02-19 15:33:15 +09:00
wasm [wasm] vm.c: stop unwinding to main for every vm_exec call by setjmp 2022-02-18 18:28:18 +09:00
win32 Check if __assume is supported 2022-02-19 23:32:52 +09:00
.appveyor.yml Appveyor: Link vcpkg DLLs except for readline 2022-02-07 15:30:07 +09:00
.cirrus.yml
.dir-locals.el
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore [wasm] add unit test suite for fiber, register scan, sjlj in platform dir 2022-01-19 11:19:06 +09:00
.rdoc_options [DOC] Add .rdoc_options file 2022-02-11 11:25:05 +09:00
.rspec_parallel
.travis.yml Ignore hung-ups after success on s390x-linux tentatively [ci skip] 2021-12-21 13:40:28 +09:00
aclocal.m4
addr2line.c
addr2line.h
array.c Use RARRAY_SHARED_ROOT_FLAG for checking re-enter 2022-02-14 09:35:54 -05:00
array.rb
ast.c Make RubyVM::AST.of work with code written in -e command-line option 2021-12-26 20:57:34 +09:00
ast.rb
autogen.sh
bignum.c [DOC] Integer#coerce deals with also Float 2021-12-29 11:50:28 +09:00
BSDL
builtin.c
builtin.h
class.c Replace and Using METACLASS_OF macro 2022-02-19 23:18:51 +09:00
common.mk Try make this more readable and consistent with other targets 2022-02-01 08:09:23 +09:00
compar.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
compile.c Fix indents [ci skip] 2022-02-03 11:21:41 +09:00
complex.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
configure.ac Check if __assume is supported 2022-02-19 23:32:52 +09:00
constant.h
cont.c rb_fiber_terminate must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
darray.h Change feature_index from fake Array to darray 2022-02-16 09:50:29 -05:00
debug.c USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
debug_counter.c
debug_counter.h
dir.c dir.c: ignore ENOTCAPABLE while glob similar to EACCES 2022-01-19 11:19:06 +09:00
dir.rb [DOC] prefer rdoc references over generated URLs 2022-02-19 15:14:01 +09:00
dln.c Remove unused function declaration in dln.c 2022-02-18 09:30:08 -05:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c [DOC] Use RDoc link style for links in the same class/module 2022-02-07 09:52:06 -05:00
enumerator.c
error.c Don't segfault if Warning.warn is undefined 2022-01-04 10:03:18 -08:00
eval.c Remove Refinement#{extend_object,append_features,prepend_features} 2022-01-05 10:59:03 -08:00
eval_error.c
eval_intern.h rb_fiber_terminate must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
eval_jump.c
file.c [DOC] Replace with IO@Modes 2022-02-07 09:52:06 -05:00
gc.c Change darray size to size_t and add functions that use GC malloc 2022-02-16 09:50:29 -05:00
gc.h Add the size pool slot size to the output of ObjectSpace.dump/dump_all 2022-02-03 15:07:35 -05:00
gc.rb [Feature #18364] Add GC.stat_heap to get stats for memory heaps 2022-01-04 09:46:36 -05:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
hrtime.h
id_table.c Support ID_TABLE_STOP for replace function 2022-01-25 16:51:16 -05:00
id_table.h Rename rb_id_table_foreach_with_replace 2022-01-25 16:51:16 -05:00
inits.c
insns.def Treat TS_ICVARC cache as separate from TS_IVC cache 2022-02-02 09:20:34 -08:00
internal.h
io.c Enhanced RDoc for io.c (#5573) 2022-02-18 16:17:51 -06:00
io.rb
io_buffer.c io_buffer.c: use mremap based resizing only when mremap available 2022-01-07 02:13:19 +09:00
iseq.c Fix indents [ci skip] 2022-02-03 11:21:41 +09:00
iseq.h
kernel.rb
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c Change feature_index from fake Array to darray 2022-02-16 09:50:29 -05:00
loadpath.c
localeinit.c
main.c [wasm] add asyncify based setjmp, fiber, register scan emulation 2022-01-19 11:19:06 +09:00
marshal.c Fix typos [ci skip] 2021-12-25 10:33:49 +09:00
marshal.rb [DOC] Document Marshal#load parameter freeze: (#5332) 2021-12-24 09:55:09 +01:00
math.c
memory_view.c
method.h Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
mini_builtin.c
miniinit.c
mjit.c Transfer the responsibility for MJIT options to mjit.c 2022-01-15 18:57:33 +09:00
mjit.h
mjit_compile.c
mjit_worker.c
NEWS.md Add String#byteindex, String#byterindex, and MatchData#byteoffset (#5518) 2022-02-19 19:10:00 +09:00
nilclass.rb
node.c
node.h
numeric.c [DOC] Fix a typo in Integer#chr example 2022-02-13 15:48:01 +09:00
numeric.rb
object.c Enhanced RDoc concerning command injection (#5537) 2022-02-18 06:46:04 -06:00
pack.c
pack.rb [DOC] Fix String#unpack and #unpack1 docs (#5331) 2021-12-23 21:58:13 +01:00
parse.y Find pattern is no longer experimental [Feature #18585] 2022-02-19 18:45:49 +09:00
prelude.rb Make Set a builtin feature [Feature #16989] 2022-02-18 11:56:24 +09:00
probes.d
probes_helper.h
proc.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
process.c Use symbols for clock IDs if clockid_t is not numeric 2022-02-19 15:33:15 +09:00
ractor.c USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
ractor.rb
ractor_core.h
random.c [DOC] Mark up the code for Kernel#rand as the same as Random#rand 2022-01-13 11:34:09 +09:00
range.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
rational.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
re.c Add String#byteindex, String#byterindex, and MatchData#byteoffset (#5518) 2022-02-19 19:10:00 +09:00
README.EXT
README.EXT.ja
README.ja.md Update badges from README.md [ci skip] 2021-12-24 09:05:12 +09:00
README.md
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c ruby.c: initialize extra optional extensions linked statically 2022-01-19 11:19:06 +09:00
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c Add fiber scheduler hooks for pread/pwrite, and add support to IO::Buffer. 2021-12-23 12:20:09 +13:00
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c st.c: Do not clear entries_bound when calling Hash#shift for empty hash 2022-02-10 00:14:27 +09:00
strftime.c
string.c Add String#byteindex, String#byterindex, and MatchData#byteoffset (#5518) 2022-02-19 19:10:00 +09:00
struct.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
symbol.c
symbol.h
thread.c Accurately report VM memsize 2022-01-21 14:34:53 -08:00
thread_none.c [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_none.h [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_pthread.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +09:00
thread_pthread.h
thread_sync.c
thread_win32.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +09:00
thread_win32.h
time.c Speed up and avoid kwarg hash alloc in Time.now 2022-01-12 12:55:14 -08:00
timev.h
timev.rb [DOC] prefer rdoc references over generated URLs 2022-02-19 15:14:01 +09:00
trace_point.rb
transcode.c Add econv_get_encoding function 2022-02-02 22:52:55 +09:00
transcode_data.h
transient_heap.c USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
transient_heap.h
util.c
variable.c variable.c: Fix incorrect identation in const_added 2022-01-14 16:22:57 +01:00
variable.h
version.c
version.h * 2022-02-19 [ci skip] 2022-02-19 04:33:35 +09:00
vm.c [wasm] vm.c: stop unwinding to main for every vm_exec call by setjmp 2022-02-18 18:28:18 +09:00
vm_args.c
vm_backtrace.c Add Thread.each_caller_location 2022-02-17 08:54:07 -08:00
vm_callinfo.h Remove a typo hash [ci skip] 2022-01-29 15:33:13 +09:00
vm_core.h [wasm] eval_inter.h gc.c vm_core.h: include wasm/setjmp.h instead of sysroot header 2022-01-19 11:19:06 +09:00
vm_debug.h USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
vm_dump.c enable RUBY_ON_BUG on release build 2022-01-25 16:43:57 +09:00
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c Streamline cached attr reader / writer indexes 2022-01-26 09:02:59 -08:00
vm_insnhelper.h
vm_method.c Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
vm_opts.h
vm_sync.c
vm_sync.h USE_RUBY_DEBUG_LOG doesn't check RUBY_DEVEL 2021-12-29 00:22:02 +09:00
vm_trace.c Fix error: old-style function definition 2022-01-22 15:48:05 +09:00
vsnprintf.c [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
warning.rb
yjit.c YJIT: Add support for ruby array cfuncs (argc=-2) 2022-01-08 11:40:55 -08:00
yjit.h re-enabled YJIT on x64-mswin64 2021-12-31 20:13:11 +09:00
yjit.rb Prefer RBOOL 2022-01-01 17:02:04 +09:00
yjit_asm.c Tiny mmap emulation for Windows 2021-12-27 15:56:23 +09:00
yjit_asm.h
yjit_codegen.c yjit_codegen.c: Prevent a possible out-of-bound access 2022-02-17 01:43:59 +09:00
yjit_codegen.h
yjit_core.c Fix -Wsign-compare when -DRUBY_DEBUG=1 2022-02-16 10:34:06 -05:00
yjit_core.h
yjit_iface.c Change darray size to size_t and add functions that use GC malloc 2022-02-16 09:50:29 -05:00
yjit_iface.h
yjit_utils.c

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus 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, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-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 also 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.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

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. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

  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 include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (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. 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 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