flight 0.0.2 → 0.0.4

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Andy Rossmeissl
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2009 Andy Rossmeissl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,17 +1,17 @@
-= flight
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Andy Rossmeissl. See LICENSE for details.
+= flight
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Andy Rossmeissl. See LICENSE for details.

data/features/flight_committees.feature

@@ -0,0 +1,20 @@
+Feature: Flight Committee Calculations
+  The flight model should generate correct committee calculations
+
+  Scenario Outline: Standard Calculations for origin/destination airport, airline, and craft
+    Given a flight has "origin_airport.iata_code" of "<source>"
+    And it has "destination_airport.iata_code" of "<dest>"
+    And it has "airline.iata_code" of "<airline>"
+    And it has "date" of "<date>"
+    And it used "aircraft.icao_code" "<aircraft>"
+    When emissions are calculated
+    Then the fuel committee should be close to <fuel>, +/-1
+    And the fuel_per_segment committee should be close to <fuel_per_segment>, +/-10
+    And the adjusted_distance_per_segment committee should be close to <adjusted_distance_per_segment>, +/-1
+    And the load_factor committee should be close to <load_factor>, +/-0.001
+    And the passengers committee should be exactly <passengers>
+    And the adjusted_distance committee should be close to <adjusted_distance>, +/-1
+    Examples:
+      | source | dest | airline | date       | aircraft | fuel  | fuel_per_segment | adjusted_distance_per_segment | load_factor | passengers | adjusted_distance |
+      | DTW    | SFO  | UA      | 2010-06-25 | A320     | 24676 | 7612             | 1341                          | 0.801       | 120        | 2241              |
+      | IAD    | CDG  | AF      | 2010-06-25 | A320     | 43477 | 13413            | 2492                          | 0.800       | 120        | 4161              |

data/features/flight_emissions.feature

@@ -0,0 +1,15 @@
+Feature: Flight Emissions Calculations
+  The flight model should generate correct emission calculations
+
+  Scenario Outline: Standard Calculations for origin/destination airport, airline, and craft
+    Given a flight has "origin_airport.iata_code" of "<source>"
+    And it has "destination_airport.iata_code" of "<dest>"
+    And it has "airline.iata_code" of "<airline>"
+    And it has "date" of "<date>"
+    And it used "aircraft.icao_code" "<aircraft>"
+    When emissions are calculated
+    Then the emission value should be within 10 kgs of <emission>
+    Examples:
+      | source | dest | airline | date       | aircraft | emission |
+      | DTW    | SFO  | UA      | 2010-06-25 | A320     | 1153     |
+      | IAD    | CDG  | AF      | 2010-06-25 | A320     | 2070     |

data/features/step_definitions/carbon_steps.rb

@@ -0,0 +1,57 @@
+require 'time'
+
+Given /^(a flight|it) (has|used) "(.+)" (of\s?)?"(.*)"$/ do |_, __, field, ___, value|
+  @activity_hash ||= {}
+  if value.present?
+    methods = field.split('.')
+    context = @activity_hash
+    methods.each do |method|
+      method = method.to_sym
+      context[method] ||= {}
+      value = Date.parse(value) if value =~ /\d{4}-\d{2}-\d{2}/
+      context[method] = value if method == methods.last.to_sym
+      context = context[method]
+    end
+  end
+end
+
+Given /^the current date is (.+)$/ do |current_date|
+  @current_date = Time.parse(current_date)
+end
+
+When /^emissions are calculated$/ do
+  @activity = FlightRecord.from_params_hash @activity_hash
+  if @current_date
+    Timecop.travel(@current_date) do
+      @emission = @activity.emission Sniff::Timeframe.this_year
+    end
+  else
+    @emission = @activity.emission Sniff::Timeframe.this_year
+  end
+  @characteristics = @activity.deliberations[:emission].characteristics
+end
+
+Then /^the emission value should be within (\d+) kgs of (\d+)$/ do |cusion, emissions|
+  @emission.should be_close(emissions.to_f, cusion.to_f)
+end
+
+Then /^the calculation should have used committees (.*)$/ do |committee_list|
+  committees = committee_list.split(/,\s*/)
+  committees.each do |committee|
+    @characteristics.keys.should include(committee)
+  end
+end
+
+Then /^the (.+) committee should be close to ([^,]+), \+\/-(.+)$/ do |committee, value, cusion|
+  @characteristics[committee.to_sym].to_f.should be_close(value.to_f, cusion.to_f)
+end
+
+Then /^the (.+) committee should be exactly (.*)$/ do |committee, value|
+  @characteristics[committee.to_sym].to_s.should == value
+end
+
+Then /^the active_subtimeframe committee should have timeframe (.*)$/ do |tf_string|
+  days, start, finish = tf_string.split(/,\s*/)
+  @characteristics[:active_subtimeframe].to_s.should =~ /#{days} days starting #{start} ending #{finish}/
+end
+

data/features/support/env.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler.setup
+
+require 'cucumber'
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+
+require 'sniff'
+
+Sniff.init File.join(File.dirname(__FILE__), '..', '..')
+
+## How to clean your database when transactions are turned off. See
+## http://github.com/bmabey/database_cleaner for more info.
+#if defined?(ActiveRecord::Base)
+#  begin
+#    require 'database_cleaner'
+#    DatabaseCleaner.strategy = :truncation
+#  rescue LoadError => ignore_if_database_cleaner_not_present
+#  end
+#end

data/lib/flight.rb

@@ -1,256 +1,26 @@
+require 'flight/carbon_model'
+require 'flight/characterization'
+require 'flight/data'
+require 'flight/summarization'
+
 module BrighterPlanet
   module Flight
-    def self.included(base)
-      base.extend ::Leap::Subject
-      base.decide :emission, :with => :characteristics do
-        committee :emission do
-          quorum 'from fuel and passengers with coefficients', :needs => [:fuel, :passengers, :seat_class_multiplier, :emission_factor, :radiative_forcing_index, :freight_share, :date] do |characteristics, timeframe|
-            if timeframe.include? characteristics[:date]
-              #(                                               kg fuel                                        ) * (                                              kg CO2 / kg fuel                                                     ) = kg CO2
-              (characteristics[:fuel] / characteristics[:passengers] * characteristics[:seat_class_multiplier]) * characteristics[:emission_factor] * characteristics[:radiative_forcing_index] * (1 - characteristics[:freight_share])
-            else
-              0
-            end
-          end
-          
-          quorum 'default' do
-            raise "The emission committee's default quorum should never be called"
-          end
-        end
-        
-        committee :fuel do # returns kg fuel
-          quorum 'from fuel per segment and emplanements and trips', :needs => [:fuel_per_segment, :emplanements_per_trip, :trips] do |characteristics|
-            characteristics[:fuel_per_segment] * characteristics[:emplanements_per_trip].to_f * characteristics[:trips].to_f
-          end
-        end
-        
-        committee :fuel_per_segment do # returns kg fuel
-          quorum 'from adjusted distance and fuel use formula and emplanements and trips', :needs => [:adjusted_distance_per_segment, :fuel_use_coefficients, :endpoint_fuel] do |characteristics|
-            characteristics[:fuel_use_coefficients][:m3].to_f * characteristics[:adjusted_distance_per_segment].to_f ** 3 +
-              characteristics[:fuel_use_coefficients][:m2].to_f * characteristics[:adjusted_distance_per_segment].to_f ** 2 +
-              characteristics[:fuel_use_coefficients][:m1].to_f * characteristics[:adjusted_distance_per_segment].to_f +
-              characteristics[:endpoint_fuel].to_f
-          end
-        end
-        
-        committee :adjusted_distance_per_segment do
-          quorum 'from adjusted distance and emplanements', :needs => [:adjusted_distance, :emplanements_per_trip] do |characteristics|
-            characteristics[:adjusted_distance] / characteristics[:emplanements_per_trip]
-          end
-        end
-        
-        committee :endpoint_fuel do
-          quorum 'from aircraft', :needs => :aircraft do |characteristics|
-            characteristics[:aircraft].endpoint_fuel
-          end
-          
-          quorum 'from aircraft class', :needs => :aircraft_class do |characteristics|
-            characteristics[:aircraft_class].endpoint_fuel
-          end
-          
-          quorum 'default' do
-            Aircraft.fallback.endpoint_fuel
-          end
-        end
-        
-        committee :fuel_use_coefficients do
-          quorum 'from aircraft', :needs => :aircraft do |characteristics|
-            characteristics[:aircraft].attributes.symbolize_keys.slice(:m1, :m2, :m3)
-          end
-          
-          quorum 'from aircraft class', :needs => :aircraft_class do |characteristics|
-            characteristics[:aircraft_class].attributes.symbolize_keys.slice(:m1, :m2, :m3)
-          end
-          
-          quorum 'default' do
-            Aircraft.fallback.attributes.symbolize_keys.slice(:m1, :m2, :m3)
-          end
-        end
-        
-        committee :passengers do
-          quorum 'from seats and load factor', :needs => [:seats, :load_factor] do |characteristics|
-            (characteristics[:seats] * characteristics[:load_factor]).round
-          end
-        end
-        
-        committee :seats do
-    # leaving this here to explain how someday we might lookup seat count based on both airline AND aircraft
-    #SE      quorum 'from_airline_and_aircraft', :needs => [:airline, :aircraft] do |characteristics, timeframe|
-    #SE        if aircraft = AirlineAircraft.memoized_find_by_airline_id_and_aircraft_id(characteristics[:airline].id, characteristics[:aircraft].id)
-    #SE          aircraft.seats
-    #SE        end
-    #SE      end
-          
-          quorum 'from aircraft', :needs => :aircraft do |characteristics|
-            characteristics[:aircraft].seats
-          end
-          
-          quorum 'from seats estimate', :needs => :seats_estimate do |characteristics|
-            characteristics[:seats_estimate]
-          end
-          
-          quorum 'from cohort', :needs => :cohort do |characteristics|
-            seats = characteristics[:cohort].weighted_average :seats, :weighted_by => :passengers
-            if seats.nil? or seats.zero?
-              nil
-            else
-              seats
-            end
-          end
-          
-          quorum 'from aircraft class', :needs => :aircraft_class do |characteristics|
-            characteristics[:aircraft_class].seats
-          end
-          
-          quorum 'default' do
-            FlightSegment.fallback.seats
-          end
-        end
-        
-        committee :load_factor do
-          quorum 'from cohort', :needs => :cohort do |characteristics|
-            characteristics[:cohort].weighted_average(:load_factor, :weighted_by => :passengers)
-          end
-    
-          quorum 'default' do
-            ::Flight.fallback.load_factor
-          end
-        end
-        
-        committee :adjusted_distance do # returns nautical miles
-          quorum 'from distance', :needs => [:distance, :emplanements_per_trip] do |characteristics|
-            characteristics[:distance] * research(:route_inefficiency_factor) * ( research(:dogleg_factor) ** (characteristics[:emplanements_per_trip] - 1) )
-          end
-        end
-        
-        committee :distance do # returns nautical miles
-          quorum 'from airports', :needs => [:origin_airport, :destination_airport] do |characteristics|
-            if  characteristics[:origin_airport].latitude and
-                characteristics[:origin_airport].longitude and
-                characteristics[:destination_airport].latitude and
-                characteristics[:destination_airport].longitude
-              characteristics[:origin_airport].distance_to(characteristics[:destination_airport], :units => :kms).kilometres.to :nautical_miles
-            end
-          end
-          
-          quorum 'from distance estimate', :needs => :distance_estimate do |characteristics|
-            characteristics[:distance_estimate].kilometres.to :nautical_miles
-          end
-          
-          quorum 'from distance class', :needs => :distance_class do |characteristics|
-            characteristics[:distance_class].distance.kilometres.to :nautical_miles
-          end
-          
-          quorum 'from cohort', :needs => :cohort do |characteristics|
-            distance = characteristics[:cohort].weighted_average(:distance, :weighted_by => :passengers).to_f.kilometres.to(:nautical_miles)
-            distance > 0 ? distance : nil
-          end
-          
-          quorum 'default' do
-            ::Flight.fallback.distance_estimate.kilometres.to :nautical_miles
-          end
-        end
-        
-        committee :emplanements_per_trip do # per trip
-          quorum 'default' do
-            ::Flight.fallback.emplanements_per_trip_before_type_cast
-          end
-        end
-        
-        committee :radiative_forcing_index do
-          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
-            characteristics[:fuel_type].radiative_forcing_index
-          end
-        end
-        
-        committee :emission_factor do # returns kg CO2 / kg fuel
-          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
-            #(            kg CO2 / litres fuel        ) * (                 litres fuel / kg fuel                      )
-            characteristics[:fuel_type].emission_factor * ( 1 / characteristics[:fuel_type].density).gallons.to(:litres)
-          end
-        end
-        
-        committee :fuel_type do
-          quorum 'default' do
-            FlightFuelType.fallback
-          end
-        end
-        
-        committee :freight_share do
-          quorum 'from cohort', :needs => :cohort do |characteristics|
-            characteristics[:cohort].weighted_average(:freight_share, :weighted_by => :passengers)
-          end
-          
-          quorum 'default' do
-            FlightSegment.fallback.freight_share
-          end
-        end
-        
-        committee :trips do
-          quorum 'default' do
-            ::Flight.fallback.trips_before_type_cast
-          end
-        end
-        
-        committee :domesticity do
-          quorum 'from airports', :needs => [:origin_airport, :destination_airport] do |characteristics|
-            if [characteristics[:origin_airport], characteristics[:destination_airport]].all?(&:united_states?)
-              FlightDomesticity.find_by_name('domestic')
-            elsif [characteristics[:origin_airport], characteristics[:destination_airport]].any?(&:united_states?)
-              FlightDomesticity.find_by_name('international')
-            end
-          end
-          
-          quorum 'from origin', :needs => :origin_airport do |characteristics|
-            if characteristics[:origin_airport].all_flights_from_here_domestic?
-              FlightDomesticity.find_by_name('domestic')
-            end
-          end
-          
-          quorum 'from destination', :needs => :destination_airport do |characteristics|
-            if characteristics[:destination_airport].all_flights_to_here_domestic?
-              FlightDomesticity.find_by_name('domestic')
-            end
-          end
-          
-          quorum 'from airline', :needs => :airline do |characteristics|
-            if characteristics[:airline].all_flights_domestic?
-              FlightDomesticity.find_by_name('domestic')
-            end
-          end
-        end
-        
-        committee :seat_class_multiplier do
-          quorum 'from seat class', :needs => :seat_class do |characteristics|
-            characteristics[:seat_class].multiplier
-          end
-          
-          quorum 'default' do
-            FlightSeatClass.fallback.multiplier
-          end
-        end
-        
-        committee :date do
-          quorum 'from creation date', :needs => :creation_date do |characteristics|
-            characteristics[:creation_date]
-          end
-          
-          quorum 'from timeframe' do |characteristics, timeframe|
-            timeframe.from
-          end
-        end
-        
-        committee :cohort do
-          quorum 'from t100', :appreciates => FlightSegment::INPUT_CHARACTERISTICS do |characteristics|
-            cohort = FlightSegment.big_cohort characteristics
-            if cohort.any?
-              cohort
-            else
-              nil
-            end
-          end
-        end
+    extend self
+
+    def included(base)
+      base.send :include, BrighterPlanet::Flight::CarbonModel
+      base.send :include, BrighterPlanet::Flight::Characterization
+#      base.send :include, BrighterPlanet::Flight::Data
+      base.send :include, BrighterPlanet::Flight::Summarization
+    end
+    def flight_model
+      if Object.const_defined? 'Flight'
+        Flight
+      elsif Object.const_defined? 'FlightRecord'
+        FlightRecord
+      else
+        raise 'There is no flight model'
       end
     end
   end
-end
+end