gis-distance 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ada8cb52ba2e522d5315e73c94a72b9c766b53bd24e37d72448ffdaed26abdc
-  data.tar.gz: 1cd738a5fed67d46ffe50358d3a72db781fe2d5f17e73e0cece9b6244d7f0127
+  metadata.gz: d53bfba92587a4e24a8e79783b523961f5649f8e677197160d1788230ff741b4
+  data.tar.gz: 78540a52eeac8d58a13bf99d03bccbbf7277f7aac8db0c9c1913301e4ef9d7ab
 SHA512:
-  metadata.gz: 7b34a028b93f9d24d25c5d6bfb3a154e2948ad4f9e2862c485abfb5fb62ba490e342f8d830735c198ee0fc211519e882bea031ea2c000c7a933eae1d89dca8ef
-  data.tar.gz: d49169c3d2f9e433a17d082259ffa5cabe52ed4f63a8d92be13ce29f3906148d55f3cfc02c8646a645f98fb012f14ea7967db9c0c4890110e8ea8c46fce940b3
+  metadata.gz: 9b87053488d8079fcd34c5260f6ee01777cff4499af6ab5f88928d98f26977e4195a4584199dfb13f70d986a7bb50934ded14e3dc46fc95c9329e2a8b2ab9340
+  data.tar.gz: 2b1b1e061f1fd25dc19ccf2163216a9fe822462d6d9c40b3e834b269d8817e3b965e5879598638ed9366f735cb48b4104ee2b1d34f6fd324e179322b92a85560

data/{CHANGES → CHANGES.md}

@@ -1,4 +1,8 @@
-== 1.0.2 - 22-Mar-2018
+## 1.1.0 - 27-Feb-2021
+* Switched from test-unit to rspec.
+* Added a Gemfile.
+
+## 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.
@@ -6,8 +10,8 @@
 * Rakefile now assumes Rubygems 2.x, and other minor updates.
 * Added a gis-distance.rb file for convenience.
 
-== 1.0.1 - 26-Oct-2014
+## 1.0.1 - 26-Oct-2014
 * Updated gemspec, Rakefile.
 
-== 1.0.0 - 10-Oct-2009
+## 1.0.0 - 10-Oct-2009
 * Initial release

data/Gemfile

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

data/{MANIFEST → MANIFEST.md}

@@ -1,6 +1,7 @@
-* CHANGES
-* MANIFEST
-* README
+* CHANGES.md
+* MANIFEST.md
+* README.md
+* Gemfile
 * Rakefile
 * gis-distance.gemspec
 * lib/gis-distance.rb

data/{README → README.md}

@@ -1,11 +1,12 @@
-== Description
+## Description
 The gis-distance library allows you to calculate geographic distance between
 two points using the formula of your choice.
 
-== Installation
-gem install gis-distance
+## Installation
+`gem install gis-distance`
 
-== Synopsis
+## Synopsis
+```ruby
 require 'gis/distance' # or 'gis-distance'
 
 # New York to Los Angeles
@@ -17,10 +18,18 @@ gis.formula = 'haversine'
 
 p gis.distance    # Kilometers
 p gis.distance.mi # Miles 
+```
 
-== License
-Artistic 2.0
+## Available Formulas
+* haversine (https://en.wikipedia.org/wiki/Haversine_formula)
+* cosine (https://en.wikipedia.org/wiki/Law_of_cosines)
 
-== Authors
+## See Also
+http://en.wikipedia.org/wiki/Earth_radius
+
+## License
+Artistic-2.0
+
+## Authors
 * Daniel Berger
 * Ardith Falkner

data/Rakefile

@@ -1,8 +1,7 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
 require 'rbconfig'
-include RbConfig
+require 'rspec/core/rake_task'
 
 CLEAN.include('**/*.gem', '**/*.log')
 
@@ -12,7 +11,7 @@ namespace 'gem' do
     require 'rubygems/package'
     spec = eval(IO.read('gis-distance.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc 'Install the gis-distance gem'
@@ -22,9 +21,7 @@ namespace 'gem' do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.warning = true
-  t.verbose = true
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/gis-distance.gemspec

@@ -2,17 +2,18 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name        = 'gis-distance'
-  spec.version     = '1.0.2'
+  spec.version     = '1.1.0'
   spec.authors     = ['Daniel J. Berger', 'Ardith Falkner']
-  spec.license     = 'Artistic 2.0'
+  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.test_files  = Dir['spec/*_spec.rb']
   spec.homepage    = 'http://github.com/djberg96/gis-distance'
   spec.cert_chain  = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/gis-distance',

data/lib/gis/distance.rb

@@ -6,7 +6,7 @@ module GIS
     class Error < StandardError; end
 
     # The version of the gis-distance library
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.1.0'.freeze
 
     # Create a new GIS::Distance object using the two sets of coordinates
     # that are provided.

data/spec/gis_distance_spec.rb

@@ -0,0 +1,94 @@
+require 'rspec'
+require 'gis/distance'
+
+RSpec.describe GIS::Distance do
+  let(:gis){ GIS::Distance.new(40.47, 73.58, 34.3, 118.15) }
+
+  example "version" do
+    expect(GIS::Distance::VERSION).to eq('1.1.0')
+    expect(GIS::Distance::VERSION).to be_frozen
+  end
+
+  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)
+  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)
+  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)
+  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)
+  end
+
+  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)
+  end
+
+  example "default radius returns expected value" do
+    expect(gis.radius).to eq(6367.45)
+  end
+
+  example "radius does not accept an argument" do
+    expect{ gis.radius(1) }.to raise_error(ArgumentError)
+  end
+
+  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)
+  end
+
+  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
+    expect(gis).to respond_to(:formula)
+    expect{ gis.formula }.not_to raise_error
+    expect(gis.formula).to be_kind_of(String)
+  end
+
+  example "formula default value" do
+    expect(gis.formula).to eq('haversine')
+  end
+
+  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
+    expect{ gis.formula(1) }.to raise_error(ArgumentError)
+    expect{ gis.formula = 'foo' }.to raise_error(GIS::Distance::Error)
+  end
+
+  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)
+  end
+
+  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
+    expect{ gis.distance.mi(1) }.to raise_error(ArgumentError)
+  end
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: gis-distance
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel J. Berger
 - Ardith Falkner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -36,33 +36,55 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2018-03-22 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 description: Calculate the distance between two points on Earth
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- certs
+- CHANGES.md
+- Gemfile
+- MANIFEST.md
+- README.md
+- Rakefile
 - certs/djberg96_pub.pem
-- CHANGES
 - gis-distance.gemspec
-- lib
-- lib/gis
-- lib/gis/distance.rb
 - lib/gis-distance.rb
-- MANIFEST
-- Rakefile
-- README
-- test
-- test/test_gis_distance.rb
+- lib/gis/distance.rb
+- spec/gis_distance_spec.rb
 homepage: http://github.com/djberg96/gis-distance
 licenses:
-- Artistic 2.0
+- Artistic-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/gis-distance
   bug_tracker_uri: https://github.com/djberg96/gis-distance/issues
@@ -70,7 +92,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,11 +107,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: The gis-distance library provides a simple interface for calculating the
   distance between two points on Earth using latitude and longitude.
 test_files:
-- test/test_gis_distance.rb
+- spec/gis_distance_spec.rb

data/test/test_gis_distance.rb

@@ -1,99 +0,0 @@
-require 'test/unit'
-require 'gis/distance'
-
-class TC_GIS_Distance < Test::Unit::TestCase
-  def setup
-    @gis = GIS::Distance.new(40.47, 73.58, 34.3, 118.15)
-  end
-
-  def test_version
-    assert_equal('1.0.2', GIS::Distance::VERSION)
-    assert_true(GIS::Distance::VERSION.frozen?)
-  end
-
-  def test_distance_basic_functionality
-    assert_respond_to(@gis, :distance)
-    assert_nothing_raised{ @gis.distance }
-    assert_kind_of(Float, @gis.distance)
-  end
-
-  def test_distance
-    assert_in_delta(0.01, 3952.39, @gis.distance)
-    assert_equal(0.0, GIS::Distance.new(40.47, 73.58, 40.47, 73.58).distance)
-  end
-
-  def test_distance_expected_argument_errors
-    assert_raise(ArgumentError){ GIS::Distance.new }
-    assert_raise(ArgumentError){ GIS::Distance.new(40.47) }
-    assert_raise(ArgumentError){ GIS::Distance.new(40.47, 73.58) }
-    assert_raise(ArgumentError){ GIS::Distance.new(40.47, 73.58, 34.3) }
-  end
-
-  def test_distance_expected_range_errors
-    assert_raise(GIS::Distance::Error){ GIS::Distance.new(91.0, 100.0, 45.0, 45.0) }
-    assert_raise(GIS::Distance::Error){ GIS::Distance.new(90.0, 190.0, 45.0, 45.0) }
-  end
-
-  def test_radius_basic_functionality
-    assert_respond_to(@gis, :radius)
-    assert_nothing_raised{ @gis.radius }
-    assert_kind_of(Float, @gis.radius)
-  end
-
-  def test_default_radius
-    assert_equal(6367.45, @gis.radius)
-  end
-
-  def test_radius_expected_errors
-    assert_raise(ArgumentError){ @gis.radius(1) }
-  end
-
-  def test_radius_setter_basic_functionality
-    assert_respond_to(@gis, :radius=)
-    assert_nothing_raised{ @gis.radius = 6368.0 }
-    assert_equal(6368.0, @gis.radius)
-  end
-
-  def test_radius_setter_expected_errors
-    assert_raise(GIS::Distance::Error){ @gis.radius = 6200 }
-    assert_raise(GIS::Distance::Error){ @gis.radius = 6400 }
-  end
-
-  def test_formula_basic_functionality
-    assert_respond_to(@gis, :formula)
-    assert_nothing_raised{ @gis.formula }
-    assert_kind_of(String, @gis.formula)
-  end
-
-  def test_formula
-    assert_equal('haversine', @gis.formula)
-  end
-
-  def test_formula_setter_basic_functionality
-    assert_respond_to(@gis, :formula=)
-    assert_nothing_raised{ @gis.formula = 'haversine' }
-  end
-
-  def test_formula_expected_errors
-    assert_raise(ArgumentError){ @gis.formula(1) }
-    assert_raise(GIS::Distance::Error){ @gis.formula = 'foo' }
-  end
-
-  def test_mi_basic_functionality
-    assert_respond_to(@gis.distance, :mi)
-    assert_nothing_raised{ @gis.distance.mi }
-    assert_kind_of(Float, @gis.distance.mi)
-  end
-
-  def test_mi
-    assert(@gis.distance > @gis.distance.mi)
-  end
-
-  def test_mi_expected_errors
-    assert_raise(ArgumentError){ @gis.distance.mi(1) }
-  end
-
-  def teardown
-    @gis = nil
-  end
-end