defra_ruby_validators 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e898f7ee267a5ce4074c4f7c4c04284f3119732
-  data.tar.gz: fd9c073dc217d74a6468bc25261f6d9338bc24c6
+  metadata.gz: 6eb5f30b11f406a2a5c91d2d2eabb709b6e662cc
+  data.tar.gz: '049bb686fcc859df2894534e21741d585e0ede29'
 SHA512:
-  metadata.gz: d97d8bd20be2314faa28da05224288eb90533113b419d6df3f4d1b0801a9a7f76ddd8e34a3df87b4f7dba7580317e55e315176c5aff38152007d502d49b69d2d
-  data.tar.gz: 29e0b534deb7e2801ec556c47488846e5be7edaa0f28b80e7433edf3ae69a858504d3f9158084bddd3946b97e5d28aa7b1630853c36f855565337f6f9b422195
+  metadata.gz: 5aff6f7c03a848a1f03fff4be8d357d2ca3f8b37ad7d3489f3b76773f20122b8014c596369b27467349b90d331c90c695a8d6a935a7f4794afbedfeb6343fb9c
+  data.tar.gz: 05ccedb6de84b3ed7c55303f30e8e9357abebbbf71c1233d1a45df5de7e056d6993c3ca95396cb3e5d438562de9ef8046b71a1c87fa2b1b1934bf1f33895ae56

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.com/DEFRA/defra-ruby-validators.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-validators)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a0f8611f1a879786f642/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-validators/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a0f8611f1a879786f642/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-validators/test_coverage)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-validators/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-validators/master)
 [![Gem Version](https://badge.fury.io/rb/defra_ruby_validators.svg)](https://badge.fury.io/rb/defra_ruby_validators)
 [![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
@@ -26,6 +27,25 @@ bundle install
 
 With this gem installed, a number of active model based validators become available.
 
+### Business type
+
+This validator checks the value provided is one of our known business types
+
+- `soleTrader`
+- `limitedCompany`
+- `partnership`
+- `limitedLiabilityPartnership`
+- `localAuthority`
+- `charity`
+
+If blank or not one of these it will return an error.
+
+Add it to your model or form object using
+
+```ruby
+validates :business_type, "defra_ruby/validators/business_type": true
+```
+
 ### Companies House number
 
 This validator checks the company registration number provided. Specifically it first checks that it matches a known format. All registration numbers are 8 characters long but can be formatted in the following ways.
@@ -48,6 +68,73 @@ Add it to your model or form object using
 validates :company_no, "defra_ruby/validators/companies_house_number": true
 ```
 
+### Email
+
+This validator checks the value is present and in a format that meets [RFC 2822](https://tools.ietf.org/html/rfc2822) and [RFC 3696](https://tools.ietf.org/html/rfc3696) (we use [validates_email_format_of](https://github.com/validates-email-format-of/validates_email_format_of) to check the format).
+
+Add it to your model or form object using
+
+```ruby
+validates :email, "defra_ruby/validators/email": true
+```
+
+### Grid reference
+
+This validator checks the value is present, is in the correct format for an [Ordnance Survey National Grid Reference](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid), and that its valid (we use [os_map_ref](https://github.com/DEFRA/os-map-ref) to check the coordinate is valid).
+
+Add it to your model or form object using
+
+```ruby
+validates :grid_reference, "defra_ruby/validators/grid_reference": true
+```
+
+### Location
+
+This validator checks the value provided is one of our accepted locations
+
+- `england`
+- `northern_ireland`
+- `scotland`
+- `wales`
+
+If blank or not one of these it will return an error.
+
+Add it to your model or form object using
+
+```ruby
+validates :location, "defra_ruby/validators/location": true
+```
+
+### Phone number
+
+This validator checks the value is present, is not too long (15 is th maximum length for any 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 :phone_number, "defra_ruby/validators/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.
+
+Add it to your model or form object using
+
+```ruby
+validates :position, "defra_ruby/validators/position": true
+```
+
+### Token
+
+This validator checks the value is present and in the correct format, which in this case is that the value has a length of 24. If blank or not in a valid format it will return an error.
+
+Add it to your model or form object using
+
+```ruby
+validates :token, "defra_ruby/validators/token": true
+```
+
 ### True or false
 
 This validator checks the value provided is either `"true"` or `"false"`. If blank or not one of these it will return an error.
@@ -55,7 +142,7 @@ This validator checks the value provided is either `"true"` or `"false"`. If bla
 Add it to your model or form object using
 
 ```ruby
-validates :company_no, "defra_ruby/validators/true_false": true
+validates :is_a_farmer, "defra_ruby/validators/true_false": true
 ```
 
 ## Contributing to this project

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

@@ -0,0 +1,6 @@
+en:
+  defra_ruby:
+    validators:
+      BusinessTypeValidator:
+        business_type:
+          inclusion: "You must answer this question"

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

@@ -0,0 +1,7 @@
+en:
+  defra_ruby:
+    validators:
+      EmailValidator:
+        email:
+          blank: "Enter an email address"
+          invalid_format: "Enter a valid email address - there’s a mistake in that one"

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

@@ -0,0 +1,8 @@
+en:
+  defra_ruby:
+    validators:
+      GridReferenceValidator:
+        grid_reference:
+          blank: Enter a grid reference
+          wrong_format: The grid reference should have 2 letters and 10 digits
+          invalid: The grid reference is not a valid coordinate

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

@@ -0,0 +1,6 @@
+en:
+  defra_ruby:
+    validators:
+      LocationValidator:
+        location:
+          inclusion: "You must answer this question"

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

@@ -0,0 +1,8 @@
+en:
+  defra_ruby:
+    validators:
+      PhoneNumberValidator:
+        phone_number:
+          blank: "Enter a telephone number"
+          invalid_format: "Enter a valid telephone number"
+          too_long: "Check the number you entered - it should have no more than than 15 characters"

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

@@ -0,0 +1,7 @@
+en:
+  defra_ruby:
+    validators:
+      PositionValidator:
+        position:
+          invalid: "The position must contain only letters, spaces, commas, full stops, hyphens and apostrophes"
+          too_long: "The position must have no more than 70 characters"

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

@@ -0,0 +1,7 @@
+en:
+  defra_ruby:
+    validators:
+      TokenValidator:
+        token:
+          invalid_format: "The token is not valid"
+          blank: "The token is missing"

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

@@ -2,4 +2,5 @@ en:
   defra_ruby:
     validators:
       TrueFalseValidator:
-        inclusion: "You must answer this question"
+        attribute:
+          inclusion: "You must answer this question"

data/lib/defra_ruby/validators.rb

@@ -6,10 +6,20 @@ require_relative "validators/version"
 require_relative "validators/configuration"
 require_relative "validators/companies_house_service"
 
+require_relative "validators/concerns/can_validate_characters"
+require_relative "validators/concerns/can_validate_length"
+require_relative "validators/concerns/can_validate_presence"
 require_relative "validators/concerns/can_validate_selection"
 
 require_relative "validators/base_validator"
+require_relative "validators/business_type_validator"
 require_relative "validators/companies_house_number_validator"
+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/position_validator"
+require_relative "validators/token_validator"
 require_relative "validators/true_false_validator"
 
 module DefraRuby

data/lib/defra_ruby/validators/base_validator.rb

@@ -6,10 +6,8 @@ module DefraRuby
 
       protected
 
-      def error_message(attribute: nil, error:)
-        return I18n.t("defra_ruby.validators.#{class_name}.#{attribute}.#{error}") if attribute
-
-        I18n.t("defra_ruby.validators.#{class_name}.#{error}")
+      def error_message(attribute, error)
+        options[:message] || I18n.t("defra_ruby.validators.#{class_name}.#{attribute}.#{error}")
       end
 
       private

data/lib/defra_ruby/validators/business_type_validator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class BusinessTypeValidator < BaseValidator
+      include CanValidateSelection
+
+      def validate_each(record, _attribute, value)
+        valid_options = %w[soleTrader limitedCompany partnership limitedLiabilityPartnership localAuthority charity]
+
+        value_is_included?(record, :business_type, value, valid_options)
+      end
+    end
+  end
+end

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -25,14 +25,14 @@ module DefraRuby
       def value_is_present?(record, attribute, value)
         return true if value.present?
 
-        record.errors[attribute] << error_message(attribute: attribute, error: "blank")
+        record.errors[attribute] << error_message(:company_no, :blank)
         false
       end
 
       def format_is_valid?(record, attribute, value)
         return true if value.match?(VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX)
 
-        record.errors[attribute] << error_message(attribute: attribute, error: "invalid")
+        record.errors[attribute] << error_message(:company_no, :invalid)
         false
       end
 
@@ -41,12 +41,12 @@ module DefraRuby
         when :active
           true
         when :inactive
-          record.errors[attribute] << error_message(attribute: attribute, error: "inactive")
+          record.errors[attribute] << error_message(:company_no, :inactive)
         when :not_found
-          record.errors[attribute] << error_message(attribute: attribute, error: "not_found")
+          record.errors[attribute] << error_message(:company_no, :not_found)
         end
       rescue StandardError
-        record.errors[attribute] << error_message(attribute: attribute, error: "error")
+        record.errors[attribute] << error_message(:company_no, :error)
       end
 
     end

data/lib/defra_ruby/validators/concerns/can_validate_characters.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    module CanValidateCharacters
+
+      private
+
+      def value_has_no_invalid_characters?(record, attribute, value)
+        # Name fields must contain only letters, spaces, commas, full stops, hyphens and apostrophes
+        return true if value.match?(/\A[-a-z\s,.']+\z/i)
+
+        record.errors[attribute] << error_message(attribute, :invalid)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/concerns/can_validate_length.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    module CanValidateLength
+
+      private
+
+      def value_is_not_too_long?(record, attribute, value, max_length)
+        return true if value.length <= max_length
+
+        record.errors[attribute] << error_message(attribute, :too_long)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/concerns/can_validate_presence.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    module CanValidatePresence
+
+      private
+
+      def value_is_present?(record, attribute, value)
+        return true if value.present?
+
+        record.errors[attribute] << error_message(attribute, :blank)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/concerns/can_validate_selection.rb

@@ -3,18 +3,16 @@
 module DefraRuby
   module Validators
     module CanValidateSelection
-      extend ActiveSupport::Concern
 
-      included do
-        private
+      private
 
-        def value_is_included?(record, attribute, value, valid_options)
-          return true if value.present? && valid_options.include?(value)
+      def value_is_included?(record, attribute, value, valid_options)
+        return true if value.present? && valid_options.include?(value)
 
-          record.errors[attribute] << error_message(error: "inclusion")
-          false
-        end
+        record.errors[attribute] << error_message(attribute, :inclusion)
+        false
       end
+
     end
   end
 end

data/lib/defra_ruby/validators/email_validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "validates_email_format_of"
+
+module DefraRuby
+  module Validators
+    class EmailValidator < BaseValidator
+      include CanValidatePresence
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, :email, value)
+
+        valid_format?(record, attribute, value)
+      end
+
+      private
+
+      def valid_format?(record, attribute, value)
+        # validate_email_format returns nil if the validation passes
+        return true unless ValidatesEmailFormatOf.validate_email_format(value)
+
+        record.errors[attribute] << error_message(:email, :invalid_format)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/grid_reference_validator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "os_map_ref"
+
+module DefraRuby
+  module Validators
+    class GridReferenceValidator < BaseValidator
+      include CanValidatePresence
+
+      def validate_each(record, attribute, value)
+        return false unless value_is_present?(record, :grid_reference, value)
+        return false unless valid_format?(record, attribute, value)
+
+        valid_coordinate?(record, attribute, value)
+      end
+
+      private
+
+      # Note that OsMapRef will work with less specific coordinates than are
+      # required for this service (100m) - so we need to add an additional check
+      # rather than just jump straight to confirming if it's a valid coordinate
+      def valid_format?(record, attribute, value)
+        return true if value.match?(/\A#{grid_reference_pattern}\z/)
+
+        record.errors[attribute] << error_message(:grid_reference, :wrong_format)
+        false
+      end
+
+      def valid_coordinate?(record, attribute, value)
+        OsMapRef::Location.for(value).easting
+        true
+      rescue OsMapRef::Error
+        record.errors[attribute] << error_message(:grid_reference, :invalid)
+        false
+      end
+
+      def grid_reference_pattern
+        [two_letters, optional_space, five_digits, optional_space, five_digits].join
+      end
+
+      def two_letters
+        "[A-Za-z]{2}"
+      end
+
+      def five_digits
+        '\d{5}'
+      end
+
+      def optional_space
+        '\s*'
+      end
+
+    end
+  end
+end