maidenhead 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad8ea73a10da985b1a7306998b711cae38c95310
-  data.tar.gz: ceb9292ef5f7e0d77d63e44e4c524124218a221c
+  metadata.gz: 40ed408d54e471f32833cacdbf1078ae0a16a643
+  data.tar.gz: da0c776dd32ec20e283bf21a6b5bc4a052018e98
 SHA512:
-  metadata.gz: e73f5f0cf8657d206cb5675169d3f14d03720dd359303ffabb55a2390fb1427ccf9fdb3e7fe20d90a3eed69697f1ad89a716fd22596a5132ef19d6e8714fe265
-  data.tar.gz: 7d60888ef13bcc5987323c97143ed4e074839cc6860d5bed63ab28f0bd378a639596829a74d4fb4ff9258670ad2ea76971bd0b776e91939abb222a32cba341c6
+  metadata.gz: e70c064ec9adeaf1983eeeffa59909c2a8019658e80acdaa0638ad8d76ab6ce04a0dfc086964c1b4ef68848c84139bd965101bff68cecf47e4d109c3fba7a0b7
+  data.tar.gz: 412eae93856575e066a4c86c0c4a4fb0ce9d827c79d13d99aded3c234d3837a7446a6255e96ed4055bc609c330cc3b16d8d48fbe277cb678907a336a29a10061

data/.travis.yml

@@ -1,7 +1,9 @@
 rvm:
   - 2.0.0
+  - 2.1.0
   - 1.9.3
-  - rbx-19mode
+  - rbx
+  - rbx-2
   - jruby-19mode
 
 before_script:

data/Gemfile

@@ -6,11 +6,15 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "minitest", ">= 0"
+  gem "minitest"
   gem "yard", "~> 0.7"
-  gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8.7"
+  gem "jeweler", "~> 2.0"
   gem "guard"
   gem 'guard-minitest'
+
+  platforms :rbx do
+#    gem 'racc'
+    gem 'rubysl'
+  end
 end

data/README.rdoc

@@ -1,5 +1,9 @@
 = maidenhead
 
+{<img src="https://travis-ci.org/skandragon/maidenhead.png?branch=master" alt="Build Status" />}[https://travis-ci.org/skandragon/maidenhead]
+{<img src="https://gemnasium.com/skandragon/maidenhead.png" alt="Dependency Status" />}[https://gemnasium.com/skandragon/maidenhead]
+{<img src="https://codeclimate.com/github/skandragon/maidenhead.png" />}[https://codeclimate.com/github/skandragon/maidenhead]
+
 This gem converts between latitude and longitude coordinates and the
 Maidenhead Location System coordinates, with various degrees of accuracy.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/maidenhead.rb

@@ -2,7 +2,6 @@
 # Easily convert between latitude and longitude coordinates the the Maidenhead
 # Locator System coordinates.
 class Maidenhead
-
   #
   # Verify that the provided Maidenhead locator string is valid.
   #
@@ -34,49 +33,34 @@ class Maidenhead
   #
   # For each grid, an arbitrary but repeatable latitude and longitude
   # is returned.
+  #
   def self.to_latlon(location)
+    maidenhead = Maidenhead.new
+    maidenhead.locator = location
+    [ maidenhead.lat, maidenhead.lon ]
+  end
 
-    unless valid_maidenhead?(location)
+  #
+  # Set the locator string.  It must be a valid string, or an ArgumentError
+  # will be raised.  This also directly computes the latitude and longitude
+  # values for this locator, so they will be valid after caling this method.
+  #
+  def locator=(location)
+    unless Maidenhead.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]
+    @locator = location
+    @lat = -90.0
+    @lon = -180.0
 
-      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
+    pad_locator
 
-    [ (lat - 90).round(6), (lon - 180).round(6) ]
+    convert_part_to_latlon(0, 1)
+    convert_part_to_latlon(1, 10)
+    convert_part_to_latlon(2, 10 * 24)
+    convert_part_to_latlon(3, 10 * 24 * 10)
+    convert_part_to_latlon(4, 10 * 24 * 10 * 24)
   end
 
   #
@@ -84,41 +68,144 @@ class Maidenhead
   # 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 = ''
+    maidenhead = Maidenhead.new
+    maidenhead.lat = lat
+    maidenhead.lon = lon
+    maidenhead.precision = precision
+    maidenhead.locator
+  end
 
-    lat = lat.to_f + 90
-    lon = lon.to_f + 180
+  #
+  # Set the latitude.  Values must be between -90.0 and +90.0 or an
+  # ArgumentError will be raised.
+  #
+  def lat=(pos)
+    @lat = range_check("lat", 90.0, pos)
+  end
 
-    # Calculate the field
-    lat = (lat / 10) + 0.0000001
-    lon = (lon / 20) + 0.0000001
-    locator += n2l(lon.floor).upcase + n2l(lat.floor).upcase
-    precision -= 1
+  #
+  # Retrieve the latitude, usually post-conversion from a locator string.
+  # The result is rounded to 6 decimal places.
+  #
+  def lat
+    @lat.round(6)
+  end
 
-    # 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}"
+  #
+  # Set the longitude.  Values must be between -180.0 and +180.0 or an
+  # ArgumentError will be raised.
+  #
+  def lon=(pos)
+    @lon = range_check("lon", 180.0, pos)
+  end
+
+  #
+  # Retrieve the longitude, usually post-conversion from a locator string.
+  # The result is rounded to 6 decimal places.
+  #
+  def lon
+    @lon.round(6)
+  end
+
+  #
+  # Set the desired precision when converting from a latitude / longitude
+  # to a maidenhead locator.  This specifies the number of groups to use,
+  # usually 2 through 5, which results in 4 through 10 characters.
+  #
+  def precision=(value)
+    @precision = value
+  end
+
+  def precision
+    @precision
+  end
+
+  #
+  # Convert from a latitude / longitude position, which must have been
+  # set via #lat= and #lon=, to a locator.
+  #
+  def locator
+    @locator = ''
+
+    @lat_tmp = @lat + 90.0
+    @lon_tmp = @lon + 180.0
+    @precision_tmp = @precision
+
+    calculate_field
+    calculate_values
+
+    @locator
+  end
+
+  private
+
+  def pad_locator
+    length = @locator.length / 2
+    while (length < 5)
+      if (length % 2) == 1
+        @locator += '55'
       else
-        lat = (lat - lat.floor) * 24
-        lon = (lon - lon.floor) * 24
-        locator += n2l(lon.floor) + n2l(lat.floor)
+        @locator += 'LL'
       end
+      length = @locator.length / 2
     end
+  end
 
-    locator
+  def convert_part_to_latlon(counter, divisor)
+    grid_lon = @locator[counter * 2, 1]
+    grid_lat = @locator[counter * 2 + 1, 1]
+
+    @lat += l2n(grid_lat) * 10.0 / divisor
+    @lon += l2n(grid_lon) * 20.0 / divisor
   end
 
-  private
+  def calculate_field
+    @lat_tmp = (@lat_tmp / 10) + 0.0000001
+    @lon_tmp = (@lon_tmp / 20) + 0.0000001
+    @locator += n2l(@lon_tmp.floor).upcase + n2l(@lat_tmp.floor).upcase
+    @precision_tmp -= 1
+  end
 
-  def self.l2n(letter)
-    letter.downcase.ord - 97
+  def compute_locator(counter, divisor)
+    @lat_tmp = (@lat_tmp - @lat_tmp.floor) * divisor
+    @lon_tmp = (@lon_tmp - @lon_tmp.floor) * divisor
+
+    if (counter % 2) == 0
+      @locator += "#{@lon_tmp.floor}#{@lat_tmp.floor}"
+    else
+      @locator += n2l(@lon_tmp.floor) + n2l(@lat_tmp.floor)
+    end
   end
 
-  def self.n2l(number)
+  def calculate_values
+    @precision_tmp.times do |counter|
+      if (counter % 2) == 0
+        compute_locator(counter, 10)
+      else
+        compute_locator(counter, 24)
+      end
+    end
+  end
+
+  def l2n(letter)
+    if letter =~ /[0-9]+/
+      letter.to_i
+    else
+      letter.downcase.ord - 97
+    end
+  end
+
+  def n2l(number)
     (number + 97).chr
   end
+
+  def range_check(target, range, pos)
+    pos = pos.to_f
+    if pos < -range or pos > range
+      raise ArgumentError.new("#{target} must be between -#{range} and +#{range}")
+    end
+    pos
+  end
 end

data/maidenhead.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: maidenhead 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "maidenhead"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Michael Graff"]
-  s.date = "2013-11-13"
+  s.date = "2014-03-27"
   s.description = "Convert between latitude/longitude and Maidenhead Locator System strings"
   s.email = "explorer@flame.org"
   s.extra_rdoc_files = [
@@ -17,7 +19,6 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".document",
     ".travis.yml",
     "Gemfile",
     "Guardfile",
@@ -32,8 +33,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/skandragon/maidenhead"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.3"
+  s.rubygems_version = "2.2.0"
   s.summary = "Maidenhead Locator System conversion"
 
   if s.respond_to? :specification_version then
@@ -42,28 +42,28 @@ Gem::Specification.new do |s|
     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<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<guard>, [">= 0"])
       s.add_development_dependency(%q<guard-minitest>, [">= 0"])
+      s.add_development_dependency(%q<rubysl>, [">= 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<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<guard>, [">= 0"])
       s.add_dependency(%q<guard-minitest>, [">= 0"])
+      s.add_dependency(%q<rubysl>, [">= 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<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<guard>, [">= 0"])
     s.add_dependency(%q<guard-minitest>, [">= 0"])
+    s.add_dependency(%q<rubysl>, [">= 0"])
   end
 end
 

data/test/test_maidenhead.rb

@@ -1,34 +1,29 @@
 require 'helper'
 
 class TestMaidenhead < Minitest::Test
-  def test_convert_from_maidenhead_5
+  def test_convert_from_maidenhead_IO93lo72hn
     lat, lon = Maidenhead.to_latlon('IO93lo72hn')
-    assert_equal 53.593924, lat
-    assert_equal -1.022569, lon
+    assert_equal [ 53.593924, -1.022569 ], [ lat, lon ]
   end
 
-  def test_convert_from_maidenhead_4
+  def test_convert_from_maidenhead_IO93lo72
     lat, lon = Maidenhead.to_latlon('IO93lo72')
-    assert_equal 53.593576, lat
-    assert_equal -1.021181, lon
+    assert_equal [ 53.593576, -1.021181 ], [ lat, lon ]
   end
 
-  def test_convert_from_maidenhead_3
+  def test_convert_from_maidenhead_IO93lo
     lat, lon = Maidenhead.to_latlon('IO93lo')
-    assert_equal 53.606076, lat
-    assert_equal -1.037847, lon
+    assert_equal [ 53.606076, -1.037847 ], [ lat, lon ]
   end
 
-  def test_convert_from_maidenhead_2
+  def test_convert_from_maidenhead_IO93
     lat, lon = Maidenhead.to_latlon('IO93')
-    assert_equal 53.481076, lat
-    assert_equal -1.037847, lon
+    assert_equal [ 53.481076, -1.037847 ], [ lat, lon ]
   end
 
-  def test_convert_from_maidenhead_1
+  def test_convert_from_maidenhead_IO
     lat, lon = Maidenhead.to_latlon('IO')
-    assert_equal 55.481076, lat
-    assert_equal -9.037847, lon
+    assert_equal [ 55.481076, -9.037847 ], [ lat, lon ]
   end
 
   def test_convert_to_maidenhead_5
@@ -119,4 +114,32 @@ class TestMaidenhead < Minitest::Test
       end
     end
   end
+
+  def test_instance_lat_out_of_range_negative_raises
+    assert_raises(ArgumentError) do
+      maidenhead = Maidenhead.new
+      maidenhead.lat = -90.1
+    end
+  end
+
+  def test_instance_lat_out_of_range_positive_raises
+    assert_raises(ArgumentError) do
+      maidenhead = Maidenhead.new
+      maidenhead.lat = 90.1
+    end
+  end
+
+  def test_instance_lon_out_of_range_negative_raises
+    assert_raises(ArgumentError) do
+      maidenhead = Maidenhead.new
+      maidenhead.lon = -180.1
+    end
+  end
+
+  def test_instance_lon_out_of_range_positive_raises
+    assert_raises(ArgumentError) do
+      maidenhead = Maidenhead.new
+      maidenhead.lon = 180.1
+    end
+  end
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: maidenhead
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Michael Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2014-03-27 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
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  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'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rubysl
   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
@@ -116,8 +116,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
-- .document
-- .travis.yml
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -138,17 +137,17 @@ 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
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Maidenhead Locator System conversion

data/.document

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