addressing 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bf8936e1edf97987fbcca8e6b47a9ca45e07fa8c2e3a120360cd6730c422a7
-  data.tar.gz: 9b7aa33a67b425cf514d8c182bdc0583de2a9ade137afcb6d682c641d50612bb
+  metadata.gz: b46d807aa97c2e089222447115d7862105246f37f850e65f824f8599af5d714d
+  data.tar.gz: b2f82f834eb10ead8e14e9b63083093b94a27bdec7a157a7102ee6c01eb15e6a
 SHA512:
-  metadata.gz: 4e8efd58bed3c59c920f66a4f144196338214d9f91a7af7185147f459752686c831f2a947326d1bedc8fd1b368af2f7b3984eaed038c5a17113986122c64682e
-  data.tar.gz: f597210f7076721c355b99782c0fe445fad1c370db22df59d8af1143329568b0167f31f4e78d879c36e7ba699335cf9caa5e222e85eb799141ed74952b465256
+  metadata.gz: fb86d0f70a24db611837a597b3f8846a545f9c16d0df2099d6baab0235cc27ff0730b97f55b138b1d946715e3a9a671b6af23544ba59851d6f10b1cde428d9e5
+  data.tar.gz: 4b4c5ce9982c8faaf53a6eab5117b8250d17fc3e11ffb34e24e3765ad931b5ad1fbd4031633a132c23c7c4d489131ff5364af22a0d695acad02e349b23414d25

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to `addressing` will be documented in this file.
 
-## 0.1.0 (UNRELEASED)
+## 0.3.0 (04-04-2022)
+
+- Allow field validation to be overridden
+- Only verify address when one of the field changes
+- Allow used address fields to be configured
+
+## 0.2.0 (25-02-2022)
+
+- Add ActiveRecord validations
+
+## 0.1.1 (21-02-2022)
+
+- Fix typo in DE custom format
+
+## 0.1.0 (07-02-2022)
 
 - Initial release

data/README.md

@@ -172,6 +172,24 @@ 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
+```
+
+For performance, the address is only verified if at least one of the fields changes. Set your own condition with:
+
+```rb
+class User < ApplicationRecord
+  validates_address if: -> { something_changed? }, ...
+end
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
@@ -203,5 +221,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/address_formats.json

@@ -42,7 +42,7 @@
 {"country_code": "CX","format": "%organization\n%given_name %family_name\n%address_line1\n%address_line2\n%locality %administrative_area %postal_code","uppercase_fields": ["locality","administrative_area"],"postal_code_pattern": "6798"}
 {"country_code": "CY","format": "%given_name %family_name\n%organization\n%address_line1\n%address_line2\n%postal_code %locality","postal_code_pattern": "\\d{4}"}
 {"country_code": "CZ","format": "%given_name %family_name\n%organization\n%address_line1\n%address_line2\n%postal_code %locality","required_fields": ["address_line1","locality","postal_code"],"postal_code_pattern": "\\d{3} ?\\d{2}"}
-{"country_code": "DE","format": "%organization\n%given_name %family_name\n%address_line1\n%address_line2\n%postalCode %locality","required_fields": ["address_line1","locality","postal_code"],"postal_code_pattern": "\\d{5}"}
+{"country_code": "DE","format": "%organization\n%given_name %family_name\n%address_line1\n%address_line2\n%postal_code %locality","required_fields": ["address_line1","locality","postal_code"],"postal_code_pattern": "\\d{5}"}
 {"country_code": "DK","format": "%given_name %family_name\n%organization\n%address_line1\n%address_line2\n%postal_code %locality","required_fields": ["address_line1","locality","postal_code"],"postal_code_pattern": "\\d{4}"}
 {"country_code": "DO","format": "%given_name %family_name\n%organization\n%address_line1\n%address_line2\n%postal_code %locality","postal_code_pattern": "\\d{5}"}
 {"country_code": "DZ","format": "%given_name %family_name\n%organization\n%address_line1\n%address_line2\n%postal_code %locality","postal_code_pattern": "\\d{5}"}

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/data/library_customizations.rb

@@ -24,7 +24,7 @@ def address_format_customizations(country_code)
   # Switch %organization and %recipient.
   # https://github.com/googlei18n/libaddressinput/issues/83
   format_customizations["DE"] = {
-    "format" => "%organization\n%given_name %family_name\n%address_line1\n%address_line2\n%postalCode %locality"
+    "format" => "%organization\n%given_name %family_name\n%address_line1\n%address_line2\n%postal_code %locality"
   }
 
   # Revert the removal of %sortingCode.

data/lib/addressing/address_field.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available address fields.
   class AddressField < Enum

data/lib/addressing/address_format.rb

@@ -141,4 +141,25 @@ module Addressing
       fields & used_fields
     end
   end
+
+  class AddressFormatHelper
+    class << self
+      # Gets the required fields.
+      #
+      # Applies field overrides to the required fields
+      # specified by the address format.
+      def required_fields(address_format, field_overrides)
+        required_fields = address_format.required_fields
+        required_fields = required_fields - field_overrides.optional_fields
+        required_fields = required_fields - field_overrides.hidden_fields
+
+        if field_overrides.required_fields
+          required_fields = required_fields + field_overrides.required_fields
+          required_fields = required_fields.uniq
+        end
+
+        required_fields
+      end
+    end
+  end
 end

data/lib/addressing/administrative_area_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available administrative area types.
   class AdministrativeAreaType < Enum

data/lib/addressing/dependent_locality_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available dependent locality types.
   class DependentLocalityType < Enum

data/lib/addressing/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Addressing
   class Enum
     class << self

data/lib/addressing/field_override.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Addressing
+  class FieldOverride < Enum
+    HIDDEN = "hidden"
+    OPTIONAL = "optional"
+    REQUIRED = "required"
+  end
+
+  class FieldOverrides
+    attr_reader :hidden_fields, :optional_fields, :required_fields
+
+    def initialize(definition)
+      AddressField.assert_all_exist(definition.keys)
+      FieldOverride.assert_all_exist(definition.values)
+
+      @hidden_fields = []
+      @optional_fields = []
+      @required_fields = []
+
+      definition.each do |field, override|
+        case override
+        when FieldOverride::HIDDEN
+          @hidden_fields << field
+        when FieldOverride::OPTIONAL
+          @optional_fields << field
+        when FieldOverride::REQUIRED
+          @required_fields << field
+        end
+      end
+    end
+  end
+end

data/lib/addressing/lazy_subdivisions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Addressing
   class LazySubdivisions
     def initialize(parents)
@@ -16,6 +18,11 @@ module Addressing
       @subdivisions.any?
     end
 
+    def empty?
+      do_initialize unless @initialized
+      @subdivisions.empty?
+    end
+
     private
 
     def do_initialize

data/lib/addressing/locality_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available locality types.
   class LocalityType < Enum

data/lib/addressing/model.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Addressing
+  module Model
+    def validates_address_format(
+      fields: [:country_code, :administrative_area, :locality, :dependent_locality, :postal_code, :sorting_code, :address_line1, :address_line2, :organization, :given_name, :additional_name, :family_name, :locale], field_overrides: nil, **options)
+      fields = Array(fields)
+      field_overrides ||= FieldOverrides.new({})
+
+      options[:if] ||= -> { fields.any? { |f| changes.key?(f.to_s) } } unless options[:unless]
+
+      class_eval do
+        validate :verify_address_format, **options
+
+        define_method :verify_address_format do
+          values = fields.each_with_object({}) { |f, v| v[f] = send(f) }
+          address = Address.new(**values)
+
+          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.
+          AddressFormatHelper::required_fields(address_format, field_overrides).each do |required_field|
+            next unless address.send(required_field).blank?
+
+            errors.add(required_field, "should not be blank")
+          end
+
+          used_fields = address_format.used_fields - field_overrides.hidden_fields
+
+          # Validate the absence of unused fields.
+          unused_fields = AddressField.all.values - 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 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/pattern_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available pattern types.
   #

data/lib/addressing/postal_code_type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "addressing/enum"
-
 module Addressing
   # Enumerates available postal code types.
   class PostalCodeType < Enum

data/lib/addressing/subdivision.rb

@@ -1,4 +1,4 @@
-require "digest"
+# frozen_string_literal: true
 
 module Addressing
   class Subdivision

data/lib/addressing/version.rb

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

data/lib/addressing.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "cgi"
+require "digest"
 require "json"
 
+require "addressing/enum"
 require "addressing/address"
 require "addressing/address_field"
 require "addressing/address_format"
@@ -10,6 +12,7 @@ require "addressing/administrative_area_type"
 require "addressing/country"
 require "addressing/default_formatter"
 require "addressing/dependent_locality_type"
+require "addressing/field_override"
 require "addressing/lazy_subdivisions"
 require "addressing/locale"
 require "addressing/locality_type"
@@ -26,3 +29,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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robin van der Vleuten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email: robinvdvleuten@gmail.com
@@ -689,9 +689,11 @@ files:
 - lib/addressing/default_formatter.rb
 - lib/addressing/dependent_locality_type.rb
 - lib/addressing/enum.rb
+- lib/addressing/field_override.rb
 - 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