emitter 0.5.0 → 0.5.1

data/Gemfile

@@ -1,3 +1,12 @@
+gem 'sniff', :path => ENV['LOCAL_SNIFF'] if ENV['LOCAL_SNIFF']
+gem 'data_miner', :path => ENV['LOCAL_DATA_MINER'] if ENV['LOCAL_DATA_MINER']
+gem 'earth', :path => ENV['LOCAL_EARTH'] if ENV['LOCAL_EARTH']
+gem 'create_table', :path => ENV['LOCAL_CREATE_TABLE'] if ENV['LOCAL_CREATE_TABLE']
+
 source :rubygems
 
-gemspec
+gemspec :path => '.'
+
+if RUBY_VERSION < "1.9"
+  gem 'fastercsv'
+end

data/emitter.gemspec

@@ -4,7 +4,7 @@ require "emitter/version"
 
 Gem::Specification.new do |s|
   s.name        = 'emitter'
-  s.version = Emitter::VERSION
+  s.version     = Emitter::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Andy Rossmeissl", "Seamus Abshere", "Ian Hough", "Matt Kling", 'Derek Kastner']
   s.email       = %q{derek@brighterplanet.com}
@@ -17,17 +17,18 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', '>=2.3.4'
-  s.add_dependency 'charisma', '>=0.3.0'
+  s.add_dependency 'activesupport', '>=2.3.10'
+  s.add_dependency 'charisma'
   s.add_dependency 'cohort_scope'
-  s.add_dependency 'data_miner', '>=1.1' unless ENV['LOCAL_DATA_MINER']
-  s.add_dependency 'earth' unless ENV['LOCAL_EARTH']
-  s.add_dependency 'falls_back_on' unless ENV['LOCAL_FALLS_BACK_ON']
-  s.add_dependency 'leap' unless ENV['LOCAL_LEAP']
+  s.add_dependency 'data_miner', '>=1.2.1' unless ENV['LOCAL_DATA_MINER']
+  s.add_dependency 'earth', '>=0.5.1' unless ENV['LOCAL_EARTH']
+  s.add_dependency 'falls_back_on'
+  s.add_dependency 'leap'
   s.add_dependency 'summary_judgement'
   s.add_dependency 'timeframe'
   s.add_dependency 'weighted_average'
+  s.add_dependency 'create_table' unless ENV['LOCAL_CREATE_TABLE']
   s.add_development_dependency 'activerecord', '~>3'
   s.add_development_dependency 'bueller'
-  s.add_development_dependency 'sniff'
+  s.add_development_dependency 'sniff', '>=0.8.2' unless ENV['LOCAL_SNIFF']
 end

data/lib/emitter.rb

@@ -1,9 +1,14 @@
+require 'active_support'
+require 'active_support/core_ext'
 require 'leap'
 require 'cohort_scope'
 require 'charisma'
 require 'data_miner'
 require 'summary_judgement'
 require 'falls_back_on'
+require 'create_table'
+
+require 'emitter/measurement'
 
 module BrighterPlanet
   module Emitter
@@ -15,10 +20,17 @@ module BrighterPlanet
       summarization
     }
     
+    # "included" not "self.included"
+    # why?
+    # This module **extends other modules**
+    # it forcibly (over)writes their definitions of self.included
+    # BrighterPlanet::AutomobileTrip.extend(Emitter) -> now BrighterPlanet::AutomobileTrip has self.included
+    # MyAutomobileTrip.include(BrighterPlanet::AutomobileTrip) -> will call BrighterPlanet::AutomobileTrip.included(MyAutomobileTrip)
     def included(base)
       base.extend ClassMethods
-      
-      common_name = self.to_s.split('::').last.underscore
+
+      # here self is the emitter module
+      common_name = self.name.demodulize.underscore
       common_camel = common_name.camelcase
 
       REQUIRED_COMPONENTS.each do |component|
@@ -32,9 +44,24 @@ module BrighterPlanet
 
       base.send :include, ::Charisma
       base.send :include, "::BrighterPlanet::#{common_camel}::Characterization".constantize
-      base._add_implicit_characteristics
+      base.class_eval do
+        preexisting = characterization.keys
+        decisions[:emission].committees.reject do |committee|
+          committee.name == :emission or preexisting.include?(committee.name)
+        end.each do |committee|
+          characterize do
+            has committee.name, :options => committee.options.slice(:measures, :display_with)
+          end
+        end
+      end
 
       base.send :include, "::BrighterPlanet::#{common_camel}::Data".constantize
+      unless base.data_miner_config.steps.any? { |step| step.description == :create_table! }
+        base.data_miner_config.steps.unshift ::DataMiner::Process.new(base.data_miner_config, :create_table!)
+      end
+      unless base.data_miner_config.steps.any? { |step| step.description == :run_data_miner_on_parent_associations! }
+        base.data_miner_config.steps.push ::DataMiner::Process.new(base.data_miner_config, :run_data_miner_on_parent_associations!)
+      end
 
       base.extend ::SummaryJudgement
       base.send :include, "::BrighterPlanet::#{common_camel}::Summarization".constantize
@@ -48,24 +75,17 @@ module BrighterPlanet
 
       base.send :include, "::BrighterPlanet::#{common_camel}::Relationships".constantize
     end
-        
+
+    # this gets added as a class method to the emitter module
     def scope(statement)
       @emission_scope = statement
     end
         
     module ClassMethods
-      def _add_implicit_characteristics
-        preexisting = characterization.keys
-        decisions[:emission].committees.reject do |committee|
-          committee.name == :emission or preexisting.include?(committee.name)
-        end.each do |committee|
-          characterize do
-            has committee.name, :options => committee.options.slice(:measures, :display_with)
-          end
-        end
+      # this will have been set by self.included on the emitter module
+      def emission_scope
+        @emission_scope
       end
-            
-      def emission_scope; @emission_scope end
     end
   end
 end

data/lib/emitter/measurement.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+# defined by charisma:
+# length kilometres (see below)
+# mass kilograms
+# speed metres_per_second (see below)
+# time seconds
+
+module BrighterPlanet
+  module Measurement
+    class Area < ::Charisma::Measurement
+      units :square_metres => 'm²'
+    end
+    
+    class Biomass < ::Charisma::Measurement
+      units :joules => 'J'
+    end
+    
+    class Cost < ::Charisma::Measurement
+      units :dollars => 'USD'
+    end
+
+    class ElectricalEnergy < ::Charisma::Measurement
+      units :kilowatt_hours => 'kWh'
+    end
+    
+    class Volume < ::Charisma::Measurement
+      units :litres => 'l'
+    end
+    
+    # TODO use charisma default
+    class BigLength < ::Charisma::Measurement
+      units :kilometres => 'km'
+    end
+
+    # TODO units :metres_per_litre => 'm/l'
+    class BigLengthPerVolume < ::Charisma::Measurement
+      units :kilometres_per_litre => 'km/l'
+    end
+    
+    # TODO use charisma default
+    class BigSpeed < ::Charisma::Measurement
+      units :kilometres_per_hour => 'km/h'
+    end
+  end
+end

data/lib/emitter/version.rb

@@ -1,3 +1,3 @@
 module Emitter
-  VERSION = '0.5.0'
+  VERSION = "0.5.1"
 end

data/spec/emitter_spec.rb

@@ -10,7 +10,7 @@ describe BrighterPlanet::Emitter do
       $:.unshift File.expand_path('fixtures/dirigible/lib', File.dirname(__FILE__))
       require 'dirigible'
       Airship.send :include, BrighterPlanet::Dirigible
-      Airship.execute_schema
+      Airship.create_table!
 
       $:.unshift File.expand_path('fixtures/biplane/lib', File.dirname(__FILE__))
     end
@@ -35,6 +35,19 @@ describe BrighterPlanet::Emitter do
     it 'should state its own scope' do
       Airship.emission_scope.should == 'Anthropogenic emissions resulting from the inflation, launching, and acceleration of dirigibles'
     end
+    
+    it 'should have extra data_miner steps' do
+      Airship.data_miner_config.steps[0].description.should == :create_table!
+      Airship.data_miner_config.steps[1].description.should == "the first step defined in the emitter module"
+      Airship.data_miner_config.steps[2].description.should == :run_data_miner_on_parent_associations!
+    end
+    
+    it 'should have units' do
+      a = Airship.new :distance => 1500, :surface_area => 200, :payload => 1000
+      a.characteristics[:distance].units.to_s[0..2].should == 'met' # meters or metres
+      a.characteristics[:payload].units.should == :kilograms
+      a.characteristics[:surface_area].units.should == :square_metres
+    end
   end
 end
 

data/spec/fixtures/biplane/lib/biplane/characterization.rb

@@ -3,8 +3,8 @@ module BrighterPlanet
     module Characterization
       def self.included(base)
         base.characterize do
-          has :distance
-          has :payload
+          has :distance, :measures => :length
+          has :payload, :measures => :mass
           has :dirigible_class
         end
       end

data/spec/fixtures/biplane/lib/biplane/data.rb

@@ -2,14 +2,10 @@ module BrighterPlanet
   module Biplane
     module Data
       def self.included(base)
-        base.data_miner do
-          schema do
-            float :distance
-            float :payload
-            integer :dirigible_class_id
-          end
-
-          process :run_data_miner_on_belongs_to_associations
+        base.create_table do
+          float :distance
+          float :payload
+          integer :dirigible_class_id
         end
       end
     end

data/spec/fixtures/dirigible/lib/dirigible/characterization.rb

@@ -3,8 +3,9 @@ module BrighterPlanet
     module Characterization
       def self.included(base)
         base.characterize do
-          has :distance
-          has :payload
+          has :distance, :measures => :length
+          has :payload, :measures => :mass
+          has :surface_area, :measures => Measurement::Area
           has :dirigible_class
         end
       end

data/spec/fixtures/dirigible/lib/dirigible/data.rb

@@ -2,14 +2,17 @@ module BrighterPlanet
   module Dirigible
     module Data
       def self.included(base)
+        base.create_table do
+          float :distance
+          float :payload
+          float :surface_area
+          integer :dirigible_class_id
+        end
+        
         base.data_miner do
-          schema do
-            float :distance
-            float :payload
-            integer :dirigible_class_id
+          process "the first step defined in the emitter module" do
+            # just make sure i'm here
           end
-
-          process :run_data_miner_on_belongs_to_associations
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'bundler'
 Bundler.setup
-
 require 'sniff'
 Sniff.init File.join(File.dirname(__FILE__), '..', '..')
 

metadata

@@ -1,10 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: emitter
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.5.1
   prerelease: 
-  version: 0.5.0
 platform: ruby
-authors: 
+authors:
 - Andy Rossmeissl
 - Seamus Abshere
 - Ian Hough
@@ -13,162 +13,168 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-02 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2159605280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.10
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: charisma
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2159605280
+- !ruby/object:Gem::Dependency
+  name: charisma
+  requirement: &2159604860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.3.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: cohort_scope
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2159604860
+- !ruby/object:Gem::Dependency
+  name: cohort_scope
+  requirement: &2159604400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: data_miner
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2159604400
+- !ruby/object:Gem::Dependency
+  name: data_miner
+  requirement: &2159603880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.1"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: earth
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2159603880
+- !ruby/object:Gem::Dependency
+  name: earth
+  requirement: &2159603320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: falls_back_on
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2159603320
+- !ruby/object:Gem::Dependency
+  name: falls_back_on
+  requirement: &2159602900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: leap
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2159602900
+- !ruby/object:Gem::Dependency
+  name: leap
+  requirement: &2159602440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: summary_judgement
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2159602440
+- !ruby/object:Gem::Dependency
+  name: summary_judgement
+  requirement: &2159601980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: timeframe
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2159601980
+- !ruby/object:Gem::Dependency
+  name: timeframe
+  requirement: &2159601560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2159601560
+- !ruby/object:Gem::Dependency
   name: weighted_average
+  requirement: &2159601140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *2159601140
+- !ruby/object:Gem::Dependency
+  name: create_table
+  requirement: &2159600400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: *2159600400
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2159599900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: bueller
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: *2159599900
+- !ruby/object:Gem::Dependency
+  name: bueller
+  requirement: &2159599480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: sniff
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  version_requirements: *2159599480
+- !ruby/object:Gem::Dependency
+  name: sniff
+  requirement: &2159598900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
   type: :development
-  version_requirements: *id013
+  prerelease: false
+  version_requirements: *2159598900
 description: A software model in Ruby for the greenhouse gas emissions
 email: derek@brighterplanet.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -177,6 +183,7 @@ files:
 - Rakefile
 - emitter.gemspec
 - lib/emitter.rb
+- lib/emitter/measurement.rb
 - lib/emitter/version.rb
 - spec/emitter_spec.rb
 - spec/fixtures/biplane/lib/biplane.rb
@@ -193,35 +200,37 @@ files:
 - spec/fixtures/dirigible/lib/dirigible/relationships.rb
 - spec/fixtures/dirigible/lib/dirigible/summarization.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/brighterplanet/emitter
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3262676913904917466
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3262676913904917466
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: The mother of all carbon models
-test_files: 
+test_files:
 - spec/emitter_spec.rb
 - spec/fixtures/biplane/lib/biplane.rb
 - spec/fixtures/biplane/lib/biplane/carbon_model.rb