rspec-rails-caching 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create gemset use rspec-rails-caching

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Vit
+
+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,46 @@
+# RSpec Rails Caching
+
+Provides a cache store for recording and matchers for testing cache events in Rails controller tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-rails-caching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-rails-caching
+
+## Usage
+
+Add `caching: true` as an option around a controller example group and use
+a proc or lambda around the action for matching:
+
+    describe WidgetsController, caching: true do
+      it "should cache the show action" do
+        ->{ get :show, id: 123 }.should cache_page('/widgets/123')
+      end
+
+      it "should expire the update action" do
+        ->{ put :update, id: 123 }.should expire_page('/widgets/123')
+      end
+    end
+
+### Available matchers:
+
+* `cache_page` / `expire_page`
+* `cache_fragment` / `expire_fragment`
+* `cache_action` / `expire_action`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rspec-rails-caching.rb

@@ -0,0 +1,32 @@
+require 'rspec-rails-caching/version'
+require 'rspec-rails-caching/matchers'
+require 'rspec-rails-caching/test_store'
+require 'rspec-rails-caching/extensions/action_controller'
+
+module RSpecRailsCaching
+
+  RSpec.configure do |config|
+    if ActionController::Base.perform_caching
+      silence_warnings do
+        Object.const_set :RAILS_CACHE, TestStore.new(true)
+      end
+      ActionController::Base.cache_store = RAILS_CACHE
+      ActionController::Base.class_eval do
+        extend Extensions::ActionController::ClassMethods
+      end
+
+      RSpec::Rails::ControllerExampleGroup.class_eval do
+        include Matchers
+      end
+
+      config.before :each do |example|
+        RAILS_CACHE.reset
+      end
+
+      config.after :each do |example|
+        RAILS_CACHE.reset
+      end
+    end
+  end
+
+end

data/lib/rspec-rails-caching/extensions.rb

@@ -0,0 +1 @@
+require 'rspec-rails-caching/extensions/action_controller/base'

data/lib/rspec-rails-caching/extensions/action_controller.rb

@@ -0,0 +1,20 @@
+module RSpecRailsCaching::Extensions
+  module ActionController
+
+    module ClassMethods
+      def cache_page(content, path, extension = nil, *)
+        instrument_page_cache :write_page, path do
+          cache_store.cached_pages << path
+        end
+      end
+
+      def expire_page(path)
+        instrument_page_cache :expire_page, path do
+          cache_store.cached_pages.delete path
+          cache_store.expired_pages << path
+        end
+      end
+    end
+
+  end
+end

data/lib/rspec-rails-caching/matchers.rb

@@ -0,0 +1,4 @@
+require 'rspec-rails-caching/matchers/cache'
+require 'rspec-rails-caching/matchers/expire'
+require 'rspec-rails-caching/matchers/cache_page'
+require 'rspec-rails-caching/matchers/expire_page'

data/lib/rspec-rails-caching/matchers/base.rb

@@ -0,0 +1,45 @@
+module RSpecRailsCaching
+  module Matchers
+    extend RSpec::Matchers::DSL
+
+    def self.caching_matcher name, &block
+      matcher name do
+        match do |actual|
+          actual = actual.call if actual.respond_to?(:call)
+          Array(expected).all? { |e| cache_results.include?(e) }
+        end
+
+        description do
+          "#{cache_or_expire} #{expected.inspect}"
+        end
+
+        failure_message_for_should_not do |actual|
+          "Expected #{controller.class} not to #{cache_or_expire} #{expected.inspect} but got #{cache_results.inspect}"
+        end
+
+        failure_message_for_should do |actual|
+          "Expected #{controller.class} to #{cache_or_expire} #{expected.inspect} but got #{cache_results.inspect}"
+        end
+
+        def controller
+          matcher_execution_context.controller
+        end
+
+        def cache_store
+          controller.cache_store
+        end
+
+        def cache_results
+          fail NoMethodError, "Abstract method 'cache_results' to be defined in matcher"
+        end
+
+        def cache_or_expire
+          fail NoMethodError, "Abstract method 'cache_or_expire' to be defined in matcher"
+        end
+
+        instance_eval &block
+
+      end
+    end
+  end
+end

data/lib/rspec-rails-caching/matchers/cache.rb

@@ -0,0 +1,13 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :cache do
+    def cache_results
+      cache_store.cached
+    end
+  end
+  alias_method :cache_fragment, :cache
+  alias_method :cache_action,   :cache
+
+end

data/lib/rspec-rails-caching/matchers/cache_page.rb

@@ -0,0 +1,15 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :cache_page do
+    def cache_or_expire
+      "cache page"
+    end
+
+    def cache_results
+      cache_store.cached_pages
+    end
+  end
+
+end

data/lib/rspec-rails-caching/matchers/expire.rb

@@ -0,0 +1,11 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :expire do
+    def cache_results
+      cache_store.expired
+    end
+  end
+
+end

data/lib/rspec-rails-caching/matchers/expire_page.rb

@@ -0,0 +1,15 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :expire_page do
+    def cache_or_expire
+      "expire page"
+    end
+
+    def cache_results
+      cache_store.expired_pages
+    end
+  end
+
+end

data/lib/rspec-rails-caching/test_store.rb

@@ -0,0 +1,70 @@
+module RSpecRailsCaching
+  class TestStore < ActiveSupport::Cache::Store
+
+    attr_reader   :cached
+    attr_reader   :expired
+    attr_reader   :expiration_patterns
+    attr_reader   :data
+    attr_accessor :read_cache
+    attr_reader   :cached_pages
+    attr_reader   :expired_pages
+
+    attr_accessor :context
+
+    def initialize(do_read_cache = false)
+      @data = {}
+      @cached = []
+      @expired = []
+      @expiration_patterns = []
+      @read_cache = do_read_cache
+      @cached_pages = []
+      @expired_pages = []
+    end
+
+    def reset
+      @data.clear
+      @cached.clear
+      @expired.clear
+      @expiration_patterns.clear
+    end
+
+    def read_entry(name, options = nil)
+      read_cache ? @data[name] : nil
+    end
+
+    def write_entry(name, value, options = nil)
+      @data[name] = value if read_cache
+      @cached << name
+    end
+
+    def delete_entry(name, options = nil)
+      @expired << name
+    end
+
+    def delete_matched(matcher, options = nil)
+      @expiration_patterns << matcher
+    end
+
+    def cached?(name)
+      @cached.include?(name)
+    end
+
+    def expired?(name)
+      @expired.include?(name) || @expiration_patterns.detect { |matcher| name =~ matcher }
+    end
+
+    def page_cached?(options = {})
+      @cached_pages.include?(test_cache_url(options))
+    end
+
+    def page_expired?(options = {})
+      @expired_pages.include?(test_cache_url(options))
+    end
+
+    private
+    def test_cache_url(options)
+      return options if options.is_a?(String)
+      url_for(options.merge(:only_path => true, :skip_relative_url_root => true))
+    end
+  end
+end

data/lib/rspec-rails-caching/version.rb

@@ -0,0 +1,3 @@
+module RSpecRailsCaching
+  VERSION = "0.2.0"
+end

data/rspec-rails-caching.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec-rails-caching/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "rspec-rails-caching"
+  gem.version     = RSpecRailsCaching::VERSION
+  gem.authors     = ["Andrew Vit"]
+  gem.email       = ["andrew@avit.ca"]
+  gem.homepage    = "https://github.com/avit/rspec-rails-caching"
+  gem.summary     = %q{RSpec Rails Caching}
+  gem.description = %q{RSpec helper for testing page and action caching in Rails}
+
+  gem.add_dependency "rails", ">=3.0.0"
+  gem.add_dependency "rspec", ">=2.8.0"
+  gem.add_dependency "rspec-rails", ">=2.10.0"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rails-caching
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Vit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: RSpec helper for testing page and action caching in Rails
+email:
+- andrew@avit.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec-rails-caching.rb
+- lib/rspec-rails-caching/extensions.rb
+- lib/rspec-rails-caching/extensions/action_controller.rb
+- lib/rspec-rails-caching/matchers.rb
+- lib/rspec-rails-caching/matchers/base.rb
+- lib/rspec-rails-caching/matchers/cache.rb
+- lib/rspec-rails-caching/matchers/cache_page.rb
+- lib/rspec-rails-caching/matchers/expire.rb
+- lib/rspec-rails-caching/matchers/expire_page.rb
+- lib/rspec-rails-caching/test_store.rb
+- lib/rspec-rails-caching/version.rb
+- rspec-rails-caching.gemspec
+homepage: https://github.com/avit/rspec-rails-caching
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -591280762391301957
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -591280762391301957
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: RSpec Rails Caching
+test_files: []