compass_point 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 572d6a5c62a94371ac1cfc51a9159a6210a4a7c6
-  data.tar.gz: 662e06d62053664bdce6e7077dd705677a8a22bb
+  metadata.gz: 8e46d4553f9de5ae11fab63be88ffea5b32b21b1
+  data.tar.gz: 9103ff880351b8f3469e912d27fcd351dc9b34e5
 SHA512:
-  metadata.gz: d513cf9a90db8df32d9610fd57c44f2fd3f32d54ca2f98799cf144ca35511a4962fe6f8fb8c5d756bb2641c13efd5292544392d5646cccdad9de70da4d4a6462
-  data.tar.gz: be80b30a04996483a29afc9cb55678f215ac2522f6c49804a43afc3147131e73f215f60342b9cdc34a1c4728649bbd93d0697d7c151deb6f4b9a5ac70c31cba3
+  metadata.gz: 3060a1b29300b947838f00e6d4083f0985b11bbc90b16c0840addf77bd83f4e2e58c205708cbe4e3e551bb91aa78788bb2090bb25057e49935ac06cb8dc64f85
+  data.tar.gz: 03e91329bc09f28df2bff07a1584fbbe1f5b1cbe4fa422d9a966bd03c0d7e76aad81071df579abde78ac300875ec1f8b453ce97c30adcf2e0c9fc04c1f5387e8

data/Gemfile.travis

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

data/README.md

@@ -21,12 +21,13 @@ Compass Point is tested to work with the following versions of ruby:
 
 ## Installation
 
-```
-gem install compass_point
-```
+    gem install compass_point
 
 ## Basic Usage
 
+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
@@ -34,6 +35,14 @@ gem install compass_point
     CompassPoint.azimuth('swbs') #=> 213.75
 
 
+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_max('E') #=> [84.38, 95.62]
+
+
 ## License
 
 Copyright (c) 2015 Keith Morrison <<keithm@infused.org>>

data/Rakefile

@@ -0,0 +1,18 @@
+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/lib/compass_point.rb

@@ -1,5 +1,5 @@
 class CompassPoint
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 
   POINTS = {
     n:    {min: 354.38, mid: 0.0,    max: 5.62},
@@ -37,15 +37,33 @@ class CompassPoint
   }
 
   class << self
-    def azimuth(compass_point)
-      key = normalize_key(compass_point)
+    def azimuth(abbreviation)
+      key = normalize_abbreviation(abbreviation)
       point = POINTS[key]
       point && point[:mid]
     end
 
+    def min(abbreviation)
+      key = normalize_abbreviation(abbreviation)
+      point = POINTS[key]
+      point && point[:min]
+    end
+
+    def max(abbreviation)
+      key = normalize_abbreviation(abbreviation)
+      point = POINTS[key]
+      point && point[:max]
+    end
+
+    def min_max(abbreviation)
+      key = normalize_abbreviation(abbreviation)
+      point = POINTS[key]
+      point && [point[:min], point[:max]]
+    end
+
     private
 
-    def normalize_key(compass_point)
+    def normalize_abbreviation(compass_point)
       compass_point.to_s.downcase.to_sym
     end
   end

data/spec/compass_point_spec.rb

@@ -2,8 +2,7 @@ require 'spec_helper'
 
 describe CompassPoint do
   describe '.azimuth' do
-
-    it 'returns mid point' 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
@@ -11,4 +10,31 @@ describe CompassPoint do
     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
+    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
+    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
+    end
+  end
+
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compass_point
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Keith Morrison
@@ -20,9 +20,12 @@ extra_rdoc_files:
 files:
 - Gemfile
 - Gemfile.lock
+- Gemfile.travis
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
+- compass_point-1.0.0.gem
 - compass_point.gemspec
 - lib/compass_point.rb
 - spec/compass_point_spec.rb