addressing 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c92e35c1ba9b99ef0f8614354be6ce1140417527f1e3b53d97f5e03e430f42
-  data.tar.gz: fdc66a367d15c31344f36e82db8c5740d57eefb34dc9e9219822bb5de4b2501d
+  metadata.gz: 0f6ea26657e38313826abc6c9dbab406b426b07ac6d03af922ab130d6b00e29f
+  data.tar.gz: d3037ec9973ae1e7f0054eece0bd3e1a7a683eda4f2c4b1ad04294b3112684c6
 SHA512:
-  metadata.gz: c30cd13e71d74a015a551975032e0800b44ccded30378fee6c1603572bf2a8dee27f57dfda894ac358ff33e26407692ed11d0e9d7ef72f3a67756e77295f812f
-  data.tar.gz: 35897859d6db9035e7fdde7282af57ebe042034a8d759a5eb8a9a79d76b91ea30ed6a5e84403c8ee74071f10c6d8879adf421d56037b5d641f8b384d22a6fd98
+  metadata.gz: 6db0b294a6ee4fb0cbb787a86e0fe506c539ea5a94ae7cb170373524540dd44a2139c90d0b6951d34728b42b19a84e3eed60bb7d50e8685ce4b65f9c21bbabb6
+  data.tar.gz: d6a857986eff573f2e136ccd1a07eb8b0da618ce00cb78af44590708a7dca54a79f1facbd2bd48ab48a9bcd66f7cce919e0c3d906572c8eebc40f12f0b5e976a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `addressing` will be documented in this file.
 
+## 0.2.0 (25-02-2022)
+
+- Add ActiveRecord validations
+
 ## 0.1.1 (21-02-2022)
 
 - Fix typo in DE custom format

data/README.md

@@ -172,6 +172,16 @@ p formatter.format(address, origin_country: "FR")
 # ÉTATS-UNIS - UNITED STATES
 ```
 
+### Validating addresses
+
+For Active Record models, use:
+
+```rb
+class User < ApplicationRecord
+  validates_address_format
+end
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
@@ -203,5 +213,3 @@ Feel free to open an issue to get feedback on your idea before spending too much
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
-
-https://github.com/countries/countries/blob/eddb4af3889e5c8b66d897f9789d43c4a1ee0598/spec/thread_safety_spec.rb

data/data/country/zh.json

@@ -35,7 +35,6 @@
   "MK": "北马其顿",
   "BJ": "贝宁",
   "BE": "比利时",
-  "PE": "秘鲁",
   "IS": "冰岛",
   "PR": "波多黎各",
   "PL": "波兰",
@@ -149,6 +148,7 @@
   "MN": "蒙古",
   "MS": "蒙特塞拉特",
   "BD": "孟加拉国",
+  "PE": "秘鲁",
   "FM": "密克罗尼西亚",
   "MM": "缅甸",
   "MD": "摩尔多瓦",

data/lib/addressing/lazy_subdivisions.rb

@@ -18,6 +18,11 @@ module Addressing
       @subdivisions.any?
     end
 
+    def empty?
+      do_initialize unless @initialized
+      @subdivisions.empty?
+    end
+
     private
 
     def do_initialize

data/lib/addressing/model.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Addressing
+  module Model
+    def validates_address_format(**options)
+      class_eval do
+        validate :verify_address_format, **options
+
+        define_method :verify_address_format do
+          fields = [:country_code, :administrative_area, :locality, :dependent_locality, :postal_code, :sorting_code, :address_line1, :address_line2, :organization, :given_name, :additional_name, :family_name, :locale].each_with_object({}) do |field, fields|
+            fields[field] = send(field)
+          end
+
+          address = Address.new(**fields)
+          return unless address.country_code.present?
+
+          address_format = AddressFormat.get(address.country_code)
+          address_format.used_fields
+
+          return unless address.country_code.present?
+
+          address_format = AddressFormat.get(address.country_code)
+          address_format.used_fields
+
+          # Validate the presence of required fields.
+          address_format.required_fields.each do |required_field|
+            next unless address.send(required_field).blank?
+
+            errors.add(required_field, "should not be blank")
+          end
+
+          # Validate the absence of unused fields.
+          unused_fields = AddressField.all.values - address_format.used_fields
+          unused_fields.each do |unused_field|
+            next if address.send(unused_field).blank?
+
+            errors.add(unused_field, "should be blank")
+          end
+
+          # Validate subdivisions.
+          subdivisions = verify_subdivisions(address, address_format)
+
+          # Validate postal code.
+          verify_postal_code(address.postal_code, subdivisions, address_format) if address_format.used_fields.include?(AddressField::POSTAL_CODE)
+        end
+
+        define_method :verify_subdivisions do |address, address_format|
+          # No predefined subdivisions exist, nothing to validate against.
+          return [] if address_format.subdivision_depth < 1
+
+          subdivisions, _parents = address_format.used_subdivision_fields.each_with_index.inject([[], []]) do |(subdivisions, parents), (field, index)|
+            # The field is empty or validation is disabled.
+            # break subdivisions if address.send(field).blank? || address_format.hidden_fields.include?(field)
+            break subdivisions if address.send(field).blank?
+
+            parents << (index > 0 ? address.send(address_format.used_subdivision_fields[index - 1]) : address_format.country_code)
+            subdivision = Subdivision.get(address.send(field), parents)
+            if subdivision.nil?
+              errors.add(field, "should be valid")
+              break [subdivisions, parents]
+            end
+
+            subdivisions << subdivision
+            # No predefined subdivisions below this level, stop here.
+            break [subdivisions, parents] if subdivision.children.empty?
+
+            [subdivisions, parents]
+          end
+
+          subdivisions
+        end
+
+        define_method :verify_postal_code do |postal_code, subdivisions, address_format|
+          # Nothing to validate.
+          return if postal_code.blank?
+
+          full_pattern, start_pattern = subdivisions.inject([address_format.postal_code_pattern, nil]) do |(full_pattern, start_pattern), subdivision|
+            pattern = subdivision.postal_code_pattern
+            next [full_pattern, start_pattern] if pattern.blank?
+            next [pattern, start_pattern] if subdivision.postal_code_pattern_type == PatternType::FULL
+
+            [full_pattern, pattern]
+          end
+
+          if full_pattern
+            # The pattern must match the provided value completely.
+            match = postal_code.match(Regexp.new(full_pattern.gsub("\\\\", "\\").to_s, "i"))
+            if match.nil? || match[0] != postal_code
+              errors.add(AddressField::POSTAL_CODE, "should be valid")
+              return
+            end
+          end
+
+          if start_pattern
+            # The pattern must match the start of the provided value.
+            match = postal_code.match(Regexp.new(start_pattern.gsub("\\\\", "\\").to_s, "i"))
+            if match.nil? || postal_code.index(match[0]) != 0
+              errors.add(AddressField::POSTAL_CODE, "should be valid")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/addressing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Addressing
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/addressing.rb

@@ -28,3 +28,10 @@ module Addressing
 
   class UnknownLocaleError < Error; end
 end
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:active_record) do
+    require "addressing/model"
+    extend Addressing::Model
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: addressing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin van der Vleuten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email: robinvdvleuten@gmail.com
@@ -684,7 +684,6 @@ files:
 - lib/addressing/address.rb
 - lib/addressing/address_field.rb
 - lib/addressing/address_format.rb
-- lib/addressing/address_format_validator.rb
 - lib/addressing/administrative_area_type.rb
 - lib/addressing/country.rb
 - lib/addressing/default_formatter.rb
@@ -693,6 +692,7 @@ files:
 - lib/addressing/lazy_subdivisions.rb
 - lib/addressing/locale.rb
 - lib/addressing/locality_type.rb
+- lib/addressing/model.rb
 - lib/addressing/pattern_type.rb
 - lib/addressing/postal_code_type.rb
 - lib/addressing/postal_label_formatter.rb