delegate_when_nil 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9792d84c37ea5e3c15dc4b6d490fdb537c978e9c
+  data.tar.gz: 7a9ef09e419e7a8a142e392799bb1a57e8faafee
+SHA512:
+  metadata.gz: 7a7b282e90b32c49e250af8536c118bd2e820139cde0b41b17ea1b55c31c9de2648f3100b46d87f97869774aadbeae8526187fb9663330d8085ee4346779ea91
+  data.tar.gz: c17356ebf0873edb2d54ae7b7779f510e6687fcf4c962a3773c3654c13233943b089dc8a85c16eb7f8008ab9aef8edcd9b2b19a4414b3b1d67a84fd127664d99

data/README.md

@@ -1,6 +1,32 @@
 # DelegateWhenNil
 
-TODO: Write a gem description
+This gem provides a macro-method, #delegate_when_nil, which works kind of like #delegate, except it evaluates
+the expression locally first, and delegates to the target only if the local result is nil.
+
+
+    class Parent
+      attr_accessor :name, :address
+      ...
+    end
+
+    class Child
+      attr_accessor :name, :address
+      delegate_when_nil :name, :address, to: :parent, prefix: :get
+
+      # equivalent to
+      # def get_name
+      #   self.name || (parent && parent.get_name) # #get_name on Parent might delegate further...
+      # end
+
+    # use #stop option to avoid the prefix on the parent attribute (delegation "stops" at parent)
+
+    class Child
+      delegate_when_nil :name, :address, to: :parent, prefix: :get, stop: true
+
+      # equivalent to
+      # def get_name
+      #   self.name || (parent && parent.name) # #name directly on parent instead of #get_name
+      # end
 
 ## Installation
 
@@ -18,35 +44,21 @@ Or install it yourself as:
 
 ## Usage
 
-First of all require the gem
-
-   require 'delegate_when_nil'
-
-Mix in the DelegateWhenNil module
-
-   class Widget
-     extend DelegateWhenNil
-     ...
-
-To use with ActiveRecord, put this in an initializer instead
-
-   ActiveRecord::Base.send :extend, DelegateNil
-
-Then #delegate_when_nil is available as a class method on your model,
+DelegateWhenNil installs itself in Module so is available everywhere in your code.
 
-   class Widget < PopularFramework::Base
-     attr_accessor :parent
-     attr_accessor :description, :colour, :height
-     delegate_when_nil :description, :colour, :height, to: :parent
-     ...
+    class Widget < PopularFramework::Base
+      attr_accessor :parent
+      attr_accessor :description, :colour, :height
+      delegate_when_nil :description, :colour, :height, to: :parent, prefix: :get
+      ...
 
 In this example, if the #description, #colour, or #height properties are accessed and are nil, DelegateWhenNil will ask the #parent property instead.
 
-   p = Parent.new :description => "Woggle"
-   w = Widget.new :parent => p, :colour => :blue
+    p = Parent.new :description => "Woggle"
+    w = Widget.new :parent => p, :colour => :blue
 
-   w.description #=> "Woggle"
-   w.colour      #=> :blue
+    w.get_description #=> "Woggle"
+    w.get_colour      #=> :blue
 
 ## Contributing
 

data/delegate_when_nil.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Like #delegate, but assumes the target method already exists, and delegates only when the local method returns nil}
   gem.homepage      = "https://github.com/conanite/delegate_when_nil"
 
-  gem.add_development_dependency 'rspec', '~> 2.9'
-  gem.add_development_dependency 'rspec_numbering_formatter'
+  gem.add_development_dependency 'rspec'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/delegate_when_nil.rb

@@ -1,28 +1,41 @@
 require "delegate_when_nil/version"
 
 module DelegateWhenNil
-  def define_conditional_delegation name, target
-    old_name = "delegate_when_nil_#{name}".to_sym
-    return if method_defined? old_name
+  # Child defines accessor :name
+  # Parent defines accessor :name
+  #
+  # class Child
+  #   delegate_when_nil :name, :address, to: :parent, prefix: :get
+  #
+  #   # equivalent to
+  #   def get_name
+  #     self.name || (parent && parent.get_name)
+  #   end
+  #
+  # use #stop option to avoid prefix on parent (delegation "stops" at parent)
+  #
+  # class Child
+  #   delegate_when_nil :name, :address, to: :parent, prefix: :get, stop: true
+  #
+  #   # equivalent to
+  #   def get_name
+  #     self.name || (parent && parent.name) # #name directly on parent instead of #get_name
+  #   end
+  #
+  def delegate_when_nil *names
+    opts     = names.pop
+    raise "please provide a hash with keys :to and :prefix as last argument" unless opts.is_a?(Hash) && opts.key?(:to) && opts.key?(:prefix)
 
-    class_eval <<DELEGATION
-      alias #{old_name} #{name}                         # alias delegate_when_nil_description description
-      def #{name} *args                                 # def description *args
-        result = #{old_name}(*args)                     #   result = delegate_when_nil_description(*args)
-        if result == nil                                #   if result == nil
-           delegate = #{target}                         #     delegate = parent
-           result = delegate.#{name}(*args) if delegate #     result = delegate.description(*args) if delegate
-        end                                             #   end
-        result                                          #   result
-      end                                               # end
-DELEGATION
-  end
+    fallback = opts[:to]
+    prefix   = opts[:prefix]
+    stop     = opts[:stop]
 
-  def delegate_when_nil *names
-    target = names.pop[:to]
-    raise "missing :to option to #delegate_when_nil for #{name}" if target.to_s == ""
-    names.each do |name|
-      define_conditional_delegation name, target
-    end
+    raise "prefix required to avoid infinite recursion in #attr_fallback #{names.inspect}" unless prefix
+
+    names.each { |name|
+      myname = [prefix, name].compact.join('_')
+      fbname = stop ? name : myname
+      class_eval "def #{myname}(*args) ; self.#{name}(*args) || (#{fallback} && #{fallback}.#{fbname}(*args)) ; end"
+    }
   end
 end

data/lib/delegate_when_nil/version.rb

@@ -1,3 +1,3 @@
 module DelegateWhenNil
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/delegate_when_nil_spec.rb

@@ -3,53 +3,57 @@ require 'spec_helper'
 describe DelegateWhenNil do
   class Parent
     attr_accessor :last_name
+    alias get_last_name last_name
   end
 
   class Child
     extend DelegateWhenNil
     attr_accessor :last_name, :parent, :size
-    delegate_when_nil :last_name, :to => :parent
-    delegate_when_nil :size, :to => :"parent.last_name"
+    delegate_when_nil :last_name, to: :parent, prefix: :get
+    delegate_when_nil :size, to: "parent.last_name", prefix: :measure, stop: true
   end
 
-  it "should not intervene when the property is present" do
+  it "does not delegate when the local property is present" do
     child = Child.new
     child.last_name = "Wong"
     expect(child.last_name).to eq "Wong"
   end
 
-  it "should not get upset when everything is nil" do
+  it "does not get upset when everything is nil" do
     child = Child.new
     expect(child.last_name).to eq nil
   end
 
-  it "should not intervene when the property is present and the delegate target is also present" do
+  it "does not delegate when the property is present and the delegate target is also present" do
     child = Child.new
     child.last_name = "Shaw"
     child.parent = Parent.new
     expect(child.last_name).to eq "Shaw"
   end
 
-  it "should not intervene when the property is present and the delegate target is also present" do
+  it "does not delegate when the property is present and the delegate target is also present" do
     child = Child.new
     child.parent = Parent.new
     child.parent.last_name = "Wonka"
-    expect(child.last_name).to eq "Wonka"
+    expect(child.last_name).to be_nil
+    expect(child.get_last_name).to eq "Wonka"
   end
 
-  it "should raise an error if a complex delegation target fails" do
+  it "raises an error if a complex delegation target fails" do
     child = Child.new
-    expect { child.size }.to raise_error
+    expect { child.measure_size }.to raise_error NoMethodError
   end
 
-  it "should execute a complex delegation target as expected" do
+  it "delegates to a complex delegation target as expected" do
     child = Child.new
     child.parent = Parent.new
     child.parent.last_name = "1234567"
-    expect(child.size).to eq 7
+    expect(child.size).to be_nil
+    expect(child.parent.last_name.size).to eq 7
+    expect(child.measure_size).to eq 7
   end
 
-  it "should ignore a complex delegation target as expected when the local property is not nil" do
+  it "ignores a complex delegation target as expected when the local property is not nil" do
     child = Child.new
     child.size = 21
     child.parent = Parent.new

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ require 'delegate_when_nil'
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,58 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: delegate_when_nil
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Conan Dalton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2020-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.9'
-- !ruby/object:Gem::Dependency
-  name: rspec_numbering_formatter
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Like #delegate, but assumes the target method already exists, and
-  delegates only when the local method returns nil'
+description: 'Like #delegate, but assumes the target method already exists, and delegates
+  only when the local method returns nil'
 email:
 - conan@conandalton.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -65,28 +46,27 @@ files:
 homepage: https://github.com/conanite/delegate_when_nil
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.5.2.3
 signing_key: 
-specification_version: 3
-summary: ! 'Like #delegate, but assumes the target method already exists, and delegates
+specification_version: 4
+summary: 'Like #delegate, but assumes the target method already exists, and delegates
   only when the local method returns nil'
 test_files:
 - spec/delegate_when_nil_spec.rb