earth 0.12.4 → 1.0.0

data/lib/earth/locality/country/data_miner.rb

@@ -1,14 +1,14 @@
-require 'earth/automobile/data_miner'
-require 'earth/fuel/data_miner'
-require 'earth/hospitality/data_miner'
-require 'earth/rail/data_miner'
+require 'earth/automobile/automobile_activity_year_type_fuel'
+require 'earth/fuel/greenhouse_gas'
+require 'earth/hospitality/commercial_building_energy_consumption_survey_response'
+require 'earth/locality/country'
+require 'earth/locality/egrid_subregion'
+require 'earth/locality/electricity_mix'
+require 'earth/rail/rail_company'
+require 'earth/rail/rail_fuel'
 
 Country.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     # http://www.iso.org/iso/list-en1-semic-3.txt
     # http://unstats.un.org/unsd/methods/m49/m49alpha.htm
     import "OpenGeoCode.org's Country Codes to Country Names list",

data/lib/earth/locality/egrid_country.rb

@@ -1,4 +1,26 @@
+require 'earth/model'
+
 class EgridCountry < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE egrid_countries
+  (
+     name                       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     generation                 FLOAT,
+     generation_units           CHARACTER VARYING(255),
+     foreign_interchange        FLOAT,
+     foreign_interchange_units  CHARACTER VARYING(255),
+     domestic_interchange       FLOAT,
+     domestic_interchange_units CHARACTER VARYING(255),
+     consumption                FLOAT,
+     consumption_units          CHARACTER VARYING(255),
+     loss_factor                FLOAT
+  );
+
+EOS
+
   self.primary_key = "name"
   
   class << self
@@ -7,16 +29,6 @@ class EgridCountry < ActiveRecord::Base
     end
   end
   
-  col :name
-  col :generation, :type => :float
-  col :generation_units
-  col :foreign_interchange, :type => :float
-  col :foreign_interchange_units
-  col :domestic_interchange, :type => :float
-  col :domestic_interchange_units
-  col :consumption, :type => :float
-  col :consumption_units
-  col :loss_factor, :type => :float
   
   warn_unless_size 1
   warn_if_any_nulls

data/lib/earth/locality/egrid_region.rb

@@ -1,6 +1,31 @@
+require 'falls_back_on'
+
+require 'earth/model'
+
 require 'earth/locality/egrid_country'
+require 'earth/locality/egrid_subregion'
 
 class EgridRegion < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE egrid_regions
+  (
+     name                       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     generation                 FLOAT,
+     generation_units           CHARACTER VARYING(255),
+     foreign_interchange        FLOAT,
+     foreign_interchange_units  CHARACTER VARYING(255),
+     domestic_interchange       FLOAT,
+     domestic_interchange_units CHARACTER VARYING(255),
+     consumption                FLOAT,
+     consumption_units          CHARACTER VARYING(255),
+     loss_factor                FLOAT
+  );
+
+EOS
+
   self.primary_key = "name"
   
   # EgridCountry must be a parent so that it automatically gets data_mined (needed for fallback calculation)
@@ -10,16 +35,6 @@ class EgridRegion < ActiveRecord::Base
   falls_back_on :name => 'fallback',
                 :loss_factor => lambda { EgridCountry.us.loss_factor }
   
-  col :name
-  col :generation, :type => :float
-  col :generation_units
-  col :foreign_interchange, :type => :float
-  col :foreign_interchange_units
-  col :domestic_interchange, :type => :float
-  col :domestic_interchange_units
-  col :consumption, :type => :float
-  col :consumption_units
-  col :loss_factor, :type => :float
   
   warn_unless_size 5
   warn_if_any_nulls

data/lib/earth/locality/egrid_region/data_miner.rb

@@ -1,9 +1,5 @@
 EgridRegion.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     import "eGRID 2012 region data",
            :url => 'http://www.epa.gov/cleanenergy/documents/egridzips/eGRID2012V1_0_year09_DATA.xls',
            :sheet => 'GGL09',

data/lib/earth/locality/egrid_subregion.rb

@@ -1,6 +1,37 @@
+require 'falls_back_on'
+
+require 'earth/model'
+
 require 'earth/locality/egrid_region'
+require 'earth/locality/electricity_mix'
 
 class EgridSubregion < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE egrid_subregions
+  (
+     abbreviation                       CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     name                               CHARACTER VARYING(255),
+     nerc_abbreviation                  CHARACTER VARYING(255),
+     egrid_region_name                  CHARACTER VARYING(255),
+     net_generation                     FLOAT,
+     net_generation_units               CHARACTER VARYING(255),
+     co2_emission_factor                FLOAT,
+     co2_emission_factor_units          CHARACTER VARYING(255),
+     co2_biogenic_emission_factor       FLOAT,
+     co2_biogenic_emission_factor_units CHARACTER VARYING(255),
+     ch4_emission_factor                FLOAT,
+     ch4_emission_factor_units          CHARACTER VARYING(255),
+     n2o_emission_factor                FLOAT,
+     n2o_emission_factor_units          CHARACTER VARYING(255),
+     electricity_emission_factor        FLOAT,
+     electricity_emission_factor_units  CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "abbreviation"
   
   belongs_to :egrid_region, :foreign_key => 'egrid_region_name'
@@ -19,22 +50,6 @@ class EgridSubregion < ActiveRecord::Base
                 :electricity_emission_factor => lambda { weighted_average(:electricity_emission_factor, :weighted_by => :net_generation) },
                 :electricity_emission_factor_units => 'kilograms_co2e_per_kilowatt_hour'
   
-  col :abbreviation
-  col :name
-  col :nerc_abbreviation
-  col :egrid_region_name
-  col :net_generation, :type => :float
-  col :net_generation_units
-  col :co2_emission_factor, :type => :float
-  col :co2_emission_factor_units
-  col :co2_biogenic_emission_factor, :type => :float
-  col :co2_biogenic_emission_factor_units
-  col :ch4_emission_factor, :type => :float
-  col :ch4_emission_factor_units
-  col :n2o_emission_factor, :type => :float
-  col :n2o_emission_factor_units
-  col :electricity_emission_factor, :type => :float
-  col :electricity_emission_factor_units
   
   warn_unless_size 26
   warn_if_any_nulls

data/lib/earth/locality/egrid_subregion/data_miner.rb

@@ -1,11 +1,8 @@
-require 'earth/fuel/data_miner'
+require 'earth/fuel/greenhouse_gas'
+require 'earth/locality/egrid_country'
 
 EgridSubregion.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     import "eGRID 2012 subregion data",
            :url => 'http://www.epa.gov/cleanenergy/documents/egridzips/eGRID2012V1_0_year09_DATA.xls',
            :sheet => 'SRL09',
@@ -25,7 +22,11 @@ EgridSubregion.class_eval do
       store 'egrid_region_name'
     end
     
-    process "Insure GreenhouseGas is populated" do
+    process "Ensure EgridCountry is populated" do
+      EgridCountry.run_data_miner!
+    end
+
+    process "Ensure GreenhouseGas is populated" do
       GreenhouseGas.run_data_miner!
     end
     

data/lib/earth/locality/electricity_mix.rb

@@ -1,4 +1,31 @@
+require 'falls_back_on'
+
+require 'earth/model'
+
 class ElectricityMix < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE electricity_mixes
+  (
+     name                               CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     egrid_subregion_abbreviation       CHARACTER VARYING(255),
+     state_postal_abbreviation          CHARACTER VARYING(255),
+     country_iso_3166_code              CHARACTER VARYING(255),
+     co2_emission_factor                FLOAT,
+     co2_emission_factor_units          CHARACTER VARYING(255),
+     co2_biogenic_emission_factor       FLOAT,
+     co2_biogenic_emission_factor_units CHARACTER VARYING(255),
+     ch4_emission_factor                FLOAT,
+     ch4_emission_factor_units          CHARACTER VARYING(255),
+     n2o_emission_factor                FLOAT,
+     n2o_emission_factor_units          CHARACTER VARYING(255),
+     loss_factor                        FLOAT
+  );
+
+EOS
+
   self.primary_key = :name
   
   def energy_content
@@ -18,19 +45,6 @@ class ElectricityMix < ActiveRecord::Base
                 :n2o_emission_factor_units => 'kilograms_co2e_per_kilowatt_hour',
                 :loss_factor => 0.096 # from ecometrica paper FIXME TODO calculate this
   
-  col :name
-  col :egrid_subregion_abbreviation
-  col :state_postal_abbreviation
-  col :country_iso_3166_code
-  col :co2_emission_factor, :type => :float
-  col :co2_emission_factor_units
-  col :co2_biogenic_emission_factor, :type => :float
-  col :co2_biogenic_emission_factor_units
-  col :ch4_emission_factor, :type => :float
-  col :ch4_emission_factor_units
-  col :n2o_emission_factor, :type => :float
-  col :n2o_emission_factor_units
-  col :loss_factor, :type => :float
   
   warn_unless_size 187
   warn_if_any_nulls

data/lib/earth/locality/electricity_mix/data_miner.rb

@@ -1,13 +1,17 @@
+require 'earth/fuel/greenhouse_gas'
+require 'earth/locality/egrid_subregion'
+require 'earth/locality/state'
+
 ElectricityMix.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     process "Ensure GreenhouseGas is populated" do
       GreenhouseGas.run_data_miner!
     end
     
+    process "Ensure EgridSubregion is populated" do
+      EgridSubregion.run_data_miner!
+    end
+    
     import "national electricity mixes from Brander et al. (2011)",
            :url => "file://#{Earth::DATA_DIR}/locality/national_electricity_efs.csv" do
       key :name, :synthesize => lambda { |row| [row['country_iso_3166_code'], 'national electricity'].join(' ') }
@@ -18,10 +22,6 @@ ElectricityMix.class_eval do
       store :loss_factor
     end
     
-    process "Ensure EgridSubregion is populated" do
-      EgridSubregion.run_data_miner!
-    end
-    
     process "Derive eGRID subregion electricity mixes" do
       EgridSubregion.safe_find_each do |subregion|
         mix = find_or_create_by_name [subregion.abbreviation, 'egrid subregion electricity'].join(' ')

data/lib/earth/locality/petroleum_administration_for_defense_district.rb

@@ -1,4 +1,21 @@
+require 'earth/model'
+
 class PetroleumAdministrationForDefenseDistrict < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE petroleum_districts
+  (
+     code             CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     district_code    CHARACTER VARYING(255),
+     district_name    CHARACTER VARYING(255),
+     subdistrict_code CHARACTER VARYING(255),
+     subdistrict_name CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "code"
   self.table_name = :petroleum_districts
   
@@ -8,11 +25,6 @@ class PetroleumAdministrationForDefenseDistrict < ActiveRecord::Base
     str
   end
   
-  col :code
-  col :district_code
-  col :district_name
-  col :subdistrict_code
-  col :subdistrict_name
 
   warn_if_nulls_except(
     :subdistrict_code,

data/lib/earth/locality/state.rb

@@ -1,4 +1,40 @@
+require 'earth/model'
+
+require 'earth/locality/census_division'
+require 'earth/locality/census_region'
+require 'earth/locality/climate_division'
+require 'earth/locality/country'
+require 'earth/locality/electricity_mix'
+require 'earth/locality/petroleum_administration_for_defense_district'
+require 'earth/locality/zip_code'
+
 class State < ActiveRecord::Base
+  data_miner do
+    process "Ensure Country and ElectricityMix are imported because they're like belongs_to associations" do
+      Country.run_data_miner!
+      ElectricityMix.run_data_miner!
+    end
+  end
+
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE states
+  (
+     postal_abbreviation                                CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     fips_code                                          INTEGER,
+     name                                               CHARACTER VARYING(255),
+     census_division_number                             INTEGER,
+     petroleum_administration_for_defense_district_code CHARACTER VARYING(255),
+     population                                         INTEGER,
+     electricity_emission_factor                        FLOAT,
+     electricity_emission_factor_units                  CHARACTER VARYING(255),
+     electricity_loss_factor                            FLOAT
+  );
+
+EOS
+
   self.primary_key = "postal_abbreviation"
   
   has_many :zip_codes,         :foreign_key => 'state_postal_abbreviation'
@@ -8,26 +44,10 @@ class State < ActiveRecord::Base
   has_one :electricity_mix, :foreign_key => 'state_postal_abbreviation'
   belongs_to :petroleum_administration_for_defense_district, :foreign_key => 'petroleum_administration_for_defense_district_code'
   
-  data_miner do
-    process "Ensure Country and ElectricityMix are imported because they're like belongs_to associations" do
-      Country.run_data_miner!
-      ElectricityMix.run_data_miner!
-    end
-  end
-  
   def country
     Country.united_states
   end
   
-  col :postal_abbreviation
-  col :fips_code, :type => :integer
-  col :name
-  col :census_division_number, :type => :integer
-  col :petroleum_administration_for_defense_district_code
-  col :population, :type => :integer
-  col :electricity_emission_factor, :type => :float
-  col :electricity_emission_factor_units
-  col :electricity_loss_factor, :type => :float
   
   warn_if_nulls_except(
     :census_division_number,

data/lib/earth/locality/state/data_miner.rb

@@ -1,9 +1,5 @@
 State.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     # state names, FIPS codes, and postal abbreviations
     import 'the U.S. Census State ANSI Code file',
            :url => 'http://www.census.gov/geo/www/ansi/state.txt',

data/lib/earth/locality/zip_code.rb

@@ -1,6 +1,39 @@
-require ::File.join(Earth::VENDOR_DIR, 'geokit-rails', 'lib', 'geokit-rails') # for acts_as_mappable
+require 'earth/model'
+require 'earth/loader'
+Earth::Loader.load_plugins
+
+require 'earth/locality/climate_division'
+require 'earth/locality/country'
+require 'earth/locality/egrid_subregion'
+require 'earth/locality/state'
+require 'earth/electricity/electric_market'
+require 'earth/electricity/electric_utility'
 
 class ZipCode < ActiveRecord::Base
+  data_miner do
+    process "Ensure Country is imported because it's like a belongs_to association" do
+      Country.run_data_miner!
+    end
+  end
+
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE zip_codes
+  (
+     name                         CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     state_postal_abbreviation    CHARACTER VARYING(255),
+     description                  CHARACTER VARYING(255),
+     latitude                     CHARACTER VARYING(255),
+     longitude                    CHARACTER VARYING(255),
+     egrid_subregion_abbreviation CHARACTER VARYING(255),
+     climate_division_name        CHARACTER VARYING(255),
+     population                   INTEGER
+  );
+
+EOS
+
   self.primary_key = "name"
   
   belongs_to :climate_division, :foreign_key => 'climate_division_name'
@@ -11,12 +44,6 @@ class ZipCode < ActiveRecord::Base
   
   scope :known_subregion, where('egrid_subregion_abbreviation IS NOT NULL')
   
-  data_miner do
-    process "Ensure Country is imported because it's like a belongs_to association" do
-      Country.run_data_miner!
-    end
-  end
-  
   def country
     Country.united_states
   end
@@ -31,14 +58,6 @@ class ZipCode < ActiveRecord::Base
                    :lat_column_name => :latitude,
                    :lng_column_name => :longitude
   
-  col :name
-  col :state_postal_abbreviation
-  col :description
-  col :latitude
-  col :longitude
-  col :egrid_subregion_abbreviation
-  col :climate_division_name
-  col :population, :type => :integer
   
   warn_unless_size 43770
   warn_if_nonexistent_owner_except :egrid_subregion