characterizable 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Seamus Abshere
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= characterizable
+
+"Cognitive mechanisms, on this view, take mathematically characterizable inputs to deliver mathematically characterizable outputs, and qua computational devices, that is all."
+
+http://tinyurl.com/28tcrw2
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "characterizable"
+    gem.summary = %Q{Characterize instances of a class}
+    gem.description = %Q{Characterize the relationship between "attributes" (getters/setters) of instances of a class}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/characterizable"
+    gem.authors = ["Andy Rossmeissl", "Seamus Abshere"]
+    gem.add_dependency 'blockenspiel', '>=0.3.2'
+    gem.add_dependency 'activesupport', '>=2.3.5'
+    gem.add_development_dependency 'activerecord', '>=2.3.5'
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "characterizable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/characterizable.rb

@@ -0,0 +1,123 @@
+require 'blockenspiel'
+require 'active_support'
+require 'active_support/version'
+%w{
+  active_support/core_ext/class/attribute_accessors
+  active_support/core_ext/object/blank
+  active_support/core_ext/array/wrap
+  active_support/core_ext/module/aliasing
+  active_support/core_ext/module/delegation
+}.each do |active_support_3_requirement|
+  require active_support_3_requirement
+end if ActiveSupport::VERSION::MAJOR == 3
+
+module Characterizable
+  def self.included(klass)
+    klass.cattr_accessor :characterizable_base
+    klass.extend ClassMethods
+  end
+  
+  def known_characteristics
+    characterizable_base.characteristics.select do |c|
+      c.known?(self) and not c.trumped?(self)
+    end
+  end
+  
+  def unknown_characteristics
+    characterizable_base.characteristics.select do |c|
+      c.unknown?(self) and c.requited?(self) and not c.trumped?(self)
+    end
+  end
+  
+  def visible_known_characteristics
+    known_characteristics.reject { |c| c.hidden? }
+  end
+  
+  def visible_unknown_characteristics
+    unknown_characteristics.reject { |c| c.hidden? }
+  end
+  
+  module ClassMethods
+    def characterize(&block)
+      self.characterizable_base = Characterizable::Base.new self
+      Blockenspiel.invoke block, characterizable_base
+    end
+    delegate :characteristics, :to => :characterizable_base
+  end
+  
+  # don't want to use a Hash, because that would be annoying to select from
+  class ArrayOfCharacteristics < Array
+    def [](key_or_index)
+      case key_or_index
+      when String, Symbol
+        detect { |c| c.name == key_or_index }
+      else
+        super
+      end
+    end
+  end
+  
+  class Base
+    attr_reader :klass
+    def initialize(klass)
+      @klass = klass
+    end
+    def characteristics
+      @_characteristics ||= ArrayOfCharacteristics.new
+    end
+    include Blockenspiel::DSL
+    def has(name, options = {}, &block)
+      characteristics.push Characteristic.new(self, name, options, &block)
+    end
+  end
+  
+  class Characteristic
+    attr_reader :base
+    attr_reader :name
+    attr_reader :trumps
+    attr_reader :prerequisite
+    attr_reader :hidden
+    attr_reader :options
+    def initialize(base, name, options = {}, &block)
+      @base = base
+      @name = name.to_sym
+      @trumps = Array.wrap(options.delete(:trumps))
+      @prerequisite = options.delete :prerequisite
+      @hidden = options.delete :hidden
+      @options = options
+      Blockenspiel.invoke block, self if block_given?
+    end
+    delegate :characteristics, :to => :base
+    def unknown?(obj)
+      obj.send(name).nil?
+    end
+    def known?(obj)
+      not unknown?(obj)
+    end
+    def trumped?(obj)
+      characteristics.any? do |c|
+        c.known?(obj) and c.trumps.include?(name)
+      end
+    end
+    def requited?(obj)
+      return true if prerequisite.nil?
+      characteristics[prerequisite].known? obj
+    end
+    def hidden?
+      hidden
+    end
+    include Blockenspiel::DSL
+    def reveals(other_name, other_options = {}, &block)
+      base.has other_name, other_options.merge(:prerequisite => name), &block
+      base.klass.module_eval %{
+        def #{name}_with_dependent_#{other_name}=(new_#{name})
+          if new_#{name}.nil?
+            self.#{other_name} = nil
+          end
+          self.#{name}_without_dependent_#{other_name} = new_#{name}
+        end
+        alias_method_chain :#{name}=, :dependent_#{other_name}
+      }, __FILE__, __LINE__
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'ruby-debug'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'characterizable'
+
+class Test::Unit::TestCase
+end

data/test/test_characterizable.rb

@@ -0,0 +1,123 @@
+require 'helper'
+
+# TODO
+class Automobile
+  attr_accessor :make, :model_year, :model, :variant, :size_class, :hybridity, :daily_distance_estimate
+  attr_accessor :record_creation_date
+  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 :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_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
+
+class SimpleAutomobile
+  include Characterizable
+  attr_accessor :make
+  attr_accessor :model
+  attr_accessor :variant
+  characterize do
+    has :make
+    has :model
+    has :variant, :trumps => :model
+  end
+end
+
+class TestCharacterizable < Test::Unit::TestCase
+  should "let you define the relevant characteristics of a class" do
+    assert_nothing_raised do
+      class OnDemandAutomobile
+        include Characterizable
+        characterize do
+          has :make
+          has :model
+        end
+      end
+    end
+  end
+
+  should "tell you what characteristics are known" do
+    a = SimpleAutomobile.new
+    a.make = 'Ford'
+    assert_equal [:make], a.known_characteristics.map(&:name)
+  end
+
+  should "tell you what characteristics are unknown" do
+    a = SimpleAutomobile.new
+    a.make = 'Ford'
+    assert_equal [:model, :variant], a.unknown_characteristics.map(&:name)
+  end
+
+  should "present a concise set of known characteristics by getting rid of those that have been trumped" do
+    a = SimpleAutomobile.new
+    a.make = 'Ford'
+    a.model = 'Taurus'
+    a.variant = 'Taurus V6 DOHC'
+    assert_equal [:make, :variant], a.known_characteristics.map(&:name)
+  end
+
+  should "not mention a characteristic as unknown if, in fact, it has been trumped" do
+    a = SimpleAutomobile.new
+    a.make = 'Ford'
+    a.variant = 'Taurus V6 DOHC'
+    assert_equal [], a.unknown_characteristics.map(&:name)
+  end
+
+  should "not mention a characteristic as unknown if it is waiting on something else to be revealed" do
+    a = Automobile.new
+    assert !a.unknown_characteristics.map(&:name).include?(:model_year)
+  end
+
+  should "make sure that trumping works even within revealed characteristics" do
+    a = Automobile.new
+    assert a.unknown_characteristics.map(&:name).include?(:size_class)
+    a.make = 'Ford'
+    a.model_year = 1999
+    a.model = 'Taurus'
+    a.size_class = 'mid-size'
+    assert_equal [:model, :model_year, :make], a.known_characteristics.map(&:name)
+    assert !a.unknown_characteristics.map(&:name).include?(:size_class)
+  end
+
+  should "enforce prerequisites by using an object's setter" do
+    a = Automobile.new
+    a.make = 'Ford'
+    a.model_year = 1999
+    a.make = nil
+    assert_equal nil, a.model_year
+  end
+  
+  should "keep user-defined options on a characteristic" do
+    assert_equal :length, Automobile.characteristics[:daily_distance_estimate].options[:measures]
+  end
+  
+  should "not confuse user-defined options with other options" do
+    assert !Automobile.characteristics[:daily_distance_estimate].options.has_key?(:trumps)
+  end
+  
+  should "know which characteristics are 'visible'" do
+    a = Automobile.new
+    assert a.unknown_characteristics.map(&:name).include?(:record_creation_date)
+    assert !a.visible_unknown_characteristics.map(&:name).include?(:record_creation_date)
+    a.record_creation_date = 'yesterday'
+    assert a.known_characteristics.map(&:name).include?(:record_creation_date)
+    assert !a.visible_known_characteristics.map(&:name).include?(:record_creation_date)
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: characterizable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Andy Rossmeissl
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: blockenspiel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Characterize the relationship between "attributes" (getters/setters) of instances of a class
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/characterizable.rb
+- test/helper.rb
+- test/test_characterizable.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/characterizable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Characterize instances of a class
+test_files: 
+- test/helper.rb
+- test/test_characterizable.rb