offline_geocoder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4410ff33ce206d140d141583e7c7e5cc8760db87
-  data.tar.gz: 100cff63bbc8c2d6dbf7c0d15d64cb618f5134e1
+SHA256:
+  metadata.gz: 624ae1437a79be0335573dcec94f1677ed1979636baf41a6610bee14ff42d9f0
+  data.tar.gz: f025d8180b5b982684ccd920f91c4fecdb4a831db4a41b1c8ed21ad3a0f867d3
 SHA512:
-  metadata.gz: 0a7de65b07395318d3da0ba2b7af18f742a7b3dc75334528f507cd314eabdc7ce6d248b05f54116c756610f2c8db88d85cde2dc25ec90d02c642ff9e26b61805
-  data.tar.gz: 276388822d2d65a6c9b65a21ff9e897d002d4fd74186ca1277e22f0b2e39b9e79fe0f3c198bf8342c0a1264bca277f7f0bfa86bb703d9573ca15b347a77e0db8
+  metadata.gz: 225e5c077fcd9c9fc5c4dfd093683059a8ae54704dbf673920a8037b6a22ac9a1def33c05e240e86fd71013844f89ed447fe4e5d17624d70213e63669d2f73fb
+  data.tar.gz: 50cb8b88b0918987d13c8be1cbddfe664da39e970b67c98b809b7199c63b8bdbc9d3626d24b0f6ace42213d97a00e3f7bdb6c010504b684a08c79b287da883e8

data/Gemfile

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in offline_geocoder.gemspec
 gemspec
+gem 'coveralls', require: false

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2015 Electronic Inaka LLC
+   Copyright 2020 Roberto Romero
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,3 +1,8 @@
+[![Build Status](https://travis-ci.org/sildur/offline_geocoder.svg)](https://travis-ci.org/sildur/offline_geocoder) 
+[![Code Climate](https://codeclimate.com/github/sildur/offline_geocoder/badges/gpa.svg)](https://codeclimate.com/github/sildur/offline_geocoder)
+![Gem](https://img.shields.io/gem/v/offline_geocoder)
+![Gem](https://img.shields.io/gem/dt/offline_geocoder)
+
 # OfflineGeocoder
 
 A gem for offline reverse geocoding. It uses data from the [GeoNames](http://www.geonames.org/) project.
@@ -22,11 +27,8 @@ Or install it yourself as:
 
 ```ruby
 require "offline_geocoder"
-
 geocoder = OfflineGeocoder.new
-
 results = geocoder.search(51.5214588, -0.1729636)
-
 p results
 ```
 
@@ -36,9 +38,47 @@ The above code will output this:
 {:lat=>51.51116, :lon=>-0.18426, :name=>"Bayswater", :admin1=>"England", :admin2=>"Greater London", :cc=>"GB", :country=>"United Kingdom"}
 ```
 
+Alternatively, you can use named parameters when searching:
+
+```ruby
+results = geocoder.search(lat: 51.5214588, lon: -0.1729636)
+```
+
+### Searching for names or attributes
+
+You can search for names, countries and such. The first result will be
+returned.
+
+Searches are case sensitive and must match entirely. e.g. "York" will
+not find "New York", and "Cote dIvoire" will not match "Cote d'Ivoire".
+
+```ruby
+require "offline_geocoder"
+geocoder = OfflineGeocoder.new
+aus = geocoder.search(name: "Bayswater")
+p aus
+gb = geocoder.search(name: "Bayswater", country: "United Kingdom")
+p gb
+```
+
+The above code will output this:
+
+```ruby
+{:lat=>-37.85, :lon=>145.26667, :name=>"Bayswater", :admin1=>"Victoria", :admin2=>"Knox", :cc=>"AU", :country=>"Australia"}
+{:lat=>51.51116, :lon=>-0.18426, :name=>"Bayswater", :admin1=>"England", :admin2=>"Greater London", :cc=>"GB", :country=>"United Kingdom"}
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contact Us
+
+For **questions** or **general comments** regarding the use of this library, please use our public
+[hipchat room](http://inaka.net/hipchat).
+
+If you find any **bugs** or have a **problem** while using this library, please [open an issue](https://github.com/inaka/galgo/issues/new) in this repo (or a pull request :)).
+
+And you can check all of our open-source projects at [inaka.github.io](http://inaka.github.io)

data/Rakefile

@@ -1,5 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/bin/setup

@@ -3,5 +3,3 @@ set -euo pipefail
 IFS=$'\n\t'
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/offline_geocoder.rb

@@ -1,46 +1,51 @@
-require "offline_geocoder/version"
-require "csv"
-require "kdtree"
+# frozen_string_literal: true
+
+require 'offline_geocoder/version'
+require 'csv'
+require 'geokdtree'
 
 class OfflineGeocoder
+  CSV_PATH = File.expand_path('../og_cities1000.csv', __dir__)
+
   def initialize
-    unless defined? @@cities
-      @@cities = []
-      @@points = []
-      index = 0
-      csv_path = File.expand_path("../../og_cities1000.csv", __FILE__)
-      lines = File.read(csv_path).split("\n")
-      @@fields = lines[0].split(',').collect(&:to_sym)
-      lines[1..-1].each {|line|
-        parsed_line =
-          if line.include?('"')
-            CSV.parse(line)[0]
-          else
-            line.split(',')
-          end
-        parsed_line[0] = parsed_line[0].to_f
-        parsed_line[1] = parsed_line[1].to_f
-        @@cities << parsed_line
-        @@points << [parsed_line[0], parsed_line[1], index]
-        index += 1
-      }
-
-      @@tree = Kdtree.new(@@points)
-      return nil
+    return if defined? @@cities
+
+    @@cities = []
+    @@tree = Geokdtree::Tree.new(2)
+    @@table = []
+    index = 0
+    CSV.foreach(CSV_PATH, headers: true, header_converters: :symbol) do |row|
+      as_hash = row.to_h
+      as_hash[:lat] = as_hash[:lat].to_f
+      as_hash[:lon] = as_hash[:lon].to_f
+      @@tree.insert([row[:lat], row[:lon]], index)
+      @@table << as_hash
+      index += 1
     end
   end
 
-  def search(latitude, longitude)
-    record = @@cities[@@tree.nearest(latitude.to_f, longitude.to_f)]
-    hash_record = {}
-    record.each_with_index do |value, index|
-      hash_record[@@fields[index]] = value
+  def search(query, lon = nil)
+    lat, lon = lon.nil? ? [query[:lat], query[:lon]] : [query, lon]
+
+    if lat && lon
+      search_by_latlon(lat.to_f, lon.to_f)
+    else
+      search_by_attr(query)
     end
-    hash_record
   end
 
   # Hide internal variables
   def inspect
-    "#<#{self.class}:0x#{'%014x' % (self.object_id << 1)}>"
+    "#<#{self.class}:0x#{format('%<id>014x', id: (object_id << 1))}>"
+  end
+
+  private
+
+  def search_by_latlon(lat, lon)
+    @@table[@@tree.nearest([lat, lon]).data.to_i].to_h
+  end
+
+  def search_by_attr(query = {})
+    @@table.select { |object| object >= query }.first
   end
 end

data/lib/offline_geocoder/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class OfflineGeocoder
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/offline_geocoder.gemspec

@@ -1,26 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'offline_geocoder/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "offline_geocoder"
+  spec.name          = 'offline_geocoder'
   spec.version       = OfflineGeocoder::VERSION
-  spec.authors       = ["Roberto Romero"]
-  spec.email         = ["roberto@inaka.net"]
+  spec.authors       = ['Roberto Romero']
+  spec.date          = Time.now.utc.strftime('%Y-%m-%d')
+  spec.email         = ['roberto.offline_geocoder@nirae.at']
+
+  spec.summary       = 'Offline reverse geocoder'
+  spec.description   = 'Offline reverse geocoder. Uses GeoNames database'
+  spec.homepage      = 'https://github.com/sildur/offline_geocoder'
+  spec.license       = 'Apache-2.0'
 
-  spec.summary       = %q{Offline reverse geocoder}
-  spec.description   = %q{Offline reverse geocoder. Uses GeoNames database}
-  spec.homepage      = "https://github.com/inaka/offline_geocoder"
-  spec.license       = "Apache-2.0"
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/sildur/offline_geocoder/issues',
+    'homepage_uri' => 'https://github.com/sildur/offline_geocoder',
+    'source_code_uri' => 'https://github.com/sildur/offline_geocoder'
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec/|\.+)}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_runtime_dependency "kdtree", "~> 0.3"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_runtime_dependency 'geokdtree', '~> 0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: offline_geocoder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roberto Romero
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,29 +53,28 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: kdtree
+  name: geokdtree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.2'
 description: Offline reverse geocoder. Uses GeoNames database
 email:
-- roberto@inaka.net
-executables: []
+- roberto.offline_geocoder@nirae.at
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -88,10 +87,13 @@ files:
 - lib/offline_geocoder/version.rb
 - offline_geocoder.gemspec
 - og_cities1000.csv
-homepage: https://github.com/inaka/offline_geocoder
+homepage: https://github.com/sildur/offline_geocoder
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sildur/offline_geocoder/issues
+  homepage_uri: https://github.com/sildur/offline_geocoder
+  source_code_uri: https://github.com/sildur/offline_geocoder
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -107,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Offline reverse geocoder

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/*gem
-
-# Ignore RubyMine files
-/.idea/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.1