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
nobu 986fb55961 Forwardable: Fix delegating to 'args' and 'block'
* lib/forwardable.rb (def_instance_delegator) fix delegating to
  'args' and 'block', clashing with local variables in generated
  methods.  [ruby-core:72579] [Bug #11916]

* lib/forwardable.rb (def_single_delegator): ditto.

If you have a class that uses Forwardable to delegate a method to
another object, and the method that returns the delegate object is
called `args` or `block`, then Forwardable will fail to work.

Here's a simple example:

    class ModelCreator
      extend Forwardable

      attr_reader :args

      def_delegator :args, :model_name

      def initialize(args)
        @args = args
      end
    end

    ModelCreator.new.model_name

If you run the last line above, then you'll get:

    NoMethodError: undefined method `model_name' for []:Array

This error occurs because `def_delegator` -- as it is written in Ruby --
uses metaprogramming to add methods to the class that will then delegate
to the delegate object. So it's as if we had written:

    class ModelCreator
      extend Forwardable

      attr_reader :args

      def model_name(*args, &block)
        args.model_name(*args, &block)
      end

      def initialize(args)
        @args = args
      end
    end

As you can see, `def_delegator` will not only forward the method call
onto the delegate object, it will also forward any arguments provided as
well. It is here that the bug arises: it splats all of the arguments
into a variable which is called `args`, and because of how variable
scope works in Ruby, it then attempts to call `model_name` on *this*
variable and *not* our delegate object method.

The fix is to call the delegate object method manually using `__send__`.
(This assumes, of course, that the given receiver is, in fact, the name
of a method and not the name of an instance variable, which is also a
possibility.) We use `__send__` because the delegate object method could
be private.

So, that looks like this:

    def model_name(*args, &block)
      __send__(:args).model_name(*args, &block)
    end

Because `def_delegators` and `delegate` use `def_delegator` internally,
they also get this fix as well.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53381 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-12-30 02:18:44 +00:00
benchmark * benchmark/bm_app_aobench.rb: fix typos. 2015-12-14 02:50:01 +00:00
bin
bootstraptest * bootstraptest/runner.rb: use safe navigation operator. 2015-12-14 08:04:28 +00:00
ccan
coverage
cygwin
defs
doc * doc/NEWS-2.3.0: fix a typo. 2015-12-27 10:55:59 +00:00
enc * enc/x_emoji.h: fix dead-link. 2015-12-27 11:00:36 +00:00
ext ⚠️ key "accelerator" is duplicated and overwritten in Tk samples 2015-12-28 15:10:25 +00:00
gems * gems/bundled_gems: Upgrade the did_you_mean gem to 1.0.0 2015-12-22 17:30:22 +00:00
include version.h (RUBY_VERSION): 2.4.0 development has started. 2015-12-25 12:40:38 +00:00
lib Forwardable: Fix delegating to 'args' and 'block' 2015-12-30 02:18:44 +00:00
man fix common misspelling [ci skip] 2015-12-24 23:23:46 +00:00
misc
missing
nacl
sample * properties. 2015-12-11 14:38:42 +00:00
spec
template * lib/erb.rb: revert r53123. It break compatibility like thor and rspec-rails. 2015-12-20 06:36:57 +00:00
test object.c: fix prepend cmp 2015-12-30 00:58:58 +00:00
tool Revert "* tool/post-commit.sh: copied from svn server." 2015-12-26 10:01:35 +00:00
win32 program version from API version 2015-12-25 16:24:43 +00:00
.document
.editorconfig
.gdbinit
.gitattributes
.gitignore * .gitignore: ignored ISeq binary format. 2015-12-09 00:46:26 +00:00
.indent.pro
.travis.yml Add ruby_2_3 branch to .travis.yml [ci skip] 2015-12-24 18:37:43 +00:00
aclocal.m4
addr2line.c
addr2line.h
array.c
bignum.c make local symbols static 2015-12-08 15:07:41 +00:00
BSDL
ChangeLog Forwardable: Fix delegating to 'args' and 'block' 2015-12-30 02:18:44 +00:00
class.c use id_table for constant tables 2015-12-29 20:19:14 +00:00
common.mk program version from API version 2015-12-25 16:24:43 +00:00
compar.c * compar.c: Update doc for == [#7688] [ci-skip] 2015-12-15 20:19:35 +00:00
compile.c compile.c: adjust label reference 2015-12-29 08:36:22 +00:00
complex.c
configure.in program version from API version 2015-12-25 16:24:43 +00:00
constant.h use id_table for constant tables 2015-12-29 20:19:14 +00:00
cont.c fix common misspelling [ci skip] 2015-12-24 23:23:46 +00:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
dir.c * compile.c: fix typos. 2015-12-14 02:51:13 +00:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c * introduce new ISeq binary format serializer/de-serializer 2015-12-08 13:58:50 +00:00
enum.c * enum.c: fix a typo in documentation. 2015-12-14 02:52:14 +00:00
enumerator.c enumerator.c: use ALLOCV 2015-12-15 15:32:28 +00:00
error.c revert deprecated functions 2015-12-24 15:09:16 +00:00
eval.c eval.c: warn block for using 2015-12-29 08:54:18 +00:00
eval_error.c
eval_intern.h
eval_jump.c
file.c prefer rb_syserr_fail 2015-12-23 08:57:48 +00:00
gc.c use id_table for constant tables 2015-12-29 20:19:14 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * gc.c: Delete excess semicolon after RUBY_ALIAS_FUNCTION(). 2015-12-15 14:20:27 +00:00
ia64.s
id_table.c
id_table.h
inits.c
insns.def insns.def (opt_case_dispatch): avoid converting Infinity 2015-12-11 09:15:14 +00:00
internal.h use id_table for constant tables 2015-12-29 20:19:14 +00:00
io.c IO#readpartial rejects bad args 2015-12-27 06:15:06 +00:00
iseq.c iseq.c: suppress warnings 2015-12-28 06:42:18 +00:00
iseq.h * introduce new ISeq binary format serializer/de-serializer 2015-12-08 13:58:50 +00:00
KNOWNBUGS.rb KNOWNBUGS.rb: Fixed typo, made more explicit [ci skip] 2015-12-13 01:45:00 +00:00
LEGAL
lex.c.blt
load.c * introduce new ISeq binary format serializer/de-serializer 2015-12-08 13:58:50 +00:00
loadpath.c
localeinit.c
main.c
Makefile.in program version from API version 2015-12-25 16:24:43 +00:00
marshal.c marshal.c: remove NULL checks for *_memsize 2015-12-09 21:34:01 +00:00
math.c
method.h
miniinit.c miniinit.c: built-in encoding aliases 2015-12-26 02:26:40 +00:00
NEWS * ChangeLog, NEWS: added. 2015-12-24 17:25:26 +00:00
node.c
node.h * compile.c: fix typos. 2015-12-14 02:51:13 +00:00
numeric.c * enum.c: fix a typo in documentation. 2015-12-14 02:52:14 +00:00
object.c object.c: fix prepend cmp 2015-12-30 00:58:58 +00:00
pack.c pack.c: check index range 2015-12-13 09:33:40 +00:00
parse.y parse.y: show_bitstack 2015-12-27 02:03:36 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c * proc.c (rb_mod_define_method): should check Symbol or not. 2015-12-20 02:14:57 +00:00
process.c * process.c (rb_execarg_parent_start1): need to convert the encoding to 2015-12-27 12:15:20 +00:00
random.c * *.c (*_memsize): do not check ptr. 2015-12-09 00:38:32 +00:00
range.c
rational.c
re.c re.c: names encoding 2015-12-17 00:46:07 +00:00
README.EXT
README.EXT.ja
README.ja.md
README.md
regcomp.c Revert r52995 2015-12-09 07:30:44 +00:00
regenc.c
regenc.h
regerror.c
regexec.c regexec.c: fix build with direct threaded VM 2015-12-22 17:34:38 +00:00
regint.h Revert r52995 2015-12-09 07:30:44 +00:00
regparse.c Revert r52995 2015-12-09 07:30:44 +00:00
regparse.h regparse.h: ANSI alias rule fix 2015-12-09 08:02:06 +00:00
regsyntax.c
ruby.c ruby.c: overriding warning options 2015-12-29 12:23:04 +00:00
ruby_atomic.h Revert r52995 2015-12-09 07:30:44 +00:00
safe.c
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c Fix rdoc for String#rstrip!, lstrip! [ci skip] 2015-12-27 09:08:17 +00:00
struct.c
symbol.c
symbol.h
thread.c * *.c (*_memsize): do not check ptr. 2015-12-09 00:38:32 +00:00
thread_pthread.c * thread_pthread.c (rb_thread_create_timer_thread): destroy attr even 2015-12-29 19:26:52 +00:00
thread_pthread.h
thread_sync.c thread_sync.c: static classes 2015-12-28 21:52:15 +00:00
thread_win32.c
thread_win32.h
time.c
timev.h
transcode.c transcode.c: infection 2015-12-17 04:35:26 +00:00
transcode_data.h
util.c prefer rb_syserr_fail 2015-12-23 08:57:48 +00:00
variable.c use id_table for constant tables 2015-12-29 20:19:14 +00:00
version.c
version.h * 2015-12-30 2015-12-29 18:20:33 +00:00
vm.c * vm.c (vm_exec): call RUBY_DTRACE_CMETHOD_RETURN_HOOK instead of 2015-12-18 02:09:38 +00:00
vm_args.c * vm_args.c (vm_caller_setup_arg_block): remove code for ifunc 2015-12-17 13:15:20 +00:00
vm_backtrace.c vm_backtrace.c: ignore ifunc frames 2015-12-21 01:18:48 +00:00
vm_core.h * vm_core.h: define USE_LAZY_LOAD if it is not defined. 2015-12-18 07:13:16 +00:00
vm_debug.h
vm_dump.c
vm_eval.c vm_eval.c: hook after method_missing 2015-12-12 09:51:30 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c * vm_insnhelper.c: move vm_callee_setup_block_arg() (and related 2015-12-22 11:20:12 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (rb_method_entry_make, check_override_opt_method): 2015-12-18 02:32:17 +00:00
vm_opts.h
vm_trace.c * enum.c: fix a typo in documentation. 2015-12-14 02:52:14 +00:00
vsnprintf.c * compile.c: fix typos. 2015-12-14 02:51:13 +00:00

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, Mac OS X, BeOS, etc.) cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms

How to get Ruby

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

http://www.ruby-lang.org/en/downloads/

The Ruby distribution files can be found on the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

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

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

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

$ git clone git://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

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

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

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

Ruby home page

The URL of the Ruby home page is:

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

Mailing list

There is a mailing list to talk about Ruby. To subscribe this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address mailto: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.in, 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.

  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 following directories and install files onto 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 (http://www.ruby-lang.org/en/community/mailing-lists) or on websites like (http://stackoverflow.com).

Bug reports should be filed at http://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.

mailto:matz@ruby-lang.org