os_map_ref 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e2b921bf19f2d0da1e4137e3d99405406c3b0bd
-  data.tar.gz: 3ab34f8c15a09653a0fe9832c6d2582f12fba8ac
+  metadata.gz: 63ae3fcaaf973eec7b4724150197b0ab202538be
+  data.tar.gz: 08a5ebe1a235a599ea73648a2b0a8718134f3b7b
 SHA512:
-  metadata.gz: 5aa6dadbd16152dc75dbadf0bb18fba8861c884687e1562912316279355fd06bb9f789ce3c1ce5b3a4d2efa2d77c57177b90803a0c41dd8d7a67b239c9338e3f
-  data.tar.gz: c87a6547421f334dc30ca1f71b271043773139fcff45a38924426b57424d476261f8c7f1eb027965b1d7c07d7c9553ff0106f55690b6c59b9d501c0cbb930515
+  metadata.gz: de6195a4927e318ebc2c00cf8c61677ee3a9d144cbbf1cd3a76ce80920e5768ff4a2810272d979917e90a39841f2866d4e55dbcc360c65513231be3b93b4b322
+  data.tar.gz: e21af0b63498777aa48e6ec7b2e6ab6dc1ac5dc6ece9f94b9eb9c3e7fc397f2fb8e409adf3a219fdbb52be4441a7a7fa6a25e29c83c7280a267accf733d826f2

data/README.md

@@ -41,15 +41,59 @@ location.northing      == 171043
 location.map_reference == 'ST 58801 71043'
 ```
 
+### From OS Map Reference to Longitude and Latitude
+
+If your end result needs to be longitude and latitude, you can combine the
+OsMapRef output with that of another gem:
+[global_convert](https://github.com/reggieb/global_convert)
+
+For example
+
+```ruby
+require 'global_convert'
+require 'os_map_ref'
+
+os_location = OsMapRef::Location.for 'ST 58801 71043'
+
+location = GlobalConvert::Location.new(
+  input: {
+    projection: :osgb36,
+    lon: os_location.easting,
+    lat: os_location.northing
+  },
+  output: {
+    projection: :wgs84
+  }
+)
+
+puts "Latitude = #{location.lat} in radians."
+puts "Longitude = #{location.lon} in radians."
+```
+
 ## 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` 
+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`. 
+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.
 
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -7,4 +7,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :spec
+task :spec => :test
+
+task :default => :test

data/lib/os_map_ref/location.rb

@@ -1,92 +1,92 @@
 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    
-    
+    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']   
+    # '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 
+    # 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[HL HM HN HO HP JL JM JN 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],

data/lib/os_map_ref/version.rb

@@ -1,3 +1,3 @@
 module OsMapRef
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: os_map_ref
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler