hash_out 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9a0ed8ed60004a223c24fb5c5d7dc878ce96de7
-  data.tar.gz: 49bfa30ee0655b9fbd206dfeef7881a24e9e2a18
+  metadata.gz: 27081d531afa436f0f54a81a4a23365562040c33
+  data.tar.gz: fe5c98956a7947cf8845b9ce8329195b5a3ec0a6
 SHA512:
-  metadata.gz: 41a8055dd2e9f5f7ff7928b8760016d711eeeea3fd01b66adc3b2ab5322a3281098b718249fff71f092186bac3560a54aa014d989d7e30a8da9fb524d6e79e48
-  data.tar.gz: 7c7aa9a516d33a43ac4edd84de03ba540ca2a990786d8f1b739d254b985c3f94676e79e92116855251ae8817d61eb19cc88bd894a8607be06f7f2a133bd3bba9
+  metadata.gz: 12218032e2a88287657a84bfe5dc9864f89dade6d5043b636cb29ad804b9f132a83893b959ae7c0f003e2e7c8cf55e92289ce88dfc61c4a065adf1b82a260449
+  data.tar.gz: 18f44cd905066a39aac9f46740ce86234674704892b3a1e8c59e92e0ee655f970875e88baa3c30b99814d32fb88e7525ba47dc6429ffdbecbefc94f0b777f2d1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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.
+
+  closes #1
+
 ### version 0.1.3 - *July 17, 2013*
 * Fixes bug: multiple calls to `#hash_out` that are from an internal method infinitely recurse
 * Fixes bug: method not present in hash when outside caller of `#hash_out` has same name

data/Gemfile.lock

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

data/README.md

@@ -37,26 +37,39 @@ Movie.new.hash_out
 # => {:title=>"Fire Walk With Me", :director=>'David Lynch'}
 ```
 
-To exclude public methods from `#hash_out`, put `exclude_from_hash_out` at the top of them.
+To exclude public methods from `#hash_out`, call the `#exclude_from_hash_out` method in them.
+`#exclude_from_hash_out` blocks any attribute mutation that occurs during a normal call to the
+method.
 
 ```ruby
 require 'hash_out'
 
-class Movie
+class Post
   include HashOut
 
+  attr_reader :upvotes
+
+  def initialize
+    @upvotes = 1000000
+  end
+
   def title
-    'Fire Walk With Me'
+    'Twin Peaks fuckin rocks'
   end
 
-  def director
+  def upvote
     exclude_from_hash_out
-    'David Lynch'
+    @upvotes += 500000
   end
 end
 
-Movie.new.hash_out
-# => {:title=>"Fire Walk With Me"}
+post = Post.new
+post.hash_out
+# => {:title=>"Twin Peaks fuckin rocks", :upvotes=>1000000}
+
+post.upvote
+post.hash_out
+# => {:title=>"Twin Peaks fuckin rocks", :upvotes=>1500000}
 ```
 
 Private methods are ignored.

data/lib/hash_out/excludable.rb

@@ -0,0 +1,19 @@
+module HashOut
+  module Excludable
+    def exclusions
+      @exclusions ||= []
+    end
+
+    def exclude_from_hash_out
+      exclusions.push last_call
+    end
+
+    def prepare_exclusions methods
+      methods.each { |method| send method }
+    end
+
+    def delete_exclusions methods
+      exclusions.each { |method| methods.delete method }
+    end
+  end
+end

data/lib/hash_out/hasher.rb

@@ -1,41 +1,34 @@
-require 'set'
+require 'hash_out/excludable'
+require 'forwardable'
 
 module HashOut
   class Hasher < Struct.new :object, :call_registry
-    def object_to_hash
-      prepare_hashable_methods
-      set_hash
-      delete_exclusions
-      @hash
-    end
+    extend Forwardable
 
-    def exclusions
-      @exclusions ||= Set.new
-    end
+    def_delegator :object, :excludable, :excludable_obj
 
-    def exclude method
-      exclusions.add method
+    def object_to_hash
+      prepare_hashable_methods
+      delete_excluded_methods
+      Hash[hashable_method_value_pairs]
     end
 
     private
 
     def prepare_hashable_methods
-      @hashable_methods = object.send :_methods_requiring_no_args
+      @hashable_methods = object.public_methods_requiring_no_args
       call_registry.delete_caller_from @hashable_methods
     end
 
-    def set_hash
-      @hash = Hash[hashable_method_value_pairs]
+    def delete_excluded_methods
+      excludable_obj.prepare_exclusions @hashable_methods
+      excludable_obj.delete_exclusions @hashable_methods
     end
 
     def hashable_method_value_pairs
       @hashable_methods.map do |method|
-        object.send :_method_value_pair, method
+        object.method_value_pair method
       end
     end
-
-    def delete_exclusions
-      exclusions.each { |exclusion| @hash.delete exclusion }
-    end
   end
 end

data/lib/hash_out/object_wrapper.rb

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

data/lib/hash_out/version.rb

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

data/lib/hash_out.rb

@@ -1,6 +1,7 @@
 require 'last_call'
-require 'hash_out/call_registry'
 require 'hash_out/hasher'
+require 'hash_out/call_registry'
+require 'hash_out/object_wrapper'
 
 module HashOut
   def hash_out
@@ -8,12 +9,6 @@ module HashOut
     _hasher.object_to_hash
   end
 
-  protected
-
-  def exclude_from_hash_out
-    _hasher.exclude last_call
-  end
-
   private
 
   def _register_call hash_out_caller
@@ -25,14 +20,12 @@ module HashOut
   end
 
   def _hasher
-    @_hasher ||= Hasher.new self, _call_registry
+    @_hasher ||= Hasher.new _wrapped_self, _call_registry
   end
 
-  def _methods_requiring_no_args
-    public_methods(false).select { |m| [-1, 0].include? method(m).arity }
+  def _wrapped_self
+    @_wrapped_self ||= ObjectWrapper.new self
   end
 
-  def _method_value_pair method
-    [method, send(method)]
-  end
+  def exclude_from_hash_out; end;
 end

data/spec/features/{attribute_mutation_spec.rb → attribute_mutation_between_hash_out_calls_spec.rb}

@@ -1,6 +1,6 @@
 require_relative '../spec_helper'
 
-describe 'attribute mutation' do
+describe 'attribute mutation between #hash_out calls' do
   class Ooze
     include HashOut
     attr_accessor :color

data/spec/features/exclude_from_hash_out_spec.rb

@@ -20,4 +20,34 @@ describe '#exclude_from_hash_out' do
 
     expect(brawler.hash_out).to_equal hash_out
   end
+
+  class Lips
+    include HashOut
+
+    def initialize
+      @size = :small
+    end
+
+    def botox
+      exclude_from_hash_out
+      @size = :fat
+    end
+
+    def size
+      @size
+    end
+  end
+
+  it 'blocks mutation effects below call' do
+    lips     = Lips.new
+    hash_out = { size: :small }
+
+    expect(lips.hash_out).to_equal hash_out
+  end
+
+  it 'mutates if call is not from #hash_out' do
+    lips = Lips.new
+    lips.botox
+    expect(lips.size).to_equal :fat
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_out
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dave Jachimiak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -54,11 +54,13 @@ files:
 - hash_out.gemspec
 - lib/hash_out.rb
 - lib/hash_out/call_registry.rb
+- lib/hash_out/excludable.rb
 - lib/hash_out/hasher.rb
+- lib/hash_out/object_wrapper.rb
 - lib/hash_out/version.rb
 - lib/last_call.rb
 - spec/features/ambiguous_caller_spec.rb
-- spec/features/attribute_mutation_spec.rb
+- spec/features/attribute_mutation_between_hash_out_calls_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
@@ -92,7 +94,7 @@ summary: 'hash_out adds the #hash_out method to your class'' instance. It return
   a hash of public method names and values.'
 test_files:
 - spec/features/ambiguous_caller_spec.rb
-- spec/features/attribute_mutation_spec.rb
+- spec/features/attribute_mutation_between_hash_out_calls_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