jpm_geo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48e481ee36d23cda6002fc637fc95fa227e89822820d1d9543b9bf041e957aff
+  data.tar.gz: 4ac9d50173f85299038d212e2640c6ac801b3ea92416bbf11cd2d5f299669c57
+SHA512:
+  metadata.gz: b4905cf4ada72268e65e033292b2aeeac2663e2ce505c0ae914d6b08c4791ea0e4a7dbb735eebccec301c974a921061a89cfa922fbabd5bf1bdb03561b80cbc6
+  data.tar.gz: 8619c23099c03caf3e690a6932ec085ab6688b5f7f4b0884294e70383de57f0d5c655b74561074623b629301651ce4490fa9c3955ebabb9e8ecf62d817fb2dd9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/LineLength:
+  Max: 120
+  IgnoredPatterns: ['^\s*#']
+  Exclude:
+    - "config/initializers/*.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# compatibility with rufo
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.1
+
+Changed gem name to jpm_geo
+
+# 0.1.0
+
+Initial release as a standalone gem.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sobakasu@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jpm_geo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    jpm_geo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  jpm_geo!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew Williams
+
+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,73 @@
+# JpmGeo
+
+Computes the bounding coordinates of all points on the surface of a sphere that have a great circle distance to the given point. This code was ported to ruby directly from http://janmatuschek.de/LatitudeLongitudeBoundingCoordinates, and is owned by Jan Philip Matuschek.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jpm_geo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jpm_geo
+
+## Usage
+
+### Configuration
+
+```
+# use miles as a distance unit (default is kilometers)
+JpmGeo.units = 'm'
+
+# specify default radius (default is Earth kilometers)
+JpmGeo.radius = 3389.5 # Mars radius (km)
+```
+
+### Creating points
+```
+# lonlat is an object that responds to 'lon' and 'lat' methods
+point = JpmGeo::Point.from_lonlat(lonlat) 
+
+# from degrees
+point = JpmGeo::Point.from_degrees(lat: 51.50853, lon: -0.12574) # London
+
+# from radians
+point = JpmGeo::Point.from_radians(lat: 0.8990, lon: -0.0022) # London (ish)
+
+# converting to/from radians/degrees
+point = point.to_radians
+point = point.to_degrees
+```
+
+### Finding distance between points
+
+```
+# distance is in the same units as radius
+distance = point.distance_to(point2)
+```
+
+### Finding bounding coordinates
+
+```
+bounds = point.bounds(100) # km
+p [bounds[0].lat, bounds[0].lon, bounds[1].lat, bounds[1].lon]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sobakasu/jpm_geo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JpmGeo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sobakasu/jpm_geo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jpm_geo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jpm_geo.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jpm_geo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpm_geo"
+  spec.version       = JpmGeo::VERSION
+  spec.authors       = ["Andrew Williams"]
+  spec.email         = ["sobakasu@gmail.com"]
+
+  spec.summary       = "Finds points within a distance of a latitude/longitude point using bounding coordinates"
+  spec.homepage      = "https://github.com/sobakasu/jpm_geo"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sobakasu/jpm_geo"
+  spec.metadata["changelog_uri"] = "https://github.com/sobakasu/jpm_geo/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jpm_geo.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Finds points within a distance of a latitude/longitude point using bounding coordinates.
+# http://janmatuschek.de/LatitudeLongitudeBoundingCoordinates
+module JpmGeo
+  class Error < StandardError; end
+
+  EARTH_RADIUS_KM = 6371.01
+  EARTH_RADIUS_M = 3963.19
+
+  class << self
+    attr_writer :radius
+
+    def radius
+      @radius || EARTH_RADIUS_KM
+    end
+
+    def units=(units)
+      raise ArgumentError, "invalid units" unless units && %w[km m].include?(units.to_s)
+
+      @units = units
+      @radius = units == "km" ? EARTH_RADIUS_KM : EARTH_RADIUS_M
+    end
+  end
+end
+
+require "jpm_geo/version"
+require "jpm_geo/point"
+require "jpm_geo/bounds"

data/lib/jpm_geo/bounds.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module JpmGeo
+  # Bounds is a bounding box defined by two Points.
+  # If the bounding box crosses the 180th meridian, there will be two sets of bounding boxes
+  # defined by four Points.
+  class Bounds
+    attr_reader :points, :radians
+
+    def [](index)
+      to_a[index]
+    end
+
+    def to_a
+      points
+    end
+
+    def size
+      points.size
+    end
+
+    def to_radians
+      return self if radians
+
+      Bounds.from_points(*points.collect(&:to_radians))
+    end
+
+    def to_degrees
+      return self unless radians
+
+      Bounds.from_points(*points.collect(&:to_degrees))
+    end
+
+    def to_s
+      "JpmGeo::Bounds[#{points}]"
+    end
+
+    class << self
+      def from_points(*points)
+        new(*points)
+      end
+    end
+
+    private
+
+    def initialize(*points)
+      @points = points
+      @radians = points[0].radians
+    end
+  end
+end

data/lib/jpm_geo/point.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module JpmGeo
+  # Point represents a latitude, longitude location
+  class Point
+    PI = Math::PI
+    PI_2 = 2 * PI
+    DEG_TO_RAD = PI / 180.0
+    RAD_TO_DEG = 180.0 / PI
+    MIN_LAT = -PI / 2
+    MAX_LAT = PI / 2
+    MIN_LON = -PI
+    MAX_LON = PI
+
+    attr_accessor :lat, :lon
+    attr_reader :radius, :radians
+
+    class << self
+      def from_lonlat(lonlat, radius: JpmGeo.radius)
+        from_degrees(lon: lonlat.lon, lat: lonlat.lat, radius: radius)
+      end
+
+      def from_degrees(lon:, lat:, radius: JpmGeo.radius)
+        new(lon: lon, lat: lat, radius: radius, radians: false)
+      end
+
+      def from_radians(lon:, lat:, radius: JpmGeo.radius, validate: true)
+        new(lon: lon, lat: lat, radius: radius, radians: true, validate: validate)
+      end
+
+      def to_rad(degrees)
+        degrees * DEG_TO_RAD
+      end
+
+      def to_deg(radians)
+        radians * RAD_TO_DEG
+      end
+    end
+
+    def to_radians
+      return self if radians
+
+      Point.from_radians(lon: Point.to_rad(lon), lat: Point.to_rad(lat), radius: radius)
+    end
+
+    def to_degrees
+      return self unless radians
+
+      Point.from_degrees(lon: Point.to_deg(lon), lat: Point.to_deg(lat), radius: radius)
+    end
+
+    def valid?
+      point = to_radians
+      point.lat >= MIN_LAT && point.lat <= MAX_LAT && point.lon >= MIN_LON && point.lon <= MAX_LON
+    end
+
+    def distance_to(point)
+      raise ArgumentError, "JpmGeo::Point expected" unless point.is_a?(JpmGeo::Point)
+
+      radians_distance_to(to_radians, point.to_radians)
+    end
+
+    # computes bounding coordinates all points that are within the great
+    # circle of the given distance from this Point.
+    # distance is in the same units as the radius argument.
+    def bounding_coordinates(distance)
+      raise ArgumentError, "invalid distance" if distance <= 0
+
+      # angular distance in radians on a great circle
+      raddist = distance / radius
+
+      point = to_radians
+      min = latlon(point.lat - raddist, 0)
+      max = latlon(point.lat + raddist, 0)
+
+      if min.lat > MIN_LAT && max.lat < MAX_LAT
+        deltalon = Math.asin(Math.sin(raddist) / Math.cos(point.lat))
+        min.lon = point.lon - deltalon
+        max.lon = point.lon + deltalon
+      else
+        # a pole is within the distance
+        min.lat = [min.lat, MIN_LAT].max
+        max.lat = [max.lat, MAX_LAT].min
+        min.lon = MIN_LON
+        max.lon = MAX_LON
+      end
+
+      bounds = bounds_from_min_max(min, max)
+      radians ? bounds : bounds.to_degrees
+    end
+
+    def to_s
+      units = radians ? " rad" : "°"
+      "JpmGeo::Point(#{lat}#{units}, #{lon}#{units})"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(JpmGeo::Point)
+
+      point = radians ? other.to_radians : other.to_degrees
+      point.lon == lon && point.lat == lat && point.radius == radius
+    end
+
+    private
+
+    def radians_distance_to(point1, point2)
+      Math.acos(Math.sin(point1.lat) * Math.sin(point2.lat) +
+                Math.cos(point1.lat) * Math.cos(point2.lat) *
+                Math.cos(point1.lon - point2.lon)) * radius
+    end
+
+    def bounds_from_min_max(min, max)
+      # http://janmatuschek.de/LatitudeLongitudeBoundingCoordinates#PolesAnd180thMeridian
+      # when the 180th meridian is with the query circle, return two sets of bounding coordinates.
+      if min.lon < MIN_LON
+        # (latmin, lonmin + 2PI), (latmax, PI) and (latmin, -PI), (latmax, lonmax)
+        Bounds.from_points(latlon(min.lat, min.lon + PI_2), latlon(max.lat, PI),
+                           latlon(min.lat, -PI), latlon(max.lat, max.lon))
+      elsif max.lon > MAX_LON
+        # (latmin, lonmin), (latmax, PI) and (latmin, -PI), (latmax, lonmax - 2PI).
+        Bounds.from_points(latlon(min.lat, min.lon), latlon(max.lat, PI),
+                           latlon(min.lat, -PI), latlon(max.lat, max.lon - PI_2))
+      else
+        # does not cross 180th meridian
+        Bounds.from_points(min, max)
+      end
+    end
+
+    def latlon(lat, lon)
+      Point.from_radians(lat: lat, lon: lon, radius: radius, validate: false)
+    end
+
+    def initialize(lon:, lat:, radians: false, radius: JpmGeo.radius, validate: true)
+      raise ArgumentError, "invalid radius" if radius <= 0
+
+      @lon = lon
+      @lat = lat
+      @radius = radius
+      @radians = radians
+      raise ArgumentError, "invalid coordinates" if validate && !valid?
+    end
+  end
+end

data/lib/jpm_geo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JpmGeo
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: jpm_geo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew Williams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- sobakasu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jpm_geo.gemspec
+- lib/jpm_geo.rb
+- lib/jpm_geo/bounds.rb
+- lib/jpm_geo/point.rb
+- lib/jpm_geo/version.rb
+homepage: https://github.com/sobakasu/jpm_geo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sobakasu/jpm_geo
+  source_code_uri: https://github.com/sobakasu/jpm_geo
+  changelog_uri: https://github.com/sobakasu/jpm_geo/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Finds points within a distance of a latitude/longitude point using bounding
+  coordinates
+test_files: []