compass_point 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 727e4aee92e7e31485a86c41370debef6bf3566b
-  data.tar.gz: 9387617d7472f9189340bec7358f8ac8d51d8d57
+  metadata.gz: 05c895cb0f48a2861a8287f21fe2c065754f28a4
+  data.tar.gz: 106814cdb998938219bff0e642fec12df38851f0
 SHA512:
-  metadata.gz: 98c507d29befc7025b5f9437723fcda5d22e7a69cbe023db5b9495b69100212c02ea8a55aaf4e6690eb5cda538feab2f2e12d17a4ad9d072055fe767dbf88dcd
-  data.tar.gz: 2af0ff531e642802bb8f2ce1204eeb3f69bc5449bdd936d5533373d1412fbe8047c97228a077c712e6ce60eeeb513d8cdef99a93cf1f10a61abb7c244d960dd4
+  metadata.gz: d25f6cc323c2ea6f32487f71699e0d030803108381e84aea8c760ea6511222a0013a91c0e232098cc6c084d852da6e3aff9f525e28dea5b006cc01defd553fb9
+  data.tar.gz: d47fea9fdc254a7aa5717f67011b03513bbc5ce901d45d7e90e8cae9dc361f21f77d73db3f620f261deac1a54f16d2c3da32afd477b8d568936453cc1163585c

data/Gemfile.lock

@@ -71,3 +71,6 @@ DEPENDENCIES
   guard
   guard-rspec
   rspec
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -4,8 +4,11 @@
 [![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/)
 
-A Ruby library for working with compass points
+A Ruby library for working with compass points.
+
+![Compass Rose](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Compass_Rose_English_North.svg/237px-Compass_Rose_English_North.svg.png)
 
 * Project page: <http://github.com/infused/compass_point>
 * API Documentation: <http://rubydoc.info/github/infused/compass_point/>
@@ -15,9 +18,8 @@ A Ruby library for working with compass points
 
 Compass Point is tested to work with the following versions of ruby:
 
-* MRI Ruby 1.9.3, 2.0.x, 2.1.x, 2.2.x
+* MRI Ruby 2.0.x, 2.1.x, 2.2.x
 * JRuby 1.7.x
-* Rubinius 2.1+
 
 ## Installation
 
@@ -25,11 +27,11 @@ Compass Point is tested to work with the following versions of ruby:
 
 ## Basic Usage
 
+### Azimuth
+
 Given an abbreviation such as "NW" or "SE", `azimuth` will
 return the corresponding azimuth in degrees from 0 to 360:
 
-    require 'compass_point'
-
     CompassPoint.azimuth('N') #=> 0.0
     CompassPoint.azimuth('S') #=> 180.0
     CompassPoint.azimuth('swbs') #=> 213.75
@@ -48,6 +50,15 @@ Get the full name for an abbreviation:
     CompassPoint.name('SEbS') #=> "Southeast by south"
 
 
+### Compass Quadrant Bearing
+
+Given an azimuth, calculate the compass quadrant bearing.  For
+example:
+
+    CompassPoint.compass_quadrant_bearing(103) #=> "S 77° E"
+    CompassPoint.compass_quadrant_bearing(340) #=> "N 20° W"
+    CompassPoint.compass_quadrant_bearing(0) #=> "N"
+
 ## License
 
 Copyright (c) 2015 Keith Morrison <<keithm@infused.org>>

data/lib/compass_point.rb

@@ -1,5 +1,5 @@
 class CompassPoint
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 
   POINTS = {
     n:    {min: 354.38, mid: 0.0,    max: 5.62,   name: 'North'},
@@ -62,8 +62,51 @@ class CompassPoint
       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'
+      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(' ')
+      end
+    end
+
     private
 
+    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
+    end
+
+    def east_or_west(bearing)
+      b = bearing.round
+      (180..360).include?(b.to_i) ? 'W' : 'E'
+    end
+
     def find_point(abbrev)
       key = normalize_abbrev(abbrev)
       POINTS[key]

data/spec/compass_point_spec.rb

@@ -43,4 +43,22 @@ describe CompassPoint do
     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'
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compass_point
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Keith Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-10-27 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-1.0.2.gem
 - compass_point.gemspec
 - lib/compass_point.rb
 - spec/compass_point_spec.rb
@@ -51,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby library for working with compass points