addressing 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f6ea26657e38313826abc6c9dbab406b426b07ac6d03af922ab130d6b00e29f
-  data.tar.gz: d3037ec9973ae1e7f0054eece0bd3e1a7a683eda4f2c4b1ad04294b3112684c6
+  metadata.gz: b46d807aa97c2e089222447115d7862105246f37f850e65f824f8599af5d714d
+  data.tar.gz: b2f82f834eb10ead8e14e9b63083093b94a27bdec7a157a7102ee6c01eb15e6a
 SHA512:
-  metadata.gz: 6db0b294a6ee4fb0cbb787a86e0fe506c539ea5a94ae7cb170373524540dd44a2139c90d0b6951d34728b42b19a84e3eed60bb7d50e8685ce4b65f9c21bbabb6
-  data.tar.gz: d6a857986eff573f2e136ccd1a07eb8b0da618ce00cb78af44590708a7dca54a79f1facbd2bd48ab48a9bcd66f7cce919e0c3d906572c8eebc40f12f0b5e976a
+  metadata.gz: fb86d0f70a24db611837a597b3f8846a545f9c16d0df2099d6baab0235cc27ff0730b97f55b138b1d946715e3a9a671b6af23544ba59851d6f10b1cde428d9e5
+  data.tar.gz: 4b4c5ce9982c8faaf53a6eab5117b8250d17fc3e11ffb34e24e3765ad931b5ad1fbd4031633a132c23c7c4d489131ff5364af22a0d695acad02e349b23414d25

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `addressing` will be documented in this file.
 
+## 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

data/README.md

@@ -182,6 +182,14 @@ class User < ApplicationRecord
 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.

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/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/model.rb

@@ -2,16 +2,20 @@
 
 module Addressing
   module Model
-    def validates_address_format(**options)
+    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
-          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
+          values = fields.each_with_object({}) { |f, v| v[f] = send(f) }
+          address = Address.new(**values)
 
-          address = Address.new(**fields)
           return unless address.country_code.present?
 
           address_format = AddressFormat.get(address.country_code)
@@ -23,14 +27,16 @@ module Addressing
           address_format.used_fields
 
           # Validate the presence of required fields.
-          address_format.required_fields.each do |required_field|
+          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 - address_format.used_fields
+          unused_fields = AddressField.all.values - used_fields
           unused_fields.each do |unused_field|
             next if address.send(unused_field).blank?
 
@@ -41,7 +47,7 @@ module Addressing
           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)
+          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|

data/lib/addressing/version.rb

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

data/lib/addressing.rb

@@ -12,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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: addressing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robin van der Vleuten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email: robinvdvleuten@gmail.com
@@ -689,6 +689,7 @@ 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