charisma 0.0.1 → 0.1.0

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-03-21'
+  s.date = "2011-03-22"
   s.authors = ['Andy Rossmeissl', 'Seamus Abshere']
   s.email = 'andy@rossmeissl.net'
   s.homepage = 'http://github.com/brighterplanet/charisma'
@@ -24,10 +24,16 @@ Gem::Specification.new do |s|
   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

@@ -1,3 +1,39 @@
+require 'active_support'
+require 'active_support/version'
+%w{
+  active_support/inflector/methods
+  active_support/core_ext/class/attribute_accessors
+  active_support/core_ext/string/output_safety
+  active_support/core_ext/module/delegation
+}.each do |active_support_3_requirement|
+  require active_support_3_requirement
+end if ActiveSupport::VERSION::MAJOR == 3
+
+require 'action_pack'
+require 'active_support/version'
+%w{
+  action_view/helpers/number_helper
+}.each do |action_pack_3_requirement|
+  require action_pack_3_requirement
+end if ActionPack::VERSION::MAJOR == 3
+
+require 'blockenspiel'
+require 'conversions'
+
+require 'charisma/base'
+require 'charisma/base/class_methods'
+require 'charisma/characteristic'
+require 'charisma/characterization'
+require 'charisma/measurement'
+require 'charisma/measurement/length'
+require 'charisma/curator'
+require 'charisma/curator/curation'
+require 'charisma/number_helper'
+
+
 module Charisma
-  # Your code goes here...
+  def self.included(base)
+    base.send :include, Base
+    base.extend Base::ClassMethods
+  end
 end

data/lib/charisma/base.rb

@@ -0,0 +1,9 @@
+module Charisma
+  module Base
+    def characteristics
+      @curator ||= Curator.new(self)
+    end
+  end
+  
+  class InvalidMeasurementError < StandardError; end
+end

data/lib/charisma/base/class_methods.rb

@@ -0,0 +1,14 @@
+module Charisma
+  module Base
+    module ClassMethods
+      def self.extended(base)
+        base.send :class_variable_set, :@@characterization, Characterization.new
+        base.send :cattr_reader, :characterization
+      end
+      def characterize(&blk)
+        Blockenspiel.invoke(blk, characterization) if block_given?
+      end
+    end
+  end
+end
+

data/lib/charisma/characteristic.rb

@@ -0,0 +1,12 @@
+module Charisma
+  class Characteristic
+    attr_reader :name, :proc, :accessor, :measurement
+    
+    def initialize(name, options, &blk)
+      @name = name
+      @proc = blk if block_given?
+      @accessor = options[:display_with]
+      @measurement = options[:measures]
+    end
+  end
+end

data/lib/charisma/characterization.rb

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

data/lib/charisma/curator.rb

@@ -0,0 +1,11 @@
+module Charisma
+  class Curator
+    def initialize(base)
+      @subject = base
+    end
+    
+    def [](name)
+      Curation.new @subject.send(name), @subject.class.characterization[name]
+    end
+  end
+end

data/lib/charisma/curator/curation.rb

@@ -0,0 +1,65 @@
+module Charisma
+  class Curator
+    class Curation
+      attr_reader :value, :characteristic
+      
+      def initialize(value, characteristic)
+        @value = value
+        @characteristic = characteristic
+      end
+      
+      delegate :to_s, :units, :u, :to => :render
+      
+      def method_missing(*args)
+        begin
+          render.send(*args)
+        rescue NoMethodError
+          super
+        end
+      end
+      
+      private
+      
+      def render
+        if characteristic.proc
+          render_proc
+        elsif characteristic.accessor
+          use_accessor
+        elsif characteristic.measurement
+          defer_to_measurement
+        elsif value.respond_to? :as_characteristic
+          defer_to_value
+        else
+          render_value
+        end
+      end
+      
+      def render_proc
+        characteristic.proc.call(value)
+      end
+      
+      def use_accessor
+        value.send(characteristic.accessor)
+      end
+      
+      def defer_to_measurement
+        case characteristic.measurement
+        when Class
+          characteristic.measurement.new(value)
+        when Symbol
+          "Charisma::Measurement::#{characteristic.measurement.to_s.camelize}".constantize.new(value)
+        else
+          raise InvalidMeasurementError
+        end
+      end
+      
+      def defer_to_value
+        value.as_characteristic
+      end
+      
+      def render_value
+        value
+      end
+    end
+  end
+end

data/lib/charisma/measurement.rb

@@ -0,0 +1,47 @@
+module Charisma
+  class Measurement
+    attr_reader :value
+    
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      "#{NumberHelper.delimit value} #{u}"
+    end
+    
+    def to_f
+      value.to_f
+    end
+    
+    def units
+      self.class.unit
+    end
+    
+    def u
+      self.class.unit_abbreviation
+    end
+    
+    def method_missing(*args)
+      if Conversions.conversions[units.to_sym][args.first]
+        to_f.send(units.to_sym).to(args.first)
+      else
+        super
+      end
+    end
+    
+    class << self
+      def units(units)
+        @units, @units_abbreviation = units.to_a.flatten
+      end
+      
+      def unit
+        @units
+      end
+      
+      def unit_abbreviation
+        @units_abbreviation
+      end
+    end
+  end
+end

data/lib/charisma/measurement/length.rb

@@ -0,0 +1,7 @@
+module Charisma
+  class Measurement
+    class Length < Measurement
+      units :meters => 'm'
+    end
+  end
+end

data/lib/charisma/number_helper.rb

@@ -0,0 +1,9 @@
+module Charisma
+  class NumberHelper
+    extend ActionView::Helpers::NumberHelper
+    
+    def self.delimit(number)
+      number_with_delimiter number, :delimiter => ",", :separator => "."
+    end
+  end
+end

data/lib/charisma/version.rb

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

data/test/helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'test/unit'
+require 'supermodel'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -7,3 +8,56 @@ 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

data/test/test_charisma.rb

@@ -1,7 +1,41 @@
 require 'helper'
 
 class TestCharisma < Test::Unit::TestCase
-  def test_something_for_real
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: charisma
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -16,13 +16,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-21 00:00:00 -04:00
+date: 2011-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: bundler
-  type: :development
+  name: activesupport
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,8 +35,8 @@ dependencies:
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: bueller
-  type: :development
+  name: actionpack
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -49,8 +49,8 @@ dependencies:
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: rake
-  type: :development
+  name: blockenspiel
+  type: :runtime
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -63,8 +63,8 @@ dependencies:
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: rcov
-  type: :development
+  name: conversions
+  type: :runtime
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,6 +75,76 @@ dependencies:
         - 0
         version: "0"
   requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bueller
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rake
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: supermodel
+  type: :development
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
 description: Define strategies for accessing and displaying a subset of your classes' attributes
 email: andy@rossmeissl.net
 executables: []
@@ -93,6 +163,15 @@ files:
 - Rakefile
 - charisma.gemspec
 - lib/charisma.rb
+- lib/charisma/base.rb
+- lib/charisma/base/class_methods.rb
+- lib/charisma/characteristic.rb
+- lib/charisma/characterization.rb
+- lib/charisma/curator.rb
+- lib/charisma/curator/curation.rb
+- lib/charisma/measurement.rb
+- lib/charisma/measurement/length.rb
+- lib/charisma/number_helper.rb
 - lib/charisma/version.rb
 - test/helper.rb
 - test/test_charisma.rb