characterizable 0.1.1 → 0.1.2

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/characterizable.gemspec

@@ -1,47 +1,47 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{characterizable}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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-11-04}
+  s.date = %q{2010-11-18}
   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"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "characterizable.gemspec",
-     "lib/characterizable.rb",
-     "lib/characterizable/base.rb",
-     "lib/characterizable/better_hash.rb",
-     "lib/characterizable/characteristic.rb",
-     "lib/characterizable/snapshot.rb",
-     "test/characterizable/test_characteristic.rb",
-     "test/helper.rb",
-     "test/test_characterizable.rb"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "characterizable.gemspec",
+    "lib/characterizable.rb",
+    "lib/characterizable/base.rb",
+    "lib/characterizable/better_hash.rb",
+    "lib/characterizable/characteristic.rb",
+    "lib/characterizable/snapshot.rb",
+    "test/characterizable/test_characteristic.rb",
+    "test/helper.rb",
+    "test/support/complex_automobile.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/characterizable/test_characteristic.rb",
-     "test/helper.rb",
-     "test/test_characterizable.rb"
+    "test/helper.rb",
+    "test/support/complex_automobile.rb",
+    "test/test_characterizable.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/characterizable/characteristic.rb

@@ -46,24 +46,36 @@ module Characterizable
       not known?(universe) and revealed? universe and not trumped? universe
     end
 
-    def effective?(universe, ignoring = nil)
-      known?(universe) and revealed? universe and not trumped? universe, ignoring
+    def effective?(universe, ignoring = [])
+      known?(universe) and
+        revealed?(universe) and not
+        trumped?(universe, ignoring)
     end
 
-    def trumped?(universe, ignoring = nil)
+    def trumped?(universe, ignoring = [])
       characteristics.each do |_, other|
-        if other.trumps.include? name and not ignoring == other.name
-          if trumps.include? other.name
-            # special case: mutual trumping. current characteristic is trumped if its friend is otherwise effective and it is not otherwise effective
-            return true if other.effective? universe, name and not effective? universe, other.name
-          else
-            return true if other.effective? universe
+        next if ignoring.include?(other.name)
+
+        if other.can_trump? self
+          if can_trump?(other)
+            return mutually_trumped?(universe, other, ignoring) 
+          elsif other.effective?(universe, ignoring + [name])
+            return true
           end
         end
       end
       false
     end
 
+    def can_trump?(other)
+      trumps.include?(other.name)
+    end
+
+    def mutually_trumped?(universe, other, ignoring)
+      # special case: mutual trumping. current characteristic is trumped if its friend is otherwise effective and it is not otherwise effective
+      other.effective?(universe, ignoring + [name]) and not effective?(universe, ignoring + [other.name])
+    end
+
     def revealed?(universe)
       return true if prerequisite.nil?
       characteristics[prerequisite].effective? universe

data/test/characterizable/test_characteristic.rb

@@ -5,19 +5,160 @@ class Character
 end
 
 class Characterizable::CharacteristicTest < Test::Unit::TestCase
-  context 'display' do
+  context Characterizable::Characteristic do
     setup do
-      @universe = { :charisma => 'hearty' }
+      @universe = ComplexAutomobile.new
     end
 
-    should 'not display a custom format if display option not given' do
-      char = Characterizable::Characteristic.new(Character, :charisma, {})
-      assert_nil char.display(@universe)
+    context '#display' do
+      setup do
+        @universe = { :charisma => 'hearty' }
+      end
+
+      should 'not display a custom format if display option not given' do
+        char = Characterizable::Characteristic.new(Character, :charisma, {})
+        assert_nil char.display(@universe)
+      end
+      should 'display a custom format if display option is given' do
+        char = Characterizable::Characteristic.new(Character, :charisma,
+                                                   { :display => lambda { |c| "Level: #{c}" } }) {}
+        assert_equal 'Level: hearty', char.display(@universe)
+      end
+    end
+
+    context '#value' do
+      context 'universe is a hash' do
+        setup do
+          @universe = { :daily_duration => 1 }
+        end
+        should 'return the value for a characteristic' do
+          characteristic = Characterizable::Characteristic.new(ComplexAutomobile, :daily_duration, {})
+          assert_equal 1, characteristic.value(@universe)
+        end
+        should 'return nil for a nonexistent characteristic' do
+          characteristic = Characterizable::Characteristic.new(ComplexAutomobile, :monthly_duration, {})
+          assert_nil characteristic.value(@universe)
+        end
+      end
+      context 'universe is a non-hash' do
+        setup do
+          @universe.daily_duration = 1
+        end
+        should 'return the value for a characteristic' do
+          characteristic = Characterizable::Characteristic.new(ComplexAutomobile, :daily_duration, {})
+          assert_equal 1, characteristic.value(@universe)
+        end
+        should 'return nil for a nonexistent characteristic' do
+          characteristic = Characterizable::Characteristic.new(ComplexAutomobile, :na, {})
+          assert_nil characteristic.value(@universe)
+        end
+      end
+    end
+
+    context '#known?' do
+      setup do
+        @characteristic = @universe.characterizable_base.characteristics[:daily_duration]
+      end
+      should 'return true if the characteristic is not nil' do
+        @universe.daily_duration = 1
+        assert @characteristic.known?(@universe)
+      end
+      should 'return false if the characteristic is nil' do
+        assert !@characteristic.known?(@universe)
+      end
     end
-    should 'display a custom format if display option is given' do
-      char = Characterizable::Characteristic.new(Character, :charisma,
-                                                 { :display => lambda { |c| "Level: #{c}" } }) {}
-      assert_equal 'Level: hearty', char.display(@universe)
+
+    context '#revealed?' do
+      should 'return true if there are no prerequisites' do
+        characteristic = @universe.characterizable_base.characteristics[:size_class]
+        assert characteristic.revealed?(@universe)
+      end
+      should 'return true if its prerequisite is effective' do
+        @universe.acquisition = '1'
+        characteristic = @universe.characterizable_base.characteristics[:retirement]
+        assert characteristic.revealed?(@universe)
+      end
+      should 'return false if its prerequisite is not effective' do
+        characteristic = @universe.characterizable_base.characteristics[:retirement]
+        assert !characteristic.revealed?(@universe)
+      end
+    end
+
+    context '#trumped?' do
+      context 'ignoring is empty' do
+        should 'return true if trumped by another effective characteristic' do
+          @universe.fuel_efficiency = '5'
+          char = @universe.characterizable_base.characteristics[:urbanity]
+          assert char.trumped?(@universe)
+        end
+        should 'return false if trumped by another ineffective characteristic' do
+          char = @universe.characterizable_base.characteristics[:weekly_distance_estimate]
+          assert !char.trumped?(@universe)
+        end
+        should 'return true if mutually trumped, other is effective, and currently not effective' do
+          @universe.daily_distance_estimate = '5'
+          char = @universe.characterizable_base.characteristics[:weekly_distance_estimate]
+          assert char.trumped?(@universe)
+        end
+        should 'return false if mutually trumped, other is effective, and currently am effective' do
+          @universe.daily_distance_estimate = '5'
+          @universe.weekly_distance_estimate = '6'
+          char = @universe.characterizable_base.characteristics[:weekly_distance_estimate]
+          assert !char.trumped?(@universe)
+        end
+        should 'return false if mutually trumped, other is not effective' do
+          char = @universe.characterizable_base.characteristics[:weekly_distance_estimate]
+          assert !char.trumped?(@universe)
+        end
+      end
+      context 'ignoring is set' do
+        should 'return false if trumped by another effective characteristic that should be ignored' do
+          @universe.daily_distance_estimate = '5'
+          char = @universe.characterizable_base.characteristics[:weekly_distance_estimate]
+          assert !char.trumped?(@universe, [:daily_distance_estimate])
+        end
+      end
+    end
+
+#    has :daily_distance_estimate, :trumps => [:weekly_distance_estimate, :annual_distance_estimate, :daily_duration], :measures => :length
+#    has :daily_duration, :trumps => [:annual_distance_estimate, :weekly_distance_estimate, :daily_distance_estimate], :measures => :time
+#    has :weekly_distance_estimate, :trumps => [:annual_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length
+#    has :annual_distance_estimate, :trumps => [:weekly_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length
+    context '#effective?' do
+      should 'return true if known, revealed, and not trumped' do
+        characteristic = @universe.characterizable_base.characteristics[:daily_duration]
+        @universe.daily_duration = '1'
+        assert characteristic.effective?(@universe)
+      end
+      should 'return false if known, reavaled, and trumped' do
+        @universe.annual_distance_estimate = "33796.2"
+        @universe.daily_duration = "3.0"
+        char = @universe.characterizable_base.
+          characteristics[:daily_duration]
+        assert_nothing_raised do
+          char.effective?(@universe)
+        end
+      end
+      should 'return false if known, but not revealed' do
+        @universe.model_year = '2007'
+        char = @universe.characterizable_base.
+          characteristics[:model_year]
+        assert !char.effective?(@universe)
+      end
+      should 'return false if not known' do
+        char = @universe.characterizable_base.
+          characteristics[:model_year]
+        assert !char.effective?(@universe)
+      end
+      should 'not infinitely recurse if there is a 3-way mutual trumping' do
+        @universe.annual_distance_estimate = "33796.2"
+        @universe.daily_duration = "3.0"
+        @universe.weekly_distance_estimate = "804.672"
+        char = @universe.characterizable_base.characteristics[:daily_duration]
+        assert_nothing_raised do
+          char.effective?(@universe)
+        end
+      end
     end
   end
 end

data/test/helper.rb

@@ -13,3 +13,7 @@ class Test::Unit::TestCase
     assert_equal Set.new(a), Set.new(b)
   end
 end
+
+Dir.glob(File.expand_path('support/**/*', File.dirname(__FILE__))).each do |file|
+  require file
+end

data/test/support/complex_automobile.rb

@@ -0,0 +1,35 @@
+class ComplexAutomobile
+  attr_accessor :make, :model_year, :model, :variant
+  attr_accessor :fuel_type, :fuel_efficiency, :urbanity
+  attr_accessor :hybridity
+  attr_accessor :daily_distance_estimate
+  attr_accessor :daily_duration
+  attr_accessor :weekly_distance_estimate
+  attr_accessor :annual_distance_estimate
+  attr_accessor :acquisition
+  attr_accessor :retirement
+  attr_accessor :size_class
+  attr_accessor :timeframe
+  include Characterizable
+  characterize do
+    has :make do |make|
+      make.reveals :model_year do |model_year|
+        model_year.reveals :model, :trumps => :size_class do |model|
+          model.reveals :variant, :trumps => :hybridity
+        end
+      end
+    end
+    has :fuel_type
+    has :fuel_efficiency, :trumps => [:urbanity, :hybridity], :measures => :length_per_volume
+    has :urbanity, :measures => :percentage
+    has :hybridity
+    has :daily_distance_estimate, :trumps => [:weekly_distance_estimate, :annual_distance_estimate, :daily_duration], :measures => :length
+    has :daily_duration, :trumps => [:annual_distance_estimate, :weekly_distance_estimate, :daily_distance_estimate], :measures => :time
+    has :weekly_distance_estimate, :trumps => [:annual_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length
+    has :annual_distance_estimate, :trumps => [:weekly_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length
+    has :acquisition
+    has :retirement, :prerequisite => :acquisition
+    has :size_class
+  end
+end
+

data/test/test_characterizable.rb

@@ -23,17 +23,9 @@ class Automobile
     end
     has :record_creation_date, :hidden => true
     has :size_class
-    # has :fuel_type
-    # has :fuel_efficiency, :trumps => [:urbanity, :hybridity], :measures => :length_per_volume
-    # has :urbanity, :measures => :percentage
     has :hybridity
     has :daily_distance_estimate, :trumps => [:weekly_distance_estimate, :annual_distance_estimate, :daily_duration], :measures => :length #, :weekly_fuel_cost, :annual_fuel_cost]
     has :daily_distance_oracle_estimate, :trumps => :daily_distance_estimate
-    # has :daily_duration, :trumps => [:annual_distance_estimate, :weekly_distance_estimate, :daily_distance_estimate], :measures => :time #, :weekly_fuel_cost, :annual_fuel_cost]
-    # has :weekly_distance_estimate, :trumps => [:annual_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length #, :weekly_fuel_cost, :annual_fuel_cost]
-    # has :annual_distance_estimate, :trumps => [:weekly_distance_estimate, :daily_distance_estimate, :daily_duration], :measures => :length #, :weekly_fuel_cost, :annual_fuel_cost]
-    # has :acquisition
-    # has :retirement
   end
 end
 
@@ -455,4 +447,17 @@ class TestCharacterizable < Test::Unit::TestCase
     sa.variant = 'Extreme Edition'
     assert_equal 'Featuring Extreme Edition', sa.display_characteristic(:variant)
   end
+
+  context 'infinite recursion' do
+    should 'not happen' do
+      c = ComplexAutomobile.new
+      c.annual_distance_estimate = "33796.2"
+      c.daily_duration = "3.0"
+      c.timeframe = "2010-01-01/2011-01-01"
+      c.weekly_distance_estimate = "804.672"
+      assert_nothing_raised do
+        c.characteristics
+      end
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-04 00:00:00 -04:00
+date: 2010-11-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +72,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -85,14 +84,15 @@ files:
 - lib/characterizable/snapshot.rb
 - test/characterizable/test_characteristic.rb
 - test/helper.rb
+- test/support/complex_automobile.rb
 - test/test_characterizable.rb
 has_rdoc: true
 homepage: http://github.com/seamusabshere/characterizable
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -121,4 +121,5 @@ summary: Characterize instances of a class
 test_files: 
 - test/characterizable/test_characteristic.rb
 - test/helper.rb
+- test/support/complex_automobile.rb
 - test/test_characterizable.rb

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC