characterizable 0.0.17 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.17
+0.1.0

data/characterizable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{characterizable}
-  s.version = "0.0.17"
+  s.version = "0.1.0"
 
   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-09-30}
+  s.date = %q{2010-11-03}
   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 = [
@@ -25,6 +25,11 @@ Gem::Specification.new do |s|
      "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"
   ]
@@ -34,7 +39,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Characterize instances of a class}
   s.test_files = [
-    "test/helper.rb",
+    "test/characterizable/test_characteristic.rb",
+     "test/helper.rb",
      "test/test_characterizable.rb"
   ]
 

data/lib/characterizable.rb

@@ -12,6 +12,12 @@ require 'active_support/version'
   require active_support_3_requirement
 end if ActiveSupport::VERSION::MAJOR == 3
 
+$:.unshift File.dirname(__FILE__)
+require 'characterizable/base'
+require 'characterizable/better_hash'
+require 'characterizable/characteristic'
+require 'characterizable/snapshot'
+
 module Characterizable
   def self.included(klass)
     klass.cattr_accessor :characterizable_base
@@ -25,93 +31,10 @@ module Characterizable
   def expire_snapshot!
     @_characteristics = nil
   end
-  
-  class BetterHash < ::Hash
-    # In Ruby 1.9, running select/reject/etc. gives you back a hash
-    # if RUBY_VERSION < '1.9'
-      def to_hash
-        Hash.new.replace self
-      end
-      def as_json(*)
-        to_hash
-      end
-      def reject(&block)
-        inject(Characterizable::BetterHash.new) do |memo, ary|
-          unless block.call(*ary)
-            memo[ary[0]] = ary[1]
-          end
-          memo
-        end
-      end
-      def select(&block)
-        inject(Characterizable::BetterHash.new) do |memo, ary|
-          if block.call(*ary)
-            memo[ary[0]] = ary[1]
-          end
-          memo
-        end
-      end
-      # 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
-      end
-    # end
-  end
-  
-  class Snapshot < BetterHash
-    attr_reader :universe
-    def initialize(universe)
-      @universe = universe
-      _take_snapshot
-    end
-    def _take_snapshot
-      universe.characterizable_base.characteristics.each do |_, c|
-        if c.known?(universe)
-          if c.effective?(universe)
-            self[c.name] = c.value(universe)
-          elsif c.trumped?(universe)
-            trumped_keys.push c.name
-          elsif !c.revealed?(universe)
-            wasted_keys.push c.name
-            lacking_keys.push c.prerequisite
-          end
-        end
-      end
-    end
-    def []=(key, value)
-      universe.expire_snapshot!
-      super
-    end
-    def wasted_keys
-      @wasted_keys ||= Array.new
-    end
-    def trumped_keys
-      @trumped_keys ||= Array.new
-    end
-    def lacking_keys
-      @lacking_keys ||= Array.new
-    end
-    def effective
-      universe.characterizable_base.characteristics.select { |_, c| c.effective?(self) }
-    end
-    def potential
-      universe.characterizable_base.characteristics.select { |_, c| c.potential?(self) }
-    end
-    def wasted
-      universe.characterizable_base.characteristics.slice(*wasted_keys)
-    end
-    def lacking
-      universe.characterizable_base.characteristics.slice(*(lacking_keys - wasted_keys))
-    end
-    def trumped
-      universe.characterizable_base.characteristics.slice(*trumped_keys)
-    end
+
+  def display_characteristic(name)
+    characteristic = self.class.characteristics[name]
+    characteristic.display(characteristics) if characteristic
   end
   
   module ClassMethods
@@ -124,99 +47,5 @@ module Characterizable
     end
   end
   
-  class CharacteristicAlreadyDefined < ArgumentError
-  end
-  
-  class Base
-    attr_reader :klass
-    def initialize(klass)
-      @klass = klass
-    end
-    def characteristics
-      @_characteristics ||= BetterHash.new
-    end
-    include Blockenspiel::DSL
-    def has(name, options = {}, &block)
-      raise CharacteristicAlreadyDefined, "The characteristic #{name} has already been defined on #{klass}!" if characteristics.has_key?(name)
-      characteristics[name] = Characteristic.new(self, name, options, &block)
-      begin
-        # quacks like an activemodel
-        klass.define_attribute_methods unless klass.respond_to?(:attribute_methods_generated?) and klass.attribute_methods_generated?
-      rescue
-        # for example, if a table doesn't exist... just ignore it
-      end
-      begin
-        klass.module_eval(%{
-          def #{name}_with_expire_snapshot=(new_#{name})
-            expire_snapshot!
-            self.#{name}_without_expire_snapshot = new_#{name}
-          end
-          alias_method_chain :#{name}=, :expire_snapshot
-        }, __FILE__, __LINE__) #if klass.instance_methods.include?("#{name}=")
-      rescue
-      end
-    end
-  end
-  class Characteristic
-    attr_reader :base
-    attr_reader :name
-    attr_reader :trumps
-    attr_reader :prerequisite
-    attr_reader :options
-    def initialize(base, name, options = {}, &block)
-      @base = base
-      @name = name
-      @trumps = Array.wrap options.delete(:trumps)
-      @prerequisite = options.delete(:prerequisite)
-      @options = options
-      Blockenspiel.invoke block, self if block_given?
-    end
-    def as_json(*)
-      { :name => name, :trumps => trumps, :prerequisite => prerequisite, :options => options }
-    end
-    def inspect
-      "<Characterizable::Characteristic name=#{name.inspect} trumps=#{trumps.inspect} prerequisite=#{prerequisite.inspect} options=#{options.inspect}>"
-    end
-    def characteristics
-      base.characteristics
-    end
-    def value(universe)
-      case universe
-      when Hash
-        universe[name]
-      else
-        universe.send name if universe.respond_to?(name)
-      end
-    end
-    def known?(universe)
-      not value(universe).nil?
-    end
-    def potential?(universe)
-      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
-    end
-    def trumped?(universe, ignoring = nil)
-      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
-          end
-        end
-      end
-      false
-    end
-    def revealed?(universe)
-      return true if prerequisite.nil?
-      characteristics[prerequisite].effective? universe
-    end
-    include Blockenspiel::DSL
-    def reveals(other_name, other_options = {}, &block)
-      base.has other_name, other_options.merge(:prerequisite => name), &block
-    end
-  end
+  class CharacteristicAlreadyDefined < ArgumentError; end
 end

data/lib/characterizable/base.rb

@@ -0,0 +1,32 @@
+module Characterizable
+  class Base
+    attr_reader :klass
+    def initialize(klass)
+      @klass = klass
+    end
+    def characteristics
+      @_characteristics ||= BetterHash.new
+    end
+    include Blockenspiel::DSL
+    def has(name, options = {}, &block)
+      raise CharacteristicAlreadyDefined, "The characteristic #{name} has already been defined on #{klass}!" if characteristics.has_key?(name)
+      characteristics[name] = Characteristic.new(self, name, options, &block)
+      begin
+        # quacks like an activemodel
+        klass.define_attribute_methods unless klass.respond_to?(:attribute_methods_generated?) and klass.attribute_methods_generated?
+      rescue
+        # for example, if a table doesn't exist... just ignore it
+      end
+      begin
+        klass.module_eval(%{
+          def #{name}_with_expire_snapshot=(new_#{name})
+            expire_snapshot!
+            self.#{name}_without_expire_snapshot = new_#{name}
+          end
+          alias_method_chain :#{name}=, :expire_snapshot
+        }, __FILE__, __LINE__) #if klass.instance_methods.include?("#{name}=")
+      rescue
+      end
+    end
+  end
+end

data/lib/characterizable/better_hash.rb

@@ -0,0 +1,39 @@
+module Characterizable
+  class BetterHash < ::Hash
+    # In Ruby 1.9, running select/reject/etc. gives you back a hash
+    # if RUBY_VERSION < '1.9'
+      def to_hash
+        Hash.new.replace self
+      end
+      def as_json(*)
+        to_hash
+      end
+      def reject(&block)
+        inject(Characterizable::BetterHash.new) do |memo, ary|
+          unless block.call(*ary)
+            memo[ary[0]] = ary[1]
+          end
+          memo
+        end
+      end
+      def select(&block)
+        inject(Characterizable::BetterHash.new) do |memo, ary|
+          if block.call(*ary)
+            memo[ary[0]] = ary[1]
+          end
+          memo
+        end
+      end
+      # 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
+      end
+    # end
+  end
+end

data/lib/characterizable/characteristic.rb

@@ -0,0 +1,80 @@
+module Characterizable
+  class Characteristic
+    attr_reader :base, :name, :trumps, :prerequisite, :display, :options
+
+    def initialize(base, name, options = {}, &block)
+      @base = base
+      @name = name
+      @trumps = Array.wrap options.delete(:trumps)
+      @prerequisite = options.delete(:prerequisite)
+      @display = options.delete(:display)
+      @options = options
+      Blockenspiel.invoke block, self if block_given?
+    end
+
+    def as_json(*)
+      { :name => name, :trumps => trumps, :prerequisite => prerequisite, :options => options }
+    end
+    
+    def inspect
+      "<Characterizable::Characteristic name=#{name.inspect} trumps=#{trumps.inspect} prerequisite=#{prerequisite.inspect} options=#{options.inspect}>"
+    end
+
+    def characteristics
+      base.characteristics
+    end
+
+    def value(universe)
+      case universe
+      when Hash
+        universe[name]
+      else
+        universe.send name if universe.respond_to?(name)
+      end
+    end
+
+    def display(universe)
+      @display.call(value(universe)) if @display
+    end
+
+    def known?(universe)
+      not value(universe).nil?
+    end
+
+    def potential?(universe)
+      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
+    end
+
+    def trumped?(universe, ignoring = nil)
+      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
+          end
+        end
+      end
+      false
+    end
+
+    def revealed?(universe)
+      return true if prerequisite.nil?
+      characteristics[prerequisite].effective? universe
+    end
+
+    include Blockenspiel::DSL
+    def reveals(other_name, other_options = {}, &block)
+      base.has other_name, other_options.merge(:prerequisite => name), &block
+    end
+
+    def displays(&block)
+      @display = block
+    end
+  end
+end

data/lib/characterizable/snapshot.rb

@@ -0,0 +1,51 @@
+module Characterizable
+  class Snapshot < BetterHash
+    attr_reader :universe
+    def initialize(universe)
+      @universe = universe
+      _take_snapshot
+    end
+    def _take_snapshot
+      universe.characterizable_base.characteristics.each do |_, c|
+        if c.known?(universe)
+          if c.effective?(universe)
+            self[c.name] = c.value(universe)
+          elsif c.trumped?(universe)
+            trumped_keys.push c.name
+          elsif !c.revealed?(universe)
+            wasted_keys.push c.name
+            lacking_keys.push c.prerequisite
+          end
+        end
+      end
+    end
+    def []=(key, value)
+      universe.expire_snapshot!
+      super
+    end
+    def wasted_keys
+      @wasted_keys ||= Array.new
+    end
+    def trumped_keys
+      @trumped_keys ||= Array.new
+    end
+    def lacking_keys
+      @lacking_keys ||= Array.new
+    end
+    def effective
+      universe.characterizable_base.characteristics.select { |_, c| c.effective?(self) }
+    end
+    def potential
+      universe.characterizable_base.characteristics.select { |_, c| c.potential?(self) }
+    end
+    def wasted
+      universe.characterizable_base.characteristics.slice(*wasted_keys)
+    end
+    def lacking
+      universe.characterizable_base.characteristics.slice(*(lacking_keys - wasted_keys))
+    end
+    def trumped
+      universe.characterizable_base.characteristics.slice(*trumped_keys)
+    end
+  end
+end

data/test/characterizable/test_characteristic.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class Character
+  include Characterizable
+end
+
+class Characterizable::CharacteristicTest < Test::Unit::TestCase
+  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
+end

data/test/test_characterizable.rb

@@ -39,13 +39,14 @@ end
 
 class SimpleAutomobile
   include Characterizable
-  attr_accessor :make
-  attr_accessor :model
-  attr_accessor :variant
+  attr_accessor :make, :model, :variant
+
   characterize do
     has :make
-    has :model
-    has :variant, :trumps => :model
+    has :model, :display => lambda { |c| "Brand new #{c}" }
+    has :variant, :trumps => :model do
+      displays { |v| "Featuring #{v}" }
+    end
   end
 end
 
@@ -446,4 +447,12 @@ class TestCharacterizable < Test::Unit::TestCase
     assert_equal [], a.characteristics.lacking.keys
     assert_equal [], a.characteristics.trumped.keys
   end
+
+  should 'display custom formats' do
+    sa = SimpleAutomobile.new
+    sa.model = 'FIT'
+    assert_equal 'Brand new FIT', sa.display_characteristic(:model)
+    sa.variant = 'Extreme Edition'
+    assert_equal 'Featuring Extreme Edition', sa.display_characteristic(:variant)
+  end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: characterizable
 version: !ruby/object:Gem::Version 
-  hash: 61
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 17
-  version: 0.0.17
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 -05:00
+date: 2010-11-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,7 +26,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
         - 3
@@ -43,7 +41,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 2
         - 3
@@ -59,7 +56,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -83,6 +79,11 @@ files:
 - 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
 has_rdoc: true
@@ -99,7 +100,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -108,7 +108,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -120,5 +119,6 @@ signing_key:
 specification_version: 3
 summary: Characterize instances of a class
 test_files: 
+- test/characterizable/test_characteristic.rb
 - test/helper.rb
 - test/test_characterizable.rb