validator-matchers 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c29cace69abe0fc863bdb4324cbf72449dbbe4eedd4cf519f7533005922ee055
+  data.tar.gz: 678704e042afb52ce86ae4f65a8b8d2dc85dd554ce6c4f2d5162d32097981f05
+SHA512:
+  metadata.gz: 1e58df1c84692e0d70abf43cc0f7f465ffafd474491d41d005d2b394a84402dc74bdcde64169ef1b0c7714da15817de3f2ca5123e8f6af3ef1fb7382aa25bda5
+  data.tar.gz: 51f1f8ad240b36b21b2d9914d45dc0cd8ded26df77bbdb1733be3f3cd6aa3d8beaac8df5bc22c134e6c09fd0d5cf4db6d0ff1b4359d17823c23f426c570ae650

data/.gitignore

@@ -0,0 +1,58 @@
+# TODO: This is just the default .gitignore, should probably be fine-tuned
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+Historical changelog for all versions.
+
+## HEAD
+
+## v0.0.0
+
+* Initial helpers with autoloading for validator specs (heavily based on [izumin5210/rspec-validator_spec_helper](https://github.com/izumin5210/rspec-validator_spec_helper))

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 [Josh Buker](mailto:crypto@joshbuker.com)
+
+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/README.md

@@ -0,0 +1,9 @@
+# RSpec Validator Matchers
+
+Inspired by the following:
+
+* [Stack Overflow post](https://stackoverflow.com/questions/7744171/how-to-test-a-custom-validator)
+* [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers)
+* [pundit-matchers](https://github.com/chrisalley/pundit-matchers)
+* [izumin5210/rspec-validator_spec_helper](https://github.com/izumin5210/rspec-validator_spec_helper).
+* [RSpec DynamicPredicate](https://github.com/rspec/rspec-expectations/blob/master/lib/rspec/matchers/built_in/has.rb)

data/lib/validator-matchers.rb

@@ -0,0 +1 @@
+require 'validator/matchers'

data/lib/validator/matchers.rb

@@ -0,0 +1,21 @@
+require 'rspec/core'
+
+module Validator
+  module Matchers
+    autoload :VERSION, 'validator/matchers/version'
+    # autoload :ModelSpecHelper, 'validator/matchers/model_spec_helper'
+    autoload :ValidatorSpecHelper, 'validator/matchers/validator_spec_helper'
+  end
+end
+
+##
+# Automatically configure RSpec to support validator specs.
+#
+RSpec.configure do |config|
+  config.define_derived_metadata(file_path: %r{/spec/validators/}) do |metadata|
+    metadata[:type] = :validator
+  end
+
+  # config.include Validator::Matchers::ModelSpecHelper,     type: :model
+  config.include Validator::Matchers::ValidatorSpecHelper, type: :validator
+end

data/lib/validator/matchers/validator_spec_helper.rb

@@ -0,0 +1,71 @@
+module Validator
+  module Matchers
+    # TODO: Document and cleanup.
+    module ValidatorSpecHelper
+      DEFAULT_ATTRIBUTE_NAME = :value
+
+      # Auto extend validator specs when included
+      def self.included(base)
+        base.instance_eval do
+          let(:validator_name) do
+            RSpec.current_example.full_description.match(/\A[\w:]+Validator/)[0]
+          end
+
+          let(:validator_class) { Object.const_get(validator_name) }
+
+          let(:validator_type) do
+            if validator_class.ancestors.include? ActiveModel::EachValidator
+              ActiveModel::EachValidator
+            else
+              ActiveModel::Validator
+            end
+          end
+
+          let(:validation_name) do
+            validator_name.underscore.gsub(/_validator\Z/, '')
+          end
+
+          let(:attribute_names) { [DEFAULT_ATTRIBUTE_NAME] }
+
+          let(DEFAULT_ATTRIBUTE_NAME) { nil }
+
+          let(:options) { nil }
+
+          # This smells like it can be extracted into two objects.
+          let(:model_class) do
+            example_group = self
+            Struct.new(*attribute_names) do
+              include ActiveModel::Validations
+
+              def self.name
+                'ValidatorModelMock'
+              end
+
+              if example_group.validator_type == ActiveModel::EachValidator
+                args =
+                  {
+                    example_group.validation_name.to_sym => (
+                      example_group.options || true
+                    )
+                  }
+                validates DEFAULT_ATTRIBUTE_NAME, args
+              else
+                if example_group.options.nil?
+                  validates_with example_group.validator_class
+                else
+                  validates_with example_group.validator_class,
+                    example_group.options
+                end
+              end
+            end
+          end
+
+          let(:validator_model_mock) do
+            attributes = attribute_names.map { |name| eval("#{name}") }
+            model_class.new(*attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/validator/matchers/version.rb

@@ -0,0 +1,15 @@
+module Validator
+  module Matchers
+    def self.gem_version
+      Gem::Version.new VERSION::STRING
+    end
+
+    module VERSION
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 0
+
+      STRING = [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/validator-matchers.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validator/matchers/version'
+
+version  = Validator::Matchers::VERSION::STRING
+gem_name = 'validator-matchers'
+repo_url = "https://github.com/athix/#{gem_name}"
+
+Gem::Specification.new do |s|
+  s.version     = version
+  s.platform    = Gem::Platform::RUBY
+  s.name        = gem_name
+  s.summary     = 'RSpec matchers for your custom validator unit testing'
+  # TODO: More descriptive description.
+  # s.description = 'RSpec matchers for your custom validator unit testing'
+
+  s.required_ruby_version = '>= 2.5.0'
+
+  s.license  = 'MIT'
+  s.author   = 'Josh Buker'
+  s.email    = 'crypto@joshbuker.com'
+  s.homepage = repo_url
+  s.metadata = {
+    'bug_tracker_uri' => "#{repo_url}/issues",
+    'changelog_uri' => "#{repo_url}/releases/tag/v#{version}",
+    'documentation_uri' => "https://rubydoc.info/gems/#{gem_name}",
+    'source_code_uri' => "#{repo_url}/tree/v#{version}"
+  }
+
+  s.files      = `git ls-files -z`.split("\x0")
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rspec-rails', '>= 3.0', '< 6'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: validator-matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Josh Buker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: 
+email: crypto@joshbuker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/validator-matchers.rb
+- lib/validator/matchers.rb
+- lib/validator/matchers/validator_spec_helper.rb
+- lib/validator/matchers/version.rb
+- validator-matchers.gemspec
+homepage: https://github.com/athix/validator-matchers
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/athix/validator-matchers/issues
+  changelog_uri: https://github.com/athix/validator-matchers/releases/tag/v0.0.0
+  documentation_uri: https://rubydoc.info/gems/validator-matchers
+  source_code_uri: https://github.com/athix/validator-matchers/tree/v0.0.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for your custom validator unit testing
+test_files: []