high_voltage 1.1.1 → 2.0.0

data/config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
-  match "/#{HighVoltage::content_path}*id" => 'high_voltage/pages#show', :as => :page, :format => false
-
+  if HighVoltage.routes
+    get HighVoltage.route_drawer.match_attributes
+  end
 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/constraints/root_route.rb

@@ -0,0 +1,22 @@
+module HighVoltage
+  module Constraints
+    # Routing constraint to validate request.path has a corresponding view
+    class RootRoute
+      def self.matches?(request)
+        pattern = file_pattern(request.path)
+
+        Dir.glob(pattern).any?
+      end
+
+      private
+
+      def self.file_pattern(page_id)
+        "#{content_path}#{page_id}.html*"
+      end
+
+      def self.content_path
+        Rails.root.join('app', 'views', HighVoltage.content_path).to_s
+      end
+    end
+  end
+end

data/lib/high_voltage/engine.rb

@@ -1,6 +1,13 @@
 module HighVoltage
-
   class Engine < Rails::Engine
-  end
+    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/page_finder.rb

@@ -0,0 +1,37 @@
+module HighVoltage
+  # A command for finding pages by id. This encapsulates the concepts of
+  # mapping page names to file names.
+  class PageFinder
+    VALID_CHARACTERS = "a-zA-Z0-9~!@$%^&*()#`_+-=<>\"{}|[];',?".freeze
+
+    def initialize(page_id)
+      @page_id = page_id
+    end
+
+    # Produce a template path to the page, in a format understood by
+    # `render :template => find`
+    def find
+      "#{content_path}#{clean_path}"
+    end
+
+    def content_path
+      HighVoltage.content_path
+    end
+
+    protected
+
+    # The raw page id passed in by the user
+    attr_reader :page_id
+
+    private
+
+    def clean_path
+      path = Pathname.new("/#{clean_id}")
+      path.cleanpath.to_s[1..-1]
+    end
+
+    def clean_id
+      @page_id.tr("^#{VALID_CHARACTERS}", '')
+    end
+  end
+end

data/lib/high_voltage/route_drawers/default.rb

@@ -0,0 +1,15 @@
+module HighVoltage
+  module RouteDrawers
+    # Matches routes in the HighVoltage.content_path directory. By default this looks
+    # for /pages/id. e.g. http://www.example.com/pages/about_us
+    class Default
+      def self.match_attributes
+        {
+          "/#{HighVoltage.content_path}*id" => 'high_voltage/pages#show',
+          :as => :page,
+          :format => false
+        }
+      end
+    end
+  end
+end

data/lib/high_voltage/route_drawers/root.rb

@@ -0,0 +1,16 @@
+module HighVoltage
+  module RouteDrawers
+    # Matches routes from root of the domain e.g. http://www.example.com/about_us
+    # Uses HighVoltage::Constraints::RootRoute to validate view exists.
+    class Root
+      def self.match_attributes
+        {
+          "/*id" => 'high_voltage/pages#show',
+          :as => :page,
+          :format => false,
+          :constraints => HighVoltage::Constraints::RootRoute
+        }
+      end
+    end
+  end
+end

data/lib/high_voltage/version.rb

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

data/lib/high_voltage.rb

@@ -1,12 +1,29 @@
 require 'high_voltage/version'
+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
-  @@layout = "application"
+  @@layout = 'application'
 
   mattr_accessor :content_path
-  @@content_path = "pages/"
+  @@content_path = 'pages/'
 
+  mattr_accessor :route_drawer
+  @@route_drawer = HighVoltage::RouteDrawers::Default
+
+  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

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe HighVoltage::Constraints::RootRoute, '.matches?' do
+  context 'view file exists' do
+    it 'should return true' do
+      request = double(path: 'index')
+      Dir.stub(:glob).and_return(['about.html.erb'])
+
+      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 = double(path: 'index')
+      File.stub(:glob).and_return([])
+
+      result = HighVoltage::Constraints::RootRoute.matches?(request)
+
+      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/alternative_finder_controller_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe AlternativeFinderController do
+  render_views
+
+  it 'renders the file from the alternative directory' do
+    get :show, :id => 'ebg13'
+
+    response.should be_success
+    response.should render_template('rot13')
+  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

@@ -1,106 +1,128 @@
+# encoding: UTF-8
 require 'spec_helper'
 
 describe HighVoltage::PagesController do
-
   render_views
 
-  context "using default configuration" do
-
-    describe "on GET to /pages/exists" do
+  context 'using default configuration' do
+    describe 'on GET to /pages/exists' do
       before { get :show, :id => 'exists' }
 
-      it "should respond with success and render template" do
+      it 'should respond with success and render template' do
         response.should be_success
         response.should render_template('exists')
       end
 
-      it "should use the default layout used by ApplicationController" do
-        response.should render_template("layouts/application")
+      it 'should use the default layout used by ApplicationController' do
+        response.should render_template('layouts/application')
       end
     end
 
-    describe "on GET to /pages/dir/nested" do
+    describe 'on GET to /pages/dir/nested' do
       before { get :show, :id => 'dir/nested' }
 
-      it "should respond with success and render template" do
+      it 'should respond with success and render template' do
         response.should be_success
         response.should render_template('pages/dir/nested')
       end
     end
 
-    it "should raise a routing error for an invalid page" do
-      lambda { get :show, :id => "invalid" }.should raise_error(ActionController::RoutingError)
+    it 'should raise a routing error for an invalid page' do
+      lambda {
+        get :show,
+        :id => '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" }.should raise_error(ActionController::RoutingError)
+    it 'should raise a routing error for a page in another directory' do
+      lambda {
+        get :show,
+        :id => '../other/wrong'
+      }.should raise_error(ActionController::RoutingError)
     end
 
-    it "should raise missing template error for valid page with invalid partial" do
-      lambda { get :show, :id => "exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+    it 'should raise missing template error for valid page with invalid partial' do
+      lambda {
+        get :show,
+        :id => 'exists_but_references_nonexistent_partial'
+      }.should raise_error(ActionView::MissingTemplate)
     end
   end
 
-  context "using custom layout" do
+  context 'using custom layout' do
     before(:all) do
-      @original_layout = HighVoltage::layout
-      HighVoltage::layout = "alternate"
+      @original_layout = HighVoltage.layout
+      HighVoltage.layout = 'alternate'
     end
 
     after(:all) do
-      HighVoltage::layout = @original_layout
+      HighVoltage.layout = @original_layout
     end
 
-    describe "on GET to /pages/exists" do
-      before { get :show, :id => "exists" }
-      
-      it "should use the custom configured layout" do
-        response.should_not render_template("layouts/application")
-        response.should render_template("layouts/alternate")
+    describe 'on GET to /pages/exists' do
+      before { get :show, :id => 'exists' }
+
+      it 'should use the custom configured layout' do
+        response.should_not render_template('layouts/application')
+        response.should render_template('layouts/alternate')
       end
     end
   end
 
-  context "using custom content path" do
+  context 'using custom content path' do
     before(:all) do
-      @original_content_path = HighVoltage::content_path
-      HighVoltage::content_path = "other_pages/"
+      @original_content_path = HighVoltage.content_path
+      HighVoltage.content_path = 'other_pages/'
     end
 
     after(:all) do
-      HighVoltage::content_path = @original_content_path
+      HighVoltage.content_path = @original_content_path
     end
 
-    describe "on GET to /other_pages/also_exists" do
+    describe 'on GET to /other_pages/also_exists' do
       before { get :show, :id => 'also_exists' }
 
-      it "should respond with success and render template" do
+      it 'should respond with success and render template' do
         response.should be_success
         response.should render_template('other_pages/also_exists')
       end
     end
 
-    describe "on GET to /other_pages/also_dir/nested" do
+    describe 'on GET to /other_pages/also_dir/nested' do
       before { get :show, :id => 'also_dir/also_nested' }
 
-      it "should respond with success and render template" do
+      it 'should respond with success and render template' do
         response.should be_success
         response.should render_template('other_pages/also_dir/also_nested')
       end
     end
 
-    it "should raise a routing error for an invalid page" do
-      lambda { get :show, :id => "also_invalid" }.should raise_error(ActionController::RoutingError)
+    it 'should raise a routing error for an invalid page' do
+      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" }.should raise_error(ActionController::RoutingError)
+    it 'should raise a routing error for a page in another directory' do
+      lambda {
+        get :show,
+        :id => '../other/wrong'
+      }.should raise_error(ActionController::RoutingError)
     end
 
-    it "should raise missing template error for valid page with invalid partial" do
-      lambda { get :show, :id => "also_exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+    it 'should raise a routing error for a page in another directory when using a Unicode exploit' do
+      lambda {
+        get :show,
+        :id => '/\\../other/wrong'
+      }.should raise_error(ActionController::RoutingError)
     end
-  end
-
 
+    it 'should raise missing template error for valid page with invalid partial' do
+      lambda {
+        get :show,
+        :id => 'also_exists_but_references_nonexistent_partial'
+      }.should raise_error(ActionView::MissingTemplate)
+    end
+  end
 end

data/spec/controllers/subclassed_pages_controller_spec.rb

@@ -1,41 +1,40 @@
 require 'spec_helper'
 
 describe SubclassedPagesController do
-
   render_views
 
-  describe "on GET to /subclassed_pages/also_exists" do
+  describe 'on GET to /subclassed_pages/also_exists' do
     before { get :show, :id => 'also_exists' }
 
-    it "should respond with success and render template" do
+    it 'should respond with success and render template' do
       response.should be_success
       response.should render_template('also_exists')
     end
 
-    it "should use the custom configured layout" do
-      response.should_not render_template("layouts/application")
+    it 'should use the custom configured layout' do
+      response.should_not render_template('layouts/application')
       response.should render_template('layouts/alternate')
     end
   end
 
-  describe "on GET to /subclassed_pages/also_dir/nested" do
-    before { get :show, :id => 'also_dir/also_nested' }
-
-    it "should respond with success and render template" do
-      response.should be_success
-      response.should render_template('other_pages/also_dir/also_nested')
-    end
-  end
-
-  it "should raise a routing error for an invalid page" do
-    lambda { get :show, :id => "invalid" }.should raise_error(ActionController::RoutingError)
+  it 'should raise a routing error for an invalid page' do
+    lambda {
+      get :show,
+      :id => '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" }.should raise_error(ActionController::RoutingError)
+  it 'should raise a routing error for a page in another directory' do
+    lambda {
+      get :show,
+      :id => '../other/wrong'
+    }.should raise_error(ActionController::RoutingError)
   end
 
-  it "should raise missing template error for valid page with invalid partial" do
-    lambda { get :show, :id => "also_exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+  it 'should raise missing template error for valid page with invalid partial' do
+    lambda {
+      get :show,
+      :id => 'also_exists_but_references_nonexistent_partial'
+    }.should raise_error(ActionView::MissingTemplate)
   end
 end

data/spec/dummy/app/controllers/alternative_finder_controller.rb

@@ -0,0 +1,14 @@
+class AlternativeFinderController < HighVoltage::PagesController
+  private
+
+  def page_finder_factory
+    Rot13PageFinder
+  end
+
+  class Rot13PageFinder < HighVoltage::PageFinder
+    def find
+      paths = super.split('/')
+      "#{paths[0..-2].join('/')}/#{paths[-1].tr('a-z','n-za-m')}"
+    end
+  end
+end

data/spec/dummy/app/controllers/subclassed_pages_controller.rb

@@ -1,7 +1,3 @@
 class SubclassedPagesController < HighVoltage::PagesController
   layout 'alternate'
-
-  def content_path
-    'other_pages/'
-  end
 end

data/spec/dummy/app/views/pages/also_dir/also_nested.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %> from a nested dir

data/spec/dummy/app/views/pages/also_exists.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %>

data/spec/dummy/app/views/pages/also_exists_but_references_nonexistent_partial.html.erb

@@ -0,0 +1,2 @@
+hello <%= 'world' %>
+<%= render 'nonexistent' %>

data/spec/dummy/app/views/pages/rot13.html.erb

@@ -0,0 +1 @@
+alternative

data/spec/dummy/config/application.rb

@@ -3,7 +3,6 @@ require File.expand_path('../boot', __FILE__)
 require "active_model/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-require "action_mailer/railtie"
 
 Bundler.require
 require "high_voltage"

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
@@ -20,11 +19,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types

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,3 +1,4 @@
 Dummy::Application.routes.draw do
-  match "/subclassed_pages/*id" => 'subclassed_pages#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/page_finder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe HighVoltage::PageFinder do
+  it 'produces the name of an existing template' do
+    find('existing').should eq 'pages/existing'
+  end
+
+  it 'produces the name of a nested template' do
+    find('dir/nested').should eq 'pages/dir/nested'
+  end
+
+  it 'uses a custom content path' do
+    with_content_path('other_pages/') do
+      find('also_exists').should eq 'other_pages/also_exists'
+    end
+  end
+
+  it 'exposes the content path' do
+    with_content_path('another_thing/') do
+      page_finder.content_path.should eq 'another_thing/'
+    end
+  end
+
+  it 'provides the page_id' do
+    subclass = Class.new(HighVoltage::PageFinder) do
+      def page_name
+        "the page is #{page_id}"
+      end
+    end
+
+    subclass.new('sweet page').page_name.should eq 'the page is sweet page'
+  end
+
+  private
+
+  def find(page_id)
+    page_finder(page_id).find
+  end
+
+  def page_finder(page_id = 'whatever')
+    HighVoltage::PageFinder.new(page_id)
+  end
+
+  def with_content_path(path)
+    original_content_path = HighVoltage.content_path
+    HighVoltage.content_path = path
+
+    yield
+
+    HighVoltage.content_path = original_content_path
+  end
+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
+  it 'should be valid' do
     HighVoltage.should be_a(Module)
   end
-end
+
+  it 'should be loadable without preloading rails' do
+    expect { require 'high_voltage' }.not_to raise_error
+  end
+end

data/spec/integration/navigation_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe "Navigation" do
+describe 'Navigation' do
   include Capybara::DSL
-  
-  it "should be a valid app" do
+
+  it 'should be a valid app' do
     ::Rails.application.should be_a(Dummy::Application)
   end
 end