dx-grid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db60093b0328e595636bf8c4509e042a8ac3d933
+  data.tar.gz: f2bd0cd4d34ede6d90dcac71c0f883947fbefca6
+SHA512:
+  metadata.gz: e17134482735828c86a3b277e661cd15bb3c0edd48d923850f40579f06bc12ef963a211f3b03b6cd2401839e35d0a33f658f0beb3144dbf52349b27585509d09
+  data.tar.gz: d3eeb86a04d6ebfc45c5000c3fd669854527008df158077dad56e031d1f25c4ec93408fc20891310976635671e7ef66164ad63448bb1d0bac5466a0741bc15fc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dx-grid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rockwell Schrock
+
+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,70 @@
+# DX::Grid
+
+The `DX::Grid` module provides methods for converting between lat/long coordinate pairs and amateur radio Maidenhead grid locators. It can also validate grid coordinators.
+
+The supported grid formats are 4-character (e.g. `FN22`) and 6-character (e.g. `FN32ab`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dx-grid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dx-grid
+
+## Usage
+
+```ruby
+require 'dx/grid'
+```
+
+### Decoding a Grid to a Coordinate
+
+```ruby
+DX::Grid.decode('FN22') # => [42.5, -75.0]
+DX::Grid.decode('FN22ab') # => [42.0625, -75.95833333333333]
+```
+
+### Encoding a Coordinate to a Grid
+
+```ruby
+DX::Grid.encode([42.481076, -75.037847]) # => 'FN22'
+DX::Grid.encode([42.481076, -75.037847], :length => 4) # => 'FN22'
+DX::Grid.encode([42.481076, -75.037847], :length => 6) # => 'FN22cd'
+```
+
+### Validating a Grid
+
+```ruby
+DX::Grid.valid?('FN22') # => true
+DX::Grid.valid?('fn22') # => true
+DX::Grid.valid?('AA00aa') # => true
+DX::Grid.valid?('ab12xx') # => true
+DX::Grid.valid?('MO00OO') # => true
+DX::Grid.valid?('lo00ol') # => true
+
+DX::Grid.valid?('FN') # => false
+DX::Grid.valid?('st12') # => false
+DX::Grid.valid?('fn22yz') # => false
+DX::Grid.valid?('hello world') # => false
+DX::Grid.valid?(nil) # => false
+DX::Grid.valid?('') # => false
+DX::Grid.valid?(5) # => false
+DX::Grid.valid?(Math::PI) # => false
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schrockwell/dx-grid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/dx-grid.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dx/grid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dx-grid"
+  spec.version       = DX::Grid::VERSION
+  spec.authors       = ["Rockwell Schrock"]
+  spec.email         = ["schrockwell@gmail.com"]
+
+  spec.summary       = %q{Amateur radio Maidenhead grid locator conversions}
+  spec.homepage      = "https://github.com/schrockwell/dx-grid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/dx/grid.rb

@@ -0,0 +1,114 @@
+require "dx/grid/version"
+
+module DX
+  module Grid
+    def self.encode(coord, options={})
+      length = options[:length] || 4
+      validate_grid_length!(length)
+      validate_coord!(coord)
+
+      lat, lon = coord[0], coord[1]
+      grid = ''
+
+      # Normalize from (-90, -180) to (0, 0)
+      lon = lon + 180.0
+      lat = lat + 90.0
+
+      # Map lon from 0 to 17 (A to R)
+      lon_index = (lon / 20.0).to_i
+      lat_index = (lat / 10.0).to_i
+
+      # Convert to characters
+      grid += "#{('A'.ord + lon_index).chr}#{('A'.ord + lat_index).chr}"
+
+      lon -= lon_index * 20.0 # 20 degrees lon per grid
+      lat -= lat_index * 10.0 # 10 degrees lat per grid
+
+      # Map from 0 to 9
+      lon_index = (lon / 2.0).to_i
+      lat_index = lat.to_i
+
+      grid += "#{lon_index}#{lat_index}"
+
+      # Do the long grid if desired
+      if length == 6
+        lon -= lon_index * 2.0 # Now 2 degrees lon per grid remaining
+        lat -= lat_index       # Now 1 degree lon per grid remaining
+
+        # Map from 0 to 23 (a to x)
+        lon_index = (lon / (2.0 / 24.0)).to_i
+        lat_index = (lat / (1.0 / 24.0)).to_i
+
+        # Convert to characters
+        grid += "#{('a'.ord + lon_index).chr}#{('a'.ord + lat_index).chr}"
+      end
+
+      grid
+    end
+
+    def self.decode(grid)
+      grid = grid.to_s
+      validate_grid!(grid)
+
+      lon = -180
+      lat = -90
+      
+      ord0 = grid[0].upcase.ord - 'A'.ord
+      ord1 = grid[1].upcase.ord - 'A'.ord
+      ord2 = grid[2].to_i
+      ord3 = grid[3].to_i
+      
+      lon += (360.0 / 18.0) * ord0 + (360.0 / 18.0 / 10.0) * ord2
+      lat += (180.0 / 18.0) * ord1 + (180.0 / 18.0 / 10.0) * ord3
+      
+      if grid.length == 4
+        lon += (360.0 / 18.0 / 10.0 / 2.0)
+        lat += (180.0 / 18.0 / 10.0 / 2.0)
+      else
+        ord4 = grid[4].downcase.ord - 'a'.ord
+        ord5 = grid[5].downcase.ord - 'a'.ord
+        
+        lon += (360.0 / 18.0 / 10.0 / 24.0) * (ord4 + 0.5)
+        lat += (180.0 / 18.0 / 10.0 / 24.0) * (ord5 + 0.5)
+      end
+      
+      return [lat, lon]
+    end
+
+    def self.valid?(str)
+      str = str.to_s
+
+      if str.length == 4
+        return str.match(/[A-R]{2}[0-9]{2}/i)
+      elsif str.length == 6
+        return str.match(/[A-R]{2}[0-9]{2}[A-X]{2}/i)
+      end
+
+      false
+    end
+
+private
+
+    def self.validate_coord!(coord)
+      if coord[0] == nil || coord[0] < -90 || coord[0] > 90
+        raise ArgumentError, 'Latitude must be between -90 and 90 degrees'
+      end
+
+      if coord[1] == nil || coord[1] < -180 || coord[1] > 180
+        raise ArgumentError, 'Longitude must be between -180 and 180 degrees'
+      end
+    end
+
+    def self.validate_grid!(grid)
+      if !valid?(grid)
+        raise ArgumentError, "Invalid grid: '#{grid}'"
+      end
+    end
+
+    def self.validate_grid_length!(length)
+      if length != 4 && length != 6
+        raise ArgumentError, 'Grid length must be 4 or 6'
+      end
+    end
+  end
+end

data/lib/dx/grid/version.rb

@@ -0,0 +1,5 @@
+module DX
+  module Grid
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: dx-grid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rockwell Schrock
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- schrockwell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dx-grid.gemspec
+- lib/dx/grid.rb
+- lib/dx/grid/version.rb
+homepage: https://github.com/schrockwell/dx-grid
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Amateur radio Maidenhead grid locator conversions
+test_files: []