development fork of ruby/ruby
Перейти к файлу
David Rodríguez 18ac783ea6 [rubygems/rubygems] Revert adding loaded specs to `Gem::Specification.stubs` and `Gem::Specification.stubs_for`
The rationale is that:

* The change has caused realworld issues. See for example
https://github.com/ruby/did_you_mean/issues/117 and specifically [this
comment](https://github.com/ruby/did_you_mean/issues/117#issuecomment-482733159)
for a great explanation of the issue it caused for `did_you_mean`.

* The change also causes problems for our development workflows. For
example, because of it, our `bundler` specs cannot currently be run with
`bin/rake` and we have to use `bin/rspec` or `bin/parallel_spec`
directly. The explanation for this is:

  - Our specs install test dependencies to `tmp` before running specs.
  - `rake` is one of these test dependencies.
  - Before installing each test dependency, we check whether it has
  matching installed specs: 2bbcdcde08/bundler/spec/support/rubygems_ext.rb (L109-L114).

  - Normally, if `rake` has not yet been installed to `tmp`, this check
  fails and `rake` is installed, but since the loaded specs are now
  added to `Gem::Specification.stubs` and `rake`'s specification _is_
  loaded because we're running through `bin/rake`, the check incorrectly
  assumes that `rake` is already installed to `tmp` and skips
  installation.
  - At a later point the specs check whether `rake` is actually
  installed and fail if it's not: 2bbcdcde08/bundler/spec/support/builders.rb (L372-L383)

Essentially, both of the issues are the same. If at runtime we change
the location of gems, we'll _want_ to not consider loaded specifications
when dealing with the new gem location, because the loaded
specifications have not been loaded from there. Loaded specifications is
something different from installed stub specifications and those should
not be mixed.

The PR still seemed to have fixed an issue, so I did my archaeology job
and investigated the original issue to double check if reverting is ok.
The logs for the original error can be found here:
https://ci.appveyor.com/project/rubygems/rubygems/build/1172/job/ogubyucpljcv22ux.

So I installed ruby 2.4.4, checked out the commit reference before the
offending PR, and the exact error reproduced. 🎉

```
$ rake test
/home/deivid/Code/rubygems/lib/rubygems/resolver.rb:231:in `search_for': Unable to resolve dependency: user requested 'bundler (= 1.16.2)' (Gem::UnsatisfiableDependencyError)
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:283:in `block in sort_dependencies'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:277:in `each'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:277:in `sort_by'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:277:in `with_index'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:277:in `sort_dependencies'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/delegates/specification_provider.rb:52:in `block in sort_dependencies'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/delegates/specification_provider.rb:69:in `with_no_such_dependency_error_handling'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/delegates/specification_provider.rb:51:in `sort_dependencies'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/resolution.rb:165:in `initial_state'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/resolution.rb:106:in `start_resolution'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/resolution.rb:64:in `resolve'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver/molinillo/lib/molinillo/resolver.rb:42:in `resolve'
  from /home/deivid/Code/rubygems/lib/rubygems/resolver.rb:188:in `resolve'
  from /home/deivid/Code/rubygems/lib/rubygems/request_set.rb:396:in `resolve'
  from /home/deivid/Code/rubygems/lib/rubygems/request_set.rb:408:in `resolve_current'
  from /home/deivid/Code/rubygems/lib/rubygems.rb:243:in `finish_resolve'
  from /home/deivid/Code/rubygems/lib/rubygems/rdoc.rb:13:in `<top (required)>'
  from /home/deivid/Code/rubygems/lib/rubygems/core_ext/kernel_require.rb:54:in `require'
  from /home/deivid/Code/rubygems/lib/rubygems/core_ext/kernel_require.rb:54:in `require'
  from /home/deivid/Code/rubygems/lib/rubygems/test_case.rb:1563:in `<top (required)>'
  from /home/deivid/Code/rubygems/test/rubygems/test_bundled_ca.rb:2:in `require'
  from /home/deivid/Code/rubygems/test/rubygems/test_bundled_ca.rb:2:in `<top (required)>'
  from /home/deivid/.rbenv/versions/2.4.4/lib/ruby/gems/2.4.0/gems/rake-12.0.0/lib/rake/rake_test_loader.rb:15:in `require'
  from /home/deivid/.rbenv/versions/2.4.4/lib/ruby/gems/2.4.0/gems/rake-12.0.0/lib/rake/rake_test_loader.rb:15:in `block in <main>'
  from /home/deivid/.rbenv/versions/2.4.4/lib/ruby/gems/2.4.0/gems/rake-12.0.0/lib/rake/rake_test_loader.rb:4:in `select'
  from /home/deivid/.rbenv/versions/2.4.4/lib/ruby/gems/2.4.0/gems/rake-12.0.0/lib/rake/rake_test_loader.rb:4:in `<main>'
rake aborted!
Command failed with status (1)

Tasks: TOP => test
```

Now the explanation of the error:

* Rubygems base `TestCase` class requires `bundler` because some tests
use `bundler`:
2bbcdcde08/lib/rubygems/test_case.rb (L26)

* That `require` (our custom rubygems require) would activate the
default bundler spec (1.16.1 for ruby 2.4.4) but then overwrite it with
a 1.16.2 version (the locally provided bundler those days) due to [this
old
hack](9f7bf0ac3a/lib/bundler/version.rb (L7-L23)).

* Rubygems base `TestCase` class requires `rubygems/rdoc`:
2bbcdcde08/lib/rubygems/test_case.rb (L1536)

* And that file ends up calling `Gem.finish_resolve`:
2bbcdcde08/lib/rubygems/rdoc.rb (L13)

* `Gem.finish_resolve` adds the currently loaded specs to the
resolution:
2bbcdcde08/lib/rubygems.rb (L235)

* That means it would try to resolve bundler 1.16.2, but no
specification for that version was installed since the default was
1.16.1. That explains why upgrading to rubygems 2.7.7 fixed the issue,
since it provided bundler 1.16.2 by default so there was not bundler
version discrepancy.

After understanding the error, I conclude that:

* Only this part of the original patch was actually needed to resolve
the error, not any of the changes in `Gem::Specification.stubs` and
`Gem::Specification.stubs_for`:

```diff
diff --git a/lib/rubygems/test_case.rb b/lib/rubygems/test_case.rb
index f1cd3d274c..92c848e870 100644
--- a/lib/rubygems/test_case.rb
+++ b/lib/rubygems/test_case.rb
@@ -13,6 +13,15 @@ else
   require 'rubygems'
 end

+# If bundler gemspec exists, add to stubs
+bundler_gemspec = File.expand_path("../../../bundler/bundler.gemspec", __FILE__)
+if File.exist?(bundler_gemspec)
+  Gem::Specification.dirs.unshift File.dirname(bundler_gemspec)
+  Gem::Specification.class_variable_set :@@stubs, nil
+  Gem::Specification.stubs
+  Gem::Specification.dirs.shift
+end
+
 begin
   gem 'minitest'
 rescue Gem::LoadError
```

So, I propose to revert adding loaded specification to
`Gem::Specification.stubs` and `Gem::Specification.stubs_for` because I
think it's safe, it fixes the issues caused by their addition, and it
simplifies `Gem::Specification` code, which is already complicated
enough.

https://github.com/rubygems/rubygems/commit/5269cd617c
2020-05-08 14:13:29 +09:00
.github Fixed a typo [ci skip] 2020-04-24 23:24:19 +09:00
basictest Fixed misspellings 2019-12-20 09:32:42 +09:00
benchmark support builtin for Kernel#Float 2020-04-22 09:49:13 +09:00
bin Removed the old executables of racc 2020-01-01 07:42:42 +09:00
bootstraptest Moved already resolved test 2020-04-27 10:39:07 +09:00
ccan Fix typos [ci skip] 2019-10-14 17:30:04 +09:00
coroutine Patch assembly so that it aligns properly 2020-04-01 15:49:02 +13:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin Set `gnumake` in GNUmakefile for cygwin 2020-03-29 17:43:24 +09:00
defs Added tooldir variable 2020-04-05 09:26:57 +09:00
doc [DOC] Added GNU make specific targets [ci skip] 2020-04-24 18:32:47 +09:00
enc Suppress warnings by gcc 10.1.0-RC-20200430 2020-05-04 12:28:24 +09:00
ext Fix indentation 2020-05-04 13:27:25 +09:00
gems power_assert repository is transferred to ruby/power_assert 2020-04-18 12:34:33 +09:00
include Get rid of -Wgnu-zero-variadic-macro-arguments errors 2020-05-01 18:39:08 +09:00
internal Allow global variables to move 2020-05-07 11:42:39 -07:00
lib [rubygems/rubygems] Revert adding loaded specs to `Gem::Specification.stubs` and `Gem::Specification.stubs_for` 2020-05-08 14:13:29 +09:00
libexec Fixed typos in racc 2020-04-27 15:28:06 +09:00
man Merge bundler-2.1.4 2020-01-08 18:00:32 +09:00
misc Add T_IMEMO support to lldb 2020-05-07 15:54:00 -07:00
missing [DOC] explicit_bzero exists in modern Linux 2020-04-26 02:00:45 +09:00
sample Fixed misspellings 2019-12-20 09:32:42 +09:00
spec Update to ruby/spec@032ee74 2020-05-03 12:28:29 +02:00
template Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
test [rubygems/rubygems] Revert adding loaded specs to `Gem::Specification.stubs` and `Gem::Specification.stubs_for` 2020-05-08 14:13:29 +09:00
tool Workaround for Minitest5 2020-05-08 07:38:50 +09:00
win32 Support version ranges for MSVC [Feature #16763] 2020-04-11 17:12:24 +09:00
.dir-locals.el emacs mode addition 2020-02-06 11:46:51 +09:00
.document Moved `Dir.open` and `Dir#initialize` to dir.rb 2020-04-06 22:22:25 +09:00
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Redmine /projects/ruby-trunk is now redirected 2019-12-31 22:06:19 -08:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Revert "Moved aclocal.m4 to macro directory" 2020-04-05 11:53:07 +09:00
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Travis s390x-linux is too unstable 2020-05-03 13:58:54 -07:00
BSDL [ruby/irb] Reformat LICENSE.txt [ci skip] 2020-02-02 03:22:51 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb
LEGAL LEGAL: add legal situation of parse.h [ci skip] 2020-05-07 17:20:05 +09:00
NEWS.md NEWS.md: the order of backtrace [Feature #8661] [ci skip] 2020-04-21 19:29:16 +09:00
README.EXT
README.EXT.ja
README.ja.md README*.md: `defines.h` moved [ci skip] 2020-02-01 00:38:38 +09:00
README.md Fix bundled gems installation on a fresh clone 2020-03-14 18:16:47 +09:00
aclocal.m4 Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
addr2line.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
addr2line.h add #include guard hack 2020-04-13 16:06:00 +09:00
appveyor.yml Fix AppVeyor pull request CI (#2983) 2020-03-26 10:14:23 -07:00
array.c reroute redefinition of NDEBUG 2020-04-21 13:07:19 +09:00
array.rb Removed useless shebang and executable bit [ci skip] 2020-02-01 23:25:46 +09:00
ast.c Separate builtin initialization calls 2019-12-29 12:34:55 +09:00
ast.rb Fix variable name and add more example [ci skip] 2020-01-03 01:27:25 +09:00
bignum.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
builtin.c take care of USE_LAZY_LOAD=1. 2019-12-25 14:12:33 +09:00
builtin.h Get rid of redefinition of `rb_execution_context_t` 2020-03-19 13:25:53 +09:00
class.c Make rb_scan_args implementations same 2020-04-12 23:29:22 +09:00
common.mk internal/process.h: add a no-warning simple wrapper for fork(2) 2020-05-02 21:34:10 +09:00
compar.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
compile.c Fix pseudo code for NODE_ARYPTN, NODE_HSHPTN 2020-05-04 13:27:25 +09:00
complex.c Optimize sin/cos 2020-05-03 15:29:51 +09:00
configure.ac Optimize sin/cos 2020-05-03 15:29:51 +09:00
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
debug.c More enums are mandatory for rp in lldb_cruby.py 2020-04-25 17:52:27 +09:00
debug_counter.c Avoid doubly showing debug counters 2020-03-15 02:25:47 -07:00
debug_counter.h Make vm_call_cfunc_with_frame a fastpath (#3027) 2020-04-13 20:32:59 -07:00
dir.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
dir.rb Moved `Dir.[]` to dir.rb 2020-04-06 22:22:25 +09:00
dln.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
dln.h add #include guard hack 2020-04-13 16:06:00 +09:00
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h add #include guard hack 2020-04-13 16:06:00 +09:00
encoding.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
enum.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
enumerator.c Improve documentation for Enumerator#next, next_values, peek and peek_values. 2020-05-05 17:04:11 -04:00
error.c Added rb_syserr_new_path 2020-04-15 21:00:53 +09:00
eval.c Raise EPIPE at broken pipe for the backward compatibility 2020-04-15 21:05:39 +09:00
eval_error.c eval_error.c: default nil as "reverse" is now false [Feature #8661] 2020-04-21 19:29:16 +09:00
eval_intern.h Create backtrace location array directly 2019-12-13 20:47:07 +09:00
eval_jump.c drop-in type check for rb_define_global_function 2019-08-29 18:34:09 +09:00
file.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
gc.c Allow global variables to move 2020-05-07 11:42:39 -07:00
gc.h Rename RUBY_MARK_NO_PIN_UNLESS_NULL to RUBY_MARK_MOVABLE_UNLESS_NULL 2020-01-23 00:11:03 +13:00
gc.rb Fix call-seq of GC.verify_compaction_references [ci skip] 2020-01-27 18:58:39 +09:00
gem_prelude.rb Do not call 'gem "did_you_mean"' for now 2019-11-30 21:08:19 -05:00
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c
hash.c RDoc enhancements for Hash[]. 2020-04-23 20:46:20 +12:00
hrtime.h
id_table.c reroute redefinition of NDEBUG 2020-04-21 13:07:19 +09:00
id_table.h Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
inits.c Moved `Dir.open` and `Dir#initialize` to dir.rb 2020-04-06 22:22:25 +09:00
insns.def Turn class variable warnings into exceptions 2020-04-10 00:29:05 -07:00
internal.h add #include guard hack 2020-04-13 16:06:00 +09:00
io.c Refactored rb_readwrite_syserr_fail 2020-04-17 14:08:54 +09:00
io.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
iseq.c Create succ_index_table as a part of `iseq_setup` 2020-04-15 16:06:48 +09:00
iseq.h add #include guard hack 2020-04-13 16:06:00 +09:00
kernel.rb support builtin for Kernel#Float 2020-04-22 09:49:13 +09:00
lex.c.blt
load.c Remove deprecated rb_require_safe 2020-04-30 10:32:27 -07:00
loadpath.c
localeinit.c
main.c main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
math.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
method.h add #include guard hack 2020-04-13 16:06:00 +09:00
mini_builtin.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c Deduplicate functions in compacted JIT code 2020-05-01 01:38:16 -07:00
mjit.h Include unit id in a function name of an inlined method 2020-04-30 23:08:13 -07:00
mjit_compile.c Remove OPT_CHECKED_RUN code 2020-05-06 20:24:19 -07:00
mjit_worker.c Revert 0776198486 for Solaris debug 2020-05-03 17:39:57 -07:00
node.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
node.h Fix indentation 2020-05-04 13:27:25 +09:00
numeric.c numeric.c: Remove unreachable code 2020-04-09 09:14:02 +09:00
object.c Share logically equivalent functions 2020-05-07 02:50:10 +09:00
pack.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
pack.rb Rubified the APIs of pack.c 2019-11-08 23:51:51 +09:00
parse.y Bison 3.5.91 now defaults parse.error to "simple" 2020-05-04 18:10:02 +09:00
prelude.rb Define IO#read/write_nonblock with builtins. 2019-11-08 10:03:19 +09:00
probes.d
probes_helper.h internal/vm.h rework 2019-12-26 20:45:12 +09:00
proc.c [DOC] Separated Method#[] from Method#call [Bug #16813] [ci skip] 2020-04-24 11:18:27 +09:00
process.c internal/process.h: add a no-warning simple wrapper for fork(2) 2020-05-02 21:34:10 +09:00
random.c Fixed constant initializer 2020-05-04 00:27:14 +09:00
range.c Suppress -Wswitch warnings 2020-04-08 15:13:37 +09:00
rational.c reroute redefinition of NDEBUG 2020-04-21 13:07:19 +09:00
re.c Add {Regexp,String}#match with block to call-seq [ci skip] 2020-04-14 12:39:16 +09:00
regcomp.c
regenc.c
regenc.h
regerror.c Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h
regparse.c Fixed misspellings 2019-12-20 09:32:42 +09:00
regparse.h
regsyntax.c
ruby-runner.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
ruby.c internal/process.h: add a no-warning simple wrapper for fork(2) 2020-05-02 21:34:10 +09:00
ruby_assert.h add #include guard hack 2020-04-13 16:06:00 +09:00
ruby_atomic.h Solaris does not provide atomic_sub family 2020-04-26 22:39:36 +09:00
rubystub.c
signal.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
siphash.c
siphash.h
sparc.c
sprintf.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
st.c Adjusted indents [ci skip] 2020-03-16 11:06:41 +09:00
strftime.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
string.c remove unused rb_str_clear define (#3059) 2020-04-25 20:39:44 -07:00
struct.c hash.c: Do not use the fast path (rb_yield_values) for lambda blocks 2020-03-16 23:17:12 +09:00
symbol.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
symbol.h add #include guard hack 2020-04-13 16:06:00 +09:00
thread.c should check pending interrupts correctly. 2020-04-09 12:51:51 +09:00
thread_pthread.c Get rid of -Wgnu-folding-constant errors 2020-05-01 19:28:23 +09:00
thread_pthread.h add #include guard hack 2020-04-13 16:06:00 +09:00
thread_sync.c more on NULL versus functions. 2020-02-07 14:24:19 +09:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h add #include guard hack 2020-04-13 16:06:00 +09:00
time.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
timev.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
trace_point.rb Fix output of example [ci skip] 2020-01-05 00:52:43 +09:00
transcode.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
transcode_data.h add #include guard hack 2020-04-13 16:06:00 +09:00
transient_heap.c decouple internal.h headers 2019-12-26 20:45:12 +09:00
transient_heap.h add #include guard hack 2020-04-13 16:06:00 +09:00
util.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
variable.c Allow global variables to move 2020-05-07 11:42:39 -07:00
variable.h add #include guard hack 2020-04-13 16:06:00 +09:00
version.c Provides ruby2_keywords 2019-10-23 00:19:25 +09:00
version.h * 2020-05-08 [ci skip] 2020-05-08 00:13:53 +09:00
vm.c Merge pull request #2991 from shyouhei/ruby.h 2020-04-08 13:28:13 +09:00
vm_args.c Reduce allocations for keyword argument hashes 2020-03-17 12:09:43 -07:00
vm_backtrace.c Add compaction support for backtrace objects 2020-05-07 11:42:39 -07:00
vm_callinfo.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_core.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_debug.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_dump.c vm_dump.c: Do not show C backtrace on riscv 2020-04-20 23:59:05 +09:00
vm_eval.c Introduce disposable call-cache. 2020-02-22 09:58:59 +09:00
vm_exec.c Add VM insns counter like debug_counter (#2789) 2019-12-28 00:44:09 -08:00
vm_exec.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_insnhelper.c Disable -Wswitch warning when VM_CHECK_MODE 2020-05-03 00:15:56 +09:00
vm_insnhelper.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_method.c Just call search_method_protect [Bug #16669] 2020-04-23 10:24:49 +09:00
vm_opts.h add #include guard hack 2020-04-13 16:06:00 +09:00
vm_trace.c Clear all trace events during teardown 2020-03-29 23:41:19 -04:00
vsnprintf.c [win32] suppress false warning by mingw gcc 2020-03-04 23:13:18 +09:00
warning.rb Fix a typo [ci skip] 2020-01-02 12:12:05 +09:00

README.md

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