high_voltage 1.2.2 → 2.1.0

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

@@ -0,0 +1,42 @@
+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, layout: HighVoltage.action_caching_layout,
+        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/config/routes.rb

@@ -1,4 +1,9 @@
 Rails.application.routes.draw do
+  if HighVoltage.home_page
+    get "/#{HighVoltage.home_page}", to: redirect('/')
+    root to: 'high_voltage/pages#show', id: HighVoltage.home_page
+  end
+
   if HighVoltage.routes
     get HighVoltage.route_drawer.match_attributes
   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")
   s.add_development_dependency("rspec-rails")
-  s.add_development_dependency("capybara", ">= 0.4.0")
-  s.add_development_dependency("sqlite3")
 end

data/lib/high_voltage/configuration.rb

@@ -0,0 +1,33 @@
+module HighVoltage
+  module Configuration
+    attr_accessor(
+      :action_caching,
+      :action_caching_layout,
+      :content_path,
+      :home_page,
+      :layout,
+      :page_caching,
+      :route_drawer,
+      :routes,
+    )
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_default_configuration
+    end
+
+    def set_default_configuration
+      self.action_caching = false
+      self.action_caching_layout = true
+      self.content_path = 'pages/'
+      self.home_page = nil
+      self.layout = 'application'
+      self.page_caching = false
+      self.route_drawer = HighVoltage::RouteDrawers::Default
+      self.routes = true
+    end
+  end
+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.1.0'.freeze
 end

data/lib/high_voltage.rb

@@ -1,25 +1,13 @@
-require 'high_voltage/version'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'high_voltage/configuration'
 require 'high_voltage/constraints/root_route'
 require 'high_voltage/page_finder'
 require 'high_voltage/route_drawers/default'
 require 'high_voltage/route_drawers/root'
+require 'high_voltage/version'
 
 module HighVoltage
-  mattr_accessor :layout
-  @@layout = 'application'
-
-  mattr_accessor :content_path
-  @@content_path = 'pages/'
-
-  mattr_accessor :route_drawer
-  @@route_drawer = HighVoltage::RouteDrawers::Default
-
-  mattr_accessor :routes
-  @@routes = true
-
-  def self.setup
-    yield self
-  end
-
+  extend Configuration
   require 'high_voltage/engine' if defined?(Rails)
 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,27 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, '#action_caching' do
+  let(:page_name) { :exists }
+
+  context 'action_caching set to true' do
+    it 'caches the action', enable_caching: true do
+      HighVoltage.action_caching = true
+      concern_reload
+
+      expect { get :show, id: page_name }.to change { action_cache_exists? }
+    end
+  end
+
+  context 'action_caching set to false' do
+    it 'does not cache the action', enable_caching: true do
+      HighVoltage.action_caching = false
+      concern_reload
+
+      expect { get :show, id: page_name }.to_not change { action_cache_exists? }
+    end
+  end
+
+  def action_cache_exists?
+    ActionController::Base.cache_store.exist?("views/test.host#{page_path(page_name)}")
+  end
+end

data/spec/controllers/page_caching_controller_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, '#cache_page' do
+  let(:page_name) { :exists }
+
+  context 'page_caching set to true' do
+    it 'caches the page', enable_caching: true do
+      HighVoltage.page_caching = true
+      concern_reload
+
+      controller.should_receive(:cache_page).at_least(:once)
+
+      get :show, id: page_name
+    end
+  end
+
+  context 'page_caching set to false' do
+    it 'does not cache the page', enable_caching: true do
+      HighVoltage.page_caching = false
+      concern_reload
+
+      controller.should_receive(:cache_page).never
+
+      get :show, id: page_name
+    end
+  end
+end
+

data/spec/controllers/pages_controller_spec.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'spec_helper'
 
 describe HighVoltage::PagesController do
@@ -50,15 +49,10 @@ describe HighVoltage::PagesController do
   end
 
   context 'using custom layout' do
-    before(:all) do
-      @original_layout = HighVoltage.layout
+    before(:each) do
       HighVoltage.layout = 'alternate'
     end
 
-    after(:all) do
-      HighVoltage.layout = @original_layout
-    end
-
     describe 'on GET to /pages/exists' do
       before { get :show, :id => 'exists' }
 
@@ -70,13 +64,9 @@ describe HighVoltage::PagesController do
   end
 
   context 'using custom content path' do
-    before(:all) do
-      @original_content_path = HighVoltage.content_path
+    before(:each) do
       HighVoltage.content_path = 'other_pages/'
-    end
-
-    after(:all) do
-      HighVoltage.content_path = @original_content_path
+      Rails.application.reload_routes!
     end
 
     describe 'on GET to /other_pages/also_exists' do
@@ -98,21 +88,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/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe HighVoltage::Configuration do
+  let(:config_value) { 'fake_config_value' }
+
+  before(:each) do
+    HighVoltage.configure do |config|
+      config.action_caching = config_value
+      config.action_caching_layout = config_value
+      config.content_path = config_value
+      config.layout = config_value
+      config.page_caching = config_value
+      config.route_drawer = config_value
+      config.routes = config_value
+    end
+  end
+
+  it { expect(HighVoltage.action_caching).to eq config_value }
+  it { expect(HighVoltage.action_caching_layout).to eq config_value }
+  it { expect(HighVoltage.content_path).to eq config_value }
+  it { expect(HighVoltage.layout).to eq config_value }
+  it { expect(HighVoltage.page_caching).to eq config_value }
+  it { expect(HighVoltage.route_drawer).to eq config_value }
+  it { expect(HighVoltage.routes).to eq config_value }
+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/requests/home_page_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Home page route' do
+  before(:each) do
+    HighVoltage.home_page = 'home'
+    Rails.application.reload_routes!
+  end
+
+  it 'redirects the duplicate content to root' do
+    get '/home'
+    expect(response).to redirect_to('/')
+  end
+end

data/spec/routing/routes_spec.rb

@@ -1,42 +1,38 @@
 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'
-    end
-
-    it 'should generate normal resource route with string' do
+  context 'default configuration' do
+    it 'generates a route' do
       page_path('one').should eq '/pages/one'
     end
 
-    it 'should generate nested route with string' do
+    it 'generates a nested route' do
       page_path('one/two').should eq '/pages/one/two'
     end
 
-    it 'should recognize nested route' do
+    it 'recognizes a route' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
           :action => 'show',
-          :id => 'one/two'
+          :id => 'one'
         },
-        '/pages/one/two'
+        '/pages/one'
       )
     end
 
-    it 'should recognize normal route' do
+    it 'recognizes a nested route' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
           :action => 'show',
-          :id => 'one'
+          :id => 'one/two'
         },
-        '/pages/one'
+        '/pages/one/two'
       )
     end
 
-    it 'should recognize normal route with dots' do
+    it 'recognizes a route with dots' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
@@ -48,78 +44,58 @@ describe 'routes' do
     end
   end
 
-  context 'using root routing configuration' do
-    around do |example|
-      cached_high_voltage_route_drawer = HighVoltage.route_drawer
+  context 'using top-level routing configuration' do
+    before(:each) do
       HighVoltage.route_drawer = HighVoltage::RouteDrawers::Root
       Rails.application.reload_routes!
-
-      example.run
-
-      HighVoltage.route_drawer = cached_high_voltage_route_drawer
-      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
+    it 'generates a route' do
       page_path('one').should eq '/one'
     end
 
-    it 'should generate nested route with string' do
+    it 'generates  a nested route' do
       page_path('one/two').should eq '/one/two'
     end
   end
 
-  context 'using a custom content_path' do
-    around do |example|
-      cached_high_voltage_content_path = HighVoltage.content_path
+  context 'custom content path' do
+    before(:each) do
       HighVoltage.content_path = 'other_pages/'
       Rails.application.reload_routes!
-
-      example.run
-
-      HighVoltage.content_path = cached_high_voltage_content_path
-      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
+    it 'generates a route' do
       page_path('one').should eq '/other_pages/one'
     end
 
-    it 'should generate nested route with string' do
+    it 'generates a nested route' do
       page_path('one/two').should eq '/other_pages/one/two'
     end
 
-    it 'should recognize nested route' do
+    it 'recognizes a route' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
           :action => 'show',
-          :id => 'one/two'
+          :id => 'one'
         },
-        '/other_pages/one/two'
+        '/other_pages/one'
       )
     end
 
-    it 'should recognize normal route' do
+    it 'recognizes a nested route' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
           :action => 'show',
-          :id => 'one'
+          :id => 'one/two'
         },
-        '/other_pages/one'
+        '/other_pages/one/two'
       )
     end
 
-    it 'should recognize normal route with dots' do
+    it 'recognizes a route with dots' do
       assert_recognizes(
         {
           :controller => 'high_voltage/pages',
@@ -131,19 +107,33 @@ describe 'routes' do
     end
   end
 
-  context 'with default configuration disabled' do
-    around do |example|
-      cached_high_voltage_routes = HighVoltage.routes
-      HighVoltage.routes = false
+  context 'home page route' do
+    it 'recognizes the root route' do
+      HighVoltage.home_page = 'home'
       Rails.application.reload_routes!
 
-      example.run
+      assert_recognizes(
+        {
+          :controller => 'high_voltage/pages',
+          :action => 'show',
+          :id => 'home'
+        },
+        '/'
+      )
+    end
+  end
 
-      HighVoltage.routes = cached_high_voltage_routes
-      Rails.application.reload_routes!
+  context 'no home page route' do
+    it 'does generate a home page route' do
+      { :get => '/' }.should_not be_routable
     end
+  end
+
+  context 'disabled routes' do
+    it 'does not recognize routes' do
+      HighVoltage.routes = false
+      Rails.application.reload_routes!
 
-    it 'should not recognize routes' do
       { :get => '/pages/one/two' }.should_not be_routable
     end
   end

data/spec/spec_helper.rb

@@ -1,18 +1,26 @@
 ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'capybara/rails'
+require 'pry'
 require 'rails/test_help'
+require 'rspec/expectations'
 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 { |file| require file }
 
 RSpec.configure do |config|
-  require 'rspec/expectations'
+  config.after(:each) do
+    HighVoltage.set_default_configuration
+    Rails.application.reload_routes!
+  end
+
   config.include RSpec::Matchers
   config.mock_with :rspec
+  config.order = 'random'
 end

data/spec/support/caching.rb

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