hash_out 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27081d531afa436f0f54a81a4a23365562040c33
-  data.tar.gz: fe5c98956a7947cf8845b9ce8329195b5a3ec0a6
+  metadata.gz: 18c9acb44220caec2192ec5e88db339e3ee2d206
+  data.tar.gz: bd0dda418d17c604f4257f3b15fe8152f0addbee
 SHA512:
-  metadata.gz: 12218032e2a88287657a84bfe5dc9864f89dade6d5043b636cb29ad804b9f132a83893b959ae7c0f003e2e7c8cf55e92289ce88dfc61c4a065adf1b82a260449
-  data.tar.gz: 18f44cd905066a39aac9f46740ce86234674704892b3a1e8c59e92e0ee655f970875e88baa3c30b99814d32fb88e7525ba47dc6429ffdbecbefc94f0b777f2d1
+  metadata.gz: 11961d83bcc9a1441c0e3351e503b53e614fd7c59a150d0a2a3e93638e8bfce6dc7ca6112479e9d847ef2c60e9cd4fba332a63f4b7cb005108399c3b4fe4003a
+  data.tar.gz: 932cb9c2a0c88e881b0b9f528211f6eb49c4b35f01fbf34057c444f1b7a5389d5abe47875c61bb4093fc94517a1503b8925f41c15a27c791611395e08d4ba013

data/.travis.yml

@@ -4,5 +4,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - rbx-19mode
-  - jruby-19mode
 script: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### version 0.2.0 - *August 15, 2013*
+* Makes hash_out compatible with Forwardable
+* Includes `#excluded_delegators_from_hash_out` class method
+
 ### version 0.1.4 - *July 18, 2013*
 * Fixes bug (issue #1): `#exclude_from_hash_out` does not block mutation that may happen in the call.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hash_out (0.1.4)
+    hash_out (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,7 +7,7 @@ Include `HashOut` to your class and convert your object to a hash with the `#has
 ## Install
 Add to your Gemfile:
 ```ruby
-gem 'hash_out', '~> 0.1'
+gem 'hash_out', '~> 0.2'
 ```
 
 Or install it from the command line:
@@ -142,6 +142,34 @@ movie.hash_out
 # => {:title=>"Fire Walk With Me", :director=>'David Lynch'}
 ```
 
+Delegators introduced by Forwardable can be excluded by including
+`#exclude_delegators_from_hash_out`. (`Forwardable` must be
+extended *before* `HashOut` is included.)
+```ruby
+require 'hash_out'
+require 'forwardable'
+
+class Movie
+  extend  Forwardable
+  include HashOut
+
+  exclude_delegators_from_hash_out
+
+  def_delegator :@title, :upcase
+
+  def initialize
+    @title = 'Fire Walk With Me'
+  end
+
+  def screaming_title
+    upcase
+  end
+end
+
+Movie.new.hash_out
+# => {:screaming_title=>"FIRE WALK WITH ME"}
+```
+
 ## Contribute
 1. Fork the repo.
 2. Create a branch.
@@ -149,12 +177,6 @@ movie.hash_out
 4. Ensure the specs are green (`$ rake`)
 5. Open a pull request.
 
-## TODO
-* Bug: make `#hash_out` work with SimpleDelegator
-* Provide class method that offers custom delegator for `#hash_out`
-* Provide class method that offers alternative to `exclude_from_hash_out`
-* Provide class method that allows for inclusion of protected and private methods in resulting hash.
-
 ## License
 The MIT License (MIT)
 

data/lib/hash_out.rb

@@ -1,9 +1,22 @@
 require 'last_call'
+require 'init_attrs'
+require 'forwardable'
 require 'hash_out/hasher'
 require 'hash_out/call_registry'
 require 'hash_out/object_wrapper'
+require 'hash_out/object_wrapper/delegated'
+require 'hash_out/delegator_registry'
 
 module HashOut
+  include LastCall
+
+  def self.included base
+    if base.is_a? Forwardable
+      base.extend DelegatorRegistry
+      base.send :include, Delegated
+    end
+  end
+
   def hash_out
     _register_call last_call
     _hasher.object_to_hash
@@ -28,4 +41,10 @@ module HashOut
   end
 
   def exclude_from_hash_out; end;
+
+  module Delegated
+    def _wrapped_self
+      @_wrapped_self ||= ObjectWrapper::Delegated.new self
+    end
+  end
 end

data/lib/hash_out/call_registry.rb

@@ -1,24 +1,21 @@
 module HashOut
-  class CallRegistry
-    attr_reader :hash_out_caller
+  class CallRegistry < Struct.new :hash_out_caller
+    include InitAttrs
 
-    def initialize hash_out_caller
-      @times_called    = 0
-      @hash_out_caller = hash_out_caller
-    end
+    init_accessor :times_called, ->{ 0 }
 
     def register_call
-      @times_called += 1
+      self.times_called += 1
     end
 
     def delete_caller_from hash
-      hash.delete hash_out_caller if internal_call?
+      hash.delete hash_out_caller  if internal_call?
     end
 
     private
 
     def internal_call?
-      @times_called > 1
+      times_called > 1
     end
   end
 end

data/lib/hash_out/delegator_excludable.rb

@@ -0,0 +1,11 @@
+require 'hash_out/excludable'
+
+module HashOut
+  module DelegatorExcludable
+    include Excludable
+
+    def exclusions
+      @exclusions ||= self.class.delegators
+    end
+  end
+end

data/lib/hash_out/delegator_registry.rb

@@ -0,0 +1,27 @@
+module HashOut
+  module DelegatorRegistry
+    def exclude_delegators_from_hash_out
+      @register_delegators = true
+    end
+
+    def def_instance_delegator *args
+      register_delegator args[-1] if register_delegators?
+      super
+    end
+    alias def_delegator def_instance_delegator
+
+    def delegators
+      @delegators ||= []
+    end
+
+    private
+
+    def register_delegator delegator
+      delegators.push delegator
+    end
+
+    def register_delegators?
+      !!@register_delegators
+    end
+  end
+end

data/lib/hash_out/excludable.rb

@@ -1,5 +1,7 @@
 module HashOut
   module Excludable
+    include LastCall
+
     def exclusions
       @exclusions ||= []
     end
@@ -8,12 +10,19 @@ module HashOut
       exclusions.push last_call
     end
 
-    def prepare_exclusions methods
+    def exclude_exclusions_from methods
+      execute methods
+      delete_exclusions_from methods
+    end
+
+    private
+
+    def execute methods
       methods.each { |method| send method }
     end
 
-    def delete_exclusions methods
-      exclusions.each { |method| methods.delete method }
+    def delete_exclusions_from methods
+      methods.delete_if { |method| exclusions.include? method }
     end
   end
 end

data/lib/hash_out/hasher.rb

@@ -1,32 +1,31 @@
 require 'hash_out/excludable'
-require 'forwardable'
 
 module HashOut
   class Hasher < Struct.new :object, :call_registry
-    extend Forwardable
+    extend  Forwardable
+    include InitAttrs
 
-    def_delegator :object, :excludable, :excludable_obj
+    def_delegator :object, :excludable, :excludable_object
+    init_accessor :hashable_methods do
+      object.public_methods_requiring_no_args
+    end
 
     def object_to_hash
       prepare_hashable_methods
-      delete_excluded_methods
       Hash[hashable_method_value_pairs]
     end
 
     private
 
     def prepare_hashable_methods
-      @hashable_methods = object.public_methods_requiring_no_args
-      call_registry.delete_caller_from @hashable_methods
-    end
+      methods = hashable_methods
 
-    def delete_excluded_methods
-      excludable_obj.prepare_exclusions @hashable_methods
-      excludable_obj.delete_exclusions @hashable_methods
+      call_registry.delete_caller_from methods
+      excludable_object.exclude_exclusions_from methods
     end
 
     def hashable_method_value_pairs
-      @hashable_methods.map do |method|
+      hashable_methods.map do |method|
         object.method_value_pair method
       end
     end

data/lib/hash_out/object_wrapper.rb

@@ -1,15 +1,12 @@
 require 'hash_out/excludable'
-require 'forwardable'
 
 module HashOut
   class ObjectWrapper < Struct.new :object
-    extend Forwardable
+    include InitAttrs
+    extend  Forwardable
 
     def_delegators :object, :dup, :public_methods, :send, :method
-
-    def excludable
-      @excludable ||= dup.extend Excludable
-    end
+    init_reader :excludable, ->{ dup.extend Excludable }
 
     def public_methods_requiring_no_args
       public_methods(false).select { |method| requires_no_args? method }
@@ -21,8 +18,8 @@ module HashOut
 
     private
 
-    def requires_no_args? m
-      [-1, 0].include? method(m).arity
+    def requires_no_args? method
+      [-1, 0].include? method(method).arity
     end
   end
 end

data/lib/hash_out/object_wrapper/delegated.rb

@@ -0,0 +1,9 @@
+require 'hash_out/delegator_excludable'
+
+module HashOut
+  class ObjectWrapper
+    class Delegated < ObjectWrapper
+      init_reader :excludable, ->{ dup.extend DelegatorExcludable }
+    end
+  end
+end

data/lib/hash_out/version.rb

@@ -1,3 +1,3 @@
 module HashOut
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/lib/init_attrs.rb

@@ -0,0 +1,46 @@
+module InitAttrs
+  module ClassMethods
+    def init_accessor name, procedure=nil, &block
+      register_attr_with_type :attr_accessor, name, procedure || block
+    end
+
+    def init_reader name, procedure=nil, &block
+      register_attr_with_type :attr_reader, name, procedure || block
+    end
+
+    def new *args
+      @instance = super
+      set_ivars
+      @instance
+    end
+
+    def register_attr_with_type type, name, procedure
+      register_attr name, procedure
+      send type, name
+    end
+
+    private
+
+    def register_attr name, procedure
+      attrs.merge! "#{name}" => procedure
+    end
+
+    def attrs
+      @attrs ||= {}
+    end
+
+    def set_ivars
+      attrs.each_pair do |name, procedure|
+        @instance.instance_variable_set "@#{name}", value(procedure)
+      end
+    end
+
+    def value procedure
+      @instance.instance_exec &procedure
+    end
+  end
+
+  def self.included base
+    base.extend ClassMethods
+  end
+end

data/lib/last_call.rb

@@ -1,4 +1,4 @@
-module Kernel
+module LastCall
   def last_call
     caller[1].match(/`(.*)'/)[1].to_sym
   end

data/spec/features/compatible_with_delegators_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../spec_helper'
+
+describe 'compatibility with delegators' do
+  require 'forwardable'
+
+  class FreshPrince
+    extend  Forwardable
+    include HashOut
+
+    def_delegator :@aww, :to_sym, :aww
+
+    def initialize
+      @aww = 'yeah'
+    end
+  end
+
+  it 'it keeps methods written by Forwardable if delegators are not excluded' do
+    fresh_prince = FreshPrince.new
+    hash_out     = { aww: :yeah }
+
+    expect(fresh_prince.hash_out).to_equal hash_out
+  end
+
+  class Clarissa
+    extend  Forwardable
+    include HashOut
+
+    exclude_delegators_from_hash_out
+
+    def_delegator  :@cool, :upcase
+    def_delegator  :@guys, :downcase, :lowercase_guys
+    def_delegators :@alright, :to_s
+
+    def initialize
+      @cool    = 'cool'
+      @guys    = 'GUYS'
+      @alright = :alright
+    end
+
+    def hey
+      upcase
+    end
+
+    def sup
+      lowercase_guys
+    end
+
+    def alright
+      to_s
+    end
+  end
+
+  it 'is ignores methods written by Forwardable if delegators are excluded' do
+    clarissa = Clarissa.new
+    hash_out = { hey: 'COOL', sup: 'guys', alright: 'alright' }
+
+    expect(clarissa.hash_out).to_equal hash_out
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_out
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Dave Jachimiak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -54,13 +54,18 @@ files:
 - hash_out.gemspec
 - lib/hash_out.rb
 - lib/hash_out/call_registry.rb
+- lib/hash_out/delegator_excludable.rb
+- lib/hash_out/delegator_registry.rb
 - lib/hash_out/excludable.rb
 - lib/hash_out/hasher.rb
 - lib/hash_out/object_wrapper.rb
+- lib/hash_out/object_wrapper/delegated.rb
 - lib/hash_out/version.rb
+- lib/init_attrs.rb
 - lib/last_call.rb
 - spec/features/ambiguous_caller_spec.rb
 - spec/features/attribute_mutation_between_hash_out_calls_spec.rb
+- spec/features/compatible_with_delegators_spec.rb
 - spec/features/exclude_from_hash_out_spec.rb
 - spec/features/objects_methods_that_call_hash_out_spec.rb
 - spec/features/objects_methods_with_arguments_spec.rb
@@ -87,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: 'hash_out adds the #hash_out method to your class'' instance. It returns
@@ -95,9 +100,11 @@ summary: 'hash_out adds the #hash_out method to your class'' instance. It return
 test_files:
 - spec/features/ambiguous_caller_spec.rb
 - spec/features/attribute_mutation_between_hash_out_calls_spec.rb
+- spec/features/compatible_with_delegators_spec.rb
 - spec/features/exclude_from_hash_out_spec.rb
 - spec/features/objects_methods_that_call_hash_out_spec.rb
 - spec/features/objects_methods_with_arguments_spec.rb
 - spec/features/objects_private_methods_spec.rb
 - spec/features/objects_public_methods_spec.rb
 - spec/spec_helper.rb
+has_rdoc: