high_voltage 1.0.1 → 1.2.0

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+*.swp
+gemfiles/*.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/rails-3.0.12.gemfile
+  - gemfiles/rails-3.1.4.gemfile
+  - gemfiles/rails-3.2.3.gemfile

data/Appraisals

@@ -0,0 +1,5 @@
+['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/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    high_voltage (1.2.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)
+      bundler
+      rake
+    builder (2.1.2)
+    capybara (1.1.0)
+      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)
+    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)
+      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)
+      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
+      rubyzip
+    spruz (0.2.13)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tzinfo (0.3.29)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  capybara (>= 0.4.0)
+  high_voltage!
+  rspec-rails
+  sqlite3

data/README.md

@@ -71,6 +71,15 @@ You can route the root url to a high voltage page like this:
 
 Which will render a homepage from app/views/pages/home.html.erb
 
+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: 
+
+    HighVoltage.content_path = "site/"
+
 Override
 --------
 
@@ -78,6 +87,7 @@ Most common reasons to override?
 
   * You need authentication around the pages to make sure a user is signed in.
   * 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:
 
@@ -86,7 +96,7 @@ Create a PagesController of your own:
 Override the default route:
 
     # in config/routes.rb
-    resources :pages
+    match "/pages/*id" => 'pages#show', :as => :page, :format => false
 
 Then modify it to subclass from High Voltage, adding whatever you need:
 

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    exec 'rake spec'
+  else
+    Rake::Task['appraise'].execute
+  end
+end
+
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
+end

data/app/controllers/high_voltage/pages_controller.rb

@@ -1,9 +1,11 @@
 class HighVoltage::PagesController < ApplicationController
+  VALID_CHARACTERS = "a-zA-Z0-9~!@$%^&*()#`_+-=<>\"{}|[];',?".freeze
 
   unloadable
+  layout Proc.new { |_| HighVoltage.layout }
 
   rescue_from ActionView::MissingTemplate do |exception|
-    if exception.message =~ %r{Missing template pages/}
+    if exception.message =~ %r{Missing template #{content_path}}
       raise ActionController::RoutingError, "No such page: #{params[:id]}"
     else
       raise exception
@@ -17,12 +19,19 @@ class HighVoltage::PagesController < ApplicationController
   protected
 
     def current_page
-      "pages/#{clean_path}"
+      "#{content_path}#{clean_path}"
     end
 
     def clean_path
-      path = Pathname.new "/#{params[:id]}"
+      path = Pathname.new("/#{clean_id}")
       path.cleanpath.to_s[1..-1]
     end
 
+    def content_path
+      HighVoltage.content_path
+    end
+
+    def clean_id
+      params[:id].tr("^#{VALID_CHARACTERS}", '')
+    end
 end

data/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
-  match '/pages/*id' => 'high_voltage/pages#show', :as => :page, :format => false
+  match "/#{HighVoltage.content_path}*id" => 'high_voltage/pages#show', :as => :page, :format => false
+
 end

data/gemfiles/rails-3.0.15.gemfile

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

data/gemfiles/rails-3.1.6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+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/high_voltage.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "high_voltage/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'high_voltage'
+  s.version     = HighVoltage::VERSION.dup
+  s.authors     = ['Matt Jankowski', 'Dan Croak', 'Nick Quaranto', 'Chad Pytel', 'Joe Ferris', 'J. Edward Dewyea', 'Tammer Saleh', 'Mike Burns', 'Tristan Dunn']
+  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.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("appraisal")
+  s.add_development_dependency("rspec-rails")
+  s.add_development_dependency("capybara", ">= 0.4.0")
+  s.add_development_dependency("sqlite3")
+end

data/lib/high_voltage/version.rb

@@ -0,0 +1,3 @@
+module HighVoltage
+  VERSION = '1.2.0'.freeze
+end

data/lib/high_voltage.rb

@@ -1,3 +1,15 @@
+require 'high_voltage/version'
+
 module HighVoltage
+  mattr_accessor :layout
+  @@layout = "application"
+
+  mattr_accessor :content_path
+  @@content_path = "pages/"
+
+  def self.setup
+    yield self
+  end
+
   require 'high_voltage/engine' if defined?(Rails)
 end

data/spec/controllers/pages_controller_spec.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe HighVoltage::PagesController do
+
+  render_views
+
+  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
+        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")
+      end
+    end
+
+    describe "on GET to /pages/dir/nested" do
+      before { get :show, :id => 'dir/nested' }
+
+      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)
+    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)
+    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)
+    end
+  end
+
+  context "using custom layout" do
+    before(:all) do
+      @original_layout = HighVoltage.layout
+      HighVoltage.layout = "alternate"
+    end
+
+    after(:all) do
+      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")
+      end
+    end
+  end
+
+  context "using custom content path" do
+    before(:all) do
+      @original_content_path = HighVoltage.content_path
+      HighVoltage.content_path = "other_pages/"
+    end
+
+    after(:all) do
+      HighVoltage.content_path = @original_content_path
+    end
+
+    describe "on GET to /other_pages/also_exists" do
+      before { get :show, :id => 'also_exists' }
+
+      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
+      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 => "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)
+    end
+
+    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
+
+    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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SubclassedPagesController do
+
+  render_views
+
+  describe "on GET to /subclassed_pages/also_exists" do
+    before { get :show, :id => 'also_exists' }
+
+    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")
+      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)
+  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)
+  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

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

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

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/alternate.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy - Alternate Layout</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/other/wrong.html.erb

@@ -0,0 +1 @@
+cant get here from pages

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

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

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

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

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

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

data/spec/dummy/app/views/pages/dir/nested.html.erb

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

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

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

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

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,44 @@
+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"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

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

@@ -0,0 +1,25 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+