shipment 0.0.0 → 0.0.1

data/features/shipment_committees.feature

@@ -0,0 +1,206 @@
+Feature: Shipment Committee Calculations
+  The shipment model should generate correct committee calculations
+
+  Scenario: Weight from nothing
+    Given a shipment emitter
+    When the "weight" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be "3.4"
+  
+  Scenario: Package count from nothing
+    Given a shipment emitter
+    When the "package_count" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be "1"
+  
+  Scenario: Carrier from nothing
+    Given a shipment emitter
+    When the "carrier" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be a fallback
+  
+  Scenario: Mode from nothing
+    Given a shipment emitter
+    When the "mode" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be a fallback
+  
+  Scenario: Segment count from nothing
+    Given a shipment emitter
+    When the "segment_count" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be "5"
+
+  Scenario Outline: Distance from origin zip code, destination zip code, and default mode
+    Given a shipment emitter
+    And a characteristic "origin_zip_code.name" of "<origin>"
+    And a characteristic "destination_zip_code.name" of "<destination>"
+    When the "mode" committee is calculated
+    And the "distance" committee is calculated
+    Then the committee should have used quorum "from origin zip code, destination zip code, and mode"
+    And the conclusion of the committee should be "<distance>"
+    Examples:
+      | origin | destination | distance |
+      | 05753  | 05753       | 0        |
+      | 05753  | 05401       | 53       |
+
+  Scenario Outline: Distance from origin zip code and destination zip code
+    Given a shipment emitter
+    And a characteristic "origin_zip_code.name" of "<origin>"
+    And a characteristic "destination_zip_code.name" of "<destination>"
+    And a characteristic "mode.name" of "<mode>"
+    When the "distance" committee is calculated
+    Then the committee should have used quorum "from origin zip code, destination zip code, and mode"
+    And the conclusion of the committee should be "<distance>"
+    Examples:
+      | origin | destination | mode    | distance   |
+      | 05753  | 05753       | courier | 0          |
+      | 05753  | 05401       | courier | 53         |
+      | 05753  | 20860       | courier | 8679       |
+      | 05401  | 05401       | air     | 0          |
+      | 05401  | 94128       | air     | 4133.31657 |
+      | 05401  | 20860       | air     | 8693       |
+      | 05401  | 05401       | ground  | 0          |
+      | 05401  | 94128       | ground  | 4133       |
+      | 05401  | 20860       | ground  | 8693       |
+
+  Scenario: Route inefficiency factor from nothing
+    Given a shipment emitter
+    When the "mode" committee is calculated
+    And the "route_inefficiency_factor" committee is calculated
+    Then the committee should have used quorum "from mode"
+    And the conclusion of the committee should be "1.05"
+
+  Scenario Outline: Route inefficiency factor from mode
+    Given a shipment emitter
+    And a characteristic "mode.name" of "<mode>"
+    When the "route_inefficiency_factor" committee is calculated
+    Then the committee should have used quorum "from mode"
+    And the conclusion of the committee should be "<factor>"
+    Examples:
+      | mode    | factor |
+      | courier | 5.0    |
+      | ground  | 1.0    |
+      | air     | 1.1    |
+
+  Scenario: Dogleg factor from default segment count
+    Given a shipment emitter
+    When the "segment_count" committee is calculated
+    And the "dogleg_factor" committee is calculated
+    Then the committee should have used quorum "from segment count"
+    And the conclusion of the committee should be "5.0625"
+
+  Scenario Outline: Dogleg factor from segment count
+    Given a shipment emitter
+    And a characteristic "segment_count" of "<segments>"
+    When the "dogleg_factor" committee is calculated
+    Then the committee should have used quorum "from segment count"
+    And the conclusion of the committee should be "<factor>"
+    Examples:
+      | segments | factor |
+      | 1        | 1.0    |
+      | 2        | 1.5    |
+
+  Scenario: Adjusted distance from default
+    Given a shipment emitter
+    When the "adjusted_distance" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be "3219.0"
+
+  Scenario: Adjusted distance from distance, route inefficiency factor, and dogleg factor
+    Given a shipment emitter
+    And a characteristic "distance" of "100.0"
+    And a characteristic "route_inefficiency_factor" of "2.0"
+    And a characteristic "dogleg_factor" of "2.0"
+    When the "adjusted_distance" committee is calculated
+    Then the committee should have used quorum "from distance, route inefficiency factor, and dogleg factor"
+    And the conclusion of the committee should be "400.0"
+
+  Scenario: Transport emission factor from default mode
+    Given a shipment emitter
+    When the "mode" committee is calculated
+    And the "transport_emission_factor" committee is calculated
+    Then the committee should have used quorum "from mode"
+    And the conclusion of the committee should be "3.0"
+
+  Scenario Outline: Transport emission factor from mode
+    Given a shipment emitter
+    And a characteristic "mode.name" of "<mode>"
+    When the "transport_emission_factor" committee is calculated
+    Then the committee should have used quorum "from mode"
+    And the conclusion of the committee should be "<emission_factor>"
+    Examples:
+      | mode    | emission_factor |
+      | courier | 2.0             |
+      | ground  | 1.0             |
+      | air     | 5.0             |
+
+  Scenario: Corporate emission factor from default carrier
+    Given a shipment emitter
+    When the "carrier" committee is calculated
+    And the "corporate_emission_factor" committee is calculated
+    Then the committee should have used quorum "from carrier"
+    And the conclusion of the committee should be "2.0"
+
+  Scenario: Corporate emission factor from carrier
+    Given a shipment emitter
+    And a characteristic "carrier.name" of "FedEx"
+    When the "corporate_emission_factor" committee is calculated
+    Then the committee should have used quorum "from carrier"
+    And the conclusion of the committee should be "2.0"
+
+  Scenario Outline: Transport emission from defaults
+    Given a shipment emitter
+    When the "weight" committee is calculated
+    And the "mode" committee is calculated
+    And the "adjusted_distance" committee is calculated
+    And the "transport_emission_factor" committee is calculated
+    And the "transport_emission" committee is calculated
+    Then the committee should have used quorum "from mode, weight, adjusted distance, and transport emission factor"
+    And the conclusion of the committee should be "600.0"
+
+  Scenario Outline: Transport emission from mode, weight, adjusted distance, and transport emission factor
+    Given a shipment emitter
+    And a characteristic "mode.name" of "<mode>"
+    And a characteristic "weight" of "<weight>"
+    And a characteristic "adjusted_distance" of "<adjusted_distance>"
+    And a characteristic "transport_emission_factor" of "<ef>"
+    When the "transport_emission" committee is calculated
+    Then the committee should have used quorum "from mode, weight, adjusted distance, and transport emission factor"
+    And the conclusion of the committee should be "<emission>"
+    Examples:
+      | mode    | weight | adjusted_distance | ef  | emission |
+      | courier | 2.0    | 100.0             | 2.0 | 2.0      |
+      | ground  | 2.0    | 100.0             | 1.0 | 200.0    |
+      | air     | 2.0    | 100.0             | 5.0 | 1000.0   |
+
+  Scenario: Corporate emission from package count and corporate emission factor
+    Given a shipment emitter
+    And a characteristic "package_count" of "2"
+    And a characteristic "corporate_emission_factor" of "2.0"
+    When the "corporate_emission" committee is calculated
+    Then the committee should have used quorum "from package count and corporate emission factor"
+    And the conclusion of the committee should be "4.0"
+
+  Scenario: Emission from transport emission and corporate emission
+    Given a shipment emitter
+    And a characteristic "transport_emission" of "400.0"
+    And a characteristic "corporate_emission" of "20.0"
+    When the "emission" committee is calculated
+    Then the committee should have used quorum "from transport emission and corporate emission"
+    And the conclusion of the committee should be "420.0"
+
+  # Scenario Outline: Duration from timestamps
+  #   Given a shipment emitter
+  #   And a characteristic "origin_timestamp" of "<origin>"
+  #   And a characteristic "destination_timestamp" of "<destination>"
+  #   When the "duration" committee is calculated
+  #   Then the committee should have used quorum "from timestamps"
+  #   And the conclusion of the committee should be "<duration>"
+  #   Examples:
+  #     | origin                    | destination               | duration |
+  #     | 2010-01-01T00:00:00Z      | 2010-01-02T01:30:00Z      | 01:30:00 | same timezone
+  #     | 2010-01-01T00:00:00Z      | 2010-01-02T09:30:00+08:00 | 01:30:00 | different timezones
+  #     | 2010-01-01T00:00:00Z      | 2009-12-31T20:30:00-05:00 | 01:30:00 | timezone change causes different days
+  #     | 2010-01-01T12:00:00+12:00 | 2009-12-31T13:30:00-12:00 | 01:30:00 | cross intl date line eastwards
+  #     | 2010-01-01T12:00:00-12:00 | 2009-01-02T13:30:00+12:00 | 01:30:00 | cross intl date line westwards

data/features/shipment_emissions.feature

@@ -4,4 +4,51 @@ Feature: Shipment Emissions Calculations
   Scenario: Calculations starting from nothing
     Given a shipment has nothing
     When emissions are calculated
-    Then the emission value should be within "0.1" kgs of "0"
+    Then the emission value should be within "0.1" kgs of "32835.8"
+
+  Scenario: Calculations from weight, package count, segment count
+    Given a shipment has "weight" of "10"
+    And it has "package_count" of "2"
+    And it has "segment_count" of "1"
+    When emissions are calculated
+    Then the emission value should be within "0.1" kgs of "96574.0"
+
+  Scenario Outline: Calculations from origin/destination
+    Given a shipment has "origin_zip_code.name" of "<origin>"
+    And it has "destination_zip_code.name" of "<destination>"
+    When emissions are calculated
+    Then the emission value should be within "0.1" kgs of "<emission>"
+    Examples:
+      | origin | destination | emission |
+      | 05401  | 05401       | 0.318    |
+      | 05401  | 94128       | 224106.1 |
+
+  Scenario: Calculations from carrier
+    Given a shipment has "carrier.name" of "FedEx"
+    When emissions are calculated
+    Then the emission value should be within "0.1" kgs of "32835.8"
+
+  Scenario Outline: Calculations from mode
+    Given a shipment has "mode.name" of "<mode>"
+    When emissions are calculated
+    Then the emission value should be within "0.1" kgs of "<emission>"
+    Examples:
+      | mode    | emission |
+      | courier | 4.0      |
+      | ground  | 10946.6  |
+      | air     | 54725.0  |
+
+  Scenario Outline: Calculations from mode and origin/destination
+    Given a shipment has "mode.name" of "<mode>"
+    And it has "origin_zip_code.name" of "<origin>"
+    And it has "destination_zip_code.name" of "<destination>"
+    When emissions are calculated
+    Then the emission value should be within "0.1" kgs of "<emission>"
+    Examples:
+      | mode    | origin | destination | emission |
+      | courier | 05401  | 05401       | 99999.9  |
+      | courier | 05401  | 94128       | 99999.9  |
+      | ground  | 05401  | 05401       | 99999.9  |
+      | ground  | 05401  | 94128       | 99999.9  |
+      | air     | 05401  | 05401       | 99999.9  |
+      | air     | 05401  | 94128       | 391297.9 |

data/features/support/env.rb

@@ -7,4 +7,4 @@ require 'rspec'
 require 'rspec/expectations'
 
 require 'sniff'
-Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :cucumber => true, :earth => [:locality, :fuel]
+Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :cucumber => true, :earth => [:locality, :shipping]

data/lib/shipment/carbon_model.rb

@@ -24,17 +24,119 @@ module BrighterPlanet
     module CarbonModel
       def self.included(base)
         base.decide :emission, :with => :characteristics do
-          ### Emission calculation
-          # Returns the `emission` estimate (*kg CO<sub>2</sub>e*).
-          # This is the total emission produced by the shipment venue.
           committee :emission do
-            #### Default emission
-            # **Complies:**
-            #
-            # Displays an error if the previous method fails.
+            # FIXME TODO deal with timeframe
+            quorum 'from transport emission and corporate emission', :needs => [:transport_emission, :corporate_emission] do |characteristics|
+              characteristics[:transport_emission] + characteristics[:corporate_emission]
+            end
+          end
+          
+          committee :corporate_emission do
+            quorum 'from package count and corporate emission factor', :needs => [:package_count, :corporate_emission_factor] do |characteristics|
+              if characteristics[:package_count] > 0
+                characteristics[:package_count] * characteristics[:corporate_emission_factor]
+              else
+                raise "Invalid package_count: #{:package_count} (must be > 0)"
+              end
+            end
+          end
+          
+          committee :transport_emission do
+            quorum 'from mode, weight, adjusted distance, and transport emission factor', :needs => [:mode, :weight, :adjusted_distance, :transport_emission_factor] do |characteristics|
+              # we're assuming here that the number of stops, rather than number of packages carried, is limiting factor on local delivery routes
+              if characteristics[:mode].name == "courier"
+                characteristics[:transport_emission_factor]
+              elsif characteristics[:weight] > 0
+                characteristics[:weight] * characteristics[:adjusted_distance] * characteristics[:transport_emission_factor]
+              else
+                raise "Invalid weight: #{:weight} (must be > 0)"
+              end
+            end
+          end
+          
+          committee :corporate_emission_factor do
+            quorum 'from carrier', :needs => :carrier, do |characteristics|
+              characteristics[:carrier].corporate_emission_factor
+            end
+          end
+          
+          committee :transport_emission_factor do
+            quorum 'from mode', :needs => :mode do |characteristics|
+              characteristics[:mode].transport_emission_factor
+            end
+          end
+          
+          committee :adjusted_distance do
+            quorum 'from distance, route inefficiency factor, and dogleg factor', :needs => [:distance, :route_inefficiency_factor, :dogleg_factor] do |characteristics|
+              characteristics[:distance] * characteristics[:route_inefficiency_factor] * characteristics[:dogleg_factor]
+            end
+            
+            quorum 'default' do
+              # ASSUMED: arbitrary
+              3219
+            end
+          end
+            
+          committee :dogleg_factor do
+            quorum 'from segment count', :needs => :segment_count do |characteristics|
+              if characteristics[:segment_count] > 0
+                # ASSUMED arbitrary
+                1.5 ** (characteristics[:segment_count] - 1)
+              else
+                raise "Invalid segment_count: #{:segment_count} (must be > 0)"
+              end
+            end
+          end
+          
+          committee :route_inefficiency_factor do
+            quorum 'from mode', :needs => :mode do |characteristics|
+              characteristics[:mode].route_inefficiency_factor
+            end
+          end
+          
+          committee :distance do
+            quorum 'from origin zip code, destination zip code, and mode', :needs => [:origin_zip_code, :destination_zip_code], do |characteristics|
+              if characteristics[:origin_zip_code] == characteristics[:destination_zip_code]
+                # FIXME TODO
+                # Special calculation to deal with travel within the same zipcode
+                0
+              else
+                characteristics[:origin_zip_code].distance_to(characteristics[:destination_zip_code], :units => :kms)
+                # FIXME TODO: calculate the distance via road using map directions
+              end
+            end
+          end
+          
+          committee :segment_count do
+            quorum 'default' do
+              # ASSUMED based on the fact that FedEx has a hub-spoke system with central and regional distribution centers so seems reasonable for average package to go through four FedEx facilities
+              5
+            end
+          end
+          
+          committee :mode do
+            quorum 'default' do
+              ShipmentMode.fallback
+            end
+          end
+          
+          committee :carrier do
+            quorum 'default' do
+              Carrier.fallback
+            end
+          end
+          
+          committee :package_count do
+            quorum 'default' do
+              # ASSUMED arbitrary
+              1
+            end
+          end
+          
+          committee :weight do
             quorum 'default' do
-#              raise "The emission committee's default quorum should never be called"
-              0
+              # ASSUMED based on average FedEx air package weight of 7.5 lbs
+              3.4
             end
           end
         end

data/lib/shipment/characterization.rb

@@ -3,6 +3,13 @@ module BrighterPlanet
     module Characterization
       def self.included(base)
         base.characterize do
+          has :weight
+          has :package_count
+          has :carrier
+          has :mode
+          has :segment_count
+          has :origin_zip_code
+          has :destination_zip_code
         end
       end
     end

data/lib/shipment/data.rb

@@ -4,6 +4,13 @@ module BrighterPlanet
       def self.included(base)
         base.data_miner do
           schema do
+            float   'weight'
+            integer 'package_count'
+            string  'carrier_name'
+            string  'mode_name'
+            integer 'segment_count'
+            string  'origin_zip_code_name'
+            string  'destination_zip_code_name'
           end
           
           process :run_data_miner_on_belongs_to_associations

data/lib/shipment/relationships.rb

@@ -2,6 +2,10 @@ module BrighterPlanet
   module Shipment
     module Relationships
       def self.included(base)
+        base.belongs_to :carrier,              :foreign_key => 'carrier_name',  :primary_key => 'name'
+        base.belongs_to :origin_zip_code,      :foreign_key => 'zip_code_name', :primary_key => 'name', :class_name => 'ZipCode'
+        base.belongs_to :destination_zip_code, :foreign_key => 'zip_code_name', :primary_key => 'name', :class_name => 'ZipCode'
+        base.belongs_to :mode,                 :foreign_key => 'mode_name',     :primary_key => 'name', :class_name => 'ShipmentMode'
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 -05:00
+date: 2010-12-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,21 +94,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: earth
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 1
-        version: 0.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: *id006
 description: A software model in Ruby for the greenhouse gas emissions of a shipment
 email: andy@rossmeissl.net
 executables: []
@@ -130,6 +115,7 @@ files:
 - lib/shipment/summarization.rb
 - lib/test_support/shipment_record.rb
 - features/support/env.rb
+- features/shipment_committees.feature
 - features/shipment_emissions.feature
 has_rdoc: true
 homepage: http://brighterplanet.github.com/shipment
@@ -145,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -143060881
+      hash: -856075423
       segments: 
       - 0
       version: "0"
@@ -166,5 +152,6 @@ specification_version: 3
 summary: A carbon model for a shipment
 test_files: 
 - features/support/env.rb
+- features/shipment_committees.feature
 - features/shipment_emissions.feature
 - lib/test_support/shipment_record.rb