earth 1.0.0 → 1.0.1

data/spec/earth/computation/computation_carrrier_instance_class_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'earth/computation/computation_carrier_instance_class'
+
+describe ComputationCarrierInstanceClass do
+  describe 'Sanity check', :sanity => true do
+    let(:ccic) { ComputationCarrierInstanceClass }
+    let(:total) { ccic.count }
+    
+    it { total.should == 8 }
+    it { ccic.where('electricity_intensity > 0').count.should == total }
+    
+    describe '.fallback' do
+      let(:fallback) { ccic.fallback }
+      it { fallback.electricity_intensity.should be_within(5e-6).of(0.105) }
+    end
+  end
+end

data/spec/earth/computation/computation_carrrier_region_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'earth/computation/computation_carrier_region'
+
+describe ComputationCarrierRegion do
+  describe 'Sanity check', :sanity => true do
+    it { ComputationCarrierRegion.count.should == 4 }
+    
+    # FIXME TODO more sanity checks
+  end
+end

data/spec/earth/computation/computation_carrrier_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'earth/computation/computation_carrier'
+
+describe ComputationCarrier do
+  describe 'Sanity check', :sanity => true do
+    let(:total) { ComputationCarrier.count }
+    
+    it { total.should == 1 }
+    it { ComputationCarrier.where('power_usage_effectiveness > 1.0').count.should == total }
+    
+    describe '.fallback' do
+      let(:fallback) { ComputationCarrier.fallback }
+      
+      it { fallback.power_usage_effectiveness.should be_within(5e-3).of(1.5) }
+    end
+  end
+end

data/spec/earth/diet/diet_class_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'earth/diet/diet_class'
+
+describe DietClass do
+  describe 'Sanity check', :sanity => true do
+    it { DietClass.count.should == 3 }
+    
+    describe 'fallback' do
+      it { DietClass.fallback.name.should == 'standard' }
+    end
+    
+    # FIXME TODO more sanity checks
+  end
+end

data/spec/earth/diet/food_group_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require "#{Earth::FACTORY_DIR}/food_group"
+
+describe FoodGroup do
+  describe '.names' do
+    it "returns a list of food group names" do
+      FoodGroup.delete_all
+      FactoryGirl.create :food_group, :meat
+      FactoryGirl.create :food_group, :veg
+      FoodGroup.names.should == ['meat', 'veg']
+    end
+  end
+  
+  describe '.[](name)' do
+    it "finds by name" do
+      meat = FactoryGirl.create :food_group, :meat
+      FoodGroup['meat'].should == meat
+    end
+  end
+  
+  describe 'Sanity check', :sanity => true do
+    it { FoodGroup.count.should == 10 }
+    
+    # FIXME TODO more sanity checks
+  end
+end

data/spec/earth/electricity/electric_market_spec.rb

@@ -1,15 +1,14 @@
 require 'spec_helper'
 require 'earth/electricity/electric_market'
-require 'earth/electricity/electric_utility' # needed for test verifying link with ElectricUtility
 
 describe ElectricMarket do
-  describe 'verify imported data', :sanity => true do
+  describe 'Sanity check', :sanity => true do
     it { ElectricMarket.count.should == 64864 }
+    it { ElectricMarket.where(:electric_utility_eia_id => nil).count.should == 0 }
     
-    it { ElectricMarket.where(:electric_utility_eia_id => nil).count.should == 0 } # some ids aren't found in our electric_utilities table
-    
+    # spot check
     it 'links 53704 to MG&E' do
-      ZipCode.find('53704').electric_utilities.should include(ElectricUtility.find 11479)
+      ElectricMarket.where(:electric_utility_eia_id => 11479).map(&:zip_code_name).should include('53704')
     end
   end
 end

data/spec/earth/electricity/electric_utility_spec.rb

@@ -1,44 +1,55 @@
 require 'spec_helper'
-require 'earth/electricity/electric_utility'
+require "#{Earth::FACTORY_DIR}/electric_utility"
+require "#{Earth::FACTORY_DIR}/green_button_adoption"
 
 describe ElectricUtility do
-  describe 'verify electric utility data', :sanity => true do
+  describe '#green_button_committer?' do
+    it 'should reveal which utilities have committed to the Green Button program' do
+      FactoryGirl.create :green_button_adoption, :committed_utility
+      FactoryGirl.create :green_button_adoption, :implemented_utility
+      
+      FactoryGirl.create(:electric_utility, :committed_utility).green_button_committer?.should == true
+      FactoryGirl.create(:electric_utility, :implemented_utility).green_button_committer?.should == false
+    end
+  end
+  
+  describe '#green_button_implementer?' do
+    it 'should reveal which utilities have implemented the Green Button program' do
+      FactoryGirl.create :green_button_adoption, :committed_utility
+      FactoryGirl.create :green_button_adoption, :implemented_utility
+      
+      FactoryGirl.create(:electric_utility, :committed_utility).green_button_implementer?.should == false
+      FactoryGirl.create(:electric_utility, :implemented_utility).green_button_implementer?.should == true
+    end
+  end
+  
+  describe 'Sanity check', :sanity => true do
     it 'should include all U.S. utilities' do
       ElectricUtility.count.should == 3265
     end
-
-    it 'should have valid state postal abbreviations' do
-      ElectricUtility.where("state_postal_abbreviation IS NOT NULL").select("DISTINCT state_postal_abbreviation").each do |utility|
-        utility.state.should be_kind_of(State)
-      end
-    end
     
     it 'should have valid NERC region abbreviations' do
       ElectricUtility.where("nerc_region_abbreviation IS NOT NULL").select("DISTINCT nerc_region_abbreviation").each do |utility|
         %w{ NPCC RFC SERC FRCC MRO SPP TRE WECC ASCC HICC}.include?(utility.nerc_region_abbreviation).should be_true
       end
     end
-
+    
     it 'should have valid second NERC region abbreviations' do
       ElectricUtility.where("second_nerc_region_abbreviation IS NOT NULL").select("DISTINCT second_nerc_region_abbreviation").each do |utility|
         %w{ NPCC RFC SERC FRCC MRO SPP TRE WECC ASCC HICC}.include?(utility.second_nerc_region_abbreviation).should be_true
       end
     end
-
+    
     it 'should include, specifically, MG&E' do
       ElectricUtility.find(11479).name.should == 'Madison Gas & Electric Co'
     end
-
+    
     it 'should include aliases' do
       ElectricUtility.find(14328).nickname.should == 'PG&E'
     end
-
-    it 'should reveal which utilities have implemented the Green Button program' do
-      ElectricUtility.find(14328).green_button_implementer?.should == true
-    end
-
-    it 'should reveal which utilities have committed to the Green Button program' do
-      ElectricUtility.find(14940).green_button_committer?.should == true
-    end
+    
+    # spot checks
+    it { ElectricUtility.find(14328).green_button_implementer?.should == true }
+    it { ElectricUtility.find(14940).green_button_committer?.should == true }
   end
 end

data/spec/earth/electricity/green_button_adoption_spec.rb

@@ -1,16 +1,38 @@
 require 'spec_helper'
-require 'earth/electricity/green_button_adoption'
+require "#{Earth::FACTORY_DIR}/green_button_adoption"
 
 describe GreenButtonAdoption do
-  describe 'verify Green Button program adoption data', :sanity => true do
-    it { GreenButtonAdoption.count.should == 19 }
-
+  describe '.committed?(*names)' do
+    it "should return true for a utility that has committed to the green button" do
+      FactoryGirl.create :green_button_adoption, :committed_utility
+      FactoryGirl.create :green_button_adoption, :implemented_utility
+      
+      GreenButtonAdoption.committed?('ACU').should == false
+      GreenButtonAdoption.committed?('ACU', 'A committed utility').should == true
+      GreenButtonAdoption.committed?('An implemented utility').should == false
+    end
+  end
+  
+  describe '.implemented?(*names)' do
+    it "should return true for a utility that has implemented the green button" do
+      FactoryGirl.create :green_button_adoption, :committed_utility
+      FactoryGirl.create :green_button_adoption, :implemented_utility
+      
+      GreenButtonAdoption.implemented?('AIU').should == false
+      GreenButtonAdoption.implemented?('AIU', 'An implemented utility').should == true
+      GreenButtonAdoption.implemented?('A committed utility').should == false
+    end
+  end
+  
+  describe 'Sanity check', :sanity => true do
+    it { GreenButtonAdoption.count.should == 23 }
+    
     it 'should recognize that PG&E has implemented' do
       GreenButtonAdoption.find('PG&E').implemented?.should == true
     end
-
-    it 'should recognize that TXU Energy has committed' do
-      GreenButtonAdoption.find('TXU Energy').committed?.should == true
+    
+    it 'should recognize that PPL has committed' do
+      GreenButtonAdoption.find('PPL').committed?.should == true
     end
   end
 end

data/spec/earth/fuel/fuel_spec.rb

@@ -1,26 +1,100 @@
 require 'spec_helper'
-require 'earth/fuel/fuel'
-require 'earth/fuel/fuel/data_miner'
-require 'earth/fuel/fuel_year' # methods are delegated to FuelYear if value in fuels is null
+require "#{Earth::FACTORY_DIR}/fuel"
+require "#{Earth::FACTORY_DIR}/fuel_year"
 
 describe Fuel do
-  describe 'after importing data', :sanity => true do
-    it 'should have all the data' do
-      Fuel.count.should == 23
+  describe '#latest_fuel_year' do
+    it {
+      FactoryGirl.create :fuel_year, :gas_2008
+      FactoryGirl.create :fuel_year, :gas_2007
+      gas = FactoryGirl.create :fuel, :gas
+      gas.latest_fuel_year.should == FuelYear.find('Gasoline 2008')
+    }
+  end
+  
+  describe '#energy_content' do
+    it "returns energy content if present" do
+      diesel = FactoryGirl.create :fuel, :diesel
+      diesel.energy_content.should be_within(5e-6).of(39)
+      diesel.energy_content_units.should == 'megajoules_per_litre'
+    end
+    
+    it "delegates method to FuelYear if energy content missing" do
+      FactoryGirl.create :fuel_year, :gas_2008
+      gas = FactoryGirl.create :fuel, :gas
+      gas.energy_content.should be_within(5e-6).of(35)
+      gas.energy_content_units.should == 'megajoules_per_litre'
+    end
+  end
+  
+  describe '#carbon_content' do
+    it "returns carbon content if present" do
+      diesel = FactoryGirl.create :fuel, :diesel
+      diesel.carbon_content.should be_within(5e-6).of(19)
+      diesel.carbon_content_units.should == 'grams_per_megajoule'
+    end
+    
+    it "delegates method to FuelYear if carbon content missing" do
+      FactoryGirl.create :fuel_year, :gas_2008
+      gas = FactoryGirl.create :fuel, :gas
+      gas.carbon_content.should be_within(5e-6).of(18)
+      gas.carbon_content_units.should == 'grams_per_megajoule'
+    end
+  end
+  
+  describe '#co2_emission_factor' do
+    it "returns co2 emission factor if present" do
+      diesel = FactoryGirl.create :fuel, :diesel
+      diesel.co2_emission_factor.should be_within(5e-6).of(2.717)
+      diesel.co2_emission_factor_units.should == 'kilograms_per_litre'
     end
     
+    it "delegates method to FuelYear if co2 emission factor missing" do
+      FactoryGirl.create :fuel_year, :gas_2008
+      gas = FactoryGirl.create :fuel, :gas
+      gas.co2_emission_factor.should be_within(5e-6).of(2.31)
+      gas.co2_emission_factor_units.should == 'kilograms_per_litre'
+    end
+  end
+  
+  describe '#co2_biogenic_emission_factor' do
+    it "returns co2 biogenic emission factor if present" do
+      diesel = FactoryGirl.create :fuel, :diesel
+      diesel.co2_biogenic_emission_factor.should be_within(5e-6).of(0.0)
+      diesel.co2_biogenic_emission_factor_units.should == 'kilograms_per_litre'
+    end
+    
+    it "delegates method to FuelYear if co2 biogenic emission factor missing" do
+      FactoryGirl.create :fuel_year, :gas_2008
+      gas = FactoryGirl.create :fuel, :gas
+      gas.co2_biogenic_emission_factor.should be_within(5e-6).of(0.0)
+      gas.co2_biogenic_emission_factor_units.should == 'kilograms_per_litre'
+    end
+  end
+  
+  describe 'Sanity check', :sanity => true do
+    let(:unvarying) { Fuel.where('biogenic_fraction IS NOT NULL') }
+    let(:biogenic) { Fuel.where(:biogenic_fraction => 1) }
+    let(:fossil) { Fuel.where(:biogenic_fraction => 0) }
+    
+    it { Fuel.count.should == 23 }
+    it { biogenic.count.should == 3 }
+    it { fossil.count.should == 11 }
+    it { unvarying.where('energy_content > 0').count.should == unvarying.count }
+    it { unvarying.where('carbon_content >= 0').count.should == unvarying.count }
+    it { unvarying.where(:oxidation_factor => 1).count.should == unvarying.count }
+    it { biogenic.where(:co2_emission_factor => 0).count.should == biogenic.count }
+    it { fossil.where('co2_emission_factor >= 0').count.should == fossil.count }
+    it { biogenic.where('co2_biogenic_emission_factor > 0').count.should == biogenic.count }
+    it { fossil.where(:co2_biogenic_emission_factor => 0).count.should == fossil.count }
+    
     it 'should have a record for district heat' do
       district_heat = Fuel.find 'District Heat'
       district_heat.co2_emission_factor.should be_within(5e-6).of(0.07598)
     end
     
-    # TODO is there a way to check whether the value in the fuels table is NULL?
-    it 'should check FuelYear for any missing values' do
-      gasoline = Fuel.find('Motor Gasoline')
-      gasoline_years = FuelYear.where(:fuel_name => 'Motor Gasoline')
-      latest_gasoline_year = gasoline_years.find_by_year(gasoline_years.maximum(:year))
-      gasoline.energy_content.should == latest_gasoline_year.energy_content
-      gasoline.carbon_content.should == latest_gasoline_year.carbon_content
-    end
+    # spot check
+    it { Fuel.find('Motor Gasoline').co2_emission_factor.should be_within(5e-6).of(2.34183) }
+    it { Fuel.find('Distillate Fuel Oil No. 2').co2_emission_factor.should be_within(5e-6).of(2.70219) }
   end
 end

data/spec/earth/fuel/fuel_year_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'earth/fuel/fuel_year'
+
+describe FuelYear do
+  describe 'Sanity check', :sanity => true do
+    let(:total) { FuelYear.count }
+    
+    it { total.should == 171 }
+    it { FuelYear.where("carbon_content > 0").count.should == total }
+    it { FuelYear.where("energy_content > 0").count.should == total }
+    it { FuelYear.where("co2_emission_factor > 0").count.should == total }
+    it { FuelYear.where("co2_biogenic_emission_factor >= 0").count.should == total }
+    
+    # Spot check
+    let(:gas) { FuelYear.find('Motor Gasoline 2008') }
+    it { gas.carbon_content.should be_within(5e-5).of(18.4445) }
+    it { gas.energy_content.should be_within(5e-5).of(34.6272) }
+    it { gas.co2_emission_factor.should be_within(5e-6).of(2.34183) }
+    it { gas.co2_biogenic_emission_factor.should be_within(5e-6).of(0) }
+  end
+end

data/spec/earth/fuel/greenhouse_gas_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require "#{Earth::FACTORY_DIR}/greenhouse_gas"
+
+describe GreenhouseGas do
+  describe '.[abbreviation]' do
+    it {
+      GreenhouseGas.delete_all
+      co2 = FactoryGirl.create :ghg, :co2
+      GreenhouseGas['co2'].should == co2
+    }
+  end
+  
+  describe 'Sanity check', :sanity => true do
+    let(:total) { GreenhouseGas.count }
+    
+    it { total.should == 4 }
+    it { GreenhouseGas.where('abbreviation IS NOT NULL').count.should == total }
+    it { GreenhouseGas.where('ipcc_report IS NOT NULL').count.should == total }
+    it { GreenhouseGas.where(:time_horizon => 100).count.should == total }
+    it { GreenhouseGas.where(:time_horizon_units => 'years').count.should == total }
+    it { GreenhouseGas.where('global_warming_potential >= 1').count.should == total }
+  end
+end

data/spec/earth/hospitality/commercial_building_energy_consumption_survey_response_spec.rb

@@ -1,10 +1,21 @@
 require 'spec_helper'
-require 'earth/hospitality/commercial_building_energy_consumption_survey_response'
+require "#{Earth::FACTORY_DIR}/commercial_building_energy_consumption_survey_response"
 
 describe CommercialBuildingEnergyConsumptionSurveyResponse do
   let(:cbecs) { CommercialBuildingEnergyConsumptionSurveyResponse }
   
-  describe "verify imported data", :sanity => true do
+  describe ".lodging_records" do
+    it "should return records representing Hotels, Motels, and Inns with no other activity" do
+      cbecs.delete_all
+      h = FactoryGirl.create :cbecs_response, :hotel
+      m = FactoryGirl.create :cbecs_response, :motel
+      FactoryGirl.create :cbecs_response, :warehouse
+      FactoryGirl.create :cbecs_response, :hotel_warehouse
+      cbecs.lodging_records.should == [h, m]
+    end
+  end
+  
+  describe "Sanity check", :sanity => true do
     let(:total) { cbecs.count }
     let(:first_lodging) { cbecs.lodging_records.first }
     
@@ -35,12 +46,4 @@ describe CommercialBuildingEnergyConsumptionSurveyResponse do
       first_lodging.fuel_oil_per_room_night_units.should == 'megajoules_per_room_night'
     end
   end
-  
-  describe ".lodging_records" do
-    it "should return records representing Hotels, Motels, and Inns with no other activity" do
-      cbecs.lodging_records.map(&:detailed_activity).uniq.sort.should == ['Hotel', 'Motel or inn']
-      cbecs.lodging_records.map(&:first_activity).uniq.should == [nil]
-      cbecs.lodging_records.count.should == 192
-    end
-  end
 end

data/spec/earth/hospitality/lodging_class_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'earth/hospitality/lodging_class'
 
 describe LodgingClass do
-  describe 'verify imported data', :sanity => true do
+  describe 'Sanity check', :sanity => true do
     it { LodgingClass.count.should == 3 }
   end
 end