earth 0.12.4 → 1.0.0

data/lib/earth/air.rb

@@ -1,3 +1,3 @@
 # lib/earth/air.rb
 require 'earth'
-Earth.require_related __FILE__
+Earth::Loader.require_related __FILE__

data/lib/earth/air/aircraft.rb

@@ -1,6 +1,43 @@
 require 'fuzzy_match/cached_result'
+require 'falls_back_on'
+
+require 'earth/model'
+
+require 'earth/air/flight_segment'
 
 class Aircraft < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE aircraft
+  (
+     icao_code            CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     manufacturer_name    CHARACTER VARYING(255),
+     model_name           CHARACTER VARYING(255),
+     description          CHARACTER VARYING(255),
+     aircraft_type        CHARACTER VARYING(255),
+     engine_type          CHARACTER VARYING(255),
+     engines              INTEGER,
+     weight_class         CHARACTER VARYING(255),
+     class_code           CHARACTER VARYING(255),
+     passengers           FLOAT,
+     seats                FLOAT,
+     seats_specificity    CHARACTER VARYING(255),
+     m3                   FLOAT,
+     m3_units             CHARACTER VARYING(255),
+     m2                   FLOAT,
+     m2_units             CHARACTER VARYING(255),
+     m1                   FLOAT,
+     m1_units             CHARACTER VARYING(255),
+     b                    FLOAT,
+     b_units              CHARACTER VARYING(255),
+     fuel_use_specificity CHARACTER VARYING(255)
+  );
+CREATE INDEX index_aircraft_on_description ON aircraft (description);
+
+EOS
+
   self.primary_key = "icao_code"
   
   # Fuzzy association with FlightSegment
@@ -122,27 +159,6 @@ class Aircraft < ActiveRecord::Base
                 :m1_units => 'kilograms_per_nautical_mile',
                 :b_units  => 'kilograms'
   
-  col :icao_code
-  col :manufacturer_name
-  col :model_name
-  col :description
-  col :aircraft_type
-  col :engine_type
-  col :engines, :type => :integer
-  col :weight_class
-  col :class_code
-  col :passengers, :type => :float
-  col :seats, :type => :float
-  col :seats_specificity
-  col :m3, :type => :float
-  col :m3_units
-  col :m2, :type => :float
-  col :m2_units
-  col :m1, :type => :float
-  col :m1_units
-  col :b, :type => :float
-  col :b_units
-  col :fuel_use_specificity
 
   warn_if_nulls_except(
     :passengers,

data/lib/earth/air/aircraft/data_miner.rb

@@ -22,10 +22,6 @@ Aircraft.class_eval do
   end
   
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     ('A'..'Z').each do |letter|
       import("aircraft made by whitelisted manufacturers whose ICAO code starts with '#{letter}' from the FAA",
              :url => "http://www.faa.gov/air_traffic/publications/atpubs/CNT/5-2-#{letter}.htm",

data/lib/earth/air/airline.rb

@@ -1,15 +1,29 @@
+require 'earth/model'
+
+require 'earth/air/flight_segment'
+
 class Airline < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE airlines
+  (
+     name           CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     secondary_name CHARACTER VARYING(255),
+     bts_code       CHARACTER VARYING(255),
+     iata_code      CHARACTER VARYING(255),
+     icao_code      CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
 
   has_many :flight_segments,
     :primary_key => :bts_code,
     :foreign_key => :airline_bts_code
   
-  col :name
-  col :secondary_name
-  col :bts_code
-  col :iata_code
-  col :icao_code
 
   warn_unless_size 1523 # note: this is overridden in data1, which imports extra airlines from proprietary data
 end

data/lib/earth/air/airline/data_miner.rb

@@ -7,10 +7,6 @@ Airline.class_eval do
   end
   
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     import "the BTS unique carrier code lookup table",
            :url => 'http://www.transtats.bts.gov/Download_Lookup.asp?Lookup=L_UNIQUE_CARRIERS',
            :errata => { :url => "file://#{Earth::ERRATA_DIR}/airline/bts_carrier_codes_errata.csv", :responder => 'Airline::Guru' } do

data/lib/earth/air/airport.rb

@@ -1,7 +1,28 @@
-require ::File.join(Earth::VENDOR_DIR, 'geokit-rails', 'lib', 'geokit-rails')
-require 'earth/locality'
+require 'earth/model'
+require 'earth/loader'
+Earth::Loader.load_plugins
+
+require 'earth/locality/country'
+require 'earth/air/flight_segment'
 
 class Airport < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE airports
+  (
+     iata_code             CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     name                  CHARACTER VARYING(255),
+     city                  CHARACTER VARYING(255),
+     country_name          CHARACTER VARYING(255),
+     country_iso_3166_code CHARACTER VARYING(255),
+     latitude              FLOAT,
+     longitude             FLOAT
+  );
+
+EOS
+
   self.primary_key = "iata_code"
   
   belongs_to :country,
@@ -18,13 +39,6 @@ class Airport < ActiveRecord::Base
                    :lat_column_name => :latitude,
                    :lng_column_name => :longitude
 
-  col :iata_code
-  col :name
-  col :city
-  col :country_name
-  col :country_iso_3166_code
-  col :latitude, :type => :float
-  col :longitude, :type => :float
 
   warn_unless_size 5324
 end

data/lib/earth/air/airport/data_miner.rb

@@ -1,4 +1,4 @@
-require 'earth/locality/data_miner'
+require 'earth/locality/country'
 
 Airport.class_eval do
   class Airport::Guru
@@ -21,10 +21,6 @@ Airport.class_eval do
   end
   
   data_miner do
-    process "Start from scratch" do
-      delete_all
-    end
-    
     process "Ensure Country is populated" do
       Country.run_data_miner!
     end

data/lib/earth/air/bts_aircraft.rb

@@ -1,7 +1,19 @@
+require 'earth/model'
+
 class BtsAircraft < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE bts_aircraft
+  (
+     bts_code    CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     description CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "bts_code"
-  col :bts_code
-  col :description
 
   warn_unless_size 379
 end

data/lib/earth/air/flight_distance_class.rb

@@ -1,17 +1,29 @@
+require 'earth/model'
+
 class FlightDistanceClass < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE flight_distance_classes
+  (
+     name               CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     distance           FLOAT,
+     distance_units     CHARACTER VARYING(255),
+     min_distance       FLOAT,
+     min_distance_units CHARACTER VARYING(255),
+     max_distance       FLOAT,
+     max_distance_units CHARACTER VARYING(255)
+  );
+
+EOS
+
   self.primary_key = "name"
   
   def self.find_by_distance(distance)
     first :conditions => arel_table[:min_distance].lt(distance.to_f).and(arel_table[:max_distance].gteq(distance.to_f))
   end
   
-  col :name
-  col :distance, :type => :float
-  col :distance_units
-  col :min_distance, :type => :float
-  col :min_distance_units
-  col :max_distance, :type => :float
-  col :max_distance_units
 
   warn_unless_size 2
 end

data/lib/earth/air/flight_distance_class_seat_class.rb

@@ -1,4 +1,25 @@
+require 'falls_back_on'
+
+require 'earth/model'
+
+require 'earth/air/flight_distance_class'
+require 'earth/air/flight_seat_class'
+
 class FlightDistanceClassSeatClass < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE flight_distance_class_seat_classes
+  (
+     name                CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     distance_class_name CHARACTER VARYING(255),
+     seat_class_name     CHARACTER VARYING(255),
+     multiplier          FLOAT
+  );
+
+EOS
+
   self.primary_key = "name"
   
   belongs_to :seat_class, :class_name => 'FlightSeatClass', :foreign_key => 'seat_class_name'
@@ -7,10 +28,6 @@ class FlightDistanceClassSeatClass < ActiveRecord::Base
   falls_back_on :name => 'fallback',
                 :multiplier => 1.0
   
-  col :name
-  col :distance_class_name
-  col :seat_class_name
-  col :multiplier, :type => :float
 
   warn_unless_size 7
 end

data/lib/earth/air/flight_seat_class.rb

@@ -1,7 +1,19 @@
+require 'earth/model'
+
 class FlightSeatClass < ActiveRecord::Base
+  extend Earth::Model
+
+  TABLE_STRUCTURE = <<-EOS
+
+CREATE TABLE flight_seat_classes
+  (
+     name CHARACTER VARYING(255) NOT NULL PRIMARY KEY
+  );
+
+EOS
+
   self.primary_key = "name"
   
-  col :name
 
   warn_unless_size 4
 end

data/lib/earth/air/flight_seat_class/data_miner.rb

@@ -1,3 +1,5 @@
+require 'earth/air/flight_distance_class_seat_class'
+
 FlightSeatClass.class_eval do
   data_miner do
     process "Ensure that FlightDistanceClassSeatClass is populated" do

data/lib/earth/air/flight_segment.rb

@@ -1,28 +1,62 @@
-require 'earth/locality'
+require 'falls_back_on'
 require 'fuzzy_match/cached_result'
 
+require 'earth/model'
+
+require 'earth/air/aircraft'
+require 'earth/air/airline'
+
 class FlightSegment < ActiveRecord::Base
-  self.primary_key = "row_hash"
+  extend Earth::Model
 
-  belongs_to :airline,
-    :primary_key => :bts_code,
-    :foreign_key => :airline_bts_code
+  TABLE_STRUCTURE = <<-EOS
 
-  belongs_to :origin_airport,
-    :class_name => 'Airport',
-    :primary_key => :iata_code,
-    :foreign_key => :origin_airport_iata_code
-  belongs_to :destination_airport,
-    :class_name => 'Airport',
-    :primary_key => :iata_code,
-    :foreign_key => :destination_airport_iata_code
-  
-  # Cutting this for now because if iata code is missing we have to look up airports using both city and country; don't know how to do this with ActiveRecord
-  # - Ian 6/12/2011
-  # # If airport iata code is missing, associate with all airports in a city
-  # # We need this to calculate distance when importing ICAO segments - see cm1 flight_segment.rb
-  # has_many :origin_city_airports,      :foreign_key => 'city', :primary_key => 'origin_airport_city',      :class_name => 'Airport'
-  # has_many :destination_city_airports, :foreign_key => 'city', :primary_key => 'destination_airport_city', :class_name => 'Airport'
+CREATE TABLE flight_segments
+  (
+     row_hash                          CHARACTER VARYING(255) NOT NULL PRIMARY KEY,
+     origin_airport_iata_code          CHARACTER VARYING(255),
+     origin_airport_city               CHARACTER VARYING(255),
+     origin_country_iso_3166_code      CHARACTER VARYING(255),
+     destination_airport_iata_code     CHARACTER VARYING(255),
+     destination_airport_city          CHARACTER VARYING(255),
+     destination_country_iso_3166_code CHARACTER VARYING(255),
+     airline_bts_code                  CHARACTER VARYING(255),
+     airline_icao_code                 CHARACTER VARYING(255),
+     airline_name                      CHARACTER VARYING(255), /* text description derived from bts or icao code */
+     aircraft_bts_code                 CHARACTER VARYING(255),
+     aircraft_description              CHARACTER VARYING(255), /* text description derived from BTS T100 or ICAO TFS */
+     flights                           INTEGER,                /* number of flights over month or year */
+     passengers                        INTEGER,                /* total passengers on all flights */
+     seats                             INTEGER,                /* total seats on all flights */
+     seats_per_flight                  FLOAT,                  /* average seats per flight */
+     load_factor                       FLOAT,                  /* passengers / seats */
+     freight_share                     FLOAT,                  /* (freight + mail) / (freight + mail + (passengers * average passenger weight)) */
+     distance                          FLOAT,
+     distance_units                    CHARACTER VARYING(255),
+     payload_capacity                  FLOAT,                  /* aircraft maximum payload capacity rating */
+     payload_capacity_units            CHARACTER VARYING(255),
+     freight                           FLOAT,                  /* total freight on all flights performed */
+     freight_units                     CHARACTER VARYING(255),
+     mail                              FLOAT,                  /* total mail on all flights performed */
+     mail_units                        CHARACTER VARYING(255),
+     month                             INTEGER,
+     year                              INTEGER,
+     source                            CHARACTER VARYING(255)  /* 'BTS T100' or 'ICAO TFS' */
+  );
+CREATE INDEX index_flight_segments_on_origin_airport_iata_code ON flight_segments (origin_airport_iata_code);
+CREATE INDEX index_flight_segments_on_origin_airport_city ON flight_segments (origin_airport_city);
+CREATE INDEX index_flight_segments_on_destination_airport_iata_code ON flight_segments (destination_airport_iata_code);
+CREATE INDEX index_flight_segments_on_destination_airport_city ON flight_segments (destination_airport_city);
+CREATE INDEX index_flight_segments_on_airline_bts_code ON flight_segments (airline_bts_code);
+CREATE INDEX index_flight_segments_on_airline_icao_code ON flight_segments (airline_icao_code);
+CREATE INDEX index_flight_segments_on_airline_name ON flight_segments (airline_name);
+CREATE INDEX index_flight_segments_on_aircraft_bts_code ON flight_segments (aircraft_bts_code);
+CREATE INDEX index_flight_segments_on_aircraft_description ON flight_segments (aircraft_description);
+CREATE INDEX index_flight_segments_on_year ON flight_segments (year)
+
+EOS
+
+  self.primary_key = "row_hash"
   
   # Enable flight_segment.aircraft
   cache_fuzzy_match_with :aircraft, :primary_key => :aircraft_description, :foreign_key => :description
@@ -49,45 +83,8 @@ class FlightSegment < ActiveRecord::Base
                 :load_factor      => lambda { weighted_average(:load_factor,      :weighted_by => :passengers) }, # 0.78073233770097  data1 10-12-2010
                 :freight_share    => lambda { weighted_average(:freight_share,    :weighted_by => :passengers) }  # 0.022567224170157 data1 10-12-2010
   
-  col :row_hash                            # auto-generated primary key
-  col :origin_airport_iata_code            # iata code
-  col :origin_airport_city                 # city
-  col :origin_country_iso_3166_code        # iso code
-  col :destination_airport_iata_code       # iata code
-  col :destination_airport_city            # city
-  col :destination_country_iso_3166_code   # iso code
-  col :airline_bts_code                    # bts code
-  col :airline_icao_code                   # icao code
-  col :airline_name                        # text description derived from bts or icao code
-  col :aircraft_bts_code                   # bts code
-  col :aircraft_description                # text description derived from BTS T100 or ICAO TFS
-  col :flights,          :type => :integer # number of flights over month or year
-  col :passengers,       :type => :integer # total passengers on all flights
-  col :seats,            :type => :integer # total seats on all flights
-  col :seats_per_flight, :type => :float   # average seats per flight; make this a float
-  col :load_factor,      :type => :float   # passengers / seats
-  col :freight_share,    :type => :float   # (freight + mail) / (freight + mail + (passengers * average passenger weight))
-  col :distance,         :type => :float   # flight distance
-  col :distance_units                      # 'kilometres'
-  col :payload_capacity, :type => :float   # aircraft maximum payload capacity rating; float b/c unit conversion
-  col :payload_capacity_units              # 'kilograms'
-  col :freight,          :type => :float   # total freight on all flights performed; float b/c unit conversion
-  col :freight_units                       # 'kilograms'
-  col :mail,             :type => :float   # total mail on all flights performed; float b/c unit conversion
-  col :mail_units                          # 'kilograms'
-  col :month,            :type => :integer # month of flight
-  col :year,             :type => :integer # year of flight
-  col :source                              # 'BTS T100' or 'ICAO TFS'
-  add_index :origin_airport_iata_code
-  add_index :origin_airport_city
-  add_index :destination_airport_iata_code
-  add_index :destination_airport_city
-  add_index :airline_bts_code
-  add_index :airline_icao_code
-  add_index :airline_name
-  add_index :aircraft_bts_code
-  add_index :aircraft_description
-  add_index :year
+  # FIXME remove this - wherever you're trying to create a flight segment, just don't use mass-assignment for the primary key
+  attr_accessible :row_hash
 
   warn_if_nulls_except(
     :origin_airport_city,
@@ -98,4 +95,12 @@ class FlightSegment < ActiveRecord::Base
   )
 
   warn_unless_size 1_254_412
+
+  def airline
+    if airline_bts_code
+      Airline.where(:bts_code => airline_bts_code).first
+    else
+      Airline.where(:icao_code => airline_icao_code).first
+    end
+  end
 end