compass_point 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 05c895cb0f48a2861a8287f21fe2c065754f28a4
-  data.tar.gz: 106814cdb998938219bff0e642fec12df38851f0
+SHA256:
+  metadata.gz: cc5cb255e2b838ab24b075812b761e36917c57f0b7e5cc7c4fab65392a521c6b
+  data.tar.gz: 3c7a1523e8ddb807d515c0e7c5d848cf72ccbd81762b3946025d25ef08f1adfe
 SHA512:
-  metadata.gz: d25f6cc323c2ea6f32487f71699e0d030803108381e84aea8c760ea6511222a0013a91c0e232098cc6c084d852da6e3aff9f525e28dea5b006cc01defd553fb9
-  data.tar.gz: d47fea9fdc254a7aa5717f67011b03513bbc5ce901d45d7e90e8cae9dc361f21f77d73db3f620f261deac1a54f16d2c3da32afd477b8d568936453cc1163585c
+  metadata.gz: 5b9738cf946eea2ce210bf7bb33b5bd40c6f5237ac98fb009f3e65436f03ef62bb2c49e886830930952932c8e3872cb1b25be67fb590a4181d0a99e911fef4e6
+  data.tar.gz: 0c86a05cee019d0e38e25e877faa4a8d1713aee1a92d9f4024ae84f62a5bf7cb78c7b9323eab2fff2bb7f6a6d435afa964090ec66aa90b3c941379d99736d319

data/Gemfile

@@ -1,9 +1,9 @@
 gemspec
 source 'https://rubygems.org'
 
-
 group :development, :test do
-  gem 'rspec'
   gem 'guard'
   gem 'guard-rspec'
+  gem 'rspec'
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,67 +1,76 @@
 PATH
   remote: .
   specs:
-    compass_point (1.0.1)
+    compass_point (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    ffi (1.9.8)
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.21)
     formatador (0.2.5)
-    guard (2.12.5)
+    guard (2.14.2)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.5.0)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hitimes (1.2.2)
-    listen (2.10.0)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    nenv (0.2.0)
-    notiffany (0.0.6)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.10.1)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
     shellany (0.0.1)
-    slop (3.6.0)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
+    thor (0.20.0)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -71,6 +80,7 @@ DEPENDENCIES
   guard
   guard-rspec
   rspec
+  rubocop
 
 BUNDLED WITH
-   1.10.6
+   1.16.1

data/Gemfile.travis

@@ -1,8 +1,7 @@
-gemspec
 source 'https://rubygems.org'
 
+gemspec
+
 group :test do
-  gem 'rubysl', :platform => :rbx
   gem 'rspec'
-  gem 'codeclimate-test-reporter', :require => false, :platform => :ruby
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2014 Keith Morrison <keithm@infused.org>
+Copyright (c) 2015-2018 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

@@ -1,8 +1,6 @@
 # Compass Point
 [![Version](http://img.shields.io/gem/v/compass_point.svg?style=flat)](https://rubygems.org/gems/compass_point)
 [![Build Status](http://img.shields.io/travis/infused/compass_point/master.svg?style=flat)](http://travis-ci.org/infused/compass_point)
-[![Code Quality](http://img.shields.io/codeclimate/github/infused/compass_point.svg?style=flat)](https://codeclimate.com/github/infused/compass_point)
-[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/infused/compass_point.svg?style=flat)](https://codeclimate.com/github/infused/compass_point)
 [![Dependency Status](http://img.shields.io/gemnasium/infused/compass_point.svg?style=flat)](https://gemnasium.com/infused/compass_point)
 [![Total Downloads](https://img.shields.io/gem/dt/compass_point.svg)](https://rubygems.org/gems/compass_point/)
 
@@ -18,7 +16,7 @@ A Ruby library for working with compass points.
 
 Compass Point is tested to work with the following versions of ruby:
 
-* MRI Ruby 2.0.x, 2.1.x, 2.2.x
+* MRI Ruby 2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x, 2.5.x
 * JRuby 1.7.x
 
 ## Installation
@@ -29,20 +27,24 @@ Compass Point is tested to work with the following versions of ruby:
 
 ### Azimuth
 
-Given an abbreviation such as "NW" or "SE", `azimuth` will
+Given an string such as "NW", "SE", "Northeast by east", or "N 20° W", `azimuth` will
 return the corresponding azimuth in degrees from 0 to 360:
 
     CompassPoint.azimuth('N') #=> 0.0
     CompassPoint.azimuth('S') #=> 180.0
     CompassPoint.azimuth('swbs') #=> 213.75
-
+    CompassPoint.azimuth('Northeast by east') #=> 56.25
+    CompassPoint.azimuth('N 20° W') #=> 340
 
 You can also get the minimum and maximum azimuths for any
 abbreviation with `min`, `max` and `min_max`:
 
     CompassPoint.min('E') #=> 84.38
     CompassPoint.max('E') #=> 95.62
+    CompassPoint.min('Northeast by east') #=> 50.63
+    CompassPoint.max('Northeast by east') #=> 61.87
     CompassPoint.min_max('E') #=> [84.38, 95.62]
+    CompassPoint.min_max('Northeast by east') #=> [50.63, 61.87]
 
 Get the full name for an abbreviation:
 
@@ -61,7 +63,7 @@ example:
 
 ## License
 
-Copyright (c) 2015 Keith Morrison <<keithm@infused.org>>
+Copyright (c) 2015-2018 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,5 +1,5 @@
 class CompassPoint
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'.freeze
 
   POINTS = {
     n:    {min: 354.38, mid: 0.0,    max: 5.62,   name: 'North'},
@@ -34,86 +34,103 @@ class CompassPoint
     nwbn: {min: 320.63, mid: 326.25, max: 331.87, name: 'Northwest by north'},
     nnw:  {min: 331.88, mid: 337.50, max: 343.12, name: 'North northwest'},
     nbw:  {min: 343.13, mid: 348.75, max: 354.37, name: 'North by west'}
-  }
+  }.freeze
 
   class << self
-    def azimuth(abbrev)
-      point = find_point(abbrev)
-      point && point[:mid]
+    def azimuth(s)
+      input = normalize_input(s)
+      if point = find_point(input)
+        point[:mid]
+      elsif match = input.match(/(n|s)\s(\d{1,3}).?\s(e|w)/)
+        base = if match[1] == 'n'
+          match[3] == 'w' ? 360 : 0
+        else
+          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)
+      end
     end
 
-    def min(abbrev)
-      point = find_point(abbrev)
+    def min(s)
+      point = find_point(normalize_input(s))
       point && point[:min]
     end
 
-    def max(abbrev)
-      point = find_point(abbrev)
+    def max(s)
+      point = find_point(normalize_input(s))
       point && point[:max]
     end
 
-    def min_max(abbrev)
-      point = find_point(abbrev)
+    def min_max(s)
+      point = find_point(normalize_input(s))
       point && [point[:min], point[:max]]
     end
 
-    def name(abbrev)
-      point = find_point(abbrev)
+    def name(s)
+      point = find_point(normalize_input(s))
       point && point[:name]
     end
 
     def compass_quadrant_bearing(bearing)
       b = bearing.round
       case b
-      when 0, 360
-        'N'
-      when 90
-        'E'
-      when 180
-        'S'
-      when 270
-        'W'
+      when 0, 360 then 'N'
+      when 90     then 'E'
+      when 180    then 'S'
+      when 270    then 'W'
       else
-        s = []
-        s << north_or_south(b)
-        if north_or_south(b) == 'N'
-          if east_or_west(b) == 'W'
-            s << (360 - b).abs.to_s
-          else
-            s << b.to_s
-          end
-        else
-          s << (180 - b).abs.to_s
-        end
-        s.last << '°'
-        s << east_or_west(b)
-        s.join(' ')
+        generate_compass_quadrant_bearing(b)
       end
     end
 
     private
 
+    def generate_compass_quadrant_bearing(b)
+      s = []
+      s << north_or_south(b)
+      s << if north_or_south(b) == 'N'
+        east_or_west(b) == 'W' ? (360 - b).abs : b
+      else
+        (180 - b).abs
+      end.to_s
+      s.last << '°'
+      s << east_or_west(b)
+      s.join(' ')
+    end
+
     def north_or_south(bearing)
       b = bearing.round
-      if (0..90).include?(b.to_i) || (270..360).include?(b.to_i)
-        'N'
-      else
-        'S'
-      end
+      (0..90).cover?(b.to_i) || (270..360).cover?(b.to_i) ? 'N' : 'S'
     end
 
     def east_or_west(bearing)
       b = bearing.round
-      (180..360).include?(b.to_i) ? 'W' : 'E'
+      (180..360).cover?(b.to_i) ? 'W' : 'E'
+    end
+
+    def find_point(s)
+      find_point_by_abbrev(s) || find_point_by_name(s)
+    end
+
+    def find_point_by_abbrev(s)
+      POINTS[s.to_sym]
     end
 
-    def find_point(abbrev)
-      key = normalize_abbrev(abbrev)
-      POINTS[key]
+    def find_point_by_name(s)
+      POINTS.values.find { |v| v[:name].downcase == s }
     end
 
-    def normalize_abbrev(abbrev)
-      abbrev.to_s.downcase.to_sym
+    def normalize_input(name)
+      name.to_s.strip.squeeze(' ').downcase
     end
   end
 end

data/spec/compass_point_spec.rb

@@ -7,6 +7,13 @@ describe CompassPoint do
       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
     end
   end
 
@@ -16,6 +23,7 @@ describe CompassPoint do
       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
     end
   end
 
@@ -25,6 +33,7 @@ describe CompassPoint do
       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
     end
   end
 
@@ -34,6 +43,7 @@ describe CompassPoint do
       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]
     end
   end
 

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
-begin
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-rescue LoadError
-end
-
 require 'compass_point'
 require 'rspec'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass_point
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Keith Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby library for working with compass points
 email: keithm@infused.org
@@ -25,7 +25,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- compass_point.gemspec
 - lib/compass_point.rb
 - spec/compass_point_spec.rb
 - spec/spec_helper.rb
@@ -50,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A Ruby library for working with compass points

data/compass_point.gemspec

@@ -1,23 +0,0 @@
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.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.test_files = Dir.glob('spec/**/*_spec.rb')
-  s.require_paths = ['lib']
-
-  s.required_ruby_version = '>= 1.9.3'
-  s.required_rubygems_version = '>= 1.3.0'
-end