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
Jeremy Evans cc5b7ed1dc Document limitation of Pathname#relative_path_from [ci skip]
This method is explicitly documented to not access the filesystem,
and the only way to get the correct behavior for a case where the
filesystem's case sensitivity differs from the operating system
default would be to access the filesystem.

Fixes [Bug #15417]
2020-09-02 10:34:33 -07:00
.github add RUBY_DEBUG=ci envval for GH actions 2020-09-01 06:14:35 +09:00
basictest
benchmark
bin Promote erb to default gems 2020-08-21 20:18:44 +09:00
bootstraptest
ccan
coroutine
coverage
cygwin
defs
doc Add alias treatment to method_documentation.rdoc (#3468) 2020-08-28 13:39:16 -05:00
enc sed -i '/rmodule.h/d' 2020-08-27 16:42:06 +09:00
ext Document limitation of Pathname#relative_path_from [ci skip] 2020-09-02 10:34:33 -07:00
gems bump version to minitest-5.14.2 2020-09-01 11:21:41 +09:00
include Version number bumped to 3.0.0 from 2.8.0 (tentative). 2020-08-31 16:38:13 +09:00
internal include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
lib Get rid of using Socket.gethostbyname 2020-08-31 17:45:27 +09:00
libexec Fix erb executable 2020-08-25 18:11:43 +09:00
man
misc add T_ZOMBIE support to lldb scripts 2020-08-27 09:00:19 -07:00
missing
sample Use own mutex instead of Thread.exclusive 2020-08-27 14:37:03 +09:00
spec Fix constant names set using const_set on a singleton class 2020-09-02 00:05:14 -04:00
template DEPRECATED_TYPE: is deprecated 2020-08-27 15:02:52 +09:00
test Fix constant names set using const_set on a singleton class 2020-09-02 00:05:14 -04:00
tool Remove the pc argument of vm_trace() 2020-09-01 22:02:29 -04:00
util
win32 DEPRECATED_TYPE: is deprecated 2020-08-27 15:02:52 +09:00
.dir-locals.el
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore
.rspec_parallel
.travis.yml .travis.yml: prefer gcc 2020-08-22 11:12:24 +09:00
aclocal.m4
addr2line.c
addr2line.h
appveyor.yml
array.c Comply with guide for method doc: array.c (#3499) 2020-09-01 12:49:48 -05:00
array.rb
ast.c
ast.rb
bignum.c
BSDL
builtin.c
builtin.h
class.c include/ruby/backward/2/rmodule.h: deprecate 2020-08-27 16:42:06 +09:00
common.mk Revert the workaround of minitest and hoe 2020-09-01 11:21:41 +09:00
compar.c
compile.c
complex.c
configure.ac Fix pthread_setname_np arguments on NetBSD 2020-09-01 07:16:31 -07:00
constant.h
cont.c
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
debug_counter.c
debug_counter.h
dir.c
dir.rb
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c
enumerator.c
error.c Support passing a category to Warning.warn 2020-09-01 16:16:06 -07:00
eval.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
eval_error.c
eval_intern.h
eval_jump.c
file.c
gc.c Fix error message for wb unprotected objects count 2020-09-01 22:03:13 -04:00
gc.h
gc.rb
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c Comply with guide for method doc: hash.c (#3466) 2020-08-27 14:54:36 -05:00
hrtime.h
id_table.c
id_table.h
inits.c
insns.def
integer.rb
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c IO.copy_stream: handle EOPNOTSUP instead of ENOTSUP 2020-08-29 16:10:58 +09:00
io.rb
iseq.c
iseq.h
kernel.rb
KNOWNBUGS.rb KNOWNBUGS.rb: use-after-poison since b9007b6c54 2020-08-30 16:07:12 +09:00
LEGAL Added did_you_mean entry because did_you_mean uses MIT license 2020-08-19 19:36:16 +09:00
lex.c.blt
load.c
loadpath.c
localeinit.c
main.c
marshal.c
math.c
method.h Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
mini_builtin.c
miniinit.c
mjit.c
mjit.h
mjit_compile.c
mjit_worker.c
NEWS.md Support passing a category to Warning.warn 2020-09-01 16:16:06 -07:00
node.c
node.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
numeric.c
object.c ROBJECT_IV_INDEX_TBL: convert into an inline function 2020-08-19 14:30:57 +09:00
pack.c
pack.rb
parse.y new_dstr: hoisted out from literal_concat and evstr2dstr 2020-09-02 13:30:16 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d
probes_helper.h
proc.c Fix Method#super_method for aliased methods 2020-08-27 08:37:03 -07:00
process.c Fix type of getlogin_r's 2nd argument 2020-08-22 09:39:24 +09:00
random.c
range.c Removed trailing spaces [ci skip] 2020-09-02 13:30:16 +09:00
rational.c
re.c Try to fix compile error on windows 2020-08-28 22:03:06 +09:00
README.EXT
README.EXT.ja
README.ja.md
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_assert.h
ruby_atomic.h
rubystub.c
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c Partial compliance with doc/method_documentation.rdoc in string.c (#3436) 2020-08-20 12:09:49 -05:00
struct.c RHASH_TBL: is now ext-only 2020-08-19 15:10:53 +09:00
symbol.c
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c
thread_pthread.c
thread_pthread.h
thread_sync.c
thread_win32.c
thread_win32.h
time.c
timev.h
trace_point.rb
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h
util.c
variable.c Fix constant names set using const_set on a singleton class 2020-09-02 00:05:14 -04:00
variable.h
version.c
version.h * 2020-09-02 [ci skip] 2020-09-02 01:46:35 +09:00
vm.c
vm_args.c
vm_backtrace.c Improve performance of partial backtraces 2020-08-27 15:17:36 -07:00
vm_callinfo.h
vm_core.h Avoid a use after free in VM assertion 2020-08-21 14:52:30 -07:00
vm_debug.h
vm_dump.c
vm_eval.c Deprecate iterator? method 2020-08-31 22:14:14 +09:00
vm_exec.c
vm_exec.h
vm_insnhelper.c Remove the pc argument of vm_trace() 2020-09-01 22:02:29 -04:00
vm_insnhelper.h
vm_method.c Remove write barrier exemption for T_ICLASS 2020-08-17 17:17:47 -04:00
vm_opts.h
vm_trace.c
vsnprintf.c
warning.rb

Build Status Build status Actions Status Actions Status Actions Status Actions Status Actions 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 include/ruby/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. 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