breasal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c02849fafca9316143e9d3e6adb58ea6b3c89b5
+  data.tar.gz: 5aaffddb410739c76b6ba64a7f2d3b5488c154f7
+SHA512:
+  metadata.gz: 46bb4f7a6eb76030568b907e6778e63171a52d0398fb42a6c832eff23d22d5516303100c9f0319560d78ee7044678d407d0784e72e52057fa192662a6cb04d1b
+  data.tar.gz: 294f4a46556d3e28077bf603670a3f3aa2a858deb5286084c5ef3cbb2c766f6f3d52a448a111e6772c6a41a45ecba35fc8fee7483c81977a00e026652b15b2e0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,20 @@
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.0
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.net#theodi"
+    template:
+      - "%{repository} %{branch} - %{message} %{build_url}"
+    on_success: change
+    on_failure: always
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "UZ7kuAfrrDfKSsmWwiPq1kS9jThJPFcxwSEyfH2sRSy4GAqqMp/E3y3Iuqbkh6GX4NFWzPtGImxcZ+9P6yoBf9Sk+N5mfUY2zyRtcjbTYZ00jvBQLgwaAh3dTRu0NXpBchn+87p7bEwV6mo4AFiacy2k/nrLdIMiyTPuqE8a1r4="
+  gem: breasal
+  on:
+    tags: true
+    repo: theodi/breasal

data/Gemfile

@@ -0,0 +1,7 @@
+#ruby=ruby-2.1.0
+#ruby-gemset=breasal
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in breasal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 pezholio
+
+MIT License
+
+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,48 @@
+[![Build Status](http://img.shields.io/travis/theodi/breasal.svg)](https://travis-ci.org/theodi/breasal)
+[![Dependency Status](http://img.shields.io/gemnasium/theodi/breasal.svg)](https://gemnasium.com/theodi/breasal)
+[![Coverage Status](http://img.shields.io/coveralls/theodi/breasal.svg)](https://coveralls.io/r/theodi/breasal)
+[![Code Climate](http://img.shields.io/codeclimate/github/theodi/breasal.svg)](https://codeclimate.com/github/theodi/breasal)
+[![Gem Version](http://img.shields.io/gem/v/breasal.svg)](https://rubygems.org/gems/breasal)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://theodi.mit-license.org)
+[![Badges](http://img.shields.io/:badges-7/7-ff6799.svg)](https://github.com/pikesley/badger)
+
+# Breasal
+
+A Ruby gem that converts both British and Irish Eastings and northing to WGS84 latitude and longitude.
+
+Based on the work by [Andrew Sprinz at Lambeth Council](https://github.com/LambethCouncil/OSGB36_Converter), and created in anger as part of work on [UK Postcodes](https://github.com/theodi/uk-postcodes)
+
+Breasal is the Welsh and Cornish God of all earth, so I thought him suitably Celtic to cover all the British isles.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'breasal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install breasal
+
+## Usage
+
+Provide an easting, northing and coordinate type (either `:gb` or `:ie` - default is `:gb`):
+
+    en = Breasal::EastingNorthing.new(easting: 412617, northing: 308885, type: :gb)
+  
+Get the WGS84 latlng:
+
+    en.to_wgs84 # => {:latitude=>52.67752501534847, :longitude=>-1.8148108086293673}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+$:.unshift File.join( File.dirname(__FILE__), "lib")
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/breasal.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breasal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "breasal"
+  spec.version       = Breasal::VERSION
+  spec.authors       = ["Stuart Harrison"]
+  spec.email         = ["stuart.harrison@theodi.org"]
+  spec.description   = %q{A Ruby gem that converts both British and Irish Eastings and northing to WGS84 latitude and longitude}
+  spec.summary       = %q{A Ruby gem that converts both British and Irish Eastings and northing to WGS84 latitude and longitude}
+  spec.homepage      = "https://github.com/theodi/breasal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "travis"
+end

data/lib/breasal.rb

@@ -0,0 +1,4 @@
+require "breasal/version"
+require "breasal/utils"
+require "breasal/latlng"
+require "breasal/easting_northing"

data/lib/breasal/easting_northing.rb

@@ -0,0 +1,127 @@
+module Breasal
+  
+  class EastingNorthing
+    
+    include Breasal::Utils
+    
+    def initialize(options)
+      @easting = options[:easting]
+      @northing = options[:northing]
+      @type = options[:type] || :gb
+    end
+    
+    # Takes OSGB36 or TM75 (Irish national grid) Easting/Northing coords 
+    # and returns WGS84 Latitude and Longitude
+    def to_wgs84
+      ll = to_latlng(@easting, @northing, @type)
+      lat_lng = LatLng.new(latitude: ll[:latitude], longitude: ll[:longitude], type: @type)
+      lat_lng.to_WGS84
+    end
+
+    # Takes OSGB36 or TM75 (Irish national grid) Easting/Northing coords
+    # and returns Latitude and Longitude in either OSGB36 or TM75 format
+  	def to_latlng(easting, northing, type = :gb)
+
+  	    if type == :ie
+          @OSGB_F0  = 1.000035
+          @N0       = 250000.0
+          @E0       = 200000.0
+          @phi0     = deg_to_rad(53.5)
+          @lambda0  = deg_to_rad(-8.0)
+          @a        = 6377340.189
+          @b        = 6356034.447
+        else
+          @OSGB_F0  = 0.9996012717
+          @N0       = -100000.0
+          @E0       = 400000.0
+          @phi0     = deg_to_rad(49.0)
+          @lambda0  = deg_to_rad(-2.0)
+          @a        = 6377563.396
+          @b        = 6356256.909
+        end 
+
+        @eSquared = ((@a * @a) - (@b * @b)) / (@a * @a)
+        @phi      = 0.0
+        @lambda   = 0.0
+        @E        = easting
+        @N        = northing
+        @n        = (@a - @b) / (@a + @b)
+        @M        = 0.0
+        @phiPrime = ((@N - @N0) / (@a * @OSGB_F0)) + @phi0
+
+  	     begin
+
+  	       @M =
+  	         (@b * @OSGB_F0)\
+  	           * (((1 + @n + ((5.0 / 4.0) * @n * @n) + ((5.0 / 4.0) * @n * @n * @n))\
+  	             * (@phiPrime - @phi0))\
+  	             - (((3 * @n) + (3 * @n * @n) + ((21.0 / 8.0) * @n * @n * @n))\
+  	               * Math.sin(@phiPrime - @phi0)\
+  	               * Math.cos(@phiPrime + @phi0))\
+  	             + ((((15.0 / 8.0) * @n * @n) + ((15.0 / 8.0) * @n * @n * @n))\
+  	               * Math.sin(2.0 * (@phiPrime - @phi0))\
+  	               * Math.cos(2.0 * (@phiPrime + @phi0)))\
+  	             - (((35.0 / 24.0) * @n * @n * @n)\
+  	               * Math.sin(3.0 * (@phiPrime - @phi0))\
+  	               * Math.cos(3.0 * (@phiPrime + @phi0))))
+
+  	       @phiPrime += (@N - @N0 - @M) / (@a * @OSGB_F0)
+
+  	     end while ((@N - @N0 - @M) >= 0.001)
+
+  	     @v = @a * @OSGB_F0 * ((1.0 - @eSquared * sin_pow_2(@phiPrime)) ** -0.5)
+  	     @rho =
+  	       @a\
+  	         * @OSGB_F0\
+  	         * (1.0 - @eSquared)\
+  	         * ((1.0 - @eSquared * sin_pow_2(@phiPrime)) ** -1.5)
+  	     @etaSquared = (@v / @rho) - 1.0
+  	     @VII = Math.tan(@phiPrime) / (2 * @rho * @v)
+  	     @VIII =
+  	       (Math.tan(@phiPrime) / (24.0 * @rho * (@v ** 3.0)))\
+  	         * (5.0\
+  	           + (3.0 * tan_pow_2(@phiPrime))\
+  	           + @etaSquared\
+  	           - (9.0 * tan_pow_2(@phiPrime) * @etaSquared))
+  	     @IX =
+  	       (Math.tan(@phiPrime) / (720.0 * @rho * (@v ** 5.0)))\
+  	         * (61.0\
+  	           + (90.0 * tan_pow_2(@phiPrime))\
+  	           + (45.0 * tan_pow_2(@phiPrime) * tan_pow_2(@phiPrime)))
+  	     @X = sec(@phiPrime) / @v
+  	     @XI =
+  	       (sec(@phiPrime) / (6.0 * @v * @v * @v))\
+  	         * ((@v / @rho) + (2 * tan_pow_2(@phiPrime)))
+  	     @XII =
+  	       (sec(@phiPrime) / (120.0 * (@v ** 5.0)))\
+  	         * (5.0\
+  	           + (28.0 * tan_pow_2(@phiPrime))\
+  	           + (24.0 * tan_pow_2(@phiPrime) * tan_pow_2(@phiPrime)))
+  	     @XIIA =
+  	       (sec(@phiPrime) / (5040.0 * (@v ** 7.0)))\
+  	         * (61.0\
+  	           + (662.0 * tan_pow_2(@phiPrime))\
+  	           + (1320.0 * tan_pow_2(@phiPrime) * tan_pow_2(@phiPrime))\
+  	           + (720.0\
+  	             * tan_pow_2(@phiPrime)\
+  	             * tan_pow_2(@phiPrime)\
+  	             * tan_pow_2(@phiPrime)))
+  	     @phi =
+  	       @phiPrime\
+  	         - (@VII * ((@E - @E0) ** 2.0))\
+  	         + (@VIII * ((@E - @E0) ** 4.0))\
+  	         - (@IX * ((@E - @E0) ** 6.0))
+  	     @lambda =
+  	       @lambda0\
+  	         + (@X * (@E - @E0))\
+  	         - (@XI * ((@E - @E0) ** 3.0))\
+  	         + (@XII * ((@E - @E0) ** 5.0))\
+  	         - (@XIIA * ((@E - @E0) ** 7.0))
+
+  	    { :latitude => rad_to_deg(@phi), :longitude => rad_to_deg(@lambda) }
+
+  	  end
+    
+  end
+  
+end

data/lib/breasal/latlng.rb

@@ -0,0 +1,69 @@
+module Breasal
+
+  class LatLng
+    
+    include Breasal::Utils
+    
+    def initialize(options)
+      @latitude = options[:latitude]
+      @longitude = options[:longitude]
+      @type = options[:type] || :gb
+    end
+    
+	  # Takes OSGB36 or TM75 Latitude and Longitude coords 
+    # and returns WGS84 Latitude and Longitude
+	  def to_WGS84
+	    
+	    if @type == :ie
+	      @a        = 6377340.189
+	      @b        = 6356034.447
+      else
+        @a        = 6377563.396
+        @b        = 6356256.909
+      end
+      
+      @eSquared = ((@a * @a) - (@b * @b)) / (@a * @a)
+
+      @phi = deg_to_rad(@latitude)
+      @lambda = deg_to_rad(@longitude)
+      @v = @a / (Math.sqrt(1 - @eSquared * sin_pow_2(@phi)))
+      @H = 0
+      @x = (@v + @H) * Math.cos(@phi) * Math.cos(@lambda)
+      @y = (@v + @H) * Math.cos(@phi) * Math.sin(@lambda)
+      @z = ((1 - @eSquared) * @v + @H) * Math.sin(@phi)
+
+      @tx =        446.448
+      @ty =       -124.157
+      @tz =        542.060
+      
+      @s  =         -0.0000204894
+      @rx = deg_to_rad( 0.00004172222)
+      @ry = deg_to_rad( 0.00006861111)
+      @rz = deg_to_rad( 0.00023391666)
+
+      @xB = @tx + (@x * (1 + @s)) + (-@rx * @y)     + (@ry * @z)
+      @yB = @ty + (@rz * @x)      + (@y * (1 + @s)) + (-@rx * @z)
+      @zB = @tz + (-@ry * @x)     + (@rx * @y)      + (@z * (1 + @s))
+
+      @a        = 6378137.000
+      @b        = 6356752.3141
+      @eSquared = ((@a * @a) - (@b * @b)) / (@a * @a)
+
+      @lambdaB = rad_to_deg(Math.atan(@yB / @xB))
+      @p = Math.sqrt((@xB * @xB) + (@yB * @yB))
+      @phiN = Math.atan(@zB / (@p * (1 - @eSquared)))
+      
+      (1..10).each do |i|
+        @v = @a / (Math.sqrt(1 - @eSquared * sin_pow_2(@phiN)))
+        @phiN1 = Math.atan((@zB + (@eSquared * @v * Math.sin(@phiN))) / @p)
+        @phiN = @phiN1
+      end
+
+      @phiB = rad_to_deg(@phiN)
+
+      { :latitude => @phiB, :longitude => @lambdaB }
+         
+    end
+  end
+
+end

data/lib/breasal/utils.rb

@@ -0,0 +1,31 @@
+module Breasal
+
+  module Utils    
+
+    def deg_to_rad(degrees)
+  	  degrees / 180.0 * Math::PI
+  	end
+
+  	def rad_to_deg(r)
+  	  (r/Math::PI)*180
+  	end
+
+  	def sin_pow_2(x)
+  	  Math.sin(x) * Math.sin(x)
+  	end
+
+  	def cos_pow_2(x)
+  	  Math.cos(x) * Math.cos(x)
+  	end
+
+  	def tan_pow_2(x)
+  	  Math.tan(x) * Math.tan(x)
+  	end
+
+  	def sec(x)
+  	  1.0 / Math.cos(x)
+  	end
+
+  end
+
+end

data/lib/breasal/version.rb

@@ -0,0 +1,3 @@
+module Breasal
+  VERSION = "0.0.1"
+end

data/spec/easting_northing_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Breasal::EastingNorthing do
+
+  context "When provided with a GB Easting and Northing" do
+    
+    it "returns the correct WGS84 latitude and longitude" do
+      en = Breasal::EastingNorthing.new(easting: 412617, northing: 308885)
+      
+      ll = en.to_wgs84
+      
+      ll[:latitude].should == 52.67752501534847
+      ll[:longitude].should == -1.8148108086293673
+    end
+    
+  end
+  
+  context "When provided with an Irish Easting and Northing" do
+    
+    it "returns the correct WGS84 latitude and longitude" do
+      en = Breasal::EastingNorthing.new(easting: 333832, northing: 374014, type: :ie)
+      
+      ll = en.to_wgs84
+      
+      ll[:latitude].should == 54.596642596875334
+      ll[:longitude].should == -5.930070032491946
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'breasal'
+
+RSpec.configure do |config|
+
+  config.order = "random"
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: breasal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: coveralls
+  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: travis
+  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: A Ruby gem that converts both British and Irish Eastings and northing
+  to WGS84 latitude and longitude
+email:
+- stuart.harrison@theodi.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- breasal.gemspec
+- lib/breasal.rb
+- lib/breasal/easting_northing.rb
+- lib/breasal/latlng.rb
+- lib/breasal/utils.rb
+- lib/breasal/version.rb
+- spec/easting_northing_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/theodi/breasal
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that converts both British and Irish Eastings and northing to
+  WGS84 latitude and longitude
+test_files:
+- spec/easting_northing_spec.rb
+- spec/spec_helper.rb