lodging 0.0.1 → 0.0.2

data/features/lodging_committees.feature

@@ -1,2 +1,93 @@
 Feature: Lodging Committee Calculations
   The lodging model should generate correct committee calculations
+
+  Scenario: Magnitude committee from default
+    Given a lodging emitter
+    When the "magnitude" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should be "1"
+
+  Scenario: Lodging class committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    Then the committee should have used quorum "default"
+    And the conclusion of the committee should have "name" of "Average"
+
+  Scenario: District heat intensity committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    And the "district_heat_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "10000000"
+
+  Scenario: District heat intensity committee from lodging class
+    Given a lodging emitter
+    And a characteristic "lodging_class.name" of "Luxury Hotel"
+    When the "district_heat_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "20000000"
+
+  Scenario: Electricity intensity committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    And the "electricity_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "5"
+
+  Scenario: Electricity intensity committee from lodging class
+    Given a lodging emitter
+    And a characteristic "lodging_class.name" of "Luxury Hotel"
+    When the "electricity_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "10"
+
+  Scenario: Fuel oil intensity committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    And the "fuel_oil_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "0.5"
+
+  Scenario: Fuel oil intensity committee from lodging class
+    Given a lodging emitter
+    And a characteristic "lodging_class.name" of "Luxury Hotel"
+    When the "fuel_oil_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "1"
+
+  Scenario: Natural gas intensity committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    And the "natural_gas_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "1"
+
+  Scenario: Natural gas intensity committee from lodging class
+    Given a lodging emitter
+    And a characteristic "lodging_class.name" of "Luxury Hotel"
+    When the "natural_gas_intensity" committee is calculated
+    Then the committee should have used quorum "from lodging class"
+    And the conclusion of the committee should be "2"
+
+  Scenario: Emission factor committee from nothing
+    Given a lodging emitter
+    When the "lodging_class" committee is calculated
+    And the "district_heat_intensity" committee is calculated
+    And the "electricity_intensity" committee is calculated
+    And the "fuel_oil_intensity" committee is calculated
+    And the "natural_gas_intensity" committee is calculated
+    And the "emission_factor" committee is calculated
+    Then the committee should have used quorum "from fuel intensities"
+    And the conclusion of the committee should be "11.24496"
+
+  Scenario: Emission factor committee from lodging class
+    Given a lodging emitter
+    And a characteristic "lodging_class.name" of "Luxury Hotel"
+    When the "district_heat_intensity" committee is calculated
+    And the "electricity_intensity" committee is calculated
+    And the "fuel_oil_intensity" committee is calculated
+    And the "natural_gas_intensity" committee is calculated
+    And the "emission_factor" committee is calculated
+    And the "emission_factor" committee is calculated
+    Then the committee should have used quorum "from fuel intensities"
+    And the conclusion of the committee should be "22.48991"

data/features/lodging_emissions.feature

@@ -1,7 +1,23 @@
 Feature: Lodging Emissions Calculations
   The lodging model should generate correct emission calculations
 
-  Scenario: Standard Calculations for lodgings
-    Given a lodging
+  Scenario: Calculations starting from nothing
+    Given a lodging has nothing
     When emissions are calculated
-    Then the emission value should be 1
+    Then the emission value should be within "0.00001" kgs of "11.24496"
+
+  Scenario: Calculations starting from magnitude
+    Given a lodging has "magnitude" of "5"
+    When emissions are calculated
+    Then the emission value should be within "0.00001" kgs of "56.22478"
+
+  Scenario: Calculations starting from lodging class
+    Given a lodging has "lodging_class.name" of "Luxury Hotel"
+    When emissions are calculated
+    Then the emission value should be within "0.00001" kgs of "22.48991"
+
+  Scenario: Calculations starting from lodging class and magnitude
+    Given a lodging has "lodging_class.name" of "Luxury Hotel"
+    And it has "magnitude" of "5"
+    When emissions are calculated
+    Then the emission value should be within "0.00001" kgs of "112.44957"

data/features/support/env.rb

@@ -5,4 +5,4 @@ require 'cucumber'
 require 'cucumber/formatter/unicode'
 
 require 'sniff'
-Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :earth => :automobile
+Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :earth => [:hospitality, :residence, :fuel], :cucumber => true

data/lib/lodging/carbon_model.rb

@@ -7,9 +7,76 @@ module BrighterPlanet
       def self.included(base)
         base.extend ::Leap::Subject
         base.decide :emission, :with => :characteristics do
-          committee :emission do # returns kg CO2
+          committee :emission do # returns kg CO2e
+            quorum 'from magnitude and emission factor', :needs => [:magnitude, :emission_factor] do |characteristics|
+              characteristics[:magnitude] * characteristics[:emission_factor]
+            end
+            
+            quorum 'default' do
+              raise "The emission committee's default quorum should never be called."
+            end
+          end
+          
+          committee :emission_factor do # returns kg CO2e per room night
+            quorum 'from fuel intensities', :needs => [:natural_gas_intensity, :fuel_oil_intensity, :electricity_intensity, :district_heat_intensity] do |characteristics|
+              natural_gas = FuelType.find_by_name "Commercial Natural Gas"
+              fuel_oil = FuelType.find_by_name "Distillate Fuel Oil 2"
+              electricity = ResidenceFuelType.find_by_name "electricity"
+              
+              # FIXME TODO won't need this once we convert emission factors to co2 / unit energy
+              #   kg / J                           kg / cubic m     J / cubic m
+              natural_gas_energy_ef = natural_gas.emission_factor / 38_339_000
+              
+              # FIXME TODO won't need this once we convert emission factors to co2 / unit energy
+              #   kg / J                        kg / l           J / l
+              fuel_oil_energy_ef = fuel_oil.emission_factor / 38_655_000
+              
+              # based on CA-CP calculator
+              # assume district heat is 50% natural gas 50% distillate fuel
+              # assume natural gas boilers 81.7% efficient; fuel oil boilers 84.6% efficient
+              # assume 5% transmission loss
+              district_heat_emission_factor = (((natural_gas_energy_ef / 0.817) / 2) + ((fuel_oil_energy_ef / 0.846) / 2)) / 0.95
+              
+              (characteristics[:natural_gas_intensity] * natural_gas.emission_factor) +
+                (characteristics[:fuel_oil_intensity] * fuel_oil.emission_factor) +
+                (characteristics[:electricity_intensity] * electricity.emission_factor) +
+                (characteristics[:district_heat_intensity] * district_heat_emission_factor)
+            end
+          end
+          
+          committee :natural_gas_intensity do # returns cubic metres per room-night
+            quorum 'from lodging class', :needs => :lodging_class do |characteristics|
+              characteristics[:lodging_class].natural_gas_intensity
+            end
+          end
+          
+          committee :fuel_oil_intensity do # returns litres per room-night
+            quorum 'from lodging class', :needs => :lodging_class do |characteristics|
+              characteristics[:lodging_class].fuel_oil_intensity
+            end
+          end
+          
+          committee :electricity_intensity do # returns kilowatt hours per room-night
+            quorum 'from lodging class', :needs => :lodging_class do |characteristics|
+              characteristics[:lodging_class].electricity_intensity
+            end
+          end
+          
+          committee :district_heat_intensity do # returns joules per room-night
+            quorum 'from lodging class', :needs => :lodging_class do |characteristics|
+              characteristics[:lodging_class].district_heat_intensity
+            end
+          end
+          
+          committee :lodging_class do # returns the type of lodging
+            quorum 'default' do
+              LodgingClass.find_by_name 'Average'
+            end
+          end
+          
+          committee :magnitude do # return room-nights - couldn't think of anything to call it except 'magnitude'
             quorum 'default' do
-              1.0
+              base.fallback.magnitude
             end
           end
         end

data/lib/lodging/characterization.rb

@@ -6,6 +6,8 @@ module BrighterPlanet
       def self.included(base)
         base.send :include, Characterizable
         base.characterize do
+          has :lodging_class # e.g. hotel / motel / other
+          has :magnitude  # room-nights
         end
         base.add_implicit_characteristics
       end

data/lib/test_support/db/schema.rb

@@ -0,0 +1,8 @@
+require 'sniff/database'
+
+Sniff::Database.define_schema do
+  create_table "lodging_records", :force => true do |t|
+    t.string  'lodging_class_name'
+    t.integer 'magnitude'
+  end
+end

data/lib/test_support/lodging_record.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'falls_back_on'
+require 'lodging'
+require 'sniff'
+
+class LodgingRecord < ActiveRecord::Base
+  include Sniff::Emitter
+  include BrighterPlanet::Lodging
+
+  belongs_to :lodging_class
+
+  falls_back_on :magnitude => 1
+end

metadata

@@ -1,27 +1,96 @@
 --- !ruby/object:Gem::Specification 
 name: lodging
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andy Rossmeissl
+- Seamus Abshere
+- Ian Hough
+- Matt Kling
+- Derek Kastner
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 -04:00
+date: 2010-09-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  type: :development
+  prerelease: false
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: cucumber
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 8
+        - 3
+        version: 0.8.3
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,8 +99,87 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  name: rdoc
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196417
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 17
+        version: 2.0.0.beta.17
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sniff
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 1
+        - 12
+        version: 0.1.12
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: emitter
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: earth
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 0
+        - 0
+        - 38
+        version: 0.0.38
+  requirement: *id010
 description: A software model in Ruby for the greenhouse gas emissions of a lodging
 email: andy@rossmeissl.net
 executables: []
@@ -42,24 +190,18 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
-- Rakefile
-- VERSION
-- dot.rvmrc
-- features/lodging_committees.feature
-- features/lodging_emissions.feature
-- features/support/env.rb
 - lib/lodging.rb
 - lib/lodging/carbon_model.rb
 - lib/lodging/characterization.rb
 - lib/lodging/data.rb
 - lib/lodging/summarization.rb
-- lodging.gemspec
+- lib/test_support/db/schema.rb
+- lib/test_support/lodging_record.rb
+- features/support/env.rb
+- features/lodging_committees.feature
+- features/lodging_emissions.feature
 has_rdoc: true
 homepage: http://github.com/brighterplanet/lodging
 licenses: []
@@ -94,5 +236,9 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A carbon model
-test_files: []
-
+test_files: 
+- features/support/env.rb
+- features/lodging_committees.feature
+- features/lodging_emissions.feature
+- lib/test_support/db/schema.rb
+- lib/test_support/lodging_record.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Gemfile

@@ -1,4 +0,0 @@
-gem 'emitter', :path => ENV['LOCAL_EMITTER'] if ENV['LOCAL_EMITTER']
-source :rubygems
-
-gemspec :path => '.'

data/Gemfile.lock

@@ -1,16 +0,0 @@
-PATH
-  remote: .
-  specs:
-    lodging (0.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    thoughtbot-shoulda (2.11.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  lodging!
-  thoughtbot-shoulda

data/Rakefile

@@ -1,53 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "lodging"
-    gem.summary = %Q{A carbon model}
-    gem.description = %Q{A software model in Ruby for the greenhouse gas emissions of a lodging}
-    gem.email = "andy@rossmeissl.net"
-    gem.homepage = "http://github.com/brighterplanet/lodging"
-    gem.authors = ["Andy Rossmeissl"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "lodging #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.0.1

data/dot.rvmrc

@@ -1,9 +0,0 @@
-rvm 1.8.7
-project=`basename \`pwd\``
-if rvm gemset list | grep $project
-then
-  rvm 1.8.7@$project
-else
-  rvm gemset create $project
-  rvm gemset use $project
-fi

data/lodging.gemspec

@@ -1,58 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{lodging}
-  s.version = "0.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andy Rossmeissl"]
-  s.date = %q{2010-09-09}
-  s.description = %q{A software model in Ruby for the greenhouse gas emissions of a lodging}
-  s.email = %q{andy@rossmeissl.net}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "dot.rvmrc",
-     "features/lodging_committees.feature",
-     "features/lodging_emissions.feature",
-     "features/support/env.rb",
-     "lib/lodging.rb",
-     "lib/lodging/carbon_model.rb",
-     "lib/lodging/characterization.rb",
-     "lib/lodging/data.rb",
-     "lib/lodging/summarization.rb",
-     "lodging.gemspec"
-  ]
-  s.homepage = %q{http://github.com/brighterplanet/lodging}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A carbon model}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-  end
-end
-