high_voltage 1.0.1 → 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

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language:
+  - ruby
+install:
+  - 'bundle install'
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Appraisals

@@ -0,0 +1,16 @@
+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/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,80 @@
+PATH
+  remote: .
+  specs:
+    high_voltage (2.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.12)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
+      bundler
+      rake
+    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 (~> 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)
+    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)
+    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.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
+      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 (= 2.0.3)
+  high_voltage!
+  pry-debugger
+  rspec-rails

data/MIT-LICENSE

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

data/NEWS.md

@@ -0,0 +1,23 @@
+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.
++ Updated README, with new TravisCI url.

data/README.md

@@ -1,29 +1,28 @@
-# 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.
 
 ... 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,108 +31,249 @@ 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.
 
-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):
+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.
 
-    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
 
-Override
---------
+#### 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:
+
+```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
+    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`
+
+```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`:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.routes = false
+```
+
+#### Content path
+
+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:
+
+```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
+```
+
+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?
 
   * 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:
+Create a `PagesController` of your own:
 
     $ rails generate controller pages
 
-Override the default route:
+Disable the default routes:
 
-    # in config/routes.rb
-    resources :pages
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.routes = false
+```
 
-Then modify it to subclass from High Voltage, adding whatever you need:
+Define a route for the new `PagesController`:
 
-    class PagesController < HighVoltage::PagesController
-      before_filter :authenticate
-      layout :layout_for_page
+```ruby
+# config/routes.rb
+get "/pages/*id" => 'pages#show', :as => :page, :format => false
 
-      protected
-        def layout_for_page
-          case params[:id]
-          when 'home'
-            'home'
-          else
-            'application'
-          end
-        end
-    end
+# if routing the root path, update for your controller
+root :to => 'pages#show', :id => 'home'
+```
 
-Testing
--------
+Then modify new `PagesController` to include the High Voltage static page concern:
 
-Just a suggestion, but you can test your pages using Shoulda pretty easily:
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
 
-    class PagesControllerTest < ActionController::TestCase
-      tests PagesController
+  before_filter :authenticate
+  layout :layout_for_page
 
-      %w(earn_money screencast about contact).each do |page|
-        context "on GET to /pages/#{page}" do
-          setup { get :show, :id => page }
+  private
 
-          should_respond_with :success
-          should_render_template page
-        end
+  def layout_for_page
+    case params[:id]
+    when 'home'
+      'home'
+    else
+      'application'
+    end
+  end
+end
+```
+
+## Custom finding
+
+You can further control the algorithm used to find pages by overriding
+the `page_finder_factory` method:
+
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
+
+  private
+
+  def page_finder_factory
+    Rot13PageFinder
+  end
+end
+```
+
+The easiest thing is to subclass `HighVoltage::PageFinder`, which
+provides you with `page_id`:
+
+```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
+```
+
+Use this to create a custom file mapping, clean filenames for your file
+system, A/B test, and so on.
+
+## Testing
+
+You can test your static pages using [RSpec](https://github.com/rspec/rspec-rails)
+and [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers):
+
+```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 <code>HighVoltage::PagesController</code> instead.
+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)
 
@@ -143,7 +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-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'appraisal'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default'
+task :default => [:all]
+
+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,28 +1,3 @@
 class HighVoltage::PagesController < ApplicationController
-
-  unloadable
-
-  rescue_from ActionView::MissingTemplate do |exception|
-    if exception.message =~ %r{Missing template pages/}
-      raise ActionController::RoutingError, "No such page: #{params[:id]}"
-    else
-      raise exception
-    end
-  end
-
-  def show
-    render :template => current_page
-  end
-
-  protected
-
-    def current_page
-      "pages/#{clean_path}"
-    end
-
-    def clean_path
-      path = Pathname.new "/#{params[:id]}"
-      path.cleanpath.to_s[1..-1]
-    end
-
+  include HighVoltage::StaticPage
 end

data/config/routes.rb

@@ -1,3 +1,5 @@
 Rails.application.routes.draw do
-  match '/pages/*id' => 'high_voltage/pages#show', :as => :page, :format => false
+  if HighVoltage.routes
+    get HighVoltage.route_drawer.match_attributes
+  end
 end

data/high_voltage.gemspec

@@ -0,0 +1,24 @@
+$:.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.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")
+end