nobrainer-rspec 1.0.1

data/lib/matchers/validations/length_of.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module Matchers
+    module Validations
+      class ValidateLengthOfMatcher < HaveValidationMatcher
+        def initialize(name)
+          super(name, :length)
+        end
+
+        def with_maximum(value)
+          @maximum = value
+          self
+        end
+        alias less_than with_maximum
+
+        def with_minimum(value)
+          @minimum = value
+          self
+        end
+        alias greater_than with_minimum
+
+        def within(value)
+          @within = value
+          self
+        end
+        alias in within
+
+        def as_exactly(value)
+          @is = value
+          self
+        end
+        alias is as_exactly
+
+        def matches?(actual)
+          return false unless @result = super(actual)
+
+          check_maximum if @maximum
+          check_minimum if @minimum
+          check_range if @within
+          check_exact if @is
+
+          @result
+        end
+
+        def description
+          options_desc = []
+          options_desc << "with minimum of #{@minimum}" if @minimum
+          options_desc << "with maximum of #{@maximum}" if @maximum
+          options_desc << "within the range of #{@within}" if @within
+          options_desc << "as exactly #{@is}" if @is
+          "#{super} #{options_desc.to_sentence}"
+        end
+
+        private
+
+        def check_maximum
+          if actual_max.nil?
+            @negative_result_message += ' with no maximum'
+            @result = false
+          elsif actual_max == @maximum
+            @positive_result_message += " with maximum of #{@maximum}"
+          else
+            @negative_result_message += " with maximum of #{actual_max}"
+            @result = false
+          end
+        end
+
+        def check_minimum
+          if actual_min.nil?
+            @negative_result_message += ' with no minimum'
+            @result = false
+          elsif actual_min == @minimum
+            @positive_result_message += " with minimum of #{@minimum}"
+          else
+            @negative_result_message += " with minimum of #{actual_min}"
+            @result = false
+          end
+        end
+
+        def check_range
+          min, max = @within.minmax
+          if !actual_min.nil? && actual_max.nil?
+            @negative_result_message += " with no minimum but with maximum of #{actual_max}"
+            @result = false
+          elsif actual_min.nil? && !actual_max.nil?
+            @negative_result_message += " with minimum_of #{actual_min} but no maximum"
+            @result = false
+          elsif actual_min.nil? && actual_max.nil?
+            @negative_result_message += ' with no minimum and maximum'
+            @result = false
+          elsif actual_min == min && actual_max == max
+            @positive_result_message += " within the range of #{@within.inspect}"
+          else
+            @negative_result_message += " within the range of #{(actual_min..actual_max).inspect}"
+            @result = false
+          end
+        end
+
+        def check_exact
+          if actual_is == @is
+            @positive_result_message += " as exactly #{@is}"
+          else
+            @negative_result_message += " as exactly #{actual_is}"
+            @result = false
+          end
+        end
+
+        def actual_is
+          actual_is = @validator.options[:is]
+        end
+
+        def actual_min
+          @validator.options[:minimum] || (@validator.options[:in] || @validator.options[:within]).try(&:min)
+        end
+
+        def actual_max
+          @validator.options[:maximum] || (@validator.options[:in] || @validator.options[:within]).try(&:max)
+        end
+      end
+
+      def validate_length_of(field)
+        ValidateLengthOfMatcher.new(field)
+      end
+    end
+  end
+end

data/lib/matchers/validations/numericality_of.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module Matchers
+    module Validations
+      class ValidateNumericalityOfMatcher < HaveValidationMatcher
+        ALLOWED_OPTIONS =
+          %i[
+            allow_nil
+            equal_to
+            even
+            greater_than
+            greater_than_or_equal_to
+            less_than
+            less_than_or_equal_to
+            nil
+            odd
+            only_integer
+          ].freeze
+
+        def initialize(field)
+          super(field, :numericality)
+          @options = {}
+        end
+
+        def to_allow(options)
+          options[:equal_to] = options if options.is_a?(Numeric)
+          options[:allow_nil] = options.delete(:nil) if options.key?(:nil)
+
+          if !options.is_a?(Hash) || options.empty? || (options.keys - ALLOWED_OPTIONS).any?
+            message =
+              'validate_numericality_of#to_allow requires a Hash parameter containing' \
+              "any of the following keys: #{ALLOWED_OPTIONS.map(&:inspect).join(', ')}"
+            raise ArgumentError, message
+          end
+
+          @options.merge!(options)
+          self
+        end
+
+        def matches?(actual)
+          return false unless result = super(actual)
+
+          @options.each do |comparator, expected_value|
+            result &= (@validator.options[comparator] == expected_value)
+          end
+
+          @positive_result_message += options_message(@validator.options)
+          @negative_result_message += options_message(@validator.options)
+          result
+        end
+
+        def description
+          "#{super}#{options_message(@options)}"
+        end
+
+        protected
+
+        def options_message(options)
+          type_msg = []
+          comp_msg = []
+          options.each_pair do |key, value|
+            case key
+            when :allow_nil
+            when :only_integer
+              type_msg << 'integer' if value
+            when :odd, :even
+              type_msg << "#{key}-numbered" if value
+            else
+              comp_msg << "#{key.to_s.tr('_', ' ')} #{value.inspect}"
+            end
+          end
+          allow_nil = (options[:allow_nil] ? 'nil' : 'non-nil') if options.key?(:allow_nil)
+          ['', 'allowing', allow_nil, type_msg.any? ? type_msg.to_sentence : nil, 'values', comp_msg.any? ? comp_msg.to_sentence : nil].compact.join(' ')
+        end
+
+        def method_missing(m, *args, &block)
+          if ALLOWED_OPTIONS.include?(m.to_sym)
+            raise ArgumentError, "wrong number of arguments (#{args.length} for 1)" if args.length > 1
+            send :to_allow, m.to_sym => args.first
+          else
+            super
+          end
+        end
+      end
+
+      def validate_numericality_of(field)
+        ValidateNumericalityOfMatcher.new(field)
+      end
+    end
+  end
+end

data/lib/matchers/validations/presence_of.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module Matchers
+    module Validations
+      def validate_presence_of(field)
+        HaveValidationMatcher.new(field, :presence)
+      end
+    end
+  end
+end

data/lib/matchers/validations/uniqueness_of.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module Matchers
+    module Validations
+      class ValidateUniquenessOfMatcher < HaveValidationMatcher
+        def initialize(field)
+          super(field, :uniqueness)
+        end
+
+        def scoped_to(*scope)
+          @scope = [scope].flatten.map(&:to_sym)
+          self
+        end
+        alias scoped_on scoped_to
+
+        def matches?(actual)
+          return false unless @result = super(actual)
+
+          check_scope if @scope
+
+          @result
+        end
+
+        def description
+          options_desc = []
+          options_desc << " scoped to #{@scope.inspect}" if @scope
+          "#{super}#{options_desc.to_sentence}"
+        end
+
+        private
+
+        def check_scope
+          message = " scope to #{@validator.options[:scope]}"
+          if @validator.options[:scope]
+            if [@validator.options[:scope] || ''].flatten.map(&:to_sym) == @scope
+              @positive_result_message += message
+            else
+              @negative_result_message += message
+            end
+          else
+            @negative_result_message += ' without a scope'
+            @result = false
+          end
+        end
+      end
+
+      def validate_uniqueness_of(field)
+        ValidateUniquenessOfMatcher.new(field)
+      end
+    end
+  end
+end

data/lib/nobrainer-rspec.rb

@@ -0,0 +1 @@
+require 'nobrainer/rspec'

data/lib/nobrainer/rspec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'nobrainer'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/mocks'
+
+require 'matchers/associations'
+require 'matchers/be_nobrainer_document'
+require 'matchers/have_field'
+require 'matchers/have_index_for'
+require 'matchers/have_timestamps'
+require 'matchers/validations'
+require 'matchers/validations/acceptance_of'
+require 'matchers/validations/confirmation_of'
+require 'matchers/validations/exclusion_of'
+require 'matchers/validations/format_of'
+require 'matchers/validations/inclusion_of'
+require 'matchers/validations/length_of'
+require 'matchers/validations/numericality_of'
+require 'matchers/validations/presence_of'
+require 'matchers/validations/uniqueness_of'
+
+module NoBrainer
+  module Matchers
+    include NoBrainer::Matchers::Associations
+    include NoBrainer::Matchers::Validations
+  end
+end

data/lib/nobrainer/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module RSpec
+    VERSION = '1.0.1'
+  end
+end

data/nobrainer-rspec.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'nobrainer/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'nobrainer-rspec'
+  spec.version     = NoBrainer::RSpec::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Guillaume Hain']
+  spec.email       = ['zedtux@zedroot.org']
+  spec.homepage    = 'https://gitlab.com/zedtux/nobrainer-rspec'
+  spec.summary     = 'RSpec matchers for Nobrainer'
+  spec.description = 'RSpec matches for Nobrainer models, including ' \
+                     'association and validation matchers.'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/blob/master/CHANGELOG.md"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{
+      ^(test|spec|features)/|
+      \.gitlab-ci.yml|
+      \.rspec|
+      \.gitignore|
+      Earthfile|
+      Dockerfile|
+      docker-compose.yml
+    }x)
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nobrainer'
+  spec.add_dependency 'rspec-core', '~> 3.3'
+  spec.add_dependency 'rspec-expectations', '~> 3.3'
+  spec.add_dependency 'rspec-mocks', '~> 3.3'
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: nobrainer-rspec
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Guillaume Hain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nobrainer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: RSpec matches for Nobrainer models, including association and validation
+  matchers.
+email:
+- zedtux@zedroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/matchers/associations.rb
+- lib/matchers/be_nobrainer_document.rb
+- lib/matchers/have_field.rb
+- lib/matchers/have_index_for.rb
+- lib/matchers/have_timestamps.rb
+- lib/matchers/validations.rb
+- lib/matchers/validations/acceptance_of.rb
+- lib/matchers/validations/confirmation_of.rb
+- lib/matchers/validations/exclusion_of.rb
+- lib/matchers/validations/format_of.rb
+- lib/matchers/validations/inclusion_of.rb
+- lib/matchers/validations/length_of.rb
+- lib/matchers/validations/numericality_of.rb
+- lib/matchers/validations/presence_of.rb
+- lib/matchers/validations/uniqueness_of.rb
+- lib/nobrainer-rspec.rb
+- lib/nobrainer/rspec.rb
+- lib/nobrainer/rspec/version.rb
+- nobrainer-rspec.gemspec
+homepage: https://gitlab.com/zedtux/nobrainer-rspec
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/zedtux/nobrainer-rspec
+  source_code_uri: https://gitlab.com/zedtux/nobrainer-rspec
+  changelog_uri: https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for Nobrainer
+test_files: []