geonames-data 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a44320d3a2e77a54cebfe239bcadc6b08609db8d
+  data.tar.gz: 9864a5e8d03ff42fde1ac42cf51b6e05ceb2a94a
+SHA512:
+  metadata.gz: 2fd9681b61a61cbf253a66512c473bbe4ac23861fe626b1f8c8781c92916754df13d9fb191a9b44e44052e726f6962fc0b14aaf04958077848809a6160fbfc51
+  data.tar.gz: 0a93f5a56136abe3ed8436af372741bea6be5514b7101d79aed81d5dc616afd84579967e4ecff1342772717776dae75d3ace3707177cdd0b84ef97552b54df46

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geonames-data.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Carney
+
+MIT License
+
+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.md

@@ -0,0 +1,74 @@
+# Geonames::Data
+
+Library for working with [Geonames data][geonames-data].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geonames-data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geonames-data
+
+## Usage
+
+To load a set of Geonames features:
+
+```ruby
+Geonames::Data.load_features("cities1000.txt")
+```
+
+Some of the Geonames files can be unworkably huge, so you can provide a filter
+block to `load_features`. The following example will load only airports:
+
+```ruby
+Geonames::Data.load_features("allCountries.txt") do |feature|
+  feature.feature_code == "AIRP"
+end
+```
+
+### Indexing
+
+Once you've got a set of features, you will probably want to index them
+somehow. There are two classes provided for this: `Geonames::Data::NameIndex`
+and `Geonames::Data::LocationIndex`.
+
+#### Name index
+
+`Geonames::Data::NameIndex` indexes Geonames features by name, including their
+ASCII name and all alternate names.
+
+```ruby
+cities = Geonames::Data.load_features("cities1000.txt")
+index = Geonames::Data::NameIndex.new(cities)
+index["Melbourne"]
+```
+
+#### Location index
+
+`Geonames::Data::LocationIndex` indexes Geonames features by geolocation
+(latitude and longitude).
+
+```ruby
+Geonames::Data.load_features("allCountries.txt") do |feature|
+  feature.feature_code == "AIRP"
+end
+index = Geonames::Data::NameIndex.new(cities)
+index.nearest(-37.814, 144.96332)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/geonames-data/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[geonames-data]: http://download.geonames.org/export/dump

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/geonames-data.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geonames/data/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geonames-data"
+  spec.version       = Geonames::Data::VERSION
+  spec.authors       = ["John Carney"]
+  spec.email         = ["john@carney.id.au"]
+  spec.summary       = %q{Library for working with Geonames data}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_runtime_dependency "kdtree"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/geonames/data.rb

@@ -0,0 +1,12 @@
+require "geonames/data/version"
+require "geonames/data/feature"
+require "geonames/data/name_index"
+require "geonames/data/location_index"
+
+module Geonames
+  module Data
+    def self.load_features(filepath, &filter)
+      Feature.load(filepath, &filter)
+    end
+  end
+end

data/lib/geonames/data/feature.rb

@@ -0,0 +1,58 @@
+require "pathname"
+
+module Geonames
+  module Data
+    class Feature
+      def self.field(name)
+        @fields ||= []
+        index = @fields.size
+        @fields << name
+        if block_given?
+          define_method name do
+            yield(@data[index])
+          end
+        else
+          define_method name do
+            @data[index]
+          end
+        end
+      end
+
+      field(:geoname_id, &:to_i)
+      field(:name)
+      field(:ascii_name)
+      field(:alternate_names)   { |names| names.split(",") }
+      field(:latitude,  &:to_f)
+      field(:longitude, &:to_f)
+      field(:feature_class)
+      field(:feature_code)
+      field(:country_code)
+      field(:cc2)               { |cc2| cc2.split(",") }
+      field(:admin1_code)
+      field(:admin2_code)
+      field(:admin3_code)
+      field(:admin4_code)
+      field(:population, &:to_i)
+      field(:elevation,  &:to_i)
+      field(:dem)
+      field(:timezone)
+      field(:modification_date)
+
+      def initialize(data)
+        @data = data.dup
+      end
+
+      def names
+        @names ||= [ name, ascii_name, *alternate_names ]
+      end
+
+      def self.load(filepath, &filter)
+        Pathname.new(filepath).open("r").inject([]) do |features, line|
+          feature = Feature.new(line.strip.split("\t"))
+          features.push(feature) if !block_given? || yield(feature)
+          features
+        end
+      end
+    end
+  end
+end

data/lib/geonames/data/location_index.rb

@@ -0,0 +1,23 @@
+require "kdtree"
+
+module Geonames
+  module Data
+    class LocationIndex
+      def initialize(features)
+        @features = features.inject({}) { |index, feature| index.update(feature.geoname_id => feature) }
+        points = features.map do |feature|
+          [ feature.latitude, feature.longitude, feature.geoname_id ]
+        end
+        @index = Kdtree.new(points)
+      end
+
+      def nearest(latitude, longitude)
+        @features[@index.nearest(latitude, longitude)]
+      end
+
+      def self.load(filepath, &filter)
+        new(Features.load(filepath, filter))
+      end
+    end
+  end
+end

data/lib/geonames/data/name_index.rb

@@ -0,0 +1,23 @@
+module Geonames
+  module Data
+    class NameIndex
+      def initialize(features)
+        @index = features.inject({}) do |index, feature|
+          feature.names.inject(index) do |index, name|
+            index[name] ||= []
+            index[name].push(feature).uniq!
+            index
+          end
+        end
+      end
+
+      def [](name)
+        @index[name]
+      end
+
+      def self.load(filepath, &filter)
+        new(Feature.load(filepath, &filter))
+      end
+    end
+  end
+end

data/lib/geonames/data/version.rb

@@ -0,0 +1,5 @@
+module Geonames
+  module Data
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: geonames-data
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Carney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kdtree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- john@carney.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geonames-data.gemspec
+- lib/geonames/data.rb
+- lib/geonames/data/feature.rb
+- lib/geonames/data/location_index.rb
+- lib/geonames/data/name_index.rb
+- lib/geonames/data/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Library for working with Geonames data
+test_files: []