ezcater_matchers 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c967cc270d0724087f02c6d1792359836c90e0dcedc2812a2c79623622a4ef63
+  data.tar.gz: e72c033b5c79ec064d06cec912d402802d059cf55c1cbbd34c3a97af368cd4e8
+SHA512:
+  metadata.gz: 5689ef239af6e382e4f2698c1c8da6ed8806088f3b26c960efc366cd54e4985ed23af7809d5ed9fbb8f716838ac79c7f9f4ca1c839d023b9cb3ef059b4f90c04
+  data.tar.gz: bb77f08cc8083dd53f97019cd4bda09f325b87768d50619e005906c10a910976ddda433387bdaa2f1bb8fc79d82f4f36e8611c8dbb614effd5c40ddcb3ef11ba

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# ezcater_matchers
+
+## v0.5.0
+- Open source release
+
+## v0.4.0
+- Add `match_models` matcher
+
+## v0.3.0
+- Add `match_db_timestamp` matcher
+
+## v0.2.0
+- Add `have_been_destroyed` matcher
+
+## v0.1.0
+- Initial version
+- Add `match_ordered_array` matcher

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in ezcater_matchers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ezCater, Inc
+
+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,83 @@
+# ezcater_matchers
+
+[![CircleCI](https://circleci.com/gh/ezcater/ezcater_matchers.svg?style=svg)](https://circleci.com/gh/ezcater/ezcater_matchers)
+
+This gem contains shared RSpec matchers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem "ezcater_matchers"
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ezcater_matchers
+
+## Usage
+
+### Matchers
+
+The matchers included in this gem are:
+
+* **have_been_destroyed**: To check that a model has (or has not) been destroyed.
+* **match_db_timestamp**: Compares two timestamps for equality with DB precision (drops nanoseconds).
+* **match_models**: Compare an enumerable to an expected list of ActiveRecord model objects (by id/type).
+* **match_ordered_array**: To check that an array has exactly the expected, ordered elements.
+
+### Examples
+
+#### match_models
+
+You can use `match_models` to simplify comparing enumerables/ActiveRecord relations to a single expected example:
+```
+my_model = build(:your_model)
+
+expect(YourModel.scope).to match_models(my_model)
+```
+
+You can use `match_models` to compare complex, heterogeneous result lists:
+
+```
+caterer = create(:caterer, name: "matches")
+brand = create(:caterer, name: "matches")
+
+expect(FullTextSearch.call("matches")).to match_models(caterer, brand)
+```
+
+You can also chain the `match_models` matcher to respect/ignore enumerable ordering, which is helpful in combatting flaky tests where order is not 100% deterministic:
+```
+caterer = create(:caterer, name: "matches")
+brand = create(:caterer, name: "matches")
+
+expect(RandomOrderedSearch.call("matches")).to match_models(caterer, brand).unordered
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ezcater/ezcater_matchers.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/ezcater_matchers.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ezcater_matchers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezcater_matchers"
+  spec.version       = EzcaterMatchers::VERSION
+  spec.authors       = ["ezCater, Inc"]
+  spec.email         = ["engineering@ezcater.com"]
+
+  spec.summary       = "shared matchers"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/ezcater/ezcater_matchers"
+  spec.license       = "MIT"
+
+  # Set "allowed_push_post" to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  excluded_files = %w(.circleci/config.yml
+                      .github/PULL_REQUEST_TEMPLATE.md
+                      .gitignore
+                      .rspec
+                      .rubocop.yml
+                      .ruby-gemset
+                      .ruby-version
+                      .travis.yml
+                      bin/console
+                      bin/setup
+                      Rakefile)
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end - excluded_files
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "ezcater_gem", ">= 0.2.0"
+  spec.add_development_dependency "ezcater_rubocop", "0.57.2"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_runtime_dependency "rspec", "~> 3.4"
+end

data/lib/ezcater_matchers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rspec"
+
+Dir.glob(File.expand_path("ezcater_matchers/*.rb", __dir__)).each { |file| require file }

data/lib/ezcater_matchers/have_been_destroyed.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_been_destroyed do
+  match do |model|
+    !model.class.exists?(model.id)
+  end
+end

data/lib/ezcater_matchers/match_db_timestamp.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Compare one or more ActiveRecord database Timestamp values, with db precision (drops nanoseconds)
+RSpec::Matchers.define :match_db_timestamp do |expected|
+  match do |actual|
+    expect(db_precision(actual)).to eq(db_precision(expected))
+  end
+
+  failure_message do |actual|
+    "expected #{debug_timestamp(db_precision(actual))} to match #{debug_timestamp(db_precision(expected))}"
+  end
+
+  def db_precision(timestamp)
+    timestamp.change(nsec: 0)
+  end
+
+  def debug_timestamp(timestamp)
+    "#{timestamp} (#{timestamp.to_f})"
+  end
+end

data/lib/ezcater_matchers/match_models.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Compare one or more ActiveRecord models to an enumerable of actual results
+# Error messages display friendly output of `ModelClass-id` tuples for debugging
+RSpec::Matchers.define :match_models do |*expected| # rubocop:disable Metrics/BlockLength
+  @comparator = :equality
+
+  match do |actual|
+    case @comparator
+    when :set
+      expect(actual_models(actual).to_set).to eq(expected_models(expected).to_set)
+    else
+      expect(actual_models(actual)).to eq(expected_models(expected))
+    end
+  end
+
+  failure_message do |actual|
+    "expected #{expected_models(expected).inspect} but got #{actual_models(actual)}"
+  end
+
+  chain :ordered do
+    @comparator = :equality
+  end
+
+  chain :unordered do
+    @comparator = :set
+  end
+
+  def actual_models(actual_array)
+    actual_array.to_a.map { |obj| object_name(obj) }
+  end
+
+  def expected_models(expected_array)
+    expected_array.map { |obj| object_name(obj) }
+  end
+
+  def object_name(obj)
+    "#{obj.class.name}-#{obj.id}"
+  end
+end

data/lib/ezcater_matchers/match_ordered_array.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "ezcater_matchers/mismatched_collection_failure"
+
+RSpec::Matchers.define :match_ordered_array do |expected|
+  match do |actual|
+    actual == expected
+  end
+
+  failure_message do |actual|
+    EzcaterMatchers::MismatchedCollectionFailure.
+      new(actual: actual, expected: expected).
+      message
+  end
+end

data/lib/ezcater_matchers/mismatched_collection_failure.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module EzcaterMatchers
+  class MismatchedCollectionFailure
+    attr_reader :message
+
+    def initialize(actual:, expected:)
+      @actual = actual
+      @expected = expected
+      @message = message_array.join("\n")
+    end
+
+    private
+
+    attr_reader :actual, :expected
+
+    def message_array
+      [].tap do |messages|
+        messages.push(extra_elements_message) if extra_elements.any?
+        messages.push(missing_elements_message) if missing_elements.any?
+        messages.push(unexpected_order_message) if missing_elements.empty? && extra_elements.empty?
+      end
+    end
+
+    def extra_elements_message
+      "the extra elements were: #{extra_elements}"
+    end
+
+    def extra_elements
+      @_extra_elements ||= actual - expected
+    end
+
+    def missing_elements_message
+      "the missing elements were: #{missing_elements}"
+    end
+
+    def missing_elements
+      @_missing_elements ||= expected - actual
+    end
+
+    def unexpected_order_message
+      "the elements are not in the expected order"
+    end
+  end
+end

data/lib/ezcater_matchers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EzcaterMatchers
+  VERSION = "0.5.0"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: ezcater_matchers
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- ezCater, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: ezcater_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: ezcater_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: shared matchers
+email:
+- engineering@ezcater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- ezcater_matchers.gemspec
+- lib/ezcater_matchers.rb
+- lib/ezcater_matchers/have_been_destroyed.rb
+- lib/ezcater_matchers/match_db_timestamp.rb
+- lib/ezcater_matchers/match_models.rb
+- lib/ezcater_matchers/match_ordered_array.rb
+- lib/ezcater_matchers/mismatched_collection_failure.rb
+- lib/ezcater_matchers/version.rb
+homepage: https://github.com/ezcater/ezcater_matchers
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: shared matchers
+test_files: []