forwardable 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c08b5a019cfdbf0cfcf51bfb66d6500065d8f6492fc50a8e481d1e427a6d2df8
-  data.tar.gz: 9a25242aae4c2214ffffc7027eb680a9e09f0fda47f1bcf35cd15cea06c35ac9
+  metadata.gz: 8b280e81b85cc1b7991cae97589999483f7e7e8fcf0296f4c40328504a9da9a3
+  data.tar.gz: b96bcbf1ee2f712336e260ce5ad71f6d54c65e6133278feb10c93e8cb4b0a373
 SHA512:
-  metadata.gz: a23ba5a69ad8fe490e81bb01815fda286e97259c7010e48c3491c9e2537a1a7cbf78da7805f07c6ac302cab8458152c9343e0f19d3669269afc33c94a11d7b42
-  data.tar.gz: 1e809b3fd7e1ff732cbd9abb384e1ad914d1bf53b4ce23973989741414cfe3015ce7cb744222dd4694b58ee1b17ec0e722406770b908ea6cafc1c19387111c3e
+  metadata.gz: 5d6487cca72bb5f315d638733a34f4ff553c53cb1caa84938ca639d746b9defe76bdc37381afce3dacb43331a6cd69f7cb6fa489170167c1b4777f8c9d90443a
+  data.tar.gz: f65f9418fd7c1c9c3b27adb398768f41bd5c04479b8306f2ec454a4c9c98e10eaf933d92db64b279e4c433e19fea4d5b7ae4a5da6f2ac9a342e50c175bebdb9f

data/forwardable.gemspec

@@ -1,8 +1,8 @@
 begin
-  require_relative "lib/forwardable"
+  require_relative "lib/forwardable/version"
 rescue LoadError
   # for Ruby core repository
-  require_relative "../forwardable"
+  require_relative "version"
 end
 
 Gem::Specification.new do |spec|
@@ -16,11 +16,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/forwardable"
   spec.license       = "BSD-2-Clause"
 
-  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "forwardable.gemspec", "lib/forwardable.rb", "lib/forwardable/impl.rb"]
+  spec.files         = ["forwardable.gemspec", "lib/forwardable.rb", "lib/forwardable/impl.rb", "lib/forwardable/version.rb"]
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
 end

data/lib/forwardable.rb

@@ -57,10 +57,9 @@
 #
 # == Another example
 #
-# We want to rely on what has come before obviously, but with delegation we can
-# take just the methods we need and even rename them as appropriate.  In many
-# cases this is preferable to inheritance, which gives us the entire old
-# interface, even if much of it isn't needed.
+# You could use Forwardable as an alternative to inheritance, when you don't want
+# to inherit all methods from the superclass. For instance, here is how you might
+# add a range of +Array+ instance methods to a new class +Queue+:
 #
 #   class Queue
 #     extend Forwardable
@@ -111,10 +110,7 @@
 #
 module Forwardable
   require 'forwardable/impl'
-
-  # Version of +forwardable.rb+
-  VERSION = "1.2.0"
-  FORWARDABLE_VERSION = VERSION
+  require "forwardable/version"
 
   @debug = nil
   class << self
@@ -123,7 +119,8 @@ module Forwardable
   end
 
   # Takes a hash as its argument.  The key is a symbol or an array of
-  # symbols.  These symbols correspond to method names.  The value is
+  # symbols.  These symbols correspond to method names, instance variable
+  # names, or constant names (see def_delegator).  The value is
   # the accessor to which the methods will be delegated.
   #
   # :call-seq:
@@ -152,18 +149,20 @@ module Forwardable
   #   def_delegator :@records, :map
   #
   def def_instance_delegators(accessor, *methods)
-    methods.delete("__send__")
-    methods.delete("__id__")
-    for method in methods
+    methods.each do |method|
+      next if /\A__(?:send|id)__\z/ =~ method
       def_instance_delegator(accessor, method)
     end
   end
 
   # Define +method+ as delegator instance method with an optional
   # alias name +ali+. Method calls to +ali+ will be delegated to
-  # +accessor.method+.
+  # +accessor.method+.  +accessor+ should be a method name, instance
+  # variable name, or constant name.  Use the full path to the
+  # constant if providing the constant name.
   #
   #   class MyQueue
+  #     CONST = 1
   #     extend Forwardable
   #     attr_reader :queue
   #     def initialize
@@ -171,18 +170,22 @@ module Forwardable
   #     end
   #
   #     def_delegator :@queue, :push, :mypush
+  #     def_delegator 'MyQueue::CONST', :to_i
   #   end
   #
   #   q = MyQueue.new
   #   q.mypush 42
   #   q.queue    #=> [42]
   #   q.push 23  #=> NoMethodError
+  #   q.to_i     #=> 1
   #
   def def_instance_delegator(accessor, method, ali = method)
     gen = Forwardable._delegator_method(self, accessor, method, ali)
 
     # If it's not a class or module, it's an instance
-    (Module === self ? self : singleton_class).module_eval(&gen)
+    mod = Module === self ? self : singleton_class
+    mod.module_eval(&gen)
+    mod.send(:ruby2_keywords, ali) if RUBY_VERSION >= '2.7'
   end
 
   alias delegate instance_delegate
@@ -222,7 +225,7 @@ module Forwardable
           #{pre}
           begin
             #{accessor}
-          end#{method_call}#{FILTER_EXCEPTION}
+          end#{method_call}
         end
       end
     end;
@@ -284,9 +287,8 @@ module SingleForwardable
   #   def_delegator :@records, :map
   #
   def def_single_delegators(accessor, *methods)
-    methods.delete("__send__")
-    methods.delete("__id__")
-    for method in methods
+    methods.each do |method|
+      next if /\A__(?:send|id)__\z/ =~ method
       def_single_delegator(accessor, method)
     end
   end
@@ -301,6 +303,7 @@ module SingleForwardable
     gen = Forwardable._delegator_method(self, accessor, method, ali)
 
     instance_eval(&gen)
+    singleton_class.send(:ruby2_keywords, ali) if RUBY_VERSION >= '2.7'
   end
 
   alias delegate single_delegate

data/lib/forwardable/impl.rb

@@ -1,13 +1,5 @@
 # :stopdoc:
 module Forwardable
-  FILE_REGEXP = %r"#{Regexp.quote(File.dirname(__FILE__))}"
-  FILTER_EXCEPTION = <<-'END'
-
-        rescue ::Exception
-          $@.delete_if {|s| ::Forwardable::FILE_REGEXP =~ s} unless ::Forwardable::debug
-          ::Kernel::raise
-  END
-
   def self._valid_method?(method)
     catch {|tag|
       eval("BEGIN{throw tag}; ().#{method}", binding, __FILE__, __LINE__)

data/lib/forwardable/version.rb

@@ -0,0 +1,5 @@
+module Forwardable
+  # Version of +forwardable.rb+
+  VERSION = "1.3.0"
+  FORWARDABLE_VERSION = VERSION
+end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: forwardable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Keiju ISHITSUKA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2019-11-30 00:00:00.000000000 Z
+dependencies: []
 description: Provides delegation of specified methods to a designated object.
 email:
 - keiju@ruby-lang.org
@@ -45,17 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - forwardable.gemspec
 - lib/forwardable.rb
 - lib/forwardable/impl.rb
+- lib/forwardable/version.rb
 homepage: https://github.com/ruby/forwardable
 licenses:
 - BSD-2-Clause
@@ -75,8 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides delegation of specified methods to a designated object.

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-  - ruby-head
-before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.

data/README.md

@@ -1,79 +0,0 @@
-# Forwardable
-
-The Forwardable module provides delegation of specified methods to a designated object, using the methods #def_delegator and #def_delegators.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'forwardable'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install forwardable
-
-## Usage
-
-For example, say you have a class RecordCollection which contains an array <tt>@records</tt>.  You could provide the lookup ethod `#record_number()`, which simply calls #[] on the <tt>@records</tt> array, like this:
-
-```
-  require 'forwardable'
-
-  class RecordCollection
-    attr_accessor :records
-    extend Forwardable
-    def_delegator :@records, :[], :record_number
-  end
-```
-
-We can use the lookup method like so:
-
-```
-  r = RecordCollection.new
-  r.records = [4,5,6]
-  r.record_number(0)  # => 4
-```
-
-Further, if you wish to provide the methods #size, #<<, and #map, all of which delegate to @records, this is how you can do it:
-
-```
-  class RecordCollection # re-open RecordCollection class
-    def_delegators :@records, :size, :<<, :map
-  end
-
-  r = RecordCollection.new
-  r.records = [1,2,3]
-  r.record_number(0)   # => 1
-  r.size               # => 3
-  r << 4               # => [1, 2, 3, 4]
-  r.map { |x| x * 2 }  # => [2, 4, 6, 8]
-```
-
-You can even extend regular objects with Forwardable.
-
-```
-  my_hash = Hash.new
-  my_hash.extend Forwardable              # prepare object for delegation
-  my_hash.def_delegator "STDOUT", "puts"  # add delegation for STDOUT.puts()
-  my_hash.puts "Howdy!"
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/forwardable.
-
-## License
-
-The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test" << "test/lib"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task :default => :test

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require_relative "../lib/forwardable"
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install