gis-distance 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53bfba92587a4e24a8e79783b523961f5649f8e677197160d1788230ff741b4
-  data.tar.gz: 78540a52eeac8d58a13bf99d03bccbbf7277f7aac8db0c9c1913301e4ef9d7ab
+  metadata.gz: afa5f1131b787db92e5e13a3992c471e8381167b926dc942eea37a398a8dc01a
+  data.tar.gz: 60996c27a828f65302c80afc8e15ae3bfc327b7f49a4283fa130a6fd6e476492
 SHA512:
-  metadata.gz: 9b87053488d8079fcd34c5260f6ee01777cff4499af6ab5f88928d98f26977e4195a4584199dfb13f70d986a7bb50934ded14e3dc46fc95c9329e2a8b2ab9340
-  data.tar.gz: 2b1b1e061f1fd25dc19ccf2163216a9fe822462d6d9c40b3e834b269d8817e3b965e5879598638ed9366f735cb48b4104ee2b1d34f6fd324e179322b92a85560
+  metadata.gz: f2ab85690778cb6b8c2a70b28f473b7fbdc5ec088ccdbc97282cfc0a47c0719ad2fd80f294d8b6eff8ff6d34ab38edfa3df54864cc1194ba9a53371c820dddae
+  data.tar.gz: 26dd4b737786902955c447fe6e7537116786be6c57ecada17bbe8151f59ee767230699b767f45242f5fe08320983eb1fa182d3cf3a2d7b27e55d9a2e99f5a9d2

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 1.2.0 - 3-Oct-2024
+* Added support for the vicenty formula, and the rvicenty gem is now a
+  runtime dependency.
+* Dropped Ruby 2.x from the github test matrix. It will still work with
+  older versions of Ruby, however.
+* Some minor updates to the README.md.
+
 ## 1.1.0 - 27-Feb-2021
 * Switched from test-unit to rspec.
 * Added a Gemfile.

data/Gemfile

@@ -1,3 +1,2 @@
-source 'https://rubygems.org' do
-  gemspec
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/djberg96/gis-distance/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/gis-distance/actions/workflows/ruby.yml)
+
 ## Description
 The gis-distance library allows you to calculate geographic distance between
 two points using the formula of your choice.
@@ -5,6 +7,9 @@ two points using the formula of your choice.
 ## Installation
 `gem install gis-distance`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/gis-distance/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
 ```ruby
 require 'gis/distance' # or 'gis-distance'
@@ -15,6 +20,7 @@ gis = GIS::Distance.new(40.47, 73.58, 34.3, 118.15)
 # Set the formula of your choice
 gis.formula = 'cosines'
 gis.formula = 'haversine'
+gis.formula = 'vincenty'
 
 p gis.distance    # Kilometers
 p gis.distance.mi # Miles 
@@ -23,10 +29,17 @@ p gis.distance.mi # Miles
 ## Available Formulas
 * haversine (https://en.wikipedia.org/wiki/Haversine_formula)
 * cosine (https://en.wikipedia.org/wiki/Law_of_cosines)
+* vincenty (https://en.wikipedia.org/wiki/Vincenty%27s_formulae)
 
 ## See Also
 http://en.wikipedia.org/wiki/Earth_radius
 
+## Miscellaneous
+Ruby 2.x was dropped from the test matrix as of version 1.2 because of
+incompatibility with bundler. This library should still work fine with
+older versions of Ruby, but you should strongly consider upgrading at this
+point since Ruby 2.x is now EOL.
+
 ## License
 Artistic-2.0
 

data/Rakefile

@@ -2,14 +2,15 @@ require 'rake'
 require 'rake/clean'
 require 'rbconfig'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-CLEAN.include('**/*.gem', '**/*.log')
+CLEAN.include('**/*.gem', '**/*.log', '**/*.lock')
 
 namespace 'gem' do
   desc 'Create the gis-distance gem'
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('gis-distance.gemspec'))
+    spec = Gem::Specification.load('gis-distance.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -21,7 +22,14 @@ namespace 'gem' do
   end
 end
 
+RuboCop::RakeTask.new
+
 desc "Run the test suite"
 RSpec::Core::RakeTask.new(:spec)
 
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
+end
+
 task :default => :spec

data/gis-distance.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name        = 'gis-distance'
-  spec.version     = '1.1.0'
+  spec.version     = '1.2.0'
   spec.authors     = ['Daniel J. Berger', 'Ardith Falkner']
   spec.license     = 'Artistic-2.0'
   spec.description = 'Calculate the distance between two points on Earth'
@@ -12,16 +12,20 @@ Gem::Specification.new do |spec|
   spec.homepage    = 'http://github.com/djberg96/gis-distance'
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 
+  spec.add_dependency('rvincenty', '~> 0.1.0')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/gis-distance',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/gis-distance/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/gis-distance/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/gis-distance/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/gis-distance',
-    'wiki_uri'          => 'https://github.com/djberg96/gis-distance/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/gis-distance',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/gis-distance/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/gis-distance/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/gis-distance/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/gis-distance',
+    'wiki_uri'              => 'https://github.com/djberg96/gis-distance/wiki',
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.summary = <<-EOF

data/lib/gis/distance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The GIS module serves as a namespace only.
 module GIS
   # The Distance class encapsulates methods related to geographic distance.
@@ -6,7 +8,7 @@ module GIS
     class Error < StandardError; end
 
     # The version of the gis-distance library
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.0'
 
     # Create a new GIS::Distance object using the two sets of coordinates
     # that are provided.
@@ -28,9 +30,7 @@ module GIS
 
     # Returns the radius of the Earth in kilometers. The default is 6367.45.
     #
-    def radius
-      @radius
-    end
+    attr_reader :radius
 
     # Sets the radius of the Earth in kilometers. This is variable because
     # the Earth is not perfectly spherical, and you may wish to adjust it.
@@ -44,9 +44,7 @@ module GIS
     # See http://en.wikipedia.org/wiki/Earth_radius for more information.
     #
     def radius=(kms)
-      if kms < 6357.0 || kms > 6378.0
-        raise Error, "Proposed radius '#{kms}' is out of range"
-      end
+      raise Error, "Proposed radius '#{kms}' is out of range" if kms < 6357.0 || kms > 6378.0
       @radius = kms
     end
 
@@ -54,9 +52,7 @@ module GIS
     # is 'haversine'.
     #--
     # See http://en.wikipedia.org/wiki/Haversine_formula for details.
-    def formula
-      @formula
-    end
+    attr_reader :formula
 
     # Sets the formula to be used internally for calculating the distance.
     # The default is 'haversine'. Your other option is 'cosines' (i.e. the
@@ -66,12 +62,14 @@ module GIS
     #
     def formula=(formula)
       case formula.to_s.downcase
-      when 'haversine'
-        @formula = 'haversine'
-      when 'cosines'
-        @formula = 'cosines'
-      else
-        raise Error, "Formula '#{formula}' not supported"
+        when 'haversine'
+          @formula = 'haversine'
+        when 'cosines'
+          @formula = 'cosines'
+        when 'vincenty'
+          @formula = 'vincenty'
+        else
+          raise Error, "Formula '#{formula}' not supported"
       end
     end
 
@@ -80,12 +78,14 @@ module GIS
     #
     def distance
       @distance =
-      case @formula.to_s.downcase
-      when 'haversine'
-        haversine_formula
-      when 'cosines'
-        law_of_cosines_formula
-      end
+        case @formula.to_s.downcase
+          when 'haversine'
+            haversine_formula
+          when 'cosines'
+            law_of_cosines_formula
+          when 'vincenty'
+            vincenty_formula
+        end
     end
 
     private
@@ -94,19 +94,19 @@ module GIS
     # 90.0 and -90.0 while longitudes must be between 180.0 and -180.0.
     #
     def validate(lat1, lon1, lat2, lon2)
-      [lat1, lat2].each{ |lat|
+      [lat1, lat2].each do |lat|
         if lat > 90 || lat < -90
           msg = "Latitude '#{lat}' is invalid - must be between -90 and 90"
           raise Error, msg
         end
-      }
+      end
 
-      [lon1, lon2].each{ |lon|
+      [lon1, lon2].each do |lon|
         if lon > 180 || lon < -180
           msg = "Longitude '#{lon}' is invalid - must be between -180 and 180"
           raise Error, msg
         end
-      }
+      end
     end
 
     # See https://en.wikipedia.org/wiki/Law_of_cosines
@@ -116,9 +116,9 @@ module GIS
       sin2 = Math.sin(@latitude2 * Math::PI / 180)
       cos1 = Math.cos(@latitude1 * Math::PI / 180)
       cos2 = Math.cos(@latitude2 * Math::PI / 180)
-      cos3 = Math.cos(@longitude2 * Math::PI / 180 - @longitude1 * Math::PI / 180)
+      cos3 = Math.cos((@longitude2 * Math::PI / 180) - (@longitude1 * Math::PI / 180))
 
-      Math.acos(sin1 * sin2 + cos1 * cos2 * cos3) * radius
+      Math.acos((sin1 * sin2) + (cos1 * cos2 * cos3)) * radius
     end
 
     # See http://en.wikipedia.org/wiki/Haversine_formula
@@ -132,15 +132,21 @@ module GIS
       dlat = lat2 - lat1
       dlon = lon2 - lon1
 
-      a = ((Math.sin(dlat/2))**2) + (Math.cos(lat1) * Math.cos(lat2) * (Math.sin(dlon/2)) ** 2)
-      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
+      a = (Math.sin(dlat / 2)**2) + (Math.cos(lat1) * Math.cos(lat2) * (Math.sin(dlon / 2)**2))
+      c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
 
       radius * c
     end
 
+    # See https://en.wikipedia.org/wiki/Vincenty's_formulae
+    def vincenty_formula
+      require 'rvincenty'
+      RVincenty.distance([@latitude1, @longitude1], [@latitude2, @longitude2]) / 1000.0
+    end
+
     # Add a custom method to the base Float class if it isn't already defined.
     class ::Float
-      unless self.respond_to?(:mi)
+      unless respond_to?(:mi)
         # Convert miles to kilometers.
         def mi
           self * 0.621371192

data/lib/gis-distance.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'gis/distance'

data/spec/gis_distance_spec.rb

@@ -1,94 +1,124 @@
+# frozen_string_literal: true
+
 require 'rspec'
 require 'gis/distance'
 
 RSpec.describe GIS::Distance do
-  let(:gis){ GIS::Distance.new(40.47, 73.58, 34.3, 118.15) }
+  let(:gis){ described_class.new(40.47, 73.58, 34.3, 118.15) }
 
-  example "version" do
-    expect(GIS::Distance::VERSION).to eq('1.1.0')
+  example 'version' do
+    expect(GIS::Distance::VERSION).to eq('1.2.0')
     expect(GIS::Distance::VERSION).to be_frozen
   end
 
-  example "distance basic functionality" do
+  example 'distance basic functionality' do
     expect(gis).to respond_to(:distance)
     expect{ gis.distance }.not_to raise_error
-    expect(gis.distance).to be_kind_of(Float)
+    expect(gis.distance).to be_a(Float)
+  end
+
+  context 'haversine' do
+    before do
+      gis.formula = 'haversine'
+    end
+
+    example 'distance method returns expected result' do
+      expect(gis.distance).to be_within(0.01).of(3952.39)
+      expect(described_class.new(40.47, 73.58, 40.47, 73.58).distance).to eq(0.0)
+    end
   end
 
-  example "distance method returns expected result" do
-    expect(gis.distance).to be_within(0.01).of(3952.39)
-    expect(GIS::Distance.new(40.47, 73.58, 40.47, 73.58).distance).to eq(0.0)
+  context 'cosines' do
+    before do
+      gis.formula = 'cosines'
+    end
+
+    example 'distance method returns expected result' do
+      expect(gis.distance).to be_within(0.01).of(3952.39)
+      expect(described_class.new(40.47, 73.58, 40.47, 73.58).distance).to eq(0.0)
+    end
+  end
+
+  context 'vincenty' do
+    before do
+      gis.formula = 'vincenty'
+    end
+
+    example 'distance method returns expected result' do
+      expect(gis.distance).to be_within(0.01).of(3963.40)
+      expect(described_class.new(40.47, 73.58, 40.47, 73.58).distance).to eq(0.0)
+    end
   end
 
-  example "constructor requires four arguments" do
-    expect{ GIS::Distance.new }.to raise_error(ArgumentError)
-    expect{ GIS::Distance.new(40.47) }.to raise_error(ArgumentError)
-    expect{ GIS::Distance.new(40.47, 73.58) }.to raise_error(ArgumentError)
-    expect{ GIS::Distance.new(40.47, 73.58, 34.3) }.to raise_error(ArgumentError)
+  example 'constructor requires four arguments' do
+    expect{ described_class.new }.to raise_error(ArgumentError)
+    expect{ described_class.new(40.47) }.to raise_error(ArgumentError)
+    expect{ described_class.new(40.47, 73.58) }.to raise_error(ArgumentError)
+    expect{ described_class.new(40.47, 73.58, 34.3) }.to raise_error(ArgumentError)
   end
 
-  example "latitude and longitude must be within range" do
-    expect{ GIS::Distance.new(91.0, 100.0, 45.0, 45.0) }.to raise_error(GIS::Distance::Error)
-    expect{ GIS::Distance.new(90.0, 190.0, 45.0, 45.0) }.to raise_error(GIS::Distance::Error)
+  example 'latitude and longitude must be within range' do
+    expect{ described_class.new(91.0, 100.0, 45.0, 45.0) }.to raise_error(GIS::Distance::Error)
+    expect{ described_class.new(90.0, 190.0, 45.0, 45.0) }.to raise_error(GIS::Distance::Error)
   end
 
-  example "radius basic functionality" do
+  example 'radius basic functionality' do
     expect(gis).to respond_to(:radius)
     expect{ gis.radius }.not_to raise_error
-    expect( gis.radius).to be_kind_of(Float)
+    expect(gis.radius).to be_a(Float)
   end
 
-  example "default radius returns expected value" do
+  example 'default radius returns expected value' do
     expect(gis.radius).to eq(6367.45)
   end
 
-  example "radius does not accept an argument" do
+  example 'radius does not accept an argument' do
     expect{ gis.radius(1) }.to raise_error(ArgumentError)
   end
 
-  example "radius setter basic functionality" do
+  example 'radius setter basic functionality' do
     expect(gis).to respond_to(:radius=)
     expect{ gis.radius = 6368.0 }.not_to raise_error
-    expect( gis.radius).to eq(6368.0)
+    expect(gis.radius).to eq(6368.0)
   end
 
-  example "radius value must be within a certain range" do
+  example 'radius value must be within a certain range' do
     expect{ gis.radius = 6200 }.to raise_error(GIS::Distance::Error)
     expect{ gis.radius = 6400 }.to raise_error(GIS::Distance::Error)
   end
 
-  example "formula basic functionality" do
+  example 'formula basic functionality' do
     expect(gis).to respond_to(:formula)
     expect{ gis.formula }.not_to raise_error
-    expect(gis.formula).to be_kind_of(String)
+    expect(gis.formula).to be_a(String)
   end
 
-  example "formula default value" do
+  example 'formula default value' do
     expect(gis.formula).to eq('haversine')
   end
 
-  example "formula setter basic functionality" do
+  example 'formula setter basic functionality' do
     expect(gis).to respond_to(:formula=)
     expect{ gis.formula = 'haversine' }.not_to raise_error
   end
 
-  example "formula setter validates value" do
+  example 'formula setter validates value' do
     expect{ gis.formula(1) }.to raise_error(ArgumentError)
     expect{ gis.formula = 'foo' }.to raise_error(GIS::Distance::Error)
   end
 
-  example "mi basic functionality" do
+  example 'mi basic functionality' do
     expect(gis.distance).to respond_to(:mi)
     expect{ gis.distance.mi }.not_to raise_error
-    expect(gis.distance.mi).to be_kind_of(Float)
+    expect(gis.distance.mi).to be_a(Float)
   end
 
-  example "mi behaves as expected" do
+  example 'mi behaves as expected' do
     expect(gis.distance).to be > gis.distance.mi
     expect(gis.distance.mi).to be_within(0.1).of(2455.9)
   end
 
-  example "mi_expected_errors" do
+  example 'mi_expected_errors' do
     expect{ gis.distance.mi(1) }.to raise_error(ArgumentError)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gis-distance
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -36,8 +36,22 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rvincenty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: Calculate the distance between two points on Earth
 email: djberg96@gmail.com
 executables: []
@@ -88,10 +130,11 @@ licenses:
 metadata:
   homepage_uri: https://github.com/djberg96/gis-distance
   bug_tracker_uri: https://github.com/djberg96/gis-distance/issues
-  changelog_uri: https://github.com/djberg96/gis-distance/blob/master/CHANGES
+  changelog_uri: https://github.com/djberg96/gis-distance/blob/main/CHANGES.md
   documentation_uri: https://github.com/djberg96/gis-distance/wiki
   source_code_uri: https://github.com/djberg96/gis-distance
   wiki_uri: https://github.com/djberg96/gis-distance/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -107,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: The gis-distance library provides a simple interface for calculating the