charisma 0.1.0 → 0.1.1

data/charisma.gemspec

@@ -1,39 +1,39 @@
-$:.push File.expand_path("../lib", __FILE__)
-require 'charisma/version'
-
-Gem::Specification.new do |s|
-  s.name = 'charisma'
-  s.version = Charisma::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.date = "2011-03-22"
-  s.authors = ['Andy Rossmeissl', 'Seamus Abshere']
-  s.email = 'andy@rossmeissl.net'
-  s.homepage = 'http://github.com/brighterplanet/charisma'
-  s.summary = %Q{Curate your rich Ruby objects' attributes}
-  s.description = %Q{Define strategies for accessing and displaying a subset of your classes' attributes}
-  s.extra_rdoc_files = [
-    'LICENSE',
-    'README.rdoc',
-  ]
-
-  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
-  s.rubygems_version = '1.3.7'
-  s.specification_version = 3
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-  
-  s.add_dependency 'activesupport'
-  s.add_dependency 'actionpack'
-  s.add_dependency 'blockenspiel'
-  s.add_dependency 'conversions'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bueller'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rcov'
-  s.add_development_dependency 'supermodel'
-end
-
+$:.push File.expand_path("../lib", __FILE__)
+require 'charisma/version'
+
+Gem::Specification.new do |s|
+  s.name = 'charisma'
+  s.version = Charisma::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = "2011-04-29"
+  s.authors = ['Andy Rossmeissl', 'Seamus Abshere']
+  s.email = 'andy@rossmeissl.net'
+  s.homepage = 'http://github.com/brighterplanet/charisma'
+  s.summary = %Q{Curate your rich Ruby objects' attributes}
+  s.description = %Q{Define strategies for accessing and displaying a subset of your classes' attributes}
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.rdoc',
+  ]
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
+  s.rubygems_version = '1.3.7'
+  s.specification_version = 3
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  s.add_dependency 'activesupport'
+  s.add_dependency 'actionpack'
+  s.add_dependency 'blockenspiel'
+  s.add_dependency 'conversions'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'bueller'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'supermodel'
+end
+

data/lib/charisma.rb

@@ -10,7 +10,7 @@ require 'active_support/version'
 end if ActiveSupport::VERSION::MAJOR == 3
 
 require 'action_pack'
-require 'active_support/version'
+require 'action_pack/version'
 %w{
   action_view/helpers/number_helper
 }.each do |action_pack_3_requirement|
@@ -30,7 +30,6 @@ require 'charisma/curator'
 require 'charisma/curator/curation'
 require 'charisma/number_helper'
 
-
 module Charisma
   def self.included(base)
     base.send :include, Base

data/lib/charisma/characterization.rb

@@ -1,19 +1,9 @@
 module Charisma
-  class Characterization
-    attr_reader :characteristics
-    
-    def initialize
-      @characteristics = {}
-    end
-    
-    def [](name)
-      characteristics[name]
-    end
-    
+  class Characterization < Hash    
     include Blockenspiel::DSL
     def has(name, options = {}, &blk)
       name = name.to_sym
-      characteristics[name] = Characteristic.new(name, options, &blk)
+      self[name] = Characteristic.new(name, options, &blk)
     end
   end
 end

data/lib/charisma/curator.rb

@@ -1,11 +1,39 @@
 module Charisma
   class Curator
-    def initialize(base)
-      @subject = base
+    attr_reader :subject
+    
+    def initialize(subject)
+      @subject = subject
+    end
+        
+    def [](key)
+      if value = subject.send(key)
+        Curation.new value, subject.class.characterization[key]
+      end
+    end
+        
+    def keys
+      subject.class.characterization.keys.select do |key|
+        !!subject.send(key)
+      end
+    end
+
+    def slice(*only_keys)
+      only_keys.inject({}) do |memo, key|
+        if curation = self[key]
+          memo[key] = curation
+        end
+        memo
+      end
     end
     
-    def [](name)
-      Curation.new @subject.send(name), @subject.class.characterization[name]
+    def to_hash
+      subject.class.characterization.keys.inject({}) do |memo, key|
+        if curation = self[key]
+          memo[key] = curation
+        end
+        memo        
+      end
     end
   end
 end

data/lib/charisma/number_helper.rb

@@ -1,3 +1,6 @@
+require 'action_pack'
+require 'action_view'
+
 module Charisma
   class NumberHelper
     extend ActionView::Helpers::NumberHelper

data/lib/charisma/version.rb

@@ -1,3 +1,3 @@
-module Charisma
-  VERSION = "0.1.0"
-end
+module Charisma
+  VERSION = "0.1.1"
+end

data/test/helper.rb

@@ -1,63 +1,73 @@
-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
-  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
-    has :size, :measures => :length # uses Charisma::Measurements::Length
-    has :weight, :measures => RelativeAstronomicMass
-    has :name
-    has :destination
-  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
-end
-
-Conversions.register :hollagrams, :supertons, 2
+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
+    has :size, :measures => :length # uses Charisma::Measurements::Length
+    has :weight, :measures => RelativeAstronomicMass
+    has :name
+    has :destination
+  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/test_charisma.rb

@@ -1,41 +1,70 @@
-require 'helper'
-
-class TestCharisma < Test::Unit::TestCase
-  def test_simple_attribute_characteristic
-    spaceship = Spaceship.new :name => 'Amaroq'
-    assert_equal 'Amaroq', spaceship.characteristics[:name].to_s
-  end
-  def test_measured_attribute
-    spaceship = Spaceship.new :size => 10 # meters
-    assert_equal '10 m', spaceship.characteristics[:size].to_s
-  end
-  def test_classified_attribute
-    spaceship = Spaceship.new :weight => 1_000_000 # hg
-    assert_equal '1,000,000 hg', spaceship.characteristics[:weight].to_s
-  end
-  def test_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_attribute_with_custom_display
-    spaceship = Spaceship.new :window_count => 10
-    assert_equal '10 windows', spaceship.characteristics[:window_count].to_s
-  end
-  def test_simple_association
-    planet = Planet.create :name => 'Pluto'
-    spaceship = Spaceship.new :destination => planet
-    assert_equal 'Pluto', spaceship.characteristics[:destination].to_s
-  end
-  def test_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_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
-end
+require 'helper'
+
+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 # meters
+    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'
+    assert_equal 'Amaroq', spaceship.characteristics.slice(:name)[:name].to_s
+  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_012_missing_characteristics_come_back_as_nil
+    spaceship = Spaceship.new :name => 'Amaroq'
+    assert_equal nil, spaceship.characteristics[:size]
+  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 }
+    spaceship.weight = 1_000_000
+    assert_equal [:name, :weight].sort_by { |k| k.to_s }, spaceship.characteristics.keys.sort_by { |k| k.to_s }
+  end
+  def test_014_characterization_keys
+    assert_equal [: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_to_hash_preserving_curation
+    spaceship = Spaceship.new :name => 'Amaroq'
+    assert_equal 'Amaroq', spaceship.characteristics.to_hash[:name].to_s
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: charisma
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-22 00:00:00 -04:00
+date: 2011-04-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency