geoprojection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b21a5ce188fe4283f22a8ffeae14392942981c101d010f5ae9e9d0f0a67d410e
+  data.tar.gz: 76ac0d07a358785a9505cbcfe4830181b6fe4d7a3b3d923ccf512b13ea906dae
+SHA512:
+  metadata.gz: 9979de234b5ac3661a96561a5e9b836b11351e82d60dd1aece15726a06a1235537324f9baaca026412d7c03712bae235b0ff50951bb0565897e45b717d55f6e1
+  data.tar.gz: 3f572c2025e219ceddb69f6b41e5a87ea84b71ed1ea8a23b3f7c4ab5848a812338af1ee2a34bf3e4b89402bbc3541a6db4461da28002d570bb1b6a44a4e3aea4

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.9

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geoprojection.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'devpack', '~> 0.4.0'
+gem 'gnuplot', '~> 2.6'
+gem 'rspec', '~> 3.0'
+gem 'rspec-its', '~> 1.3'
+gem 'rubocop', '~> 1.28'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.10'
+gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    geoprojection (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    devpack (0.4.0)
+    diff-lcs (1.5.0)
+    gnuplot (2.6.2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    paint (2.2.1)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
+      paint (~> 2.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devpack (~> 0.4.0)
+  geoprojection!
+  gnuplot (~> 2.6)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.3)
+  rubocop (~> 1.28)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.10)
+  strong_versions (~> 0.4.5)
+
+BUNDLED WITH
+   2.3.11

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,32 @@
+# Geoprojection
+
+Toolkit for translating distances (kilometers) from co-ordinates (latitude, longitude) onto geographically-precise (within reason) projections.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add geoprojection
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install geoprojection
+
+## Usage
+
+### Ellipse
+
+Provide a center point (latitude, longitude) and a distance (kilometers) to calculate a projected ellipse at the given coordinates. An array of `[latitude, longitude]` polygon points is provided.
+
+The default number of points is `36`. This can be overridden with the `points` parameter to `Geoprojection::Ellipse.new`.
+
+```ruby
+ellipse = Geoprojection::Ellipse.new(latitude: 50.8169, longitude: 0.1367, distance: 10, points: 36)
+ellipse.points
+```
+
+The actual returned points will be N+1, as the start and end point are identical to provide a complete polygon.
+
+## Contributing
+
+Make changes, run `make test`, create a pull request.

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/lib/geoprojection/ellipse.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Geoprojection
+  # Elliptical projection of a center point (lat, long) with a provided distance from the center.
+  class Ellipse
+    EQUATOR_KM_PER_LATITUDE_DEGREE = 110.567
+    EQUATOR_KM_PER_LONGITUDE_DEGREE = 111.321
+    DEGREES_PER_RADIAN = Math::PI / 180
+
+    def initialize(latitude:, longitude:, distance:, points: 36)
+      @latitude = latitude
+      @longitude = longitude
+      @distance = distance
+      @points = points
+    end
+
+    def points
+      # Create a complete polygon by joining the last and first points.
+      projected_points + [projected_points.first]
+    end
+
+    private
+
+    def projected_points
+      @projected_points ||= @points.times.map do |index|
+        theta = step * index
+        [derived_x(theta), derived_y(theta)]
+      end
+    end
+
+    def derived_x(theta)
+      @longitude + (DEGREES_PER_RADIAN * @distance * longitude_distortion * Math.cos(DEGREES_PER_RADIAN * theta))
+    end
+
+    def derived_y(theta)
+      @latitude + (DEGREES_PER_RADIAN * @distance * latitude_distortion * Math.sin(DEGREES_PER_RADIAN * theta))
+    end
+
+    def step
+      @step ||= 360.0 / @points
+    end
+
+    def longitude_distortion
+      @longitude_distortion ||= 1 / (EQUATOR_KM_PER_LONGITUDE_DEGREE * Math.cos(DEGREES_PER_RADIAN * @latitude))
+    end
+
+    def latitude_distortion
+      @latitude_distortion ||= 1 / (EQUATOR_KM_PER_LATITUDE_DEGREE / @latitude)
+    end
+  end
+end

data/lib/geoprojection/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Geoprojection
+  VERSION = '0.1.0'
+end

data/lib/geoprojection.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'geoprojection/version'
+require_relative 'geoprojection/ellipse'
+
+module Geoprojection
+  class Error < StandardError; end
+end

data/sig/geoprojection.rbs

@@ -0,0 +1,4 @@
+module Geoprojection
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: geoprojection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-11 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- Rakefile
+- lib/geoprojection.rb
+- lib/geoprojection/ellipse.rb
+- lib/geoprojection/version.rb
+- sig/geoprojection.rbs
+homepage: https://github.com/bobf/geoprojection
+licenses: []
+metadata:
+  homepage_uri: https://github.com/bobf/geoprojection
+  source_code_uri: https://github.com/bobf/geoprojection
+  changelog_uri: https://github.com/bobf/geoprojection
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []