earth 0.12.4 → 1.0.0

data/lib/earth/industry/naics_2002.rb

@@ -1,4 +1,24 @@
+require 'earth/model'
+
+require 'earth/industry/industry'
+require 'earth/industry/naics_2002_naics_2007_concordance'
+require 'earth/industry/naics_2002_sic_1987_concordance'
+require 'earth/industry/naics_2007'
+require 'earth/industry/sic_1987'
+
 class Naics2002 < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE naics_2002
+  (
+     code        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "code"
   self.table_name = "naics_2002"
   
@@ -9,7 +29,4 @@ class Naics2002 < ActiveRecord::Base
   
   has_many :naics_2002_naics_2007_concordances, :foreign_key => :naics_2002_code
   has_many :naics_2007, :through => :naics_2002_naics_2007_concordances
-  
-  col :code
-  col :description
 end

data/lib/earth/industry/naics_2002_naics_2007_concordance.rb

@@ -1,4 +1,23 @@
+require 'earth/model'
+
+require 'earth/industry/naics_2002'
+require 'earth/industry/naics_2007'
+
 class Naics2002Naics2007Concordance < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE naics2002_naics2007_concordances
+  (
+     row_hash        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     naics_2002_code CHARACTER VARYING(255),
+     naics_2007_code CHARACTER VARYING(255),
+     naics_2002_note CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "row_hash"
   
   belongs_to :naics_2002, :foreign_key => :naics_2002_code
@@ -9,8 +28,4 @@ class Naics2002Naics2007Concordance < ActiveRecord::Base
     (note = description.match(/ - (.+)/)) ? note.captures.first : nil
   end
   
-  col :row_hash
-  col :naics_2002_code
-  col :naics_2007_code
-  col :naics_2002_note
 end

data/lib/earth/industry/naics_2002_sic_1987_concordance.rb

@@ -1,4 +1,23 @@
+require 'earth/model'
+
+require 'earth/industry/naics_2002'
+require 'earth/industry/sic_1987'
+
 class Naics2002Sic1987Concordance < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE naics2002_sic1987_concordances
+  (
+     row_hash        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     naics_2002_code CHARACTER VARYING(255),
+     sic_1987_code   CHARACTER VARYING(255),
+     sic_note        CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "row_hash"
   
   belongs_to :naics_2002, :foreign_key => :naics_2002_code
@@ -9,8 +28,4 @@ class Naics2002Sic1987Concordance < ActiveRecord::Base
     (note = description.match /.+?\((.+)\)/) ? note.captures.first : nil
   end
   
-  col :row_hash
-  col :naics_2002_code
-  col :sic_1987_code
-  col :sic_note
 end

data/lib/earth/industry/naics_2007.rb

@@ -1,10 +1,25 @@
+require 'earth/model'
+
+require 'earth/industry/naics_2002_naics_2007_concordance'
+require 'earth/industry/naics_2002'
+
 class Naics2007 < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE naics_2007
+  (
+     code        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "code"
   self.table_name = "naics_2007"
   
   has_many :naics_2002_naics_2007_concordances, :foreign_key => :naics_2007_code
   has_many :naics_2002, :through => :naics_2002_naics_2007_concordances
   
-  col :code
-  col :description
 end

data/lib/earth/industry/product_line.rb

@@ -1,13 +1,28 @@
+require 'earth/model'
+
+require 'earth/industry/industry_product'
+require 'earth/industry/industry_product_line'
+require 'earth/industry/product_line_industry_product'
+
 class ProductLine < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE product_lines
+  (
+     ps_code     CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description TEXT,
+     broadline   CHARACTER VARYING(255), /* FIXME TODO do we need this? */
+     parent      CHARACTER VARYING(255)  /* FIXME TODO do we need this? */
+  );
+
+EOS
+
   self.primary_key = "ps_code"
   
   has_many :industry_product_lines,         :foreign_key => 'ps_code'
   
   has_many :product_line_industry_products, :foreign_key => 'ps_code'
   has_many :industry_products, :through => :product_line_industry_products
-  
-  col :ps_code
-  col :description, :type => :text
-  col :broadline # FIXME TODO do we need this?
-  col :parent    # FIXME TODO do we need this?
 end

data/lib/earth/industry/product_line_industry_product.rb

@@ -1,11 +1,25 @@
+require 'earth/model'
+
+require 'earth/industry/product_line'
+require 'earth/industry/industry_product'
+
 class ProductLineIndustryProduct < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE product_line_industry_products
+  (
+     row_hash           CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     ps_code            CHARACTER VARYING(255),
+     ratio              FLOAT,
+     naics_product_code CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "row_hash"
   
   belongs_to :product_line,     :foreign_key => 'ps_code'
   belongs_to :industry_product, :foreign_key => 'naics_product_code'
-
-  col :row_hash
-  col :ps_code
-  col :ratio, :type => :float
-  col :naics_product_code
 end

data/lib/earth/industry/sector.rb

@@ -1,10 +1,23 @@
+require 'earth/model'
+
+require 'earth/industry/industry_sector'
+
 class Sector < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE sectors
+  (
+     io_code     CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description TEXT,
+     value       FLOAT,
+     value_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "io_code"
 
   has_many :industry_sectors, :foreign_key => 'io_code'
-  
-  col :io_code
-  col :description, :type => :text
-  col :value, :type => :float
-  col :value_units
 end

data/lib/earth/industry/sic_1987.rb

@@ -1,4 +1,21 @@
+require 'earth/model'
+
+require 'earth/industry/naics_2002'
+require 'earth/industry/naics_2002_sic_1987_concordance'
+
 class Sic1987 < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE sic_1987
+  (
+     code        CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "code"
   self.table_name = "sic_1987"
   
@@ -10,6 +27,4 @@ class Sic1987 < ActiveRecord::Base
     (desc = description.match /^(.+?) \(/) ? desc.captures.first : description
   end
   
-  col :code
-  col :description
 end

data/lib/earth/loader.rb

@@ -0,0 +1,47 @@
+require 'earth'
+
+module Earth
+  module Loader
+    def Loader.require_related(path)
+      path = ::File.expand_path path
+      raise ::ArgumentError, %{[earth gem] #{path} is not in #{LIB_DIR}} unless path.start_with?(LIB_DIR)
+      domain = %r{#{LIB_DIR}/([^\./]+)}.match(path).captures.first
+      require_domain domain, :mine_original_sources => path.include?('data_miner')
+    end
+    
+    def Loader.require_all(options = {})
+      require_glob ::File.join(LIB_DIR, '**', '*.rb'), options
+    end
+    
+    def Loader.require_domain(domain, options = {})
+      require_glob ::File.join(LIB_DIR, domain.to_s, '**', '*.rb'), options 
+    end
+    
+    def Loader.require_glob(glob, options = {})
+      @require_glob ||= []
+      args = [glob, options]
+      return if @require_glob.include?(args)
+      @require_glob << args
+      data_miner_paths = []
+      ::Dir[glob].each do |path|
+        if path.include?('data_miner')
+          data_miner_paths << path
+        else
+          require path
+        end
+      end
+      # load data_miner blocks second to make sure they override
+      data_miner_paths.each do |path|
+        require path
+      end if options[:load_data_miner] || options[:mine_original_sources]
+      nil
+    end
+    
+    def Loader.load_plugins
+      Dir[File.expand_path('../../../vendor/**/init.rb', __FILE__)].each do |pluginit|
+        $LOAD_PATH.unshift ::File.join(::File.dirname(pluginit), 'lib')
+        Kernel.load pluginit
+      end
+    end
+  end
+end

data/lib/earth/locality.rb

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

data/lib/earth/locality/census_division.rb

@@ -1,5 +1,36 @@
-require 'earth/fuel'
+require 'falls_back_on'
+
+require 'earth/model'
+
+require 'earth/locality/census_region'
+require 'earth/locality/climate_division'
+require 'earth/locality/state'
+require 'earth/locality/zip_code'
+require 'earth/residence/residential_energy_consumption_survey_response'
+
 class CensusDivision < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE census_divisions
+  (
+     number                                         INTEGER NOT NULL PRIMARY KEY,
+     name                                           CHARACTER VARYING(255),
+     census_region_name                             CHARACTER VARYING(255),
+     census_region_number                           INTEGER,
+     meeting_building_natural_gas_intensity         FLOAT,
+     meeting_building_natural_gas_intensity_units   CHARACTER VARYING(255),
+     meeting_building_fuel_oil_intensity            FLOAT,
+     meeting_building_fuel_oil_intensity_units      CHARACTER VARYING(255),
+     meeting_building_electricity_intensity         FLOAT,
+     meeting_building_electricity_intensity_units   CHARACTER VARYING(255),
+     meeting_building_district_heat_intensity       FLOAT,
+     meeting_building_district_heat_intensity_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "number"
   
   belongs_to :census_region, :foreign_key => 'census_region_number'
@@ -15,18 +46,6 @@ class CensusDivision < ActiveRecord::Base
                 :meeting_building_electricity_intensity => 0.0084323684 / 1.square_feet.to(:square_metres),
                 :meeting_building_district_heat_intensity => 0.0004776370.kbtus.to(:megajoules) / 1.square_feet.to(:square_metres)
   
-  col :number, :type => :integer
-  col :name
-  col :census_region_name
-  col :census_region_number, :type => :integer
-  col :meeting_building_natural_gas_intensity, :type => :float
-  col :meeting_building_natural_gas_intensity_units
-  col :meeting_building_fuel_oil_intensity, :type => :float
-  col :meeting_building_fuel_oil_intensity_units
-  col :meeting_building_electricity_intensity, :type => :float
-  col :meeting_building_electricity_intensity_units
-  col :meeting_building_district_heat_intensity, :type => :float
-  col :meeting_building_district_heat_intensity_units
 
   warn_unless_size 9
 end

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

@@ -1,4 +1,3 @@
-require 'earth/fuel/data_miner'
 CensusDivision.class_eval do
   data_miner do
     # http://www.census.gov/popest/geographic/codes02.csv

data/lib/earth/locality/census_region.rb

@@ -1,14 +1,27 @@
+require 'earth/model'
+
+require 'earth/locality/census_division'
+require 'earth/locality/state'
+require 'earth/residence/residential_energy_consumption_survey_response'
+
 class CensusRegion < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE census_regions
+  (
+     number INTEGER NOT NULL PRIMARY KEY,
+     name   CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "number"
   
   has_many :census_divisions, :foreign_key => 'census_region_number'
   has_many :states, :through => :census_divisions
-  # has_many :climate_divisions, :through => :census_divisions
-  # has_many :zip_codes, :through => :census_divisions
   has_many :residential_energy_consumption_survey_responses, :foreign_key => 'census_region_number'
-  
-  col :number, :type => :integer
-  col :name
 
   warn_unless_size 4
 end

data/lib/earth/locality/climate_division.rb

@@ -1,4 +1,25 @@
+require 'earth/model'
+  
+require 'earth/locality/state'
+require 'earth/locality/zip_code'
+
 class ClimateDivision < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE climate_divisions
+  (
+     name                      CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     heating_degree_days       FLOAT,
+     heating_degree_days_units CHARACTER VARYING(255),
+     cooling_degree_days       FLOAT,
+     cooling_degree_days_units CHARACTER VARYING(255),
+     state_postal_abbreviation CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
   
   has_many :zip_codes, :foreign_key => 'climate_division_name'
@@ -6,12 +27,6 @@ class ClimateDivision < ActiveRecord::Base
   
   RADIUS = 750
   
-  col :name
-  col :heating_degree_days, :type => :float
-  col :heating_degree_days_units
-  col :cooling_degree_days, :type => :float
-  col :cooling_degree_days_units
-  col :state_postal_abbreviation
 
   warn_unless_size 359
 end

data/lib/earth/locality/country.rb

@@ -1,18 +1,78 @@
-require 'earth/automobile'
-require 'earth/hospitality'
-require 'earth/rail'
+require 'falls_back_on'
+
+require 'earth/model'
+
+require 'earth/locality/electricity_mix'
+require 'earth/rail/rail_company'
 
 class Country < ActiveRecord::Base
-  self.primary_key = "iso_3166_code"
-  
-  has_many :rail_companies,  :foreign_key => 'country_iso_3166_code' # used to calculate rail data
-  has_one :electricity_mix, :foreign_key => 'country_iso_3166_code'
-  
   data_miner do
     process "Ensure ElectricityMix is imported because it's like a belongs_to association" do
       ElectricityMix.run_data_miner!
     end
   end
+
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE countries
+  (
+     iso_3166_code                         CHARACTER VARYING(255) NOT NULL PRIMARY KEY, /* alpha-2 2-letter like GB */
+     iso_3166_numeric_code                 INTEGER,                                     /* numeric like 826; aka UN M49 code */
+     iso_3166_alpha_3_code                 CHARACTER VARYING(255),                      /* 3-letter like GBR */
+     name                                  CHARACTER VARYING(255),
+     heating_degree_days                   FLOAT,
+     heating_degree_days_units             CHARACTER VARYING(255),
+     cooling_degree_days                   FLOAT,
+     cooling_degree_days_units             CHARACTER VARYING(255),
+     automobile_urbanity                   FLOAT,                           /* float from 0 to 1 */
+     automobile_fuel_efficiency            FLOAT,
+     automobile_fuel_efficiency_units      CHARACTER VARYING(255),
+     automobile_city_speed                 FLOAT,
+     automobile_city_speed_units           CHARACTER VARYING(255),
+     automobile_highway_speed              FLOAT,
+     automobile_highway_speed_units        CHARACTER VARYING(255),
+     automobile_trip_distance              FLOAT,
+     automobile_trip_distance_units        CHARACTER VARYING(255),
+     electricity_emission_factor           FLOAT,
+     electricity_emission_factor_units     CHARACTER VARYING(255),
+     electricity_co2_emission_factor       FLOAT,
+     electricity_co2_emission_factor_units CHARACTER VARYING(255),
+     electricity_ch4_emission_factor       FLOAT,
+     electricity_ch4_emission_factor_units CHARACTER VARYING(255),
+     electricity_n2o_emission_factor       FLOAT,
+     electricity_n2o_emission_factor_units CHARACTER VARYING(255),
+     electricity_loss_factor               FLOAT,
+     flight_route_inefficiency_factor      FLOAT,
+     lodging_occupancy_rate                FLOAT,
+     lodging_natural_gas_intensity         FLOAT,
+     lodging_natural_gas_intensity_units   CHARACTER VARYING(255),
+     lodging_fuel_oil_intensity            FLOAT,
+     lodging_fuel_oil_intensity_units      CHARACTER VARYING(255),
+     lodging_electricity_intensity         FLOAT,
+     lodging_electricity_intensity_units   CHARACTER VARYING(255),
+     lodging_district_heat_intensity       FLOAT,
+     lodging_district_heat_intensity_units CHARACTER VARYING(255),
+     rail_passengers                       FLOAT,
+     rail_trip_distance                    FLOAT,
+     rail_trip_distance_units              CHARACTER VARYING(255),
+     rail_speed                            FLOAT,
+     rail_speed_units                      CHARACTER VARYING(255),
+     rail_trip_electricity_intensity       FLOAT,
+     rail_trip_electricity_intensity_units CHARACTER VARYING(255),
+     rail_trip_diesel_intensity            FLOAT,
+     rail_trip_diesel_intensity_units      CHARACTER VARYING(255),
+     rail_trip_co2_emission_factor         FLOAT,
+     rail_trip_co2_emission_factor_units   CHARACTER VARYING(255)
+  );
+
+EOS
+
+  self.primary_key = "iso_3166_code"
+  
+  has_many :rail_companies,  :foreign_key => 'country_iso_3166_code' # used to calculate rail data
+  has_one :electricity_mix, :foreign_key => 'country_iso_3166_code'
   
   def self.united_states
     find_by_iso_3166_code('US')
@@ -59,54 +119,6 @@ class Country < ActiveRecord::Base
                 :rail_trip_co2_emission_factor => lambda { weighted_average(:rail_trip_co2_emission_factor, :weighted_by => :rail_passengers) },
                 :rail_trip_co2_emission_factor_units => 'kilograms_per_passenger_kilometre' # FIXME TODO derive this
   
-  col :iso_3166_code                            # alpha-2 2-letter like GB
-  col :iso_3166_numeric_code, :type => :integer # numeric like 826; aka UN M49 code
-  col :iso_3166_alpha_3_code                    # 3-letter like GBR
-  col :name
-  col :heating_degree_days, :type => :float
-  col :heating_degree_days_units
-  col :cooling_degree_days, :type => :float
-  col :cooling_degree_days_units
-  col :automobile_urbanity, :type => :float # float from 0 to 1
-  col :automobile_fuel_efficiency, :type => :float
-  col :automobile_fuel_efficiency_units
-  col :automobile_city_speed, :type => :float
-  col :automobile_city_speed_units
-  col :automobile_highway_speed, :type => :float
-  col :automobile_highway_speed_units
-  col :automobile_trip_distance, :type => :float
-  col :automobile_trip_distance_units
-  col :electricity_emission_factor, :type => :float
-  col :electricity_emission_factor_units
-  col :electricity_co2_emission_factor, :type => :float
-  col :electricity_co2_emission_factor_units
-  col :electricity_ch4_emission_factor, :type => :float
-  col :electricity_ch4_emission_factor_units
-  col :electricity_n2o_emission_factor, :type => :float
-  col :electricity_n2o_emission_factor_units
-  col :electricity_loss_factor, :type => :float
-  col :flight_route_inefficiency_factor, :type => :float
-  col :lodging_occupancy_rate, :type => :float
-  col :lodging_natural_gas_intensity, :type => :float
-  col :lodging_natural_gas_intensity_units
-  col :lodging_fuel_oil_intensity, :type => :float
-  col :lodging_fuel_oil_intensity_units
-  col :lodging_electricity_intensity, :type => :float
-  col :lodging_electricity_intensity_units
-  col :lodging_district_heat_intensity, :type => :float
-  col :lodging_district_heat_intensity_units
-  col :rail_passengers, :type => :float
-  col :rail_trip_distance, :type => :float
-  col :rail_trip_distance_units
-  col :rail_speed, :type => :float
-  col :rail_speed_units
-  col :rail_trip_electricity_intensity, :type => :float
-  col :rail_trip_electricity_intensity_units
-  col :rail_trip_diesel_intensity, :type => :float
-  col :rail_trip_diesel_intensity_units
-  col :rail_trip_co2_emission_factor, :type => :float
-  col :rail_trip_co2_emission_factor_units
-  
   warn_unless_size 249
   warn_if_nulls_except(
      /heating/,