national_grid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91d57aee8d888d98b249a9b6a9441ba16e14f821
+  data.tar.gz: 586d14b009bc0408103838f903b03d712ce10b0d
+SHA512:
+  metadata.gz: 366673606396f5ced7ca47ce7d02551463681c13c0939a4a9a9944620e9740302ea502b3eca594d9f79de4b9cf55df4bab57f0eb9bdc284c1d70416b827f4bc2
+  data.tar.gz: f296578bb91fe0ff92d6b0cd8847b407df3d65e09ecf5bf97d25e64bced713113059c31caf34d1f773374fe2198709bc1580fb4eaf0bfa4981a161676891f36e

data/.gitignore

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ext/ostn02c"]
+	path = ext/ostn02c
+	url = git@github.com:jawj/OSTN02C.git

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,31 @@
+Copyright © 2014 Andrew Haines
+
+NationalGrid uses the OSTN02C implementation of the Ordnance Survey National
+Grid Transformation (OSTN02) and Ordnance Survey Geoid model (OSGM02).
+
+OSTN02C © 2014 George MacKerron
+
+OSTN02 and OSGM02 are trademarks of Ordnance Survey.
+OSTN02 and OSGM02 data © Crown copyright 2002. All rights reserved.
+
+
+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,29 @@
+# NationalGrid
+
+NationalGrid is a Ruby binding to [OSTN02C](https://github.com/jawj/OSTN02C), which converts between National Grid easting-northing coordinates (OSGB36) and GPS latitude-longitude coordinates (ETRS89) using the OSTN02 transformation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'national_grid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install national_grid
+
+## Usage
+
+```ruby
+require "national_grid"
+
+NationalGrid::EastingNorthing.new(362269.979, 169978.688, 54.467).to_latitude_longitude
+# => #<NationalGrid::LatitudeLongitude:0x3ff8f955f0b4 latitude=51.427547 longitude=-2.544076 elevation=104.018>
+
+NationalGrid::LatitudeLongitude.new(53.779110, -3.040455, 64.940).to_easting_northing
+# => #<NationalGrid::EastingNorthing:0x3ff8f995f04c easting=331534.545 northing=431920.763 elevation=12.636>
+```

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rake/testtask"
+require_relative "ext/ostn02c"
+
+CLEAN.include OSTN02C.object_path
+
+file OSTN02C.library => OSTN02C.sources do
+  OSTN02C.make or fail "Building libostn02 failed"
+end
+
+Rake::ExtensionTask.new "national_grid" do |ext|
+  ext.lib_dir = "lib/national_grid"
+end
+
+Rake::Task["compile"].prerequisites.unshift FileList[OSTN02C.library]
+
+Rake::TestTask.new "test" => "compile" do |test|
+  test.pattern = "test/**/*_test.rb"
+end
+
+task "default" => "test"

data/ext/national_grid/common.c

@@ -0,0 +1,6 @@
+#include <common.h>
+
+double default_to_zero(VALUE value) {
+  if (NIL_P(value)) return 0;
+  return NUM2DBL(value);
+}

data/ext/national_grid/common.h

@@ -0,0 +1,4 @@
+#pragma once
+#include <national_grid.h>
+
+double default_to_zero(VALUE value);

data/ext/national_grid/extconf.rb

@@ -0,0 +1,8 @@
+require "mkmf"
+require_relative "../ostn02c"
+
+dir_config "ostn02c", [OSTN02C.include_path], [OSTN02C.lib_path]
+
+abort "libostn02 not found" unless have_library "ostn02", "test(false)", "OSTN02.h"
+
+create_makefile "national_grid/national_grid"

data/ext/national_grid/national_grid.c

@@ -0,0 +1,10 @@
+#include <national_grid.h>
+
+VALUE mNationalGrid;
+
+void Init_national_grid() {
+  mNationalGrid = rb_define_module("NationalGrid");
+
+  Init_national_grid_easting_northing();
+  Init_national_grid_latitude_longitude();
+}

data/ext/national_grid/national_grid.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <ruby.h>
+#include <OSTN02.h>
+#include <common.h>
+#include <national_grid_easting_northing.h>
+#include <national_grid_latitude_longitude.h>
+
+extern VALUE mNationalGrid;

data/ext/national_grid/national_grid_easting_northing.c

@@ -0,0 +1,60 @@
+#include <national_grid_easting_northing.h>
+
+VALUE cNationalGridEastingNorthing;
+
+static EastingNorthing* easting_northing(VALUE self) {
+  EastingNorthing* data;
+  Data_Get_Struct(self, EastingNorthing, data);
+  return data;
+}
+
+static VALUE allocate(VALUE class) {
+  EastingNorthing* data = ALLOC(EastingNorthing);
+  return Data_Wrap_Struct(class, NULL, xfree, data);
+}
+
+static VALUE initialize(int argc, VALUE* argv, VALUE self) {
+  VALUE easting, northing, elevation;
+  rb_scan_args(argc, argv, "03", &easting, &northing, &elevation);
+
+  EastingNorthing* data = easting_northing(self);
+  data->e = default_to_zero(easting);
+  data->n = default_to_zero(northing);
+  data->elevation = default_to_zero(elevation);
+
+  return self;
+}
+
+static VALUE easting(VALUE self) {
+  return DBL2NUM(easting_northing(self)->e);
+}
+
+static VALUE northing(VALUE self) {
+  return DBL2NUM(easting_northing(self)->n);
+}
+
+static VALUE elevation(VALUE self) {
+  return DBL2NUM(easting_northing(self)->elevation);
+}
+
+static VALUE to_latitude_longitude(VALUE self) {
+  LatLonDecimal data = ETRS89LatLonFromETRS89EastingNorthing(ETRS89EastingNorthingFromOSGB36EastingNorthing(*easting_northing(self)));
+  if (data.geoid == 0) return Qnil;
+  return new_national_grid_latitude_longitude(data);
+}
+
+void Init_national_grid_easting_northing() {
+  cNationalGridEastingNorthing = rb_define_class_under(mNationalGrid, "EastingNorthing", rb_cObject);
+  rb_define_alloc_func(cNationalGridEastingNorthing, allocate);
+  rb_define_method(cNationalGridEastingNorthing, "initialize", initialize, -1);
+  rb_define_method(cNationalGridEastingNorthing, "easting", easting, 0);
+  rb_define_method(cNationalGridEastingNorthing, "northing", northing, 0);
+  rb_define_method(cNationalGridEastingNorthing, "elevation", elevation, 0);
+  rb_define_method(cNationalGridEastingNorthing, "to_latitude_longitude", to_latitude_longitude, 0);
+}
+
+VALUE new_national_grid_easting_northing(EastingNorthing data) {
+  VALUE instance = allocate(cNationalGridEastingNorthing);
+  *easting_northing(instance) = data;
+  return instance;
+}

data/ext/national_grid/national_grid_easting_northing.h

@@ -0,0 +1,6 @@
+#pragma once
+#include <national_grid.h>
+
+extern VALUE cNationalGridEastingNorthing;
+void Init_national_grid_easting_northing();
+VALUE new_national_grid_easting_northing(EastingNorthing data);

data/ext/national_grid/national_grid_latitude_longitude.c

@@ -0,0 +1,60 @@
+#include <national_grid_latitude_longitude.h>
+
+VALUE cNationalGridLatitudeLongitude;
+
+static LatLonDecimal* latitude_longitude(VALUE self) {
+  LatLonDecimal* data;
+  Data_Get_Struct(self, LatLonDecimal, data);
+  return data;
+}
+
+static VALUE allocate(VALUE class) {
+  LatLonDecimal* data = ALLOC(LatLonDecimal);
+  return Data_Wrap_Struct(class, NULL, xfree, data);
+}
+
+static VALUE initialize(int argc, VALUE* argv, VALUE self) {
+  VALUE latitude, longitude, elevation;
+  rb_scan_args(argc, argv, "03", &latitude, &longitude, &elevation);
+
+  LatLonDecimal* data = latitude_longitude(self);
+  data->lat = default_to_zero(latitude);
+  data->lon = default_to_zero(longitude);
+  data->elevation = default_to_zero(elevation);
+
+  return self;
+}
+
+static VALUE latitude(VALUE self) {
+  return DBL2NUM(latitude_longitude(self)->lat);
+}
+
+static VALUE longitude(VALUE self) {
+  return DBL2NUM(latitude_longitude(self)->lon);
+}
+
+static VALUE elevation(VALUE self) {
+  return DBL2NUM(latitude_longitude(self)->elevation);
+}
+
+static VALUE to_easting_northing(VALUE self) {
+  EastingNorthing data = OSGB36EastingNorthingFromETRS89EastingNorthing(ETRS89EastingNorthingFromETRS89LatLon(*latitude_longitude(self)));
+  if (data.geoid == 0) return Qnil;
+  return new_national_grid_easting_northing(data);
+}
+
+void Init_national_grid_latitude_longitude() {
+  cNationalGridLatitudeLongitude = rb_define_class_under(mNationalGrid, "LatitudeLongitude", rb_cObject);
+  rb_define_alloc_func(cNationalGridLatitudeLongitude, allocate);
+  rb_define_method(cNationalGridLatitudeLongitude, "initialize", initialize, -1);
+  rb_define_method(cNationalGridLatitudeLongitude, "latitude", latitude, 0);
+  rb_define_method(cNationalGridLatitudeLongitude, "longitude", longitude, 0);
+  rb_define_method(cNationalGridLatitudeLongitude, "elevation", elevation, 0);
+  rb_define_method(cNationalGridLatitudeLongitude, "to_easting_northing", to_easting_northing, 0);
+}
+
+VALUE new_national_grid_latitude_longitude(LatLonDecimal data) {
+  VALUE instance = allocate(cNationalGridLatitudeLongitude);
+  *latitude_longitude(instance) = data;
+  return instance;
+}

data/ext/national_grid/national_grid_latitude_longitude.h

@@ -0,0 +1,6 @@
+#pragma once
+#include <national_grid.h>
+
+extern VALUE cNationalGridLatitudeLongitude;
+void Init_national_grid_latitude_longitude();
+VALUE new_national_grid_latitude_longitude(LatLonDecimal data);

data/ext/ostn02c.rb

@@ -0,0 +1,52 @@
+require "rbconfig"
+require "fileutils"
+
+module OSTN02C
+  module_function
+
+  def make
+    compile and package
+  end
+
+  def compile
+    puts "Compiling libostn02"
+    FileUtils.mkdir_p object_path
+    Dir.chdir object_path do
+      system RbConfig.expand("$(CC) -I#{include_path} $(CPPFLAGS) $(CFLAGS) -c #{sources.join(" ")}")
+    end
+  end
+
+  def package
+    puts "Packaging libostn02"
+    FileUtils.mkdir_p lib_path
+    system RbConfig.expand("$(AR) -crsv #{library} #{objects}")
+  end
+
+  def sources
+    Dir.glob(File.join(include_path, "*.c"))
+  end
+
+  def objects
+    File.join(object_path, "*.o")
+  end
+
+  def library
+    File.join(lib_path, "libostn02.a")
+  end
+
+  def include_path
+    File.expand_path("ostn02c/OSTN02", __dir__)
+  end
+
+  def lib_path
+    File.join(output_path, "lib")
+  end
+
+  def object_path
+    File.join(output_path, "obj")
+  end
+
+  def output_path
+    File.expand_path("../tmp/ostn02c", __dir__)
+  end
+end

data/lib/national_grid/easting_northing.rb

@@ -0,0 +1,15 @@
+module NationalGrid
+  class EastingNorthing
+    include Inspect
+
+    def to_a
+      [easting, northing, elevation]
+    end
+
+    private
+
+    def inspect_attributes
+      "easting=%.3f northing=%.3f elevation=%.3f" % to_a
+    end
+  end
+end

data/lib/national_grid/inspect.rb

@@ -0,0 +1,7 @@
+module NationalGrid
+  module Inspect
+    def inspect
+      "#<#{self.class.name}:0x%x #{inspect_attributes}>" % object_id
+    end
+  end
+end

data/lib/national_grid/latitude_longitude.rb

@@ -0,0 +1,15 @@
+module NationalGrid
+  class LatitudeLongitude
+    include Inspect
+
+    def to_a
+      [latitude, longitude, elevation]
+    end
+
+    private
+
+    def inspect_attributes
+      "latitude=%.6f longitude=%.6f elevation=%.3f" % to_a
+    end
+  end
+end

data/lib/national_grid/version.rb

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

data/lib/national_grid.rb

@@ -0,0 +1,5 @@
+require "national_grid/version"
+require "national_grid/national_grid"
+require "national_grid/inspect"
+require "national_grid/easting_northing"
+require "national_grid/latitude_longitude"

data/national_grid.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "national_grid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "national_grid"
+  spec.version       = NationalGrid::VERSION
+  spec.authors       = ["Andrew Haines"]
+  spec.email         = ["andrew@haines.org.nz"]
+  spec.summary       = "Converts between Ordnance Survey National Grid easting-northing coordinates and GPS latitude-longitude coordinates"
+  spec.homepage      = "https://github.com/haines/national_grid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "minitest", "~> 5.3"
+end

data/test/national_grid/easting_northing_test.rb

@@ -0,0 +1,54 @@
+require "minitest/autorun"
+require "national_grid"
+
+module NationalGrid
+  class EastingNorthingTest < Minitest::Test
+    def test_initialize_with_defaults
+      point = EastingNorthing.new
+
+      assert_equal 0, point.easting
+      assert_equal 0, point.northing
+      assert_equal 0, point.elevation
+    end
+
+    def test_initialize_with_easting_and_northing
+      point = EastingNorthing.new(12345.6, 78901.2)
+
+      assert_equal 12345.6, point.easting
+      assert_equal 78901.2, point.northing
+      assert_equal 0, point.elevation
+    end
+
+    def test_initialize_with_easting_northing_and_elevation
+      point = EastingNorthing.new(12345.6, 78901.2, 345.6)
+
+      assert_equal 12345.6, point.easting
+      assert_equal 78901.2, point.northing
+      assert_equal 345.6, point.elevation
+    end
+
+    def test_inspect
+      assert_match /^#<NationalGrid::EastingNorthing:0x\h+ easting=12345.678 northing=90123.456 elevation=789.012>$/, EastingNorthing.new(12345.6779, 90123.4559, 789.0119).inspect
+    end
+
+    def test_to_a
+      assert_equal [12345.6, 78901.2, 345.6], EastingNorthing.new(12345.6, 78901.2, 345.6).to_a
+    end
+
+    def test_to_latitude_longitude
+      assert_close LatitudeLongitude.new(51.427547, -2.544076, 104.018), EastingNorthing.new(362269.979, 169978.688, 54.467).to_latitude_longitude
+    end
+
+    def test_to_latitude_longitude_when_outside_the_grid
+      assert_nil EastingNorthing.new(999999.999, 999999.999, 99.999).to_latitude_longitude
+    end
+
+    private
+
+    def assert_close(expected, actual)
+      assert_in_delta expected.latitude, actual.latitude, 0.5e-6
+      assert_in_delta expected.longitude, actual.longitude, 0.5e-6
+      assert_in_delta expected.elevation, actual.elevation, 0.5e-3
+    end
+  end
+end

data/test/national_grid/latitude_longitude_test.rb

@@ -0,0 +1,54 @@
+require "minitest/autorun"
+require "national_grid"
+
+module NationalGrid
+  class LatitudeLongitudeTest < Minitest::Test
+    def test_initialize_with_defaults
+      point = LatitudeLongitude.new
+
+      assert_equal 0, point.latitude
+      assert_equal 0, point.longitude
+      assert_equal 0, point.elevation
+    end
+
+    def test_initialize_with_latitude_and_longitude
+      point = LatitudeLongitude.new(12.3, 45.6)
+
+      assert_equal 12.3, point.latitude
+      assert_equal 45.6, point.longitude
+      assert_equal 0, point.elevation
+    end
+
+    def test_initialize_with_latitude_longitude_and_elevation
+      point = LatitudeLongitude.new(12.3, 45.6, 789.0)
+
+      assert_equal 12.3, point.latitude
+      assert_equal 45.6, point.longitude
+      assert_equal 789.0, point.elevation
+    end
+
+    def test_inspect
+      assert_match /^#<NationalGrid::LatitudeLongitude:0x\h+ latitude=12.345678 longitude=90.123456 elevation=789.012>$/, LatitudeLongitude.new(12.3456779, 90.1234559, 789.0119).inspect
+    end
+
+    def test_to_a
+      assert_equal [12.3, 45.6, 789.0], LatitudeLongitude.new(12.3, 45.6, 789.0).to_a
+    end
+
+    def test_to_easting_northing
+      assert_close EastingNorthing.new(331534.545, 431920.763, 12.636), LatitudeLongitude.new(53.779110, -3.040455, 64.940).to_easting_northing
+    end
+
+    def test_to_easting_northing_when_outside_the_grid
+      assert_nil LatitudeLongitude.new(-45.878761, 170.502798).to_easting_northing
+    end
+
+    private
+
+    def assert_close(expected, actual)
+      assert_in_delta expected.easting, actual.easting, 0.5e-3
+      assert_in_delta expected.northing, actual.northing, 0.5e-3
+      assert_in_delta expected.elevation, actual.elevation, 0.5e-3
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: national_grid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Haines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rake-compiler
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+description: 
+email:
+- andrew@haines.org.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ext/national_grid/common.c
+- ext/national_grid/common.h
+- ext/national_grid/extconf.rb
+- ext/national_grid/national_grid.c
+- ext/national_grid/national_grid.h
+- ext/national_grid/national_grid_easting_northing.c
+- ext/national_grid/national_grid_easting_northing.h
+- ext/national_grid/national_grid_latitude_longitude.c
+- ext/national_grid/national_grid_latitude_longitude.h
+- ext/ostn02c.rb
+- lib/national_grid.rb
+- lib/national_grid/easting_northing.rb
+- lib/national_grid/inspect.rb
+- lib/national_grid/latitude_longitude.rb
+- lib/national_grid/version.rb
+- national_grid.gemspec
+- test/national_grid/easting_northing_test.rb
+- test/national_grid/latitude_longitude_test.rb
+homepage: https://github.com/haines/national_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.2.2
+signing_key: 
+specification_version: 4
+summary: Converts between Ordnance Survey National Grid easting-northing coordinates
+  and GPS latitude-longitude coordinates
+test_files:
+- test/national_grid/easting_northing_test.rb
+- test/national_grid/latitude_longitude_test.rb