earth 0.12.4 → 1.0.0

data/lib/earth/diet/food_group.rb

@@ -1,4 +1,22 @@
+require 'earth/model'
+
 class FoodGroup < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE food_groups
+  (
+     name                           CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     intensity                      FLOAT,
+     intensity_units                CHARACTER VARYING(255),
+     energy                         FLOAT,
+     energy_units                   CHARACTER VARYING(255),
+     suggested_imperial_measurement CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
 
   class << self
@@ -11,12 +29,5 @@ class FoodGroup < ActiveRecord::Base
     end
   end
   
-  col :name
-  col :intensity, :type => :float
-  col :intensity_units
-  col :energy, :type => :float
-  col :energy_units
-  col :suggested_imperial_measurement # ?
-
   warn_unless_size 10
 end

data/lib/earth/electricity.rb

@@ -1,3 +1,3 @@
 # lib/earth/electricity.rb
 require 'earth'
-Earth.require_related __FILE__
+Earth::Loader.require_related __FILE__

data/lib/earth/electricity/electric_market.rb

@@ -1,12 +1,24 @@
-require 'earth/locality'
+require 'earth/model'
+
+require 'earth/electricity/electric_utility'
+require 'earth/locality/zip_code'
 
 class ElectricMarket < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE electric_markets
+  (
+     id                      CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     electric_utility_eia_id INTEGER,
+     zip_code_name           CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "id" # string
   
   belongs_to :electric_utility, :foreign_key => 'electric_utility_eia_id'
   belongs_to :zip_code, :foreign_key => 'zip_code_name'
-  
-  col :id
-  col :electric_utility_eia_id, :type => :integer
-  col :zip_code_name
 end

data/lib/earth/electricity/electric_market/data_miner.rb

@@ -1,5 +1,3 @@
-require 'earth/locality/data_miner'
-
 ElectricMarket.class_eval do
   data_miner do
     import 'IOU markets',

data/lib/earth/electricity/electric_utility.rb

@@ -1,18 +1,33 @@
-require 'earth/locality'
+require 'earth/model'
+
+require 'earth/electricity/electric_market'
+require 'earth/electricity/green_button_adoption'
+require 'earth/locality/state'
+require 'earth/locality/zip_code'
 
 class ElectricUtility < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE electric_utilities
+  (
+     eia_id                          INTEGER NOT NULL PRIMARY KEY,
+     name                            CHARACTER VARYING(255),
+     nickname                        CHARACTER VARYING(255),
+     state_postal_abbreviation       CHARACTER VARYING(255),
+     nerc_region_abbreviation        CHARACTER VARYING(255),
+     second_nerc_region_abbreviation CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "eia_id"
   
   belongs_to :state, :foreign_key => 'state_postal_abbreviation'
   has_many :electric_markets, :foreign_key => :electric_utility_eia_id
   has_many :zip_codes, :through => :electric_markets
   
-  col :eia_id, :type => :integer
-  col :name
-  col :nickname
-  col :state_postal_abbreviation
-  col :nerc_region_abbreviation
-  col :second_nerc_region_abbreviation
 
   def green_button_implementer?
     GreenButtonAdoption.implemented? name, nickname 

data/lib/earth/electricity/electric_utility/data_miner.rb

@@ -1,4 +1,4 @@
-require 'earth/locality/data_miner'
+require 'earth/electricity/green_button_adoption'
 
 ElectricUtility.class_eval do
   data_miner do

data/lib/earth/electricity/green_button_adoption.rb

@@ -1,9 +1,21 @@
+require 'earth/model'
+
 class GreenButtonAdoption < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE green_button_adoptions
+  (
+     electric_utility_name CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     implemented           BOOLEAN,
+     committed             BOOLEAN
+  );
+
+EOS
+
   self.primary_key = "electric_utility_name"
   
-  col :electric_utility_name
-  col :implemented, :type => :boolean
-  col :committed, :type => :boolean
 
   class << self
     def implemented?(*names)

data/lib/earth/fuel.rb

@@ -1,3 +1,3 @@
 # lib/earth/fuel.rb
 require 'earth'
-Earth.require_related __FILE__
+Earth::Loader.require_related __FILE__

data/lib/earth/fuel/fuel.rb

@@ -1,23 +1,8 @@
+require 'earth/model'
+
+require 'earth/fuel/fuel_year'
+
 class Fuel < ActiveRecord::Base
-  self.primary_key = "name"
-  
-  has_many :fuel_years, :foreign_key => 'fuel_name'
-  
-  col :name
-  col :physical_units
-  col :density, :type => :float
-  col :density_units
-  col :energy_content, :type => :float
-  col :energy_content_units
-  col :carbon_content, :type => :float
-  col :carbon_content_units
-  col :oxidation_factor, :type => :float
-  col :biogenic_fraction, :type => :float
-  col :co2_emission_factor, :type => :float
-  col :co2_emission_factor_units
-  col :co2_biogenic_emission_factor, :type => :float
-  col :co2_biogenic_emission_factor_units
-  
   # Need to ensure FuelYear gets data_mined even when pulling with taps
   # b/c Fuel has instance methods to look up missing values from FuelYear
   data_miner do
@@ -26,6 +11,34 @@ class Fuel < ActiveRecord::Base
     end
   end
   
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE fuels
+  (
+     name                               CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     physical_units                     CHARACTER VARYING(255),
+     density                            FLOAT,
+     density_units                      CHARACTER VARYING(255),
+     energy_content                     FLOAT,
+     energy_content_units               CHARACTER VARYING(255),
+     carbon_content                     FLOAT,
+     carbon_content_units               CHARACTER VARYING(255),
+     oxidation_factor                   FLOAT,
+     biogenic_fraction                  FLOAT,
+     co2_emission_factor                FLOAT,
+     co2_emission_factor_units          CHARACTER VARYING(255),
+     co2_biogenic_emission_factor       FLOAT,
+     co2_biogenic_emission_factor_units CHARACTER VARYING(255)
+  );
+
+EOS
+
+  self.primary_key = "name"
+  
+  has_many :fuel_years, :foreign_key => 'fuel_name'
+  
   def latest_fuel_year
     fuel_years.find_by_year(fuel_years.maximum('year'))
   end

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

@@ -1,9 +1,7 @@
+require 'earth/fuel/fuel_year'
+
 Fuel.class_eval do
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     process "Ensure FuelYear is populated" do
       FuelYear.run_data_miner!
     end

data/lib/earth/fuel/fuel_price.rb

@@ -1,11 +1,25 @@
+require 'earth/model'
+
+require 'earth/fuel/fuel_type'
+
 class FuelPrice < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE fuel_prices
+  (
+     name        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     price       FLOAT,
+     price_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
   
   belongs_to :fuel_type, :foreign_key => 'name' # weird
   
-  col :name
-  col :price, :type => :float
-  col :price_units
 
   warn_unless_size 34
 end

data/lib/earth/fuel/fuel_type.rb

@@ -1,5 +1,28 @@
+require 'falls_back_on'
+
+require 'earth/model'
+
+require 'earth/fuel/fuel_price'
+
 # DEPRECATED but FuelPurchase still uses this
 class FuelType < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE fuel_types
+  (
+     name                          CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     emission_factor               FLOAT,
+     emission_factor_units         CHARACTER VARYING(255),
+     density                       FLOAT,
+     density_units                 CHARACTER VARYING(255),
+     average_purchase_volume       FLOAT,
+     average_purchase_volume_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
   
   has_many :prices, :class_name => 'FuelPrice', :foreign_key => 'name' # weird
@@ -13,17 +36,5 @@ class FuelType < ActiveRecord::Base
     prices.average :price
   end
   
-  col :name
-  col :emission_factor, :type => :float
-  col :emission_factor_units
-  col :density, :type => :float
-  col :density_units
-  col :average_purchase_volume, :type => :float
-  col :average_purchase_volume_units
-  # col :energy_content, :type => :float
-  # col :energy_content_units
-  # col :carbon_content, :type => :float
-  # col :carbon_content_units
-
   warn_unless_size 36
 end

data/lib/earth/fuel/fuel_year.rb

@@ -1,21 +1,35 @@
+require 'earth/model'
+
+require 'earth/fuel/fuel'
+
 class FuelYear < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE fuel_years
+  (
+     name                               CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     fuel_name                          CHARACTER VARYING(255),
+     year                               INTEGER,
+     energy_content                     FLOAT,
+     energy_content_units               CHARACTER VARYING(255),
+     carbon_content                     FLOAT,
+     carbon_content_units               CHARACTER VARYING(255),
+     oxidation_factor                   FLOAT,
+     biogenic_fraction                  FLOAT,
+     co2_emission_factor                FLOAT,
+     co2_emission_factor_units          CHARACTER VARYING(255),
+     co2_biogenic_emission_factor       FLOAT,
+     co2_biogenic_emission_factor_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
   
   belongs_to :fuel, :foreign_key => 'fuel_name'
   
-  col :name
-  col :fuel_name
-  col :year, :type => :integer
-  col :energy_content, :type => :float
-  col :energy_content_units
-  col :carbon_content, :type => :float
-  col :carbon_content_units
-  col :oxidation_factor, :type => :float
-  col :biogenic_fraction, :type => :float
-  col :co2_emission_factor, :type => :float
-  col :co2_emission_factor_units
-  col :co2_biogenic_emission_factor, :type => :float
-  col :co2_biogenic_emission_factor_units
   
   # FIXME TODO verify fuel name is in Fuel
   # verify "Fuel name should never be missing" do

data/lib/earth/fuel/greenhouse_gas.rb

@@ -1,4 +1,22 @@
+require 'earth/model'
+
 class GreenhouseGas < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE greenhouse_gases
+  (
+     name                     CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     abbreviation             CHARACTER VARYING(255),
+     ipcc_report              CHARACTER VARYING(255),
+     time_horizon             INTEGER,
+     time_horizon_units       CHARACTER VARYING(255),
+     global_warming_potential INTEGER
+  );
+
+EOS
+
   self.primary_key = "name"
     
   class << self
@@ -7,12 +25,6 @@ class GreenhouseGas < ActiveRecord::Base
     end
   end
   
-  col :name
-  col :abbreviation
-  col :ipcc_report
-  col :time_horizon, :type => :integer
-  col :time_horizon_units
-  col :global_warming_potential, :type => :integer
   
   # verify "Abbreviation and IPCC report should never be missing" do
   #   GreenhouseGas.all.each do |record|

data/lib/earth/hospitality.rb

@@ -1,3 +1,3 @@
 # lib/earth/hospitality.rb
 require 'earth'
-Earth.require_related __FILE__
+Earth::Loader.require_related __FILE__

data/lib/earth/hospitality/commercial_building_energy_consumption_survey_response.rb

@@ -1,64 +1,76 @@
+require 'earth/model'
+
 class CommercialBuildingEnergyConsumptionSurveyResponse < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE cbecs_responses
+  (
+     id                                 INTEGER NOT NULL PRIMARY KEY,
+     census_region_number               INTEGER,
+     census_division_number             INTEGER,
+     climate_zone_number                INTEGER,
+     heating_degree_days                FLOAT,
+     heating_degree_days_units          CHARACTER VARYING(255),
+     cooling_degree_days                FLOAT,
+     cooling_degree_days_units          CHARACTER VARYING(255),
+     construction_year                  INTEGER,
+     area                               FLOAT,
+     area_units                         CHARACTER VARYING(255),
+     floors                             INTEGER,
+     lodging_rooms                      INTEGER,
+     percent_cooled                     FLOAT,
+     food_prep_room                     BOOLEAN,
+     laundry_onsite                     BOOLEAN,
+     indoor_pool                        BOOLEAN,
+     principal_activity                 CHARACTER VARYING(255),
+     detailed_activity                  CHARACTER VARYING(255),
+     first_activity                     CHARACTER VARYING(255),
+     second_activity                    CHARACTER VARYING(255),
+     third_activity                     CHARACTER VARYING(255),
+     first_activity_share               FLOAT,
+     second_activity_share              FLOAT,
+     third_activity_share               FLOAT,
+     months_used                        INTEGER,
+     weekly_hours                       INTEGER,
+     electricity_use                    FLOAT,
+     electricity_use_units              CHARACTER VARYING(255),
+     electricity_energy                 FLOAT,
+     electricity_energy_units           CHARACTER VARYING(255),
+     natural_gas_use                    FLOAT,
+     natural_gas_use_units              CHARACTER VARYING(255),
+     natural_gas_energy                 FLOAT,
+     natural_gas_energy_units           CHARACTER VARYING(255),
+     fuel_oil_use                       FLOAT,
+     fuel_oil_use_units                 CHARACTER VARYING(255),
+     fuel_oil_energy                    FLOAT,
+     fuel_oil_energy_units              CHARACTER VARYING(255),
+     district_heat_use                  FLOAT,
+     district_heat_use_units            CHARACTER VARYING(255),
+     district_heat_energy               FLOAT,
+     district_heat_energy_units         CHARACTER VARYING(255),
+     stratum                            INTEGER,
+     pair                               INTEGER,
+     weighting                          FLOAT,
+     room_nights                        FLOAT,
+     /* what follow are for lodging fuzzy weighting */
+     electricity_per_room_night         FLOAT,
+     electricity_per_room_night_units   CHARACTER VARYING(255),
+     natural_gas_per_room_night         FLOAT,
+     natural_gas_per_room_night_units   CHARACTER VARYING(255),
+     fuel_oil_per_room_night            FLOAT,
+     fuel_oil_per_room_night_units      CHARACTER VARYING(255),
+     district_heat_per_room_night       FLOAT,
+     district_heat_per_room_night_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "id"
   self.table_name = :cbecs_responses
   
   def self.lodging_records
     where(:detailed_activity => ['Hotel', 'Motel or inn'], :first_activity => nil)
   end
-  
-  col :id,                     :type => :integer
-  col :census_region_number,   :type => :integer
-  col :census_division_number, :type => :integer
-  col :climate_zone_number,    :type => :integer
-  col :heating_degree_days,    :type => :float
-  col :heating_degree_days_units
-  col :cooling_degree_days,    :type => :float
-  col :cooling_degree_days_units
-  col :construction_year,      :type => :integer
-  col :area,                   :type => :float
-  col :area_units
-  col :floors,                 :type => :integer
-  col :lodging_rooms,          :type => :integer
-  col :percent_cooled,         :type => :float
-  col :food_prep_room,         :type => :boolean
-  col :laundry_onsite,         :type => :boolean
-  col :indoor_pool,            :type => :boolean
-  col :principal_activity
-  col :detailed_activity
-  col :first_activity
-  col :second_activity
-  col :third_activity
-  col :first_activity_share,   :type => :float
-  col :second_activity_share,  :type => :float
-  col :third_activity_share,   :type => :float
-  col :months_used,            :type => :integer
-  col :weekly_hours,           :type => :integer
-  col :electricity_use,        :type => :float
-  col :electricity_use_units
-  col :electricity_energy,     :type => :float
-  col :electricity_energy_units
-  col :natural_gas_use,        :type => :float
-  col :natural_gas_use_units
-  col :natural_gas_energy,     :type => :float
-  col :natural_gas_energy_units
-  col :fuel_oil_use,           :type => :float
-  col :fuel_oil_use_units
-  col :fuel_oil_energy,        :type => :float
-  col :fuel_oil_energy_units
-  col :district_heat_use,      :type => :float
-  col :district_heat_use_units
-  col :district_heat_energy,   :type => :float
-  col :district_heat_energy_units
-  col :stratum,                :type => :integer
-  col :pair,                   :type => :integer
-  col :weighting,              :type => :float
-  col :room_nights,            :type => :float
-  col :electricity_per_room_night, :type => :float   # for lodging fuzzy weighting
-  col :electricity_per_room_night_units              # for lodging fuzzy weighting
-  col :natural_gas_per_room_night, :type => :float   # for lodging fuzzy weighting
-  col :natural_gas_per_room_night_units              # for lodging fuzzy weighting
-  col :fuel_oil_per_room_night, :type => :float      # for lodging fuzzy weighting
-  col :fuel_oil_per_room_night_units                 # for lodging fuzzy weighting
-  col :district_heat_per_room_night, :type => :float # for lodging fuzzy weighting
-  col :district_heat_per_room_night_units            # for lodging fuzzy weighting
 end