uk_county_locator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f80e2a756a051daa471e931e2a6a873d3bcd6cb1cb70982615db766d640e121a
-  data.tar.gz: 84f0c67cdc2e61b1a10b0a7df7de88f3d71c6ad304935f2527128c85c9f9e405
+  metadata.gz: 11e8ea68871c3be4cf5946c13058ea2948a25e5ace07914c6330ae576ac73fec
+  data.tar.gz: 7e1ec0119646dd94fdadb82f1085b67eab224f838d7fb3d7d309fb1850413052
 SHA512:
-  metadata.gz: b1f68ea7ca094210af2fb2f3802e07226309bf612a6b8dd25d79c55c60baa7ee959bcc4262f794456d19db06173f2aa915c650de1650328b74f2538b082eebfc
-  data.tar.gz: 4346bc8f9577b663a8b57a139d11ee8fab609a4c8373ecb8573845437dfd7d448f7f15781ba1efea4e0cc591d757c43b6db467e1937b64a4205882fc50cfc58a
+  metadata.gz: 3d407a46d1cfec80b9e14135b730617107cb857ea0be59bf1cd36b656742da1eb5303cc93fdea45fa2ff7e49ed877b01ae86efd575c722654dbb13279d79cc53
+  data.tar.gz: 3c818bac421056fc4f7078f8d5b648d459f1c47e0cac587a2882ca861688dacd8c0b7ccbc0a7698a9d0923db92bd362edfd99a3f29830c9897413d7836603b0f

data/README.md

@@ -65,6 +65,23 @@ puts polygon # => "iah@mrgyHs@tTkk@zc@jz@h{@kLnr@jo@rWal@}Rrk@za@UjMdhAb_@t|Bjn@
 
 The gem will support a number of common aliases for county names, in as far as is feasible, including shorthand abbreviations, such as 'Herts', 'Beds' and 'Bucks', as well as Welsh, Irish and Scots Gaelic languages, and more subtle alternative names.
 
+```ruby
+polygon = UkCountyLocator.find_polygon(county: 'Londonderry', type: :ceremonial)
+puts polygon # => "lhhk@geboIEHA?????_eAtQi`CtL}_..."
+
+polygon = UkCountyLocator.find_polygon(county: 'Derry', type: :ceremonial)
+puts polygon # => "lhhk@geboIEHA?????_eAtQi`CtL}_..."
+
+polygon = UkCountyLocator.find_polygon(county: 'derry', type: :ceremonial)
+puts polygon # => "lhhk@geboIEHA?????_eAtQi`CtL}_..."
+
+polygon = UkCountyLocator.find_polygon(county: 'Co Derry', type: :ceremonial)
+puts polygon # => "lhhk@geboIEHA?????_eAtQi`CtL}_..."
+
+polygon = UkCountyLocator.find_polygon(county: 'Contae Dhoire', type: :ceremonial)
+puts polygon # => "lhhk@geboIEHA?????_eAtQi`CtL}_..."
+```
+
 #### Fetching the County List
 
 It is also possible to fetch the list of counties, per type (alphabetised):
@@ -73,6 +90,50 @@ county_list = UkCountyLocator.county_list(type: :ceremonial)
 puts county_list # => ["Bedfordshire", "Berkshire", "Bristol", "Buckinghamshire", "Cambridgeshire", ...]
 ```
 
+## Errors & Rescues
+The gem is able to sanitize data inputs to a point, and where invalid arguments are passed in, it is designed to error loudly.
+
+For example, string numeric values can be passed in:
+```ruby
+county = UkCountyLocator.find_county(lat: '51.5074', lng: '-0.1278')
+puts county # => "Greater London"
+
+county = UkCountyLocator.find_county(lat: 'foo', lng: 'bar')
+# => UkCountyLocator::InvalidArgumentError (Invalid lat format: 'foo')
+
+county = UkCountyLocator.find_county(lat: :foo, lng: :bar)
+# => UkCountyLocator::InvalidArgumentError (Expected lat to be Numeric or a String, got Symbol)
+
+county = UkCountyLocator.find_county(lat: nil, lng: nil)
+# => UkCountyLocator::InvalidArgumentError (Expected lat to be Numeric or a String, got NilClass)
+
+county = UkCountyLocator.find_county(lat: 51.5074, lng: -0.1278, type: 'Ceremonial')
+puts county # => "Greater London"
+
+county = UkCountyLocator.find_county(lat: 51.5074, lng: -0.1278, type: :postal)
+# => UkCountyLocator::InvalidArgumentError (Invalid input: type must be one of :current, :ceremonial, :historic., or :all, got postal)
+
+polygon = UkCountyLocator.find_polygon(county: 123)
+# => UkCountyLocator::InvalidArgumentError (Expected county to be a String, got Integer)
+
+polygon = UkCountyLocator.find_polygon(county: nil)
+# => UkCountyLocator::InvalidArgumentError (Expected county to be a String, got NilClass)
+
+county_list = UkCountyLocator.county_list(type: 'foo')
+# => UkCountyLocator::InvalidArgumentError (Invalid input: type must be one of :current, :ceremonial, :historic., got foo)
+```
+Note that the gem will infer the `:ceremonial` `:type` if an explicit `nil` value passed in:
+```ruby
+county = UkCountyLocator.find_county(lat: 51.5074, lng: -0.1278, type: nil)
+puts county # => "Greater London"
+
+polygon = UkCountyLocator.find_polygon(county: 'Greater London', type: nil)
+puts polygon # => "iah@mrgyHs@tTkk@zc@jz@h{@kLnr@jo@rWal@}Rrk@za@UjMdhAb_@t|Bjn@`h@|mAzs@kMl\\h..."
+
+county_list = UkCountyLocator.county_list(type: nil)
+puts county_list # => ["Bedfordshire", "Berkshire", "Bristol", "Buckinghamshire", "Cambridgeshire", ...]
+```
+
 ## County Type Definitions
 There are three sets of county data within the gem.  The definitions between the three sets will differ between the four constituent countries of the United Kingdom, but are defined as per these Wikipedia links:
 
@@ -124,7 +185,7 @@ See image of Orkney Islands polygon:
 
 
 ### Rivers, Tributaries and Coastal Lines
-In order to compress the polygon areas, the boundaries that cover coastal lines have been more roughly drawn, with fewer coordinate points.  The polygons are continuous where larger rivers and tributaries, where the same county on both sides.  This means that coordinates that fall in the river will return the county as a result.
+In order to compress the polygon areas, the boundaries that cover coastal lines have been more roughly drawn, with fewer coordinate points.  The polygons are continuous where larger rivers and tributaries cut into a county area that falls on both sides of said river.  This means that coordinates that fall in the river will return the county as a result.
 
 For example, coordinates that fall within the river Thames, where Greater London is on both sides of the river, will return 'Greater London' as the ceremonial county.
 

data/lib/uk_county_locator/argument_validator.rb

@@ -10,15 +10,16 @@ module UkCountyLocator
     def initialize(request:, type:, lat: nil, lng: nil, county: nil)
       @request = request
       @type = verified_type(type)
-      @lat = parse_coordinate(lat, 'lat') if lat
-      @lng = parse_coordinate(lng, 'lat') if lat
-      @county = validated_county(county) if county
+      @lat = parse_coordinate(lat, 'lat') if @request == :county
+      @lng = parse_coordinate(lng, 'lat') if @request == :county
+      @county = validated_county(county) if @request == :polygon
     end
 
     private
 
     def verified_type(type)
       type = type&.downcase&.to_sym
+      return :ceremonial if type.nil?
       return type if valid_county_type?(type)
 
       raise InvalidArgumentError, "Invalid input: type must be one of :current, :ceremonial, :historic.#{all_message}"\

data/lib/uk_county_locator/version.rb

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

data/lib/uk_county_locator.rb

@@ -22,13 +22,13 @@ module UkCountyLocator
   end
 
   def self.find_polygon(county:, type: :ceremonial)
-    validated_params = ArgumentValidator.new(request: :data, type: type, county: county)
+    validated_params = ArgumentValidator.new(request: :polygon, 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)
+    validated_params = ArgumentValidator.new(request: :list, type: type)
 
     PolygonFetcher.new(type: validated_params.type).county_list
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uk_county_locator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Edward Beesley
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geokit