high_voltage 1.2.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 200549e039d8c31dc74ed8c376f5dd684314aa56
+  data.tar.gz: 9bbe74af83cbb6ef5478451581df294b8830b82a
+SHA512:
+  metadata.gz: 13a625a99201f9969aa48524fd001bd2eadbee5c42a0fc7fd0e956dbcaf875dd46dbafbcf407709e6042f1aa7576b9469f5f813bc95fe9cef1a96b6efb8c93f1
+  data.tar.gz: ce011d7615d5f6e85450f1458aa901c49d69f0ad543ef6f73b26e543bebafc6ebd6d0532584f115f3d18a015e8023e3277067ea796f2ac0d8543e2bc5015fa19

data/.gitignore

@@ -5,5 +5,5 @@ spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/
 *.swp
-gemfiles/*.lock
-*.gem
+gemfiles/
+*.gem

data/.travis.yml

@@ -1,9 +1,8 @@
-language: ruby
+language:
+  - ruby
+install:
+  - 'bundle install'
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-gemfile:
-  - gemfiles/rails_3.0.18.gemfile
-  - gemfiles/rails_3.1.9.gemfile
-  - gemfiles/rails_3.2.10.gemfile
+  - 2.0.0

data/Appraisals

@@ -1,5 +1,16 @@
-['3.2.10', '3.1.9', '3.0.18'].each do |rails_version|
-  appraise "rails_#{rails_version}" do
-    gem "rails", rails_version
+if RUBY_VERSION >= '2.0'
+  rails_versions = ['~> 3.2.13', '~> 4.0.0']
+else
+  rails_versions = ['~> 3.1.12', '~> 3.2.13']
+end
+
+rails_versions.each do |rails_version|
+  appraise "rails#{rails_version.slice(/\d+\.\d+/)}" do
+    gem 'rails', rails_version
+
+    if rails_version == '~> 4.0.0'
+      gem 'actionpack-action_caching'
+      gem 'actionpack-page_caching'
+    end
   end
 end

data/Gemfile.lock

@@ -1,94 +1,80 @@
 PATH
   remote: .
   specs:
-    high_voltage (1.2.2)
+    high_voltage (2.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionpack (3.0.10)
-      activemodel (= 3.0.10)
-      activesupport (= 3.0.10)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.10)
-      activesupport (= 3.0.10)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.10)
-    appraisal (0.4.1)
+    activesupport (3.1.12)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
       bundler
       rake
-    builder (2.1.2)
-    capybara (1.1.0)
+    capybara (2.0.3)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.2.2)
-      ffi (~> 1.0.6)
+      xpath (~> 1.0.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.1.3)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    ffi (1.0.9)
-    i18n (0.5.0)
-    json_pure (1.5.4)
-      spruz (~> 0.2.8)
-    mime-types (1.16)
-    nokogiri (1.5.0)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    ffi (1.9.0)
+    method_source (0.8.1)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rack-test (0.6.2)
       rack (>= 1.0)
-    railties (3.0.10)
-      actionpack (= 3.0.10)
-      activesupport (= 3.0.10)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.4)
-    rake (0.9.2.2)
-    rdoc (3.9.4)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rake (10.1.0)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    rspec-rails (2.6.1)
-      actionpack (~> 3.0)
-      activesupport (~> 3.0)
-      railties (~> 3.0)
-      rspec (~> 2.6.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (2.5.0)
-      childprocess (>= 0.2.1)
-      ffi (>= 1.0.7)
-      json_pure
+    rspec-mocks (2.1.0)
+    rspec-rails (2.1.0)
+      rspec (~> 2.1.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.33.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
       rubyzip
-    spruz (0.2.13)
-    sqlite3 (1.3.4)
-    thor (0.14.6)
-    tzinfo (0.3.29)
-    xpath (0.1.4)
+      websocket (~> 1.0.4)
+    slop (3.4.5)
+    websocket (1.0.7)
+    xpath (1.0.0)
       nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (>= 3.1.0)
   appraisal
-  capybara (>= 0.4.0)
+  capybara (= 2.0.3)
   high_voltage!
+  pry-debugger
   rspec-rails
-  sqlite3

data/NEWS.md

@@ -1,6 +1,22 @@
+New for 2.0.0:
++ Extract PagesController into a module
++ Update README with module usage instructions
+
+New for 1.2.4:
++ Add page and action caching
++ Remove redundant link style `page_path(id: 'about')` from README
++ Clean up Appraisals for Travis-CI
++ Remove Ruby 1.8.7 from test suite
+
+New for 1.2.3:
++ Updates for Rails 4 compatibility.
++ Fix for Rails 4 circular dependency error.
++ Add ability to load High Voltage outside of rails. Require `attribute_accessors`
+
 New for 1.2.2:
 + Bug fix for RootRoute constraint. Support haml, slim, etc.
 + README updated for root routes.
+
 New for 1.2.1:
 + Ability to disable HighVoltage routes.
 + New RootRoute constraint.

data/README.md

@@ -4,26 +4,25 @@ Rails engine for static pages.
 
 ... but be careful. [Danger!](http://www.youtube.com/watch?v=HD5tnb2RBYg)
 
-Static pages?
--------------
+## Static pages?
 
 Yeah, like "About us", "Directions", marketing pages, etc.
 
-Installation
-------------
+## Installation
 
     $ gem install high_voltage
 
 Include in your Gemfile:
 
-    gem "high_voltage"
+```ruby
+gem 'high_voltage'
+```
 
 For Rails versions prior to 3.0, use the 0.9.2 tag of high_voltage:
 
     https://github.com/thoughtbot/high_voltage/tree/v0.9.2
 
-Usage
------
+## Usage
 
 Write your static pages and put them in the RAILS_ROOT/app/views/pages directory.
 
@@ -32,28 +31,29 @@ Write your static pages and put them in the RAILS_ROOT/app/views/pages directory
 
 After putting something interesting there, you can link to it from anywhere in your app with:
 
-    link_to "About", page_path("about")
-
-This will also work, if you like the more explicit style:
-
-    link_to "About", page_path(:id => "about")
+```ruby
+link_to 'About', page_path('about')
+```
 
 You can nest pages in a directory structure, if that makes sense from a URL perspective for you:
 
-    link_to "Q4 Reports", page_path("about/corporate/policies/HR/en_US/biz/sales/Quarter-Four")
+```ruby
+link_to 'Q4 Reports', page_path('about/corporate/policies/HR/en_US/biz/sales/Quarter-Four')
+```
 
 Bam.
 
-Routes
-------
+## Routes
 
 By default, the static page routes will be like /pages/:id (where :id is the view filename).
 
 If you want to route to a static page in another location (for example, a homepage), do this:
 
-    match 'pages/home' => 'high_voltage/pages#show', :id => 'home'
+```ruby
+get 'pages/home' => 'high_voltage/pages#show', id: 'home'
+```
 
-In that case, you'd need an app/views/pages/home.html.erb file.
+In that case, you'd need an `app/views/pages/home.html.erb` file.
 
 Generally speaking, you need to route to the 'show' action with an :id param of the view filename.
 
@@ -62,22 +62,36 @@ want to generate a named route (with the :as routing option) for some route whic
 by High Voltage, make sure not to use :page as the name, because that will conflict with the named
 route generated by High Voltage itself.
 
-For example, this will work for top-level routes (we will
-get a named route called `static_path` which does not conflict with the generated `page_path` method):
-
-    match '/:id' => 'high_voltage/pages#show', :as => :static, :via => :get
-
 #### Specifying a root path
 
-You can route the root url to a high voltage page like this:
+You can route the root route to a High Voltage page like this:
 
-    root :to => 'high_voltage/pages#show', :id => 'home'
+```ruby
+root :to => 'high_voltage/pages#show', id: 'home'
+```
 
 Which will render a homepage from app/views/pages/home.html.erb
 
-#### Enabling root domain routes
+#### Page titles and meta-data
+
+We suggest using `content_for` and `yield` for setting custom page titles and
+meta-data on High Voltage pages.
+
+```ruby
+# app/views/pages/about.html.erb
+<%= content_for :page_title, 'About Us - Custom page title' %>
+```
+
+Then print the contents of `:title` into the layout:
 
-You can remove the directory `pages` from the URL path and serve up routes from 
+```ruby
+# app/views/layouts/application.html.erb
+<title><%= yield(:page_title) %></title>
+```
+
+#### Top-level routes
+
+You can remove the directory `pages` from the URL path and serve up routes from
 the root of the domain path:
 
     http://www.example.com/about
@@ -90,31 +104,57 @@ Would look for corresponding files:
 
 This is accomplished by changing the `HighVoltage.route_drawer` to `HighVoltage::RouteDrawers::Root`
 
-    # config/initializers/high_voltage.rb
-    HighVoltage.route_drawer = HighVoltage::RouteDrawers::Root
-
-Note: This is not a catchall route. It will check the `HighVoltage.content_path` 
-(by default this is `app/views/pages`) and validate the view exists.
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.route_drawer = HighVoltage::RouteDrawers::Root
+```
 
 #### Disabling routes
 
-The default routes can be completely removed by changing the
-`HighVoltage.routes` to `false`
+The default routes can be completely removed by changing the `HighVoltage.routes`
+to `false`:
 
-    # config/initializers/high_voltage.rb
-    HighVoltage.routes = false
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.routes = false
+```
 
-Customize
---------
+#### Content path
 
-High Voltage uses a default path and folder of 'pages', i.e. 'url.com/pages/contact' , 'app/views/pages'
+High Voltage uses a default path and folder of 'pages', i.e. 'url.com/pages/contact',
+'app/views/pages'.
 
 You can change this in an initializer:
 
-    HighVoltage.content_path = "site/"
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.content_path = 'site/'
+```
+
+#### Caching
+
+High Voltage supports both [page](http://guides.rubyonrails.org/caching_with_rails.html#page-caching) and [action caching](http://guides.rubyonrails.org/caching_with_rails.html#action-caching).
+
+To enable them you can add the following to your initializer:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.action_caching = true
+# OR
+HighVoltage.page_caching = true
+```
 
-Override
---------
+High Voltage will use your default cache store to store action caches.
+
+Using caching with Ruby on Rails 4 or higher requires gems:
+
+```ruby
+# Gemfile
+gem 'actionpack-action_caching'
+gem 'actionpack-page_caching'
+```
+
+## Override
 
 Most common reasons to override?
 
@@ -122,97 +162,118 @@ Most common reasons to override?
   * You need to render different layouts for different pages.
   * You need to render a partial from the `app/views/pages` directory.
 
-Create a PagesController of your own:
+Create a `PagesController` of your own:
 
     $ rails generate controller pages
 
-Override the default route:
+Disable the default routes:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.routes = false
+```
+
+Define a route for the new `PagesController`:
+
+```ruby
+# config/routes.rb
+get "/pages/*id" => 'pages#show', :as => :page, :format => false
+
+# if routing the root path, update for your controller
+root :to => 'pages#show', :id => 'home'
+```
 
-    # in config/routes.rb
-    match "/pages/*id" => 'pages#show', :as => :page, :format => false
+Then modify new `PagesController` to include the High Voltage static page concern:
 
-    # if routing the root path, update for your controller
-    root :to => 'pages#show', :id => 'home'
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
 
-Then modify it to subclass from High Voltage, adding whatever you need:
+  before_filter :authenticate
+  layout :layout_for_page
 
-    class PagesController < HighVoltage::PagesController
-      before_filter :authenticate
-      layout :layout_for_page
+  private
 
-      protected
-        def layout_for_page
-          case params[:id]
-          when 'home'
-            'home'
-          else
-            'application'
-          end
-        end
+  def layout_for_page
+    case params[:id]
+    when 'home'
+      'home'
+    else
+      'application'
     end
+  end
+end
+```
 
-Custom finding
---------------
+## Custom finding
 
 You can further control the algorithm used to find pages by overriding
 the `page_finder_factory` method:
 
-    class PagesController < HighVoltage::PagesController
-      private
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
 
-      def page_finder_factory
-        Rot13PageFinder
-      end
-    end
+  private
+
+  def page_finder_factory
+    Rot13PageFinder
+  end
+end
+```
 
 The easiest thing is to subclass `HighVoltage::PageFinder`, which
 provides you with `page_id`:
 
-    class Rot13PageFinder < HighVoltage::PageFinder
-      def find
-        paths = super.split('/')
-        directory = paths[0..-2]
-        filename = paths[-1].tr('a-z','n-za-m')
+```ruby
+class Rot13PageFinder < HighVoltage::PageFinder
+  def find
+    paths = super.split('/')
+    directory = paths[0..-2]
+    filename = paths[-1].tr('a-z','n-za-m')
 
-        File.join(*directory, filename)
-      end
-    end
+    File.join(*directory, filename)
+  end
+end
+```
 
 Use this to create a custom file mapping, clean filenames for your file
 system, A/B test, and so on.
 
-Testing
--------
+## Testing
 
-You can test your static pages using [RSpec](https://github.com/rspec/rspec-rails) 
+You can test your static pages using [RSpec](https://github.com/rspec/rspec-rails)
 and [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers):
 
-    # spec/controllers/pages_controller_spec.rb
-    describe PagesController, '#show' do
-      %w(earn_money screencast about contact).each do |page|
-        context 'on GET to /pages/#{page}' do
-          before do
-            get :show, :id => page
-          end
-
-          it { should respond_with(:success) }
-          it { should render_template(page) }
-        end
+```ruby
+# spec/controllers/pages_controller_spec.rb
+describe PagesController, '#show' do
+  %w(earn_money screencast about contact).each do |page|
+    context 'on GET to /pages/#{page}' do
+      before do
+        get :show, :id => page
       end
+
+      it { should respond_with(:success) }
+      it { should render_template(page) }
     end
+  end
+end
+```
 
 If you're not using a custom PagesController be sure to test
 `HighVoltage::PagesController` instead.
 
 Enjoy!
 
-Contributing
-------------
+## Contributing
 
-Please see CONTRIBUTING.md for details.
+Please see [CONTRIBUTING.md](https://github.com/thoughtbot/high_voltage/blob/master/CONTRIBUTING.md)
+for details.
 
-Credits
--------
+## Credits
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
@@ -222,8 +283,7 @@ Thank you to all [the contributors](https://github.com/thoughtbot/high_voltage/c
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-License
--------
+## License
 
 High Voltage is Copyright © 2009-2013 thoughtbot. It is free software, and may
 be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -1,18 +1,19 @@
+# encoding: utf-8
+
+require 'rubygems'
 require 'bundler/setup'
 require 'bundler/gem_tasks'
-require 'appraisal'
 
+require 'rake'
 require 'rspec/core/rake_task'
+require 'appraisal'
+
 RSpec::Core::RakeTask.new(:spec)
 
-task :default do |t|
-  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
-    exec 'rake spec'
-  else
-    Rake::Task['appraise'].execute
-  end
-end
+desc 'Default'
+task :default => [:all]
 
-task :appraise => ['appraisal:install'] do |t|
-  exec 'rake appraisal'
+desc 'Test the engine under all supported Rails versions'
+task all: ['appraisal:install'] do |t|
+  exec 'rake appraisal spec'
 end

data/app/controllers/concerns/high_voltage/static_page.rb

@@ -0,0 +1,41 @@
+module HighVoltage::StaticPage
+  extend ActiveSupport::Concern
+
+  included do
+    layout ->(_) { HighVoltage.layout }
+
+    rescue_from ActionView::MissingTemplate do |exception|
+      if exception.message =~ %r{Missing template #{page_finder.content_path}}
+        raise ActionController::RoutingError, "No such page: #{params[:id]}"
+      else
+        raise exception
+      end
+    end
+
+    if respond_to?(:caches_action)
+      caches_action :show, if: -> { HighVoltage.action_caching }
+    end
+
+    if respond_to?(:caches_page)
+      caches_page :show, if: -> { HighVoltage.page_caching }
+    end
+
+    hide_action :current_page, :page_finder, :page_finder_factory
+  end
+
+  def show
+    render template: current_page
+  end
+
+  def current_page
+    page_finder.find
+  end
+
+  def page_finder
+    page_finder_factory.new(params[:id])
+  end
+
+  def page_finder_factory
+    HighVoltage::PageFinder
+  end
+end

data/app/controllers/high_voltage/pages_controller.rb

@@ -1,30 +1,3 @@
 class HighVoltage::PagesController < ApplicationController
-  unloadable
-  layout Proc.new { |_| HighVoltage.layout }
-
-  rescue_from ActionView::MissingTemplate do |exception|
-    if exception.message =~ %r{Missing template #{page_finder.content_path}}
-      raise ActionController::RoutingError, "No such page: #{params[:id]}"
-    else
-      raise exception
-    end
-  end
-
-  def show
-    render :template => current_page
-  end
-
-  private
-
-  def current_page
-    page_finder.find
-  end
-
-  def page_finder
-    page_finder_factory.new(params[:id])
-  end
-
-  def page_finder_factory
-    HighVoltage::PageFinder
-  end
+  include HighVoltage::StaticPage
 end

data/high_voltage.gemspec

@@ -8,15 +8,17 @@ Gem::Specification.new do |s|
   s.email       = ['support@thoughtbot.com']
   s.homepage    = 'http://github.com/thoughtbot/high_voltage'
   s.summary     = 'Simple static page rendering controller'
-  s.description = 'Fire in the disco.  Fire in the ... taco bell.'
+  s.description = 'Fire in the disco. Fire in the ... taco bell.'
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency("activesupport", ">= 3.1.0")
   s.add_development_dependency("appraisal")
+  s.add_development_dependency("capybara", "= 2.0.3")
+  s.add_development_dependency("pry-debugger")
   s.add_development_dependency("rspec-rails")
-  s.add_development_dependency("capybara", ">= 0.4.0")
-  s.add_development_dependency("sqlite3")
 end

data/lib/high_voltage/engine.rb

@@ -1,4 +1,13 @@
 module HighVoltage
   class Engine < Rails::Engine
+    initializer 'Require concerns path' do |app|
+      concerns_path = 'app/controllers/concerns'
+
+      unless app.paths.keys.include?(concerns_path)
+        app.paths.add(concerns_path)
+      end
+
+      require 'concerns/high_voltage/static_page'
+    end
   end
 end

data/lib/high_voltage/version.rb

@@ -1,3 +1,3 @@
 module HighVoltage
-  VERSION = '1.2.2'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/high_voltage.rb

@@ -3,6 +3,7 @@ require 'high_voltage/constraints/root_route'
 require 'high_voltage/page_finder'
 require 'high_voltage/route_drawers/default'
 require 'high_voltage/route_drawers/root'
+require 'active_support/core_ext/module/attribute_accessors'
 
 module HighVoltage
   mattr_accessor :layout
@@ -17,6 +18,12 @@ module HighVoltage
   mattr_accessor :routes
   @@routes = true
 
+  mattr_accessor :action_caching
+  @@action_caching = false
+
+  mattr_accessor :page_caching
+  @@page_caching = false
+  
   def self.setup
     yield self
   end

data/spec/constraints/root_route_spec.rb

@@ -3,19 +3,23 @@ require 'spec_helper'
 describe HighVoltage::Constraints::RootRoute, '.matches?' do
   context 'view file exists' do
     it 'should return true' do
-      request = stub(:path => 'index')
-      Dir.stub!(:glob).and_return(['about.html.erb'])
+      request = double(path: 'index')
+      Dir.stub(:glob).and_return(['about.html.erb'])
 
-      HighVoltage::Constraints::RootRoute.matches?(request).should be_true
+      result = HighVoltage::Constraints::RootRoute.matches?(request)
+
+      expect(result).to be_true
     end
   end
 
   context 'view file does not exist' do
     it 'should return false' do
-      request = stub(:path => 'index')
-      File.stub!(:glob).and_return([])
+      request = double(path: 'index')
+      File.stub(:glob).and_return([])
+
+      result = HighVoltage::Constraints::RootRoute.matches?(request)
 
-      HighVoltage::Constraints::RootRoute.matches?(request).should be_false
+      expect(result).to be_false
     end
   end
 end

data/spec/controllers/action_caching_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, 'action_caching' do
+  it 'caches the action when action_caching is set to true', enable_caching: true do
+    expect do
+      HighVoltage.action_caching = true
+      concern_reload
+      get :show, id: :exists
+    end.to change { action_was_cached(:exists) }
+  end
+
+  it 'does not cache the action when action_caching is set to false', enable_caching: true do
+    expect do
+      HighVoltage.action_caching = false
+      concern_reload
+      get :show, id: :exists
+    end.to_not change { action_was_cached(:exists) }
+  end
+
+  def action_was_cached(page)
+    ActionController::Base.cache_store.exist?("views/test.host#{page_path(page)}")
+  end
+end

data/spec/controllers/page_caching_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, 'action_caching' do
+  it 'caches the page when page_caching is set to true', enable_caching: true do
+    controller.should_receive(:cache_page).at_least(:once)
+
+    HighVoltage.page_caching = true
+    concern_reload
+    get :show, id: :exists
+  end
+
+  it 'does not cache the page when page_caching is set to false', enable_caching: true do
+    controller.should_receive(:cache_page).never
+
+    HighVoltage.page_caching = false
+    concern_reload
+    get :show, id: :exists
+  end
+end
+

data/spec/controllers/pages_controller_spec.rb

@@ -98,21 +98,21 @@ describe HighVoltage::PagesController do
     end
 
     it 'should raise a routing error for an invalid page' do
-      lambda { 
-        get :show, 
-        :id => 'also_invalid' 
+      lambda {
+        get :show,
+        :id => 'also_invalid'
       }.should raise_error(ActionController::RoutingError)
     end
 
     it 'should raise a routing error for a page in another directory' do
       lambda {
         get :show,
-        :id => '../other/wrong' 
+        :id => '../other/wrong'
       }.should raise_error(ActionController::RoutingError)
     end
 
     it 'should raise a routing error for a page in another directory when using a Unicode exploit' do
-      lambda { 
+      lambda {
         get :show,
         :id => '/\\../other/wrong'
       }.should raise_error(ActionController::RoutingError)

data/spec/dummy/config/environments/test.rb

@@ -7,8 +7,7 @@ Dummy::Application.configure do
   # and recreated between test runs.  Don't rely on the data there!
   config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  config.eager_load = false
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true

data/spec/dummy/config/initializers/secret_key_base.rb

@@ -0,0 +1 @@
+Dummy::Application.config.secret_key_base = '9c0b876ab8f513cc23d354b6d684c88eb9bc5f73ddc8d5843e7c6ac9176c5819adc2620e220980a3cb818de687753f1bfc56c66c4454b74fc7d432813f8e555a'

data/spec/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Dummy::Application.routes.draw do
-  match "/subclassed_pages/*id" => 'subclassed_pages#show', :format => false
-  match "/alternative_finder/*id" => 'alternative_finder#show', :format => false
+  get "/subclassed_pages/*id" => 'subclassed_pages#show', :format => false
+  get "/alternative_finder/*id" => 'alternative_finder#show', :format => false
 end

data/spec/high_voltage_spec.rb

@@ -1,7 +1,11 @@
-require 'spec_helper'
+require 'minimal_spec_helper'
 
 describe HighVoltage do
   it 'should be valid' do
     HighVoltage.should be_a(Module)
   end
+
+  it 'should be loadable without preloading rails' do
+    expect { require 'high_voltage' }.not_to raise_error
+  end
 end

data/spec/minimal_spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+end

data/spec/routing/routes_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'routes' do
   context 'using default configuration' do
     it 'should generate normal resource route with id' do
-      page_path(:id => 'one').should eq '/pages/one'
+      page_path('one').should eq '/pages/one'
     end
 
     it 'should generate normal resource route with string' do
@@ -48,7 +48,7 @@ describe 'routes' do
     end
   end
 
-  context 'using root routing configuration' do
+  context 'using top-level routing configuration' do
     around do |example|
       cached_high_voltage_route_drawer = HighVoltage.route_drawer
       HighVoltage.route_drawer = HighVoltage::RouteDrawers::Root
@@ -60,10 +60,6 @@ describe 'routes' do
       Rails.application.reload_routes!
     end
 
-    it 'should generate normal resource route with id' do
-      page_path(:id => 'one').should eq '/one'
-    end
-
     it 'should generate normal resource route with string' do
       page_path('one').should eq '/one'
     end
@@ -85,10 +81,6 @@ describe 'routes' do
       Rails.application.reload_routes!
     end
 
-    it 'should generate normal resource route with id' do
-      page_path(:id => 'one').should eq '/other_pages/one'
-    end
-
     it 'should generate normal resource route with string' do
       page_path('one').should eq '/other_pages/one'
     end

data/spec/spec_helper.rb

@@ -1,15 +1,16 @@
 ENV['RAILS_ENV'] = 'test'
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'pry'
 require 'rails/test_help'
 require 'rspec/rails'
 require 'capybara/rails'
 
 Rails.backtrace_cleaner.remove_silencers!
-Capybara.default_driver   = :rack_test
+Capybara.default_driver = :rack_test
 Capybara.default_selector = :css
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f}
 
 RSpec.configure do |config|
   require 'rspec/expectations'

data/spec/support/caching.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.around(:each, enable_caching: true) do |example|
+    ActionController::Base.perform_caching = true
+    old_cache_store = ActionController::Base.cache_store
+    ActionController::Base.cache_store = :memory_store
+
+    example.run
+
+    ActionController::Base.cache_store = old_cache_store
+    ActionController::Base.perform_caching = false
+  end
+end

data/spec/support/concern_reload.rb

@@ -0,0 +1,11 @@
+def concern_reload
+  HighVoltage::PagesController.class_eval do
+    if respond_to?(:caches_action)
+      caches_action :show, if: -> { HighVoltage.action_caching }
+    end
+
+    if respond_to?(:caches_page)
+      caches_page :show, if: -> { HighVoltage.page_caching }
+    end
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: high_voltage
 version: !ruby/object:Gem::Version
-  version: 1.2.2
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Jankowski
@@ -17,73 +16,79 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry-debugger
+  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-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Fire in the disco.  Fire in the ... taco bell.
+description: Fire in the disco. Fire in the ... taco bell.
 email:
 - support@thoughtbot.com
 executables: []
@@ -100,11 +105,9 @@ files:
 - NEWS.md
 - README.md
 - Rakefile
+- app/controllers/concerns/high_voltage/static_page.rb
 - app/controllers/high_voltage/pages_controller.rb
 - config/routes.rb
-- gemfiles/rails_3.0.18.gemfile
-- gemfiles/rails_3.1.9.gemfile
-- gemfiles/rails_3.2.10.gemfile
 - high_voltage.gemspec
 - lib/high_voltage.rb
 - lib/high_voltage/constraints/root_route.rb
@@ -114,7 +117,9 @@ files:
 - lib/high_voltage/route_drawers/root.rb
 - lib/high_voltage/version.rb
 - spec/constraints/root_route_spec.rb
+- spec/controllers/action_caching_controller_spec.rb
 - spec/controllers/alternative_finder_controller_spec.rb
+- spec/controllers/page_caching_controller_spec.rb
 - spec/controllers/pages_controller_spec.rb
 - spec/controllers/subclassed_pages_controller_spec.rb
 - spec/dummy/Rakefile
@@ -145,6 +150,7 @@ files:
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_key_base.rb
 - spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
@@ -164,35 +170,40 @@ files:
 - spec/high_voltage/page_finder_spec.rb
 - spec/high_voltage_spec.rb
 - spec/integration/navigation_spec.rb
+- spec/minimal_spec_helper.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
+- spec/support/caching.rb
+- spec/support/concern_reload.rb
 homepage: http://github.com/thoughtbot/high_voltage
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple static page rendering controller
 test_files:
 - spec/constraints/root_route_spec.rb
+- spec/controllers/action_caching_controller_spec.rb
 - spec/controllers/alternative_finder_controller_spec.rb
+- spec/controllers/page_caching_controller_spec.rb
 - spec/controllers/pages_controller_spec.rb
 - spec/controllers/subclassed_pages_controller_spec.rb
 - spec/dummy/Rakefile
@@ -223,6 +234,7 @@ test_files:
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_key_base.rb
 - spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
@@ -242,6 +254,8 @@ test_files:
 - spec/high_voltage/page_finder_spec.rb
 - spec/high_voltage_spec.rb
 - spec/integration/navigation_spec.rb
+- spec/minimal_spec_helper.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/support/caching.rb
+- spec/support/concern_reload.rb

data/gemfiles/rails_3.0.18.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "3.0.18"
-
-gemspec :path=>"../"

data/gemfiles/rails_3.1.9.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "3.1.9"
-
-gemspec :path=>"../"

data/gemfiles/rails_3.2.10.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "3.2.10"
-
-gemspec :path=>"../"