defra_ruby_validators 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8cefa4eee1eb9fcc363935f64760eb88aafd35d29ac09cfd3663105aafa3eb
-  data.tar.gz: 0dbc80e1d0c36fc4452257e6ade5377d83f04b860f9ec0375975526aca43f961
+  metadata.gz: 2e9394d56a860bc591e8858943843bae425845124bdca40f68f90fa864e3bbc6
+  data.tar.gz: 259e137a79906fb23ca984322d0e7d87dfa117cd87f4b5f87df182a69fec8cd5
 SHA512:
-  metadata.gz: 0417b991688a935460cbd8e96d28dd8d1496838d7aa5d56420f9a0e5ac701d652b278657a1a733c905e1f3b8ae6880e659b58071e90673af351224c9a3445ed2
-  data.tar.gz: 88fb21c5eb3ca1cc365ce4b52aeb8171540ec1cc5776b32cab5122fccb978215f46ea92ff13ceedde13fedd4b700d8f757a74db50f08e4e0e45e049c6ab2dfde
+  metadata.gz: 5336207fa6acbb53f0c36cb3759ea3d31e507de9392e2c0081bed9160bad765de799a88b6a8b4295daa80ec534f00ab158ae606e6592d624bbd8cfa48d34c69a
+  data.tar.gz: c81e615d1b0337ff9e21380f80a91d50670ec5b95c950a35e346feda88822e34f0e9660f81b7e75d200b6b0fc83cff2d05af79e383b78123c7edab9fb46563e8

data/README.md

@@ -144,6 +144,16 @@ Add it to your model or form object using
 validates :phone_number, "defra_ruby/validators/phone_number": true
 ```
 
+### Mobile phone number
+
+This validator checks the value is present, is not too long (15 is th maximum length for any phone number), is a mobile phone number, and is in the correct format as per [E.164](https://en.wikipedia.org/wiki/E.164) (we use [phonelib](https://github.com/daddyz/phonelib) to check the format).
+
+Add it to your model or form object using
+
+```ruby
+validates :mobile_phone_number, "defra_ruby/validators/mobile_phone_number": true
+```
+
 ### Position
 
 This validator checks the value provided for 'position' i.e. someones role or title within an organisation. This is an optional field so the validator has to handle the value being blank. If it's not then it can be no longer than 70 characters and only include letters, spaces, commas, full stops, hyphens and apostrophes else it will return an error.

data/config/locales/defra_ruby/validators/mobile_phone_number_validator/en.yml

@@ -0,0 +1,7 @@
+en:
+  defra_ruby:
+    validators:
+      MobilePhoneNumberValidator:
+        blank: "Enter a mobile phone number"
+        invalid_format: "Enter a valid mobile phone number"
+        too_long: "Check the number you entered - it should have no more than than 15 characters"

data/config/locales/defra_ruby/validators/postcode_validator/en.yml

@@ -0,0 +1,6 @@
+en:
+  defra_ruby:
+    validators:
+      PostcodeValidator:
+        blank: "Enter a postcode"
+        invalid_format: "Enter a valid postcode - there’s a mistake in that one"

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -9,9 +9,8 @@ module DefraRuby
       # SC534714, CE000958
       # IP00141R, IP27702R, SP02252R
       # https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/426891/uniformResourceIdentifiersCustomerGuide.pdf
-      VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX = Regexp.new(
+      VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX =
         /\A(\d{8,8}$)|([a-zA-Z]{2}\d{6}$)|([a-zA-Z]{2}\d{5}[a-zA-Z]{1}$)\z/i
-      ).freeze
 
       def validate_each(record, attribute, value)
         return false unless value_is_present?(record, attribute, value)

data/lib/defra_ruby/validators/mobile_phone_number_validator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "phonelib"
+
+module DefraRuby
+  module Validators
+    class MobilePhoneNumberValidator < BaseValidator
+      include CanValidatePresence
+      include CanValidateLength
+
+      MAX_LENGTH = 15
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, attribute, value)
+        return false unless value_is_not_too_long?(record, attribute, value, MAX_LENGTH)
+
+        valid_format?(record, attribute, value)
+      end
+
+      private
+
+      def valid_format?(record, attribute, value)
+        Phonelib.default_country = "GB"
+        return true if Phonelib.valid?(value) && Phonelib.parse(value).type == :mobile
+
+        add_validation_error(record, attribute, :invalid_format)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/postcode_validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "uk_postcode"
+
+module DefraRuby
+  module Validators
+    class PostcodeValidator < BaseValidator
+      include CanValidatePresence
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, attribute, value)
+
+        valid_format?(record, attribute, value)
+      end
+
+      private
+
+      def valid_format?(record, attribute, value)
+        parsed_value = UKPostcode.parse(value)
+        return true if (normalise(parsed_value) == normalise(value)) && parsed_value.full_valid?
+
+        add_validation_error(record, attribute, :invalid_format)
+        false
+      end
+
+      def normalise(postcode)
+        postcode.to_s.downcase.gsub(/\s+/, "")
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Validators
-    VERSION = "2.5.1"
+    VERSION = "2.6.0"
   end
 end

data/lib/defra_ruby/validators.rb

@@ -18,7 +18,9 @@ require_relative "validators/email_validator"
 require_relative "validators/grid_reference_validator"
 require_relative "validators/location_validator"
 require_relative "validators/phone_number_validator"
+require_relative "validators/mobile_phone_number_validator"
 require_relative "validators/position_validator"
+require_relative "validators/postcode_validator"
 require_relative "validators/token_validator"
 require_relative "validators/true_false_validator"
 require_relative "validators/past_date_validator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: uk_postcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: validates_email_format_of
   requirement: !ruby/object:Gem::Requirement
@@ -125,9 +139,11 @@ files:
 - config/locales/defra_ruby/validators/email_validator/en.yml
 - config/locales/defra_ruby/validators/grid_reference_validator/en.yml
 - config/locales/defra_ruby/validators/location_validator/en.yml
+- config/locales/defra_ruby/validators/mobile_phone_number_validator/en.yml
 - config/locales/defra_ruby/validators/past_date_validator/en.yml
 - config/locales/defra_ruby/validators/phone_number_validator/en.yml
 - config/locales/defra_ruby/validators/position_validator/en.yml
+- config/locales/defra_ruby/validators/postcode_validator/en.yml
 - config/locales/defra_ruby/validators/token_validator/en.yml
 - config/locales/defra_ruby/validators/true_false_validator/en.yml
 - lib/defra_ruby/validators.rb
@@ -144,9 +160,11 @@ files:
 - lib/defra_ruby/validators/engine.rb
 - lib/defra_ruby/validators/grid_reference_validator.rb
 - lib/defra_ruby/validators/location_validator.rb
+- lib/defra_ruby/validators/mobile_phone_number_validator.rb
 - lib/defra_ruby/validators/past_date_validator.rb
 - lib/defra_ruby/validators/phone_number_validator.rb
 - lib/defra_ruby/validators/position_validator.rb
+- lib/defra_ruby/validators/postcode_validator.rb
 - lib/defra_ruby/validators/token_validator.rb
 - lib/defra_ruby/validators/true_false_validator.rb
 - lib/defra_ruby/validators/version.rb