purchase 0.0.4 → 0.1.0

data/features/purchase_committees.feature

@@ -2,7 +2,7 @@ Feature: Purchase Committee Calculations
   The purchase model should generate correct committee calculations
 
   Scenario Outline: Adjusted cost committee from cost and date
-    Given a purchase emitter
+    Given a purchase emitter 
     And a characteristic "cost" of "<cost>"
     And characteristic "date" of "<date>"
     When the "adjusted_cost" committee is calculated
@@ -10,23 +10,24 @@ Feature: Purchase Committee Calculations
     And the conclusion of the committee should be "<adjusted_cost>"
     Examples:
       | cost   | date       | adjusted_cost |
-      | 831.23 | 2010-08-01 |        831.23 |
-      |  11.00 | 2005-07-14 |          11.0 |
+      | 831.23 | 2010-08-01 |     688.67439 |
+      |  11.00 | 2005-07-14 |       9.11350 |
 
   Scenario Outline: Adjusted cost committee from purchase amount and date
-    Given a purchase emitter
+    Given a purchase emitter 
     And a characteristic "purchase_amount" of "<amount>"
     And characteristic "date" of "<date>"
-    When the "adjusted_cost" committee is calculated
-    Then the committee should have used quorum "from purchase amount and date"
+    When the "cost" committee is calculated
+    And the "adjusted_cost" committee is calculated
+    Then the committee should have used quorum "from cost and date"
     And the conclusion of the committee should be "<adjusted_cost>"
     Examples:
       | amount | date       | adjusted_cost |
-      | 831.23 | 2010-08-01 |       748.107 |
-      |  11.00 | 2005-07-14 |           9.9 |
+      | 831.23 | 2010-08-01 |     619.80695 |
+      |  11.00 | 2005-07-14 |       8.20215 |
 
   Scenario Outline: Merchant category committee from merchant
-    Given a purchase emitter
+    Given a purchase emitter 
     And a characteristic "merchant.id" of "<id>"
     When the "merchant_category" committee is calculated
     Then the conclusion of the committee should have "mcc" of "<mcc>"
@@ -35,94 +36,114 @@ Feature: Purchase Committee Calculations
       | 1  | 5111 |
       | 2  | 5732 |
 
-  Scenario Outline: Industry shares committee
-    Given a purchase emitter
+  Scenario Outline: Industry shares committee from merchant category
+    Given a purchase emitter 
     And a characteristic "merchant_category.mcc" of "<mcc>"
     When the "industry_shares" committee is calculated
-    Then the conclusion of the committee should have a record identified with "naics_code" of "<naics>" and having "ratio" of "<ratio>"
+    Then the conclusion of the committee should have a record identified with "naics_code" of "<naics>" and having "ratio" of "<share>"
     Examples:
-      | mcc  | naics  | ratio  |
-      | 5111 | 45321  |   1.0  |
-      | 5732 | 443112 |   1.0  |
-      | 5172 | 32411  |   0.8  |
-      | 5172 | 324121 |   0.05 |
-      | 5172 | 324122 |   0.05 |
-      | 5172 | 324191 |   0.05 |
-      | 5172 | 324199 |   0.05 |
+      | mcc  | naics  | share |
+      | 5111 | 45321  | 1.0   |
+      | 5172 | 32411  | 0.8   |
+      | 5172 | 324121 | 0.05  |
+      | 5172 | 324122 | 0.05  |
+      | 5172 | 324191 | 0.05  |
+      | 5172 | 324199 | 0.05  |
 
-  Scenario Outline: Product line shares committee
-    Given a purchase emitter
+  Scenario Outline: Product line shares committee from merchant category
+    Given a purchase emitter 
     And a characteristic "merchant_category.mcc" of "<mcc>"
     When the "industry_shares" committee is calculated
     And the "product_line_shares" committee is calculated
-    Then the conclusion of the committee should include a key of <ps_code> and value <ratio>
+    Then the conclusion of the committee should have a record identified with "ps_code" of "<ps_code>" and having "ratio" of "<share>"
     Examples:
-      | mcc  | ps_code  | ratio  |
+      | mcc  | ps_code  | share  |
       | 5111 | 20370    |    0.6 |
-      | 5732 | 20375    |    0.5 |
-      | 5172 | 30860    |   0.32 |
-      | 5172 | 30861    | 0.0225 |
-      | 5172 | 30862    | 0.0175 |
-      | 5172 | 30863    |  0.018 |
-      | 5172 | 30864    |  0.019 |
-
-  Scenario Outline: Sector shares committee from industry shares
-    Given a purchase emitter
-    And a characteristic "merchant_category.mcc" of "<mcc>"
-    When the "industry_shares" committee is calculated
-    And the "sector_shares" committee is calculated
-    Then the conclusion of the committee should include a key of "<io_code>" and subvalue "share" of "<share>" and subvalue "emission_factor" of "<emission_factor>"
-    Examples:
-      | mcc  | io_code | emission_factor | share  |
-      | 5111 |         |                 |        |
-      | 5732 |         |                 |        |
-      | 5172 | 324110  |             2.0 |    0.8 |
-      | 5172 | 324121  |             1.3 |   0.05 |
-      | 5172 | 324122  |             0.9 |   0.05 |
-      | 5172 | 324191  |             0.2 |   0.05 |
-      | 5172 | 324199  |             1.2 |   0.05 |
+      | 5111 | 20852    |    0.2 |
+      | 5111 | 20853    |    0.2 |
 
-  Scenario Outline: Sector shares committee from industry shares and product line shares
-    Given a purchase emitter
+  Scenario Outline: Sector shares committee from merchant category
+    Given a purchase emitter 
     And a characteristic "merchant_category.mcc" of "<mcc>"
     When the "industry_shares" committee is calculated
     And the "product_line_shares" committee is calculated
     And the "sector_shares" committee is calculated
-    Then the conclusion of the committee should include a key of "<io_code>" and subvalue "share" of "<share>" and subvalue "emission_factor" of "<emission_factor>"
+    Then the conclusion of the committee should have a record identified with "io_code" of "<io_code>" and having "emission_factor" of "<emission_factor>"
+    And the conclusion of the committee should have a record identified with "io_code" of "<io_code>" and having "share" of "<share>"
     Examples:
       | mcc  | io_code | emission_factor | share  |
       | 5111 | 334111  |             1.3 |   0.24 |
-      | 5111 | 33411A  |             0.5 |   0.18 |
       | 5111 | 511200  |             1.0 |   0.18 |
-      | 5111 | 339940  |             1.1 |    0.2 |
-      | 5111 | 322230  |             1.4 |    0.2 |
-      | 5732 | 33411A  |             0.5 |    0.5 |
+      | 5111 | 33411A  |             0.5 |   0.18 |
+      | 5111 | 322230  |             1.4 |   0.2  |
+      | 5111 | 339940  |             1.1 |   0.2  |
       | 5732 | 334300  |             1.2 |   0.25 |
-      | 5732 | 334210  |             1.6 |    0.2 |
-      | 5172 | 324110  |             2.0 |  0.256 |
+      | 5732 | 33411A  |             0.5 |   0.5  |
+      | 5732 | 334210  |             1.6 |   0.2  |
+      | 5812 | 722000  |             0.8 |   1.0  |
+      | 5172 | 324110  |             2.0 |   0.8  |
       | 5172 | 324121  |             1.3 |   0.05 |
       | 5172 | 324122  |             0.9 |   0.05 |
-      | 5172 | 324191  |             0.2 |   0.32 |
+      | 5172 | 324191  |             0.2 |   0.05 |
       | 5172 | 324199  |             1.2 |   0.05 |
-      | 8225 | 722000  |             0.8 |   0.15 |
 
-  Scenario Outline: Emission factor from sector shares
-    Given a purchase emitter
+  Scenario Outline: Emission factor from merchant category
+    Given a purchase emitter 
     And a characteristic "merchant_category.mcc" of "<mcc>"
     When the "industry_shares" committee is calculated
     And the "product_line_shares" committee is calculated
     And the "sector_shares" committee is calculated
-    And the "emission_factor" committee is calculated
-    Then the conclusion of the committee should be "<emission_factor>"
+    And the "emission_factors" committee is calculated
+    Then the conclusion of the committee should have a record identified with "io_code" of "<io_code>" and having "factor" of "<emission_factor_share>"
     Examples:
-      | mcc  | emission_factor |
-      | 5111 |           1.082 |
-      | 5732 |            0.87 |
-      | 5172 |        0.799205 |
-      | 8225 |            0.12 |
+      | mcc  | io_code | emission_factor_share |
+      | 5111 | 334111  |                 0.312 |
+      | 5111 | 33411A  |                  0.09 |
+      | 5111 | 511200  |                  0.18 |
+      | 5111 | 339940  |                  0.22 |
+      | 5111 | 322230  |                  0.28 |
+      | 5732 | 33411A  |                  0.25 |
+      | 5732 | 334300  |                   0.3 |
+      | 5732 | 334210  |                  0.32 |
+      | 5172 | 324110  |                   1.6 |
+      | 5172 | 324121  |                 0.065 |
+      | 5172 | 324122  |                 0.045 |
+      | 5172 | 324191  |                  0.01 |
+      | 5172 | 324199  |                  0.06 |
+      | 5812 | 722000  |                   0.8 |
 
-  Scenario Outline: Emission factor from default
+  Scenario: Emission factor from default
+    Given a purchase emitter 
+    When the "emission_factors" committee is calculated
+    Then the conclusion of the committee should have a record identified with "io_code" of "0" and having "factor" of "1"
+
+  Scenario Outline: Sector emissions from merchant id, cost, and date
     Given a purchase emitter
-    And a characteristic "merchant_category.mcc" of "<mcc>"
-    When the "emission_factor" committee is calculated
-    Then the conclusion of the committee should be "100"
+    And a characteristic "merchant.id" of "<merchant>"
+    And a characteristic "cost" of "<cost>"
+    And a characteristic "date" of "<date>"
+    When the "adjusted_cost" committee is calculated
+    And the "merchant_category" committee is calculated
+    And the "industry_shares" committee is calculated
+    And the "product_line_shares" committee is calculated
+    And the "sector_shares" committee is calculated
+    And the "emission_factors" committee is calculated
+    And the "sector_emissions" committee is calculated
+    Then the conclusion of the committee should include "<emission>"
+    Examples:
+      | merchant | io_code | cost   | date       | emission  |
+      |        1 | 322230  | 100.00 | 2010-07-28 |  23.19801 |
+      |        1 | 334111  | 100.00 | 2010-07-28 |  25.84921 |
+      |        1 | 339940  | 100.00 | 2010-07-28 |  18.22701 |
+      |        1 | 511200  | 100.00 | 2010-07-28 |  14.91301 |
+      |        1 | 33411A  | 100.00 | 2010-07-28 |   7.45650 |
+      |        2 | 334210  | 100.00 | 2010-07-28 |  26.51201 |
+      |        2 | 334300  | 100.00 | 2010-07-28 |  24.85501 |
+      |        2 | 33411A  | 100.00 | 2010-07-28 |  20.71251 |
+      |        3 | 722000  | 100.00 | 2010-07-28 |  66.28003 |
+      |        4 | 7211A0  | 100.00 | 2010-07-28 |  82.85004 |
+      |        5 | 324110  | 100.00 | 2010-07-28 | 132.56007 |
+      |        5 | 324121  | 100.00 | 2010-07-28 |   5.38525 |
+      |        5 | 324122  | 100.00 | 2010-07-28 |   3.72825 |
+      |        5 | 324191  | 100.00 | 2010-07-28 |   0.82850 |
+      |        5 | 324199  | 100.00 | 2010-07-28 |   4.97100 |

data/features/purchase_emissions.feature

@@ -1,7 +1,7 @@
 Feature: Purchase Emissions Calculations
   The purchase model should generate correct emission calculations
   
-  Scenario Outline: Calculations for a merchant
+  Scenario Outline: Calculations starting from a merchant
     Given a purchase has "merchant.id" of "<id>"
     And it has "cost" of "<cost>"
     And it has "date" of "<date>"
@@ -9,22 +9,51 @@ Feature: Purchase Emissions Calculations
     Then the emission value should be within 1 kgs of <emission>
     Examples:
       | id  | cost   | date       | emission |
-      | 1   | 100.00 | 2010-07-28 | 108.2    |
-      | 2   | 100.00 | 2010-07-28 |  87.0    |
-      | 3   | 100.00 | 2010-07-28 |  80.0    |
-      | 4   | 100.00 | 2010-07-28 | 121.0    |
-      | 5   | 100.00 | 2010-07-28 | 79.9205  |
+      | 1   | 100.00 | 2010-07-28 |  89.64   |
+      | 2   | 100.00 | 2010-07-28 |  72.08   |
+      | 3   | 100.00 | 2010-07-28 |  66.28   |
+      | 4   | 100.00 | 2010-07-28 |  82.85   |
+      | 5   | 100.00 | 2010-07-28 | 147.47   |
   
-  Scenario Outline: Calculations for a merchant category
+  Scenario Outline: Calculations starting from a merchant category
     Given a purchase has "merchant_category.mcc" of "<mcc>"
     And it has "cost" of "<cost>"
     And it has "date" of "<date>"
     When emissions are calculated
-    Then the emission value should be within 1 kgs of <emission>
+    Then the emission value should be within 0.1 kgs of <emission>
     Examples:
       | mcc  | cost   | date       | emission |
-      | 5111 | 100.00 | 2010-07-28 | 108.2    |
-      | 5732 | 100.00 | 2010-07-28 |  87.0    |
-      | 5812 | 100.00 | 2010-07-28 |  80.0    |
-      | 3504 | 100.00 | 2010-07-28 | 121.0    |
-      | 5172 | 100.00 | 2010-07-28 | 79.9205  |
+      | 5111 | 100.00 | 2010-07-28 |  89.64   |
+      | 5732 | 100.00 | 2010-07-28 |  72.08   |
+      | 5812 | 100.00 | 2010-07-28 |  66.28   |
+      | 3504 | 100.00 | 2010-07-28 |  82.85   |
+      | 5172 | 100.00 | 2010-07-28 | 147.47   |
+
+  Scenario Outline: Calculations starting from industry
+    Given a purchase has "naics_code" of "<naics>"
+    And it has "cost" of "<cost>"
+    And it has "date" of "<date>"
+    When emissions are calculated
+    Then the emission value should be within 0.1 kgs of <emission>
+    Examples:
+      | naics  | cost   | date       | emission |
+      | 45321  | 100.00 | 2010-07-28 |  89.64   |
+      | 443112 | 100.00 | 2010-07-28 |  72.08   |
+      | 72211  | 100.00 | 2010-07-28 |  66.28   |
+      | 72111  | 100.00 | 2010-07-28 |  82.85   |
+      | 32411  | 100.00 | 2010-07-28 | 132.56   |
+      | 324121 | 100.00 | 2010-07-28 |   5.39   |
+      | 324122 | 100.00 | 2010-07-28 |   3.73   |
+      | 324191 | 100.00 | 2010-07-28 |   0.83   |
+      | 324199 | 100.00 | 2010-07-28 |   4.97   |
+
+  Scenario Outline: Calculations without merchant, merchant category, or industry
+    Given a purchase has "cost" of "<cost>"
+    And it has "date" of "<date>"
+    When emissions are calculated
+    Then the emission value should be within 0.1 kgs of <emission>
+    Examples:
+      | cost   | date       | emission |
+      | 100.00 | 2010-07-28 |  82.85   |
+      | 100.00 | 2010-08-28 |  82.85   |
+      | 120.00 | 2010-08-28 |  99.42   |

data/features/support/env.rb

@@ -5,4 +5,4 @@ require 'cucumber'
 require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
 
 require 'sniff'
-Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :earth => :industry
+Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :earth => :industry, :cucumber => true

data/lib/purchase/carbon_model.rb

@@ -1,5 +1,6 @@
 require 'leap'
 require 'timeframe'
+require 'date'
 
 module BrighterPlanet
   module Purchase
@@ -11,96 +12,92 @@ module BrighterPlanet
       def self.included(base)
         base.extend ::Leap::Subject
         base.extend FastTimestamp
+
         base.decide :emission, :with => :characteristics do
           committee :emission do
-            quorum 'from emissions factor and adjusted cost', :needs => [:emission_factor, :adjusted_cost] do |characteristics|
-              #       lbs CO2e / 2002 US $              2002 US $
-              characteristics[:emission_factor] * characteristics[:adjusted_cost]
+            quorum 'from emissions factor and adjusted cost', :needs => :sector_emissions do |characteristics|
+              characteristics[:sector_emissions].inject(0) { |sum, emission| sum += emission }
             end
-            
-            quorum 'default' do
-              raise "The purchase's default emission quorum should never be called"
+          end
+
+          committee :sector_emissions do
+            quorum 'from emissions factors and adjusted cost', :needs => [:emission_factors, :adjusted_cost] do |characteristics|
+              characteristics[:emission_factors].map do |emission_factor|
+                emission_factor.factor * characteristics[:adjusted_cost]
+              end
             end
           end
-          
-          committee :emission_factor do
-            quorum 'from sector_shares', :needs => [:sector_shares] do |characteristics|
-              characteristics[:sector_shares].inject(0) do |sum, (io_code, data)|
-                if data[:emission_factor].nil?
+
+          committee :emission_factors do
+            quorum 'from sector shares', :needs => [:sector_shares] do |characteristics|
+              characteristics[:sector_shares].inject([]) do |list, sector_share|
+                if sector_share.emission_factor.nil?
                   raise MissingEmissionFactor,
-                    "Missing emission factor for sector #{io_code}"
+                    "Missing emission factor for sector #{sector_share.io_code}"
                 end
-                sum + data[:emission_factor] * data[:share]
+                factor = sector_share.emission_factor * sector_share.share
+                list << EmissionFactor.new(sector_share.io_code, factor)
               end
             end
             
+            # FIXME TODO figure out if we really want a fallback and get a real one
             quorum 'default' do
-              # FIXME TODO figure out a real fallback emission factor
-              100
+              [EmissionFactor.new(0, 1)]
             end
           end
           
           committee :sector_shares do
             quorum 'from industry shares and product line shares', :needs => [:industry_shares, :product_line_shares] do |characteristics|
-              industry_sector_shares = sector_shares_from_industry_shares(characteristics[:industry_shares])
+              industry_shares = characteristics[:industry_shares]
+              industry_sector_shares = industry_shares.inject([]) do |list, industry_share|
+                industry_share.industries_sectors.each do |industry_sector|
+                  io_code = industry_sector.io_code
+                  unless ['420000','4A0000'].include?(io_code.to_s)
+                    calculated_share = industry_share.ratio * industry_sector.ratio
+                    sector = industry_sector.sector
+                    list << SectorShare.new(sector, calculated_share)
+                  end
+                end
+                list
+              end
 
               product_line_shares = characteristics[:product_line_shares]
-              product_lines_sectors = ProductLinesSectors.find :all,
-                :conditions => { :ps_code => product_line_shares.keys }
-              product_sector_shares = product_lines_sectors.inject({}) do |hash, product_line_sector|
-                io_code = product_line_sector.io_code
-                ps_code = product_line_sector.ps_code
-                product_line_share = product_line_shares[ps_code]
-
-                share = product_line_sector.ratio * product_line_share
-                sector = product_line_sector.sector
-                if sector.nil?
-                  raise MissingSectorForProductLineSector, 
-                    "Missing a related sector for ProductLineSector #{product_line_sector.inspect}"
+              product_sector_shares = product_line_shares.inject([]) do |list, product_line_share|
+                product_line_share.product_lines_sectors.each do |product_line_sector|
+                  calculated_share = product_line_sector.ratio * product_line_share.ratio
+                  sector = product_line_sector.sector
+                  list << SectorShare.new(sector, calculated_share)
                 end
-                hash[io_code] = {
-                  :share => share, 
-                  :emission_factor => sector.emission_factor
-                }
-                hash
+                list
               end
 
-              industry_sector_shares.merge product_sector_shares
-            end
-            
-            # TODO Do we need this?
-            quorum 'from industry shares', :needs => [:industry_shares] do |characteristics|
-              sector_shares_from_industry_shares(characteristics[:industry_shares])
-            end
-            
-            quorum 'default' do
-              raise "We need a merchant, merchant category, industry, or product_line"
+              industry_sector_shares + product_sector_shares
             end
           end
-          
+
           committee :product_line_shares do
-            quorum 'from industry shares', :needs => [:industry_shares] do |characteristics|
+            quorum 'from industry shares', :needs => :industry_shares do |characteristics|
               industry_shares = characteristics[:industry_shares]
-              industries_product_lines = industry_shares.
-                map(&:industries_product_lines).flatten
-                  
-              industries_product_lines.inject({}) do |hash, industry_product_line|
-                ps_code = industry_product_line.ps_code
-                naics_code = industry_product_line.naics_code
-                industry_share = industry_shares.find_by_naics_code naics_code
-                hash[ps_code] = 
-                  industry_product_line.ratio * industry_share.ratio
-                hash
+              industry_shares.inject([]) do |list, industry_share|
+                industry_share.industries_product_lines.each do |industry_product_line|
+                  ratio = industry_product_line.ratio * industry_share.ratio
+                  list << ProductLineShare.new(industry_product_line.ps_code, 
+                                               ratio)
+                end
+                list
               end
             end
           end
           
           committee :industry_shares do
-            quorum 'from merchant category', :needs => [:merchant_category] do |characteristics|
-              characteristics[:merchant_category].merchant_categories_industries
+            quorum 'from merchant category', :needs => :merchant_category do |characteristics|
+              IndustryShare.find_all_by_merchant_category characteristics[:merchant_category]
+            end
+            quorum 'from industry', :needs => :naics_code do |characteristics|
+              IndustryShare.find_all_by_naics_code characteristics[:naics_code]
             end
           end
-          
+
           committee :merchant_category do
             quorum 'from merchant', :needs => [:merchant] do |characteristics|
               characteristics[:merchant].merchant_category
@@ -109,42 +106,101 @@ module BrighterPlanet
           
           committee :adjusted_cost do
             quorum 'from cost and date', :needs => [:cost, :date] do |characteristics|
-              # FIXME TODO convert cost to 2002 dollars based on date
-              characteristics[:cost]
+              # TODO: Come up with a way to fetch real CPI conversions
+              @cpi_lookup ||= { 
+                2009 => 1.189, 2010 => 1.207, 2011 => 1.225, 2012 => 1.245, 
+                2013 => 1.265 }
+
+              date = parse_date characteristics[:date]
+              conversion_factor = @cpi_lookup[date.year] || 1.207
+
+              characteristics[:cost].to_f / conversion_factor
             end
+          end
             
-            quorum 'from purchase amount and date', :needs => [:purchase_amount, :date] do |characteristics|
+          committee :cost do
+            quorum 'from purchase amount', :needs => :purchase_amount do |characteristics|
               # FIXME TODO take out tax, then convert to 2002 US $ based on date and cost
               characteristics[:purchase_amount] * 0.9
             end
+          end
 
+          committee :date do
             quorum 'default' do
-              raise "We need either a cost or purchase amount"
+              Date.today
             end
           end
         end
         # FIXME TODO make other committees to report emissions by gas, by io sector, etc.
       end
 
-      def self.sector_shares_from_industry_shares(industry_shares)
-        industry_sectors = industry_shares.map(&:industries_sectors).flatten
-        industry_sectors.inject({}) do |hash, industry_sector|
-          io_code = industry_sector.io_code
-          unless ['420000','4A0000'].include?(io_code.to_s)
-            naics_code = industry_sector.naics_code
-            industry_share = industry_shares.find_by_naics_code naics_code
-            calculated_share = industry_share.ratio * industry_sector.ratio
-            sector = industry_sector.sector
-            if sector.nil?
-              raise MissingSectorForIndustrySector, 
-                "Missing a related sector for IndustrySector #{industry_sector.inspect}"
+      def self.parse_date(date)
+        date = date.is_a?(Date) ? date : Date.parse(date)
+      end
+
+      class IndustryShare
+        class << self
+          def find_all_by_naics_code(naics_code)
+            industry = Industry.find_by_naics_code naics_code
+            from_merchant_categories_industries industry.merchant_categories_industries
+          end
+          def find_all_by_merchant_category(merchant_category)
+            from_merchant_categories_industries merchant_category.merchant_categories_industries
+          end
+
+        private
+          def from_merchant_categories_industries(merchant_categories_industries)
+            merchant_categories_industries.map do |mci|
+              new mci.naics_code, mci.ratio
             end
-            hash[io_code] = {
-              :share => calculated_share,
-              :emission_factor => sector.emission_factor
-            }
           end
-          hash
+        end
+
+        attr_accessor :naics_code, :ratio
+
+        def initialize(naics_code, ratio)
+          self.naics_code = naics_code
+          self.ratio = ratio
+        end
+
+        def industries_product_lines
+          IndustriesProductLines.find_all_by_naics_code naics_code
+        end
+
+        def industries_sectors
+          IndustriesSectors.find_all_by_naics_code naics_code
+        end
+      end
+
+      class ProductLineShare
+        attr_accessor :ps_code, :ratio
+
+        def initialize(ps_code, ratio)
+          self.ps_code = ps_code
+          self.ratio = ratio
+        end
+
+        def product_lines_sectors
+          ProductLinesSectors.find_all_by_ps_code ps_code
+        end
+      end
+
+      class SectorShare
+        attr_accessor :io_code, :share, :emission_factor
+
+        def initialize(sector, share)
+          self.io_code = sector.io_code
+          self.share = share
+          self.emission_factor = sector.emission_factor
+        end
+      end
+
+      class EmissionFactor
+        attr_accessor :io_code, :factor
+
+        def initialize(io_code, factor)
+          self.io_code = io_code
+          self.factor = factor
         end
       end
     end

data/lib/purchase/characterization.rb

@@ -8,15 +8,10 @@ module BrighterPlanet
         base.characterize do
           has :merchant
           has :merchant_category
-          has :industry_shares 
-          has :product_line_shares
-          has :sector_shares
-          has :purchase_amount # full purchase amount
+          has :naics_code
+          has :total           # full purchase amount
           has :tax             # tax portion of purchase
           has :cost            # cost before tax
-          has :line_item       # text describing what was purchased
-          has :customer_code
-          has :zip_code
           has :date
         end
       end

data/lib/test_support/db/schema.rb

@@ -4,7 +4,6 @@ Sniff::Database.define_schema do
   create_table "purchase_records", :force => true do |t|
     t.integer 'merchant_id'
     t.string  'mcc'
-    t.string  'naics_code'
     t.string  'ps_code'
     t.string  'io_code'
     t.float   'purchase_amount'

data/lib/test_support/purchase_record.rb

@@ -9,7 +9,6 @@ class PurchaseRecord < ActiveRecord::Base
   
   belongs_to :merchant,          :foreign_key => 'merchant_id'
   belongs_to :merchant_category, :foreign_key => 'mcc'
-  # belongs_to :industry,          :foreign_key => 'naics_code'
-  # belongs_to :product_line,      :foreign_key => 'ps_code'
-  # belongs_to :sector,            :foreign_key => 'io_code'
+
+  attr_accessor :naics_code
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: purchase
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -19,7 +19,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 -04:00
+date: 2010-08-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,12 +144,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 23
         segments: 
         - 0
-        - 0
-        - 19
-        version: 0.0.19
+        - 1
+        - 6
+        version: 0.1.6
   requirement: *id008
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -207,12 +207,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 57
+        hash: 55
         segments: 
         - 0
         - 0
-        - 19
-        version: 0.0.19
+        - 20
+        version: 0.0.20
   requirement: *id012
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -255,12 +255,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 11
         segments: 
         - 0
         - 4
-        - 1
-        version: 0.4.1
+        - 2
+        version: 0.4.2
   requirement: *id015
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -302,7 +302,6 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.html
 - README.markdown
 files: 
 - LICENSE
@@ -314,8 +313,6 @@ files:
 - lib/purchase/summarization.rb
 - lib/test_support/db/schema.rb
 - lib/test_support/purchase_record.rb
-- README.html
-- features/step_definitions/committee_steps.rb
 - features/support/env.rb
 - features/purchase_committees.feature
 - features/purchase_emissions.feature
@@ -354,7 +351,6 @@ signing_key:
 specification_version: 3
 summary: A carbon model
 test_files: 
-- features/step_definitions/committee_steps.rb
 - features/support/env.rb
 - features/purchase_committees.feature
 - features/purchase_emissions.feature

data/README.html

@@ -1,102 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC
-    "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
-    "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
-<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
-<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title>Purchase</title></head>
-<body>
-<h1 id='purchase'>Purchase</h1>
-
-<p>The purchase gem is used by Brighter Planet&#8217;s Carbon Middleware platform to define a mathematical emissions model for a purchase activity. In addition, this gem defines how the model&#8217;s calculation is displayed in a human readable format.</p>
-
-<p>Contributions are welcome and encouraged, as we believe that help from the scientific and developer communities will help us provide correct and transparent models of greenhouse gas-emitting activities. See the section on the Collaboration Cycle below.</p>
-
-<h2 id='usage'>Usage</h2>
-
-<p>The purchase gem defines a module, BrighterPlanet::Purchase that should be included into an ActiveRecord model. Calling #emission on an instance of the model will determine the amount of emissions (CO2e) generated by the activity.</p>
-
-<pre><code>class PurchaseRecord &lt; ActiveRecord::Base
-  include BrighterPlanet::Purchase
-  ...
-end
-
-p = PurchaseRecord.new :merchant_category_code =&gt; 2324, :amount =&gt; 873.45
-p.emission
-# =&gt; 2472</code></pre>
-
-<h2 id='getting_ready_for_development'>Getting Ready for Development</h2>
-
-<p>Purchase uses bundler to manage dependencies. To prepare your environment, perform the following: git clone git://github.com/brighterplanet/purchase.git cd purchase gem install bundler (note: prior to bundler 1.0 release, add &#8211;pre) bundle install</p>
-
-<h3 id='a_note_to_rvm_users_and_nonusers'>A Note to RVM Users (and Non-Users)</h3>
-
-<p><a href='http://rvm.beginrescueend.com/'>RVM</a> is a great tool for testing and development as it can create independent gem environments.</p>
-
-<p>Included in the repository is a .rvmrc that will automatically create a ruby 1.8.7 gemset for you named purchase. If you already have a gemset with the same name, simply replace the `pwd` within the .rvmrc to whatever name you want.</p>
-
-<h2 id='testing'>Testing</h2>
-
-<p>Our goal is to have sufficient testing coverage for our emissions models. We have chosen to write our tests using <a href='http://cukes.info'>cucumber</a> as the table-formatted testing fits well with our calculations tests and the plain-english stories lower the barrier to entry for programmers of all skill levels.</p>
-
-<p>There are two main features:</p>
-
-<ul>
-<li>purchase_emissions.feature, which tests emission values for various inputs</li>
-
-<li>purchase_committees.feature, which tests sub-calculations used within the model</li>
-</ul>
-
-<p>To run all tests: <code>rake</code> or <code>cucumber</code></p>
-
-<p>To run individual tests: <code>cucumber features/name_of_feature.feature</code></p>
-
-<p>To run a specific scenario: <code>cucumber features/name_of_feature.feature:line_number_of_scenario</code></p>
-
-<h3 id='sniff'>Sniff</h3>
-
-<p>The sniff gem is used to provide a testing environment that includes dependent data models and a database.</p>
-
-<p>See: <a href='http://github.com/brighterplanet/sniff'>http://github.com/brighterplanet/sniff</a></p>
-
-<h3 id='earth'>Earth</h3>
-
-<p>The earth gem contains the model definitions for dependent data models. For instance, this is zip code data or fuel prices used in the emissions calculations. Earth will look for any test fixtures defined in lib/test_support/db/fixtures. These sample records are in csv format and are imported into the testing database.</p>
-
-<h2 id='implementation'>Implementation</h2>
-
-<p>See the README for the sniff gem: <a href='http://github.com/brighterplanet/sniff/blob/master/README.markdown'>http://github.com/brighterplanet/sniff/blob/master/README.markdown</a></p>
-
-<h2 id='collaboration_cycle'>Collaboration cycle</h2>
-
-<p>Brighter Planet vigorously encourages collaborative improvement of its emitter libraries. Collaboration requires a (free) GitHub account.</p>
-
-<h3 id='you'>You</h3>
-
-<ol>
-<li>Fork the emitter repository on GitHub.</li>
-
-<li>Write a test proving the existing implementation&#8217;s inadequacy. Ensure that the test fails. Commit the test.</li>
-
-<li>Improve the code until your new test passes and commit your changes.</li>
-
-<li>Push your changes to your GitHub fork.</li>
-
-<li>Submit a pull request to brighterplanet.</li>
-</ol>
-
-<h3 id='brighter_planet'>Brighter Planet</h3>
-
-<ol>
-<li>Receive a pull request.</li>
-
-<li>Pull changes from forked repository.</li>
-
-<li>Ensure tests pass.</li>
-
-<li>Review changes for scientific accuracy.</li>
-
-<li>Merge changes to master repository and publish.</li>
-
-<li>Direct production environment to use new emitter version.</li>
-</ol>
-</body></html>

data/features/step_definitions/committee_steps.rb

@@ -1,93 +0,0 @@
-def coerce_value(value)
-  if value =~ /\d+\.\d+/
-    value.to_f
-  elsif value =~ /^\d+$/
-    value.to_i
-  else
-    value
-  end
-end
-
-def compare_values(a, b)
-  if b =~ /\d+\.\d+/
-    b = b.to_f
-    a.should be_close(b, 0.00001)
-  elsif b =~ /^\d+$/
-    b = b.to_i
-    a.should == b
-  else
-    a.should == b
-  end
-end
-
-Given /^a purchase emitter$/ do
-  @activity = PurchaseRecord
-end
-
-Given /^(a )?characteristic "(.*)" of "(.*)"$/ do |_, name, value|
-  @characteristics ||= {}
-
-  if name =~ /\./
-    model_name, attribute = name.split /\./
-    model = model_name.singularize.camelize.constantize
-    value = model.send "find_by_#{attribute}", value
-    @characteristics[model_name.to_sym] = value
-  else
-    value = coerce_value(value)
-    @characteristics[name.to_sym] = value
-  end
-end
-
-When /^the "(.*)" committee is calculated$/ do |committee_name|
-  @decision ||= @activity.decisions[:emission]
-  @committee = @decision.committees.find { |c| c.name.to_s == committee_name }
-  @report = @committee.report(@characteristics, [])
-  @characteristics[committee_name.to_sym] = @report.conclusion
-end
-
-Then /^the committee should have used quorum "(.*)"$/ do |quorum|
-  @report.quorum.name.should == quorum
-end
-
-Then /^the conclusion of the committee should be "(.+)"$/ do |conclusion|
-  compare_values(@report.conclusion, conclusion)
-end
-
-Then /^the conclusion of the committee should include a key of (.*) and value (.*)$/ do |key, value|
-  if key.present?
-    @report.conclusion.keys.map(&:to_s).should include(key)
-  else
-    @report.conclusion.keys.map(&:to_s).should be_empty
-  end
-
-  if value.present?
-    @report.conclusion.each do |k, v|
-      @report.conclusion[k.to_s] == v
-    end
-    compare_values(@report.conclusion[key.to_s], value)
-  end
-end
-
-Then /^the conclusion of the committee should have "(.*)" of "(.*)"$/ do |attribute, value|
-  report_value = coerce_value @report.conclusion.send(attribute)
-  report_value.should == coerce_value(value)
-end
-
-Then /^the conclusion of the committee should have a record identified with "(.*)" of "(.*)" and having "(.*)" of "(.*)"$/ do |id_field, id, field, value|
-  id_field = id_field.to_sym
-  records = @report.conclusion
-  record = records.send("find_by_#{id_field}", id)
-  coerce_value(record.send(field)).should == coerce_value(value)
-end
-
-Then /^the conclusion of the committee should include a key of "(.*)" and subvalue "(.*)" of "(.*)" and subvalue "(.*)" of "(.*)"$/ do |key, subkey1, subvalue1, subkey2, subvalue2|
-  if key.present?
-    @report.conclusion.keys.map(&:to_s).should include(key)
-    actual_subvalue1 = coerce_value(@report.conclusion[key.to_s][subkey1.to_sym].to_s)
-    compare_values(actual_subvalue1, subvalue1)
-    actual_subvalue2 = coerce_value(@report.conclusion[key.to_s][subkey2.to_sym].to_s)
-    compare_values(actual_subvalue2, subvalue2)
-  else
-    @report.conclusion.keys.map(&:to_s).should be_empty
-  end
-end