uk_county_locator 0.1.0

data/lib/uk_county_locator/polylines_service.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'polylines'
+require 'geokit'
+require 'parallel'
+
+# PolylinesService handles the decoding of polygon polyline data and provides
+# functionality to check if a given point (latitude, longitude) lies within
+# any of the provided polygons. It supports batch processing of multiple
+# polygons using parallel processing to improve performance.
+class PolylinesService
+  def initialize(lat:, lng:)
+    @point = Geokit::LatLng.new(lat, lng)
+  end
+
+  def polygon_to_array(polygon:)
+    Polylines::Decoder.decode_polyline(polygon).map { |lng, lat| Geokit::LatLng.new(lat, lng) }
+  end
+
+  def point_inside_polygon?(polygons)
+    return nil if @point.nil?
+
+    result = Parallel.map(polygons, in_processes: 4) do |name, polygon|
+      geo_polygon = Geokit::Polygon.new(polygon_to_array(polygon: polygon))
+
+      geo_polygon.contains?(@point) ? name : nil
+    end
+
+    result.compact.first
+  end
+end

data/lib/uk_county_locator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UkCountyLocator
+  VERSION = '0.1.0'
+end

data/lib/uk_county_locator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'uk_county_locator/argument_validator'
+require_relative 'uk_county_locator/locator'
+require_relative 'uk_county_locator/polygon_fetcher'
+require_relative 'uk_county_locator/version'
+
+# UkCountyLocator module provides functionality for locating counties
+# in the UK based on latitude and longitude coordinates. It supports
+# different types of county information, including historical, ceremonial,
+# and current county/ Unitary Authority data. The main method, `find_county`,
+# returns the relevant county data for the provided coordinates and type.
+# The method `find_polygon` will return the polygon for the requested county and type.
+module UkCountyLocator
+  class Error < StandardError; end
+  class InvalidArgumentError < Error; end
+
+  def self.find_county(lat:, lng:, type: :ceremonial)
+    validated_params = ArgumentValidator.new(request: :county, type: type, lat: lat, lng: lng)
+
+    Locator.new(validated_params.lat, validated_params.lng, type: validated_params.type).county_data
+  end
+
+  def self.find_polygon(county:, type: :ceremonial)
+    validated_params = ArgumentValidator.new(request: :data, type: type, county: county)
+
+    PolygonFetcher.new(type: validated_params.type).county_polygon(county)
+  end
+
+  def self.county_list(type: :ceremonial)
+    validated_params = ArgumentValidator.new(request: :data, type: type)
+
+    PolygonFetcher.new(type: validated_params.type).county_list
+  end
+end

data/sig/uk_county_locator.rbs

@@ -0,0 +1,4 @@
+module UkCountyLocator
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/uk_county_locator.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/uk_county_locator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'uk_county_locator'
+  spec.version = UkCountyLocator::VERSION
+  spec.authors = ['Edward Beesley']
+  spec.email = ['ed@homeflow.co.uk']
+
+  spec.summary = 'A Ruby gem that stores encoded polygon data for UK counties, ' \
+               'with the ability to return county information for given coordinates.'
+
+  spec.homepage = 'https://github.com/EdBeese/uk_county_locator'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/EdBeese/uk_county_locator'
+  spec.metadata['changelog_uri'] = 'https://github.com/EdBeese/uk_county_locator/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'geokit', '>= 1.0', '< 3.0'
+  spec.add_dependency 'parallel', '>= 1.0', '< 3.0'
+  spec.add_dependency 'polylines', '>= 0.1.1', '< 1.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: uk_county_locator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edward Beesley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: polylines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- ed@homeflow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uk_county_locator.rb
+- lib/uk_county_locator/aliases/ceremonial_county_aliases.rb
+- lib/uk_county_locator/aliases/current_county_and_unitary_authority_aliases.rb
+- lib/uk_county_locator/aliases/historic_county_aliases.rb
+- lib/uk_county_locator/argument_validator.rb
+- lib/uk_county_locator/locator.rb
+- lib/uk_county_locator/polygon_fetcher.rb
+- lib/uk_county_locator/polygons/ceremonial_county_polygons.rb
+- lib/uk_county_locator/polygons/current_county_and_unitary_authority_polygons.rb
+- lib/uk_county_locator/polygons/historic_county_polygons.rb
+- lib/uk_county_locator/polylines_service.rb
+- lib/uk_county_locator/version.rb
+- sig/uk_county_locator.rbs
+- uk_county_locator-0.0.2.gem
+- uk_county_locator.gemspec
+homepage: https://github.com/EdBeese/uk_county_locator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/EdBeese/uk_county_locator
+  source_code_uri: https://github.com/EdBeese/uk_county_locator
+  changelog_uri: https://github.com/EdBeese/uk_county_locator/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: A Ruby gem that stores encoded polygon data for UK counties, with the ability
+  to return county information for given coordinates.
+test_files: []