earth 0.3.8 → 0.3.9

data/Gemfile.lock

@@ -1,22 +1,14 @@
 PATH
   remote: .
   specs:
-    earth (0.3.7)
+    earth (0.3.8)
       activerecord (~> 3)
-      activerecord (~> 3)
-      cohort_scope (>= 0.0.7)
       cohort_scope (>= 0.0.7)
       conversions (>= 1.4.5)
-      conversions (>= 1.4.5)
-      data_miner (~> 0.5.6)
       data_miner (~> 0.5.6)
       falls_back_on (>= 0.0.3)
-      falls_back_on (>= 0.0.3)
-      geokit (>= 1.5.0)
       geokit (>= 1.5.0)
       loose_tight_dictionary (>= 0.0.8)
-      loose_tight_dictionary (>= 0.0.8)
-      weighted_average (>= 0.0.4)
       weighted_average (>= 0.0.4)
 
 GEM

data/lib/earth/automobile/automobile_make_model_year_variant/data_miner.rb

@@ -139,7 +139,7 @@ AutomobileMakeModelYearVariant.class_eval do
       bus[:format] = :fixed_width
       bus[:cut] = '13-' if year == 1995
       bus[:schema_name] = :fuel_economy_guide_b
-      bus[:select] = lambda { |row| row['supress_code'].blank? and row['state_code'] == 'F' }
+      bus[:select] = lambda { |row| row['suppress_code'].blank? and row['state_code'] == 'F' }
       Slither.define :fuel_economy_guide_b do |d|
         d.rows do |row|
           row.trap { true } # there's only one section

data/lib/earth/shipping.rb

@@ -1,2 +1,3 @@
 require 'earth/shipping/carrier'
+require 'earth/shipping/carrier_mode'
 require 'earth/shipping/shipment_mode'

data/lib/earth/shipping/carrier.rb

@@ -1,7 +1,12 @@
 class Carrier < ActiveRecord::Base
   set_primary_key :name
   
-  falls_back_on :corporate_emission_factor => 0.318#Carrier.average(:corporate_emission_factor)
+  has_many :carrier_modes, :foreign_key => 'carrier_name', :primary_key => 'name'
+  
+  # TODO calculate these
+  falls_back_on :route_inefficiency_factor => 1.03,# Carrier.weighted_average(:route_inefficiency_factor, :weighted_by => :package_volume)
+                :transport_emission_factor => 0.0005266,# Carrier.weighted_average(:transport_emission_factor, :weighted_by => :package_volume)
+                :corporate_emission_factor => 0.221# Carrier.weighted_average(:corporate_emission_factor, :weighted_by => :package_volume)
   
   data_miner do
     tap "Brighter Planet's shipping company data", Earth.taps_server

data/lib/earth/shipping/carrier/data_miner.rb

@@ -2,6 +2,10 @@ Carrier.class_eval do
   data_miner do
     schema Earth.database_options do
       string 'name'
+      float  'package_volume'
+      float  'route_inefficiency_factor'
+      float  'transport_emission_factor'
+      string 'transport_emission_factor_units'
       float  'corporate_emission_factor'
       string 'corporate_emission_factor_units'
     end
@@ -9,15 +13,33 @@ Carrier.class_eval do
     import "a list of shipping companies and their characteristics",
            :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdG1ONU1HZDdZTFJNclFYVkRzR0k5Z2c&hl=en&single=true&gid=0&output=csv' do
       key   'name'
+      store 'package_volume'
+      store 'route_inefficiency_factor'
+      store 'transport_emission_factor', :units_field_name => 'transport_emission_factor_units'
       store 'corporate_emission_factor', :units_field_name => 'corporate_emission_factor_units'
     end
     
-    verify "All entries should have corporate_emission_factor >= 0" do
-      all.each do |record|
-        unless record[:corporate_emission_factor] >= 0
-          raise "Invalid corporate_emission_factor for Carrier #{record[:name]}: #{record[:corporate_emission_factor]}"
-        end
-      end
-    end
+    # TODO: derive package volume, route inefficiency factor, and transport emission factor
+    # process "derive package volume, route inefficiency factor, and transport emission factor from CarrierModes" do
+    #   CarrierMode.run_data_miner!
+    #   
+    #   carrier_modes = CarrierMode.arel_table
+    #   carriers = Carrier.arel_table
+    #   conditional_relation = carrier_modes[:include_in_fallbacks].and(carriers[:name].eq(carrier_modes[:carrier_name]))
+    #   
+    #   update_all "package_volume            = (#{carriers.project(sum(carriers[:package_volume]).where(conditional_relation)).to_sql})"
+    #   update_all "route_inefficiency_factor = (#{CarrierMode.weighted_average_relation(:route_inefficiency_factor, :weighted_by => :package_volume).where(conditional_relation).to_sql})"
+    #   update_all "transport_emission_factor = (#{CarrierMode.weighted_average_relation(:transport_emission_factor, :weighted_by => :package_volume).where(conditional_relation).to_sql})"
+    #   what about transport_emission_factor_units?
+    # end
+    
+    # TODO: verification
+    # all entries should have name
+    # all entries should have package_volume
+    # all entries should have route_inefficiency_factor
+    # all entries should have transport_emission_factor > 0
+    # all entries should have transport_emission_factor_units
+    # all entries should have corporate_emission_factor > 0
+    # all entries should have corporate_emission_factor_units
   end
 end

data/lib/earth/shipping/carrier_mode.rb

@@ -0,0 +1,10 @@
+class CarrierMode < ActiveRecord::Base
+  set_primary_key :name
+  
+  belongs_to :carrier, :foreign_key => 'carrier_name', :primary_key => 'name'
+  belongs_to :mode,    :foreign_key => 'mode_name',    :primary_key => 'name', :class_name => 'ShipmentMode'
+  
+  data_miner do
+    tap "Brighter Planet's carrier mode data", Earth.taps_server
+  end
+end

data/lib/earth/shipping/carrier_mode/data_miner.rb

@@ -0,0 +1,34 @@
+CarrierMode.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      string 'carrier_name'
+      string 'mode_name'
+      boolean 'include_in_fallbacks'
+      float  'package_volume'
+      float  'route_inefficiency_factor'
+      float  'transport_emission_factor'
+      string 'transport_emission_factor_units'
+    end
+    
+    import "a list of carrier modes and their characteristics",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGRsRkJOd0NPd0FETTI0NmpYUlBsN2c&hl=en&single=true&gid=0&output=csv' do
+      key   'name'
+      store 'carrier_name'
+      store 'mode_name'
+      store 'include_in_fallbacks'
+      store 'package_volume'
+      store 'route_inefficiency_factor'
+      store 'transport_emission_factor', :units_field_name => 'transport_emission_factor_units'
+    end
+    
+    # TODO: verification
+    # all entries should have carrier_name
+    # all entries should have mode_name
+    # all entries should have include_in_fallbacks
+    # all entries should have package_volume
+    # all entries should have route_inefficiency_factor
+    # all entries should have transport emission factor > 0
+    # all entries should have transport emission factor units
+  end
+end

data/lib/earth/shipping/data_miner.rb

@@ -1,2 +1,3 @@
 require 'earth/shipping/carrier/data_miner'
+require 'earth/shipping/carrier_mode/data_miner'
 require 'earth/shipping/shipment_mode/data_miner'

data/lib/earth/shipping/shipment_mode.rb

@@ -1,8 +1,7 @@
 class ShipmentMode < ActiveRecord::Base
   set_primary_key :name
   
-  falls_back_on :route_inefficiency_factor => 1.05,#ShipmentMode.where(not(:name => 'courier')).average(:route_inefficiency_factor),
-                :transport_emission_factor => 0.0007696#ShipmentMode.where(not(:name => 'courier')).average(:route_inefficiency_factor)
+  has_many :carrier_modes, :foreign_key => 'mode_name', :primary_key => 'name'
   
   data_miner do
     tap "Brighter Planet's shipment mode data", Earth.taps_server

data/lib/earth/shipping/shipment_mode/data_miner.rb

@@ -13,5 +13,22 @@ ShipmentMode.class_eval do
       store 'route_inefficiency_factor'
       store 'transport_emission_factor', :units_field_name => 'transport_emission_factor_units'
     end
+    
+    # TODO: derive route inefficiency factor and transport emission factor
+    # process "derive route inefficiency factor and transport emission factor from CarrierModes" do
+    #   CarrierMode.run_data_miner!
+    #   
+    #   carrier_modes = CarrierMode.arel_table
+    #   modes = ShipmentMode.arel_table
+    #   
+    #   update_all "route_inefficiency_factor = (#{CarrierMode.weighted_average_relation(:route_inefficiency_factor, :weighted_by => :package_volume).where(modes[:name].eq(carrier_modes[:mode_name])).to_sql})"
+    #   update_all "transport_emission_factor = (#{CarrierMode.weighted_average_relation(:transport_emission_factor, :weighted_by => :package_volume).where(modes[:name].eq(carrier_modes[:mode_name])).to_sql})"
+    #   what about transport_emission_factor_units?
+    # end
+    
+    # TODO: verification
+    # all entries should have route_inefficiency_factor >= 1
+    # all entries should have transport_emission_factor > 0
+    # all entries should have transport_emission_factor_units
   end
 end

data/spec/earth_spec.rb

@@ -27,7 +27,7 @@ describe Earth do
   describe '.resources' do
     it 'should get a list of resources' do
       resources = Earth.resources
-      resources.keys.count.should == 58
+      resources.keys.count.should == 59
       resources['FuelType'][:domain].should == 'fuel'
     end
     it 'should exclude data_miner files' do
@@ -37,7 +37,7 @@ describe Earth do
 
   describe '.resource_names' do
     it 'should get a list of all resource names' do
-      Earth.resource_names.count.should == 58
+      Earth.resource_names.count.should == 59
       Earth.resource_names.should include('Aircraft')
       Earth.resource_names.should include('Industry')
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: earth
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 3
-  - 8
-  version: 0.3.8
+  - 9
+  version: 0.3.9
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -05:00
+date: 2010-12-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -376,6 +376,8 @@ files:
 - lib/earth/shipping.rb
 - lib/earth/shipping/carrier.rb
 - lib/earth/shipping/carrier/data_miner.rb
+- lib/earth/shipping/carrier_mode.rb
+- lib/earth/shipping/carrier_mode/data_miner.rb
 - lib/earth/shipping/data_miner.rb
 - lib/earth/shipping/shipment_mode.rb
 - lib/earth/shipping/shipment_mode/data_miner.rb