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 049e1f8560
Fix typo
2021-10-26 14:43:12 +09:00
.github more on eliminating $make 2021-10-26 09:05:46 +09:00
basictest
benchmark add vm_ivar_of_class_set 2021-10-23 01:32:55 +09:00
bin
bootstraptest YJIT: Implement duphash (#5009) 2021-10-25 10:40:33 -04:00
ccan
coroutine
coverage
cygwin Suppress maybe-uninitialized warning on mingw 2021-10-02 08:02:57 +09:00
defs
doc update doc/ractor.md about ivars 2021-10-23 01:32:55 +09:00
enc ruby tool/update-deps --fix 2021-10-05 14:18:23 +09:00
ext [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
gems Update TypeProf to 0.20.1 2021-10-25 19:42:42 +09:00
include improve doc coverage [ci skip] 2021-10-26 09:30:42 +09:00
internal [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
lib [rubygems/rubygems] Add support to build and sign certificates with multiple key algorithms 2021-10-26 08:01:55 +09:00
libexec
man [ruby/irb] Add help about extra doc dir option 2021-10-11 21:12:58 +09:00
misc [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
missing
sample
spec [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
template Remove the scraper 2021-10-20 18:19:38 -04:00
test fix random EBADF problem 2021-10-26 11:39:52 +09:00
tool check other IO#close calls 2021-10-25 17:38:23 +09:00
win32 Remove the scraper 2021-10-20 18:19:38 -04:00
.appveyor.yml Dot-prefix appveyor.yml 2021-09-25 15:44:14 +09:00
.cirrus.yml Set the locale encoding to UTF-8 2021-09-28 00:52:18 +09:00
.dir-locals.el
.document marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
.editorconfig
.gdbinit
.gitattributes
.gitignore Remove the scraper 2021-10-20 18:19:38 -04:00
.rspec_parallel
.travis.yml Reduce the amount of false positive notifications 2021-10-20 21:57:49 -07:00
aclocal.m4
addr2line.c Cast to void pointer for %p in commented out code [ci skip] 2021-10-20 11:22:33 +09:00
addr2line.h
array.c Remove repeated 'the' (#4966) 2021-10-13 23:05:44 -07:00
array.rb [DOC] Additional to Array#sample [ci skip] 2021-09-22 14:17:09 +09:00
ast.c ast.c: Use kept script_lines data instead of re-opening the source file (#5019) 2021-10-26 01:58:01 +09:00
ast.rb
autogen.sh
bignum.c bary_mul_balance_with_mulfunc: move working buffer allocation 2021-10-12 00:45:14 +09:00
BSDL
builtin.c
builtin.h
class.c [Feature #18239] Refactor RVARGC alloc functions 2021-10-25 13:26:23 -04:00
common.mk YJIT: Implement duphash (#5009) 2021-10-25 10:40:33 -04:00
compar.c
compile.c suppress warnings for probable NULL dererefences 2021-10-24 19:24:50 +09:00
complex.c Remove declarations unused since a95262356e 2021-10-18 23:46:58 +09:00
configure.ac Mention YJIT in Capstone autoconf check 2021-10-20 18:19:43 -04:00
constant.h
cont.c rb_fiber_raise(): add doxygen 2021-09-30 20:55:23 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
darray.h Add rb_darray_clear() for Kevin. Fix some warnings. 2021-10-20 18:19:40 -04:00
debug.c [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
debug_counter.c
debug_counter.h
dir.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
dir.rb
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c suppress warnings for probable NULL dererefences 2021-10-24 19:24:50 +09:00
enum.c Fix Enumerable#each_cons and Enumerable#each_slice to return a receiver 2021-10-25 12:13:44 +09:00
enumerator.c Introduce RBIMPL_NONNULL_ARG macro 2021-09-27 14:47:52 +09:00
error.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
eval.c Deprecate include/prepend in refinements and add Refinement#import_methods instead 2021-10-21 16:31:54 +09:00
eval_error.c
eval_intern.h
eval_jump.c
file.c rb_encoding is already const 2021-10-14 10:23:33 +09:00
gc.c [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
gc.h Enable inline assembly of SET_MACHINE_STACK_END on AIX 2021-10-04 23:06:43 -05:00
gc.rb [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Restore Hash#compare_by_identity mode [Bug #18171] 2021-10-02 11:43:35 +09:00
hrtime.h
id_table.c Qundef is not for ID 2021-10-13 12:07:57 +09:00
id_table.h
inits.c Match the main-branch location of yjit in inits.c 2021-10-20 18:19:43 -04:00
insns.def Eliminate some redundant checks on num in newhash 2021-10-18 17:41:38 +09:00
internal.h
io.c Fix typo 2021-10-26 14:43:12 +09:00
io.rb
iseq.c freeze (make shareable) script_lines 2021-10-21 16:17:39 +09:00
iseq.h Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
kernel.rb
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c Pass the VM pointer as an argument 2021-10-10 23:34:16 +09:00
loadpath.c
localeinit.c
main.c
marshal.c marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
marshal.rb marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
math.c
memory_view.c
method.h
mini_builtin.c
miniinit.c
mjit.c
mjit.h Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
mjit_compile.c Extract precompile_inlinable_child_iseq to separate alloca for each iseq 2021-10-12 17:12:01 +09:00
mjit_worker.c
NEWS.md Fix links [ci skip] 2021-10-25 08:38:44 +09:00
nilclass.rb
node.c
node.h
numeric.c Enhanced RDoc for Numeric (#4991) 2021-10-19 12:00:22 -05:00
numeric.rb
object.c Deprecate include/prepend in refinements and add Refinement#import_methods instead 2021-10-21 16:31:54 +09:00
pack.c Refactor associated pointer 2021-10-24 17:50:35 +09:00
pack.rb add example for buffer: argument of pack. 2021-10-25 12:25:13 +09:00
parse.y ast.c: Use kept script_lines data instead of re-opening the source file (#5019) 2021-10-26 01:58:01 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
process.c process.c: Add Process._fork (#5017) 2021-10-25 20:47:19 +09:00
ractor.c Yet Another Ruby JIT! 2021-10-20 18:19:31 -04:00
ractor.rb
ractor_core.h Move rb_ractor_p definition 2021-10-04 08:21:40 +09:00
random.c [Win32] Prefer Cryptography Next Generation API 2021-10-02 21:22:33 +09:00
range.c [DOC] Fix code markup [ci skip] 2021-10-25 01:04:51 +09:00
rational.c
re.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md Move Ruby's README back where it was 2021-10-20 18:19:42 -04:00
regcomp.c Cast up to get rid of the potential overflow posibility 2021-10-14 18:43:32 +09:00
regenc.c
regenc.h
regerror.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regexec.c
regint.h Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.h
regsyntax.c
ruby-runner.c
ruby.c [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c Add gvl and fiber assertions to scheduler interface to catch invalid usage. 2021-09-20 23:16:45 +12:00
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
struct.c [DOC] Fix code markup [ci skip] 2021-10-25 01:04:51 +09:00
symbol.c Fix STATIC_SYM2ID for large ID on IL32LLP64 platforms 2021-10-14 01:11:31 +09:00
symbol.h
thread.c Make Coverage suspendable (#4856) 2021-10-25 20:00:51 +09:00
thread_pthread.c
thread_pthread.h
thread_sync.c
thread_win32.c Function w32_error does not return 2021-10-04 08:15:52 +09:00
thread_win32.h
time.c Prefer the reentrant versions of gmtime and localtime 2021-10-14 23:44:15 +09:00
timev.h
timev.rb
trace_point.rb
transcode.c [Feature #18239] Implement VWA for strings 2021-10-25 13:26:23 -04:00
transcode_data.h
transient_heap.c Supress warning: data argument not used by format string [-Wformat-extra-args] 2021-10-20 07:48:30 +09:00
transient_heap.h
util.c
variable.c allow to access ivars of classes/modules 2021-10-23 01:32:55 +09:00
variable.h
version.c Show +YJIT in version string and RUBY_DESCRIPTION 2021-10-20 18:19:43 -04:00
version.h * 2021-10-26 [ci skip] 2021-10-26 01:51:20 +09:00
vm.c Make Coverage suspendable (#4856) 2021-10-25 20:00:51 +09:00
vm_args.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
vm_backtrace.c ast.c: Use kept script_lines data instead of re-opening the source file (#5019) 2021-10-26 01:58:01 +09:00
vm_callinfo.h Partial revert of ceebc7fc98 2021-10-20 18:19:36 -04:00
vm_core.h Make Coverage suspendable (#4856) 2021-10-25 20:00:51 +09:00
vm_debug.h Use RUBY_FUNCTION_NAME_STRING for old Visual C++ 2021-10-20 11:22:33 +09:00
vm_dump.c Shorten register names on arm64-darwin not to be truncated 2021-10-10 21:58:56 +09:00
vm_eval.c Introduce rb_vm_call_with_refinements to DRY up a few calls 2021-10-01 08:12:46 -09:00
vm_exec.c Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
vm_exec.h Remove the scraper 2021-10-20 18:19:38 -04:00
vm_insnhelper.c Extract yjit_force_iv_index and make it work when object is frozen 2021-10-20 18:19:43 -04:00
vm_insnhelper.h Count interpreter instructions when -DYJIT_STATS=1 2021-10-20 18:19:40 -04:00
vm_method.c Partial revert of ceebc7fc98 2021-10-20 18:19:36 -04:00
vm_opts.h oops Direct threading should be default 2021-10-20 18:19:25 -04:00
vm_sync.c Supress warning: data argument not used by format string [-Wformat-extra-args] 2021-10-20 07:48:30 +09:00
vm_sync.h
vm_trace.c Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00
vsnprintf.c
warning.rb
yjit.c Strip out YJIT at build time when unsupported or disabled (#5003) 2021-10-25 10:45:22 -04:00
yjit.h Update YJIT code owners. Revert accidental commit. 2021-10-25 14:53:22 -04:00
yjit.rb Strip out YJIT at build time when unsupported or disabled (#5003) 2021-10-25 10:45:22 -04:00
yjit_asm.c YJIT: Show GCC that the mmap probing loop runs at least once 2021-10-20 19:04:22 -04:00
yjit_asm.h Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00
yjit_codegen.c YJIT: Implement duphash (#5009) 2021-10-25 10:40:33 -04:00
yjit_codegen.h Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00
yjit_core.c Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00
yjit_core.h Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00
yjit_iface.c YJIT: Don't take VM lock on constant IC fill when disabled 2021-10-22 17:22:41 -04:00
yjit_iface.h Fix non RUBY_DEBUG build warnings 2021-10-20 18:19:43 -04:00
yjit_utils.c Put YJIT into a single compilation unit 2021-10-20 18:19:42 -04:00

Actions Status: macOS 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/contributing.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