os_map_ref 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d3a6d62d55bbfca44fd8031064e34087eb938e9
+  data.tar.gz: 4793331eb8dddfd7033762b3df45bcfe188bf07a
+SHA512:
+  metadata.gz: 9638109a89f0295e16fec3a4c2e03a029f9aba6c905baa21f412dda6765eb13f8d37c36d54ff3e203ba148e4bd0dc09eab0111f9f4328bc99e754778abe0fb3b
+  data.tar.gz: b0dcce127c708d994d3c7e96c8173a8630d911aab28434ab20324e909efc1be3eaca192a3b27dd233df12aff6f9451c49ed56a0f6c2d030910827baa7f81dfc7

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.2.3
+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 os_map_ref.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2016 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,55 @@
+# OsMapRef
+
+This gem allows you to gather U.K. Ordnance Survey Eastings, North, and Map
+References from a range of text inputs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'os_map_ref'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install os_map_ref
+
+## Usage
+
+To convert a map reference to eastings and northings:
+
+```ruby
+location = OsMapRef::Location.for 'ST5880171043'
+
+location.easting       == 358801
+location.northing      == 171043
+location.map_reference == 'ST 58801 71043'
+```
+
+To convert eastings and northings to a map reference:
+
+```ruby
+location = OsMapRef::Location.for '358801, 171043'
+
+location.easting       == 358801
+location.northing      == 171043
+location.map_reference == 'ST 58801 71043'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake test` to run the tests. You can also run `bin/console` 
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reggieb/os_map_ref.
+

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 => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "os_map_ref"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/os_map_ref/error.rb

@@ -0,0 +1,3 @@
+module OsMapRef
+  class Error < StandardError; end
+end

data/lib/os_map_ref/input_processor.rb

@@ -0,0 +1,89 @@
+class InputProcessor
+  attr_reader :input
+  
+  def initialize(input)
+    @input = input
+  end
+  
+  def params
+    case input
+    when map_reference_pattern
+      map_reference_params
+    when easting_northing_pattern
+      easting_northing_params
+    else
+      raise OsMapRef::Error, "Unable to process input #{input}"
+    end
+  end
+  
+  def map_reference_params
+    {map_reference: processed_map_reference}
+  end
+  
+  def easting_northing_params
+    {
+      easting: easting_and_northing[0],
+      northing: easting_and_northing[1]
+    }
+  end
+  
+  def processed_map_reference
+    [
+      grid_letters,
+      padded_map_reference_easting,
+      padded_map_reference_northing
+    ].join(' ')
+  end
+  
+  def map_reference_elements
+    @map_reference_elements ||= get_map_reference_elements
+  end
+  
+  def get_map_reference_elements
+    match = map_reference_pattern.match input
+    (1..3).collect{|n| match[n]}
+  end
+  
+  def grid_letters
+     map_reference_elements[0]
+  end
+    
+  def map_reference_easting
+    map_reference_elements[1]
+  end
+  
+  def map_reference_northing
+    map_reference_elements[2]
+  end
+  
+  def padded_map_reference_easting
+    map_reference_easting.ljust(5, '0')
+  end
+  
+  def padded_map_reference_northing
+    target_length = northing_longer_than_easting? ? 6 : 5
+    map_reference_northing.ljust(target_length, '0')
+  end
+  
+  def northing_longer_than_easting?
+    map_reference_northing.length > map_reference_easting.length
+  end
+  
+  def map_reference_pattern
+    /([a-zA-Z]{2})\s*(\d{3,5})\s*(\d{3,6})/
+  end
+  
+  def easting_and_northing
+    @easting_and_northing ||= get_easting_and_northing
+  end
+    
+  def get_easting_and_northing
+    match = easting_northing_pattern.match input
+    (1..2).collect{|n| match[n].ljust(6, '0').to_i}
+  end
+  
+  def easting_northing_pattern
+    /(\d{3,6})[\,\s]+(\d{3,6})/
+  end
+  
+end

data/lib/os_map_ref/location.rb

@@ -0,0 +1,105 @@
+require 'matrix'
+module OsMapRef
+  class Location
+    
+    def self.for(text)
+      input_processor = InputProcessor.new(text)
+      new input_processor.params
+    end
+    
+    def initialize(args={})
+      @map_reference = args[:map_reference].freeze if args[:map_reference]
+      @easting = args[:easting].to_i if args[:easting]
+      @northing = args[:northing].to_i if args[:northing]
+    end
+    
+    def map_reference
+      @map_reference ||= build_map_reference.freeze
+    end
+    
+    def build_map_reference
+      [grid_reference_prefix, short_easting, short_northing].join(' ')
+    end
+    
+    def grid_easting
+      easting.to_s[0].to_i
+    end
+    
+    def short_easting
+      easting.to_s[1..-1].to_i
+    end
+    
+    def long_northing?
+      northing.to_s.length >= 7
+    end
+    
+    def grid_northing
+      northing.to_s[0..(chars_in_northing_start - 1)].to_i
+    end
+    
+    def short_northing
+      northing.to_s[chars_in_northing_start..-1].to_i
+    end
+    
+    def chars_in_northing_start
+      long_northing? ? 2 : 1
+    end
+    
+    def grid_reference_prefix
+      grid[grid_northing][grid_easting]
+    end
+    
+    def easting
+      @easting ||= easting_from_map_reference.to_i
+    end
+    
+    def northing
+      @northing ||= northing_from_map_reference.to_i
+    end    
+    
+    def northing_from_map_reference
+      northing_easting_from_map_reference[0].to_s + map_reference_parts[2]
+    end
+    
+    def easting_from_map_reference
+      northing_easting_from_map_reference[1].to_s + map_reference_parts[1]
+    end
+    
+    # The parts should be a pair of letters then two sets of numbers
+    # 'ST 58901 71053' becomes ['ST', '58901', '71053']   
+    def map_reference_parts
+      @map_reference_parts ||= map_reference.split
+    end
+    
+    # Returns array of [grid_northing, grid_easting] for the gird element
+    # matching the map reference start. So 'ST 58901 71053' will return [1, 3]
+    def northing_easting_from_map_reference
+      @northing_easting_from_map_reference ||= matrix.index map_reference_parts[0]
+    end
+    
+    def matrix
+      @matrix ||= Matrix[*grid]
+    end
+    
+    # Grid of 100km squares as they are arranged over the UK.
+    # The grid is reversed so that the origin (0,0) is the 
+    # bottom left corner ('SV').
+    def grid
+      @grid ||= [
+        %w[HL HM HN HO HP JL JM JH JO JP],
+        %w[HQ HR HS HT HU JQ JR JS JT JU],
+        %w[HV HW HX HY HZ JV JW JX JY JZ],
+        %w[NA NB NC ND NE OA OB OC OD OE],
+        %w[NF NG NH NJ NK OF OG OH OI OJ],
+        %w[NL NM NN NO NP OL OM ON OO OP],
+        %w[NQ NR NS NT NU OQ OR OS OT OU],
+        %w[NV NW NX NY NZ OV OW OX OY OZ],
+        %w[SA SB SC SD SE TA TB TC TD TE],
+        %w[SF SG SH SJ SK TF TG TH TI TJ],
+        %w[SL SM SN SO SP TL TM TN TO TP],
+        %w[SQ SR SS ST SU TQ TR TS TT TU],
+        %w[SV SW SX SY SZ TV TW TX TY TZ]
+      ].reverse
+    end
+  end
+end

data/lib/os_map_ref/version.rb

@@ -0,0 +1,3 @@
+module OsMapRef
+  VERSION = "0.1.0"
+end

data/lib/os_map_ref.rb

@@ -0,0 +1,7 @@
+require "os_map_ref/error"
+require "os_map_ref/input_processor"
+require "os_map_ref/location"
+require "os_map_ref/version"
+module OsMapRef
+  # Namespace
+end

data/os_map_ref.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'os_map_ref/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "os_map_ref"
+  spec.version       = OsMapRef::VERSION
+  spec.authors       = ["Rob Nichols"]
+  spec.email         = ["rob@undervale.co.uk"]
+
+  spec.summary       = %q{A tool to help handle UK Ordnance Survey map references, in particular to convert them to other coordinate systems}
+  spec.description   = %q{This gem allows you to gather U.K. Ordnance Survey Eastings, North, and Map References from a range of text inputs; and output them in a consistent manner}
+  spec.homepage      = "https://github.com/reggieb/os_map_ref"
+
+  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.license       = "LICENSE"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: os_map_ref
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-24 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: This gem allows you to gather U.K. Ordnance Survey Eastings, North, and
+  Map References from a range of text inputs; and output them in a consistent manner
+email:
+- rob@undervale.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/os_map_ref.rb
+- lib/os_map_ref/error.rb
+- lib/os_map_ref/input_processor.rb
+- lib/os_map_ref/location.rb
+- lib/os_map_ref/version.rb
+- os_map_ref.gemspec
+homepage: https://github.com/reggieb/os_map_ref
+licenses:
+- LICENSE
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A tool to help handle UK Ordnance Survey map references, in particular to
+  convert them to other coordinate systems
+test_files: []