rspec_model_validations 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c7eddb001578c400fb07e353dc90519a5a9003e62856cadb4de221060ba97bf
+  data.tar.gz: 0f7cdb19b649ea52717542a66614bff5a62f592000d7750df6c9103dfb611982
+SHA512:
+  metadata.gz: 3325f11863d332b16dde60c6092dbeb19ca18b4ae7cfefbaf1b9fc6868816941c3310d8a0a2970a14680962454144207c05007d7521d558dd96228276a1e781e
+  data.tar.gz: ebe6d58e97a337e6c2dd4436073312251b94b66307fd7d3ee5acb2576a8b7515d77b50fdf1bc7971799d068227013d43dbe4967d5fe7fe90db3f64b258e67484

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/.local
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.cache/
+.irb_history
+.bash_history
+.byebug_history
+
+# rspec failure tracking
+.rspec_status
+
+# Editor file
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - /bin/**
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - /app/spec/**/**/**/**/**/**/*.rb
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1,9 @@
+##
+# Base - basic image use to run dev tools
+#
+FROM ruby:3.0.2
+
+WORKDIR /app
+
+ADD . .
+RUN bundle install

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+## CORE
+# Include dependencies
+gemspec
+
+## TEST
+# Model framework in order to run validation
+gem 'activemodel', '~> 7.0.0'
+# Framework
+gem 'rspec', '~> 3.10.0'
+# Coverage
+gem 'simplecov', '~> 0.19.1'
+
+## DEV TOOLS
+# Breakpoint
+gem 'byebug', '~> 11.1.3'
+# Linter
+gem 'rubocop', '~> 1.21.0'
+# Documentation
+gem 'yard', '~> 0.9.26'

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    rspec_model_validations (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  aarch64-linux
+
+DEPENDENCIES
+  activemodel (~> 7.0.0)
+  byebug (~> 11.1.3)
+  rspec (~> 3.10.0)
+  rspec_model_validations!
+  rubocop (~> 1.21.0)
+  simplecov (~> 0.19.1)
+  yard (~> 0.9.26)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pierre Guego
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,49 @@
+##
+# Simplify docker usage
+#
+container = gem_rspec_model_validations
+option = -ti --rm --user $(shell id -u):$(shell id -g) -v $(shell pwd):/app -e HOME=/app
+
+.PHONY: doc
+args = $(filter-out $@,$(MAKECMDGOALS))
+%:
+	@:
+
+# build the docker image
+install:
+	@ docker build -t $(container) .
+
+# run the test inside container
+test:
+	@ docker run ${option} ${container} rspec $(args)
+
+# display linter error
+lint:
+	@ docker run $(option) ${container} rubocop ${args}
+
+# display linter error
+lintf:
+	@ docker run $(option) ${container} rubocop -A ${args}
+
+# documentation compilation
+doc:
+	@ docker run $(option) $(container) yardoc --list-undoc $(args)
+
+# exec the commande in the container: make exec bash
+exec:
+	@ docker run $(option) $(container) $(args)
+
+# remove everything created by makefile command
+clean:
+	- rm -rf doc
+	- rm -rf coverage
+	- rm -rf .bundle
+	- rm -rf .yardoc
+	- rm -rf .cache
+	- rm -rf .local
+	- rm .rspec_status
+	- rm .byebug_history
+	- rm .irb_history
+	- rm .bash_history
+	- docker image rm ruby:3.0.2
+	- docker image rm $(container)

data/README.md

@@ -0,0 +1,112 @@
+# RspecModelValidations
+
+*Extra matchers to improve testing of model validation*
+
+Testing model validation can be a bit clunky:
+* `model.valid?` test the entire model so it can lead to errors
+* specific error on attribute can be test with `model.added?` or `errors[:attribute]` but options or message must be provided
+* attribute setting and validation trigger must be call
+* as validation are test through "raw code" failure message can be hard to understand
+
+`rspec_model_validations` make testing smoother by adding matchers to focus test on specific attribute / validation.
+
+```ruby
+  # model
+  validates :attribute, numericality: true
+
+  # spec
+  expect(model).to invalidate(:attribute).with(:blank, :not_a_number).on nil
+
+  # equivalent to
+  model.attribute = nil
+  model.validate
+  expect(model.errors).to be_added :attribute, :blank
+  expect(model.errors).to be_added :attribute, :not_a_number, value: nil
+```
+
+## Requirements
+
+* ~> 1.0: rails ~> 7.0
+
+*Note: it should be able to run with older version of rails but behaviour is not garanted.*
+
+## Installation
+
+1. Add this gem to your application in :test env
+
+```ruby
+  gem 'rspec_model_validations', '~> 1.0', require: false, group: :test
+```
+
+2. Setup spec/rails_helper.rb file to access matchers
+
+```ruby
+  # Add additional requires below this line. Rails is not loaded until this point!
+  require 'rspec_model_validations'
+
+  # ...
+
+  RSpec.configure do |config|
+    config.include RspecModelValidations::Matchers
+  end
+```
+
+## Usage
+
+### Test validation errors
+
+`invalidate :attribute` test errors on a specific attribute.
+It run validation and test that the targeted attribute have at least one error.
+
+```ruby
+  model.attribute = nil
+  expect(model).to invalidate :attribute
+
+  # equivalent to
+  model.attribute = nil
+  model.validate
+  expect(model.errors[:attribute]).to be_present
+```
+
+Options:
+
+* `with` specify which errors type must be present. It accept single or multiple symbols.
+
+```ruby
+  model.attribute = nil
+  expect(model).to invalidate(:attribute).with :blank, :not_a_number
+
+  # equivalent to
+  model.attribute = nil
+  model.validate
+  expect(model.errors.group_by_attribute(:attribute).map(&:type)).to include(:blank, :not_a_number)
+```
+
+* `on` set the attribute value
+
+```ruby
+  expect(model).to invalidate(:attribute).on nil
+
+  # equivalent to
+  model.attribute = nil
+  model.validate
+  expect(model.errors[:attribute]).to be_present
+```
+
+### Test successfull validation
+
+`validate :attribute` test a specific attribute validity.
+It run validation and then test that none errors are related to the given attribute.
+
+```ruby
+  model.attribute = 9
+  expect(model).to validate :attribute
+
+  # equivalent to
+  model.attribute = 9
+  model.validate
+  expect(model.errors[:attribute]).to be_empty
+```
+
+Options:
+  * `on` see invalidate on option

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rspec_model_validations'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/rspec_model_validations/matchers/base.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Dry matcher code
+module RspecModelValidations::Matchers::Base
+  # @param attribute [Symbol, String]
+  def initialize attribute
+    @attribute = attribute.to_s.to_sym
+    @model = nil
+    @errors = nil
+  end
+
+  # Store given value
+  # @param value [Object]
+  # @return [self]
+  def on value
+    @on = value
+
+    self
+  end
+
+  private
+
+  # Raise an error if model does not posses @attribute
+  # @param model [ActiveModel::Model]
+  def attribute_belongs_to! model
+    return if model.respond_to? @attribute
+
+    message = "#{@attribute.inspect} is not a #{model.class} attribute !"
+    raise RspecModelValidations::Error, message
+  end
+
+  # Run model validations and return attribute errors type
+  # Set model attribute with on value when on is set.
+  # @param model [ActiveModel::Model]
+  # @return [Array]
+  def attribute_errors model
+    model.instance_variable_set "@#{@attribute}", @on if defined? @on
+    model.validate
+    model.errors.group_by_attribute[@attribute]&.map(&:type) || []
+  end
+
+  # Return the model attribute value.
+  # Attribute must exist
+  # @param model [ActiveModel::Model]
+  # @return [Object]
+  def attribute_value model; model.instance_variable_get "@#{@attribute}" end
+
+  # Format a matcher expected / got faillure message
+  # @param expected [String] expected part of the message
+  # @param got [String] got part of the message
+  # @return [String]
+  def message expected, got; "\nexpected: #{expected}\n     got: #{got}" end
+end

data/lib/rspec_model_validations/matchers/invalidate.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Test if model validation lead to errors on the given attribute.
+#
+# Option:
+#   * `with` test that the attribute have specific error rather than any
+class RspecModelValidations::Matchers::Invalidate
+  include RspecModelValidations::Matchers::Base
+
+  def initialize attribute
+    super
+
+    @with = nil
+  end
+
+  # Set the with option
+  # @param errors [*Symbol] One or more error which should be in attribute errors
+  # @return [self]
+  def with *errors
+    @with = errors
+
+    self
+  end
+
+  # Run the test
+  # @param model[ActiveModel::Model]
+  # @return [Boolean] Test result
+  # @raise [RspecModelValidations::Error] When model does not posses the given attribute
+  def matches? model
+    attribute_belongs_to! model
+
+    @model = model
+    @errors = attribute_errors model
+
+    @errors.count != 0 && (@with.nil? || (@with & @errors) == @with)
+  end
+
+  # Explain why matches? fail
+  # @return [String]
+  def failure_message
+    attribute = "#{@model.class}##{@attribute}"
+    value = attribute_value(@model).inspect
+
+    expected = "#{value} on #{attribute} to be invalidated"
+    expected = "#{expected} with #{@with.map(&:inspect).join ', '}" unless @with.nil?
+
+    message expected, @errors
+  end
+
+  # Explain why matches? fail when negated
+  # @return [String]
+  def failure_message_when_negated
+    attribute = "#{@model.class}##{@attribute}"
+    value = attribute_value(@model).inspect
+
+    expected = "#{value} on #{attribute} to be validated"
+    expected = "#{value} on #{attribute} not to be invalidated with #{@with.map(&:inspect).join ', '}" unless @with.nil?
+
+    message expected, @errors
+  end
+
+  # One line syntax description
+  # @return [String]
+  def description
+    result = "invalidate #{@attribute.inspect} attribute"
+    result = "#{result} with #{@with.map(&:inspect).join ', '}" unless @with.nil?
+
+    result
+  end
+end

data/lib/rspec_model_validations/matchers/validate.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Test if model validation does not lead to errors on the given attribute.
+class RspecModelValidations::Matchers::Validate
+  include RspecModelValidations::Matchers::Base
+
+  # Run the test
+  # @param model[ActiveModel::Model]
+  # @return [Boolean] Test result
+  # @raise [RspecModelValidations::Error] When model does not posses the given attribute
+  def matches? model
+    attribute_belongs_to! model
+
+    @model = model
+    @errors = attribute_errors model
+
+    @errors.empty?
+  end
+
+  # Explain why matches? fail and show errors
+  # @return [String]
+  def failure_message
+    message "#{attribute_value(@model).inspect} to be a valid value for #{@model.class}##{@attribute}", @errors
+  end
+
+  # Explain why matches? fail when negated
+  # @return [String]
+  def failure_message_when_negated
+    message "#{attribute_value(@model).inspect} to be an invalid value for #{@model.class}##{@attribute}", @errors
+  end
+
+  # One line syntax description
+  # @return [String]
+  def description; "validate #{@attribute.inspect} attribute" end
+end

data/lib/rspec_model_validations/matchers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Rspec 'alias' to run matchers.
+# Include with rspec configuration method `include`
+module RspecModelValidations::Matchers
+  # `validate` alias
+  # @return [Validate]
+  def validate attribute; Validate.new attribute end
+
+  # `invalidate` alias
+  # @return [Validate]
+  def invalidate attribute; Invalidate.new attribute end
+end

data/lib/rspec_model_validations/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Root module
+module RspecModelValidations
+  # RspecModelValidations version number: major.minor.maintenance
+  VERSION = '1.0.1'
+end

data/lib/rspec_model_validations.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'rspec_model_validations/version'
+
+require_relative 'rspec_model_validations/matchers'
+require_relative 'rspec_model_validations/matchers/base'
+require_relative 'rspec_model_validations/matchers/validate'
+require_relative 'rspec_model_validations/matchers/invalidate'
+
+module RspecModelValidations
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/rspec_model_validations.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rspec_model_validations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_model_validations'
+  spec.version       = RspecModelValidations::VERSION
+  spec.authors       = ['Pierre Guego']
+  spec.email         = ['pierre.guego@champagne-terroir.fr']
+
+  spec.summary       = 'Extra matchers to test model validation'
+  spec.homepage      = 'https://github.com/faljie/rspec_model_validations'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rspec_model_validations
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Pierre Guego
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pierre.guego@champagne-terroir.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- bin/console
+- lib/rspec_model_validations.rb
+- lib/rspec_model_validations/matchers.rb
+- lib/rspec_model_validations/matchers/base.rb
+- lib/rspec_model_validations/matchers/invalidate.rb
+- lib/rspec_model_validations/matchers/validate.rb
+- lib/rspec_model_validations/version.rb
+- rspec_model_validations.gemspec
+homepage: https://github.com/faljie/rspec_model_validations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/faljie/rspec_model_validations
+  source_code_uri: https://github.com/faljie/rspec_model_validations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Extra matchers to test model validation
+test_files: []