earth-ruby19 0.2.3

data/lib/earth/automobile/data_miner.rb

@@ -0,0 +1,8 @@
+require 'earth/automobile/automobile_fuel_type/data_miner'
+require 'earth/automobile/automobile_make/data_miner'
+require 'earth/automobile/automobile_make_fleet_year/data_miner'
+require 'earth/automobile/automobile_make_year/data_miner'
+require 'earth/automobile/automobile_model/data_miner'
+require 'earth/automobile/automobile_model_year/data_miner'
+require 'earth/automobile/automobile_size_class/data_miner'
+require 'earth/automobile/automobile_variant/data_miner'

data/lib/earth/base.rb

@@ -0,0 +1,7 @@
+module Earth
+  module Base
+    def define_schema(data_miner)
+      data_miner.schema Earth.database_options, &self.schema_definition
+    end
+  end
+end

data/lib/earth/bus.rb

@@ -0,0 +1 @@
+require 'earth/bus/bus_class'

data/lib/earth/bus/bus_class.rb

@@ -0,0 +1,19 @@
+class BusClass < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :bus_trips
+  
+  # https://brighterplanet.sifterapp.com/projects/30/issues/454
+  falls_back_on :distance => 5.45.miles.to(:kilometres),
+                :passengers => 8.25,
+                :speed => 19.67.miles.to(:kilometres),
+                :duration => 0.277,
+                :diesel_intensity => 0.143.gallons_per_mile.to(:litres_per_kilometre),
+                :gasoline_intensity => 0.000123.gallons_per_mile.to(:litres_per_kilometre),
+                :alternative_fuels_intensity => 0.0517.gallons_per_mile.to(:litres_per_kilometre),
+                :fugitive_air_conditioning_emission => 0.0203.pounds_per_mile.to(:kilograms_per_kilometre)
+
+  data_miner do
+    tap "Brighter Planet's sanitized bus class data", Earth.taps_server
+  end
+end

data/lib/earth/bus/bus_class/data_miner.rb

@@ -0,0 +1,41 @@
+BusClass.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'distance'
+      string 'distance_units'
+      float  'passengers'
+      float  'speed'
+      string 'speed_units'
+      float  'duration'
+      string 'duration_units'
+      float  'diesel_intensity'
+      string 'diesel_intensity_units'
+      float  'gasoline_intensity'
+      string 'gasoline_intensity_units'
+      float  'alternative_fuels_intensity'
+      string 'alternative_fuels_intensity_units'
+      float  'fugitive_air_conditioning_emission'
+      string 'fugitive_air_conditioning_emission_units'
+    end
+    
+    process "Define some necessary conversions" do
+      Conversions.register :gallons_per_mile, :litres_per_kilometre, 2.35214583
+      Conversions.register :pounds_per_mile, :kilograms_per_kilometre, 0.281849232
+    end
+    
+    import "a list of bus classes and pre-calculated trip and fuel use characteristics",
+           :url => 'http://static.brighterplanet.com/science/data/transport/bus/bus_classes.csv' do
+      key   'name'
+      store 'distance', :from_units => :miles, :to_units => :kilometres
+      store 'passengers'
+      store 'speed', :from_units => :miles, :to_units => :kilometres
+      store 'duration', :units => :minutes
+      store 'diesel_intensity', :field_name => 'diesel_per_vehicle_mile', :from_units => :gallons_per_mile, :to_units => :litres_per_kilometre
+      store 'gasoline_intensity', :field_name => 'gasoline_per_vehicle_mile', :from_units => :gallons_per_mile, :to_units => :litres_per_kilometre
+      store 'alternative_fuels_intensity', :field_name => 'alternative_fuels_per_vehicle_mile', :from_units => :gallons_per_mile, :to_units => :litres_per_kilometre
+      store 'fugitive_air_conditioning_emission', :field_name => 'fugitive_air_conditioning_emission_per_vehicle_mile', :from_units => :pounds_per_mile, :to_units => :kilograms_per_kilometre
+    end
+  end
+end
+

data/lib/earth/bus/data_miner.rb

@@ -0,0 +1 @@
+require 'earth/bus/bus_class/data_miner'

data/lib/earth/conversions_ext.rb

@@ -0,0 +1,45 @@
+require 'conversions'
+Conversions.register(:miles, :nautical_miles, 0.868976242)
+Conversions.register(:kilometres, :nautical_miles, 0.539956803)
+Conversions.register(:pounds_per_gallon, :kilograms_per_litre, 0.119826427)
+Conversions.register(:inches, :meters, 0.0254)
+Conversions.register(:kilowatt_hours, :watt_hours, 1_000.0)
+Conversions.register(:kilowatt_hours, :btus, 3_412.14163) # obsolete?
+Conversions.register(:watt_hours, :btus, 3.4121414799) # obsolete?
+Conversions.register(:watt_hours, :joules, 3_600.0)
+Conversions.register(:kilowatt_hours, :joules, 3_600_000.0)
+
+# Conversions.register(:btus, :gallons_of_kerosene, 0.000007419521097)
+Conversions.register(:joules, :litres_of_kerosene, 1.0 / (135_000.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
+
+# Conversions.register(:btus, :gallons_of_propane, 0.000010471204188)
+Conversions.register(:joules, :litres_of_propane, 1.0 / (91_333.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
+
+# Conversions.register(:btus, :therms, 0.000010002388121)
+Conversions.register(:therms, :joules, 105_505_585.0) # should only be used for RECS 2005
+
+# Conversions.register(:btus, :gallons_of_fuel_oil, 0.0000072007637183)
+Conversions.register(:joules, :litres_of_fuel_oil, 1.0 / (138_690.0 * 3.78541178 * 1_055.05585)) # should only be used for RECS 2005
+
+# Conversions.register(:tons_of_coal, :btus, 20_169_000.0)
+Conversions.register(:joules, :kilograms_of_coal, 1.0 / (22_342_000.0 * 0.00110231131 * 1_055.05585)) # should only be used for RECS 2005
+
+Conversions.register(:kilograms, :lbs, 2.20462262)
+Conversions.register(:kbtus, :btus, 1_000.0)
+Conversions.register(:square_feet, :square_metres, 0.09290304)
+Conversions.register(:pounds_per_square_foot, :kilograms_per_square_metre, 4.88242764)
+Conversions.register(:kilograms_per_kilowatt_hour, :kilograms_per_megawatt_hour, 1_000.0)
+Conversions.register(:btus, :joules, 1_055.05585)
+Conversions.register(:kbtus, :joules, 1_000.0 * 1_055.05585)
+Conversions.register(:cords, :joules, 2.11011171e10)
+
+Conversions.register(:gallons_per_mile, :litres_per_kilometre, 2.35214583)
+Conversions.register(:pounds_per_mile, :kilograms_per_kilometre, 0.281849232)
+Conversions.register(:dollars, :cents, 100)
+Conversions.register(:cubic_feet, :cubic_metres, 0.0283168466)
+# 1 (kilocalories per pound) = 9 224.14105 joules per kilogram
+Conversions.register :kilocalories_per_pound, :joules_per_kilogram, 9_224.14105
+# 1 (grams per kilocalories) = 2.39005736 × 10-7 kilograms per joules
+Conversions.register :grams_per_kilocalorie, :kilograms_per_joule, 2.39005736e-7
+# 1 joule = 0.000239005736 kilocalories
+Conversions.register :joules, :kilocalories, 0.000239005736

data/lib/earth/data_miner.rb

@@ -0,0 +1,10 @@
+require 'earth/air/data_miner'
+require 'earth/automobile/data_miner'
+require 'earth/bus/data_miner'
+require 'earth/diet/data_miner'
+require 'earth/fuel/data_miner'
+require 'earth/hospitality/data_miner'
+require 'earth/locality/data_miner'
+require 'earth/pet/data_miner'
+require 'earth/rail/data_miner'
+require 'earth/residence/data_miner'

data/lib/earth/diet.rb

@@ -0,0 +1,2 @@
+require 'earth/diet/diet_class'
+require 'earth/diet/food_group'

data/lib/earth/diet/data_miner.rb

@@ -0,0 +1,2 @@
+require 'earth/diet/diet_class/data_miner'
+require 'earth/diet/food_group/data_miner'

data/lib/earth/diet/diet_class.rb

@@ -0,0 +1,15 @@
+class DietClass < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :diets
+  
+  data_miner do
+    tap "Brighter Planet's diet class data", Earth.taps_server
+  end
+  
+  class << self
+    def fallback
+      find_by_name 'standard'
+    end
+  end
+end

data/lib/earth/diet/diet_class/data_miner.rb

@@ -0,0 +1,36 @@
+DietClass.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'intensity'
+      string 'intensity_units'
+      float  'red_meat_share'
+      float  'poultry_share'
+      float  'fish_share'
+      float  'eggs_share'
+      float  'nuts_share'
+      float  'dairy_share'
+      float  'cereals_and_grains_share'
+      float  'fruit_share'
+      float  'vegetables_share'
+      float  'oils_and_sugars_share'
+    end
+    
+    import "a Brighter Planet-defined list of diet classes and food group caloric distributions",
+           :url => 'http://static.brighterplanet.com/science/data/consumables/diets/diet_classes.csv' do
+      key   'name'
+      store 'intensity'
+      store 'red_meat_share'
+      store 'poultry_share'
+      store 'fish_share'
+      store 'eggs_share'
+      store 'nuts_share'
+      store 'dairy_share'
+      store 'cereals_and_grains_share'
+      store 'fruit_share'
+      store 'vegetables_share'
+      store 'oils_and_sugars_share'
+    end
+  end
+end
+

data/lib/earth/diet/food_group.rb

@@ -0,0 +1,17 @@
+class FoodGroup < ActiveRecord::Base
+  set_primary_key :name
+
+  class << self
+    def names
+      connection.select_values arel_table.project(:name).to_sql
+    end
+    
+    def [](name)
+      find_by_name name.to_s
+    end
+  end
+  
+  data_miner do
+    tap "Brighter Planet's food group data", Earth.taps_server
+  end
+end

data/lib/earth/diet/food_group/data_miner.rb

@@ -0,0 +1,26 @@
+FoodGroup.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string  'name'
+      float   'intensity'
+      string  'intensity_units'
+      float   'energy'
+      string  'energy_units'
+      string  'suggested_imperial_measurement' # ?
+    end
+    
+    import "a list of food groups and their emissions intensities",
+           :url => 'http://static.brighterplanet.com/science/data/consumables/diets/food_groups.csv' do
+      key   'name'
+      store 'intensity', :units => :grams_per_kilocalorie #FIXME TODO make sure diet expects kg / joule and then do :from_units => :grams_per_kilocalorie, :to_units => :kilograms_per_joule
+    end
+    
+    import "energy and units",
+           :url => 'http://spreadsheets.google.com/pub?key=trkBEq5oFnUQE76gQ6VpQgw' do
+      key   'name'
+      store 'energy', :units => 'unknown' #FIXME this needs to be "kilocalories per" and then whatever the suggested imperial measurement is
+      store 'suggested_imperial_measurement', :field_name => 'friendly_units'
+    end
+  end
+end
+

data/lib/earth/fuel.rb

@@ -0,0 +1,2 @@
+require 'earth/fuel/fuel_price'
+require 'earth/fuel/fuel_type'

data/lib/earth/fuel/data_miner.rb

@@ -0,0 +1,2 @@
+require 'earth/fuel/fuel_price/data_miner'
+require 'earth/fuel/fuel_type/data_miner'

data/lib/earth/fuel/fuel_price.rb

@@ -0,0 +1,13 @@
+class FuelPrice < ActiveRecord::Base
+  set_primary_key :name
+  
+  belongs_to :fuel_type, :foreign_key => 'name' # weird
+  
+  data_miner do
+    tap "Brighter Planet's fuel price data", Earth.taps_server
+    
+    process "pull dependencies" do
+      run_data_miner_on_belongs_to_associations
+    end
+  end
+end

data/lib/earth/fuel/fuel_price/data_miner.rb

@@ -0,0 +1,20 @@
+FuelPrice.class_eval do
+  # FIXME TODO phase 2
+  # location
+  # month/year
+
+  data_miner do
+    schema Earth.database_options do
+      string  'name'
+      float   'price'
+      string  'price_units'
+    end
+    
+    import 'fuel prices derived from the EIA',
+           :url => 'http://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdHlSdXJoOFB5aEpHenJQbTVJdS1pMVE',
+           :select => lambda { |row| row['fuel_type_name'].present? } do
+      key   'name', :field_name => 'fuel_type_name'
+      store 'price', :units_field_name => 'price_units'
+    end
+  end
+end

data/lib/earth/fuel/fuel_type.rb

@@ -0,0 +1,18 @@
+class FuelType < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :prices, :class_name => 'FuelPrice', :foreign_key => 'name' # weird
+  
+  falls_back_on :emission_factor               => 1.0, #FIXME TODO put a real value here - also do we want to do emission factors in kg / kj?
+                :emission_factor_units         => 'FIXME',
+                :average_purchase_volume       => 100, #FIXME TODO put a real value here - also do we want to do volumes in kJ?
+                :average_purchase_volume_units => 'FIXME'
+  
+  data_miner do
+    tap "Brighter Planet's fuel types data", Earth.taps_server
+  end
+  
+  def price
+    prices.average :price
+  end
+end

data/lib/earth/fuel/fuel_type/data_miner.rb

@@ -0,0 +1,37 @@
+FuelType.class_eval do
+  # FIXME TODO phase 2
+  # annual emissions factors
+  # annual energy contents
+  # gas-specific emissions factors
+
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'emission_factor'
+      string 'emission_factor_units'
+      float  'average_purchase_volume'
+      string 'average_purchase_volume_units'
+      # float    'energy_content'
+      # string   'energy_content_units'
+      # float    'carbon_content'
+      # string   'carbon_content_units'
+    end
+    
+    # process "Define some necessary conversions" do
+    #   Conversions.register :teragrams_per_quadrillion_british_thermal_units, :kilograms_per_joule,         0.000000000947817123
+    #   Conversions.register :million_british_thermal_units_per_short_ton,     :joules_per_kilogram,         1.16300000
+    #   Conversions.register :million_british_thermal_units_per_cubic_foot,    :joules_per_cubic_metre, 37_258.9457
+    #   Conversions.register :million_british_thermal_units_per_barrel,        :joules_per_litre,            6.63610165
+    #   Conversions.register :carbon,                                          :carbon_dioxide,              3.66666667
+    # end
+    
+    import "a list of fuels and their emissions factors",
+           :url => 'http://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdDR3RjlTcWlsLTc2TzQ0cERTMElJbHc' do
+      key 'name', :field_name => 'fuel'
+      store 'emission_factor', :units_field_name => 'emission_factor_units'
+      store 'average_purchase_volume', :units_field_name => 'average_purchase_volume_units'
+      # store 'energy_content', :field_name => 'energy_content', :units_field_name => 'energy_content_units', :to_units => 'FIXME' # FIXME need different conversions for different rows...
+      # store 'carbon_content', :field_name => 'carbon_content', :units_field_name => 'carbon_content_units', :to_units => :kilograms_per_joule
+    end
+  end
+end

data/lib/earth/hospitality.rb

@@ -0,0 +1 @@
+require 'earth/hospitality/lodging_class'

data/lib/earth/hospitality/data_miner.rb

@@ -0,0 +1 @@
+require 'earth/hospitality/lodging_class/data_miner'

data/lib/earth/hospitality/lodging_class.rb

@@ -0,0 +1,9 @@
+class LodgingClass < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :lodgings
+  
+  data_miner do
+    tap "Brighter Planet's lodging class data", Earth.taps_server
+  end
+end

data/lib/earth/hospitality/lodging_class/data_miner.rb

@@ -0,0 +1,30 @@
+LodgingClass.class_eval do
+  data_miner do
+    schema Earth.database_options do
+      string 'name'
+      float  'natural_gas_intensity'
+      string 'natural_gas_intensity_units'
+      float  'fuel_oil_intensity'
+      string 'fuel_oil_intensity_units'
+      float  'electricity_intensity'
+      string 'electricity_intensity_units'
+      float  'district_heat_intensity'
+      string 'district_heat_intensity_units'
+    end
+    
+    process "Define some unit conversions" do
+      Conversions.register :hundred_cubic_feet_per_room_night, :cubic_metres_per_room_night,        2.831685
+      Conversions.register :gallons_per_room_night,            :litres_per_room_night,              3.785412
+      Conversions.register :thousand_btu_per_room_night,       :joules_per_room_night,      1_055_056
+    end
+    
+    import "a list of lodging classes and pre-calculated emission factors",
+           :url => 'https://spreadsheets.google.com/pub?key=0AoQJbWqPrREqdGZZWmZtWEJlYzhRNXlPdWpBTldlcUE&hl=en&output=csv' do
+      key   'name'
+      store 'natural_gas_intensity', :from_units => :hundred_cubic_feet_per_room_night, :to_units => :cubic_metres_per_room_night
+      store 'fuel_oil_intensity', :from_units => :gallons_per_room_night, :to_units => :litres_per_room_night
+      store 'electricity_intensity', :units_field_name => 'electricity_intensity_units'
+      store 'district_heat_intensity', :from_units => :thousand_btu_per_room_night, :to_units => :joules_per_room_night
+    end
+  end
+end

data/lib/earth/industry.rb

@@ -0,0 +1,10 @@
+require 'earth/industry/industry_product_line'
+require 'earth/industry/industry_sector'
+require 'earth/industry/industry'
+require 'earth/industry/industry_product'
+require 'earth/industry/merchant'
+require 'earth/industry/merchant_category_industry'
+require 'earth/industry/merchant_category'
+require 'earth/industry/product_line'
+require 'earth/industry/product_line_industry_product'
+require 'earth/industry/sector'

data/lib/earth/industry/industry.rb

@@ -0,0 +1,23 @@
+class Industry < ActiveRecord::Base
+  extend Earth::Base
+  set_primary_key :naics_code
+  
+  has_many :merchant_category_industries, :foreign_key => 'naics_code'
+  
+  has_many :industry_product_lines, :foreign_key => 'naics_code'
+  has_many :product_lines, :through => :industry_product_lines
+  
+  has_many :industry_sectors, :foreign_key => 'naics_code'
+  has_many :sectors, :through => :industry_sectors
+  
+  def self.schema_definition
+    lambda do
+      string 'naics_code'
+      string 'description'
+    end
+  end
+
+  data_miner do
+    Industry.define_schema(self)
+  end
+end