os_map_ref 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e402a08b5f2575a30def6376c195855cdd1c4537
-  data.tar.gz: 82f882c3c5cf7c12c54519747deee392f0ecfdda
+  metadata.gz: 408a8566ec988e46917ddec0ab4540092b446dcd
+  data.tar.gz: 91cbf8775320c6fab6668a02b8ef299e8c12525b
 SHA512:
-  metadata.gz: '079ba362e43f0993c800a7db2cde7ffddb1e1ba9ac2fb9a654cfb848dd129c5492952df2fa9fbf3f049560d0588fa06a49fc34f88925135f722e1681ddbaa892'
-  data.tar.gz: f49114adfdbbad429901f90e1df5b2050b2e778a487abadb76bdee5e753f12bd57d206a875806827e8521429ba4319085595e987865cc21e93d8f87a70430ab1
+  metadata.gz: 9a374de093e186f14ec61721c1652b25549d66ec66c027e1c9f9f2640a8bb778843c04a4954e60bde30fba3841b391e0d3ee08c53f8eb22c189b953c0bab324c
+  data.tar.gz: 82334f32ea0d3f8e0c7f9c1f528211e944a0cc34f79ea9ea1fa5c777b845cde1ad5adbf24b7de7917083ede26cc17a7d35233f23adc938ae37bf8ded92759be9

data/README.md

@@ -1,10 +1,9 @@
 # OsMapRef
 
-[![Build Status](https://travis-ci.org/DEFRA/os_map_ref.svg?branch=master)](https://travis-ci.org/DEFRA/os_map_ref)
-[![Maintainability](https://api.codeclimate.com/v1/badges/759edb337395f3c0e9d2/maintainability)](https://codeclimate.com/github/DEFRA/os_map_ref/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/759edb337395f3c0e9d2/test_coverage)](https://codeclimate.com/github/DEFRA/os_map_ref/test_coverage)
-[![security](https://hakiri.io/github/DEFRA/os_map_ref/master.svg)](https://hakiri.io/github/DEFRA/os_map_ref/master)
-[![Dependency Status](https://dependencyci.com/github/DEFRA/os_map_ref/badge)](https://dependencyci.com/github/DEFRA/os_map_ref)
+[![Build Status](https://travis-ci.org/DEFRA/os-map-ref.svg?branch=master)](https://travis-ci.org/DEFRA/os-map-ref)
+[![Maintainability](https://api.codeclimate.com/v1/badges/17df026b62cc3912f842/maintainability)](https://codeclimate.com/github/DEFRA/os-map-ref/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/17df026b62cc3912f842/test_coverage)](https://codeclimate.com/github/DEFRA/os-map-ref/test_coverage)
+[![security](https://hakiri.io/github/DEFRA/os-map-ref/master.svg)](https://hakiri.io/github/DEFRA/os-map-ref/master)
 [![Gem Version](https://badge.fury.io/rb/os_map_ref.svg)](https://badge.fury.io/rb/os_map_ref)
 
 This gem allows you to gather U.K. Ordnance Survey Eastings, North, and Map
@@ -83,9 +82,7 @@ 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`
-for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` 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`.
 

data/Rakefile

@@ -1,16 +1,29 @@
-require "bundler/gem_tasks"
-require "github_changelog_generator/task"
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
 
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+# rubocop:disable Lint/HandleExceptions
 begin
   require "rspec/core/rake_task"
+
   RSpec::Core::RakeTask.new(:spec)
-rescue LoadError => err
-  puts "Load error: #{err}"
-end
 
-task test: :spec
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+# rubocop:enable Lint/HandleExceptions
 
-task default: :test
+require "github_changelog_generator/task"
 
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
 end

data/lib/os_map_ref.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "os_map_ref/error"
 require "os_map_ref/input_processor"
 require "os_map_ref/location"

data/lib/os_map_ref/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OsMapRef
   class Error < StandardError; end
 end

data/lib/os_map_ref/input_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OsMapRef
   class InputProcessor
     attr_reader :input

data/lib/os_map_ref/location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "matrix"
 
 module OsMapRef

data/lib/os_map_ref/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OsMapRef
-  VERSION = "0.4.2".freeze
+  VERSION = "0.5.0"
 end

data/spec/os_map_ref/input_processor_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe OsMapRef::InputProcessor do
+
+  let(:map_reference) { "ST 58901 71053" }
+  let(:long_map_reference) { "HT 58901 71053" }
+  let(:easting) { "358901" }
+  let(:northing) { "171053" }
+
+  describe ".new" do
+    context "with map reference" do
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(map_reference)
+        expect(input_cleaner.params[:map_reference]).to eq(map_reference)
+      end
+    end
+
+    context "with map reference without spaces" do
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(map_reference.gsub(/\s+/, ""))
+        expect(input_cleaner.params[:map_reference]).to eq(map_reference)
+      end
+    end
+
+    context "with lower case map reference" do
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(map_reference.downcase)
+        expect(input_cleaner.params[:map_reference]).to eq(map_reference)
+      end
+    end
+
+    context "with long map reference" do
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(long_map_reference)
+        expect(input_cleaner.params[:map_reference]).to eq(long_map_reference)
+      end
+    end
+
+    context "with long map reference without spaces" do
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(long_map_reference.gsub(/\s+/, ""))
+        expect(input_cleaner.params[:map_reference]).to eq(long_map_reference)
+      end
+    end
+
+    context "with six figure map reference" do
+      let(:map_reference) { "ST589710" }
+      it "should return formated map reference" do
+        input_cleaner = described_class.new(map_reference)
+        expect(input_cleaner.params[:map_reference]).to eq("ST 58900 71000")
+      end
+    end
+
+    context "with easting and northings" do
+      let(:expected) { { easting: easting, northing: northing } }
+
+      it "should handle easting and nothing separated by space" do
+        input = [easting, northing].join(" ")
+        input_cleaner = described_class.new(input)
+        expect(input_cleaner.params).to eq(expected)
+      end
+
+      it "should handle easting and nothing separated by comma" do
+        input = [easting, northing].join(",")
+        input_cleaner = described_class.new(input)
+        expect(input_cleaner.params).to eq(expected)
+      end
+
+      it "should handle easting and nothing separated by space and space" do
+        input = [easting, northing].join(", ")
+        input_cleaner = described_class.new(input)
+        expect(input_cleaner.params).to eq(expected)
+      end
+    end
+
+    context "with short eastings and northings" do
+      it "should pad out short input" do
+        input = "123 456"
+        input_cleaner = described_class.new(input)
+        expected = { easting: "123000", northing: "456000" }
+        expect(input_cleaner.params).to eq(expected)
+      end
+    end
+
+    context "with short eastings and northings, but longer northing" do
+      it "should pad out short input" do
+        input = "456 1234"
+        input_cleaner = described_class.new(input)
+        expected = { easting: "456000", northing: "1234000" }
+        expect(input_cleaner.params).to eq(expected)
+      end
+    end
+
+    context "with decimals in eastings and northings" do
+      it "should pass on the decimal elements" do
+        input = "308901.4,101053.3"
+        input_cleaner = described_class.new(input)
+        expected = { easting: "308901.4", northing: "101053.3" }
+        expect(input_cleaner.params).to eq(expected)
+      end
+    end
+
+    it "should raise error on unknown input" do
+      expect { described_class.new("unknown").params }.to raise_error(OsMapRef::Error)
+    end
+  end
+end

data/spec/os_map_ref/location_spec.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe OsMapRef::Location do
+
+  let(:map_reference) { "ST 58901 71053" }
+  let(:easting) { "358901" }
+  let(:northing) { "171053" }
+  let(:long_map_reference) { "HT 58901 71053" }
+  let(:long_northing) { "1171053" }
+
+  describe ".for" do
+    it "should accept a map reference" do
+      location = described_class.for map_reference
+      expect(location.map_reference).to eq(map_reference)
+    end
+
+    it "should accept a map reference without space" do
+      location = described_class.for map_reference.delete(" ")
+      expect(location.map_reference).to eq(map_reference)
+    end
+
+    it "should accept a downcase map reference" do
+      location = described_class.for map_reference.downcase
+      expect(location.map_reference).to eq(map_reference)
+    end
+
+    it "should accept easting and northing" do
+      location = described_class.for [easting, northing].join(" ")
+      expect(location.map_reference).to eq(map_reference)
+    end
+  end
+
+  describe ".new" do
+    it "should accept easting and northing strings" do
+      location = described_class.new easting: easting.to_s, northing: northing.to_s
+      expect(location.easting).to eq(easting)
+      expect(location.northing).to eq(northing)
+    end
+
+    context "when initiated with map_reference" do
+      let(:location) { described_class.new map_reference: map_reference }
+
+      describe ".map_reference" do
+        it "should return input" do
+          expect(location.map_reference).to eq(map_reference)
+        end
+      end
+
+      describe ".easting" do
+        it "should be calculated from map_reference" do
+          expect(location.easting).to eq(easting)
+        end
+      end
+
+      describe ".northing" do
+        it "should be calculated from map_reference" do
+          expect(location.northing).to eq(northing)
+        end
+      end
+    end
+
+    context "when initiated with easting and northing" do
+      let(:location) { described_class.new easting: easting, northing: northing }
+
+      describe ".map_reference" do
+        it "should be calculated from easting and northing" do
+          expect(location.map_reference).to eq(map_reference)
+        end
+      end
+
+      describe ".easting" do
+        it "should return input" do
+          expect(location.easting).to eq(easting)
+        end
+      end
+
+      describe ".northing" do
+        it "should return input" do
+          expect(location.northing).to eq(northing)
+        end
+      end
+
+      describe ".grid_easting" do
+        it "should be first number of easting" do
+          expect(location.grid_easting).to eq(3)
+        end
+      end
+
+      describe ".short_easting" do
+        it "should be number after first number of easting" do
+          expect(location.short_easting).to eq("58901")
+        end
+      end
+
+      describe ".grid_northing" do
+        it "should be first number of northing" do
+          expect(location.grid_northing).to eq(1)
+        end
+      end
+
+      describe ".short_northing" do
+        it "should be number after first number of northing" do
+          expect(location.short_northing).to eq("71053")
+        end
+      end
+    end
+
+    context "when initiated with easting and long northing" do
+      let(:location) { described_class.new easting: easting, northing: long_northing }
+
+      describe ".grid_northing" do
+        it "should be the first two numbers of northing" do
+          expect(location.grid_northing).to eq(11)
+        end
+      end
+
+      describe ".short_northing" do
+        it "should be the number after the first two numbers of northing" do
+          expect(location.short_northing).to eq("71053")
+        end
+      end
+    end
+
+    context "when eastings and northing second character a zero" do
+      let(:map_reference) { "ST 08901 01053" }
+      let(:easting) { "308901" }
+      let(:northing) { "101053" }
+      let(:location) { described_class.new easting: easting, northing: northing }
+
+      describe ".map_reference" do
+        it "should be calculated from easting and northing" do
+          expect(location.map_reference).to eq(map_reference)
+        end
+      end
+    end
+
+    context "when eastings and northing contain decimals" do
+      let(:map_reference) { "ST 08901 01053" }
+      let(:easting) { "308901.4" }
+      let(:northing) { "101053.3" }
+      let(:location) { described_class.new easting: easting, northing: northing }
+
+      describe ".map_reference" do
+        it "should be calculated from easting and northing" do
+          expect(location.map_reference).to eq(map_reference)
+        end
+      end
+    end
+
+    context "when eastings and northing is one unit into grid from origin" do
+      let(:map_reference) { "SV 00001 00001" }
+      let(:easting) { "000001" }
+      let(:northing) { "000001" }
+
+      context "and eastings and northings defined" do
+        let(:location) { described_class.new easting: easting, northing: northing }
+
+        describe ".map_reference" do
+          it "should be calculated from easting and northing" do
+            expect(location.map_reference).to eq(map_reference)
+          end
+        end
+      end
+
+      context "and map reference is defined" do
+        let(:location) { described_class.new map_reference: map_reference }
+
+        describe ".easting" do
+          it "should be calculated from map_reference" do
+            expect(location.easting).to eq(easting)
+          end
+        end
+
+        describe ".northing" do
+          it "should be calculated from map_reference" do
+            expect(location.northing).to eq(northing)
+          end
+        end
+      end
+
+      context "when grid_reference prefix not in grid" do
+        let(:map_reference) { "zz 00001 00001" }
+        let(:location) { described_class.new map_reference: map_reference }
+
+        it "should raise an exception" do
+          expect { location.easting }.to raise_error(OsMapRef::Error)
+        end
+
+      end
+    end
+
+    context "when northing is long" do
+      let(:map_reference) { long_map_reference }
+      let(:northing) { long_northing }
+
+      context "and eastings and northings defined" do
+        let(:location) { described_class.new easting: easting, northing: northing }
+
+        describe ".map_reference" do
+          it "should be calculated from easting and northing" do
+            expect(location.map_reference).to eq(map_reference)
+          end
+        end
+      end
+
+      context "and map reference is defined" do
+        let(:location) { described_class.new map_reference: map_reference }
+
+        describe ".easting" do
+          it "should be calculated from map_reference" do
+            expect(location.easting).to eq(easting)
+          end
+        end
+
+        describe ".northing" do
+          it "should be calculated from map_reference" do
+            expect(location.northing).to eq(northing)
+          end
+        end
+      end
+    end
+  end
+
+  describe ".remove_decimals" do
+    let(:location) { described_class.new map_reference: map_reference }
+
+    it "should return the number if no decimals" do
+      expect(location.remove_decimals("308901")).to eq("308901")
+    end
+
+    it "should return the number with decimals removed" do
+      expect(location.remove_decimals("308901.4")).to eq("308901")
+    end
+  end
+end

data/spec/os_map_ref_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+
+describe OsMapRef do
+
+  describe "::VERSION" do
+    it "should be a string" do
+      expect(described_class::VERSION).to be_a(String)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Code coverage
+require "simplecov"
+
+SimpleCov.start do
+  # any custom configs like groups and filters can be here at a central place
+
+  # Standard filters
+  add_filter "lib/os_map_ref/version"
+  # It's standard to ignore the spec folder when determining coverage
+  add_filter "/spec/"
+
+  # You can make Simplecov ignore sections of by wrapping them in # :nocov:
+  # tags. However without knowledge of this `nocov` doesn't mean a lot so here
+  # we take advantage of a feature that allows us to use a custom token to do
+  # the same thing `nocov` does. Now in our code any sections we want to exclude
+  # from test coverage stats we wrap in # :simplecov_ignore: tokens.
+  # https://github.com/colszowka/simplecov#ignoringskipping-code
+  nocov_token "simplecov_ignore"
+end
+
+require_relative "../lib/os_map_ref"
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 2
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: os_map_ref
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
-- Environment Agency
+- Defra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: github_changelog_generator
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,13 +88,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -105,10 +98,13 @@ files:
 - 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/DEFRA/os_map_ref
+- spec/os_map_ref/input_processor_spec.rb
+- spec/os_map_ref/location_spec.rb
+- spec/os_map_ref_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DEFRA/os-map-ref
 licenses:
-- Nonstandard
+- The Open Government Licence (OGL) Version 3
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -118,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -126,9 +122,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 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: []
+test_files:
+- spec/spec_helper.rb
+- spec/os_map_ref/location_spec.rb
+- spec/os_map_ref/input_processor_spec.rb
+- spec/os_map_ref_spec.rb

data/.codeclimate.yml

@@ -1,19 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-  reek:
-    enabled: true
-ratings:
-  paths:
-  - "**.module"
-  - "**.rb"
-exclude_paths:
-- spec/

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,122 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.2
-  # Cop names are not displayed in offense messages by default. We find it useful to include this information so we can
-  # use it to investigate what the fix may be.
-  DisplayCopNames: true
-  # Style guide URLs are not displayed in offense messages by default. Again we find it useful to go straight to the
-  # documentation for a rule when investigating what the fix may be.
-  DisplayStyleGuide: true
-  Include:
-    - "**/*.gemspec"
-    - "**/*.rake"
-    - "**/*.rb"
-    - "**/Gemfile"
-    - "**/Rakefile"
-  Exclude:
-    - "**/bin/*"
-
-# Rubymine disagrees and not sure how to fix Rubymine indentation right now
-Layout/CaseIndentation:
-  Enabled: false
-
-# We believe it looks cluttered not having the ability to have empty lines after
-# the module, class, and block declarations
-Layout/EmptyLinesAroundBlockBody:
-  Enabled: false
-Layout/EmptyLinesAroundModuleBody:
-  Enabled: false
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# Without this exclusion a line like this `expect { subject.call }` will get
-# flagged as an error by Rubocop. This is a deliberate idiom in rspec so rather
-# than add exceptions where it is used, we exclude spec's from this rule here.
-# https://github.com/bbatsov/rubocop/issues/4222
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*"
-
-# TODO: Understand what the issue is and whether this needs to be more formally disabled (i.e. the dev team agree)
-# We don't understand this for now - seems to prevent perfectly reasonable meta-programming
-Lint/NestedMethodDefinition:
-  Enabled: false
-
-# We felt as a team that the default size of 15 was too low, and blocked what to us are sound methods which would not
-# add any value if broken up, for exampler composer type methods. Therefore we agreed to up the score to 20 to allow
-# for these types of methods
-Metrics/AbcSize:
-  Max: 40
-
-# We don't feel we can help having a large gemspec, hence we exclude it.
-# We don't feel it makes sense to split specs and factories over multiple files,
-# or when in a context be forced to try and come up with slightly different ones
-# in order to reduce the block length. Hence we exclude specs and factories from
-# this rule.
-# Shared examples are the same as specs, but don't have the _spec.rb extension
-# hence they are listed separately
-Metrics/BlockLength:
-  Exclude:
-    - "**/*.gemspec"
-    - "**/spec/**/*_spec.rb"
-    - "**/spec/**/*_factory.rb"
-    - "**/spec/shared_examples/*.rb"
-
-# We believe the default of 10 lines for a method length is too restrictive and often quickly hit just because we need
-# to specify the namesspace, class and method before then doing something with it.
-Metrics/MethodLength:
-  Max: 30
-Metrics/ModuleLength:
-  Max: 400
-  Exclude:
-    - "**/spec/**/*_spec.rb"
-
-# We believe the default 80 characters is too restrictive and that lines can still be readable and maintainable
-# when no more than 120 characters. This also allows us to maximise our screen space.
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - "**spec/factories/**/*.rb"
-    - "**spec/features/**/*_spec.rb"
-    - "**spec/models/**/*_spec.rb"
-    - "**spec/policies/**/*_spec.rb"
-    - "**spec/routing/**/*_spec.rb"
-
-# Turn these off as can totally mess with the expect{...}.to syntax
-# Also reports on model validations using Proc.new { style blocks but trying to use do .. end raises invalid syntax
-Style/BlockDelimiters:
-  Exclude:
-    - "**spec/**/*_spec.rb"
-
-# As a web app, as long as the team commit to using well named classes for
-# controllers, models etc it should not be necessary to add top-level class
-# documentation.
-Style/Documentation:
-  Enabled: false
-
-# We've found the sprintf style for formatting strings can be useful when storing a formatted string as a template,
-# and passing in strings that can vary with context. Therefore we chose to disable this rule.
-Style/FormatString:
-  Enabled: false
-
-# When using Ruby >= 2.3, Rubocop wants to add a comment to the top of *.rb
-# to aid migration to frozen literals in Ruby 3.0. We are not interested in
-# modifying every file at this point, so this cop is disabled for now.
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# In specs we like to use the pattern of updating within an expect do block and
-# then asserting a given attribute has changed as a result. This requires
-# chaining hence we exclude specs from this rule
-Style/MethodCalledOnDoEndBlock:
-  Exclude:
-    - "**/spec/**/*_spec.rb"
-
-# There are no relative performance improvements using '' over "", therefore we believe there is more
-# value in using "" for all strings irrespective of whether string interpolation is used
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# Rubocop 0.42 introduced this cop - disabling for now until we have time to resolve
-# the issues it raises.
-Style/MethodMissing:
-  Enabled: false

data/.travis.yml

@@ -1,31 +0,0 @@
-# Needed as part of submitting test coverage statistics to CodeClimate as part
-# of the build
-# https://docs.codeclimate.com/v1.0/docs/travis-ci-test-coverage
-env:
-  global:
-    - CC_TEST_REPORTER_ID=df8a9d5af846f573eb944b1e7ba0ea40ec79efe0f3350af095054e2d5a6f2d56
-
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.2.3
-
-# Travis CI clones repositories to a depth of 50 commits, which is only really
-# useful if you are performing git operations.
-# https://docs.travis-ci.com/user/customizing-the-build/#Git-Clone-Depth
-git:
-  depth: 3
-
-before_script:
-  # Setup to support the CodeClimate test coverage submission
-  # As per CodeClimate's documentation, they suggest only running
-  # ./cc-test-reporter commands on travis-ci push builds only. Hence we wrap all
-  # the codeclimate test coverage related commands in a check that tests if we
-  # are in a pull request or not.
-  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter; fi
-  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then chmod +x ./cc-test-reporter; fi
-  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter before-build; fi
-
-after_script:
-  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi

data/CHANGELOG.md

@@ -1,61 +0,0 @@
-# Change Log
-
-## [v0.4.2](https://github.com/DEFRA/os_map_ref/tree/v0.4.2) (2017-10-30)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.4.1...v0.4.2)
-
-**Merged pull requests:**
-
-- Bump version no. for release of v0.4.2 [\#19](https://github.com/DEFRA/os_map_ref/pull/19) ([Cruikshanks](https://github.com/Cruikshanks))
-- Add changelog and ability to auto generate it [\#18](https://github.com/DEFRA/os_map_ref/pull/18) ([Cruikshanks](https://github.com/Cruikshanks))
-- Fix badge links in README pointing 2 old EA Github [\#17](https://github.com/DEFRA/os_map_ref/pull/17) ([Cruikshanks](https://github.com/Cruikshanks))
-- Fix and update codeclimate and travis-ci config [\#16](https://github.com/DEFRA/os_map_ref/pull/16) ([Cruikshanks](https://github.com/Cruikshanks))
-- Add std rubocop config and resolve issues found [\#15](https://github.com/DEFRA/os_map_ref/pull/15) ([Cruikshanks](https://github.com/Cruikshanks))
-- Correct details in gemspec [\#14](https://github.com/DEFRA/os_map_ref/pull/14) ([Cruikshanks](https://github.com/Cruikshanks))
-- Integrate project with Hakiri [\#13](https://github.com/DEFRA/os_map_ref/pull/13) ([Cruikshanks](https://github.com/Cruikshanks))
-
-## [v0.4.1](https://github.com/DEFRA/os_map_ref/tree/v0.4.1) (2016-05-17)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.4.0...v0.4.1)
-
-**Merged pull requests:**
-
-- Confirm codeclimate api key [\#12](https://github.com/DEFRA/os_map_ref/pull/12) ([Cruikshanks](https://github.com/Cruikshanks))
-- Integrate project with codeclimate [\#11](https://github.com/DEFRA/os_map_ref/pull/11) ([Cruikshanks](https://github.com/Cruikshanks))
-- Add version badge to README [\#10](https://github.com/DEFRA/os_map_ref/pull/10) ([Cruikshanks](https://github.com/Cruikshanks))
-
-## [v0.4.0](https://github.com/DEFRA/os_map_ref/tree/v0.4.0) (2016-04-05)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.3.0...v0.4.0)
-
-**Merged pull requests:**
-
-- Correct error in grid: skipped K instead of I in right-hand portion [\#9](https://github.com/DEFRA/os_map_ref/pull/9) ([reggieb](https://github.com/reggieb))
-- Fix/improve range of inputs accepted [\#8](https://github.com/DEFRA/os_map_ref/pull/8) ([reggieb](https://github.com/reggieb))
-
-## [v0.3.0](https://github.com/DEFRA/os_map_ref/tree/v0.3.0) (2016-04-04)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.2.0...v0.3.0)
-
-**Closed issues:**
-
-- Convert tests to Rspec [\#2](https://github.com/DEFRA/os_map_ref/issues/2)
-
-**Merged pull requests:**
-
-- Changes tests over to rspec [\#7](https://github.com/DEFRA/os_map_ref/pull/7) ([reggieb](https://github.com/reggieb))
-- Update contribution section in README [\#6](https://github.com/DEFRA/os_map_ref/pull/6) ([Cruikshanks](https://github.com/Cruikshanks))
-- Update travis configuration for repo [\#5](https://github.com/DEFRA/os_map_ref/pull/5) ([Cruikshanks](https://github.com/Cruikshanks))
-- Bump version to 0.2.0 [\#4](https://github.com/DEFRA/os_map_ref/pull/4) ([reggieb](https://github.com/reggieb))
-
-## [v0.2.0](https://github.com/DEFRA/os_map_ref/tree/v0.2.0) (2016-03-30)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.1.1...v0.2.0)
-
-**Merged pull requests:**
-
-- fixed typo in prefix matrix [\#3](https://github.com/DEFRA/os_map_ref/pull/3) ([kennyevil](https://github.com/kennyevil))
-- Add license details to README [\#1](https://github.com/DEFRA/os_map_ref/pull/1) ([Cruikshanks](https://github.com/Cruikshanks))
-
-## [v0.1.1](https://github.com/DEFRA/os_map_ref/tree/v0.1.1) (2016-03-24)
-[Full Changelog](https://github.com/DEFRA/os_map_ref/compare/v0.1.0...v0.1.1)
-
-## [v0.1.0](https://github.com/DEFRA/os_map_ref/tree/v0.1.0) (2016-03-23)
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

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

data/os_map_ref.gemspec

@@ -1,33 +0,0 @@
-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       = ["Environment Agency"]
-  spec.email         = ["alan.cruikshanks@environment-agency.gov.uk"]
-
-  # rubocop:disable Metrics/LineLength
-  spec.summary       = "A tool to help handle UK Ordnance Survey map references, in particular to convert them to other coordinate systems"
-  spec.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"
-  # rubocop:enable Metrics/LineLength
-  spec.homepage      = "https://github.com/DEFRA/os_map_ref"
-  spec.license       = "Nonstandard"
-
-  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.required_ruby_version = ">= 1.9"
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov", "~> 0.13"
-  spec.add_development_dependency "github_changelog_generator"
-end