flight 0.0.2 → 0.0.4

data/lib/flight/carbon_model.rb

@@ -0,0 +1,270 @@
+require 'weighted_average'
+
+module BrighterPlanet
+  module Flight
+    module CarbonModel
+      def self.included(base)
+        base.send :include, ::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.andand.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
+              fallback = Aircraft.fallback
+              if fallback
+                fallback.attributes.symbolize_keys.slice(:m1, :m2, :m3)
+              end
+            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.andand.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
+              BrighterPlanet::Flight.flight_model.fallback.andand.load_factor
+            end
+          end
+          
+          committee :adjusted_distance do # returns nautical miles
+            quorum 'from distance', :needs => [:distance, :emplanements_per_trip] do |characteristics|
+              route_inefficiency_factor = BrighterPlanet::Flight.flight_model.research(:route_inefficiency_factor)
+              dogleg_factor = BrighterPlanet::Flight.flight_model.research(:dogleg_factor)
+              characteristics[:distance] * route_inefficiency_factor * ( 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
+              BrighterPlanet::Flight.flight_model.fallback.distance_estimate.kilometres.to :nautical_miles
+            end
+          end
+          
+          committee :emplanements_per_trip do # per trip
+            quorum 'default' do
+              BrighterPlanet::Flight.flight_model.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.andand.freight_share
+            end
+          end
+          
+          committee :trips do
+            quorum 'default' do
+              BrighterPlanet::Flight.flight_model.fallback.andand.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.andand.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.andand.from
+            end
+          end
+          
+          committee :cohort do
+            quorum 'from t100', :appreciates => FlightSegment::INPUT_CHARACTERISTICS do |characteristics|
+              needed_characteristics = characteristics
+              needed_characteristics.
+                reject! { |k,v| !FlightSegment::INPUT_CHARACTERISTICS.include?(k) }
+              cohort = FlightSegment.big_cohort needed_characteristics
+              if cohort.any?
+                cohort
+              else
+                nil
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flight/characterization.rb

@@ -0,0 +1,31 @@
+module BrighterPlanet
+  module Flight
+    module Characterization
+      def self.included(base)
+        base.characterize do
+          has :date, :trumps => :year
+          has :year
+          has :time_of_day
+          has :origin_airport do |origin_airport|
+            origin_airport.reveals :destination_airport, 
+              :trumps => [:distance_class, :domesticity, :distance_estimate]
+          end
+          has :distance_class
+          has :distance_estimate, :trumps => :distance_class, :measures => :length, :precision => 0
+          has :domesticity
+          has :airline
+          has :trips
+          has :emplanements_per_trip
+          has :seat_class
+          has :load_factor, :measures => :percentage
+          has :seats_estimate, :range => 1..500
+          has :aircraft_class, :trumps => [:propulsion, :fuel_type]
+          has :aircraft, :trumps => [:propulsion, :aircraft_class, :seats_estimate, :fuel_type]
+          has :propulsion, :trumps => :fuel_type
+
+          has :creation_date, :hidden => true
+        end
+      end
+    end
+  end
+end

data/lib/flight/data.rb

@@ -0,0 +1,34 @@
+module BrighterPlanet
+  module Flight
+    module Data
+      def self.included(base)
+        base.data_miner do
+          schema do
+            string   'origin_airport_id'
+            string   'destination_airport_id'
+            integer  'trips'
+            integer  'emplanements_per_trip'
+            float    'distance_estimate'
+            string   'distance_class_id'
+            string   'aircraft_id'
+            string   'aircraft_class_id'
+            string   'propulsion_id'
+            string   'fuel_type_id'
+            string   'airline_id'
+            string   'seat_class_id'
+            integer  'seats_estimate'
+            float    'load_factor'
+            string   'domesticity_id'
+            date     'date'
+            integer  'year'
+            time     'time_of_day'
+          end
+          
+          process "pull dependencies" do
+            run_data_miner_on_belongs_to_associations
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flight/summarization.rb

@@ -0,0 +1,20 @@
+module BrighterPlanet
+  module Flight
+    module Summarization
+      def self.included(base)
+        base.summarize do |has|
+          has.adjective 'one-way', :if => lambda { |flight| flight.trips == 1 }
+          has.adjective 'round-trip', :if => lambda { |flight| flight.trips == 1 }
+          has.adjective 'nonstop', :if => lambda { |flight| flight.emplanements_per_trip == 1 }
+          has.identity 'flight'
+          has.modifier lambda { |flight| "from #{flight.origin_airport.name}" }, :if => :origin_airport
+          has.modifier lambda { |flight| "to #{flight.destination_airport.name}" }, :if => :destination_airport
+          has.modifier lambda { |flight| "on a #{flight.vehicle}" }, :if => :vehicle
+          has.modifier lambda { |flight| "on #{flight.date.to_formatted_s(:archive)}"}, :if => :date
+          has.verb :take
+          has.aspect :perfect
+        end
+      end
+    end
+  end
+end

data/lib/test_support/data_models/aircraft.rb

@@ -0,0 +1,25 @@
+class Aircraft < ActiveRecord::Base
+  set_table_name 'aircraft'
+  set_primary_key :icao_code
+  
+  belongs_to :aircraft_class, :foreign_key => 'brighter_planet_aircraft_class_code'
+  belongs_to :manufacturer,   :foreign_key => 'manufacturer_name',                  :class_name => 'AircraftManufacturer'
+  has_many   :segments,       :foreign_key => 'bts_aircraft_type_code',             :class_name => "FlightSegment", :primary_key => 'bts_aircraft_type_code'
+
+  falls_back_on :m3 =>                      lambda { weighted_average(:m3,             :weighted_by => [:segments, :passengers]) }, # 9.73423082858437e-08   r7110: 8.6540464368905e-8      r6972: 8.37e-8
+                :m2 =>                      lambda { weighted_average(:m2,             :weighted_by => [:segments, :passengers]) }, # -0.000134350543484608  r7110: -0.00015337661447817    r6972: -4.09e-5
+                :m1 =>                      lambda { weighted_average(:m1,             :weighted_by => [:segments, :passengers]) }, # 6.7728101555467        r7110: 4.7781966869412         r6972: 7.85
+                :endpoint_fuel =>           lambda { weighted_average(:endpoint_fuel,  :weighted_by => [:segments, :passengers]) }, # 1527.81790006167       r7110: 1065.3476555284         r6972: 1.72e3
+                :seats =>                   lambda { weighted_average(:seats,          :weighted_by => [:segments, :passengers]) } # 62.1741
+
+  class << self
+    def loose_search_columns
+      @_loose_search_columns ||= [primary_key, :manufacturer_name, :name]
+    end
+
+    # search by name
+    def loose_right_reader
+      @_loose_right_reader ||= lambda { |record| record[1,2].join ' ' }
+    end
+  end
+end

data/lib/test_support/data_models/aircraft_class.rb

@@ -0,0 +1,6 @@
+class AircraftClass < ActiveRecord::Base
+  set_primary_key :brighter_planet_aircraft_class_code
+  
+  has_many :aircraft, :foreign_key => 'brighter_planet_aircraft_class_code'
+#  has_many :airline_aircraft_seat_classes, :through => :aircraft
+end

data/lib/test_support/data_models/aircraft_manufacturer.rb

@@ -0,0 +1,5 @@
+class AircraftManufacturer < ActiveRecord::Base
+  set_primary_key :name
+  
+  has_many :aircraft, :foreign_key => 'manufacturer_name'
+end

data/lib/test_support/data_models/airline.rb

@@ -0,0 +1,24 @@
+class Airline < ActiveRecord::Base
+  set_primary_key :iata_code
+
+#  has_many :airline_aircraft, :class_name => 'AirlineAircraft'
+#  has_many :seat_classes, :class_name => 'AirlineSeatClass'
+  has_many :segments, :class_name => "FlightSegment", :foreign_key => 'airline_iata_code'
+#  has_many :airline_aircraft_seat_classes, :class_name => 'AirlineAircraftSeatClass'
+
+  
+  class << self
+    def loose_search_columns
+      @_loose_search_columns ||= [primary_key, :name]
+    end
+  
+    # search by name
+    def loose_right_reader
+      @_loose_right_reader ||= lambda { |record| record[1] }
+    end
+  end
+  
+  def all_flights_domestic?
+    !international?
+  end
+end

data/lib/test_support/data_models/airport.rb

@@ -0,0 +1,52 @@
+class Airport < ActiveRecord::Base
+  set_primary_key :iata_code
+
+  acts_as_mappable :default_units => :nms,
+                   :lat_column_name => :latitude,
+                   :lng_column_name => :longitude
+  
+  class << self
+    def loose_search_columns
+      @_loose_search_columns ||= [primary_key, :city]
+    end
+
+    # search by name
+    def loose_right_reader
+      @_loose_right_reader ||= lambda { |record| record[1] }
+    end
+  end
+  
+  def name_and_location
+    [ name.to_s.titleize, city, country.andand.name ].select(&:present?).join ', '
+  end
+  
+  # --------------------------------
+  # virtual has_many association
+  # has_many :segments won't work because there's no general way to specify the correct conditions
+  # even if you get clever with it, like
+  # has_many  :segments,
+  #           :class_name => 'FlightSegment',
+  #           :foreign_key => 'origin_airport_id',
+  #           :conditions => 'flight_segments.destination_airport_id = #{id}'
+  # you get queries like "`flight_segments`.origin_airport_id = 3654 AND (flight_segments.destination_airport_id = 3654))"
+  # in which you notice the AND which must be an OR
+  # and you can't just do finder_sql, because that breaks any other :select
+  def segments
+    FlightSegment.scoped :conditions => ['origin_airport_id = ? OR destination_airport_id = ?', id, id]
+  end
+  # --------------------------------
+  
+  belongs_to :country, :foreign_key => 'country_iso_3166_code'
+
+  def all_flights_from_here_domestic?
+    !international_origin?
+  end
+
+  def all_flights_to_here_domestic?
+    !international_destination?
+  end
+  
+  def united_states?
+    country == Country.united_states
+  end
+end