nobrainer-rspec 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e0c49605afc9e72f119e3d5ecb2809a556defc5ab84d52574eef569d8c08697
+  data.tar.gz: 6a71e9bcb29d5e29c8cc4071fbab8ece22bb3ecbc1d814619c442782032d0924
+SHA512:
+  metadata.gz: 916dfe718138432512a974b258d5d6a9d86a46c184225889e41ebbcd2f13ec8989619f243b8a0ea05791fbcd87e88ad0ab328f4fda83090061275e0951f06fc2
+  data.tar.gz: 7416170408b071fbc3eb6c448e4d604ae771dec9a67b7b37202405d5b36521e2b3c860a29f2b6c77c368af48d2cb235da4175d7bced7572c74730e6419bfd53b

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2020-11-27
+### Fixed
+- Fixes gem build which was creating an empty gem
+
+## [1.0.0] - 2020-11-26
+### Added
+- be_nobrainer_document
+- have_field
+- have_index_for
+- have_timestamps
+- belong_to
+- have_one
+- have_one(...).through(...)
+- have_many
+- have_many(...).through(...)
+- validate_presence_of
+- validate_uniqueness_of
+- validate_length_of
+- validate_inclusion_of
+- validate_acceptance_of
+- validate_confirmation_of
+- validate_exclusion_of
+- validate_format_of
+- validate_numericality_of
+
+[Unreleased]: https://gitlab.com/zedtux/nobrainer-rspec/-/compare/v1.0.1...master
+[1.0.1]: https://gitlab.com/zedtux/nobrainer-rspec/-/compare/v1.0.0...v1.1.0
+[1.0.0]: https://gitlab.com/zedtux/nobrainer-rspec/-/tags/v1.0.0
+

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'byebug'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Guillaume Hain and Contributors
+
+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,61 @@
+# nobrainer-rspec
+
+The nobrainer-rspec library provides a collection of RSpec-compatible matchers that help to test NoBrainer documents.
+
+This gem is heavily inspiring from the [mongoid-rspec](https://github.com/mongoid/mongoid-rspec) gem, keeping same API so that migrating from one to the other is easy.
+
+## Installation
+
+Drop this line into your Gemfile:
+
+```ruby
+group :test do
+  gem 'nobrainer-rspec'
+end
+
+```
+
+## Configuration
+
+Add to your `rails_helper.rb` or `spec_helper.rb` file.
+
+```ruby
+require 'nobrainer-rspec'
+
+RSpec.configure do |config|
+  config.include NoBrainer::Matchers
+end
+```
+
+## Matchers
+
+* [be_nobrainer_document](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/be_nobrainer_document.rb)
+* [have_field](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/have_field.rb)
+* [have_index_for](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/have_index_for.rb)
+* [have_timestamps](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/have_timestamps.rb)
+
+## Associations
+
+* [belong_to, have_one, have_many](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/associations.rb)
+
+## Validations
+
+* [validate_acceptance_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/acceptance_of.rb)
+* [validate_confirmation_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/confirmation_of.rb)
+* [validate_exclusion_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/exclusion_of.rb)
+* [validate_format_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/format_of.rb)
+* [validate_inclusion_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/inclusion_of.rb)
+* [validate_length_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/length_of.rb)
+* [validate_numericality_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/numericality_of.rb)
+* [validate_presence_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/presence_of.rb)
+* [validate_uniqueness_of](https://gitlab.com/zedtux/nobrainer-rspec/-/blob/master/lib/matchers/validations/uniqueness_of.rb)
+
+## Contributing
+
+You're encouraged to contribute to this library.
+
+## Copyright and License
+
+Copyright (c) 2020 Guillaume Hain and Contributors.
+
+MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nobrainer'
+require 'nobrainer/rspec'
+
+# 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
+
+NoBrainer.configure do |config|
+  config.app_name = 'nobrainer-rspec'
+end
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install
+

data/lib/matchers/associations.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+module NoBrainer
+  module Matchers
+    module Associations
+      HAS_MANY = NoBrainer::Document::Association::HasMany
+      HAS_MANY_THROUGH = NoBrainer::Document::Association::HasManyThrough
+      HAS_ONE = NoBrainer::Document::Association::HasOne
+      HAS_ONE_THROUGH = NoBrainer::Document::Association::HasOneThrough
+      BELONGS_TO = NoBrainer::Document::Association::BelongsTo
+
+      # The `belong_to` matcher is used to ensure that a `belongs_to`
+      # association exists on your model.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :organization
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it { is_expected.to belong_to(:organization) }
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### class_name
+      #
+      # Use `class_name` to test usage of the `:class_name` option. This
+      # asserts that the model you're referring to actually exists.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :ancient_city, class_name: 'City'
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it { is_expected.to belong_to(:ancient_city).class_name('City') }
+      #     end
+      #
+      # ##### with_primary_key
+      #
+      # Use `with_primary_key` to test usage of the `:primary_key` option.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :great_country, primary_key: 'country_id'
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it do
+      #         is_expected.to belong_to(:great_country)
+      #           .with_primary_key('country_id')
+      #       end
+      #     end
+      #
+      # ##### with_foreign_key
+      #
+      # Use `with_foreign_key` to test usage of the `:foreign_key` option.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :great_country, foreign_key: 'country_id'
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it do
+      #         is_expected.to belong_to(:great_country)
+      #           .with_foreign_key('country_id')
+      #       end
+      #     end
+      #
+      # ##### with_dependent
+      #
+      # Use `with_dependent` to assert that the `:dependent` option was
+      # specified.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :world, dependent: :destroy
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it { is_expected.to belong_to(:world).with_dependent(:destroy) }
+      #     end
+      #
+      # ##### required
+      #
+      # Use `required` to assert that the association is not allowed to be nil.
+      #
+      #     class Person
+      #       include NoBrainer::Document
+      #
+      #       belongs_to :organization, required: true
+      #     end
+      #
+      #     # RSpec
+      #     describe Person
+      #       it { is_expected.to belong_to(:organization).with_required(true) }
+      #     end
+      #
+      class HaveAssociationMatcher
+        def initialize(name, association_type)
+          @association = {}
+          @association[:name] = name.to_sym
+          @association[:type] = association_type
+          @expectation_message = "#{type_description} #{@association[:name].inspect}"
+          @expectation_message += " of type #{@association[:class].inspect}" unless @association[:class].nil?
+        end
+
+        def class_name(klass)
+          @association[:class] = klass
+          @expectation_message += " with class_name #{@association[:class].inspect}"
+          self
+        end
+
+        def through(association_key)
+          @association[:through] = association_key
+          @association[:type] = @association[:type] == HAS_ONE ? HAS_ONE_THROUGH : HAS_MANY_THROUGH
+          @expectation_message += " through #{association_key.inspect}"
+          self
+        end
+
+        def with_dependent(method_name)
+          @association[:dependent] = method_name
+          @expectation_message += " which specifies dependent as #{@association[:dependent]}"
+          self
+        end
+
+        def with_primary_key(primary_key)
+          @association[:primary_key] = primary_key.to_sym
+          @expectation_message += " using primary key #{@association[:primary_key].inspect}"
+          self
+        end
+
+        def with_foreign_key(foreign_key)
+          @association[:foreign_key] = foreign_key.to_sym
+          @expectation_message += " using foreign key #{@association[:foreign_key].inspect}"
+          self
+        end
+
+        def with_required(required)
+          @association[:required] = required
+          @expectation_message += " with required #{@association[:required].inspect}"
+          self
+        end
+
+        def matches?(actual)
+          @actual = actual.is_a?(Class) ? actual : actual.class
+          metadata = @actual.association_metadata[@association[:name]]
+
+          if metadata.nil?
+            @negative_result_message = "no association named #{@association[:name]}"
+            return false
+          else
+            @positive_result_message = "association named #{@association[:name]}"
+          end
+
+          relation = metadata.class.name.gsub(/::Metadata$/, '').constantize
+          if relation != @association[:type]
+            @negative_result_message = "#{@actual.inspect} #{type_description(relation, false)} #{@association[:name].inspect}"
+            return false
+          else
+            @positive_result_message = "#{@actual.inspect} #{type_description(relation, false)} #{@association[:name].inspect}"
+          end
+
+          if !@association[:class].nil? && (@association[:class] != metadata.options[:class_name])
+            @negative_result_message = "#{@positive_result_message} with class_name #{metadata.options[:class_name].inspect}"
+            return false
+          else
+            @positive_result_message = "#{@positive_result_message}#{" with class_name #{metadata.options[:class_name].inspect}" if @association[:class]}"
+          end
+
+          if @association[:dependent]
+            if @association[:dependent].to_sym != (metadata.options[:dependent] && metadata.options[:dependent].to_sym)
+              @negative_result_message = "#{@positive_result_message} which specified dependent as #{metadata.options[:dependent]}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which specified dependent as #{metadata.options[:dependent]}"
+            end
+          end
+
+          if @association[:primary_key]
+            if metadata.options[:primary_key] != @association[:primary_key]
+              @negative_result_message = "#{@positive_result_message} with primary key #{metadata.options[:primary_key].inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} with primary key #{metadata.options[:primary_key].inspect}"
+            end
+          end
+
+          if @association[:foreign_key]
+            if metadata.foreign_key != @association[:foreign_key]
+              @negative_result_message = "#{@positive_result_message} with foreign key #{metadata.foreign_key.inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} with foreign key #{metadata.foreign_key.inspect}"
+            end
+          end
+
+          if @association[:through]
+            if metadata.options[:through] != @association[:through]
+              @negative_result_message = "#{@positive_result_message} through #{metadata.options[:through].inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} through #{metadata.options[:through].inspect}"
+            end
+          end
+
+          if @association[:required]
+            if metadata.options[:required] != @association[:required]
+              @negative_result_message = "#{@positive_result_message} with required #{metadata.options[:required].inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} with required #{metadata.options[:required].inspect}"
+            end
+          end
+
+          true
+        end
+
+        def failure_message_for_should
+          "Expected #{@actual.inspect} to #{@expectation_message}, got #{@negative_result_message}"
+        end
+
+        def failure_message_for_should_not
+          "Expected #{@actual.inspect} to not #{@expectation_message}, got #{@positive_result_message}"
+        end
+
+        alias failure_message failure_message_for_should
+        alias failure_message_when_negated failure_message_for_should_not
+
+        def description
+          @expectation_message
+        end
+
+        def type_description(type = nil, passive = true)
+          type ||= @association[:type]
+          case type.name
+          when HAS_ONE.name
+            (passive ? 'have one' : 'having one')
+          when HAS_ONE_THROUGH.name
+            (passive ? 'have one through' : 'having one')
+          when HAS_MANY.name
+            (passive ? 'have many' : 'having many')
+          when HAS_MANY_THROUGH.name
+            (passive ? 'have many through' : 'having many')
+          when BELONGS_TO.name
+            (passive ? 'belong to' : 'belonging to')
+          else
+            raise format("Unknown association type #{type}")
+          end
+        end
+
+        private
+
+        def association_kind_of
+          Mongoid::Compatibility::Version.mongoid5_or_older? ? Origin::Key : Mongoid::Criteria::Queryable::Key
+        end
+      end
+
+      def have_one_related(association_name)
+        HaveAssociationMatcher.new(association_name, HAS_ONE)
+      end
+      alias have_one have_one_related
+
+      def have_many_related(association_name)
+        HaveAssociationMatcher.new(association_name, HAS_MANY)
+      end
+      alias have_many have_many_related
+
+      def belong_to_related(association_name)
+        HaveAssociationMatcher.new(association_name, BELONGS_TO)
+      end
+      alias belong_to belong_to_related
+    end
+  end
+end