high_voltage 1.1.1 → 1.2.1

data/.gitignore

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

data/.travis.yml

@@ -1,3 +1,9 @@
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/rails-3.0.15.gemfile
+  - gemfiles/rails-3.1.6.gemfile
+  - gemfiles/rails-3.2.6.gemfile

data/Appraisals

@@ -1,7 +1,5 @@
-appraise "rails-3.1.0" do
-  gem "rails", "3.1.0"
-end
-
-appraise "rails-3.0.10" do
-  gem "rails", "3.0.10"
+['3.2.6', '3.1.6', '3.0.15'].each do |rails_version|
+  appraise "rails-#{rails_version}" do
+    gem "rails", rails_version
+  end
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    high_voltage (1.1.1)
+    high_voltage (1.2.1)
 
 GEM
   remote: http://rubygems.org/
@@ -22,7 +22,7 @@ GEM
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
     activesupport (3.0.10)
-    appraisal (0.3.8)
+    appraisal (0.4.1)
       bundler
       rake
     builder (2.1.2)
@@ -55,7 +55,7 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (0.9.2)
+    rake (0.9.2.2)
     rdoc (3.9.4)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010 thoughtbot, inc.
+Copyright 2010-2012 thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# High Voltage [![Build Status](http://travis-ci.org/thoughtbot/high_voltage.png)](http://travis-ci.org/thoughtbot/high_voltage)
+# High Voltage [![Build Status](https://travis-ci.org/thoughtbot/high_voltage.png)](http://travis-ci.org/thoughtbot/high_voltage)
 
 Rails engine for static pages.
 
@@ -57,26 +57,59 @@ 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.
 
-High Voltage will generate a named route method of `page_path` which you can use, as well.  If you 
-want to generate a named route (with the :as routing option) for some route which will be handled 
-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 
+High Voltage will generate a named route method of `page_path` which you can use, as well.  If you
+want to generate a named route (with the :as routing option) for some route which will be handled
+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:
 
     root :to => 'high_voltage/pages#show', :id => 'home'
 
 Which will render a homepage from app/views/pages/home.html.erb
 
+#### Enabling root domain 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
+    http://www.example.com/company
+
+Would look for corresponding files:
+
+    app/views/pages/about.html.erb
+    app/views/pages/company.html.erb
+
+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.
+
+#### Disabling routes
+
+The default routes can be completely removed by changing the
+`HighVoltage.routes` to `false`
+
+    # config/initializers/high_voltage.rb
+    HighVoltage.routes = false
+
 Customize
 --------
 
 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: 
+You can change this in an initializer:
 
     HighVoltage.content_path = "site/"
 
@@ -115,25 +148,58 @@ Then modify it to subclass from High Voltage, adding whatever you need:
         end
     end
 
+Custom finding
+--------------
+
+You can further control the algorithm used to find pages by overriding
+the `page_finder_factory` method:
+
+    class PagesController < HighVoltage::PagesController
+      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')
+
+        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
 -------
 
-Just a suggestion, but you can test your pages using Shoulda pretty easily:
-
-    class PagesControllerTest < ActionController::TestCase
-      tests PagesController
+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
-          setup { get :show, :id => page }
+        context 'on GET to /pages/#{page}' do
+          before do
+            get :show, :id => page
+          end
 
-          should_respond_with :success
-          should_render_template page
+          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 <code>HighVoltage::PagesController</code> instead.
+If you're not using a custom PagesController be sure to test
+`HighVoltage::PagesController` instead.
 
 Enjoy!
 
@@ -156,4 +222,5 @@ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 License
 -------
 
-High Voltage is Copyright © 2009-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+High Voltage is Copyright © 2009-2012 thoughtbot. It is free software, and may
+be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

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

data/app/controllers/high_voltage/pages_controller.rb

@@ -1,10 +1,9 @@
 class HighVoltage::PagesController < ApplicationController
-
   unloadable
-  layout Proc.new { |_| HighVoltage::layout }
+  layout Proc.new { |_| HighVoltage.layout }
 
   rescue_from ActionView::MissingTemplate do |exception|
-    if exception.message =~ %r{Missing template #{content_path}}
+    if exception.message =~ %r{Missing template #{page_finder.content_path}}
       raise ActionController::RoutingError, "No such page: #{params[:id]}"
     else
       raise exception
@@ -15,19 +14,17 @@ class HighVoltage::PagesController < ApplicationController
     render :template => current_page
   end
 
-  protected
-
-    def current_page
-      "#{content_path}#{clean_path}"
-    end
+  private
 
-    def clean_path
-      path = Pathname.new "/#{params[:id]}"
-      path.cleanpath.to_s[1..-1]
-    end
+  def current_page
+    page_finder.find
+  end
 
-    def content_path
-      HighVoltage::content_path
-    end
+  def page_finder
+    page_finder_factory.new(params[:id])
+  end
 
+  def page_finder_factory
+    HighVoltage::PageFinder
+  end
 end

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/gemfiles/{rails-3.0.10.gemfile → rails-3.0.15.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "3.0.10"
+gem "rails", "3.0.15"
 
 gemspec :path=>"../"

data/gemfiles/{rails-3.1.0.gemfile → rails-3.1.6.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "3.1.0"
+gem "rails", "3.1.6"
 
 gemspec :path=>"../"

data/gemfiles/rails-3.2.6.gemfile

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

data/lib/high_voltage/constraints/root_route.rb

@@ -0,0 +1,24 @@
+module HighVoltage
+  module Constraints
+    # Routing constraint to validate request.path has a corresponding view
+    class RootRoute
+      VIEW_EXTENSIONS = 'html.erb,html.haml,html'
+
+      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}.{#{VIEW_EXTENSIONS}}"
+      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,4 @@
 module HighVoltage
-
   class Engine < Rails::Engine
   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 = '1.2.1'.freeze
 end

data/lib/high_voltage.rb

@@ -1,11 +1,21 @@
 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'
 
 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
 
   def self.setup
     yield self

data/spec/constraints/root_route_spec.rb

@@ -0,0 +1,21 @@
+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'])
+
+      HighVoltage::Constraints::RootRoute.matches?(request).should 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([])
+
+      HighVoltage::Constraints::RootRoute.matches?(request).should be_false
+    end
+  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/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