compass_point 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb3e7bab2d5ddc4cc246aeea5c02714a16713feb1646c86ec89a4015ecd753e
-  data.tar.gz: cc30e1b188cfac483650b97556f6baff583de196872f7eda132384e47eae4560
+  metadata.gz: 58dc6a0e428a79c4f324f8203b4bd263b79e83a2bc27ed2b9275d737579f5b49
+  data.tar.gz: 6f7747c5f2298d8801a6f4c28636237c5ced151c5439826ec6db0aaa92cd5e14
 SHA512:
-  metadata.gz: 43c9378298e358659a9874c23b8e341d8edcb319ca69a79d6fd83403cb19fc8a701fecd2b46bd5f1632efd6e99556280106fe05e63c2c9e17e321010f0f9d470
-  data.tar.gz: 99f9b3b30d78b3f0d0564b329e8ae2adcca6da6c6306582b700c370f4cad3c858b1339e98370062d5be6c384f44370ca96b00f93e50746d00387746900a3e30d
+  metadata.gz: 1afe4228022af269623dcdf5d0918ae87bd805773d6b08f1bc043197cc6d8b45c4bb7e569f56717b2ae3c42dcd861f7113c8d46d7bac1546155e10e0bc0a72b4
+  data.tar.gz: 6222b9724ca875db38cd2cf2213e53233463ce9e02cef98ee5664211bbc3212769bd4e25c524b0485380b798999a7b6c7563948508fa077ce5b71fa2a6c547ed

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2023 Keith Morrison <keithm@infused.org>
+Copyright (c) 2015-2024 Keith Morrison <keithm@infused.org>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -16,7 +16,7 @@ A Ruby library for working with compass points.
 
 Compass Point is compatible with the following versions of Ruby:
 
-* MRI Ruby 3.0.x, 3.1.x, 3.2.x, and 3.3.x
+* MRI Ruby 3.1.x, 3.2.x, and 3.3.x
 
 ## Installation
 
@@ -68,7 +68,7 @@ example:
 
 ## License
 
-Copyright (c) 2015-2023 Keith Morrison <<keithm@infused.org>>
+Copyright (c) 2015-2024 Keith Morrison <<keithm@infused.org>>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/lib/compass_point.rb

@@ -1,7 +1,7 @@
 class CompassPoint
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'.freeze
 
-  COMPASS_BEARING_REGEX = /(n|s)\s(\d{1,3}).?\s(e|w)/.freeze
+  COMPASS_BEARING_REGEX = /(n|s)\s(\d{1,3}).?\s(e|w)/
 
   POINTS = {
     n: {min: 354.38, mid: 0.0, max: 5.62, name: 'North'},
@@ -41,9 +41,9 @@ class CompassPoint
   class << self
     def azimuth(s)
       input = normalize_input(s)
-      if point = find_point(input)
+      if (point = find_point(input))
         point[:mid]
-      elsif match = input.match(COMPASS_BEARING_REGEX)
+      elsif (match = input.match(COMPASS_BEARING_REGEX))
         azimuth_from_match(match)
       end
     end
@@ -96,15 +96,13 @@ class CompassPoint
         180
       end
 
-      adjust = match[2].to_i
-
       operation = if (match[1] == 'n' && match[3] == 'w') || (match[1] == 's' && match[3] == 'e')
         :-
       else
         :+
       end
 
-      base.send(operation, adjust)
+      base.send(operation, match[2].to_i)
     end
 
     def generate_compass_quadrant_bearing(b)

data/spec/compass_point_spec.rb

@@ -3,88 +3,87 @@ require 'spec_helper'
 describe CompassPoint do
   describe '.azimuth' do
     it 'returns mid point in degrees' do
-      expect(CompassPoint.azimuth('N')).to eq 0.0
-      expect(CompassPoint.azimuth(:nw)).to eq 315.0
-      expect(CompassPoint.azimuth('sbw')).to eq 191.25
-      expect(CompassPoint.azimuth('X')).to be_nil
-      expect(CompassPoint.azimuth('Northeast by east')).to eq 56.25
-      expect(CompassPoint.azimuth('N 27° E')).to eq 27
-      expect(CompassPoint.azimuth('S 77° E')).to eq 103
-      expect(CompassPoint.azimuth('S 2° E')).to eq 178
-      expect(CompassPoint.azimuth('N 77° W')).to eq 283
-      expect(CompassPoint.azimuth('N 20 W')).to eq 340
-      expect(CompassPoint.azimuth('S 30° W')).to eq 210
+      expect(described_class.azimuth('N')).to eq 0.0
+      expect(described_class.azimuth(:nw)).to eq 315.0
+      expect(described_class.azimuth('sbw')).to eq 191.25
+      expect(described_class.azimuth('X')).to be_nil
+      expect(described_class.azimuth('Northeast by east')).to eq 56.25
+      expect(described_class.azimuth('N 27° E')).to eq 27
+      expect(described_class.azimuth('S 77° E')).to eq 103
+      expect(described_class.azimuth('S 2° E')).to eq 178
+      expect(described_class.azimuth('N 77° W')).to eq 283
+      expect(described_class.azimuth('N 20 W')).to eq 340
+      expect(described_class.azimuth('S 30° W')).to eq 210
     end
   end
 
   describe '.back_azimuth' do
     it 'returns opposite of azimuth' do
-      expect(CompassPoint.back_azimuth('N')).to eq 180.0
-      expect(CompassPoint.back_azimuth(:nw)).to eq 135.0
-      expect(CompassPoint.back_azimuth('sbw')).to eq 11.25
-      expect(CompassPoint.back_azimuth('X')).to be_nil
-      expect(CompassPoint.back_azimuth('Northeast by east')).to eq 236.25
-      expect(CompassPoint.back_azimuth('N 27° E')).to eq 207
-      expect(CompassPoint.back_azimuth('S 77° E')).to eq 283
-      expect(CompassPoint.back_azimuth('S 2° E')).to eq 358
-      expect(CompassPoint.back_azimuth('N 77° W')).to eq 103
-      expect(CompassPoint.back_azimuth('N 20 W')).to eq 160
-      expect(CompassPoint.back_azimuth('S 30° W')).to eq 30
+      expect(described_class.back_azimuth('N')).to eq 180.0
+      expect(described_class.back_azimuth(:nw)).to eq 135.0
+      expect(described_class.back_azimuth('sbw')).to eq 11.25
+      expect(described_class.back_azimuth('X')).to be_nil
+      expect(described_class.back_azimuth('Northeast by east')).to eq 236.25
+      expect(described_class.back_azimuth('N 27° E')).to eq 207
+      expect(described_class.back_azimuth('S 77° E')).to eq 283
+      expect(described_class.back_azimuth('S 2° E')).to eq 358
+      expect(described_class.back_azimuth('N 77° W')).to eq 103
+      expect(described_class.back_azimuth('N 20 W')).to eq 160
+      expect(described_class.back_azimuth('S 30° W')).to eq 30
     end
   end
 
   describe '.min' do
     it 'returns min point in degrees' do
-      expect(CompassPoint.min('N')).to eq 354.38
-      expect(CompassPoint.min(:nw)).to eq 309.38
-      expect(CompassPoint.min('sbw')).to eq 185.63
-      expect(CompassPoint.min('X')).to be_nil
-      expect(CompassPoint.min('Northeast by east')).to eq 50.63
+      expect(described_class.min('N')).to eq 354.38
+      expect(described_class.min(:nw)).to eq 309.38
+      expect(described_class.min('sbw')).to eq 185.63
+      expect(described_class.min('X')).to be_nil
+      expect(described_class.min('Northeast by east')).to eq 50.63
     end
   end
 
   describe '.max' do
     it 'returns max point in degrees' do
-      expect(CompassPoint.max('N')).to eq 5.62
-      expect(CompassPoint.max(:nw)).to eq 320.62
-      expect(CompassPoint.max('sbw')).to eq 196.87
-      expect(CompassPoint.max('X')).to be_nil
-      expect(CompassPoint.max('Northeast by east')).to eq 61.87
+      expect(described_class.max('N')).to eq 5.62
+      expect(described_class.max(:nw)).to eq 320.62
+      expect(described_class.max('sbw')).to eq 196.87
+      expect(described_class.max('X')).to be_nil
+      expect(described_class.max('Northeast by east')).to eq 61.87
     end
   end
 
   describe '.min_max' do
     it 'returns [min, max]' do
-      expect(CompassPoint.min_max('N')).to eq [354.38, 5.62]
-      expect(CompassPoint.min_max(:nw)).to eq [309.38, 320.62]
-      expect(CompassPoint.min_max('sbw')).to eq [185.63, 196.87]
-      expect(CompassPoint.min_max('X')).to be_nil
-      expect(CompassPoint.min_max('Northeast by east')).to eq [50.63, 61.87]
+      expect(described_class.min_max('N')).to eq [354.38, 5.62]
+      expect(described_class.min_max(:nw)).to eq [309.38, 320.62]
+      expect(described_class.min_max('sbw')).to eq [185.63, 196.87]
+      expect(described_class.min_max('X')).to be_nil
+      expect(described_class.min_max('Northeast by east')).to eq [50.63, 61.87]
     end
   end
 
   describe '.name' do
     it 'returns the points full name' do
-      expect(CompassPoint.name('nnw')).to eq 'North northwest'
+      expect(described_class.name('nnw')).to eq 'North northwest'
     end
   end
 
   describe '.compass_quadrant_bearing' do
     it 'is' do
-      expect(CompassPoint.compass_quadrant_bearing(0)).to eq 'N'
-      expect(CompassPoint.compass_quadrant_bearing(27)).to eq 'N 27° E'
-      expect(CompassPoint.compass_quadrant_bearing(27.4)).to eq 'N 27° E'
-      expect(CompassPoint.compass_quadrant_bearing(27.7)).to eq 'N 28° E'
-      expect(CompassPoint.compass_quadrant_bearing(90)).to eq 'E'
-      expect(CompassPoint.compass_quadrant_bearing(103)).to eq 'S 77° E'
-      expect(CompassPoint.compass_quadrant_bearing(178)).to eq 'S 2° E'
-      expect(CompassPoint.compass_quadrant_bearing(180)).to eq 'S'
-      expect(CompassPoint.compass_quadrant_bearing(210)).to eq 'S 30° W'
-      expect(CompassPoint.compass_quadrant_bearing(270)).to eq 'W'
-      expect(CompassPoint.compass_quadrant_bearing(283)).to eq 'N 77° W'
-      expect(CompassPoint.compass_quadrant_bearing(340)).to eq 'N 20° W'
-      expect(CompassPoint.compass_quadrant_bearing(360)).to eq 'N'
+      expect(described_class.compass_quadrant_bearing(0)).to eq 'N'
+      expect(described_class.compass_quadrant_bearing(27)).to eq 'N 27° E'
+      expect(described_class.compass_quadrant_bearing(27.4)).to eq 'N 27° E'
+      expect(described_class.compass_quadrant_bearing(27.7)).to eq 'N 28° E'
+      expect(described_class.compass_quadrant_bearing(90)).to eq 'E'
+      expect(described_class.compass_quadrant_bearing(103)).to eq 'S 77° E'
+      expect(described_class.compass_quadrant_bearing(178)).to eq 'S 2° E'
+      expect(described_class.compass_quadrant_bearing(180)).to eq 'S'
+      expect(described_class.compass_quadrant_bearing(210)).to eq 'S 30° W'
+      expect(described_class.compass_quadrant_bearing(270)).to eq 'W'
+      expect(described_class.compass_quadrant_bearing(283)).to eq 'N 77° W'
+      expect(described_class.compass_quadrant_bearing(340)).to eq 'N 20° W'
+      expect(described_class.compass_quadrant_bearing(360)).to eq 'N'
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass_point
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Keith Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby library for working with compass points
 email: keithm@infused.org
@@ -18,13 +18,8 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- Gemfile
-- Gemfile.lock
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
-- compass_point.gemspec
 - lib/compass_point.rb
 - spec/compass_point_spec.rb
 - spec/spec_helper.rb
@@ -42,14 +37,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby library for working with compass points

data/Gemfile

@@ -1,12 +0,0 @@
-gemspec
-source 'https://rubygems.org'
-
-group :development, :test do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'irb'
-  gem 'rake'
-  gem 'rspec'
-  gem 'rubocop-performance'
-  gem 'rubocop-rspec'
-end

data/Gemfile.lock

@@ -1,111 +0,0 @@
-PATH
-  remote: .
-  specs:
-    compass_point (2.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.5.0)
-    ffi (1.15.5)
-    formatador (1.1.0)
-    guard (2.18.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.13.0)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    io-console (0.6.0)
-    irb (1.6.4)
-      reline (>= 0.3.0)
-    json (2.6.3)
-    listen (3.8.0)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
-    method_source (1.0.0)
-    nenv (0.3.0)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    parallel (1.23.0)
-    parser (3.2.2.1)
-      ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (2.8.0)
-    reline (0.3.3)
-      io-console (~> 0.5)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.51.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
-      rubocop (~> 1.33)
-    rubocop-performance (1.17.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.22.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-    ruby-progressbar (1.13.0)
-    shellany (0.0.1)
-    thor (1.2.2)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  compass_point!
-  guard
-  guard-rspec
-  irb
-  rake
-  rspec
-  rubocop-performance
-  rubocop-rspec
-
-BUNDLED WITH
-   2.4.13

data/Guardfile

@@ -1,52 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features)
-
-## Uncomment to clear the screen before every task
-# clearing :on
-
-## Guard internally checks for changes in the Guardfile and exits.
-## If you want Guard to automatically start up again, run guard in a
-## shell loop, e.g.:
-##
-##  $ while bundle exec guard; do echo "Restarting Guard..."; done
-##
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
-  watch('Guardfile')            { 'spec' }
-end

data/Rakefile

@@ -1,18 +0,0 @@
-require 'bundler/setup'
-Bundler.setup(:default, :development)
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new :spec do |t|
-  t.rspec_opts = %w[--color]
-end
-
-RSpec::Core::RakeTask.new :specdoc do |t|
-  t.rspec_opts = %w[-fl]
-end
-
-task default: :spec
-
-desc 'Open an irb session preloaded with this library'
-task :console do
-  sh 'irb -rubygems -I lib -r compass_point.rb'
-end

data/compass_point.gemspec

@@ -1,22 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-require 'compass_point'
-
-Gem::Specification.new do |s|
-  s.name = 'compass_point'
-  s.version = CompassPoint::VERSION
-  s.authors = ['Keith Morrison']
-  s.email = 'keithm@infused.org'
-  s.homepage = 'http://github.com/infused/compass_point'
-  s.summary = 'A Ruby library for working with compass points'
-  s.description = 'A Ruby library for working with compass points'
-  s.license = 'MIT'
-
-  s.rdoc_options = ['--charset=UTF-8']
-  s.extra_rdoc_files = ['README.md', 'LICENSE']
-  s.files = Dir['[A-Z]*', '{lib,spec}/**/*', 'compass_points.gemspec']
-  s.require_paths = ['lib']
-
-  s.required_ruby_version = '>= 3.0.0'
-  s.metadata['rubygems_mfa_required'] = 'true'
-end