umts-custom-matchers 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e90039bee08f84a23c5fdec616b2655a3642f61
-  data.tar.gz: ea98a4272410693f779fb400fa1713398552530d
+SHA256:
+  metadata.gz: c882162c2ba6dcf128603574b4e02c5a09fdd46fe38beda2d29f8b42a4858e81
+  data.tar.gz: 93786143d1e726ef5742382d3eee172a9b750e562fc8dc8660be541ce1448f93
 SHA512:
-  metadata.gz: b1554af00b1b7f66332decddb6644a783fd86002f7142efa465a2f2f2fc6a95c084b66f2c0edeba75ff03dc7fd74dd213c305773abdcea679d9e16bbd26afdfd
-  data.tar.gz: 906d28fe4f65ff475797f8377a27410b1754fee356db7e534eaaa9f4ac71b5f61932cdcd05c40fefb2b5db66daa9e93b0d5a3d5f29d85799ff23837ee81b0898
+  metadata.gz: a4f01c0ceadb6ce32545022b21ee925c4ec144d95d739b860b1144ea4bd4ba7ff10839aea5991d3eefa75c74957dfba36c6abe095955e9b5c1f74f9a83b7022c
+  data.tar.gz: 38467a95ae068a0b1afeb59758f12b2d78cb6648099628255080fe7d333a1602c86370bac1a5ecee618ebe5bf48f668f7c3f83de047a7333a80432529c1106e0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 David Faulkenberry
+Copyright (c) 2020 UMass Transportation Services
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,20 @@
-# UmtsCustomMatchers
+UmtsCustomMatchers
+==================
 
-Custom RSpec Rails-related matchers, used for UMass Transit's internal Rails development process.
+Custom RSpec Rails-related matchers, used for UMass Transit's internal Rails
+development process.
 
-Primary contributor is @dfaulken.
+Much of the inspiration for these solutions came from inspection of the
+rspec-rails source code, so thanks to the rspec-rails team for making their
+source code public.
 
-## Installation
+[![Build Status][travis-badge]][travis-link]
+[![Test Coverage][cc-coverage-badge]][cc-coverage-link]
+[![Code Climate][cc-badge]][cc-link]
+[![Issue Count][cc-issue-badge]][cc-issue-link]
+
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
@@ -14,27 +24,66 @@ gem 'umts-custom-matchers'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install umts-custom-matchers
+```
+$ gem install umts-custom-matchers
+```
+
+Usage
+-----
+
+Require the matchers in your RSpec configuration file:
+
+```ruby
+require 'umts_custom_matchers'
+```
+
+And include them:
+
+```ruby
+RSpec.configure do |config|
+  # ...
+  config.include UmtsCustomMatchers
+end
+```
 
-## Usage
+Development
+-----------
 
-TODO: Write usage instructions here
+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.
 
-## Development
+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][rg].
 
-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.
+Contributing
+------------
 
-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).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/umts/custom-matchers.
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/umts-custom-matchers.
+License
+-------
 
+The gem is available as open source under the terms of the [MIT License][lic].
 
-## License
+[travis-badge]: https://travis-ci.org/umts/custom-matchers.svg?branch=master
+[travis-link]: https://travis-ci.org/umts/custom-matchers
+[cc-coverage-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/coverage.svg
+[cc-coverage-link]: https://codeclimate.com/github/umts/custom-matchers/coverage
+[cc-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/gpa.svg
+[cc-link]: https://codeclimate.com/github/umts/custom-matchers
+[cc-issue-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/issue_count.svg
+[cc-issue-link]: https://codeclimate.com/github/umts/custom-matchers
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[rg]: https://rubygems.org
+[lic]: http://opensource.org/licenses/MIT

data/lib/umts_custom_matchers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'umts_custom_matchers/version'
+
+require 'umts_custom_matchers/redirect_back'
+
+##
+# Container module for UMTS RSpec matchers
+module UmtsCustomMatchers
+end

data/lib/umts_custom_matchers/redirect_back.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'action_controller'
+require 'action_controller/test_case'
+require 'rspec/rails/matchers'
+
+##
+#:nodoc:
+module UmtsCustomMatchers
+  ##
+  # Matcher for redirecting to "back". Asserts that the HTTP response code is
+  # a redirect, and also that the `Location` matches the HTTP_REFERER of the
+  # request.
+  class RedirectBack
+    MATCHER_MODULE = RSpec::Rails::Matchers
+    STATUS_CODE_MATCHER = MATCHER_MODULE::HaveHttpStatus::GenericStatus
+    REDIRECT_PATH_MATCHER = MATCHER_MODULE::RedirectTo::RedirectTo
+
+    ALLOWED_REQUEST_TYPES = [ActionController::TestRequest].freeze
+    ALLOWED_RESPONSE_TYPES = [ActionDispatch::TestResponse].freeze
+
+    def initialize(scope)
+      @scope = scope
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
+
+    ##
+    # Returns `true` if response is a `302`, and the location matches the `HTTP_REFERER`
+    # of the request. `false` otherwise.
+    def matches?(code)
+      path = 'http://test.host/redirect'
+      status_matcher = STATUS_CODE_MATCHER.new :redirect
+      path_matcher = REDIRECT_PATH_MATCHER.new @scope, path
+
+      verify_spec_type or return false
+      verify_request_type or return false
+      verify_response_type or return false
+      verify_input_type(code) or return false
+
+      @scope.request.env['HTTP_REFERER'] ||= path
+      code.call
+      @response = @scope.response
+
+      verify_status_code(status_matcher) or return false
+      verify_redirect_path(path_matcher) or return false
+
+      true
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
+
+    ##
+    #:nodoc:
+    def failure_message
+      @message
+    end
+
+    ##
+    #:nodoc:
+    def failure_message_when_negated
+      'expected response not to redirect back, but did'
+    end
+
+    ##
+    #:nodoc:
+    def supports_block_expectations?
+      true
+    end
+
+    private
+
+    def verify_input_type(input)
+      return true if input.is_a? Proc
+
+      @message =
+        "expected block argument, but received #{input.class}"
+      false
+    end
+
+    def verify_redirect_path(matcher)
+      return true if matcher.matches? @response
+
+      @message = matcher.failure_message
+      false
+    end
+
+    def verify_request_type
+      return true if ALLOWED_REQUEST_TYPES.include? @scope.request.class
+
+      @message = "expected test request to be one of: \
+                  #{ALLOWED_REQUEST_TYPES.join ', '}; \
+                  but was #{@scope.request.class}"
+      false
+    end
+
+    def verify_response_type
+      return true if ALLOWED_RESPONSE_TYPES.include? @scope.response.class
+
+      @message = "expected test response to be one of: \
+                  #{ALLOWED_RESPONSE_TYPES.join ', '}; \
+                  but was #{@scope.response.class}"
+      false
+    end
+
+    def verify_spec_type
+      return true if @scope.respond_to?(:request) && @scope.respond_to?(:response)
+
+      @message = 'The redirect_back matcher is only valid for controller specs.'
+      false
+    end
+
+    def verify_status_code(matcher)
+      return true if matcher.matches? @response
+
+      @message = matcher.failure_message
+      false
+    end
+  end
+
+  ##
+  # Wrapper method for `RedirectBack` can be used in examples if `UmtsCustomMatchers`
+  # is incuded.
+  def redirect_back
+    RedirectBack.new self
+  end
+end

data/lib/umts_custom_matchers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UmtsCustomMatchers
+  VERSION = '1.0.0'
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: umts-custom-matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - UMass Transit Services
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2021-01-06 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: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -115,26 +121,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- lib/umts-custom-matchers.rb
-- lib/umts-custom-matchers/redirect_back.rb
-- lib/umts-custom-matchers/version.rb
-- umts-custom-matchers.gemspec
+- lib/umts_custom_matchers.rb
+- lib/umts_custom_matchers/redirect_back.rb
+- lib/umts_custom_matchers/version.rb
 homepage: https://github.com/umts/custom-matchers
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message: The require location of this gem's libraries has been changed
+  to reflect better ruby conventions. Change any instance of `require 'umts-custom-matchers'
+  to `require 'umts_custom_matchers'
 rdoc_options: []
 require_paths:
 - lib
@@ -142,15 +141,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Custom RSpec Rails-related matcher, used for UMass Transit's internal Rails

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,10 +0,0 @@
-Metrics/LineLength:
-  Max: 100
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/umts-custom-cops/version.rb'
-
-Style/FileName:
-  Enabled: false

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-env: CODECLIMATE_REPO_TOKEN=2e3996c4e1980943b0b1350ecfccc3c7f1adf90952d7a6c176b4d4bcf4e6b0c6
-before_install: gem install bundler
-script: bundle exec rake
-notifications:
-  email:
-    recipients:
-      - transit-it@admin.umass.edu

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in umts-custom-matchers.gemspec
-gemspec

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'umts/custom/matchers'
-
-# 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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/umts-custom-matchers.rb

@@ -1,3 +0,0 @@
-require 'umts-custom-matchers/version'
-
-require 'umts-custom-matchers/redirect_back'

data/lib/umts-custom-matchers/redirect_back.rb

@@ -1,30 +0,0 @@
-require 'rspec/rails/matchers'
-
-module UmtsCustomMatchers
-  class RedirectBack
-    MATCHER_MODULE = RSpec::Rails::Matchers
-    STATUS_CODE_MATCHER = MATCHER_MODULE::HaveHttpStatus::GenericStatus
-    REDIRECT_PATH_MATCHER = MATCHER_MODULE::RedirectTo::RedirectTo
-
-    def initialize(scope)
-      @scope = scope
-    end
-
-    def matches?(code)
-      path = 'http://test.host/redirect'
-      @scope.request.env['HTTP_REFERER'] = path
-      return false unless code.is_a? Proc
-      code.call
-      STATUS_CODE_MATCHER.new(:redirect).matches?(@scope.response) &&
-        REDIRECT_PATH_MATCHER.new(@scope, path).matches?(true)
-    end
-
-    def supports_block_expectations?
-      true
-    end
-  end
-
-  def redirect_back
-    RedirectBack.new self
-  end
-end

data/lib/umts-custom-matchers/version.rb

@@ -1,3 +0,0 @@
-module UmtsCustomMatchers
-  VERSION = '0.1.3'.freeze
-end

data/umts-custom-matchers.gemspec

@@ -1,37 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'umts-custom-matchers/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'umts-custom-matchers'
-  spec.version       = UmtsCustomMatchers::VERSION
-  spec.authors       = ['UMass Transit Services']
-  spec.email         = ['transit-it@admin.umass.edu']
-
-  spec.summary       = "Custom RSpec Rails-related matcher, used for UMass
-                          Transit's internal Rails development process."
-  spec.homepage      = 'https://github.com/umts/custom-matchers'
-  spec.license       = 'MIT'
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'rspec-rails', '~>3.0'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
-end