defra_ruby_validators 2.6.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e9394d56a860bc591e8858943843bae425845124bdca40f68f90fa864e3bbc6
-  data.tar.gz: 259e137a79906fb23ca984322d0e7d87dfa117cd87f4b5f87df182a69fec8cd5
+  metadata.gz: fcc15d0837d498fd37fe5cfd1781d2b80b87165c0235b6e94aa50ad6463151a5
+  data.tar.gz: de144f02848b1b2c8de4ccb5bdb4ec9963697eed004ccf07106139333078936e
 SHA512:
-  metadata.gz: 5336207fa6acbb53f0c36cb3759ea3d31e507de9392e2c0081bed9160bad765de799a88b6a8b4295daa80ec534f00ab158ae606e6592d624bbd8cfa48d34c69a
-  data.tar.gz: c81e615d1b0337ff9e21380f80a91d50670ec5b95c950a35e346feda88822e34f0e9660f81b7e75d200b6b0fc83cff2d05af79e383b78123c7edab9fb46563e8
+  metadata.gz: bd502508cb5a172c6778bc20782dd799ea39f70fe0ada1291914c1ece812525cbe67c23c9de9687b76bba27fb3786cdab987720d798a1d478753527b5034e766
+  data.tar.gz: 0500a197f3405f89bd4501e642103b3692f57a4f40997c2d184897a5fad055b8fa90b34f79daea5e5eafeb1a5e4cd43e84d5d6b787a64dbd9de2bcbe6cd6088d

data/README.md

@@ -184,6 +184,16 @@ Add it to your model or form object using
 validates :is_a_farmer, "defra_ruby/validators/true_false": true
 ```
 
+### Price
+
+This validator checks the value is present and in the correct format, meaning it has no more than 2 decimal places. If blank or not in a valid format it will return an error.
+
+Add it to your model or form object using
+
+```ruby
+validates :price, "defra_ruby/validators/price": true
+```
+
 ## Adding custom error messages
 
 All the validators in this gem have built-in error messages. But if you want, you can provide your own custom message in the app, like this:

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

@@ -6,4 +6,6 @@ en:
         invalid_format: "Enter a valid number - it should have 8 digits, or 2 letters followed by 6 digits, or 2 letters followed by 5 digits and another letter. If your number has only 7 digits, enter it with a zero at the start."
         not_found: Companies House couldn't find a company with this number
         inactive: Your company must be registered as an active company
+        unsupported_company_type: Your company must be registered as a limited company or a limited liability partnership
+        argument_error: Invalid permitted_types value. It must be nil, a string or an array of strings.
         error: There was an error connecting with Companies House. Hopefully this is a one off and will work if you try again.

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

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

data/lib/defra_ruby/validators/companies_house_number_validator.rb

@@ -16,8 +16,8 @@ module DefraRuby
         return false unless value_is_present?(record, attribute, value)
         return false unless format_is_valid?(record, attribute, value)
 
-        company_type = options[:company_type]
-        validate_with_companies_house(record, attribute, value, company_type)
+        permitted_types = options[:permitted_types]
+        validate_with_companies_house(record, attribute, value, permitted_types)
       end
 
       private
@@ -37,18 +37,21 @@ module DefraRuby
         false
       end
 
-      def validate_with_companies_house(record, attribute, value, company_type)
-        case CompaniesHouseService.new(value, company_type).status
+      def validate_with_companies_house(record, attribute, value, permitted_types)
+        case CompaniesHouseService.new(company_number: value, permitted_types:).status
         when :active
           true
         when :inactive
           add_validation_error(record, attribute, :inactive)
         when :not_found
           add_validation_error(record, attribute, :not_found)
+        when :unsupported_company_type
+          add_validation_error(record, attribute, :unsupported_company_type)
         else
-          # Sonarcloud suggested that not having an `else` is a code smell
           add_validation_error(record, attribute, :error)
         end
+      rescue ArgumentError
+        add_validation_error(record, attribute, :argument_error)
       rescue StandardError
         add_validation_error(record, attribute, :error)
       end

data/lib/defra_ruby/validators/companies_house_service.rb

@@ -5,15 +5,18 @@ require "rest-client"
 module DefraRuby
   module Validators
     class CompaniesHouseService
-      def initialize(company_no, company_type = nil)
-        @company_no = company_no
-        @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_no}"
+      def initialize(company_number:, permitted_types: nil)
+        @company_number = company_number
+        @permitted_types = permitted_types
+
+        validate_permitted_types
+
+        @url = "#{DefraRuby::Validators.configuration.companies_house_host}#{@company_number}"
         @api_key = DefraRuby::Validators.configuration.companies_house_api_key
-        @company_type = company_type
       end
 
       def status
-        return :not_found unless company_type_is_allowed?(json_response)
+        return :unsupported_company_type unless company_type_is_allowed?(json_response)
 
         status_is_allowed?(json_response) ? :active : :inactive
       rescue RestClient::ResourceNotFound
@@ -34,16 +37,30 @@ module DefraRuby
 
       private
 
+      def validate_permitted_types
+        return if @permitted_types.nil?
+
+        return if @permitted_types.is_a?(String) || @permitted_types.is_a?(Array)
+
+        raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+      end
+
       def status_is_allowed?(json_response)
         %w[active voluntary-arrangement].include?(json_response["company_status"])
       end
 
       def company_type_is_allowed?(json_response)
-        # if a company_type has not been defined in the validator,
-        # we skip this check
-        return true if @company_type.blank?
+        # if permitted_types has not been defined in the validator, we skip this check
+        return true if @permitted_types.blank?
 
-        @company_type.to_s == json_response["type"]
+        case @permitted_types
+        when String
+          @permitted_types.to_s == json_response["type"]
+        when Array
+          @permitted_types.include?(json_response["type"])
+        else
+          raise ArgumentError, I18n.t("defra_ruby.validators.CompaniesHouseNumberValidator.argument_error")
+        end
       end
     end
   end

data/lib/defra_ruby/validators/price_validator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Validators
+    class PriceValidator < 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)
+        return true if value.match?(/\A\d{1,10}(\.\d{1,2})?\z/)
+
+        add_validation_error(record, attribute, :invalid_format)
+        false
+      end
+
+    end
+  end
+end

data/lib/defra_ruby/validators/version.rb

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

data/lib/defra_ruby/validators.rb

@@ -24,6 +24,7 @@ require_relative "validators/postcode_validator"
 require_relative "validators/token_validator"
 require_relative "validators/true_false_validator"
 require_relative "validators/past_date_validator"
+require_relative "validators/price_validator"
 
 module DefraRuby
   module Validators

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_validators
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Defra
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -144,6 +144,7 @@ files:
 - 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/price_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
@@ -165,6 +166,7 @@ files:
 - 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/price_validator.rb
 - lib/defra_ruby/validators/token_validator.rb
 - lib/defra_ruby/validators/true_false_validator.rb
 - lib/defra_ruby/validators/version.rb
@@ -175,7 +177,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -191,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Defra ruby on rails validations
 test_files: []