delegates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59b7c5fec2ef33582f5b4563712a3a7d7a750b9a2e4fdfcfb097b880d66927dc
+  data.tar.gz: e49380a8f88e8e48ccd7bd82d98caeee7ffeb7df9000c41a9e8399da0fb9e98b
+SHA512:
+  metadata.gz: 7f97640dce630c2b2d92c14e82572ffd6515adb6badc0c7f76c36420eaa090918f9417c37a41b1dda8b2e8857dd8285d996c068c7fe56159975ae2adf51f73bc
+  data.tar.gz: 44e85bee9c1f676548510f2fd05453ceda13f485e82a18a180dd53e4e7ee3c0b97f9b93b91a4eabe09f870b57c8102e81ed2830888bff1c33b434d81a32071a4

data/README.md

@@ -0,0 +1,46 @@
+# Delegates
+
+[![Gem Version](https://badge.fury.io/rb/delegates.svg)](http://badge.fury.io/rb/delegates)
+![build](https://github.com/zverok/delegates/workflows/CI/badge.svg)
+
+This gem is just an extraction of the handy `delegate :method1, :method2, method3, to: :receiver` from ActiveSupport. It seems to be seriously superior to stdlib's [Forwardable](https://ruby-doc.org/stdlib-2.7.1/libdoc/forwardable/rdoc/Forwardable.html), and sometimes I want it in contexts when ActiveSupport and monkey-patching is undesireable.
+
+Usage:
+
+```
+gem install delegates
+```
+(or add `gem 'delegates'` to your `Gemfile`).
+
+Then:
+
+```ruby
+class Employee < Struct.new(:name, :department, :address)
+  # ...
+  extend Delegates
+  delegates :city, :street, to: :address
+  # ...
+end
+
+employee = Employee.new(name, department, address)
+
+employee.city # will call employee.address.city
+```
+
+`to:` can be anything evaluatable from inside the class: `:<CONSTANT>`, `:@<instance_variable>`, `'chain.of.calls'` etc.; special names requiring `self` (like `class` method) handled gracefully with just `delegate ..., to: :class`. New methods are defined with `eval`-ing strings, so they are as fast as if manually written.
+
+Supported options examples (all that ActiveSupport's `Module#delegate` supports):
+
+```ruby
+delegate :city, to: :address, prefix: true # defined method would be address_city
+delegate :city, to: :address, prefix: :adrs # defined method would be adrs_city
+
+delegate :city, to: :address, private: true # defined method would be private
+
+delegate :city, to: :address, allow_nil: true
+```
+The latter option will handle the `employee.city` call when `employee.address` is `nil` by returning `nil`; otherwise (by default) informative `DelegationError` is raised.
+
+## Credits
+
+99.99% of credits should go to Rails users and contributors, who found and and handled miriads of realistic edge cases. I just copied the code (and groomed it a bit for closer to my own style).

data/lib/delegates.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'set'
+
+# Provides a {#delegate} class method to define methods whose calls are delegated to nested objects
+#
+# **Examples:**
+#
+# ```ruby
+# class Greeter
+#   def hello
+#     'hello'
+#   end
+#
+#   def goodbye
+#     'goodbye'
+#   end
+# end
+#
+# class Foo
+#   def greeter
+#     Greeter.new
+#   end
+#
+#   extend Delegates
+#   delegate :hello, to: :greeter
+# end
+#
+# Foo.new.hello   # => "hello"
+# Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c>
+# ```
+#
+# Methods can be delegated to instance variables, class variables, or constants
+# by providing them as a symbols:
+#
+# ```ruby
+# class Foo
+#   CONSTANT_ARRAY = [0,1,2,3]
+#   @@class_array  = [4,5,6,7]
+#
+#   def initialize
+#     @instance_array = [8,9,10,11]
+#   end
+#   delegate :sum, to: :CONSTANT_ARRAY
+#   delegate :min, to: :@@class_array
+#   delegate :max, to: :@instance_array
+# end
+#
+# Foo.new.sum # => 6
+# Foo.new.min # => 4
+# Foo.new.max # => 11
+# ```
+#
+# See {#delegate} docs for available params.
+#
+# The target method must be public, otherwise it will raise `NoMethodError`.
+#
+module Delegates
+  # Initial source: https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/module/delegation.rb
+
+  # Error generated by +delegate+ when a method is called on +nil+ and +allow_nil+
+  # option is not used.
+  class DelegationError < NoMethodError; end
+
+  # @private
+  RUBY_RESERVED_KEYWORDS =
+    %w[alias and BEGIN begin break case class def defined? do
+       else elsif END end ensure false for if in module next nil not or redo rescue retry
+       return self super then true undef unless until when while yield].freeze
+
+  # @private
+  DELEGATION_RESERVED_KEYWORDS = %w[_ arg args block].freeze
+
+  # @private
+  DELEGATION_RESERVED_METHOD_NAMES = Set.new(
+    RUBY_RESERVED_KEYWORDS + DELEGATION_RESERVED_KEYWORDS
+  ).freeze
+
+  # Note that methods call to exactly once (in case it has side-effects)
+
+  # @private
+  ALLOW_NIL_PATTERN = <<~RUBY
+    def %{method_name}(%{definition})
+      _ = %{to}
+      if !_.nil? || nil.respond_to?(:%{method})
+        _.%{method}(%{definition})
+      end
+    end
+  RUBY
+
+  # @private
+  NO_NIL_PATTERN = <<~RUBY
+    def %{method_name}(%{definition})
+      _ = %{to}
+      _.%{method}(%{definition})
+    rescue NoMethodError => e
+      if _.nil? && e.name == :%{method}
+        raise DelegationError, "%{module}#%{method_name} delegated to %{to}.%{method}, but %{to} is nil: \#{self.inspect}"
+      else
+        raise
+      end
+    end
+  RUBY
+
+  # Defines methods specified in `methods` to delegate their calls to `to`.
+  #
+  # @param methods [Array<String, Symbol>] List of method names to delegate
+  # @param to [String, Symbol] Specifies the target object name, could be anything callable from inside
+  #   the class, e.g. `:some_attribute`, `:@any_instance_variable`, `'chain.of.calls`
+  # @param prefix [true, String, Symbol] If `true`, prefixes new method with target method, e.g.
+  #   `delegate :name, to: :customer, prefix: true` produces method named `customer_name`; if
+  #   set to a string/symbol, uses it as a custom prefix, e.g. `delegate :name, to: :customer, prefix: 'cs'`
+  #   produces method named `cs_name`
+  # @param allow_nil [true, false] If set to `true`, then returns `nil` when delegated object
+  #   is `nil`; otherwise (default) raises `Delegates::DelegationError`
+  # @param private [true, false] If set to `true`, changes method visibility to private
+  #
+  # @return [Array<Symbol>] Array of method names defined
+  def delegate(*methods, to:, prefix: nil, allow_nil: false, private: false)
+    if prefix == true && /^[^a-z_]/.match?(to)
+      raise ArgumentError,
+            'Can only automatically set the delegation prefix when delegating to a method.'
+    end
+
+    method_prefix = if prefix
+                      "#{prefix == true ? to : prefix}_"
+                    else
+                      ''
+                    end
+
+    location = caller_locations(1, 1).first
+    file, line = location.path, location.lineno
+
+    to = to.to_s
+    to = "self.#{to}" if DELEGATION_RESERVED_METHOD_NAMES.include?(to)
+
+    method_defs = []
+    method_names = []
+
+    methods.map(&:to_s).map do |method|
+      method_name = "#{method_prefix}#{method}"
+      method_names << method_name.to_sym
+
+      # Attribute writer methods only accept one argument. Makes sure []=
+      # methods still accept two arguments.
+      definition = if method.match?(/[^\]]=$/)
+                     'arg'
+                   elsif RUBY_VERSION >= '2.7'
+                     '...'
+                   else
+                     '*args, &block'
+                   end
+
+      method_defs <<
+        if allow_nil
+          ALLOW_NIL_PATTERN % {
+            method_name: method_name,
+            definition: definition,
+            method: method,
+            to: to
+          }
+        else
+          NO_NIL_PATTERN % {
+            module: self,
+            method_name: method_name,
+            definition: definition,
+            method: method,
+            to: to
+          }
+        end
+    end
+    module_eval(method_defs.join(';').gsub(/ *\n */m, ';'), file, line)
+    private(*method_names) if private
+    method_names
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: delegates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.38.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: saharspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  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: yard
+  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'
+description: |2
+      ActiveSupport's delegation syntax is much more convenient than Ruby's stdlib Forwardable.
+      This gem just extracts it as an independent functionality (available on-demand without
+      monkey-patching Module).
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/delegates.rb
+homepage: https://github.com/zverok/delegates
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/zverok/delegates/issues
+  documentation_uri: https://www.rubydoc.info/gems/delegates/
+  homepage_uri: https://github.com/zverok/delegates
+  source_code_uri: https://github.com/zverok/delegates
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: 'delegate :methods, to: :target, extracted from ActiveSupport'
+test_files: []