characterizable 0.0.9 → 0.0.10

data/README.rdoc

@@ -4,6 +4,58 @@
 
 http://tinyurl.com/28tcrw2
 
+== What is a BetterHash?
+
+It just brings some Ruby 1.9 behavior to Ruby 1.8 hashes... (from http://webonrails.com/2009/02/06/ruby-191-hash)
+
+    RUBY_VERSION => 1.8.6
+    >> hash = {:a=> 1, :b=>2, :c=>3, :d=>4}
+    => {:b=>2, :c=>3, :d=>4, :a=>1}
+    >> hash.select{|k,v| k == :c }
+    => [[:c, 3]]
+
+    RUBY_VERSION => 1.9.1
+    >> hash = {:a=> 1, :b=>2, :c=>3, :d=>4}
+    => {:a=>1, :b=>2, :c=>3, :d=>4}
+    >> hash.select{|k,v| k == :c }
+    => {:c=>3}
+
+I hope these two tests show the value of BetterHash in the context of this gem...
+
+    should "not be annoying to work with characteristics on a particular instance" do
+      a = SimpleAutomobile.new
+      a.make = 'Nissan'
+      assert_same_contents [:make], a.characteristics.effective.keys
+      assert_same_contents [:make], a.characteristics.effective.select { true }.keys
+    end
+
+    should "not be annoying to work with characteristics hashes on a class level"
+      assert_same_contents [:make, :model, :variant], SimpleAutomobile.characteristics.keys
+      assert_same_contents [:make, :model, :variant], SimpleAutomobile.characteristics.select { true }.keys
+    end
+
+If you didn't have BetterHash, you wouldn't be able to call <tt>#keys</tt> because in Ruby 1.8 <tt>Hash#select</tt> (and <tt>#reject</tt>) gives you back an Array.
+
+== What is a Snapshot?
+
+It's a hash of the characteristics at a particular time...
+
+    should "keep snapshots separately" do
+      my_car = Automobile.new
+      my_car.make = 'Ford'
+      my_car.model_year = 1999
+      snapshot = my_car.characteristics
+      assert_same_contents [:make, :model_year], snapshot.effective.keys
+      my_car.make = nil
+      assert_same_contents [], my_car.characteristics.effective.keys           # up to date!
+      assert_same_contents [:make, :model_year], snapshot.effective.keys       # frozen in time!
+    end
+
+There are two important points here:
+
+* If you call <tt>my_car.characteristics</tt>, you will always get the most recent snapshot
+* If you save the output to a variable like <tt>snapshot</tt>, that snapshot won't change
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/characterizable.gemspec

@@ -1,60 +1,60 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{characterizable}
-  s.version = "0.0.9"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andy Rossmeissl", "Seamus Abshere"]
-  s.date = %q{2010-07-06}
-  s.description = %q{Characterize the relationship between "attributes" (getters/setters) of instances of a class}
-  s.email = %q{seamus@abshere.net}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "characterizable.gemspec",
-     "lib/characterizable.rb",
-     "test/helper.rb",
-     "test/test_characterizable.rb"
-  ]
-  s.homepage = %q{http://github.com/seamusabshere/characterizable}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Characterize instances of a class}
-  s.test_files = [
-    "test/helper.rb",
-     "test/test_characterizable.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<blockenspiel>, [">= 0.3.2"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
-      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
-    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-  end
-end
-
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{characterizable}
+  s.version = "0.0.10"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Rossmeissl", "Seamus Abshere"]
+  s.date = %q{2010-07-06}
+  s.description = %q{Characterize the relationship between "attributes" (getters/setters) of instances of a class}
+  s.email = %q{seamus@abshere.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "characterizable.gemspec",
+     "lib/characterizable.rb",
+     "test/helper.rb",
+     "test/test_characterizable.rb"
+  ]
+  s.homepage = %q{http://github.com/seamusabshere/characterizable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Characterize instances of a class}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_characterizable.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<blockenspiel>, [">= 0.3.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/characterizable.rb

@@ -3,6 +3,7 @@ require 'blockenspiel'
 require 'active_support'
 require 'active_support/version'
 %w{
+  active_support/core_ext/hash/slice
   active_support/core_ext/class/attribute_accessors
   active_support/core_ext/object/blank
   active_support/core_ext/array/wrap
@@ -26,45 +27,45 @@ module Characterizable
     @_characteristics = nil
   end
   
-  # hashes that survive as such when you select/reject/slice them
-  # they also keep arguments passed to them
-  class SurvivorHash < Hash
-    attr_reader :survivor_args
-    def initialize(*survivor_args)
-      @survivor_args = survivor_args
-    end
-    def reject(&block)
-      inject(self.class.new(*survivor_args)) do |memo, ary|
-        unless block.call(*ary)
-          memo[ary[0]] = ary[1]
+  class BetterHash < ::Hash
+    # In Ruby 1.9, running select/reject/etc. gives you back a hash
+    if RUBY_VERSION < '1.9'
+      def reject(&block)
+        inject(Characterizable::BetterHash.new) do |memo, ary|
+          unless block.call(*ary)
+            memo[ary[0]] = ary[1]
+          end
+          memo
         end
-        memo
       end
-    end
-    def select(&block)
-      inject(self.class.new(*survivor_args)) do |memo, ary|
-        if block.call(*ary)
-          memo[ary[0]] = ary[1]
+      def select(&block)
+        inject(Characterizable::BetterHash.new) do |memo, ary|
+          if block.call(*ary)
+            memo[ary[0]] = ary[1]
+          end
+          memo
         end
-        memo
       end
-    end
-    def slice(*keep)
-      inject(self.class.new(*survivor_args)) do |memo, ary|
-        if keep.include?(ary[0])
-          memo[ary[0]] = ary[1]
+      # I need this because otherwise it will try to do self.class.new on subclasses
+      # which would get "0 for 1" arguments error with Snapshot, among other things
+      def slice(*keep)
+        inject(Characterizable::BetterHash.new) do |memo, ary|
+          if keep.include?(ary[0])
+            memo[ary[0]] = ary[1]
+          end
+          memo
         end
-        memo
       end
     end
   end
   
-  class Snapshot < SurvivorHash
-    def initialize(*survivor_args)
-      super
-      take_snapshot
+  class Snapshot < BetterHash
+    attr_reader :target
+    def initialize(target)
+      @target = target
+      _take_snapshot
     end
-    def take_snapshot
+    def _take_snapshot
       target.characterizable_base.characteristics.each do |_, c|
         if c.known?(target)
           if c.effective?(target)
@@ -78,16 +79,6 @@ module Characterizable
         end
       end
     end
-    def slice(*keep)
-      copy = self.class.new *survivor_args
-      copy.keys.each do |key|
-        copy.delete key unless keep.include? key
-      end
-      copy
-    end
-    def target
-      survivor_args.first
-    end
     def []=(key, value)
       target.expire_snapshot!
       super
@@ -132,7 +123,7 @@ module Characterizable
       @klass = klass
     end
     def characteristics
-      @_characteristics ||= SurvivorHash.new
+      @_characteristics ||= BetterHash.new
     end
     include Blockenspiel::DSL
     def has(name, options = {}, &block)

data/test/test_characterizable.rb

@@ -62,22 +62,35 @@ class TestCharacterizable < Test::Unit::TestCase
   should "survive as a certain kind of hash" do
     a = SimpleAutomobile.new
 
-    assert_equal Characterizable::SurvivorHash, SimpleAutomobile.characteristics.class
-    assert_equal Characterizable::SurvivorHash, SimpleAutomobile.characteristics.select { false }.class
-    assert_equal Characterizable::SurvivorHash, SimpleAutomobile.characteristics.slice(:hello).class
-    assert_equal Characterizable::SurvivorHash, SimpleAutomobile.characteristics.merge({:hi => 'there'}).class
+    assert_equal Characterizable::BetterHash, SimpleAutomobile.characteristics.class
+    assert_equal Characterizable::BetterHash, SimpleAutomobile.characteristics.select { false }.class
+    assert_equal Characterizable::BetterHash, SimpleAutomobile.characteristics.slice(:hello).class
+    assert_equal Characterizable::BetterHash, SimpleAutomobile.characteristics.merge({:hi => 'there'}).class
     
-    assert_equal Characterizable::SurvivorHash, a.characteristics.effective.class
-    assert_equal Characterizable::SurvivorHash, a.characteristics.effective.select { false }.class
-    assert_equal Characterizable::SurvivorHash, a.characteristics.effective.slice(:hello).class
-    assert_equal Characterizable::SurvivorHash, a.characteristics.effective.merge({:hi => 'there'}).class
+    assert_equal Characterizable::BetterHash, a.characteristics.effective.class
+    assert_equal Characterizable::BetterHash, a.characteristics.effective.select { false }.class
+    assert_equal Characterizable::BetterHash, a.characteristics.effective.slice(:hello).class
+    assert_equal Characterizable::BetterHash, a.characteristics.effective.merge({:hi => 'there'}).class
+
+    assert_equal Characterizable::BetterHash, a.characteristics.select { false }.class
+    assert_equal Characterizable::BetterHash, a.characteristics.slice(:hello).class
 
     assert_equal Characterizable::Snapshot, a.characteristics.class
-    assert_equal Characterizable::Snapshot, a.characteristics.select { false }.class
-    assert_equal Characterizable::Snapshot, a.characteristics.slice(:hello).class
     assert_equal Characterizable::Snapshot, a.characteristics.merge({:hi => 'there'}).class
   end
   
+  should "not be annoying to work with characteristics on a particular instance" do
+    a = SimpleAutomobile.new
+    a.make = 'Nissan'
+    assert_same_contents [:make], a.characteristics.effective.keys
+    assert_same_contents [:make], a.characteristics.effective.select { true }.keys
+  end
+  
+  should "not be annoying to work with characteristics hashes on a class level" do
+    assert_same_contents [:make, :model, :variant], SimpleAutomobile.characteristics.keys
+    assert_same_contents [:make, :model, :variant], SimpleAutomobile.characteristics.select { true }.keys
+  end
+  
   should "tell you what characteristics are effective" do
     a = SimpleAutomobile.new
     a.make = 'Ford'
@@ -229,8 +242,8 @@ class TestCharacterizable < Test::Unit::TestCase
     snapshot = a.characteristics
     assert_same_contents [:make, :model_year], snapshot.effective.keys
     a.make = nil
-    assert_same_contents [], a.characteristics.effective.keys
-    assert_same_contents [:make, :model_year], snapshot.effective.keys
+    assert_same_contents [], a.characteristics.effective.keys             # up to date!
+    assert_same_contents [:make, :model_year], snapshot.effective.keys    # frozen in time!
   end
     
   should "work when passed around as a snapshot" do
@@ -323,5 +336,31 @@ class TestCharacterizable < Test::Unit::TestCase
     a.make = 'Ford'
     assert_equal({ :make => 'Ford' }, a.characteristics)
     assert_equal({}, a.characteristics.slice(:dummy))
+    assert_equal({ :make => 'Ford' }, a.characteristics.slice(:make))
+  end
+  
+  should 'allow characterizations to be selected' do
+    a = Automobile.new
+    a.make = 'Ford'
+    assert_equal({ :make => 'Ford' }, a.characteristics.select { |k, v| k == :make })
+    assert_equal({}, a.characteristics.select { |k, v| k == :dummy })
+  end
+  
+  should 'allow characterizations to be rejected' do
+    a = Automobile.new
+    a.make = 'Ford'
+    assert_equal({ :make => 'Ford' }, a.characteristics.reject { |k, v| k == :dummy })
+    assert_equal({}, a.characteristics.reject { |k, v| k == :make })
   end
+
+  should 'not reset snapshot after slicing' do
+    a = Automobile.new
+    a.make = 'Ford'
+    snapshot = a.characteristics.slice(:dummy)
+    assert_equal({}, snapshot)
+    a.make = 'Nissan'
+    assert_equal({}, snapshot)
+    assert_equal({}, snapshot.slice(:make))
+  end
+  
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: characterizable
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -22,9 +23,11 @@ dependencies:
   name: blockenspiel
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 3
@@ -36,9 +39,11 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 3
@@ -50,9 +55,11 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -88,23 +95,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Characterize instances of a class