defra_ruby_validators 2.4.1 → 2.5.1

data/spec/defra_ruby/validators/configuration_spec.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe DefraRuby::Validators::Configuration do
-  describe "ATTRIBUTES" do
-    it "represents the expected config settings and only those settings" do
-      expected_attributes = %i[
-        companies_house_host
-        companies_house_api_key
-      ]
-
-      expect(described_class::ATTRIBUTES).to match_array(expected_attributes)
-    end
-  end
-
-  it "sets the appropriate default config settings" do
-    fresh_config = described_class.new
-
-    expect(fresh_config.companies_house_host).to eq("https://api.companieshouse.gov.uk/company/")
-    expect(fresh_config.companies_house_api_key).to eq(nil)
-  end
-
-  describe "#ensure_valid" do
-    before(:each) do
-      described_class::ATTRIBUTES.each do |attribute|
-        subject.public_send("#{attribute}=", "foo")
-      end
-    end
-
-    context "when all of the attributes are present" do
-      it "does not raise an error" do
-        expect { subject.ensure_valid }.to_not raise_error
-        expect(subject.ensure_valid).to eq(true)
-      end
-    end
-
-    context "when at least one of the attributes is missing" do
-      before(:each) do
-        subject.companies_house_api_key = nil
-      end
-
-      it "raises an error" do
-        message = "The following DefraRuby::Validators configuration attributes are missing: [:companies_house_api_key]"
-        expect { subject.ensure_valid }.to raise_error(message)
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/email_validator_spec.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  EmailValidatable = Struct.new(:email) do
-    include ActiveModel::Validations
-
-    validates :email, "defra_ruby/validators/email": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe EmailValidator, type: :model do
-
-      valid_email = "test@example.com"
-      invalid_email = "foo@bar"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a presence validator",
-        EmailValidator,
-        Test::EmailValidatable,
-        :email,
-        valid: valid_email
-      )
-
-      describe "#validate_each" do
-        context "when the email is not valid" do
-          context "because the email is not correctly formatted" do
-            validatable = Test::EmailValidatable.new(invalid_email)
-
-            error_message = Helpers::Translator.error_message(EmailValidator, :invalid_format)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :email,
-                            error: :invalid_format,
-                            error_message: error_message
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/grid_reference_validator_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  GridReferenceValidatable = Struct.new(:grid_reference) do
-    include ActiveModel::Validations
-
-    validates :grid_reference, "defra_ruby/validators/grid_reference": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe GridReferenceValidator, type: :model do
-
-      valid_grid_reference = "ST 58337 72855" # Bristol, City of Bristol
-      invalid_grid_reference = "58337 72855"
-      non_coordinate_grid_reference = "AA 12345 67890"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a presence validator",
-        GridReferenceValidator,
-        Test::GridReferenceValidatable,
-        :grid_reference,
-        valid: valid_grid_reference
-      )
-
-      describe "#validate_each" do
-        context "when the grid reference is not valid" do
-          context "because the grid reference is not correctly formatted" do
-            validatable = Test::GridReferenceValidatable.new(invalid_grid_reference)
-            error_message = Helpers::Translator.error_message(GridReferenceValidator, :invalid_format)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :grid_reference,
-                            error: :invalid_format,
-                            error_message: error_message
-          end
-
-          context "because the grid reference is not a coordinate" do
-            validatable = Test::GridReferenceValidatable.new(non_coordinate_grid_reference)
-            error_message = Helpers::Translator.error_message(GridReferenceValidator, :invalid)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :grid_reference,
-                            error: :invalid,
-                            error_message: error_message
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/location_validator_spec.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  LocationValidatable = Struct.new(:location) do
-    include ActiveModel::Validations
-
-    validates :location, "defra_ruby/validators/location": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe LocationValidator, type: :model do
-
-      valid_location = %w[england northern_ireland scotland wales].sample
-      invalid_location = "france"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a selection validator",
-        LocationValidator,
-        Test::LocationValidatable,
-        :location,
-        valid: valid_location, invalid: invalid_location
-      )
-
-      context "when the value is overseas" do
-        validatable = Test::LocationValidatable.new("overseas")
-
-        context "when overseas_allowed is enabled" do
-          before do
-            allow_any_instance_of(DefraRuby::Validators::BaseValidator).to receive(:options).and_return(allow_overseas: true)
-          end
-
-          it_behaves_like "a valid record", validatable
-        end
-
-        context "when overseas_allowed is not enabled" do
-          before do
-            allow_any_instance_of(DefraRuby::Validators::BaseValidator).to receive(:options).and_return({})
-          end
-
-          error_message = Helpers::Translator.error_message(LocationValidator, :inclusion)
-
-          it_behaves_like "an invalid record",
-                          validatable: validatable,
-                          attribute: :location,
-                          error: :inclusion,
-                          error_message: error_message
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/past_date_validator_spec.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  PastDateValidatable = Struct.new(:date) do
-    include ActiveModel::Validations
-
-    validates :date, "defra_ruby/validators/past_date": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe PastDateValidator, type: :model do
-
-      valid_date = Date.today
-      future_date = Date.today + 1
-      invalid_date = Date.new(20, 2, 2)
-
-      it_behaves_like "a valid record", Test::PastDateValidatable.new(valid_date)
-      it_behaves_like "an invalid record",
-                      validatable: Test::PastDateValidatable.new(future_date),
-                      attribute: :date,
-                      error: :past_date,
-                      error_message: Helpers::Translator.error_message(PastDateValidator, :past_date)
-
-      it_behaves_like "an invalid record",
-                      validatable: Test::PastDateValidatable.new(invalid_date),
-                      attribute: :date,
-                      error: :invalid_date,
-                      error_message: Helpers::Translator.error_message(PastDateValidator, :invalid_date)
-    end
-  end
-end

data/spec/defra_ruby/validators/phone_number_validator_spec.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  PhoneNumberValidatable = Struct.new(:phone_number) do
-    include ActiveModel::Validations
-
-    validates :phone_number, "defra_ruby/validators/phone_number": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe PhoneNumberValidator, type: :model do
-
-      valid_number = [
-        "+441234567890",
-        "01234567890",
-        "+441234-567-890",
-        "01234.567.890",
-        "+441234 567 890"
-      ].sample
-      too_long_number = Helpers::TextGenerator.random_number_string(16) # The max length is 15.
-      invalid_number = "#123"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a presence validator",
-        PhoneNumberValidator,
-        Test::PhoneNumberValidatable,
-        :phone_number,
-        valid: valid_number
-      )
-      it_behaves_like(
-        "a length validator",
-        PhoneNumberValidator,
-        Test::PhoneNumberValidatable,
-        :phone_number,
-        valid: valid_number, invalid: too_long_number
-      )
-
-      describe "#validate_each" do
-        context "when the phone number is not valid" do
-          context "because the phone number is not correctly formatted" do
-            validatable = Test::PhoneNumberValidatable.new(invalid_number)
-            error_message = Helpers::Translator.error_message(PhoneNumberValidator, :invalid_format)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :phone_number,
-                            error: :invalid_format,
-                            error_message: error_message
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/position_validator_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  PositionValidatable = Struct.new(:position) do
-    include ActiveModel::Validations
-
-    validates :position, "defra_ruby/validators/position": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe PositionValidator, type: :model do
-
-      valid_position = "Padawan"
-      too_long_position = Helpers::TextGenerator.random_string(PositionValidator::MAX_LENGTH + 1)
-      invalid_position = "**Invalid_@_Position**"
-      empty_position = ""
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a length validator",
-        PositionValidator,
-        Test::PositionValidatable,
-        :position,
-        valid: valid_position, invalid: too_long_position
-      )
-      it_behaves_like(
-        "a characters validator",
-        PositionValidator,
-        Test::PositionValidatable,
-        :position,
-        valid: valid_position, invalid: invalid_position
-      )
-
-      describe "#validate_each" do
-        context "when the position is valid" do
-          context "despite being blank (because position is optional)" do
-            it_behaves_like "a valid record", Test::PositionValidatable.new(empty_position)
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/token_validator_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  TokenValidatable = Struct.new(:token) do
-    include ActiveModel::Validations
-
-    validates :token, "defra_ruby/validators/token": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe TokenValidator, type: :model do
-
-      valid_token = Helpers::TextGenerator.random_string(24)
-      invalid_token = "123456"
-
-      it_behaves_like("a validator")
-      it_behaves_like(
-        "a presence validator",
-        TokenValidator,
-        Test::TokenValidatable,
-        :token,
-        valid: valid_token
-      )
-
-      describe "#validate_each" do
-        context "when the token is not valid" do
-          context "because the token is not correctly formatted" do
-            validatable = Test::TokenValidatable.new(invalid_token)
-            error_message = Helpers::Translator.error_message(TokenValidator, :invalid_format)
-
-            it_behaves_like "an invalid record",
-                            validatable: validatable,
-                            attribute: :token,
-                            error: :invalid_format,
-                            error_message: error_message
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/validators/true_false_validator_spec.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module Test
-  TrueFalseValidatable = Struct.new(:attribute) do
-    include ActiveModel::Validations
-
-    validates :attribute, "defra_ruby/validators/true_false": true
-  end
-end
-
-module DefraRuby
-  module Validators
-    RSpec.describe TrueFalseValidator do
-      invalid_value = "unsure"
-
-      it_behaves_like("a validator")
-
-      it_behaves_like(
-        "a selection validator",
-        TrueFalseValidator,
-        Test::TrueFalseValidatable,
-        :attribute,
-        valid: true, invalid: invalid_value
-      )
-
-      it_behaves_like(
-        "a selection validator",
-        TrueFalseValidator,
-        Test::TrueFalseValidatable,
-        :attribute,
-        valid: false, invalid: invalid_value
-      )
-    end
-  end
-end

data/spec/defra_ruby/validators_spec.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe DefraRuby::Validators do
-  describe "VERSION" do
-    it "is a version string in the correct format" do
-      expect(DefraRuby::Validators::VERSION).to be_a(String)
-      expect(DefraRuby::Validators::VERSION).to match(/\d+\.\d+\.\d+/)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-
-# Require and run our simplecov initializer as the very first thing we do.
-# This is as per its docs https://github.com/colszowka/simplecov#getting-started
-require "./spec/support/simplecov"
-
-# Load env vars from a text file. This must be done before we load the other
-# support files as some of them rely on the env vars being set.
-require "dotenv/load"
-
-# Requires supporting ruby files with custom matchers and macros, etc, in
-# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
-# run as spec files by default. This means that files in spec/support that end
-# in _spec.rb will both be required and run as specs, causing the specs to be
-# run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with the --pattern
-# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-#
-# We make an exception for simplecov because that will already have been
-# required and run at the very top of spec_helper.rb
-support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
-support_files.each { |f| require f }
-
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-end

data/spec/support/defra_ruby_validators.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Need to require our actual code files. We don't just require everything in
-# lib/defra_ruby because it contains the engine file which has a dependency on
-# rails. We don't have that as a dependency of this project because it is
-# a given this will be used in a rails project. So instead we require the
-# validators file directly to load the content covered by our tests.
-require "defra_ruby/validators"
-
-DefraRuby::Validators.configure do |c|
-  def raise_missing_env_var(variable)
-    raise("Environment variable #{variable} has not been set")
-  end
-
-  c.companies_house_api_key = (ENV["COMPANIES_HOUSE_API_KEY"] || raise_missing_env_var("COMPANIES_HOUSE_API_KEY"))
-end

data/spec/support/helpers/text_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Helpers
-  module TextGenerator
-    def self.random_string(length)
-      random_string_from_sequence([("a".."z"), ("A".."Z")].map(&:to_a).flatten, length)
-    end
-
-    def self.random_number_string(length)
-      random_string_from_sequence(("0".."9").to_a, length)
-    end
-
-    def self.random_string_from_sequence(sequence, length)
-      (0...length).map { sequence[rand(sequence.length)] }.join
-    end
-  end
-end

data/spec/support/helpers/translator.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Helpers
-  module Translator
-    def self.error_message(klass, error)
-      class_name = klass_name(klass)
-
-      I18n.t("defra_ruby.validators.#{class_name}.#{error}")
-    end
-
-    def self.klass_name(klass)
-      klass.name.split("::").last
-    end
-  end
-end

data/spec/support/i18n.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# Support using the locale files within our tests (else we'd rely on loading the
-# gem in a rails app to confirm these are being pulled through correctly.)
-require "i18n"
-
-I18n.load_path << Dir[File.expand_path("config/locales") + "/**/*.yml"]
-I18n.default_locale = :en

data/spec/support/pry.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# Support debugging in the tests. Add `binding.pry` wherever you want execution
-# to stop and the debugger to kick in.
-# Details on the debugging commands can be found here
-# https://github.com/deivid-rodriguez/pry-byebug#commands
-require "pry-byebug"

data/spec/support/shared_examples/validators/characters_validator.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a characters validator" do |validator, validatable_class, attribute, values|
-  it "includes CanValidateCharacters" do
-    included_modules = described_class.ancestors.select { |ancestor| ancestor.instance_of?(Module) }
-
-    expect(included_modules)
-      .to include(DefraRuby::Validators::CanValidateCharacters)
-  end
-
-  describe "#validate_each" do
-    context "when the #{attribute} is valid" do
-      it_behaves_like "a valid record", validatable_class.new(values[:valid])
-    end
-
-    context "when the #{attribute} is not valid" do
-      context "because the #{attribute} is not correctly formatted" do
-        validatable = validatable_class.new(values[:invalid])
-        error_message = Helpers::Translator.error_message(validator, :invalid_format)
-
-        it_behaves_like "an invalid record",
-                        validatable: validatable,
-                        attribute: attribute,
-                        error: :invalid_format,
-                        error_message: error_message
-      end
-    end
-  end
-end

data/spec/support/shared_examples/validators/invalid_record.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "an invalid record" do |validatable:, attribute:, error:, error_message:|
-  it "confirms the object is invalid" do
-    expect(validatable).to_not be_valid
-  end
-
-  it "adds a single validation error to the record" do
-    validatable.valid?
-    expect(validatable.errors[attribute].count).to eq(1)
-  end
-
-  it "adds an appropriate validation error" do
-    validatable.valid?
-    expect(error_message).to_not include("translation missing:")
-    expect(validatable.errors[attribute]).to eq([error_message])
-  end
-
-  context "when there are custom error messages" do
-    let(:custom_message) { "something is wrong (in a customised way)" }
-    let(:messages) { { error => custom_message } }
-    before { allow_any_instance_of(DefraRuby::Validators::BaseValidator).to receive(:options).and_return(messages: messages) }
-
-    it "uses the custom message instead of the default" do
-      validatable.valid?
-      expect(validatable.errors[attribute]).to eq([custom_message])
-    end
-  end
-end