charisma 0.3.2 → 0.3.3

data/Rakefile

@@ -21,7 +21,7 @@ Bueller::Tasks.new
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.test_files = FileList['test/**/test_*.rb'] + FileList['test/**/*_spec.rb']
   test.verbose = true
 end
 

data/charisma.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.name = 'charisma'
   s.version = Charisma::VERSION
   s.platform = Gem::Platform::RUBY
-  s.date = "2011-07-06"
+  s.date = "2011-09-29"
   s.authors = ['Andy Rossmeissl', 'Seamus Abshere']
   s.email = 'andy@rossmeissl.net'
   s.homepage = 'http://github.com/brighterplanet/charisma'

data/lib/charisma.rb

@@ -4,6 +4,7 @@ require 'active_support/version'
   active_support/inflector/methods
   active_support/core_ext/class/attribute_accessors
   active_support/core_ext/string/output_safety
+  active_support/core_ext/object/try
 }.each do |active_support_3_requirement|
   require active_support_3_requirement
 end if ActiveSupport::VERSION::MAJOR == 3

data/lib/charisma/base.rb

@@ -6,7 +6,4 @@ module Charisma
       @curator ||= Curator.new(self)
     end
   end
-  
-  # Poorly-defined measurements raise this error.
-  class InvalidMeasurementError < StandardError; end
 end

data/lib/charisma/characteristic.rb

@@ -43,8 +43,6 @@ module Charisma
         measurement
       when ::Symbol
         "::Charisma::Measurement::#{measurement.to_s.camelize}".constantize
-      else
-        raise InvalidMeasurementError
       end
     end
   end

data/lib/charisma/curator.rb

@@ -8,23 +8,33 @@ module Charisma
     # The curator's subject--the instance itself' 
     attr_reader :subject
     
-    # The hashed wrapped by the curator that actually stores the computed characteristics'
-    attr_reader :characteristics
-    
     # Create a Curator.
     #
     # Typically this is done automatically when <tt>#characteristics</tt> is called on an instance of a characterized class for the first time.
     # @param [Object] The subject of the curation -- an instance of a characterized class
     # @see Charisma::Base#characteristics
     def initialize(subject)
-      @characteristics = {}.extend LooseEquality
       @subject = subject
       subject.class.characterization.keys.each do |key|
-        if subject.respond_to?(key) and value = subject.send(key)
-          self[key] = value
+        if subject.respond_to?(key)
+          value = subject.send(key)
+          self[key] = value unless value.nil?
         end
       end
     end
+
+    # The hashed wrapped by the curator that actually stores the computed characteristics'
+    def characteristics
+      return @characteristics unless @characteristics.nil?
+
+      @characteristics = ::Hash.new do |h, key|
+        if characterization = subject.class.characterization[key]
+          Curation.new nil, characterization
+        end
+      end
+      @characteristics.extend LooseEquality
+      @characteristics
+    end
     
     # Store a late-defined characteristic, with a Charisma wrapper.
     # @param [Symbol] key The name of the characteristic, which must match one defined in the class's characterization
@@ -41,6 +51,26 @@ module Charisma
     # (see #inpsect)
     def to_s; inspect end
     
+    # Provide a hash of display-friendly presentations of the computed characteristics' values.
+    #
+    # This is just a convenience method for a common use case, namely injecting a hash with the display-friendly presentations.
+    # @return [Hash]
+    def to_hash
+      characteristics.inject({}) do |memo, (k, v)|
+        memo[k] = v.to_s
+        memo
+      end
+    end
+    
+    # Provide a shallow copy.
+    #
+    # @return [Charisma::Curator]
+    def dup
+      shallow = super
+      shallow.instance_variable_set :@characteristics, characteristics.dup
+      shallow
+    end
+    
     extend ::Forwardable
     def_delegators :characteristics, :[], :keys, :slice, :==, :each
     

data/lib/charisma/curator/curation.rb

@@ -22,7 +22,7 @@ module Charisma
       # @param [Charisma::Characteristic, optional] characteristic The associated characteristic definition
       def initialize(value, characteristic = nil)
         @characteristic = characteristic
-        establish_units_methods if characteristic && characteristic.measurement
+        establish_units_methods
         self.value = value
       end
       
@@ -49,12 +49,19 @@ module Charisma
       # Delegator method
       def __setobj__(obj); self.value = obj end
       
+      def units
+        characteristic.try(:measurement_class).try(:unit)
+      end
+      
+      def u
+        characteristic.try(:measurement_class).try(:unit_abbreviation)
+      end
+      
       private
       
-      # If this curation deals with a measured characteristic, this method will delegate <tt>#u</tt>, <tt>#units</tt>, and appropriate unit-name methods to <tt>#render</tt>.
+      # If this curation deals with a measured characteristic, this method will delegate appropriate unit-name methods like <tt>#kilograms</tt> to <tt>#render</tt>.
       def establish_units_methods
-        self.class.def_delegators :render, :u, :units
-        if conversions = Conversions.conversions[units.to_sym]
+        if characteristic and characteristic.measurement and conversions = Conversions.conversions[units.to_sym]
           self.class.def_delegators :render, *conversions.keys
         end
       end

data/lib/charisma/version.rb

@@ -1,4 +1,4 @@
 module Charisma
   # Charisma's version
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/test/charisma/curator_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+require File.expand_path('../support/spaceship', File.dirname(__FILE__))
+
+describe Charisma::Curator do
+  before do
+    @ship = Spaceship.new :window_count => 3, :weight => false
+    @curator = Charisma::Curator.new @ship
+  end
+
+  describe '#initialize' do
+    it 'stores the subject' do
+      @curator.subject.must_equal @ship
+    end
+    it "assigns any characteristics set on subject to the curation's characteristics" do
+      @curator.characteristics[:window_count].must_equal 3
+    end
+    it "assigns characteristics on subject set to `false`" do
+      @curator.characteristics[:weight].must_be_same_as false
+    end
+    it "does not assign nil characteristics" do
+      @curator.characteristics.keys.wont_include :size
+    end
+  end
+
+  describe '#characteristics' do
+    it 'returns a default value of a nil Curation for valid characteristics' do
+      @curator.characteristics[:size].value.must_be_nil
+    end
+  end
+end

data/test/helper.rb

@@ -1,77 +1,7 @@
 require 'bigdecimal'
 require 'rubygems'
 require 'test/unit'
-require 'supermodel'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'charisma'
-
-class Test::Unit::TestCase
-end
-
-class RelativeAstronomicMass < Charisma::Measurement # or don't inherit and provide everything yourself
-  units :hollagrams => 'hg' 
-  # before_ and after_ filters or some other reason to use this as opposed to Charisma::Measurements::Mass
-end
-
-class Spaceship < SuperModel::Base
-  attributes :window_count, :name, :size, :weight
-  belongs_to :make, :class_name => 'SpaceshipMake', :primary_key => 'name'
-  belongs_to :fuel, :class_name => 'SpaceshipFuel', :primary_key => 'name'
-  belongs_to :destination, :class_name => 'Planet', :primary_key => 'name'
-  
-  include Charisma
-  characterize do
-    has :make, :display_with => :name
-    has :fuel
-    has :window_count do |window_count|
-      "#{window_count} windows"
-    end
-  end
-  
-  characterize do
-    has :size, :measures => :length # uses Charisma::Measurements::Length
-    has :weight, :measures => RelativeAstronomicMass
-    has :name
-    has :destination
-    has :color
-  end
-end
-
-class SpaceshipMake < SuperModel::Base
-  has_many :spaceships
-  attributes :name
-  self.primary_key = :name 
-end
-
-class SpaceshipFuel < SuperModel::Base
-  has_many :spaceships
-  attributes :name, :emission_factor
-  self.primary_key = :name 
-  
-  def as_characteristic
-    "#{name} (#{emission_factor} kg CO2/L)"
-  end
-end
-
-class Planet < SuperModel::Base
-  has_many :spaceships
-  attributes :name
-  self.primary_key = :name 
-  
-  def to_s
-    name
-  end
-  
-  def mass
-    case name
-    when 'Pluto'
-      BigDecimal('1.31e+1_022')
-    else
-      raise "unknown"
-    end
-  end
-end
-
-Conversions.register :hollagrams, :supertons, 2

data/test/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bigdecimal'
+require 'rubygems'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'charisma'

data/test/support/planet.rb

@@ -0,0 +1,20 @@
+require 'supermodel'
+
+class Planet < SuperModel::Base
+  has_many :spaceships
+  attributes :name
+  self.primary_key = :name 
+  
+  def to_s
+    name
+  end
+  
+  def mass
+    case name
+    when 'Pluto'
+      BigDecimal('1.31e+1_022')
+    else
+      raise "unknown"
+    end
+  end
+end

data/test/support/relative_astronomic_mass.rb

@@ -0,0 +1,6 @@
+class RelativeAstronomicMass < Charisma::Measurement # or don't inherit and provide everything yourself
+  units :hollagrams => 'hg' 
+  # before_ and after_ filters or some other reason to use this as opposed to Charisma::Measurements::Mass
+end
+
+Conversions.register :hollagrams, :supertons, 2

data/test/support/spaceship.rb

@@ -0,0 +1,26 @@
+require 'supermodel'
+require File.expand_path('relative_astronomic_mass', File.dirname(__FILE__))
+
+class Spaceship < SuperModel::Base
+  attributes :window_count, :name, :size, :weight
+  belongs_to :make, :class_name => 'SpaceshipMake', :primary_key => 'name'
+  belongs_to :fuel, :class_name => 'SpaceshipFuel', :primary_key => 'name'
+  belongs_to :destination, :class_name => 'Planet', :primary_key => 'name'
+  
+  include Charisma
+  characterize do
+    has :make, :display_with => :name
+    has :fuel
+    has :window_count do |window_count|
+      "#{window_count} windows"
+    end
+  end
+  
+  characterize do
+    has :size, :measures => :length # uses Charisma::Measurements::Length
+    has :weight, :measures => RelativeAstronomicMass
+    has :name
+    has :destination
+    has :color
+  end
+end

data/test/support/spaceship_fuel.rb

@@ -0,0 +1,11 @@
+require 'supermodel'
+
+class SpaceshipFuel < SuperModel::Base
+  has_many :spaceships
+  attributes :name, :emission_factor
+  self.primary_key = :name 
+  
+  def as_characteristic
+    "#{name} (#{emission_factor} kg CO2/L)"
+  end
+end

data/test/support/spaceship_make.rb

@@ -0,0 +1,7 @@
+require 'supermodel'
+
+class SpaceshipMake < SuperModel::Base
+  has_many :spaceships
+  attributes :name
+  self.primary_key = :name 
+end

data/test/test_charisma.rb

@@ -1,78 +1,100 @@
-require 'helper'
+require File.expand_path('helper', File.dirname(__FILE__))
+
+require 'support/planet'
+require 'support/spaceship'
+require 'support/spaceship_fuel'
+require 'support/spaceship_make'
 
 class TestCharisma < Test::Unit::TestCase
   def test_001_simple_attribute_characteristic
     spaceship = Spaceship.new :name => 'Amaroq'
     assert_equal 'Amaroq', spaceship.characteristics[:name].to_s
   end
+  
   def test_002_measured_attribute
     spaceship = Spaceship.new :size => 10 # metres
     assert_equal '10 m', spaceship.characteristics[:size].to_s
   end
+  
   def test_003_classified_attribute
     spaceship = Spaceship.new :weight => 1_000_000 # hg
     assert_equal '1,000,000 hg', spaceship.characteristics[:weight].to_s
   end
+  
   def test_004_units
     spaceship = Spaceship.new :weight => '1000000.1' # kg
     assert_equal :hollagrams, spaceship.characteristics[:weight].units
     assert_equal 'hg', spaceship.characteristics[:weight].u
     assert_equal 2_000_000.2, spaceship.characteristics[:weight].supertons
   end
+  
   def test_005_attribute_with_custom_display
     spaceship = Spaceship.new :window_count => 10
     assert_equal '10 windows', spaceship.characteristics[:window_count].to_s
   end
+  
   def test_006_simple_association
     planet = Planet.create :name => 'Pluto'
     spaceship = Spaceship.new :destination => planet
     assert_equal 'Pluto', spaceship.characteristics[:destination].to_s
   end
+  
   def test_007_association_with_display_hint
     make = SpaceshipMake.create :name => 'Boeing'
     spaceship = Spaceship.new :make => make
     assert_equal 'Boeing', spaceship.characteristics[:make].to_s
   end
+  
   def test_008_association_with_prepared_display
     fuel = SpaceshipFuel.create :name => 'Kerosene', :emission_factor => 10
     spaceship = Spaceship.new :fuel => fuel
     assert_equal 'Kerosene (10 kg CO2/L)', spaceship.characteristics[:fuel].to_s
   end
+  
   def test_009_number_helper
     assert_equal '1,000', Charisma::NumberHelper.delimit(1_000)
   end
+  
   def test_010_characteristics_slice
     spaceship = Spaceship.new :name => 'Amaroq', :window_count => 2, :size => 10
     assert_equal '10 m', spaceship.characteristics.slice(:size, :window_count)[:size].to_s
     assert_equal nil, spaceship.characteristics.slice(:size, :window_count)[:name]
     assert_equal 2, spaceship.characteristics.slice(:size, :window_count).values.length
   end
+  
   def test_011_associated_object_methods
     planet = Planet.create :name => 'Pluto'
     spaceship = Spaceship.new :destination => planet
     assert_equal BigDecimal('1.31e+1_022'), spaceship.characteristics[:destination].mass
   end
+  
   def test_011_characteristic_arithmetic
     amaroq = Spaceship.new :window_count => 8
     geo = Spaceship.new :window_count => 6
     assert_equal 2, amaroq.characteristics[:window_count] - geo.characteristics[:window_count]
   end
-  def test_012_missing_characteristics_come_back_as_nil
+  
+  def test_012_missing_characteristics_can_still_be_accessed
     spaceship = Spaceship.new :name => 'Amaroq'
-    assert_equal nil, spaceship.characteristics[:size]
+    assert_equal Charisma::Curator::Curation, spaceship.characteristics[:size].class
+    assert_equal nil, spaceship.characteristics[:size].value
   end
+  
   def test_013_characteristics_keys
     spaceship = Spaceship.new :name => 'Amaroq'
     assert_equal [:name].sort_by { |k| k.to_s }, spaceship.characteristics.keys.sort_by { |k| k.to_s }
   end
+  
   def test_014_characterization_keys
     assert_equal [:color, :destination, :fuel, :make, :name, :size, :weight, :window_count].sort_by { |k| k.to_s }, Spaceship.characterization.keys.sort_by { |k| k.to_s }
   end
+  
   def test_015_characteristic_equality
     amaroq = Spaceship.new :window_count => 8
     buster = Spaceship.new :window_count => 8
     assert_equal amaroq.characteristics, buster.characteristics
   end
+  
   def test_016_inspection_of_undefined_characteristic
     muktruk = Spaceship.new
     muktruk.characteristics[:bumper_sticker] = 'LT'
@@ -80,6 +102,7 @@ class TestCharisma < Test::Unit::TestCase
       muktruk.characteristics[:bumper_sticker].inspect
     end
   end
+  
   def test_017_each
     spaceship = Spaceship.new :name => 'Amaroq'
     catch :blam do
@@ -89,14 +112,36 @@ class TestCharisma < Test::Unit::TestCase
       flunk
     end
   end
+  
   def test_018_double_bag
     geo = SpaceshipMake.create :name => 'Geo'
     g = Spaceship.new :make => geo
     g.characteristics[:name] = g.characteristics[:make]
     assert_equal 'Geo', g.characteristics[:name].to_s
   end
+  
   def test_019_compare_fixnum
     amaroq = Spaceship.new :window_count => 8
     assert(amaroq.characteristics == { :window_count => 8 })
   end
+  
+  def test_020_to_hash
+    spaceship = Spaceship.new :name => 'Amaroq', :window_count => 2, :size => 10
+    assert_equal({:name => 'Amaroq', :window_count => '2 windows', :size => '10 m'}, spaceship.characteristics.to_hash)
+  end
+  
+  def test_021_dup
+    spaceship = Spaceship.new :name => 'Amaroq'
+    initial_characteristics = spaceship.characteristics.dup
+    assert_equal [:name], initial_characteristics.keys
+    spaceship.characteristics[:window_count] = 2
+    assert_equal [:name], initial_characteristics.keys
+    assert_equal [:name, :window_count], spaceship.characteristics.keys
+  end
+  
+  def test_022_nil_units
+    spaceship = Spaceship.new
+    assert_equal nil, spaceship.characteristics[:name].units
+    assert_equal :hollagrams, spaceship.characteristics[:weight].units
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charisma
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-06 00:00:00.000000000Z
+date: 2011-09-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2154378400 !ruby/object:Gem::Requirement
+  requirement: &2158256360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154378400
+  version_requirements: *2158256360
 - !ruby/object:Gem::Dependency
   name: blockenspiel
-  requirement: &2154377600 !ruby/object:Gem::Requirement
+  requirement: &2158255680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154377600
+  version_requirements: *2158255680
 - !ruby/object:Gem::Dependency
   name: conversions
-  requirement: &2154376900 !ruby/object:Gem::Requirement
+  requirement: &2158250620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154376900
+  version_requirements: *2158250620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154376460 !ruby/object:Gem::Requirement
+  requirement: &2158250040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154376460
+  version_requirements: *2158250040
 - !ruby/object:Gem::Dependency
   name: bueller
-  requirement: &2154376040 !ruby/object:Gem::Requirement
+  requirement: &2158249400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154376040
+  version_requirements: *2158249400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154375600 !ruby/object:Gem::Requirement
+  requirement: &2158248760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154375600
+  version_requirements: *2158248760
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2154375180 !ruby/object:Gem::Requirement
+  requirement: &2158248140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154375180
+  version_requirements: *2158248140
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &2154374740 !ruby/object:Gem::Requirement
+  requirement: &2158247460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154374740
+  version_requirements: *2158247460
 description: Define strategies for accessing and displaying a subset of your classes'
   attributes
 email: andy@rossmeissl.net
@@ -130,7 +130,14 @@ files:
 - lib/charisma/measurement/time.rb
 - lib/charisma/number_helper.rb
 - lib/charisma/version.rb
+- test/charisma/curator_spec.rb
 - test/helper.rb
+- test/spec_helper.rb
+- test/support/planet.rb
+- test/support/relative_astronomic_mass.rb
+- test/support/spaceship.rb
+- test/support/spaceship_fuel.rb
+- test/support/spaceship_make.rb
 - test/test_charisma.rb
 homepage: http://github.com/brighterplanet/charisma
 licenses: []
@@ -146,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2414637371029360902
+      hash: -4326195820228354583
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,5 +167,12 @@ signing_key:
 specification_version: 3
 summary: Curate your rich Ruby objects' attributes
 test_files:
+- test/charisma/curator_spec.rb
 - test/helper.rb
+- test/spec_helper.rb
+- test/support/planet.rb
+- test/support/relative_astronomic_mass.rb
+- test/support/spaceship.rb
+- test/support/spaceship_fuel.rb
+- test/support/spaceship_make.rb
 - test/test_charisma.rb