geo_coord 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36feeb545afb9bf13f5d330302ba226b9c9fc9ce28aa1b223ad0c796ca1e2e37
-  data.tar.gz: 57ea4296740735b6c8606738b38498225130620a43056832ae7ee3a96c8b3b2a
+  metadata.gz: b3db98f605de72af073cfe394b476854eaea49c5f25ebd576e154eb4674d32ec
+  data.tar.gz: a858a86c033c9dc3e6c1d12d0f1de494ac59b253b7bacf541f8f66d78050a5af
 SHA512:
-  metadata.gz: 45c9aa30f9d38d1ea2d96cd89fefe0f09ff77a1d18d515402ba6ccb2d37b92a5b8d3ef1903c619cc8c655f4787750db1dae1f457330ac58d2c84ec086ed8962b
-  data.tar.gz: 77ffed86527f6752f4885c0e22173aa84214c8074a7793fc0026ce8d7c78ee43bc3c6d6e1b62a43d77de03619dcc097dde576531c176d149e115b0bf235532f3
+  metadata.gz: 3b0c3ab2b548655cf0ea6b4dc344dfbfad703cdcd02de350d1321e1efc97eed917a161182502703b437a25ba8b1703a60fb0df8aed8bc88fc2358ca2590507a9
+  data.tar.gz: bfe1756c5a66741f6cbd81e41d5b4d6977ab6df66b901bad410ddea4fcb246402fd1d8a3b932e8e698a979ad603ed5188668941d47a53a4b7fe650bc18fa7e7a

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  main:
+    name: >-
+      ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.5, 2.6, 2.7, 3.0 ]
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: install dependencies
+        run:  bundle install --jobs 3 --retry 3
+      - name: spec
+        run:  bundle exec rake spec
+      - name: rubocop
+        run:  bundle exec rake rubocop

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Geo::Coord changelog
 
+## 0.2.0 - Feb 15, 2021
+
+* Support Ruby versions up to 3.0
+* Drop compatibility checks for Ruby < 2.4
+* Update specs to modern style (no hope to make it to standard library after 5 years :shrug:)
+* Fix seconds fraction truncation in DMS-initialization (@matthew-angelswing)
+* Change positional `hemisphere` argument in `to_s` to keyword for clarity
+
 ## 0.1.0 - Feb 3, 2018
 
 * Switch to `BigDecimal` for internal values storage;

data/README.md

@@ -1,8 +1,7 @@
 # Geo::Coord—simple geo coordinates class for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/geo_coord.svg)](http://badge.fury.io/rb/geo_coord)
-[![Dependency Status](https://gemnasium.com/zverok/geo_coord.svg)](https://gemnasium.com/zverok/geo_coord)
-[![Build Status](https://travis-ci.org/zverok/geo_coord.svg?branch=master)](https://travis-ci.org/zverok/geo_coord)
+![Build Status](https://github.com/zverok/geo_coord/workflows/CI/badge.svg?branch=master)
 [![Coverage Status](https://coveralls.io/repos/zverok/geo_coord/badge.svg?branch=master)](https://coveralls.io/r/zverok/geo_coord?branch=master)
 
 `Geo::Coord` is a basic class representing `[latitude, longitude]` pair
@@ -36,13 +35,13 @@ other projects.
 You can read my initial proposal [here](https://github.com/zverok/geo_coord/blob/master/StdlibProposal.md)
 and discussion in Ruby tracker [there](https://bugs.ruby-lang.org/issues/12361).
 
-I still have a small hope it would be part of stdlib once, that's why I
+~~I still have a small hope it would be part of stdlib once, that's why I
 preserve the style of specs (outdated rspec, but compatible with mspec used
-for standard library) and docs (yard in RDoc-compatibility mode).
+for standard library) and docs (yard in RDoc-compatibility mode).~~
 
 ## Installation
 
-Now when it is a gem, just do your usual `gem install geo_coord` or add
+As usual: `gem install geo_coord` or add
 `gem "geo_coord", require: "geo/coord"` to your Gemfile.
 
 ## Usage
@@ -178,7 +177,7 @@ metres for distances (as they are SI unit) and degrees for azimuth.
 Latitude and longitude are stored in degrees, but radians values accessors
 are provided (being widely used in geodesy math).
 
-**Internal storage**: Since ver 0.0.2, latitude and longitude stored
+**Internal storage**: Since ver 0.1.0, latitude and longitude stored
 internally as an instances of `BigDecimal`. While having some memory
 and performance downsides, this datatype provides _correctness_ of
 conversions between floating point & deg-min-sec representations:

data/geo_coord.gemspec

@@ -20,15 +20,17 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.4.0'
 
   s.add_development_dependency 'rubocop', '>= 0.40'
-  s.add_development_dependency 'rspec', '= 2.14'
-  s.add_development_dependency 'mspec'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov', '~> 0.9'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubygems-tasks'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'dokaz'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'saharspec'
 end

data/lib/geo/coord.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
+require 'bigdecimal/util'
 
 # Geo::Coord is Ruby's library for handling [lat, lng] pairs of
 # geographical coordinates. It provides most of basic functionality
@@ -141,44 +144,44 @@ module Geo
       end
 
       # @private
-      INT_PATTERN = '[-+]?\d+'.freeze # :nodoc:
+      INT_PATTERN = '[-+]?\d+' # :nodoc:
       # @private
-      UINT_PATTERN = '\d+'.freeze # :nodoc:
+      UINT_PATTERN = '\d+' # :nodoc:
       # @private
-      FLOAT_PATTERN = '[-+]?\d+(?:\.\d*)?'.freeze # :nodoc:
+      FLOAT_PATTERN = '[-+]?\d+(?:\.\d*)?' # :nodoc:
       # @private
-      UFLOAT_PATTERN = '\d+(?:\.\d*)?'.freeze # :nodoc:
+      UFLOAT_PATTERN = '\d+(?:\.\d*)?' # :nodoc:
 
       # @private
-      DEG_PATTERN = '[ °d]'.freeze # :nodoc:
+      DEG_PATTERN = '[ °d]' # :nodoc:
       # @private
-      MIN_PATTERN = "['′’m]".freeze # :nodoc:
+      MIN_PATTERN = "['′’m]" # :nodoc:
       # @private
-      SEC_PATTERN = '["″s]'.freeze # :nodoc:
+      SEC_PATTERN = '["″s]' # :nodoc:
 
       # @private
-      LL_PATTERN = /^(#{FLOAT_PATTERN})\s*[,; ]\s*(#{FLOAT_PATTERN})$/ # :nodoc:
+      LL_PATTERN = /^(#{FLOAT_PATTERN})\s*[,; ]\s*(#{FLOAT_PATTERN})$/.freeze # :nodoc:
 
       # @private
-      DMS_LATD_P = "(?<latd>#{INT_PATTERN})#{DEG_PATTERN}".freeze # :nodoc:
+      DMS_LATD_P = "(?<latd>#{INT_PATTERN})#{DEG_PATTERN}" # :nodoc:
       # @private
-      DMS_LATM_P = "(?<latm>#{UINT_PATTERN})#{MIN_PATTERN}".freeze # :nodoc:
+      DMS_LATM_P = "(?<latm>#{UINT_PATTERN})#{MIN_PATTERN}" # :nodoc:
       # @private
-      DMS_LATS_P = "(?<lats>#{UFLOAT_PATTERN})#{SEC_PATTERN}".freeze # :nodoc:
+      DMS_LATS_P = "(?<lats>#{UFLOAT_PATTERN})#{SEC_PATTERN}" # :nodoc:
       # @private
-      DMS_LAT_P = "#{DMS_LATD_P}\\s*#{DMS_LATM_P}\\s*#{DMS_LATS_P}\\s*(?<lath>[NS])".freeze # :nodoc:
+      DMS_LAT_P = "#{DMS_LATD_P}\\s*#{DMS_LATM_P}\\s*#{DMS_LATS_P}\\s*(?<lath>[NS])" # :nodoc:
 
       # @private
-      DMS_LNGD_P = "(?<lngd>#{INT_PATTERN})#{DEG_PATTERN}".freeze # :nodoc:
+      DMS_LNGD_P = "(?<lngd>#{INT_PATTERN})#{DEG_PATTERN}" # :nodoc:
       # @private
-      DMS_LNGM_P = "(?<lngm>#{UINT_PATTERN})#{MIN_PATTERN}".freeze # :nodoc:
+      DMS_LNGM_P = "(?<lngm>#{UINT_PATTERN})#{MIN_PATTERN}" # :nodoc:
       # @private
-      DMS_LNGS_P = "(?<lngs>#{UFLOAT_PATTERN})#{SEC_PATTERN}".freeze # :nodoc:
+      DMS_LNGS_P = "(?<lngs>#{UFLOAT_PATTERN})#{SEC_PATTERN}" # :nodoc:
       # @private
-      DMS_LNG_P = "#{DMS_LNGD_P}\\s*#{DMS_LNGM_P}\\s*#{DMS_LNGS_P}\\s*(?<lngh>[EW])".freeze # :nodoc:
+      DMS_LNG_P = "#{DMS_LNGD_P}\\s*#{DMS_LNGM_P}\\s*#{DMS_LNGS_P}\\s*(?<lngh>[EW])" # :nodoc:
 
       # @private
-      DMS_PATTERN = /^\s*#{DMS_LAT_P}\s*[,; ]\s*#{DMS_LNG_P}\s*$/x # :nodoc:
+      DMS_PATTERN = /^\s*#{DMS_LAT_P}\s*[,; ]\s*#{DMS_LNG_P}\s*$/x.freeze # :nodoc:
 
       # Parses Coord from string containing float latitude and longitude.
       # Understands several types of separators/spaces between values.
@@ -277,15 +280,17 @@ module Geo
         pattern = PARSE_PATTERNS.inject(pattern) do |memo, (pfrom, pto)|
           memo.gsub(pfrom, pto)
         end
-        match = Regexp.new('^' + pattern).match(str)
+        match = Regexp.new("^#{pattern}").match(str)
         raise ArgumentError, "Coordinates str #{str} can't be parsed by pattern #{pattern}" unless match
-        new(match.names.map { |n| [n.to_sym, _extract_match(match, n)] }.to_h)
+
+        new(**match.names.map { |n| [n.to_sym, _extract_match(match, n)] }.to_h)
       end
 
       private
 
       def _extract_match(match, name)
         return nil unless match[name]
+
         val = match[name]
         name.end_with?('h') ? val : val.to_f
       end
@@ -319,28 +324,28 @@ module Geo
     #    g = Geo::Coord.new(lat: 50.004444)
     #    # => #<Geo::Coord 50°0'16"N 0°0'0"W>
     #
-    def initialize(lat = nil, lng = nil, **opts)
+    def initialize(lat = nil, lng = nil, **kwargs) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       @globe = Globes::Earth.instance
 
+      # It is probably can be clearer with Ruby 2.7+ pattern-matching... or with less permissive
+      # protocol :)
+      kwargs = lat if lat.is_a?(Hash) && kwargs.empty? # Ruby 3.0
+
       case
       when lat && lng
         _init(lat, lng)
-      when opts.key?(:lat) || opts.key?(:lng)
-        _init(opts[:lat], opts[:lng])
-      when opts.key?(:latd) || opts.key?(:lngd)
-        _init_dms(opts)
+      when kwargs.key?(:lat) || kwargs.key?(:lng)
+        _init(*kwargs.values_at(:lat, :lng))
+      when kwargs.key?(:latd) || kwargs.key?(:lngd)
+        _init_dms(**kwargs)
       else
-        raise ArgumentError, "Can't create #{self.class} by provided data"
+        raise ArgumentError, "Can't create #{self.class} by provided data: (#{lat}, #{lng}, **#{kwargs}"
       end
     end
 
     # Compares with +other+.
     #
-    # Note, that comparison includes comparing floating point values,
-    # so, when two "almost exactly same" coord pairs are calculated using
-    # different methods, you can rarely expect them to be _exactly_ equal.
-    #
-    # Also, note that no greater/lower relation is defined on Coord, so,
+    # Note that no greater/lower relation is defined on Coord, so,
     # for example, you can't just sort an array of Coord.
     def ==(other)
       other.is_a?(self.class) && other.lat == lat && other.lng == lng
@@ -363,7 +368,7 @@ module Geo
 
     # Returns latitude hemisphere (upcase letter 'N' or 'S').
     def lath
-      lat > 0 ? 'N' : 'S'
+      lat.positive? ? 'N' : 'S'
     end
 
     # Returns longitude degrees (unsigned integer).
@@ -383,7 +388,7 @@ module Geo
 
     # Returns longitude hemisphere (upcase letter 'E' or 'W').
     def lngh
-      lng > 0 ? 'E' : 'W'
+      lng.positive? ? 'E' : 'W'
     end
 
     # Returns latitude components: degrees, minutes, seconds and optionally
@@ -392,17 +397,17 @@ module Geo
     #    # Nothern hemisphere:
     #    g = Geo::Coord.new(50.004444, 36.231389)
     #
-    #    g.latdms        # => [50, 0, 15.9984, "N"]
-    #    g.latdms(true)  # => [50, 0, 15.9984]
+    #    g.latdms                     # => [50, 0, 15.9984, "N"]
+    #    g.latdms(hemisphere: false)  # => [50, 0, 15.9984]
     #
     #    # Southern hemisphere:
     #    g = Geo::Coord.new(-50.004444, 36.231389)
     #
-    #    g.latdms        # => [50, 0, 15.9984, "S"]
-    #    g.latdms(true)  # => [-50, 0, 15.9984]
+    #    g.latdms                     # => [50, 0, 15.9984, "S"]
+    #    g.latdms(hemisphere: false)  # => [-50, 0, 15.9984]
     #
-    def latdms(nohemisphere = false)
-      nohemisphere ? [latsign * latd, latm, lats] : [latd, latm, lats, lath]
+    def latdms(hemisphere: true)
+      hemisphere ? [latd, latm, lats, lath] : [latsign * latd, latm, lats]
     end
 
     # Returns longitude components: degrees, minutes, seconds and optionally
@@ -411,17 +416,17 @@ module Geo
     #    # Eastern hemisphere:
     #    g = Geo::Coord.new(50.004444, 36.231389)
     #
-    #    g.lngdms        # => [36, 13, 53.0004, "E"]
-    #    g.lngdms(true)  # => [36, 13, 53.0004]
+    #    g.lngdms                     # => [36, 13, 53.0004, "E"]
+    #    g.lngdms(hemisphere: false)  # => [36, 13, 53.0004]
     #
     #    # Western hemisphere:
     #    g = Geo::Coord.new(50.004444, 36.231389)
     #
-    #    g.lngdms        # => [36, 13, 53.0004, "E"]
-    #    g.lngdms(true)  # => [-36, 13, 53.0004]
+    #    g.lngdms                     # => [36, 13, 53.0004, "E"]
+    #    g.lngdms(hemisphere: false)  # => [-36, 13, 53.0004]
     #
-    def lngdms(nohemisphere = false)
-      nohemisphere ? [lngsign * lngd, lngm, lngs] : [lngd, lngm, lngs, lngh]
+    def lngdms(hemisphere: true)
+      hemisphere ? [lngd, lngm, lngs, lngh] : [lngsign * lngd, lngm, lngs]
     end
 
     # Latitude in radians. Geodesy formulae almost alwayse use greek Phi
@@ -488,11 +493,11 @@ module Geo
     end
 
     # @private
-    INTFLAGS = '\+'.freeze # :nodoc:
+    INTFLAGS = '\+' # :nodoc:
     # @private
-    FLOATUFLAGS = /\.0\d+/ # :nodoc:
+    FLOATUFLAGS = /\.0\d+/.freeze # :nodoc:
     # @private
-    FLOATFLAGS = /\+?#{FLOATUFLAGS}?/ # :nodoc:
+    FLOATFLAGS = /\+?#{FLOATUFLAGS}?/.freeze # :nodoc:
 
     # @private
     DIRECTIVES = { # :nodoc:
@@ -605,8 +610,8 @@ module Geo
 
     private
 
-    LAT_RANGE_ERROR = 'Expected latitude to be between -90 and 90, %p received'.freeze
-    LNG_RANGE_ERROR = 'Expected longitude to be between -180 and 180, %p received'.freeze
+    LAT_RANGE_ERROR = 'Expected latitude to be between -90 and 90, %p received'
+    LNG_RANGE_ERROR = 'Expected longitude to be between -180 and 180, %p received'
 
     def _init(lat, lng)
       lat = BigDecimal(lat.to_f, 10)
@@ -624,22 +629,16 @@ module Geo
     # @private
     LNGH = {'E' => 1, 'W' => -1}.freeze # :nodoc:
 
-    def _init_dms(opts) # rubocop:disable Metrics/AbcSize
-      lat = (
-        opts[:latd].to_i +
-        opts[:latm].to_i / 60.0 +
-        opts[:lats].to_i / 3600.0
-      ) * guess_sign(opts[:lath], LATH)
-      lng = (
-        opts[:lngd].to_i +
-        opts[:lngm].to_i / 60.0 +
-        opts[:lngs].to_i / 3600.0
-      ) * guess_sign(opts[:lngh], LNGH)
+    def _init_dms(latd: 0, latm: 0, lats: 0, lath: nil, lngd: 0, lngm: 0, lngs: 0, lngh: nil) # rubocop:disable Metrics/AbcSize
+      lat = (latd.to_d + latm.to_d / 60 + lats.to_d / 3600) * guess_sign(lath, LATH)
+      lng = (lngd.to_d + lngm.to_d / 60 + lngs.to_d / 3600) * guess_sign(lngh, LNGH)
+
       _init(lat, lng)
     end
 
     def guess_sign(h, hemishperes)
       return 1 unless h
+
       hemishperes[h] or
         raise ArgumentError, "Unidentified hemisphere: #{h}"
     end
@@ -647,6 +646,7 @@ module Geo
     def guard_seconds(pattern, result)
       m = pattern.match(/<(lat|lng)s>/)
       return result unless m && result.start_with?('60')
+
       carry = "#{m[1]}m".to_sym
       [pattern % {lats: 0, lngs: 0}, carry]
     end

data/lib/geo/coord/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Geo
   class Coord
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geo_coord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.40'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,12 +136,41 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: saharspec
+  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: ''
 email: zverok.offline@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
@@ -163,15 +192,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Geo::Coord class