grid_square 0.0.1

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use ruby-1.9.3@grid_square --create

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+before_install:
+  - gem install bundler
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gem "rspec"
+gem "rspec-given"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-given (1.5.1)
+      rspec (> 1.2.8)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  rspec-given

data/README.md

@@ -0,0 +1,75 @@
+# GridSquare
+
+Calculate between GridSquare references and latitude/longitude.
+
+```
+grid = GridSquare.new "DN40bi"
+
+grid.center
+# => #<Location:0x000001008514d8 @longitude=-109.20833333333333, @latitude=41.6875>
+
+grid.width
+# => 0.08333333333333333
+
+grid.height
+# => 0.041666666666666664
+
+GridSquare.encode(-111.866785, 40.363840).subsquare
+# => "DN40bi"
+
+# With arbitrary precision: specify the number of fields
+GridSquare.encode(-111.866785, 40.363840, 10).grid_reference
+# => "DN40BI57XH67OE24bd98"
+```
+
+
+# How the US GridSquare System Works
+
+Okay in theory the GridSquare system is really complicated. But in
+practice is just base conversion to a number that has a changing
+radix. The first pair of digits are base 18, and the following pairs
+alternate between base 10 and base 24.
+
+Here's how it works:
+
+The first two letters of a grid reference express the longitude and
+latitude in base 18 (A through R). This pair of letters divides up the
+whole planet into 18 equal "fields", each field being 10 degrees high
+(latitude) and 20 degrees wide (longitude).
+
+The next two digits are decimals that divide up each field into 10x10
+"squares" (that's their name; they're obviously not square or even
+rectangular). Squares are 2 degrees wide and 1 degree tall.
+
+The next two letters are base 24 (A through X) and divide each square
+into 24x24 "subsquares". Each subsquare is 5 minutes wide and 2.5
+minutes tall.
+
+The next two digits are decimals. The official spec calls this the
+"extended subsquare".
+
+Officially the locator system stops at extended subsquares (8 digits)
+but unofficially it can be extended by repeating the base 10, base 24
+pairs indefinitely to give precision to the subatomic level and
+beyond. This is of course quite silly as the whole system is based on
+the notion of a spherical earth and the point of the system is to
+economically tell a complete stranger approximately where in the world
+the person they are talking to is located.
+
+By convention, the code is capitalized except for the last 2 letters,
+though the first two characters are always capitalized.
+
+
+# Who Uses this Crap?
+
+Ham Radio operators use them to quickly exchange approximate location.
+By convention, shortwave operators give their location in squares
+while VHF and UHF operators give their location in subsquares. A
+square has a precision of about 280km; subsquares give a location to
+within 12km.
+
+
+# Really?
+
+Yes. It even has an amusing name, the Maidenhead Locator System:
+http://en.wikipedia.org/wiki/Maidenhead_Locator_System

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/grid_square.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grid_square/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "grid_square"
+  gem.version       = GridSquare::VERSION
+  gem.authors       = ["Graham McIntire", "David Brady"]
+  gem.email         = ["gmcintire@gmail.com"]
+  gem.description   = %q{Encode/decode between lat/lng locations and US GridSquare references}
+  gem.summary       = %q{Encode/decode between lat/lng locations and US GridSquare references}
+  gem.homepage      = "https://github.com/gmcintire/grid_square"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/grid_square/version.rb

@@ -0,0 +1,3 @@
+module GridSquare
+  VERSION = "0.0.1"
+end

data/lib/grid_square.rb

@@ -0,0 +1,76 @@
+#require 'location'
+#require 'radix_enumerator'
+#require 'string_ext'
+
+class GridSquare
+  attr_reader :grid_reference, :origin
+
+  # location can be a string containing a GS reference or a pair
+  # containing longitude and latitude.
+  def initialize(grid_reference)
+    @grid_reference = grid_reference
+    decode
+  end
+
+  def self.encode(longitude, latitude, precision=4 )
+    longitude += 180
+    latitude += 90
+    radixes = RadixEnumerator.new
+    grid_reference = ''
+    size = Location.new(360.0, 180.0)
+    precision.times do
+      zero,radix = *radixes.next
+
+      lng = (radix * longitude / size.longitude).floor
+      lat = (radix * latitude / size.latitude).floor
+
+      grid_reference += "%s%s" % [(zero + lng).chr, (zero + lat).chr]
+      size /= radix
+      longitude -= lng * size.longitude
+      latitude -= lat * size.latitude
+    end
+
+    new grid_reference.downcase_last
+  end
+
+  # Maidenhead locator names
+  def field; precision 1; end
+  def square; precision 2; end
+  def subsquare; precision 3; end
+  def extended_subsquare; precision 4; end
+
+  # Return code to a given number of 2-digit fields
+  def precision(num_fields)
+    raise IndexError.new "GridSquare.square: insufficient precision to index #{num_fields} fields" unless grid_reference.length >= num_fields * 2
+    grid_reference[0...num_fields*2].downcase_last
+  end
+
+  def decode
+    radixes = RadixEnumerator.new
+    @origin, @size = Location.new(-180.0, -90.0), Location.new(360.0, 180.0)
+
+    @grid_reference.upcase.chars.each_slice(2) do |lng, lat|
+      zero, radix = *radixes.next
+      @size /= radix
+      @origin += Location.new(@size.longitude * (lng.ord - zero), @size.latitude * (lat.ord - zero))
+    end
+  end
+
+  def width; @size.longitude; end
+  def height; @size.latitude; end
+
+  def left; @origin.longitude; end
+  def bottom; @origin.latitude; end
+  def top; (@origin + @size).latitude; end
+  def right; (@origin + @size).longitude; end
+
+  alias :west :left
+  alias :south :bottom
+  alias :east :right
+  alias :north :top
+
+  def center
+    @origin + @size/2
+  end
+end
+

data/lib/location.rb

@@ -0,0 +1,24 @@
+module GridSquare
+  class Location
+    attr_accessor :longitude, :latitude
+    def initialize(longitude, latitude)
+      @longitude, @latitude = longitude, latitude
+    end
+
+    def /(scalar)
+      Location.new longitude/scalar, latitude/scalar
+    end
+
+    def *(scalar)
+      Location.new longitude*scalar, latitude*scalar
+    end
+
+    def +(other)
+      Location.new longitude+other.longitude, latitude+other.latitude
+    end
+
+    def -(other)
+      Location.new longitude-other.longitude, latitude-other.latitude
+    end
+  end
+end

data/lib/radix_enumerator.rb

@@ -0,0 +1,12 @@
+module GridSquare
+  class RadixEnumerator
+    def next
+      if @enum.nil?
+        @enum = ([["0".ord, 10], [?A.ord, 24]]).cycle
+        [?A.ord, 18]
+      else
+        @enum.next
+      end
+    end
+  end
+end

data/lib/string_ext.rb

@@ -0,0 +1,9 @@
+class String
+  def downcase_last
+    if length > 4
+      self[0...-4].upcase + self[-4..-1].downcase
+    else
+      upcase
+    end
+  end
+end

data/spec/lib/grid_square_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require_relative "../../lib/grid_square"
+
+describe GridSquare do
+  context "created from field" do
+    Given(:grid_square) { GridSquare.new "DN" }
+
+    Then { grid_square.field.should == "DN" }
+    Then { lambda { grid_square.square }.should raise_error(IndexError) }
+    Then { lambda { grid_square.subsquare }.should raise_error(IndexError) }
+    Then { lambda { grid_square.extended_subsquare.should }.should raise_error(IndexError) }
+    Then { lambda { grid_square.precision 10 }.should raise_error(IndexError) }
+
+    Then { grid_square.west.should be_within(0.00001).of -120.0 }
+    Then { grid_square.south.should be_within(0.00001).of 40.0 }
+    Then { grid_square.north.should be_within(0.00001).of 50.0 }
+    Then { grid_square.east.should be_within(0.00001).of -100.0 }
+
+    Then { grid_square.width.should be_within(0.00001).of 20.0 }
+    Then { grid_square.height.should be_within(0.00001).of 10.0 }
+
+    Then { grid_square.center.longitude.should be_within(0.00001).of -110.0 }
+    Then { grid_square.center.latitude.should be_within(0.00001).of 45.0 }
+  end
+
+  context "created from square" do
+    Given(:grid_square) { GridSquare.new "DN41" }
+
+    Then { grid_square.field.should == "DN" }
+    Then { grid_square.square.should == "DN41" }
+    Then { lambda { grid_square.subsquare.should == "DN41bi" }.should raise_error(IndexError) }
+    Then { lambda { grid_square.extended_subsquare.should }.should raise_error(IndexError) }
+    Then { lambda { grid_square.precision 10 }.should raise_error(IndexError) }
+
+    Then { grid_square.west.should be_within(0.00001).of -112.0 }
+    Then { grid_square.south.should be_within(0.00001).of 41.0 }
+
+    Then { grid_square.width.should be_within(0.00001).of 2.0 }
+    Then { grid_square.height.should be_within(0.00001).of 1.0 }
+
+    Then { grid_square.center.longitude.should be_within(0.00001).of -111.0 }
+    Then { grid_square.center.latitude.should be_within(0.00001).of 41.5 }
+  end
+
+  context "created from subsquare" do
+    Given(:grid_square) { GridSquare.new "DN41bi" }
+
+    Then { grid_square.field.should == "DN" }
+    Then { grid_square.square.should == "DN41" }
+    Then { grid_square.subsquare.should == "DN41bi" }
+    Then { lambda { grid_square.extended_subsquare.should }.should raise_error(IndexError) }
+    Then { lambda { grid_square.precision 10 }.should raise_error(IndexError) }
+
+    Then { grid_square.west.should be_within(0.00001).of -111.91666 }
+    Then { grid_square.south.should be_within(0.00001).of 41.33333 }
+
+    Then { grid_square.width.should be_within(0.00001).of 0.083333 }
+    Then { grid_square.height.should be_within(0.00001).of 0.041666 }
+
+    Then { grid_square.center.longitude.should be_within(0.00001).of -111.875 }
+    Then { grid_square.center.latitude.should be_within(0.00001).of 41.35416 }
+  end
+
+  context "created from extended subsquare" do
+    Given(:grid_square) { GridSquare.new "DN41bi63" }
+
+    Then { grid_square.field.should == "DN" }
+    Then { grid_square.square.should == "DN41" }
+    Then { grid_square.subsquare.should == "DN41bi" }
+    Then { grid_square.extended_subsquare.should == "DN41bi63" }
+    Then { lambda { grid_square.precision 10 }.should raise_error(IndexError) }
+
+    Then { grid_square.west.should be_within(0.00001).of -111.86666 }
+    Then { grid_square.south.should be_within(0.00001).of 41.34583 }
+
+    Then { grid_square.width.should be_within(0.00001).of 0.0083333 }
+    Then { grid_square.height.should be_within(0.00001).of 0.0041666 }
+
+    Then { grid_square.center.longitude.should be_within(0.00001).of -111.8625 }
+    Then { grid_square.center.latitude.should be_within(0.00001).of 41.34792 }
+  end
+
+  context "proper field casing" do
+    Given(:upper) { GridSquare.new "DN41BI83QR" }
+    Given(:lower) { GridSquare.new "dn41bi83qr" }
+
+    Then { upper.field.should == "DN" }
+    Then { upper.square.should == "DN41" }
+    Then { upper.subsquare.should == "DN41bi" }
+    Then { upper.precision(4).should == "DN41bi83" }
+
+    Then { lower.field.should == "DN" }
+    Then { lower.square.should == "DN41" }
+    Then { lower.subsquare.should == "DN41bi" }
+    Then { lower.precision(4).should == "DN41bi83" }
+  end
+
+  context "created from a ridiculously long GridSquare code" do
+    Given(:ludicrous) { GridSquare.new "RN91SK59MC07FQ84VK31SM03PF57XS16DU32MS24LX34EI48RQ28CS09MA87VO18GS16WK64JL24XF21KJ12FO37RJ73QL28IU39AS55HC86SW74JD70VQ61SF52QA21SD28GB60HT40SN34VG10NP11TP27CR36OA76LD28TI36JE73TF03OT41UH60IX96IH80HX45KC53SJ57AF07HQ38NI74WT84LP33UQ34OP06TV69IA96LB80VW57MV04SJ88AV74GO73JW26BF53DE74BH31EV57WP25WO98IL47BT13AD44WC66BL08IA01KN55FV05EI50KM77HV72LF21NG51XI69QW28PO80FW77AI36BE19ID25JR96KA39DA28LK83PL86TP85AH21LB31NF52BQ06WJ64AQ05XK16RJ16SP96KE85BU61BS68OK10HC39QH86XB51PO62RA27JH93PM08NF46XS98HN76LJ55KQ68AQ34JR96OF09DJ13NP76BP09AP83MK60SE83FX63OS03AG31HA46KB00QF06LU66DX71PH65WU26IF88AO21LE62DI34GF23hc34" }
+    Then { ludicrous.field.should == "RN" }
+    Then { ludicrous.square.should == "RN91" }
+    Then { ludicrous.subsquare.should == "RN91sk" }
+    Then { ludicrous.extended_subsquare.should == "RN91sk59" }
+    Then { lambda { ludicrous.precision 301 }.should raise_error(IndexError) }
+  end
+
+  describe ".encode" do
+    Given(:grid_square) { GridSquare.encode -111.866785, 40.363840 }
+
+    Then { grid_square.grid_reference.should == "DN40bi57" }
+
+    context "with precision" do
+      Given(:grid_square) { GridSquare.encode -111.866785, 40.363840, 10 }
+
+      Then { grid_square.grid_reference.should == "DN40BI57XH67OE24bd98" }
+    end
+  end
+end

data/spec/lib/location_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require_relative '../../lib/location'
+
+module GridSquare
+  describe Location do
+    # We can use Locations to represent exact points...
+    Given(:origin) { Location.new 0.0, 0.0 }
+
+    # Or spans/sizes
+    Given(:window) { Location.new -180.0, -90.0 }
+
+    Then { window.longitude.should be_within(0.000001).of -180.0 }
+    Then { window.latitude.should be_within(0.000001).of -90.0 }
+
+    context "translation +" do
+      Given(:new_origin) { origin + Location.new(50.0, 40.0) }
+      Then { new_origin.longitude.should be_within(0.000001).of 50.0 }
+      Then { new_origin.latitude.should be_within(0.000001).of 40.0 }
+    end
+
+    context "translation -" do
+      Given(:new_origin) { origin - Location.new(50.0, 40.0) }
+      Then { new_origin.longitude.should be_within(0.000001).of -50.0 }
+      Then { new_origin.latitude.should be_within(0.000001).of -40.0 }
+    end
+
+    context "scaling *" do
+      Given(:new_window) { window * 2 }
+      Then { new_window.longitude.should be_within(0.000001).of -360.0 }
+      Then { new_window.latitude.should be_within(0.000001).of -180.0 }
+    end
+
+    context "scaling /" do
+      Given(:new_window) { window / 2 }
+      Then { new_window.longitude.should be_within(0.000001).of -90.0 }
+      Then { new_window.latitude.should be_within(0.000001).of -45.0 }
+    end
+  end
+end

data/spec/lib/radix_enumerator_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require_relative '../../lib/radix_enumerator'
+
+module GridSquare
+  describe RadixEnumerator do
+    Given(:radix) { RadixEnumerator.new }
+
+    Then {
+      radix.next[0].should == ?A.ord
+      radix.next[0].should == "0".ord
+      radix.next[0].should == ?A.ord
+      radix.next[0].should == "0".ord
+      radix.next[0].should == ?A.ord
+      radix.next[0].should == "0".ord
+      radix.next[0].should == ?A.ord
+      radix.next[0].should == "0".ord
+      radix.next[0].should == ?A.ord
+    }
+
+    Then {
+      radix.next[1].should == 18
+      radix.next[1].should == 10
+      radix.next[1].should == 24
+      radix.next[1].should == 10
+      radix.next[1].should == 24
+      radix.next[1].should == 10
+      radix.next[1].should == 24
+      radix.next[1].should == 10
+      radix.next[1].should == 24
+    }
+  end
+end

data/spec/lib/string_ext_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require_relative "../../lib/string_ext"
+
+describe String do
+  describe "#downcase_last" do
+    context "field" do
+      Given(:upper) { "DN" }
+      Given(:lower) { "dn" }
+
+      Then { upper.downcase_last.should == "DN" }
+      Then { lower.downcase_last.should == "DN" }
+    end
+
+    context "ending in digits" do
+      Given(:upper) { "DN41BI83" }
+      Given(:lower) { "dn41bi83" }
+
+      Then { upper.downcase_last.should == "DN41bi83" }
+      Then { lower.downcase_last.should == "DN41bi83" }
+    end
+
+    context "subsquare or longer" do
+      Given(:upper) { "DN41BI83QR" }
+      Given(:lower) { "dn41bi83qr" }
+
+      Then { upper.downcase_last.should == "DN41BI83qr" }
+      Then { lower.downcase_last.should == "DN41BI83qr" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rspec-given"

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: grid_square
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Graham McIntire
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-16 00:00:00.000000000 Z
+dependencies: []
+description: Encode/decode between lat/lng locations and US GridSquare references
+email:
+- gmcintire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- grid_square.gemspec
+- lib/grid_square.rb
+- lib/grid_square/version.rb
+- lib/location.rb
+- lib/radix_enumerator.rb
+- lib/string_ext.rb
+- spec/lib/grid_square_spec.rb
+- spec/lib/location_spec.rb
+- spec/lib/radix_enumerator_spec.rb
+- spec/lib/string_ext_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gmcintire/grid_square
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Encode/decode between lat/lng locations and US GridSquare references
+test_files:
+- spec/lib/grid_square_spec.rb
+- spec/lib/location_spec.rb
+- spec/lib/radix_enumerator_spec.rb
+- spec/lib/string_ext_spec.rb
+- spec/spec_helper.rb