gis-distance 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: de0d6744ec7592d14cdb3398067abd15588b55d0
-  data.tar.gz: eb2841a2bc5a5929ad11e2f80fdecdaae76790f3
+SHA256:
+  metadata.gz: 3ada8cb52ba2e522d5315e73c94a72b9c766b53bd24e37d72448ffdaed26abdc
+  data.tar.gz: 1cd738a5fed67d46ffe50358d3a72db781fe2d5f17e73e0cece9b6244d7f0127
 SHA512:
-  metadata.gz: ea6d9b7e977287c7eed702bb268201fab900b676289ed74c1e6a79a46ada9b5a3a867c7fab1050c2c6321e37b23ec224a9910ea3440bf43d763650fa754b3b3e
-  data.tar.gz: 75fb7849d35c167dc14563a9c711abf6a734491da8ce4f74687c1c721c91609bbaf04b68ed21f15149d8ebea9fe2628bd09f55e9b9f2d221f78550b7af53924a
+  metadata.gz: 7b34a028b93f9d24d25c5d6bfb3a154e2948ad4f9e2862c485abfb5fb62ba490e342f8d830735c198ee0fc211519e882bea031ea2c000c7a933eae1d89dca8ef
+  data.tar.gz: d49169c3d2f9e433a17d082259ffa5cabe52ed4f63a8d92be13ce29f3906148d55f3cfc02c8646a645f98fb012f14ea7967db9c0c4890110e8ea8c46fce940b3

data/CHANGES

@@ -1,3 +1,11 @@
+== 1.0.2 - 22-Mar-2018
+* Added 'cosines' as a supported formula. This will use the Law of cosines
+  to calculate the distance.
+* Added metadata to the gemspec.
+* Added a cert.
+* Rakefile now assumes Rubygems 2.x, and other minor updates.
+* Added a gis-distance.rb file for convenience.
+
 == 1.0.1 - 26-Oct-2014
 * Updated gemspec, Rakefile.
 

data/MANIFEST

@@ -3,5 +3,6 @@
 * README
 * Rakefile
 * gis-distance.gemspec
+* lib/gis-distance.rb
 * lib/gis/distance.rb
 * test/test_gis_distance.rb

data/README

@@ -6,11 +6,15 @@ two points using the formula of your choice.
 gem install gis-distance
 
 == Synopsis
-require 'gis/distance'
+require 'gis/distance' # or 'gis-distance'
 
 # New York to Los Angeles
 gis = GIS::Distance.new(40.47, 73.58, 34.3, 118.15)
 
+# Set the formula of your choice
+gis.formula = 'cosines'
+gis.formula = 'haversine'
+
 p gis.distance    # Kilometers
 p gis.distance.mi # Miles 
 

data/Rakefile

@@ -9,14 +9,10 @@ CLEAN.include('**/*.gem', '**/*.log')
 namespace 'gem' do
   desc 'Create the gis-distance gem'
   task :create => [:clean] do
+    require 'rubygems/package'
     spec = eval(IO.read('gis-distance.gemspec'))
-
-    if Gem::VERSION < "2.0"
-      Gem::Builder.new(spec).build
-    else
-      require 'rubygems/package'
-      Gem::Package.build(spec)
-    end
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec, true)
   end
 
   desc 'Install the gis-distance gem'

data/certs/djberg96_pub.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+-----END CERTIFICATE-----

data/gis-distance.gemspec

@@ -1,19 +1,29 @@
 require 'rubygems'
 
-Gem::Specification.new do |gem|
-  gem.name        = 'gis-distance'
-  gem.version     = '1.0.1' 
-  gem.authors     = ['Daniel J. Berger', 'Ardith Falkner']
-  gem.license     = 'Artistic 2.0'
-  gem.description = 'Calculate the distance between 2 points on Earth'
-  gem.email       = 'djberg96@gmail.com'
-  gem.files       = Dir['**/*'].reject{ |f| f.include?('git') }
-  gem.test_files  = ['test/test_gis_distance.rb']
-  gem.homepage    = 'http://github.com/djberg96/gis-distance'
+Gem::Specification.new do |spec|
+  spec.name        = 'gis-distance'
+  spec.version     = '1.0.2'
+  spec.authors     = ['Daniel J. Berger', 'Ardith Falkner']
+  spec.license     = 'Artistic 2.0'
+  spec.description = 'Calculate the distance between two points on Earth'
+  spec.email       = 'djberg96@gmail.com'
+  spec.files       = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.test_files  = ['test/test_gis_distance.rb']
+  spec.homepage    = 'http://github.com/djberg96/gis-distance'
+  spec.cert_chain  = ['certs/djberg96_pub.pem']
 
-  gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
 
-  gem.summary = <<-EOF
+  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'
+  }
+
+  spec.summary = <<-EOF
     The gis-distance library provides a simple interface for
     calculating the distance between two points on Earth using
     latitude and longitude.

data/lib/gis-distance.rb

@@ -0,0 +1 @@
+require_relative 'gis/distance'

data/lib/gis/distance.rb

@@ -1,135 +1,151 @@
 # The GIS module serves as a namespace only.
 module GIS
-   # The Distance class encapsulates methods related to geographic distance.
-   class Distance
-      # Error raised if latitude or longitude values are invalid.
-      class Error < StandardError; end
-
-      # The version of the gis-distance library
-      VERSION = '1.0.1'
-
-      # Create a new GIS::Distance object using the two sets of coordinates
-      # that are provided.
-      #
-      # If invalid coordinates are provided a GIS::Distance::Error is raised.
-      #
-      def initialize(latitude1, longitude1, latitude2, longitude2)
-         validate(latitude1, longitude1, latitude2, longitude2)
-
-         @latitude1  = latitude1
-         @longitude1 = longitude1
-         @latitude2  = latitude2
-         @longitude2 = longitude2
-
-         @radius   = 6367.45
-         @formula  = 'haversine'
-         @distance = nil
+  # The Distance class encapsulates methods related to geographic distance.
+  class Distance
+    # Error raised if latitude or longitude values are invalid.
+    class Error < StandardError; end
+
+    # The version of the gis-distance library
+    VERSION = '1.0.2'.freeze
+
+    # Create a new GIS::Distance object using the two sets of coordinates
+    # that are provided.
+    #
+    # If invalid coordinates are provided a GIS::Distance::Error is raised.
+    #
+    def initialize(latitude1, longitude1, latitude2, longitude2)
+      validate(latitude1, longitude1, latitude2, longitude2)
+
+      @latitude1  = latitude1
+      @longitude1 = longitude1
+      @latitude2  = latitude2
+      @longitude2 = longitude2
+
+      @radius   = 6367.45
+      @formula  = 'haversine'
+      @distance = nil
+    end
+
+    # Returns the radius of the Earth in kilometers. The default is 6367.45.
+    #
+    def radius
+      @radius
+    end
+
+    # 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.
+    #
+    # However, the possible range of values is limited from 6357.0 to 6378.0.
+    # If a value outside of this range is provided a GIS::Distance::Error
+    # is raised.
+    #
+    # The default value is 6367.45.
+    #
+    # 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
-
-      # Returns the radius of the Earth in kilometers. The default is 6367.45.
-      #
-      def radius
-         @radius
+      @radius = kms
+    end
+
+    # Returns the formula used to calculate the distance. The default formula
+    # is 'haversine'.
+    #--
+    # See http://en.wikipedia.org/wiki/Haversine_formula for details.
+    def formula
+      @formula
+    end
+
+    # Sets the formula to be used internally for calculating the distance.
+    # The default is 'haversine'. Your other option is 'cosines' (i.e. the
+    # Law of Cosines).
+    #
+    # If an unsupported formula is provided a GIS::Distance::Error is raised.
+    #
+    def formula=(formula)
+      case formula.to_s.downcase
+      when 'haversine'
+        @formula = 'haversine'
+      when 'cosines'
+        @formula = 'cosines'
+      else
+        raise Error, "Formula '#{formula}' not supported"
       end
-
-      # 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.
-      #
-      # However, the possible range of values is limited from 6357.0 to 6378.0.
-      # If a value outside of this range is provided a GIS::Distance::Error
-      # is raised.
-      #
-      # The default value is 6367.45.
-      #
-      # 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
-         @radius = kms
+    end
+
+    # Returns the distance (in kilometers) between the two coordinates
+    # provided in the constructor.
+    #
+    def distance
+      @distance =
+      case @formula.to_s.downcase
+      when 'haversine'
+        haversine_formula
+      when 'cosines'
+        law_of_cosines_formula
       end
-
-      # Returns the formula used to calculate the distance. The default formula
-      # is 'haversine'.
-      #--
-      # See http://en.wikipedia.org/wiki/Haversine_formula for details.
-      def formula
-         @formula
-      end
-
-      # Sets the formula to be used internally for calculating the distance.
-      # The default is 'haversine'.
-      #
-      # If an unsupported formula is provided a GIS::Distance::Error is raised.
-      #
-      def formula=(formula)
-         case formula.to_s.downcase
-            when 'haversine'
-               @formula = 'haversine'
-         else
-            raise Error, "Formula '#{formula}' not supported"
-         end
-      end
-
-      # Returns the distance (in kilometers) between the two coordinates
-      # provided in the constructor.
-      #
-      def distance
-         @distance =
-         case @formula.to_s.downcase
-            when 'haversine'
-               haversine_formula
-         end
-      end
-
-      private
-
-      # Validate the latitude and longitude values. Latitudes must be between
-      # 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|
-            if lat > 90 || lat < -90
-               msg = "Latitude '#{lat}' is invalid - must be between -90 and 90"
-               raise Error, msg
-            end
-         }
-
-         [lon1, lon2].each{ |lon|
-            if lon > 180 || lon < -180
-               msg = "Longitude '#{lon}' is invalid - must be between -180 and 180"
-               raise Error, msg
-            end
-         }
+    end
+
+    private
+
+    # Validate the latitude and longitude values. Latitudes must be between
+    # 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|
+        if lat > 90 || lat < -90
+          msg = "Latitude '#{lat}' is invalid - must be between -90 and 90"
+          raise Error, msg
+        end
+      }
+
+      [lon1, lon2].each{ |lon|
+        if lon > 180 || lon < -180
+          msg = "Longitude '#{lon}' is invalid - must be between -180 and 180"
+          raise Error, msg
+        end
+      }
+    end
+
+    # See https://en.wikipedia.org/wiki/Law_of_cosines
+    #
+    def law_of_cosines_formula
+      sin1 = Math.sin(@latitude1 * Math::PI / 180)
+      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)
+
+      Math.acos(sin1 * sin2 + cos1 * cos2 * cos3) * radius
+    end
+
+    # See http://en.wikipedia.org/wiki/Haversine_formula
+    #
+    def haversine_formula
+      lat1 = @latitude1  * Math::PI / 180
+      lon1 = @longitude1 * Math::PI / 180
+      lat2 = @latitude2  * Math::PI / 180
+      lon2 = @longitude2 * Math::PI / 180
+
+      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))
+
+      radius * c
+    end
+
+    # Add a custom method to the base Float class if it isn't already defined.
+    class ::Float
+      unless self.respond_to?(:mi)
+        # Convert miles to kilometers.
+        def mi
+          self * 0.621371192
+        end
       end
-
-      # See http://en.wikipedia.org/wiki/Haversine_formula
-      #
-      def haversine_formula
-         lat1 = @latitude1  * Math::PI / 180
-         lon1 = @longitude1 * Math::PI / 180
-         lat2 = @latitude2  * Math::PI / 180
-         lon2 = @longitude2 * Math::PI / 180
-
-         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))
-
-         @radius * c
-      end
-
-      # Add a custom method to the base Float class if it isn't already defined.
-      class ::Float
-         unless self.respond_to?(:mi)
-            # Convert miles to kilometers.
-            def mi
-               self * 0.621371192
-            end
-         end
-      end
-   end
+    end
+  end
 end
-

data/test/test_gis_distance.rb

@@ -7,7 +7,8 @@ class TC_GIS_Distance < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.0.1', GIS::Distance::VERSION)
+    assert_equal('1.0.2', GIS::Distance::VERSION)
+    assert_true(GIS::Distance::VERSION.frozen?)
   end
 
   def test_distance_basic_functionality

metadata

@@ -1,17 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: gis-distance
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Daniel J. Berger
 - Ardith Falkner
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies: []
-description: Calculate the distance between 2 points on Earth
+description: Calculate the distance between two points on Earth
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -20,17 +47,29 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files:
+- certs
+- certs/djberg96_pub.pem
 - CHANGES
-- MANIFEST
-- README
-- Rakefile
 - gis-distance.gemspec
+- lib
+- lib/gis
 - lib/gis/distance.rb
+- lib/gis-distance.rb
+- MANIFEST
+- Rakefile
+- README
+- test
 - test/test_gis_distance.rb
 homepage: http://github.com/djberg96/gis-distance
 licenses:
 - Artistic 2.0
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -47,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The gis-distance library provides a simple interface for calculating the