rspec-matchers-controller_filters 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b46a7e5fce634af5c3ed5117755a502fa9a0593
+  data.tar.gz: 6fc3d2728a1b707fd7781496acf9335930b7dda1
+SHA512:
+  metadata.gz: d29ed4e300b76461d678fe85777debc91674f2429e82a40eb0e09732776e4d2db7623638fdfe530356f0b7ea3da1d551b3752d1ee02c28df6104f9b3b3d6a700
+  data.tar.gz: f87f201db6ac2760be2713afdfb2e52bf52eeb273ff14de7c8945b666a7bfdd12e27a0a296353a3cfd195a287ac0473d221b09805941297e40d3c5e10b60b0a1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Lazarus Lazaridis
+
+MIT License
+
+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,47 @@
+# Rspec::Matchers::ControllerFilters
+
+Use this gem to test execution of before/around/after filters of controller actions with RSpec.
+http://www.arubystory.com/2014/10/testing-execution-of-beforefilter-with.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-matchers-controller_filters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-matchers-controller_filters
+
+## Usage
+
+In your controller specs you may use the new matchers:
+
+```ruby
+it { should execute_before_filter :your_filter, :on => :your_action, :with => { :parameter_name => 'parameter_value'} }
+it { should_not execute_around_filter :your_filter, :on => :your_action, :with => { :parameter_name => 'parameter_value'} }
+it { should execute_after_filter :your_filter, :on => :your_action, :with => { :parameter_name => 'parameter_value'} }
+```
+
+The **with** parameter is optional.
+
+## Contributing
+
+1. Fork it ( https://github.com/iridakos/rspec-matchers-controller_filters/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Important note
+This is my first gem so please:
+1. Use it at your own risk
+2. Any feedback is welcome!
+
+##### [**Lazarus Lazaridis**](http://twitter.com/arubystory)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+
+end
+
+task :default => :spec

data/lib/rspec/matchers/controller_filters.rb

@@ -0,0 +1,192 @@
+require 'rspec/matchers/controller_filters/version'
+require 'rspec/matchers'
+
+module RSpec
+  module Matchers
+    module ControllerFilters
+      # Error signaling that a matcher fails.
+      class FilterFailureError < StandardError;
+      end
+
+      # Support for Rails 3, 4
+      ROUTING_ERROR_CLASS = defined?(ActionController::UrlGenerationError) ? ActionController::UrlGenerationError : (defined?(ActionController::RoutingError) ? ActionController::RoutingError : StandardError )
+
+      class << self
+        # Resolves the error message to show for a failing test.
+        #
+        # If neither a routing nor an unexpected error has occurred, the message to be displayed describes the failed expectation.
+        def resolve_failure_message(scope, actual, expectations, routing_error, unexpected_error, negated)
+          return unexpected_failure_message_for scope, actual, expectations, unexpected_error if unexpected_error.present?
+          return routing_failure_message_for scope, actual, expectations, routing_error if routing_error.present?
+          failure_message_for scope, actual, expectations, negated
+        end
+
+        protected
+
+        def failure_message_for(scope, actual, expectations, negated)
+          filter = expectations[0]
+          options = expectations[1]
+          action = options[:on]
+          via = options[:via]
+          params = options[:with]
+
+          "Expected #{actual.class} #{negated ? 'not ' : ''}to execute filter '#{filter}' #{scope.to_s} action '#{action}' (request made via #{via} with params '#{params}') but it did#{negated ? '' : 'n\'t'}."
+        end
+
+        def routing_failure_message_for(scope, actual, expectations, routing_error)
+          filter = expectations[0]
+          options = expectations[1]
+          action = options[:on]
+          via = options[:via]
+          params = options[:with]
+
+          message = "Routing error while trying to check if #{actual.class} executes '#{filter}' #{scope.to_s} action '#{action}' (request made via #{via} with params '#{params}').\n"
+          message << "Check your params (ex you might need to include an id).\n"
+          message << "Routing error description: #{routing_error}"
+        end
+
+        def unexpected_failure_message_for(scope, actual, expectations, unexpected_error)
+          filter = expectations[0]
+          options = expectations[1]
+          action = options[:on]
+          via = options[:via]
+          params = options[:with]
+
+          message = "Unexpected error while trying to check if #{actual.class} executes '#{filter}' #{scope.to_s} action '#{action}' (request made via #{via} with params '#{params}').\n"
+          message << "Error description: #{unexpected_error}"
+        end
+      end
+
+      RSpec::Matchers.define :execute_before_filter do |filter_name, options = {}|
+        match do |controller|
+          execute_match(filter_name, options, false)
+        end
+
+        match_when_negated do |controller|
+          !execute_match(filter_name, options, true)
+        end
+
+        def execute_match(filter_name, options, negated)
+          allow(controller).to receive(filter_name).and_wrap_original { |&block|
+            @filter_executed = block.nil?
+          }
+
+          allow(controller).to receive(options[:on]) {
+            raise RSpec::Matchers::ControllerFilters::FilterFailureError if !@filter_executed || @action_executed
+            @action_executed = true
+            controller.render :text => 'success'
+          }
+
+          begin
+            send(options[:via] || :get, options[:on], options[:with])
+            @filter_executed
+          rescue RSpec::Matchers::ControllerFilters::FilterFailureError
+            false
+          rescue ROUTING_ERROR_CLASS => e
+            @routing_error = e.message
+            negated
+          rescue => e
+            @unexpected_error = e.message
+            negated
+          end
+        end
+
+        failure_message do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :before, actual, expected, @routing_error, @unexpected_error, false
+        end
+
+        failure_message_when_negated do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :before, actual, expected, @routing_error, @unexpected_error, true
+        end
+      end
+
+      RSpec::Matchers.define :execute_after_filter do |filter_name, options = {}|
+        match do |controller|
+          execute_match(filter_name, options, false)
+        end
+
+        match_when_negated do |controller|
+          !execute_match(filter_name, options, true)
+        end
+
+        def execute_match(filter_name, options, negated)
+          allow(controller).to receive(filter_name) {
+            raise RSpec::Matchers::ControllerFilters::FilterFailureError unless @action_executed
+            @filter_executed = true
+          }
+          allow(controller).to receive(options[:on]) {
+            @action_executed = true
+            controller.render(:nothing => true)
+          }
+
+          result = begin
+            send(options[:via] || :get, options[:on], options[:with])
+            @action_executed && @filter_executed
+          rescue RSpec::Matchers::ControllerFilters::FilterFailureError
+            false
+          rescue ROUTING_ERROR_CLASS => e
+            @routing_error = e.message
+            negated
+          rescue => e
+            @unexpected_error = e.message
+            negated
+          end
+
+          result
+        end
+
+        failure_message do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :after, actual, expected, @routing_error, @unexpected_error, false
+        end
+
+        failure_message_when_negated do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :after, actual, expected, @routing_error, @unexpected_error, true
+        end
+      end
+
+      RSpec::Matchers.define :execute_around_filter do |filter_name, options = {}|
+        match do |controller|
+          execute_match(filter_name, options, false)
+        end
+
+        match_when_negated do |controller|
+          !execute_match(filter_name, options, true)
+        end
+
+        def execute_match(filter_name, options, negated)
+          allow(controller).to receive(options[:on]) {
+            if !@filter_executed || @action_executed
+              raise RSpec::Matchers::ControllerFilters::FilterFailureError
+            else
+              @action_executed = true
+            end
+          }
+
+          allow(controller).to receive(filter_name) {
+            @filter_executed = true
+            controller.send(options[:on])
+          }
+
+          send(options[:via] || :get, options[:on], options[:with])
+          @filter_executed && @action_executed
+        rescue ROUTING_ERROR_CLASS
+          @routing_error = true
+          negated
+        rescue RSpec::Matchers::ControllerFilters::FilterFailureError
+          false
+        rescue => e
+          @unexpected_error = e.message
+          negated
+        end
+
+        failure_message do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :around, actual, expected, @routing_error, @unexpected_error, false
+        end
+
+        failure_message_when_negated do |actual|
+          RSpec::Matchers::ControllerFilters.resolve_failure_message :around, actual, expected, @routing_error, @unexpected_error, true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/matchers/controller_filters/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Matchers
+    module ControllerFilters
+      VERSION = '0.0.2'
+    end
+  end
+end

data/rspec-matchers-controller_filters.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/matchers/controller_filters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-matchers-controller_filters'
+  spec.version       = Rspec::Matchers::ControllerFilters::VERSION
+  spec.authors       = ['Lazarus Lazaridis']
+  spec.summary       = 'Test execution of before/around/after filters with RSpec'
+  spec.description   = 'This gem defines custom filters that can be used to test execution of filters before, around or after controller actions.'
+  spec.homepage      = 'https://github.com/iridakos/rspec-matchers-controller_filters'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'rspec-rails', '~> 3', '>= 3.1'
+end

data/spec/rspec/matchers/controller_filters/controller_filters_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+require 'rails/all'
+require 'rspec/rails'
+require 'action_controller/railtie'
+
+module Test
+  class TestApplication < ::Rails::Application;  end
+
+  TestApplication.config.secret_key_base = 'test'
+
+  class TestsController < ActionController::Base
+    include ::Rails.application.routes.url_helpers
+
+    before_filter :a_before_filter, :only => [:before_filter_collection_action,
+                                              :before_and_around_filter_collection_action,
+                                              :before_and_after_filter_collection_action,
+                                              :before_filter_member_action,
+                                              :before_and_around_filter_member_action,
+                                              :before_and_after_filter_member_action]
+
+    around_filter :an_around_filter, :only => [:before_and_around_filter_collection_action,
+                                               :around_filter_collection_action,
+                                               :around_and_after_filter_collection_action,
+                                               :before_and_around_filter_member_action,
+                                               :around_filter_member_action,
+                                               :around_and_after_filter_member_action]
+
+    after_filter :an_after_filter, :only => [:before_and_after_filter_collection_action,
+                                             :around_and_after_filter_collection_action,
+                                             :after_filter_collection_action,
+                                             :before_and_after_filter_member_action,
+                                             :around_and_after_filter_member_action,
+                                             :after_filter_member_action]
+
+    def before_filter_collection_action; end
+    def around_filter_collection_action; end
+    def after_filter_collection_action; end
+    def before_and_around_filter_collection_action; end
+    def before_and_after_filter_collection_action; end
+    def around_and_after_filter_collection_action; end
+    def before_filter_member_action; end
+    def around_filter_member_action; end
+    def after_filter_member_action; end
+    def before_and_around_filter_member_action; end
+    def before_and_after_filter_member_action; end
+    def around_and_after_filter_member_action; end
+
+    protected
+
+    def a_before_filter; end
+    def an_around_filter; yield; end
+    def an_after_filter; end
+  end
+end
+
+RSpec.describe Test::TestsController, :type => :controller do
+  before do
+    routes.draw {
+      namespace :test do
+        resources :tests, :only => [] do
+          collection do
+            get :before_filter_collection_action
+            get :around_filter_collection_action
+            get :after_filter_collection_action
+            get :before_and_around_filter_collection_action
+            get :before_and_after_filter_collection_action
+            get :around_and_after_filter_collection_action
+          end
+
+          member do
+            get :before_filter_member_action
+            get :around_filter_member_action
+            get :after_filter_member_action
+            get :before_and_around_filter_member_action
+            get :before_and_after_filter_member_action
+            get :around_and_after_filter_member_action
+          end
+        end
+      end
+    }
+  end
+
+  describe ':execute_before_filter' do
+    it { should execute_before_filter :a_before_filter, :on => :before_filter_collection_action, :via => :get }
+    it { should execute_before_filter :a_before_filter, :on => :before_and_around_filter_collection_action, :via => :get }
+    it { should execute_before_filter :a_before_filter, :on => :before_and_after_filter_collection_action, :via => :get }
+    it { should execute_before_filter :a_before_filter, :on => :before_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_before_filter :a_before_filter, :on => :before_and_around_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_before_filter :a_before_filter, :on => :before_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+
+    it { should_not execute_before_filter :a_before_filter, :on => :around_filter_collection_action, :via => :get }
+    it { should_not execute_before_filter :a_before_filter, :on => :after_filter_collection_action, :via => :get }
+    it { should_not execute_before_filter :a_before_filter, :on => :around_and_after_filter_collection_action, :via => :get }
+    it { should_not execute_before_filter :a_before_filter, :on => :around_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_before_filter :a_before_filter, :on => :after_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_before_filter :a_before_filter, :on => :around_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+  end
+
+  describe ':execute_around_filter' do
+    it { should execute_around_filter :an_around_filter, :on => :before_and_around_filter_collection_action, :via => :get }
+    it { should execute_around_filter :an_around_filter, :on => :before_and_around_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_around_filter :an_around_filter, :on => :around_filter_collection_action, :via => :get }
+    it { should execute_around_filter :an_around_filter, :on => :around_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_around_filter :an_around_filter, :on => :around_and_after_filter_collection_action, :via => :get }
+    it { should execute_around_filter :an_around_filter, :on => :around_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+
+    it { should_not execute_around_filter :an_around_filter, :on => :before_and_after_filter_collection_action, :via => :get }
+    it { should_not execute_around_filter :an_around_filter, :on => :before_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_around_filter :an_around_filter, :on => :after_filter_collection_action, :via => :get }
+    it { should_not execute_around_filter :an_around_filter, :on => :after_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_around_filter :an_around_filter, :on => :before_filter_collection_action, :via => :get }
+    it { should_not execute_around_filter :an_around_filter, :on => :before_filter_member_action, :via => :get, :with => { :id => 1 } }
+  end
+
+  describe ':execute_after_filter' do
+    it { should execute_after_filter :an_after_filter, :on => :before_and_after_filter_collection_action, :via => :get }
+    it { should execute_after_filter :an_after_filter, :on => :before_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_after_filter :an_after_filter, :on => :after_filter_collection_action, :via => :get }
+    it { should execute_after_filter :an_after_filter, :on => :around_and_after_filter_collection_action, :via => :get }
+    it { should execute_after_filter :an_after_filter, :on => :after_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should execute_after_filter :an_after_filter, :on => :around_and_after_filter_member_action, :via => :get, :with => { :id => 1 } }
+
+    it { should_not execute_after_filter :an_after_filter, :on => :before_filter_collection_action, :via => :get }
+    it { should_not execute_after_filter :an_after_filter, :on => :before_and_around_filter_collection_action, :via => :get }
+    it { should_not execute_after_filter :an_after_filter, :on => :before_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_after_filter :an_after_filter, :on => :before_and_around_filter_member_action, :via => :get, :with => { :id => 1 } }
+    it { should_not execute_after_filter :an_after_filter, :on => :around_filter_collection_action, :via => :get }
+    it { should_not execute_after_filter :an_after_filter, :on => :around_filter_member_action, :via => :get, :with => { :id => 1 } }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'action_view'
+require 'action_controller'
+require 'rails'
+require 'rspec/rails/adapters'
+require 'rspec/rails/view_rendering'
+require 'rspec/rails/example/rails_example_group'
+require 'rspec/rails/example/controller_example_group'
+require 'rspec/matchers/controller_filters'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rspec-matchers-controller_filters
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Lazarus Lazaridis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: This gem defines custom filters that can be used to test execution of
+  filters before, around or after controller actions.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/matchers/controller_filters.rb
+- lib/rspec/matchers/controller_filters/version.rb
+- rspec-matchers-controller_filters.gemspec
+- spec/rspec/matchers/controller_filters/controller_filters_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iridakos/rspec-matchers-controller_filters
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Test execution of before/around/after filters with RSpec
+test_files:
+- spec/rspec/matchers/controller_filters/controller_filters_spec.rb
+- spec/spec_helper.rb