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
Samuel Williams 9151ed2fb2 Return fstrings from build_const_pathname.
It's possible for `build_const_pathname` to be called when `rb_cString` is
still NULL. There is a fix-up step when `rb_cString` is initialized, but
it only applies to `fstring` instances.
2021-09-25 18:19:20 +12:00
.github .github/workflows/compilers.yml: Use GNUMAKEFLAGS. 2021-09-23 10:21:06 +02:00
basictest
benchmark Add benchmarks to create Time instances 2021-09-12 18:44:53 +09:00
bin
bootstraptest
ccan
coroutine
coverage
cygwin
defs Fix rubyspec_capiext dependency and flags 2021-08-30 12:03:44 +09:00
doc [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
enc
ext [DOC] Use unpack1 instead of unpack(template)[0] [ci skip] 2021-09-23 09:20:00 +09:00
gems Update bundled_gems at 2021-09-14 2021-09-14 07:04:28 +00:00
include Align the implementation precedences with rb_atomic_t definition 2021-09-24 10:11:32 +09:00
internal Consider modified modules initialized [Bug #18185] 2021-09-24 08:29:00 +09:00
lib [ruby/reline] Add aliases {prev,next}_history to ed_{prev,next}_history 2021-09-25 00:11:44 +09:00
libexec [ruby/irb] Move IRB::TOPLEVEL_BINDING from exe/irb to lib/irb/workspace.rb 2021-09-10 06:37:07 +09:00
man Add --autocomplete / --noautocomplete options 2021-08-30 02:45:13 +09:00
misc [Feature #18045] Implement size classes for GC 2021-08-25 09:28:21 -04:00
missing Use C99-defined signbit macro 2021-08-27 12:42:23 +09:00
sample Clean up lambda output from exyacc.rb 2021-08-25 18:23:56 -07:00
spec FL_USER flags on ohter than T_DATA are reserved [Misc #18059] 2021-09-24 19:23:15 +09:00
template Ripper source on mswin 2021-09-21 13:05:27 +09:00
test Pend test_complete_require_library_name_first 2021-09-24 22:56:38 +09:00
tool .cirrus.yml: Add Cirrus CI for Arm64 tests. 2021-09-22 09:01:43 +02:00
win32 Reminders of the Windows versions each API is available [ci skip] 2021-09-24 12:31:20 +09:00
.cirrus.yml .cirrus.yml: Add Cirrus CI for Arm64 tests. 2021-09-22 09:01:43 +02:00
.dir-locals.el
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c Use the correct address size 2021-09-23 12:29:07 -07:00
addr2line.h
appveyor.yml Enable shallow clone on appveyor 2021-09-19 17:17:03 +09:00
array.c [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
array.rb [DOC] Additional to Array#sample [ci skip] 2021-09-22 14:17:09 +09:00
ast.c ast.c: AST.of against C method should return nil (as Ruby 2.6--3.0) 2021-09-18 21:52:18 +09:00
ast.rb
autogen.sh
bignum.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
BSDL
builtin.c
builtin.h
class.c Use the flag for uninitialized module [Bug #18185] 2021-09-24 08:29:00 +09:00
common.mk Explicit the target of do-install-all as the same as dont-install-all 2021-09-21 23:58:00 +09:00
compar.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
compile.c Using RB_FLOAT_TYPE_P macro 2021-09-12 11:16:31 +09:00
complex.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
configure.ac MINGW-UCRT: Set CONFIG['arch'] and RUBY_PLATFORM to "x64-mingw-ucrt" 2021-09-20 00:15:30 +09:00
constant.h
cont.c Expose rb_fiber_raise and tidy up the internal implementation. 2021-09-20 18:30:51 +12:00
CONTRIBUTING.md [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
COPYING
COPYING.ja
debug.c
debug_counter.c
debug_counter.h
dir.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
dir.rb Links for What's Here sections (#4827) 2021-09-13 10:37:15 -05:00
dln.c dln.c: add missing dependency 2021-09-10 20:00:06 +09:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c Enhanced RDoc for Enumerable#inject (#4876) 2021-09-20 18:19:21 -05:00
enumerator.c Comparing nonnull argument to NULL is useless 2021-09-23 16:55:35 +09:00
error.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
eval.c Consider modified modules initialized [Bug #18185] 2021-09-24 08:29:00 +09:00
eval_error.c Trim extra whitespace in inaccesible error message 2021-09-01 13:18:55 +09:00
eval_intern.h
eval_jump.c
file.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
gc.c Fix malloc_increase is not correctly calculated 2021-09-20 09:01:58 -04:00
gc.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
gc.rb Enhance documentation on GC.stat (#4843) 2021-09-20 14:40:55 -04:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
hrtime.h
id_table.c
id_table.h
inits.c
insns.def Fix typo in insns.def [ci skip] 2021-09-23 17:14:04 -04:00
internal.h Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
io.c [DOC] Use unpack1 instead of unpack(template)[0] [ci skip] 2021-09-23 09:20:00 +09:00
io.rb
iseq.c Replace RBOOL macro 2021-09-05 23:01:27 +09:00
iseq.h
kernel.rb
KNOWNBUGS.rb
LEGAL [DOC] Separate paragraph in LEGAL instead of break lines [ci skip] 2021-09-11 19:09:37 +09:00
lex.c.blt
load.c Revert "Do not load file with same realpath twice when requiring" 2021-09-18 17:37:35 -07:00
loadpath.c
localeinit.c
main.c
marshal.c Add symname_equal_lit for comparison with a string literal 2021-09-23 22:07:52 +09:00
math.c Using RB_FLOAT_TYPE_P macro 2021-09-12 11:16:31 +09:00
memory_view.c memory_view.c: Rename private to private_data for C++ (#4812) 2021-09-06 16:01:52 +09:00
method.h
mini_builtin.c
miniinit.c
mjit.c
mjit.h
mjit_compile.c Suppress redefinition warnings of GET_SELF() 2021-08-30 09:06:36 +09:00
mjit_worker.c
NEWS.md add NEWS entry for https://github.com/ruby/ruby/pull/4815 2021-09-22 17:59:28 +09:00
nilclass.rb
node.c
node.h
numeric.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
numeric.rb Replace RBOOL macro 2021-09-05 23:01:27 +09:00
object.c Fix a typo [Bug #17048] 2021-09-19 22:39:18 +09:00
pack.c
pack.rb
parse.y Use %printer directive for Bison 3.8 2021-09-14 18:51:38 +09:00
prelude.rb
probes.d
probes_helper.h
proc.c Assert not to be UNDEF visibility 2021-09-01 19:28:54 +09:00
process.c Rework order of operations to better handle last_status. 2021-09-22 18:50:26 +12:00
ractor.c
ractor.rb [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
ractor_core.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
random.c HCRYPTPROV is not a HANDLE 2021-09-24 12:12:38 +09:00
range.c Correct two errors in Range RDoc (#4889) 2021-09-23 18:08:49 -05:00
rational.c Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
re.c [Feature #18172] Add MatchData#match_length 2021-09-16 19:55:06 +09:00
README.EXT
README.EXT.ja
README.ja.md
README.md .cirrus.yml: Add Cirrus CI for Arm64 tests. 2021-09-22 09:01:43 +02:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
ruby_assert.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
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 Use free instead of xfree to free altstack 2021-09-06 14:22:24 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
st.c
strftime.c Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
string.c [DOC] Use unpack1 instead of unpack(template)[0] [ci skip] 2021-09-23 09:20:00 +09:00
struct.c Enhanced RDoc for Struct (#4891) 2021-09-24 18:41:02 -05:00
symbol.c include/ruby/internal/symbol.h: add doxygen 2021-09-10 20:00:06 +09:00
symbol.h
thread.c Refactor and Using RBOOL macro 2021-09-15 08:11:05 +09:00
thread_pthread.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
thread_pthread.h
thread_sync.c Add WB_PROTECTED to mutexes 2021-09-17 10:03:39 +09:00
thread_win32.c
thread_win32.h Get rid of duplicate typedef 2021-09-03 22:47:58 +09:00
time.c Include the invalid value in invalid_utc_offset error 2021-09-18 18:03:54 +09:00
timev.h
timev.rb Links for What's Here sections (#4827) 2021-09-13 10:37:15 -05:00
trace_point.rb
transcode.c Using SYMBOL_P macro 2021-09-11 08:48:56 +09:00
transcode_data.h
transient_heap.c
transient_heap.h
util.c include/ruby/internal/ctype.h: add doxygen 2021-09-10 20:00:06 +09:00
variable.c Return fstrings from build_const_pathname. 2021-09-25 18:19:20 +12:00
variable.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
version.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
version.h * 2021-09-25 [ci skip] 2021-09-25 00:12:00 +09:00
vm.c Revert "Do not load file with same realpath twice when requiring" 2021-09-18 17:37:35 -07:00
vm_args.c Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_backtrace.c
vm_callinfo.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_core.h Revert "Do not load file with same realpath twice when requiring" 2021-09-18 17:37:35 -07:00
vm_debug.h suppress GCC's -Wsuggest-attribute=format 2021-09-10 20:00:06 +09:00
vm_dump.c
vm_eval.c Refactor rb_call_super function 2021-09-25 17:03:36 +12:00
vm_exec.c
vm_exec.h Remove printf family from the mjit header 2021-09-11 08:41:32 +09:00
vm_insnhelper.c Extract hook macro for attributes 2021-09-19 16:27:47 +09:00
vm_insnhelper.h
vm_method.c
vm_opts.h
vm_sync.c
vm_sync.h
vm_trace.c include/ruby/debug.h: add doxygen 2021-09-10 20:00:06 +09:00
vsnprintf.c
warning.rb

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