maidenhead 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad8ea73a10da985b1a7306998b711cae38c95310
+  data.tar.gz: ceb9292ef5f7e0d77d63e44e4c524124218a221c
+SHA512:
+  metadata.gz: e73f5f0cf8657d206cb5675169d3f14d03720dd359303ffabb55a2390fb1427ccf9fdb3e7fe20d90a3eed69697f1ad89a716fd22596a5132ef19d6e8714fe265
+  data.tar.gz: 7d60888ef13bcc5987323c97143ed4e074839cc6860d5bed63ab28f0bd378a639596829a74d4fb4ff9258670ad2ea76971bd0b776e91939abb222a32cba341c6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+
+before_script:
+
+notifications:
+  email:
+    - explorer@flame.org

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "guard"
+  gem 'guard-minitest'
+end

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb})
+  # watch(%r{^lib/(.+)\.rb})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb})
+  # watch(%r{^test/test_helper\.rb}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Michael Graff
+
+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.rdoc

@@ -0,0 +1,20 @@
+= maidenhead
+
+This gem converts between latitude and longitude coordinates and the
+Maidenhead Location System coordinates, with various degrees of accuracy.
+
+== Contributing to maidenhead
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Michael Graff. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "maidenhead"
+  gem.homepage = "http://github.com/skandragon/maidenhead"
+  gem.license = "MIT"
+  gem.summary = %Q{Maidenhead Locator System conversion}
+  gem.description = %Q{Convert between latitude/longitude and Maidenhead Locator System strings}
+  gem.email = "explorer@flame.org"
+  gem.authors = ["Michael Graff"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/maidenhead.rb

@@ -0,0 +1,124 @@
+##
+# Easily convert between latitude and longitude coordinates the the Maidenhead
+# Locator System coordinates.
+class Maidenhead
+
+  #
+  # Verify that the provided Maidenhead locator string is valid.
+  #
+  def self.valid_maidenhead?(location)
+    return false unless location.is_a?String
+    return false unless location.length >= 2
+    return false unless (location.length % 2) == 0
+
+    length = location.length / 2
+    length.times do |counter|
+      grid = location[counter * 2, 2]
+      if (counter == 0)
+        return false unless grid =~ /[a-rA-R]{2}/
+      elsif (counter % 2) == 0
+        return false unless grid =~ /[a-xA-X]{2}/
+      else
+        return false unless grid =~ /[0-9]{2}/
+      end
+    end
+
+    true
+  end
+
+  #
+  # Convert from a Maidenhead locator string to latitude and longitude.
+  # Location may be between 1 and 5 grids in size (2 to 10 characters).
+  # Longer values may work, but accuracy is not guaranteed as latitude
+  # and longitude values returned are rounded ot 6 decimal places.
+  #
+  # For each grid, an arbitrary but repeatable latitude and longitude
+  # is returned.
+  def self.to_latlon(location)
+
+    unless valid_maidenhead?(location)
+      raise ArgumentError.new("Location is not a valid Maidenhead Locator System string")
+    end
+
+    length = location.length / 2
+    while (length < 5)
+      if (length % 2) == 1
+        location += '55'
+      else
+        location += 'LL'
+      end
+      length = location.length / 2
+    end
+
+    lat = 0
+    lon = 0
+
+    lat_multiplier = 10.0
+    lon_multiplier = 20.0
+
+    5.times do |counter|
+      grid_lon = location[counter * 2, 1]
+      grid_lat = location[counter * 2 + 1, 1]
+
+      if counter == 0
+        lat += l2n(grid_lat) * lat_multiplier
+        lon += l2n(grid_lon) * lon_multiplier
+      elsif (counter % 2) == 0
+        lat_multiplier /= 24
+        lon_multiplier /= 24
+        lat += l2n(grid_lat) * lat_multiplier
+        lon += l2n(grid_lon) * lon_multiplier
+      else
+        lat_multiplier /= 10
+        lon_multiplier /= 10
+        lat += grid_lat.to_i * lat_multiplier
+        lon += grid_lon.to_i * lon_multiplier
+      end
+    end
+
+    [ (lat - 90).round(6), (lon - 180).round(6) ]
+  end
+
+  #
+  # Convert from latitude and longitude to a Maidenhead locator string.
+  # Latitude should be between -90 and 90, and longitude should be between
+  # -180 and 180.  Precision defaults to 5 blocks, which returns 10 characters.
+  # More precise coordinates may work, but accuracy is not guaranteed.
+  def self.to_maidenhead(lat, lon, precision = 5)
+    locator = ''
+
+    lat = lat.to_f + 90
+    lon = lon.to_f + 180
+
+    # Calculate the field
+    lat = (lat / 10) + 0.0000001
+    lon = (lon / 20) + 0.0000001
+    locator += n2l(lon.floor).upcase + n2l(lat.floor).upcase
+    precision -= 1
+
+    # Calculate the remaining values
+    precision.times do |counter|
+      if (counter % 2) == 0
+        lat = (lat - lat.floor) * 10
+        lon = (lon - lon.floor) * 10
+        locator += "#{lon.floor}#{lat.floor}"
+      else
+        lat = (lat - lat.floor) * 24
+        lon = (lon - lon.floor) * 24
+        locator += n2l(lon.floor) + n2l(lat.floor)
+      end
+    end
+
+    locator
+  end
+
+  private
+
+  def self.l2n(letter)
+    letter.downcase.ord - 97
+  end
+
+  def self.n2l(number)
+    (number + 97).chr
+  end
+end

data/maidenhead.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "maidenhead"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Graff"]
+  s.date = "2013-11-13"
+  s.description = "Convert between latitude/longitude and Maidenhead Locator System strings"
+  s.email = "explorer@flame.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/maidenhead.rb",
+    "maidenhead.gemspec",
+    "test/helper.rb",
+    "test/test_maidenhead.rb"
+  ]
+  s.homepage = "http://github.com/skandragon/maidenhead"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Maidenhead Locator System conversion"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-minitest>, [">= 0"])
+    else
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-minitest>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-minitest>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'maidenhead'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest.autorun

data/test/test_maidenhead.rb

@@ -0,0 +1,122 @@
+require 'helper'
+
+class TestMaidenhead < Minitest::Test
+  def test_convert_from_maidenhead_5
+    lat, lon = Maidenhead.to_latlon('IO93lo72hn')
+    assert_equal 53.593924, lat
+    assert_equal -1.022569, lon
+  end
+
+  def test_convert_from_maidenhead_4
+    lat, lon = Maidenhead.to_latlon('IO93lo72')
+    assert_equal 53.593576, lat
+    assert_equal -1.021181, lon
+  end
+
+  def test_convert_from_maidenhead_3
+    lat, lon = Maidenhead.to_latlon('IO93lo')
+    assert_equal 53.606076, lat
+    assert_equal -1.037847, lon
+  end
+
+  def test_convert_from_maidenhead_2
+    lat, lon = Maidenhead.to_latlon('IO93')
+    assert_equal 53.481076, lat
+    assert_equal -1.037847, lon
+  end
+
+  def test_convert_from_maidenhead_1
+    lat, lon = Maidenhead.to_latlon('IO')
+    assert_equal 55.481076, lat
+    assert_equal -9.037847, lon
+  end
+
+  def test_convert_to_maidenhead_5
+    maidenhead = Maidenhead.to_maidenhead(53.593923, -1.022569, 5)
+    assert_equal 'IO93lo72hn', maidenhead
+  end
+
+  def test_convert_to_maidenhead_4
+    maidenhead = Maidenhead.to_maidenhead(53.593923, -1.022569, 4)
+    assert_equal 'IO93lo72', maidenhead
+  end
+
+  def test_convert_to_maidenhead_3
+    maidenhead = Maidenhead.to_maidenhead(53.593923, -1.022569, 3)
+    assert_equal 'IO93lo', maidenhead
+  end
+
+  def test_convert_to_maidenhead_2
+    maidenhead = Maidenhead.to_maidenhead(53.593923, -1.022569, 2)
+    assert_equal 'IO93', maidenhead
+  end
+
+  def test_convert_to_maidenhead_1
+    maidenhead = Maidenhead.to_maidenhead(53.593923, -1.022569, 1)
+    assert_equal 'IO', maidenhead
+  end
+
+  def test_convert_JJ00aa
+    lat, lon = Maidenhead.to_latlon('JJ00aa00aa')
+    assert_equal lat, 0
+    assert_equal lon, 0
+  end
+
+  def test_edges_0
+    maidenhead = Maidenhead.to_maidenhead(-90, -180, 5)
+    assert_equal 'AA00aa00aa', maidenhead
+  end
+
+  def test_edges_1
+    maidenhead = Maidenhead.to_maidenhead(90, -180, 5)
+    assert_equal 'AS00aa00aa', maidenhead
+  end
+
+  def test_edges_2
+    maidenhead = Maidenhead.to_maidenhead(90, 180, 5)
+    assert_equal 'SS00aa00aa', maidenhead
+  end
+
+  def test_edges_3
+    maidenhead = Maidenhead.to_maidenhead(-90, 180, 5)
+    assert_equal 'SA00aa00aa', maidenhead
+  end
+
+  def test_throws_for_invalid_maidenhead
+    assert_raises(ArgumentError) do
+      Maidenhead.to_latlon('A')
+    end
+  end
+
+  def test_valid_maidenhead
+    matrix = {
+      'AA' => true,
+      'AA00' => true,
+      'AA00AA' => true,
+      'Rr99XX' => true,
+      'rR99Xx99' => true,
+      'RR99xX99Xx' => true,
+      'RR99xX99xX' => true,
+
+      12 => false,
+      '' => false,
+      nil => false,
+
+      'A' => false,
+      'A1' => false,
+      '00' => false,
+      'AA0' => false,
+      'AAAA' => false,
+      'AA0A' => false,
+      'SS99' => false,
+    }
+
+    matrix.each do |locator, expected_result|
+      if expected_result
+        assert Maidenhead.valid_maidenhead?(locator), "#{locator} should be valid"
+      else
+        refute Maidenhead.valid_maidenhead?(locator), "#{locator} should not be valid"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: maidenhead
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Graff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert between latitude/longitude and Maidenhead Locator System strings
+email: explorer@flame.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/maidenhead.rb
+- maidenhead.gemspec
+- test/helper.rb
+- test/test_maidenhead.rb
+homepage: http://github.com/skandragon/maidenhead
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Maidenhead Locator System conversion
+test_files: []