hash_out 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09d4acf8885e3018d89507399d889841f5b67e34
-  data.tar.gz: 180a33b85d8abd7cfc25b333d9649bd1c0465cb3
+  metadata.gz: b9a0ed8ed60004a223c24fb5c5d7dc878ce96de7
+  data.tar.gz: 49bfa30ee0655b9fbd206dfeef7881a24e9e2a18
 SHA512:
-  metadata.gz: 2c7021e5425cefeef649cf02d1e4e291098ecb6636838f55b416a6eb74a1f4fb464108ef9d5b6d410e6b5e6fe37da6ec15159d042f1ff7d219f50383b3b1731c
-  data.tar.gz: cd0abe87615671b457852adaf3a68b7138f4e9526d8d0d3a85f102a86665c60a2d2e92c9c29d25ad21a515386e58e477dd03c60bfa97d28eb2d0018d5ef3d84a
+  metadata.gz: 41a8055dd2e9f5f7ff7928b8760016d711eeeea3fd01b66adc3b2ab5322a3281098b718249fff71f092186bac3560a54aa014d989d7e30a8da9fb524d6e79e48
+  data.tar.gz: 7c7aa9a516d33a43ac4edd84de03ba540ca2a990786d8f1b739d254b985c3f94676e79e92116855251ae8817d61eb19cc88bd894a8607be06f7f2a133bd3bba9

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### 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
+* Makes behavior more object-oriented
+* Divides features into separate files
+* Improves README in terms of understanding different features
+
+### version 0.1.2 - *July 15, 2013*
+* Fixes bug: internal calls to `#hash_out` infinitely recurse
+
+### version 0.1.1 - *July 15, 2013*
+* Changes rake to a development dependency from a runtime dependency
+
+# version 0.1.0 - *July 15, 2013*
+* Initial release

data/Gemfile.lock

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

data/README.md

@@ -16,15 +16,28 @@ $ gem install hash_out
 ```
 
 ## Usage
-1. `require 'hash_out'`.
-2. Include `HashOut` in your class.
-3. If desired, exclude methods from `#hash_out` by adding `exclude_from_hash_out` to them.
-4. Call `#hash_out` on the instance to return a hash of method names and their values.
+`require 'hash_out'`, `include HashOut`, and call `#hash_out` on the instance.
 
-##### `#hash_out` automatically excludes the following from the hash it returns:
-1. private methods
-2. methods that require arguments
-3. instance methods in classes that include `HashOut` that wrap or otherwise call `#hash_out`
+```ruby
+require 'hash_out'
+
+class Movie
+  include HashOut
+
+  def title
+    'Fire Walk With Me'
+  end
+
+  def director
+    'David Lynch'
+  end
+end
+
+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.
 
 ```ruby
 require 'hash_out'
@@ -40,30 +53,80 @@ class Movie
     exclude_from_hash_out
     'David Lynch'
   end
+end
+
+Movie.new.hash_out
+# => {:title=>"Fire Walk With Me"}
+```
+
+Private methods are ignored.
+```ruby
+require 'hash_out'
+
+class Movie
+  include HashOut
 
-  def available_instantly? catalog=TerribleStreamingService.new
-    catalog.available_instantly? self
+  def title
+    'Fire Walk With Me'
   end
 
-  def has_actor? actor
-    actors.include? actor
+  private
+
+  def director
+    'David Lynch'
+  end
+end
+
+Movie.new.hash_out
+# => {:title=>"Fire Walk With Me"}
+```
+
+Public methods that require arguments are also ignored.
+```ruby
+require 'hash_out'
+
+class Movie
+  include HashOut
+
+  def title
+    'Fire Walk With Me'
   end
 
   def chance_of_sequel? existing_sequels, strategy=FutureSequelStrategy
     strategy.new(self, existing_sequels).chance > 0.5
   end
+end
 
-  private
+Movie.new.hash_out
+# => {:title=>"Fire Walk With Me"}
+```
+
+Public methods that call `#hash_out` are ignored, too.
 
-  def actors
-    ['Sheryl Lee', 'David Bowie', 'Ray Wise']
+```ruby
+require 'hash_out'
+
+class Movie
+  include HashOut
+
+  def title
+    'Fire Walk With Me'
+  end
+
+  def director
+    'David Lynch'
+  end
+
+  def attributes
+    hash_out
   end
 end
 
 movie = Movie.new
+movie.attributes
+# => {:title=>"Fire Walk With Me", :director=>'David Lynch'}
 movie.hash_out
-# => {:title=>"Fire Walk With Me", :available_instantly?=>false}
-
+# => {:title=>"Fire Walk With Me", :director=>'David Lynch'}
 ```
 
 ## Contribute
@@ -73,6 +136,12 @@ 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/call_registry.rb

@@ -0,0 +1,24 @@
+module HashOut
+  class CallRegistry
+    attr_reader :hash_out_caller
+
+    def initialize hash_out_caller
+      @times_called    = 0
+      @hash_out_caller = hash_out_caller
+    end
+
+    def register_call
+      @times_called += 1
+    end
+
+    def delete_caller_from hash
+      hash.delete hash_out_caller if internal_call?
+    end
+
+    private
+
+    def internal_call?
+      @times_called > 1
+    end
+  end
+end

data/lib/hash_out/hasher.rb

@@ -0,0 +1,41 @@
+require 'set'
+
+module HashOut
+  class Hasher < Struct.new :object, :call_registry
+    def object_to_hash
+      prepare_hashable_methods
+      set_hash
+      delete_exclusions
+      @hash
+    end
+
+    def exclusions
+      @exclusions ||= Set.new
+    end
+
+    def exclude method
+      exclusions.add method
+    end
+
+    private
+
+    def prepare_hashable_methods
+      @hashable_methods = object.send :_methods_requiring_no_args
+      call_registry.delete_caller_from @hashable_methods
+    end
+
+    def set_hash
+      @hash = Hash[hashable_method_value_pairs]
+    end
+
+    def hashable_method_value_pairs
+      @hashable_methods.map do |method|
+        object.send :_method_value_pair, method
+      end
+    end
+
+    def delete_exclusions
+      exclusions.each { |exclusion| @hash.delete exclusion }
+    end
+  end
+end

data/lib/hash_out/version.rb

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

data/lib/hash_out.rb

@@ -1,63 +1,38 @@
-module HashOut
-  require 'set'
+require 'last_call'
+require 'hash_out/call_registry'
+require 'hash_out/hasher'
 
+module HashOut
   def hash_out
-    caller_method = caller_method_sym caller.first
-
-    handle_recursion(caller_method) do
-      if @called == 1
-        set_hash_out
-        delete_exclusions
-      end
-    end
-
-    @hash_out
+    _register_call last_call
+    _hasher.object_to_hash
   end
 
   protected
 
   def exclude_from_hash_out
-    excluded_method = caller_method_sym caller.first
-    exclusions.add excluded_method
+    _hasher.exclude last_call
   end
 
   private
 
-  def handle_recursion hash_out_caller
-    @called ||= 0
-    @called  += 1
-    exclusions.add hash_out_caller
-    yield
-    @called = 0
+  def _register_call hash_out_caller
+    _call_registry(hash_out_caller).register_call
   end
 
-  def set_hash_out
-    @hash_out = Hash[interesting_methods_and_values]
+  def _call_registry hash_out_caller=nil
+    @_call_registry ||= CallRegistry.new hash_out_caller
   end
 
-  def interesting_methods_and_values
-    methods_requiring_no_arguments.map do |method_name|
-      name_value_pair method_name
-    end
+  def _hasher
+    @_hasher ||= Hasher.new self, _call_registry
   end
 
-  def methods_requiring_no_arguments
+  def _methods_requiring_no_args
     public_methods(false).select { |m| [-1, 0].include? method(m).arity }
   end
 
-  def name_value_pair method_name
-    [method_name, send(method_name)]
-  end
-
-  def delete_exclusions
-    exclusions.each { |exclusion| @hash_out.delete exclusion }
-  end
-
-  def exclusions
-    @exclusions ||= Set.new
-  end
-
-  def caller_method_sym caller_string
-    caller_string.match(/`(.*)'/)[1].to_sym
+  def _method_value_pair method
+    [method, send(method)]
   end
 end

data/lib/last_call.rb

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

data/spec/features/ambiguous_caller_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../spec_helper'
+
+describe 'ambiguous caller' do
+  class What
+    include HashOut
+
+    def huh
+      :yep
+    end
+  end
+
+  class Yep
+    def self.huh
+      What.new.hash_out
+    end
+  end
+
+  it "keeps the key of the name of another object's caller" do
+    hash_out = { huh: :yep }
+    expect(Yep.huh).to_equal hash_out
+  end
+end

data/spec/features/attribute_mutation_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../spec_helper'
+
+describe 'attribute mutation' do
+  class Ooze
+    include HashOut
+    attr_accessor :color
+  end
+
+  it 'accounts for it between calls to #hash_out' do
+    ooze = Ooze.new
+    ooze.color = :green
+    expect(ooze.hash_out).to_equal({color: :green})
+
+    ooze.color = :purple
+    expect(ooze.hash_out).to_equal({color: :purple})
+  end
+end

data/spec/features/exclude_from_hash_out_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../spec_helper'
+
+describe '#exclude_from_hash_out' do
+  class Brawler
+    include HashOut
+
+    def fighting?
+      true
+    end
+
+    def pancakes
+      exclude_from_hash_out
+      'yes please'
+    end
+  end
+
+  it 'ignores public methods that declare exclusion from public hash' do
+    brawler  = Brawler.new
+    hash_out = { fighting?: brawler.fighting? }
+
+    expect(brawler.hash_out).to_equal hash_out
+  end
+end

data/spec/features/objects_methods_that_call_hash_out_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../spec_helper'
+
+describe "object's methods that call #hash_out" do
+  class SoMeta
+    include HashOut
+
+    def an_method
+      :result
+    end
+
+    def attributes
+      hash_out
+      hash_out
+      hash_out
+    end
+  end
+
+  it 'ignores internal public method that calls #hash_out any number of times' do
+    so_meta  = SoMeta.new
+    hash_out = { an_method: :result }
+
+    expect(so_meta.attributes).to_equal hash_out
+    expect(so_meta.hash_out).to_equal hash_out
+  end
+end

data/spec/features/objects_methods_with_arguments_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../spec_helper'
+
+describe "object's methods with arguments" do
+  class Beans; end;
+  class Grinder
+    include HashOut
+
+    def initialize
+      @beans = Beans.new
+    end
+
+    def grind settings, beans=@beans
+      with_settings(settings) do |grinder|
+        beans.krush_with grinder
+      end
+    end
+
+    def clean materials
+      clean_with materials
+      @cleaned = true
+    end
+
+    def blade edge=:sharp
+      edge
+    end
+
+    private
+
+    def with_settings settings
+      @settings = settings
+      yield self
+    end
+
+    def clean_with materials
+    end
+  end
+
+  it 'ignores public methods that require arguments' do
+    grinder  = Grinder.new
+    hash_out = { blade: grinder.blade }
+
+    expect(grinder.hash_out).to_equal hash_out
+  end
+end

data/spec/features/objects_private_methods_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+
+describe "object's private methods" do
+  class ShotCaller
+    include HashOut
+
+    def front
+      :chillin
+    end
+
+    private
+
+    def real_mood
+      :nervous
+    end
+  end
+
+  it 'ignores them' do
+    shot_caller = ShotCaller.new
+    hash_out    = { front: shot_caller.front }
+
+    expect(shot_caller.hash_out).to_equal hash_out
+  end
+end

data/spec/features/objects_public_methods_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../spec_helper'
+
+describe "object's public methods" do
+  class Baller
+    include HashOut
+
+    def mood
+      :ballin
+    end
+
+    def height
+      :tall
+    end
+  end
+
+  it 'returns a hash of name-values from them' do
+    baller   = Baller.new
+    hash_out = {
+      mood:   baller.mood,
+      height: baller.height
+    }
+
+    expect(baller.hash_out).to_equal hash_out
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require_relative '../lib/hash_out'
+require 'minitest/autorun'
+require 'minitest/spec/expect'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_out
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dave Jachimiak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -46,14 +46,25 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - hash_out.gemspec
 - lib/hash_out.rb
+- lib/hash_out/call_registry.rb
+- lib/hash_out/hasher.rb
 - lib/hash_out/version.rb
-- spec/lib/integration_spec.rb
+- lib/last_call.rb
+- spec/features/ambiguous_caller_spec.rb
+- spec/features/attribute_mutation_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
 homepage: http://github.com/davejachimiak/hash_out
 licenses:
 - MIT
@@ -80,4 +91,11 @@ specification_version: 4
 summary: 'hash_out adds the #hash_out method to your class'' instance. It returns
   a hash of public method names and values.'
 test_files:
-- spec/lib/integration_spec.rb
+- spec/features/ambiguous_caller_spec.rb
+- spec/features/attribute_mutation_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

data/spec/lib/integration_spec.rb

@@ -1,130 +0,0 @@
-require_relative '../../lib/hash_out'
-require 'minitest/autorun'
-require 'minitest/spec/expect'
-
-describe 'HashOut#hash_out' do
-  class Baller
-    include HashOut
-
-    def mood
-      :ballin
-    end
-
-    def height
-      :tall
-    end
-  end
-
-  it 'returns a hash of name-values' do
-    baller   = Baller.new
-    hash_out = {
-      mood:   baller.mood,
-      height: baller.height
-    }
-
-    expect(baller.hash_out).to_equal hash_out
-  end
-
-  class ShotCaller
-    include HashOut
-
-    def front
-      :chillin
-    end
-
-    private
-
-    def real_mood
-      :nervous
-    end
-  end
-
-  it 'ignores private methods' do
-    shot_caller = ShotCaller.new
-    hash_out    = { front: shot_caller.front }
-
-    expect(shot_caller.hash_out).to_equal hash_out
-  end
-
-  class Brawler
-    include HashOut
-
-    def fighting?
-      true
-    end
-
-    def pancakes
-      exclude_from_hash_out
-      'yes please'
-    end
-  end
-
-  it 'ignores public methods that declare exclusion from public hash' do
-    brawler  = Brawler.new
-    hash_out = { fighting?: brawler.fighting? }
-
-    expect(brawler.hash_out).to_equal hash_out
-  end
-
-  class Beans; end;
-  class Grinder
-    require 'ostruct'
-    include HashOut
-
-    def initialize
-      @beans = Beans.new
-    end
-
-    def grind settings, beans=@beans
-      with_settings(settings) do
-        beans.krush
-      end
-    end
-
-    def clean materials
-      clean_with materials
-      @cleaned = true
-    end
-
-    def blade edge=:sharp
-      edge
-    end
-
-    private
-
-    def with_settings settings
-      @settings = settings
-      yield self
-    end
-
-    def clean_with materials
-      #
-    end
-  end
-
-  it 'ignores public methods that require arguments' do
-    grinder  = Grinder.new
-    hash_out = { blade: grinder.blade }
-
-    expect(grinder.hash_out).to_equal hash_out
-  end
-
-  class SoMeta
-    include HashOut
-
-    def an_method
-      :result
-    end
-
-    def attributes
-      hash_out
-    end
-  end
-
-  it "ignores internal public method that calls #hash_out" do
-    so_meta  = SoMeta.new
-    hash_out = { an_method: :result }
-
-    expect(so_meta.attributes).to_equal hash_out
-  end
-end