compass_rose 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc2d34186d25b9b5f7ba22b34c76527d6bb7d429
+  data.tar.gz: 82c63d1a56c9d7c82199a379aac952902e08dbe3
+SHA512:
+  metadata.gz: 11f6527ad55c1d692771b12956cc40447d0e4b700e0441fe835a48e39bdc4bc265785d1c66f64da7e1fb16ea26a07f1d611304f84ae9f5189a70b409fdb8db61
+  data.tar.gz: 8f654997966a3c9d55e49ed994fe618121b56d803181b73c535aee739d3c67f0333ad1f5f547c38f0addd85a9bea7a8a6bb65a0a3b9475109fcb83aeb351142f

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# misc files
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+- 2.1.1
+notifications:
+  email:
+  - t+travisci@heckman.io

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Heckman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+compass_rose
+=================
+
+A tiny gem to convert numerical bearings to their string forms.
+
+LICENSE
+-------
+`compass_rose` is released under
+[The MIT License](http://opensource.org/licenses/MIT) The full text of the
+license can be found in the `LICENSE` file. The summary can be found
+[here](https://tldrlegal.com/license/mit-license#summary) courtest of
+tldrlegal.
+
+In short, MIT is a permissive license and means you can pretty much do what you
+want with this code as long as the original copyright is included.
+
+CONTRIBUTING
+------------
+Something wrong or you want to submit an improvement? Fork the repo, make your
+changes on a feature branch, write some tests, and submit a pull request. I
+only ask that the commits have useful information and use proper/complete
+sentences.
+
+INSTALLATION
+------------
+
+```shell
+gem install compass_rose
+```
+
+Gemfile
+
+```Ruby
+gem 'compass_rose'
+```
+
+USAGE
+-----
+
+```Ruby
+require 'compass_rose'
+bearing = 232   # directional bearing
+points = 16     # the number of points the compass rose should be divided into
+d = Compass::Rose.direction(bearing, points)
+```
+
+At this point, d would contain the direction. This would be a Hash with the
+following keys:
+
+* `full` - full name of the direction, (i.e. `North by east`,
+`North-northeast`, etc.)
+* `abbr` - direction's abbrivation (i.e., `N`, `ESE`, `SWbW`, etc.)
+* `wind_pt` - the traditional wind point (i.e., `Qto Ponente verso Maestro`)
+
+Points
+------
+A compass rose can be cut in to 4 different sizes: 4, 8, 16, 32. This table
+shows which directions are available in the different sizes:
+
+|     Direction      | 4 | 8 | 16 | 32 |
+|:------------------:|:-:|:-:|:--:|:--:|
+| North              | X | X |  X |  X |
+| North by east      |   |   |    |  X |
+| North-northeast    |   |   |  X |  X |
+| Northeast by north |   |   |    |  X |
+| Northeast          |   | X |  X |  X |
+| Northeast by east  |   |   |    |  X |
+| East-northeast     |   |   |  X |  X |
+| East by north      |   |   |    |  X |
+| East               | X | X |  X |  X |
+| East by south      |   |   |    |  X |
+| East-southeast     |   |   |  X |  X |
+| Southeast by east  |   |   |    |  X |
+| Southeast          |   | X |  X |  X |
+| Southeast by south |   |   |    |  X |
+| South-southeast    |   |   |  X |  X |
+| South by east      |   |   |    |  X |
+| South              | X | X |  X |  X |
+| South by west      |   |   |    |  X |
+| South-southwest    |   |   |  X |  X |
+| Southwest by south |   |   |    |  X |
+| Southwest          |   | X |  X |  X |
+| Southwest by west  |   |   |    |  X |
+| West-southwest     |   |   |  X |  X |
+| West by south      |   |   |    |  X |
+| West               | X | X |  X |  X |
+| West by north      |   |   |    |  X |
+| West-northwest     |   |   |  X |  X |
+| Northwest by west  |   |   |    |  X |
+| Northwest          |   | X |  X |  X |
+| Northwest by north |   |   |    |  X |
+| North-northwest    |   |   |  X |  X |
+| North by west      |   |   |    |  X |

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- coding: UTF-8 -*-
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rubocop::RakeTask.new(:rubocop) do |t|
+  t.patterns =
+    %w(compass_rose.gemspec lib/**/*.rb spec/**/*.rb)
+  t.fail_on_error = true
+end
+
+task default: [:rubocop, :spec]

data/compass_rose.gemspec

@@ -0,0 +1,30 @@
+# -*- coding: UTF-8 -*-
+require 'English'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'compass_rose'
+
+Gem::Specification.new do |g|
+  g.name        = 'compass_rose'
+  g.version     = Compass::Rose::VERSION
+  g.date        = Time.now.strftime('%Y-%m-%d')
+  g.description = 'Converts bearings in degrees to human-readable names'
+  g.summary     = 'Bearings to human-readable names'
+  g.authors     = ['Tim Heckman']
+  g.email       = 't@heckman.io'
+  g.homepage    = 'https://github.com/theckman/compass_rose'
+  g.license     = 'MIT'
+
+  g.test_files  = %x(git ls-files spec/*).split
+  g.files       = %x(git ls-files).split
+
+  g.add_development_dependency 'rake', '~>10.1.0'
+  g.add_development_dependency 'rspec', '~>2.14.1'
+  g.add_development_dependency 'rubocop', '~> 0.19.0'
+  g.add_development_dependency 'fuubar', '~> 1.3.2'
+  g.add_development_dependency 'simplecov', '~> 0.8.2'
+  g.add_development_dependency 'coveralls', '~> 0.7.0'
+  g.add_development_dependency 'awesome_print', '~> 1.2.0'
+  g.add_development_dependency 'bundler', '>= 1.3'
+end

data/lib/compass_rose/direction.rb

@@ -0,0 +1,66 @@
+# -*- coding: UTF-8 -*-
+
+require 'compass_rose/rose'
+require 'compass_rose/ranges'
+
+module CompassRose
+  # Direction calculation class
+  #
+  class Direction
+    def self.calculate(bearing, points)
+      validate_bearing(bearing)
+      validate_points(points)
+      p = points_to_sym(points)
+      n = find_direction(bearing, CompassRose::RANGES[p])
+      CompassRose::ROSE[n]
+    end
+
+    private
+
+    def self.validate_bearing(bearing)
+      if ![Fixnum, Float].include?(bearing.class) ||
+         (bearing >= 360 || bearing < 0)
+        fail(ArgumentError, 'arg 1 must be a number between 0.00 and 359.99')
+      end
+    end
+
+    def self.validate_points(points)
+      if points.class != Fixnum ||
+         ![4, 8, 16, 32].include?(points)
+        fail(ArgumentError, 'arg 2 must be one of: 4, 8, 16, 32')
+      end
+    end
+
+    def self.points_to_sym(points)
+      m = { 4 => :four, 8 => :eight, 16 => :sixteen, 32 => :thirtytwo }
+      m[points]
+    end
+
+    def self.find_direction(bearing, ranges)
+      ranges.each do |k, v|
+        if v[:low] > v[:high]
+          return k if check_north(bearing, v)
+        else
+          return k if check_else(bearing, v)
+        end
+      end
+      nil
+    end
+
+    def self.check_north(bearing, ranges)
+      if bearing >= ranges[:low] || bearing <= ranges[:high]
+        true
+      else
+        false
+      end
+    end
+
+    def self.check_else(bearing, ranges)
+      if bearing >= ranges[:low] && bearing <= ranges[:high]
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/compass_rose/ranges.rb

@@ -0,0 +1,89 @@
+# -*- coding: UTF-8 -*-
+
+# Stuff
+#
+module CompassRose
+  # RoseUtils module is used to build the RANGES constant below
+  #
+  module RoseUtils
+    def self.build_rose(rose_map)
+      last_bearing = 0.00
+      h = hashit(rose_map, last_bearing)
+      h
+    end
+
+    def self.hashit(rose_map, last_bearing)
+      h = {}
+      rose_map[:d].each do |b|
+        if last_bearing == 0
+          low, high, last_bearing = bearing_zero(rose_map)
+        else
+          low, high, last_bearing = bearing_nonzero(rose_map, last_bearing)
+        end
+        h[b] = { low: low, high: high }
+      end
+      h
+    end
+
+    def self.bearing_zero(rose_map)
+      low = format(
+        '%.2f', (360.0 - (rose_map[:s] / 2.0)) + 0.01
+      ).to_f
+      last_bearing = high = format(
+        '%.2f', 0.00 + (rose_map[:s] / 2.0)
+      ).to_f
+      [low, high, last_bearing]
+    end
+
+    def self.bearing_nonzero(rose_map, last_bearing)
+      low = format('%.2f', last_bearing + 0.01).to_f
+      last_bearing = high = format('%.2f', last_bearing + rose_map[:s]).to_f
+      [low, high, last_bearing]
+    end
+  end
+  extend RoseUtils
+
+  FOUR ||= {
+    s: (360 / 4.0),
+    d: [:north, :east, :south, :west]
+  }
+
+  EIGHT ||= {
+    s: (360 / 8.0),
+    d: [
+      :north, :northeast, :east, :southeast,
+      :south, :southwest, :west, :northwest
+    ]
+  }
+
+  SIXTEEN ||= {
+    s: (360 / 16.0),
+    d: [
+      :north, :north_northeast, :northeast, :east_northeast, :east,
+      :east_southeast, :southeast, :south_southeast, :south,
+      :south_southwest, :southwest, :west_southwest, :west, :west_northwest,
+      :northwest, :north_northwest
+    ]
+  }
+
+  THIRTYTWO ||= {
+    s: (360 / 32.0),
+    d: [
+      :north, :north_by_east, :north_northeast, :northeast_by_north,
+      :northeast, :northeast_by_east, :east_northeast, :east_by_north, :east,
+      :east_by_south, :east_southeast, :southeast_by_east, :southeast,
+      :southeast_by_south, :south_southeast, :south_by_east, :south,
+      :south_by_west, :south_southwest, :southwest_by_south, :southwest,
+      :southwest_by_west, :west_southwest, :west_by_south, :west,
+      :west_by_north, :west_northwest, :northwest_by_west, :northwest,
+      :northwest_by_north, :north_northwest, :north_by_west
+    ]
+  }
+
+  RANGES ||= {
+    four: RoseUtils.build_rose(FOUR),
+    eight: RoseUtils.build_rose(EIGHT),
+    sixteen: RoseUtils.build_rose(SIXTEEN),
+    thirtytwo: RoseUtils.build_rose(THIRTYTWO)
+  }
+end

data/lib/compass_rose/rose.rb

@@ -0,0 +1,116 @@
+# -*- coding: UTF-8 -*-
+
+# Compass Rose
+#
+# Contains the ::ROSE constant which contains all points
+#
+module CompassRose
+  # obtained rose data from
+  # - https://en.wikipedia.org/wiki/Points_of_the_compass
+  #
+  ROSE ||= {
+    # when only broken in to 4 parts
+    north: { full: 'North', abbr: 'N', wind_pt: 'Tramontana' },
+    east: { full: 'East', abbr: 'E', wind_pt: 'Levante' },
+    south: { full: 'South', abbr: 'S', wind_pt: 'Ostro' },
+    west: { full: 'West', abbr: 'W', wind_pt:  'Ponente' },
+
+    # when broken in to 8 parts
+    northeast: { full: 'Northeast', abbr: 'NE', wind_pt: 'Greco' },
+    southeast: { full: 'Southeast', abbr: 'SE', wind_pt: 'Scirocco' },
+    southwest: { full: 'Southwest', abbr: 'SW', wind_pt: 'Libeccio' },
+    northwest: { full: 'Northwest', abbr: 'NW', wind_pt: 'Maestro' },
+
+    # when broken in to 16 parts
+    north_northeast: {
+      full: 'North-northeast', abbr: 'NNE', wind_pt: 'Greco-Tramontana'
+    },
+    east_northeast: {
+      full: 'East-northeast', abbr: 'ENE', wind_pt: 'Greco-Levante'
+    },
+    east_southeast: {
+      full: 'East-southeast', abbr: 'ESE', wind_pt: 'Levante-Scirocco'
+    }, # Listen up ese...
+    south_southeast: {
+      full: 'South-southeast', abbr: 'SSE', wind_pt: 'Ostro-Scirocco'
+    },
+    south_southwest: {
+      full: 'South-southwest', abbr: 'SSW', wind_pt: 'Ostro-Libeccio'
+    },
+    west_southwest: {
+      full: 'West-southwest', abbr: 'WSW', wind_pt: 'Ponente-Libeccio'
+    },
+    west_northwest: {
+      full: 'West-northwest', abbr: 'WNW', wind_pt: 'Maestro-Ponente'
+    },
+    north_northwest: {
+      full: 'North-northwest', abbr: 'NNW', wind_pt: 'Maestro-Tramontana'
+    },
+
+    # when broken in to 32 parts
+    north_by_east: {
+      full: 'North by east', abbr: 'NbE',
+      wind_pt: 'Qto Tramontana verso Greco'
+    },
+    northeast_by_north: {
+      full: 'Northeast by north', abbr: 'NEbN',
+      wind_pt: 'Qto Greco verso Tramontana'
+    },
+    northeast_by_east: {
+      full: 'Northeast by east', abbr: 'NEbE',
+      wind_pt: 'Qto Greco verso Levante'
+    },
+    east_by_north: {
+      full: 'East by north', abbr: 'EbN',
+      wind_pt: 'Qto Levante verso Greco'
+    },
+    east_by_south: {
+      full: 'East by south', abbr: 'EbS',
+      wind_pt: 'Qto Levante verso Scirocco'
+    },
+    southeast_by_east: {
+      full: 'Southeast by east', abbr: 'SEbE',
+      wind_pt: 'Qto Scirocco verso Levante'
+    },
+    southeast_by_south: {
+      full: 'Southeast by south', abbr: 'SEbS',
+      wind_pt: 'Qto Scirocco verso Ostro'
+    },
+    south_by_east: {
+      full: 'South by east', abbr: 'SbE',
+      wind_pt: 'Qto Ostro verso Scirocco'
+    },
+    south_by_west: {
+      full: 'South by west', abbr: 'SbW',
+      wind_pt: 'Qto Ostro verso Libeccio'
+    },
+    southwest_by_south: {
+      full: 'Southwest by south', abbr: 'SWbS',
+      wind_pt: 'Qto Libeccio verso Ostro'
+    },
+    southwest_by_west: {
+      full: 'Southwest by west', abbr: 'SWbW',
+      wind_pt: 'Qto Libeccio verso Ponente'
+    },
+    west_by_south: {
+      full: 'West by south', abbr: 'WbS',
+      wind_pt: 'Qto Ponente verso Libeccio'
+    },
+    west_by_north: {
+      full: 'West by north', abbr: 'WbN',
+      wind_pt: 'Qto Ponente verso Maestro'
+    },
+    northwest_by_west: {
+      full: 'Northwest by west', abbr: 'NWbW',
+      wind_pt: 'Qto Maestro verso Ponente'
+    },
+    northwest_by_north: {
+      full: 'Northwest by north', abbr: 'NWbN',
+      wind_pt: 'Qto Maestro verso Tramontana'
+    },
+    north_by_west: {
+      full: 'North by west', abbr: 'NbW',
+      wind_pt: 'Qto Tramontana verso Maestro'
+    }
+  }
+end

data/lib/compass_rose.rb

@@ -0,0 +1,38 @@
+# -*- coding: UTF-8 -*-
+# The MIT License (MIT)
+
+# Copyright (c) 2014 Tim Heckman
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'compass_rose/direction'
+require 'compass_rose/ranges'
+
+# Something
+#
+module Compass
+  # Get the direction that your bearing is on the Compass Rose
+  #
+  class Rose
+    VERSION = '0.1.0'
+    def self.direction(bearing, num_points)
+      CompassRose::Direction.calculate(bearing, num_points)
+    end
+  end
+end

data/spec/compass_rose/direction_spec.rb

@@ -0,0 +1,282 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+
+describe CompassRose::Direction do
+  let(:direction) { described_class }
+
+  context '#check_else' do
+    let(:ranges) { CompassRose::RANGES[:thirtytwo] }
+
+    it 'should accept no more than two args' do
+      expect do
+        direction.check_else(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than two args' do
+      expect do
+        direction.check_else(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return true if it is within the south range' do
+      r = ranges[:south]
+      expect(direction.check_else(180, r)).to be_true
+    end
+
+    it 'should return false if it is outside the southern range' do
+      r = ranges[:south]
+      expect(direction.check_else(0, r)).to be_false
+    end
+  end
+
+  context '#check_north' do
+    let(:ranges) { CompassRose::RANGES[:thirtytwo] }
+
+    it 'should accept no more than two args' do
+      expect do
+        direction.check_north(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than two args' do
+      expect do
+        direction.check_north(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return true if it is within the north range' do
+      r = ranges[:north]
+      expect(direction.check_north(0, r)).to be_true
+    end
+
+    it 'should return false if it is outside the north range' do
+      r = ranges[:north]
+      expect(direction.check_north(180, r)).to be_false
+    end
+  end
+
+  context '#find_direction' do
+    let(:ranges) { CompassRose::RANGES[:thirtytwo] }
+    let(:fdir) { direction.find_direction(0, ranges) }
+
+    it 'should accept no more than two args' do
+      expect do
+        direction.find_direction(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than two args' do
+      expect do
+        direction.find_direction(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return a symbol' do
+      expect(fdir).to be_an_instance_of Symbol
+    end
+
+    it 'should return the proper direction' do
+      expect(direction.find_direction(90, ranges)).to eql :east
+    end
+  end
+
+  context '#points_to_sym' do
+    it 'should accept no more than one arg' do
+      expect do
+        direction.points_to_sym(nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than one arg' do
+      expect do
+        direction.points_to_sym
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return a symbol' do
+      expect(direction.points_to_sym(4)).to be_an_instance_of Symbol
+    end
+
+    it 'should return :four for 4' do
+      expect(direction.points_to_sym(4)).to eql :four
+    end
+
+    it 'should return :eight for 8' do
+      expect(direction.points_to_sym(8)).to eql :eight
+    end
+
+    it 'should return :four for 16' do
+      expect(direction.points_to_sym(16)).to eql :sixteen
+    end
+
+    it 'should return :four for 32' do
+      expect(direction.points_to_sym(32)).to eql :thirtytwo
+    end
+  end
+
+  context '#validate_points' do
+    let(:vp) { direction.validate_points(4) }
+
+    it 'should accept no more than one arg' do
+      expect do
+        direction.validate_points(nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than one arg' do
+      expect do
+        direction.validate_points
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return nil' do
+      expect(vp).to be_nil
+    end
+
+    it 'should raise ArgumentError when passed invalid Fixnum' do
+      expect do
+        direction.validate_points(370)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a String' do
+      expect do
+        direction.validate_points('')
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed nil' do
+      expect do
+        direction.validate_points(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a symbol' do
+      expect do
+        direction.validate_points(:x)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a Float' do
+      expect do
+        direction.validate_points(0.0)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a Array' do
+      expect do
+        direction.validate_points([])
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a Hash' do
+      expect do
+        direction.validate_points({})
+      end.to raise_error ArgumentError
+    end
+  end
+
+  context '#validate_bearing' do
+    let(:vb) { direction.validate_bearing(0) }
+
+    it 'should accept no more than one arg' do
+      expect do
+        direction.validate_bearing(nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than one arg' do
+      expect do
+        direction.validate_bearing
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return nil' do
+      expect(vb).to be_nil
+    end
+
+    it 'should raise ArgumentError when passed invalid Fixnum' do
+      expect do
+        direction.validate_bearing(370)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a String' do
+      expect do
+        direction.validate_bearing('')
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed nil' do
+      expect do
+        direction.validate_bearing(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a symbol' do
+      expect do
+        direction.validate_bearing(:x)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a Array' do
+      expect do
+        direction.validate_bearing([])
+      end.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError if passed a Hash' do
+      expect do
+        direction.validate_bearing({})
+      end.to raise_error ArgumentError
+    end
+  end
+
+  context '#calculate' do
+    let(:c) { direction.calculate(0, 32) }
+
+    it 'should accept no more than two args' do
+      expect do
+        direction.calculate(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should accept no less than two args' do
+      expect do
+        direction.calculate(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return a Hash' do
+      expect(c).to be_an_instance_of Hash
+    end
+
+    it 'should have the :full key' do
+      expect(c.key?(:full)).to be_true
+    end
+
+    it 'should have :full String' do
+      expect(c[:full]).to be_an_instance_of String
+      expect(c[:full].empty?).to be_false
+    end
+
+    it 'should have the :abbr key' do
+      expect(c.key?(:abbr)).to be_true
+    end
+
+    it 'should have :abbr String' do
+      expect(c[:abbr]).to be_an_instance_of String
+      expect(c[:abbr].empty?).to be_false
+    end
+
+    it 'should have the :wind_pt key' do
+      expect(c.key?(:wind_pt)).to be_true
+    end
+
+    it 'should have :wind_pt String' do
+      expect(c[:wind_pt]).to be_an_instance_of String
+      expect(c[:wind_pt].empty?).to be_false
+    end
+  end
+end

data/spec/compass_rose/ranges.rb

@@ -0,0 +1,15 @@
+# -*- coding: UTF-8 -*-
+
+shared_examples 'CompassRose::Ranges' do
+  it ' should be an instance of Hash ' do
+    expect(subject).to be_an_instance_of Hash
+  end
+
+  it 'should have the :s key' do
+    expect(subject.key?(:s)).to be_true
+  end
+
+  it 'should ha3ve the :d key' do
+    expect(subject.key?(:d)).to be_true
+  end
+end

data/spec/compass_rose/ranges_spec.rb

@@ -0,0 +1,181 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+require_relative 'ranges'
+
+describe CompassRose::RoseUtils do
+  before do
+    @lb = 343.12
+    @m = CompassRose::THIRTYTWO
+  end
+
+  context '#bearing_nonzero' do
+    it 'should take no more than two args' do
+      expect do
+        CompassRose::RoseUtils.bearing_nonzero(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should take no less than two args' do
+      expect do
+        CompassRose::RoseUtils.bearing_nonzero(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return an Array' do
+      b = CompassRose::RoseUtils.bearing_nonzero(@m, @lb)
+      expect(b).to be_an_instance_of Array
+    end
+
+    it 'should return the correct values' do
+      b = CompassRose::RoseUtils.bearing_nonzero(@m, @lb)
+      expect(b[0]).to eql(@lb + 0.01)
+      expect(b[1]).to eql(@lb + 11.25)
+      expect(b[2]).to eql(@lb + 11.25)
+    end
+  end
+
+  context '#bearing_zero' do
+
+    it 'should take no more one arg' do
+      expect do
+        CompassRose::RoseUtils.bearing_zero(nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should take no less than one arg' do
+      expect do
+        CompassRose::RoseUtils.bearing_zero
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return an Array' do
+      b = CompassRose::RoseUtils.bearing_zero(@m)
+      expect(b).to be_an_instance_of Array
+    end
+
+    it 'should return the correct values' do
+      b = CompassRose::RoseUtils.bearing_zero(@m)
+      expect(b[0]).to eql 354.38
+      expect(b[1]).to eql 5.62
+      expect(b[2]).to eql 5.62
+    end
+  end
+
+  context '#hashit' do
+    let(:hit) { CompassRose::RoseUtils.hashit(@m, 0.00) }
+
+    it 'should take no more than two args' do
+      expect do
+        CompassRose::RoseUtils.hashit(nil, nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should take no less than two args' do
+      expect do
+        CompassRose::RoseUtils.hashit(nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return a Hash' do
+      expect(hit).to be_an_instance_of Hash
+    end
+
+    it 'should have each key should be a hash' do
+      hit.each do |k, v|
+        expect(v).to be_an_instance_of Hash
+      end
+    end
+
+    it 'should have the :low key' do
+      hit.each do |k, v|
+        expect(v.key?(:low)).to be_true
+      end
+    end
+
+    it 'should have the :high key' do
+      hit.each do |k, v|
+        expect(v.key?(:high)).to be_true
+      end
+    end
+  end
+
+  context '#build_rose' do
+    let(:br) { CompassRose::RoseUtils.build_rose(@m) }
+
+    it 'should take no more than one arg' do
+      expect do
+        CompassRose::RoseUtils.build_rose(nil, nil)
+      end.to raise_error ArgumentError
+    end
+
+    it 'should take no less than one arg' do
+      expect do
+        CompassRose::RoseUtils.build_rose
+      end.to raise_error ArgumentError
+    end
+
+    it 'should return a Hash' do
+      expect(br).to be_an_instance_of Hash
+    end
+  end
+end
+
+describe CompassRose::FOUR do
+  subject { CompassRose::FOUR }
+  it_should_behave_like 'CompassRose::Ranges'
+end
+
+describe CompassRose::EIGHT do
+  subject { CompassRose::EIGHT }
+  it_should_behave_like 'CompassRose::Ranges'
+end
+
+describe CompassRose::SIXTEEN do
+  subject { CompassRose::SIXTEEN }
+  it_should_behave_like 'CompassRose::Ranges'
+end
+
+describe CompassRose::THIRTYTWO do
+  subject { CompassRose::THIRTYTWO }
+  it_should_behave_like 'CompassRose::Ranges'
+end
+
+describe CompassRose::RANGES do
+  subject { CompassRose::RANGES }
+
+  it 'should be an instance of Hash' do
+    expect(subject).to be_an_instance_of Hash
+  end
+
+  it 'should have the :four key' do
+    expect(subject.key?(:four)).to be_true
+  end
+
+  it 'should have a :four key which is a Hash' do
+    expect(subject[:four]).to be_an_instance_of Hash
+  end
+
+  it 'should have the :eight key' do
+    expect(subject.key?(:eight)).to be_true
+  end
+
+  it 'should have an :eight key which is a Hash' do
+    expect(subject[:eight]).to be_an_instance_of Hash
+  end
+
+  it 'should have the :sixteen key' do
+    expect(subject.key?(:sixteen)).to be_true
+  end
+
+  it 'should have a :sixteen key which is a Hash' do
+    expect(subject[:sixteen]).to be_an_instance_of Hash
+  end
+
+  it 'should have the :thirtytwo key' do
+    expect(subject.key?(:thirtytwo)).to be_true
+  end
+
+  it 'should have a :thirtytwo key which is a Hash' do
+    expect(subject[:thirtytwo]).to be_an_instance_of Hash
+  end
+end

data/spec/compass_rose/rose_spec.rb

@@ -0,0 +1,41 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+require 'ap'
+
+TRUSTED_KEYS ||= [
+  :north, :east, :south, :west, :northeast, :southeast, :southwest, :northwest,
+  :north_northeast, :east_northeast, :east_southeast, :south_southeast,
+  :south_southwest, :west_southwest, :west_northwest, :north_northwest,
+  :north_by_east, :northeast_by_north, :northeast_by_east, :east_by_north,
+  :east_by_south, :southeast_by_east, :southeast_by_south, :south_by_east,
+  :south_by_west, :southwest_by_south, :southwest_by_west, :west_by_south,
+  :west_by_north, :northwest_by_west, :northwest_by_north, :north_by_west
+]
+
+describe CompassRose::ROSE do
+  subject { CompassRose::ROSE }
+
+  it { should be_an_instance_of Hash }
+
+  TRUSTED_KEYS.each do |k|
+    it "should contain the #{k} key" do
+      expect(subject.key?(k)).to be_true
+    end
+
+    it "should contain the #{k} Hash" do
+      expect(subject[k]).to be_an_instance_of Hash
+    end
+
+    it "should contain the #{k} Hash and it should have the :full key" do
+      expect(subject[k].key?(:full)).to be_true
+    end
+
+    it "should contain the #{k} Hash and it should have the :abbr key" do
+      expect(subject[k].key?(:abbr)).to be_true
+    end
+
+    it "should contain the #{k} Hash and it should have the :wind_pt key" do
+      expect(subject[k].key?(:wind_pt)).to be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# -*- coding: UTF-8 -*-
+# -*- coding: UTF-8 -*-
+require 'rspec'
+require 'simplecov'
+require 'coveralls'
+
+$LOAD_PATH.unshift '.' unless $LOAD_PATH.include?('.')
+
+def repo_root
+  File.expand_path('../../..', __FILE__)
+end
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'compass_rose'

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: compass_rose
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Heckman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Converts bearings in degrees to human-readable names
+email: t@heckman.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- compass_rose.gemspec
+- lib/compass_rose.rb
+- lib/compass_rose/direction.rb
+- lib/compass_rose/ranges.rb
+- lib/compass_rose/rose.rb
+- spec/compass_rose/direction_spec.rb
+- spec/compass_rose/ranges.rb
+- spec/compass_rose/ranges_spec.rb
+- spec/compass_rose/rose_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/theckman/compass_rose
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bearings to human-readable names
+test_files:
+- spec/compass_rose/direction_spec.rb
+- spec/compass_rose/ranges.rb
+- spec/compass_rose/ranges_spec.rb
+- spec/compass_rose/rose_spec.rb
+- spec/spec_helper.rb