37a2c660aa
Also add keyword argument separation warnings for Class#new and Method#call. To allow for keyword argument to required positional hash converstion in cfuncs, add a vm frame flag indicating the cfunc was called with an empty keyword hash (which was removed before calling the cfunc). The cfunc can check this frame flag and add back an empty hash if it is passing its arguments to another Ruby method. Add rb_empty_keyword_given_p function for checking if called with an empty keyword hash, and rb_add_empty_keyword for adding back an empty hash to argv. All of this empty keyword argument support is only for 2.7. It will be removed in 3.0 as Ruby 3 will not convert empty keyword arguments to required positional hash arguments. Comment all of the relevent code to make it obvious this is expected to be removed. Add rb_funcallv_kw as an public C-API function, just like rb_funcallv but with a keyword flag. This is used by rb_obj_call_init (internals of Class#new). This also required expected call_type enum with CALL_FCALL_KW, similar to the recent addition of CALL_PUBLIC_KW. Add rb_vm_call_kw as a internal function, used by call_method_data (internals of Method#call and UnboundMethod#bind_call). Add tests for UnboundMethod#bind_call keyword handling. |
||
---|---|---|
.github/workflows | ||
basictest | ||
benchmark | ||
bin | ||
bootstraptest | ||
ccan | ||
coroutine | ||
coverage | ||
cygwin | ||
defs | ||
doc | ||
enc | ||
ext | ||
gems | ||
include | ||
lib | ||
libexec | ||
man | ||
misc | ||
missing | ||
sample | ||
spec | ||
template | ||
test | ||
tool | ||
win32 | ||
.dir-locals.el | ||
.document | ||
.editorconfig | ||
.gdbinit | ||
.gitattributes | ||
.gitignore | ||
.indent.pro | ||
.rspec_parallel | ||
.travis.yml | ||
BSDL | ||
CONTRIBUTING.md | ||
COPYING | ||
COPYING.ja | ||
GPL | ||
KNOWNBUGS.rb | ||
LEGAL | ||
NEWS | ||
README.EXT | ||
README.EXT.ja | ||
README.ja.md | ||
README.md | ||
aclocal.m4 | ||
addr2line.c | ||
addr2line.h | ||
appveyor.yml | ||
array.c | ||
ast.c | ||
bignum.c | ||
class.c | ||
common.mk | ||
compar.c | ||
compile.c | ||
complex.c | ||
configure.ac | ||
constant.h | ||
cont.c | ||
debug.c | ||
debug_counter.c | ||
debug_counter.h | ||
dir.c | ||
dln.c | ||
dln.h | ||
dln_find.c | ||
dmydln.c | ||
dmyenc.c | ||
dmyext.c | ||
encindex.h | ||
encoding.c | ||
enum.c | ||
enumerator.c | ||
error.c | ||
eval.c | ||
eval_error.c | ||
eval_intern.h | ||
eval_jump.c | ||
file.c | ||
gc.c | ||
gc.h | ||
gem_prelude.rb | ||
golf_prelude.rb | ||
goruby.c | ||
hash.c | ||
hrtime.h | ||
id_table.c | ||
id_table.h | ||
inits.c | ||
insns.def | ||
internal.h | ||
io.c | ||
iseq.c | ||
iseq.h | ||
lex.c.blt | ||
load.c | ||
loadpath.c | ||
localeinit.c | ||
main.c | ||
marshal.c | ||
math.c | ||
method.h | ||
miniinit.c | ||
mjit.c | ||
mjit.h | ||
mjit_compile.c | ||
mjit_worker.c | ||
node.c | ||
node.h | ||
numeric.c | ||
object.c | ||
pack.c | ||
parse.y | ||
prelude.rb | ||
probes.d | ||
probes_helper.h | ||
proc.c | ||
process.c | ||
random.c | ||
range.c | ||
rational.c | ||
re.c | ||
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 | ||
safe.c | ||
signal.c | ||
siphash.c | ||
siphash.h | ||
sparc.c | ||
sprintf.c | ||
st.c | ||
strftime.c | ||
string.c | ||
struct.c | ||
symbol.c | ||
symbol.h | ||
thread.c | ||
thread_pthread.c | ||
thread_pthread.h | ||
thread_sync.c | ||
thread_win32.c | ||
thread_win32.h | ||
time.c | ||
timev.h | ||
transcode.c | ||
transcode_data.h | ||
transient_heap.c | ||
transient_heap.h | ||
util.c | ||
variable.c | ||
version.c | ||
version.h | ||
vm.c | ||
vm_args.c | ||
vm_backtrace.c | ||
vm_core.h | ||
vm_debug.h | ||
vm_dump.c | ||
vm_eval.c | ||
vm_exec.c | ||
vm_exec.h | ||
vm_insnhelper.c | ||
vm_insnhelper.h | ||
vm_method.c | ||
vm_opts.h | ||
vm_trace.c | ||
vsnprintf.c | ||
wercker.yml |
README.md
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
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
-
If you want to use Microsoft Visual C++ to compile Ruby, read win32/README.win32 instead of this document.
-
If
./configure
does not exist or is older thanconfigure.ac
, runautoconf
to (re)generate configure. -
Run
./configure
, which will generateconfig.h
andMakefile
.Some C compiler flags may be added by default depending on your environment. Specify
optflags=..
andwarnflags=..
as necessary to override them. -
Edit
defines.h
if you need. Usually this step will not be needed. -
Remove comment mark(
#
) before the module names fromext/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
" inext/Setup
.Usually this step will not be needed.
-
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).
- On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign
-
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). -
Optionally, run
make update-gems
andmake extract-gems
.If you want to install bundled gems, run
make update-gems
andmake extract-gems
before runningmake install
. -
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.