defra_ruby_validators 2.5.0 → 2.5.1

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

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a length validator" do |validator, validatable_class, attribute, values|
-  it "includes CanValidateLength" do
-    included_modules = described_class.ancestors.select { |ancestor| ancestor.instance_of?(Module) }
-
-    expect(included_modules)
-      .to include(DefraRuby::Validators::CanValidateLength)
-  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 too long" do
-        validatable = validatable_class.new(values[:invalid])
-        error_message = Helpers::Translator.error_message(validator, :too_long)
-
-        it_behaves_like "an invalid record",
-                        validatable: validatable,
-                        attribute: attribute,
-                        error: :too_long,
-                        error_message: error_message
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a presence validator" do |validator, validatable_class, attribute, values|
-  it "includes CanValidatePresence" do
-    included_modules = described_class.ancestors.select { |ancestor| ancestor.instance_of?(Module) }
-
-    expect(included_modules)
-      .to include(DefraRuby::Validators::CanValidatePresence)
-  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 present" do
-        validatable = validatable_class.new
-        error_message = Helpers::Translator.error_message(validator, :blank)
-
-        it_behaves_like "an invalid record",
-                        validatable: validatable,
-                        attribute: attribute,
-                        error: :blank,
-                        error_message: error_message
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a selection validator" do |validator, validatable_class, attribute, values|
-  it "includes CanValidateSelection" do
-    included_modules = described_class.ancestors.select { |ancestor| ancestor.instance_of?(Module) }
-
-    expect(included_modules)
-      .to include(DefraRuby::Validators::CanValidateSelection)
-  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 present" do
-        validatable = validatable_class.new
-        error_message = Helpers::Translator.error_message(validator, :inclusion)
-
-        it_behaves_like "an invalid record",
-                        validatable: validatable,
-                        attribute: attribute,
-                        error: :inclusion,
-                        error_message: error_message
-      end
-
-      context "because the #{attribute} is not from an approved list" do
-        validatable = validatable_class.new(values[:invalid])
-        error_message = Helpers::Translator.error_message(validator, :inclusion)
-
-        it_behaves_like "an invalid record",
-                        validatable: validatable,
-                        attribute: attribute,
-                        error: :inclusion,
-                        error_message: error_message
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a valid record" do |validatable|
-  it "confirms the object is valid" do
-    expect(validatable).to be_valid
-  end
-
-  it "the errors are empty" do
-    validatable.valid?
-    expect(validatable.errors).to be_empty
-  end
-end

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

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples "a validator" do
-  it "is a type of BaseValidator" do
-    expect(described_class.ancestors)
-      .to include(DefraRuby::Validators::BaseValidator)
-  end
-end

data/spec/support/simplecov.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "simplecov"
-
-# We start it with the rails param to ensure it includes coverage for all code
-# started by the rails app, and not just the files touched by our unit tests.
-# This gives us the most accurate assessment of our unit test coverage
-# https://github.com/colszowka/simplecov#getting-started
-SimpleCov.start do
-  # We filter the spec folder, mainly to ensure that any dummy apps don't get
-  # included in the coverage report. However our intent is that nothing in the
-  # spec folder should be included
-  add_filter "/spec/"
-  # The version file is simply just that, so we do not feel the need to ensure
-  # we have a test for it
-  add_filter "lib/defra_ruby/validators/version"
-end