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
hsbt 4ae3df42f7 Merge RubyGems master@9be7858f7f17eae3058204f3c03e4b798ba18b9c
This version contains the some style changes by RuboCop.

    * 9d810be0ed
    * 61ea98a727
    * 795893dce3
    * 9be7858f7f

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@67074 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2019-02-14 12:59:03 +00:00
basictest Prefer block_given? to iterator? 2019-01-18 09:52:50 +00:00
benchmark benchmark/app_aobench.rb: complete commented code to write the image to a file 2019-01-21 12:31:29 +00:00
bin bin/erb: improve documentation of -P flag 2018-12-16 14:24:20 +00:00
bootstraptest on-smash canary detection 2019-02-01 07:26:39 +00:00
ccan ccan/list: sync with upstream 2018-02-01 08:59:27 +00:00
coroutine Ensure x86 stack is fortified, fixed #15335. 2018-12-11 23:49:33 +00:00
coverage
cygwin
defs Method reference operator 2018-12-31 15:00:37 +00:00
doc NEWS: use note-list 2019-02-02 06:38:09 +00:00
enc Removed duplicate dependents 2019-02-14 05:40:08 +00:00
ext Prefer relative directory from srcdir to top_srcdir 2019-02-14 05:42:14 +00:00
gems * gems/bundled_gems: Upgrade the did_you_mean gem to 1.3.0 2018-12-19 19:01:02 +00:00
include introduce rb_nogvl C-API to mark ubf as async-signal-safe 2019-01-04 13:14:11 +00:00
lib Merge RubyGems master@9be7858f7f17eae3058204f3c03e4b798ba18b9c 2019-02-14 12:59:03 +00:00
libexec Merge Bundler 2.0.1 from upstream. 2019-01-04 13:10:58 +00:00
man Merge Bundler 2.0.1 from upstream. 2019-01-04 13:10:58 +00:00
misc ruby-style.el: ruby-style-c-mode by VCS [ci skip] 2018-11-27 13:47:49 +00: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 Accept a third value for NaNs, as produced by the Sun Studio C Compiler 2019-02-11 21:57:10 +00:00
template Disable tailcall optimization [Bug #15303] 2018-12-12 05:46:13 +00:00
test Merge RubyGems master@9be7858f7f17eae3058204f3c03e4b798ba18b9c 2019-02-14 12:59:03 +00:00
tool Prefer relative directory from srcdir to top_srcdir 2019-02-14 05:42:14 +00:00
win32 Parenthesize for to ignore errors 2019-02-13 15:34:08 +00: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 Set indent_size of reg*.[ch] to 2 [ci skip] 2018-10-03 07:43:13 +00:00
.gdbinit support theap for T_HASH. [Feature #14989] 2018-10-30 22:11:51 +00:00
.gitattributes
.gitignore Use BUILDDIR in ruby-runner.h from config.status 2018-12-08 01:49:02 +00:00
.indent.pro
.travis.yml .travis.yml: allow C99 on pedanticism buid 2019-01-10 07:59:18 +00:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c Use _NSGetMachExecuteHeader() instead of _mh_execute_header 2019-01-31 12:58:33 +00:00
addr2line.h Support Mach-O on backtrace with DWARF 2018-10-20 06:35:25 +00:00
appveyor.yml appveyor.yml: retry zlib downloads 2019-02-07 14:58:37 +00:00
array.c Clarify Array#- and Array#difference documentation 2019-01-15 13:52:38 +00:00
ast.c ast.c: fix missing head part in dynamic literal 2019-01-14 10:16:54 +00:00
bignum.c * expand tabs. 2019-01-04 13:14:18 +00:00
BSDL
class.c class.c: refactor class_instance_method_list 2019-01-09 14:04:21 +00:00
common.mk Removed duplicate dependents 2019-02-14 05:40:08 +00:00
compar.c
compile.c Show proper location for warning [Feature #15575] 2019-02-04 08:13:37 +00:00
complex.c No TypeError at nil if exception: false 2019-01-12 05:02:58 +00:00
configure.ac random.c: use getrandom() if available. 2019-02-10 08:21:33 +00:00
constant.h vm_insnhelper.c: rb_autoloading_value flag 2018-02-13 09:34:43 +00:00
cont.c Fix styles [ci skip] 2019-01-09 13:58:49 +00: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 internal.h: remove dependecy on ruby/io.h 2018-01-09 06:24:10 +00:00
debug_counter.c add debug counters more. 2018-09-28 01:10:43 +00:00
debug_counter.h rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
dir.c dir.c: fix Dir.glob with braces and matching dir 2019-01-16 14:06:37 +00:00
dln.c reduce copy & paste 2018-07-30 07:07:48 +00:00
dln.h
dln_find.c
dmydln.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
dmyenc.c
dmyext.c
encindex.h
encoding.c encoding.c: check external encoding 2018-09-15 16:27:06 +00:00
enum.c enum.c: [DOC] tally does not take a block 2019-02-08 09:57:23 +00:00
enumerator.c * expand tabs. 2019-01-30 06:06:02 +00:00
error.c Remove message to recommend to repot bug 2019-02-13 04:32:03 +00:00
eval.c mjit.c: use boolean type for boolean variables 2019-01-10 14:31:18 +00:00
eval_error.c eval_error.c: should not escapce newline and tab 2019-01-24 10:10:18 +00:00
eval_intern.h reduce copy & paste 2018-07-30 07:07:48 +00:00
eval_jump.c $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
file.c file.c: use correct integer-conversion function 2018-10-23 12:23:04 +00:00
gc.c fix empty Hash memsize. 2019-02-12 03:45:15 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb added f for 1 byte FizzBuzz because Hexagony has such feature 2018-05-21 06:20:24 +00:00
goruby.c
GPL
hash.c hash.c: hoisted out st_index_hash 2019-01-30 05:08:36 +00:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
ia64.S Change Makefile rule for assembly to use .S rather than .s 2018-11-24 11:35:29 +00:00
id_table.c
id_table.h
inits.c initialize VM postponed_job first. [Bug #15288] 2018-11-08 05:35:46 +00:00
insns.def insns.def: opt_regexpmatch1 is not a leaf insn 2019-02-01 11:52:06 +00:00
internal.h enumerator.c: fix arith_seq_first for Infinity 2019-01-30 06:05:57 +00:00
io.c io.c: remove unused variable and fix typo 2019-02-11 03:06:10 +00:00
iseq.c Fix styles [ci skip] 2019-01-09 13:58:49 +00:00
iseq.h script_compiled TracePoint event [Feature #15287] 2018-12-06 13:42:32 +00:00
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL Split procstat_vm.c 2019-02-07 08:53:13 +00:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c * expand tabs. 2018-12-31 01:14:52 +00:00
loadpath.c -Wno-overlength-strings 2018-01-16 08:35:33 +00:00
localeinit.c internal.h: remove dependecy on ruby/encoding.h 2018-01-09 06:24:11 +00:00
main.c
Makefile.in Cleaning gems should not clean ext 2019-02-13 15:48:36 +00:00
marshal.c avoid division by zero 2018-11-16 01:52:39 +00:00
math.c math.c: adjust cbrt 2018-06-06 14:01:43 +00:00
method.h Add refinements support to method/instance_method. 2019-01-28 11:45:21 +00:00
miniinit.c
mjit.c mjit.c: use boolean type for boolean variables 2019-01-10 14:31:18 +00:00
mjit.h mjit.c: use boolean type for boolean variables 2019-01-10 14:31:18 +00:00
mjit_compile.c mjit.c: use boolean type for boolean variables 2019-01-10 14:31:18 +00:00
mjit_worker.c Revert "mjit_worker.c: try to simplify CC_DLDFLAGS_ARGS" 2019-01-19 09:08:10 +00:00
NEWS enum.c: Enumerable#tally 2019-02-07 08:14:10 +00:00
node.c * expand tabs. 2018-12-31 15:00:52 +00:00
node.h Method reference operator 2018-12-31 15:00:37 +00:00
numeric.c enumerator.c: fix arith_seq_first for Infinity 2019-01-30 06:05:57 +00:00
object.c Fix Module#const_defined? on inherited constants 2019-01-28 13:32:32 +00:00
pack.c pack.c: cast from double to float can be undefined 2018-11-16 09:04:34 +00:00
parse.y parse.y: trim newline in erred code 2019-01-26 13:43:32 +00:00
prelude.rb TracePoint#enable(target_thraed:) [Feature #15473] 2018-12-29 16:44:09 +00:00
probes.d
probes_helper.h vm.c: disable dtrace in jit source 2018-02-20 03:15:33 +00:00
proc.c * expand tabs. 2019-01-28 11:45:24 +00:00
process.c new constant: Process::CLOCK_TAI. 2019-02-09 14:54:54 +00:00
random.c random.c: unify syscall with getrandom 2019-02-10 10:42:50 +00:00
range.c Fix styles [ci skip] 2019-01-09 13:58:49 +00:00
rational.c No TypeError at nil if exception: false 2019-01-12 05:02:58 +00:00
re.c re.c: [DOC] fix typos 2018-12-13 20:25:36 +00:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Update CI build status badges [ci skip] 2018-12-20 09:55:05 +00:00
README.md README.md: add wercker status badge [ci skip] 2018-11-02 12:21:59 +00:00
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 2018-09-15 09:59:14 +00:00
regenc.c
regenc.h initializer paren-string {("str")} is a C99ism 2018-01-02 06:41:49 +00:00
regerror.c regerror.c: lenghten MAX_ERROR_PAR_LEN to contain old property names 2018-10-16 09:10:56 +00:00
regexec.c label as lvalue is a GCCism 2018-01-02 06:41:54 +00:00
regint.h
regparse.c convert check for array length to assertion and comment out 2018-12-07 07:20:26 +00:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c
ruby-runner.c Give the MJIT header path name 2018-12-08 01:50:39 +00:00
ruby.c Defer escaping control char in error messages 2019-01-08 09:08:31 +00:00
ruby_assert.h string literal longer than 509 characters is a C99ism 2018-01-02 06:41:43 +00:00
ruby_atomic.h move atomic logic from mjit.c from ruby_atomic.h 2018-08-01 03:40:37 +00:00
rubystub.c
safe.c $SAFE as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
signal.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
siphash.c
siphash.h blacklist UBSAN's unsigned integer overflow 2018-11-07 04:09:05 +00:00
sparc.c
sprintf.c sprintf.c: fix typo 2018-04-22 19:41:06 +00:00
st.c st.c (rb_hash_bulk_insert_into_st_table): avoid out-of-bounds write 2019-01-15 14:19:19 +00:00
strftime.c Prefer rb_fstring_lit over rb_fstring_cstr 2018-10-13 09:59:22 +00:00
string.c * string.c (chopped_length): early return for empty strings 2019-02-07 07:39:47 +00:00
struct.c Struct#to_h: Add doc for block form. 2018-12-23 03:43:45 +00:00
symbol.c parse.y: ignore constant name captures 2018-12-20 05:43:15 +00:00
symbol.h parse.y: ignore constant name captures 2018-12-20 05:43:15 +00:00
thread.c introduce rb_nogvl C-API to mark ubf as async-signal-safe 2019-01-04 13:14:11 +00:00
thread_pthread.c introduce rb_nogvl C-API to mark ubf as async-signal-safe 2019-01-04 13:14:11 +00:00
thread_pthread.h thread_pthread.h: rename gvl.acquired' to gvl.owner' and document 2018-08-28 00:24:08 +00:00
thread_sync.c thread_sync.c (rb_mutex_t): eliminate fork_gen 2018-12-22 01:41:18 +00:00
thread_win32.c thread.c (call_without_gvl): spawn thread for UBF iff single-threaded 2019-01-04 12:53:06 +00:00
thread_win32.h
time.c time.c: [DOC] small improvement 2019-01-20 15:04:41 +00:00
timev.h Timezone support by Time [Feature #14850] 2018-10-08 02:35: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 rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
transient_heap.h introduce USE_TRANSIENT_HEAP to enable/disable theap. 2018-11-01 08:53:44 +00:00
util.c Split dtoa.c 2019-02-07 08:53:11 +00:00
variable.c * expand tabs. 2018-12-28 10:33:04 +00:00
version.c Moved version numbers 2018-12-28 02:12:34 +00:00
version.h * 2019-02-14 2019-02-13 15:19:28 +00:00
vm.c on-smash canary detection 2019-02-01 07:26:39 +00:00
vm_args.c on-smash canary detection 2019-02-01 07:26:39 +00:00
vm_backtrace.c Make some internal functions static 2018-11-16 06:52:00 +00:00
vm_core.h introduce rb_nogvl C-API to mark ubf as async-signal-safe 2019-01-04 13:14:11 +00:00
vm_debug.h
vm_dump.c Split procstat_vm.c 2019-02-07 08:53:13 +00:00
vm_eval.c on-smash canary detection 2019-02-01 07:26:39 +00:00
vm_exec.c vm_exec.c: reduced repeated same calls 2018-03-04 01:52:19 +00:00
vm_exec.h fix typo. 2018-09-21 06:30:54 +00:00
vm_insnhelper.c on-smash canary detection 2019-02-01 07:26:39 +00:00
vm_insnhelper.h on-smash canary detection 2019-02-01 07:26:39 +00:00
vm_method.c Add refinements support to method/instance_method. 2019-01-28 11:45:21 +00:00
vm_opts.h vm_opts.h: share USE_IC_FOR_IVAR as OPT_IC_FOR_IVAR 2018-10-14 11:25:36 +00:00
vm_trace.c vm_trace.c: trick rdoc for TracePoint#enable 2019-02-01 05:20:07 +00:00
vsnprintf.c avoid division by zero 2018-11-16 01:52:39 +00:00
wercker.yml wercker.yml: debug problematic test on test-all 2018-11-18 09:32:29 +00:00

Build Status Build status wercker status

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 (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/trunk/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/

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

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

Or if you are using git then use 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:

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

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

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

Ruby home page

The URL of the Ruby home page is:

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

Mailing list

There is a mailing list to talk about 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

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.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).

Bug reports should be filed 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