elcgeo 0.0.1 → 0.0.2

data/Manifest

@@ -1,3 +1,16 @@
+Manifest
+README.textile
 Rakefile
+TODO
+elcgeo.gemspec
 lib/elcgeo.rb
-Manifest
+rails_generators/geo/USAGE
+rails_generators/geo/geo_generator.rb
+rails_generators/geo/templates/migration.rb
+rails_generators/geo/templates/models/city.rb
+rails_generators/geo/templates/models/country.rb
+rails_generators/geo/templates/models/county.rb
+rails_generators/geo/templates/models/place.rb
+rails_generators/geo/templates/models/state.rb
+rails_generators/geo/templates/models/zip_code.rb
+rails_generators/geo/templates/tasks/import_places.rake

data/README.textile

@@ -0,0 +1,14 @@
+GEO generator creates database migrations, models and helper rake tasks to add GEO functionality to a Rails application.
+
+*Supported countries:*
+
+* USA
+
+h3. Usage
+
+<pre><code>$ script/generate geo
+</code></pre>
+
+
+Built thanks to instructions:
+http://buzaz.com/index.php/2010/01/03/how-to-build-a-ruby-gem/

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('elcgeo', '0.0.1') do |p|
+Echoe.new('elcgeo', '0.0.2') do |p|
   p.description    = "ELC Technologies GEO tools"
   p.url            = "http://github.com/elc/elcgeo"
   p.author         = "ELC Technologies"

data/TODO

@@ -0,0 +1,6 @@
+- Update README
+- Add Canada
+- Add tests
+- Add index to places table
+- Add controllers(?)
+- Publish gem to rubygems.org

data/elcgeo.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{elcgeo}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["ELC Technologies"]
-  s.date = %q{2010-05-07}
+  s.date = %q{2010-05-11}
   s.description = %q{ELC Technologies GEO tools}
   s.email = %q{info @nospam@ elctech.com}
-  s.extra_rdoc_files = ["lib/elcgeo.rb"]
-  s.files = ["Rakefile", "lib/elcgeo.rb", "Manifest", "elcgeo.gemspec"]
+  s.extra_rdoc_files = ["README.textile", "TODO", "lib/elcgeo.rb"]
+  s.files = ["Manifest", "README.textile", "Rakefile", "TODO", "elcgeo.gemspec", "lib/elcgeo.rb", "rails_generators/geo/USAGE", "rails_generators/geo/geo_generator.rb", "rails_generators/geo/templates/migration.rb", "rails_generators/geo/templates/models/city.rb", "rails_generators/geo/templates/models/country.rb", "rails_generators/geo/templates/models/county.rb", "rails_generators/geo/templates/models/place.rb", "rails_generators/geo/templates/models/state.rb", "rails_generators/geo/templates/models/zip_code.rb", "rails_generators/geo/templates/tasks/import_places.rake"]
   s.homepage = %q{http://github.com/elc/elcgeo}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Elcgeo", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Elcgeo", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{elcgeo}
   s.rubygems_version = %q{1.3.6}

data/lib/elcgeo.rb

@@ -1,3 +1,5 @@
+# nothing to see here, the real action is under rails_generators
+
 # rake install elcgeo.gemspec
 # start irb and test
 # 
@@ -5,13 +7,13 @@
 # require 'rubygems'
 # require 'elcgeo'
 # ELC::Geo.version
-# => 0.1
+# => 0.2
 #
 # rake gem
 module ELC
   module Geo
     def self.version
-      puts '0.1'
+      puts '0.2'
     end
   end
 end

data/rails_generators/geo/USAGE

@@ -0,0 +1,9 @@
+Description:
+    The GEO generator creates database migrations, models and helper rake tasks to
+    add GEO functionality to a Rails application.
+
+    Supported countries:
+    * USA
+  
+Examples:
+    script/generate geo

data/rails_generators/geo/geo_generator.rb

@@ -0,0 +1,50 @@
+class GeoGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory "app/models"
+      m.directory "lib"
+      m.directory "lib/tasks"
+      m.directory "db/migrate"
+      m.directory "db/data"
+
+      models = %w(city country county place state zip_code)
+      models.each do |model|
+        m.template "models/#{model}.rb", "app/models/#{model}.rb"
+      end
+
+      m.template "tasks/import_places.rake", "lib/tasks/import_places.rake"
+
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_countries_and_places"
+
+      if test_framework == :rspec
+      else
+      end
+    end
+  end
+
+  protected
+
+  def test_framework
+    options[:test_framework] ||= File.exist?(destination_path("spec")) ? :rspec : :testunit
+  end
+
+#  def add_options!(opt)
+#    opt.separator ''
+#    opt.separator 'Options:'
+#    opt.on("--testunit", "Use test/unit for test files.") { options[:test_framework] = :testunit }
+#    opt.on("--rspec", "Use RSpec for test files.") { options[:test_framework] = :rspec }
+#  end
+
+  def banner
+    <<-EOS
+Creates GEO models, migrations and helper rake tasks.
+
+USAGE: #{$0} #{spec.name}
+EOS
+  end
+  
+end

data/rails_generators/geo/templates/migration.rb

@@ -0,0 +1,66 @@
+class CreateCountriesAndPlaces < ActiveRecord::Migration
+  def self.up
+    create_table :places, :primary_key => :geonameid do |t|
+      t.string  :name
+      t.string  :asciiname
+      t.string  :alternatenames, :limit => 4000
+      t.float   :latitude
+      t.float   :longitude
+      t.string  :feature_class, :limit => 1
+      t.string  :feature_code, :limit => 10
+      t.string  :country_code, :limit => 2
+      t.string  :cc2, :limit => 60
+      t.string  :admin1_code, :limit => 20
+      t.string  :admin2_code, :limit => 80
+      t.string  :admin3_code, :limit => 20
+      t.string  :admin4_code, :limit => 20
+      t.integer :population, :limit => 8
+      t.integer :elevation
+      t.integer :gtopo30
+      t.string  :timezone
+      t.string  :modification_date
+      t.integer :country_id
+      t.integer :state_id
+      t.integer :city_id
+      t.integer :county_id
+      t.string  :type
+
+      t.timestamps
+    end
+
+    create_table :countries do |t|
+      t.string :name
+      t.string :abbr
+      t.string :code
+
+      t.timestamps
+    end
+    add_index :countries, :name
+    add_index :countries, :abbr
+    add_index :countries, :code
+
+    create_table :zip_codes do |t|
+      t.string :name
+      t.string :zip_code
+      t.string :lat
+      t.string :lng
+      t.string :country_code
+      t.string :country_name
+      t.string :state_province_code
+      t.string :state_province_name
+      t.integer :county_code
+      t.string :county_name
+      t.integer :state_id
+      t.integer :county_id
+      t.integer :city_id
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :places
+    drop_table :countries
+    drop_table :zip_codes
+  end
+end

data/rails_generators/geo/templates/models/city.rb

@@ -0,0 +1,7 @@
+class City < Place
+  belongs_to :country
+  belongs_to :state
+  belongs_to :county
+
+  named_scope :popular, :conditions => ['state_id IS NOT NULL'], :order => 'population DESC', :limit => 25  
+end

data/rails_generators/geo/templates/models/country.rb

@@ -0,0 +1,10 @@
+class Country < ActiveRecord::Base
+  attr_accessible :all
+  validates_presence_of :code, :name
+  validates_uniqueness_of :code, :abbr, :name
+
+  has_many :states
+  has_many :counties
+end
+
+

data/rails_generators/geo/templates/models/county.rb

@@ -0,0 +1,8 @@
+class County < Place
+  belongs_to :country
+  belongs_to :state
+  has_many :cities, :class_name => "City",   :foreign_key => "county_id"
+
+  named_scope :popular, :order => 'population DESC', :limit => 25
+  def county_code; admin2_code; end
+end

data/rails_generators/geo/templates/models/place.rb

@@ -0,0 +1,13 @@
+class Place < ActiveRecord::Base
+  set_primary_key :geonameid
+
+  def state_province_code; admin1_code; end
+  alias :code :state_province_code
+
+  def lat; latitude; end
+  def lng; longitude; end
+
+  def self.find_by_code(code)
+    self.find_by_admin1_code(code)
+  end
+end

data/rails_generators/geo/templates/models/state.rb

@@ -0,0 +1,11 @@
+class State < Place
+  has_many :counties
+  has_many :cities
+  has_many :zip_codes
+  belongs_to :country
+
+  named_scope :popular, :order => 'population DESC', :limit => 25
+
+  # This is US states...
+  # named_scope :states, :conditions => { :country_code => Country.find_by_country_code("US") }
+end

data/rails_generators/geo/templates/models/zip_code.rb

@@ -0,0 +1,5 @@
+class ZipCode < ActiveRecord::Base
+  belongs_to :state
+  belongs_to :county
+  belongs_to :city
+end

data/rails_generators/geo/templates/tasks/import_places.rake

@@ -0,0 +1,132 @@
+namespace :import do
+
+  desc "Download and Import data files"
+  task :download_and_import do
+    Rake::Task["import:download"]. invoke
+    Rake::Task["import:places"].   invoke
+    Rake::Task["import:zip_codes"].invoke
+  end
+
+  desc "Download data files"
+  task :download do
+    puts 'Downloading http://download.geonames.org/export/zip/US.zip'
+    `cd db/data && curl -O http://download.geonames.org/export/zip/US.zip`
+    `cd db/data && unzip US.zip`
+    `cd db/data && rm US.zip`
+    `cd db/data && mv US.txt US_zip.csv`
+    `cd db/data && mv readme.txt US_zip_readme.txt`
+
+    puts 'Downloading http://download.geonames.org/export/dump/US.zip'
+    `cd db/data && curl -O http://download.geonames.org/export/dump/US.zip`
+    `cd db/data && unzip US.zip`
+    `cd db/data && rm US.zip`
+    `cd db/data && mv US.txt US.csv`
+    `cd db/data && mv readme.txt US_readme.txt`
+    puts
+    puts 'Done. Now run following rake tasks to import places and/or zip codes'
+    puts 'rake import:places'
+    puts 'rake import:zip_codes'
+  end
+
+  # This only works on MySQL because of the CSV "LOAD DATA INFILE"
+  desc "Import places"
+  task :places => :environment do
+    puts "Deleting all places..."
+    Place.delete_all
+
+    puts "Importing places..."
+    ActiveRecord::Base.connection.execute "LOAD DATA LOCAL INFILE '#{RAILS_ROOT}/db/data/US.csv' INTO TABLE places FIELDS TERMINATED BY '\t' OPTIONALLY ENCLOSED BY '\"' LINES TERMINATED BY '\n';"
+
+    Place.delete_all("feature_code <> 'ADM1' AND feature_code <> 'ADM2' AND feature_code <> 'PPL' AND feature_code <> 'PPLA'")
+
+    puts "Updating states..."
+    Place.update_all("type = 'State'",  "feature_code = 'ADM1'")
+    puts "Updating counties..."
+    Place.update_all("type = 'County'", "feature_code = 'ADM2'")
+    puts "Updating cities..."
+    Place.update_all("type = 'City'",   "feature_code = 'PPL' OR feature_code = 'PPLA'")
+
+    puts "Setting country..."
+    country = Country.find_by_abbr("USA")
+    Place.update_all("country_id = #{country.id}") if country
+
+    Rake::Task["import:update_place_ids"].invoke
+
+    puts "Done."
+  end
+
+  task :update_place_ids => :environment do
+    State.find_each do |state|
+      sql_string = "update places
+                   set state_id = #{state.id}
+                   where admin1_code = \"#{state.state_province_code}\"
+                   and type <> \"State\""
+      puts sql_string.gsub(/\n|\t/,"").squeeze(" ")
+      ActiveRecord::Base.connection.execute(sql_string)
+    end
+
+    County.find_each do |county|
+      sql_string = "update places
+                  set county_id = #{county.id}
+                  where admin2_code = \"#{county.county_code}\"
+                  and admin1_code = \"#{county.state_province_code}\"
+                  and type = \"City\""
+      puts sql_string.gsub(/\n|\t/,"").squeeze(" ")
+      ActiveRecord::Base.connection.execute(sql_string)
+    end
+  end
+
+  desc "Import zip codes"
+  task :zip_codes => :environment do
+    puts "Deleting all zip codes..."
+    ZipCode.delete_all
+
+    puts "Importing zip codes..."
+    ActiveRecord::Base.connection.execute "LOAD DATA LOCAL INFILE '#{RAILS_ROOT}/db/data/US_zip.csv' \
+      INTO TABLE zip_codes FIELDS TERMINATED BY '\t' OPTIONALLY ENCLOSED BY '\"' LINES TERMINATED BY '\n' \
+      (country_code, zip_code, name, state_province_name, state_province_code, county_name, county_code, lat, lng)"
+
+    Rake::Task["import:update_zipcode_ids"].invoke
+  end
+
+  desc "Update the city/county/state zipcode relationships"
+  task :update_zipcode_ids => :environment do
+    Rake::Task["import:update_zipcode_state_ids"].invoke
+    Rake::Task["import:update_zipcode_county_ids"].invoke
+    Rake::Task["import:update_zipcode_city_ids"].invoke
+  end
+
+  task :update_zipcode_state_ids => :environment do
+    puts "Updating the state zipcode relationships..."
+    State.find(:all).each do |state|
+      sql_string = "update zip_codes
+                  set state_id = #{state.id}
+                  where state_province_code = \'#{state.state_province_code}\'"
+      puts sql_string
+      ActiveRecord::Base.connection.execute(sql_string)
+    end
+  end
+
+  task :update_zipcode_county_ids => :environment do
+    puts "Updating the county zipcode relationships..."
+    County.find(:all).each do |county|
+    sql_string = "update zip_codes
+                set county_id = #{county.id}
+                where county_code = \"#{county.county_code}\"
+                and state_province_code = \'#{county.state_province_code}\'"
+    puts sql_string.gsub(/\n|\t/,"").squeeze(" ")
+    ActiveRecord::Base.connection.execute(sql_string)
+    end
+  end
+
+  task :update_zipcode_city_ids => :environment do
+    puts "Updating the city zipcode relationships..."
+    City.find(:all, :select => "geonameid, name, state_id, county_id, city_id", :conditions => 'name IS NOT NULL').each do |city|
+      if city.state_id && city.county_id
+        ZipCode.update_all("city_id = #{city.id}", "state_id = #{city.state_id} AND county_id = #{city.county_id} AND replace(name, '''', ' ') = '#{city.name.gsub(/\'/," ")}'")
+        puts "updated #{city.name} zip codes"
+      end
+    end
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - ELC Technologies
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 +01:00
+date: 2010-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,12 +25,26 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.textile
+- TODO
 - lib/elcgeo.rb
 files: 
-- Rakefile
-- lib/elcgeo.rb
 - Manifest
+- README.textile
+- Rakefile
+- TODO
 - elcgeo.gemspec
+- lib/elcgeo.rb
+- rails_generators/geo/USAGE
+- rails_generators/geo/geo_generator.rb
+- rails_generators/geo/templates/migration.rb
+- rails_generators/geo/templates/models/city.rb
+- rails_generators/geo/templates/models/country.rb
+- rails_generators/geo/templates/models/county.rb
+- rails_generators/geo/templates/models/place.rb
+- rails_generators/geo/templates/models/state.rb
+- rails_generators/geo/templates/models/zip_code.rb
+- rails_generators/geo/templates/tasks/import_places.rake
 has_rdoc: true
 homepage: http://github.com/elc/elcgeo
 licenses: []
@@ -42,7 +56,7 @@ rdoc_options:
 - --title
 - Elcgeo
 - --main
-- README
+- README.textile
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement