flight 0.1.5 → 0.1.6

data/features/flight_committees.feature

@@ -184,7 +184,7 @@ Feature: Flight Committee Calculations
       | code    | seats  |
       | BP-FM1  | 125.0  |
       | BP-BA1  | 120.0  |
-      | BP-XX1  | 130.0  |
+      | BP-XX1s | 130.0  |
 
   Scenario Outline: Seats committee from aircraft missing seats
     Given a flight emitter
@@ -265,10 +265,10 @@ Feature: Flight Committee Calculations
     And the conclusion of the committee should have a record with "m1" equal to "4"
     And the conclusion of the committee should have a record with "endpoint_fuel" equal to "0"
     Examples:
-      | code   |
-      | BP-XX1 |
-      | BP-XX3 |
-      | BP-XX4 |
+      | code    |
+      | BP-XX1f |
+      | BP-XX3  |
+      | BP-XX4  |
 
   Scenario: Fuel use coefficients committee from aircraft class
     Given a flight emitter

data/lib/flight/carbon_model/fuel_use_equation.rb

@@ -0,0 +1,28 @@
+module BrighterPlanet
+  module Flight
+    module CarbonModel
+      class FuelUseEquation < Struct.new(:m3, :m2, :m1, :endpoint_fuel)
+        def empty?
+          values.all?(&:nil?) or values.all?(&:zero?)
+        end
+
+        def values
+          [m3, m2, m1, endpoint_fuel]
+        end
+
+        def to_xml(options = {})
+          options[:indent] ||= 2
+          xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+          xml.instruct! unless options[:skip_instruct]
+          xml.fuel_use_equation do |estimate_block|
+            estimate_block.endpoint_fuel endpoint_fuel, :type => 'float'
+            estimate_block.m1 m1, :type => 'float'
+            estimate_block.m2 m2, :type => 'float'
+            estimate_block.m3 m3, :type => 'float'
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/flight/carbon_model.rb

@@ -7,12 +7,13 @@ require 'timeframe'
 require 'date'
 require 'weighted_average'
 require 'builder'
+require 'flight/carbon_model/fuel_use_equation'
 
 ## Flight carbon model
 # This model is used by [Brighter Planet](http://brighterplanet.com)'s carbon emission [web service](http://carbon.brighterplanet.com) to estimate the **greenhouse gas emissions of passenger air travel**.
 #
 ##### Timeframe and date
-# The model estimates the emissions that occur during a particular `timeframe`. To do this it needs to know the `date` on which the flight occurred. For example, if the `timeframe` is January 2010, a flight that occured on January 5, 2010 will have emissions but a flight that occured on February 1, 2010 will not. If no `timeframe` is specified, the default is the current year. If no `date` is specified, the default is the first day of the `timeframe`.
+# The model estimates the emissions that occur during a particular `timeframe`. To do this it needs to know the `date` on which the flight occurred. For example, if the `timeframe` is January 2010, a flight that occurred on January 5, 2010 will have emissions but a flight that occurred on February 1, 2010 will not.
 #
 ##### Calculations
 # The final estimate is the result of the **calculations** detailed below. These calculations are performed in reverse order, starting with the last calculation listed and finishing with the `emission` calculation. Each calculation is named according to the value it returns.
@@ -24,21 +25,20 @@ require 'builder'
 # Each method lists any established calculation standards with which it **complies**. When compliance with a standard is requested, all methods that do not comply with that standard are ignored. This means that any values a particular method requires will have been calculated using a compliant method, because those are the only methods available. If any value did not have a compliant method in its calculation then it would be undefined, and the current method would have been ignored.
 #
 ##### Collaboration
-# Contributions to this carbon model are actively encouraged and warmly welcomed. This library includes a comprehensive test suite to ensure that your changes do not cause regressions. All changes shold include test coverage for new functionality. Please see [sniff](http://github.com/brighterplanet/sniff#readme), our emitter testing framework, for more information.
+# Contributions to this carbon model are actively encouraged and warmly welcomed. This library includes a comprehensive test suite to ensure that your changes do not cause regressions. All changes should include test coverage for new functionality. Please see [sniff](http://github.com/brighterplanet/sniff#readme), our emitter testing framework, for more information.
 module BrighterPlanet
   module Flight
     module CarbonModel
       def self.included(base)
-        base.extend FastTimestamp
         base.decide :emission, :with => :characteristics do
           ### Emission calculation
           # Returns the `emission` estimate in *kg CO<sub>2</sub>e*.
-          # This is the passenger's share of the total flight emissions that occured during the `timeframe`.
+          # This is the passenger's share of the total flight emissions that occurred during the `timeframe`.
           committee :emission do
             #### Emission from fuel, emission factor, freight share, passengers, multipliers, and date
             # **Complies:** GHG Protocol, ISO-14064-1, Climate Registry Protocol
             #
-            # - Checks whether the flight occured during the `timeframe`
+            # - Checks whether the flight occurred during the `timeframe`
             # - Multiplies `fuel use` (*kg fuel*) by an `emission factor` (*kg CO<sub>2</sub>e / kg fuel*) and an `aviation multiplier` to give total flight emissions in *kg CO<sub>2</sub>e*
             # - Multiplies by (1 - `freight share`) to take out emissions attributed to freight cargo and mail, leaving emissions attributed to passengers and their baggage
             # - Divides by the number of `passengers` and multiplies by a `seat class multiplier` to give `emission` for the passenger
@@ -281,7 +281,7 @@ module BrighterPlanet
                   bts_code = flight_segment.aircraft_bts_code.to_s
                   aircraft = relevant_aircraft[bts_code]
                   aircraft_coefficient = aircraft.send(name)
-                  if aircraft_coefficient.nil? or aircraft_coefficient.zero?
+                  if aircraft_coefficient.nil?
                     aircraft_coefficient = aircraft.aircraft_class.send(name)
                   end
                   coefficient + (aircraft_coefficient * flight_segment.passengers)
@@ -574,57 +574,21 @@ module BrighterPlanet
           end
           
           ### Date calculation
-          # Returns the `date` on which the flight occured.
+          # Returns the `date` on which the flight occurred.
           committee :date do
             #### Date from client input
             # **Complies:** All
             #
-            # Uses the client-input value for `date`.
+            # Uses the client-input `date`.
             
             #### Date from timeframe
             # **Complies:** GHG Protocol, ISO-14064-1, Climate Registry Protocol
             #
-            # Assumes the flight occured on the first day of the `timeframe`.
+            # Assumes the flight occurred on the first day of the `timeframe`.
             quorum 'from timeframe', :complies => [:ghg_protocol, :iso, :tcr] do |characteristics, timeframe|
               timeframe.from
             end
           end
-          
-          ### Timeframe calculation
-          # Returns the `timeframe`.
-          # This is the period over which to calculate emissions.
-            
-            #### Timeframe from client input
-            # **Complies:** All
-            #
-            # Uses the client-input value for `timeframe`.
-            
-            #### Default timeframe
-            # **Complies:** All
-            #
-            # Uses the current calendar year.
-        end
-      end
-      
-      class FuelUseEquation < Struct.new(:m3, :m2, :m1, :endpoint_fuel)
-        def empty?
-          values.all?(&:nil?) or values.all?(&:zero?)
-        end
-
-        def values
-          [m3, m2, m1, endpoint_fuel]
-        end
-
-        def to_xml(options = {})
-          options[:indent] ||= 2
-          xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
-          xml.instruct! unless options[:skip_instruct]
-          xml.fuel_use_equation do |estimate_block|
-            estimate_block.endpoint_fuel endpoint_fuel, :type => 'float'
-            estimate_block.m1 m1, :type => 'float'
-            estimate_block.m2 m2, :type => 'float'
-            estimate_block.m3 m3, :type => 'float'
-          end
         end
       end
     end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flight
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Andy Rossmeissl
@@ -18,165 +19,176 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-06 00:00:00 -04:00
+date: 2010-12-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 3
         - 0
         - 1
         version: 3.0.1
   type: :development
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   type: :development
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: cucumber
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
         - 0
         version: 1.4.0
   type: :development
-  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rake
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rdoc
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rspec
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 2
         - 0
         - 1
         version: 2.0.1
   type: :development
-  prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: sniff
+  prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 0
-        - 2
+        - 3
         - 0
-        version: 0.2.0
+        version: 0.3.0
   type: :development
-  prerelease: false
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: emitter
+  prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 0
+        - 2
         - 1
-        - 8
-        version: 0.1.8
+        version: 0.2.1
   type: :runtime
-  prerelease: false
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: builder
+  name: earth
+  prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
-        version: "0"
+        - 3
+        - 1
+        version: 0.3.1
   type: :runtime
-  prerelease: false
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: earth
+  name: builder
+  prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
-        - 2
-        - 7
-        version: 0.2.7
+        version: "0"
   type: :runtime
-  prerelease: false
   version_requirements: *id011
 description: A software model in Ruby for the greenhouse gas emissions of a flight
 email: andy@rossmeissl.net
@@ -193,6 +205,7 @@ files:
 - README.rdoc
 - lib/flight.rb
 - lib/flight/carbon_model.rb
+- lib/flight/carbon_model/fuel_use_equation.rb
 - lib/flight/characterization.rb
 - lib/flight/data.rb
 - lib/flight/fallback.rb
@@ -201,8 +214,8 @@ files:
 - lib/test_support/flight_record.rb
 - README.markdown
 - features/support/env.rb
-- features/flight_emissions.feature
 - features/flight_committees.feature
+- features/flight_emissions.feature
 has_rdoc: true
 homepage: http://github.com/brighterplanet/flight
 licenses: []
@@ -217,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -696785283
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -226,6 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -238,6 +252,6 @@ specification_version: 3
 summary: A carbon model
 test_files: 
 - features/support/env.rb
-- features/flight_emissions.feature
 - features/flight_committees.feature
+- features/flight_emissions.feature
 - lib/test_support/flight_record.rb