high_voltage 1.2.2 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6132908ee3ceb8d0bd92c7904926e07aa25d33fa
+  data.tar.gz: 7380d36e82d395f54ba6a360ec6bf22d3a6d1f61
+SHA512:
+  metadata.gz: 46412825479d480b85bb248ac95c08f8428b8b8e95f0c1365ff5430377d197cfcf9faf1a3ba83f94fccb34ee4bf5c9c19ee43d3d2b49a88ec53549096a148c9d
+  data.tar.gz: 012bbf16df86ae556196514c59c21b963d9300a82245663ec0ae2eee0c007e66ceac20e21dba0072d9abd3cfac81af36ee82dd109864883cca6af97f80b2a38a

data/.gitignore

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

data/.travis.yml

@@ -1,9 +1,8 @@
-language: ruby
+language:
+  - ruby
+install:
+  - 'bundle install'
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-gemfile:
-  - gemfiles/rails_3.0.18.gemfile
-  - gemfiles/rails_3.1.9.gemfile
-  - gemfiles/rails_3.2.10.gemfile
+  - 2.0.0

data/Appraisals

@@ -1,5 +1,16 @@
-['3.2.10', '3.1.9', '3.0.18'].each do |rails_version|
-  appraise "rails_#{rails_version}" do
-    gem "rails", rails_version
+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/Gemfile.lock

@@ -1,94 +1,70 @@
 PATH
   remote: .
   specs:
-    high_voltage (1.2.2)
+    high_voltage (2.1.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)
+    activesupport (3.1.12)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
       bundler
       rake
-    builder (2.1.2)
-    capybara (1.1.0)
+    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 (~> 0.1.4)
-    childprocess (0.2.2)
-      ffi (~> 1.0.6)
+      xpath (~> 1.0.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
     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)
+    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)
+    rack (1.5.2)
+    rack-test (0.6.2)
       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)
+    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.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
+    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
-    spruz (0.2.13)
-    sqlite3 (1.3.4)
-    thor (0.14.6)
-    tzinfo (0.3.29)
-    xpath (0.1.4)
+      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 (>= 0.4.0)
+  capybara (= 2.0.3)
   high_voltage!
+  pry
   rspec-rails
-  sqlite3

data/NEWS.md

@@ -1,6 +1,28 @@
+New for 2.1.0:
++ Extract configuration options into a module
++ Add ability to configure whether layout is cached with action_caching
++ Add ability to configure a `home_page` for root routing to High Voltage
++ Update README with new block style config
+
+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.

data/README.md

@@ -4,26 +4,25 @@ 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', '~> 2.1.0'
+```
 
 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,52 +31,58 @@ 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
-------
+## Configuration
+
+#### Routing overview
 
 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'
-
-In that case, you'd need an app/views/pages/home.html.erb file.
+```ruby
+get 'pages/home' => 'high_voltage/pages#show', id: 'home'
+```
 
-Generally speaking, you need to route to the 'show' action with an :id param of the view filename.
+In that case, you'd need an `app/views/pages/home.html.erb` file.
 
-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.
+Generally speaking, you need to route to the 'show' action with an `:id` param of the view filename.
 
-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
+High Voltage will generate a named route method of `page_path`. If you want to generate
+your own named route (with the :as routing option), make sure not to use `:page`
+as it will conflict with the High Voltage named route.
 
 #### Specifying a root path
 
-You can route the root url to a high voltage page like this:
+You can configure the root route to a High Voltage page like this:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.home_page = 'home'
+end
+```
 
-    root :to => 'high_voltage/pages#show', :id => 'home'
+Which will render the page from `app/views/pages/home.html.erb` when the '/'
+route of the site is accessed.
 
-Which will render a homepage from app/views/pages/home.html.erb
+Note: High Voltage also creates a search engine friendly 301 redirect. Any attempt to
+access the path '/home' will be redirected to '/'.
 
-#### Enabling root domain routes
+#### Top-level routes
 
-You can remove the directory `pages` from the URL path and serve up routes from 
+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
@@ -88,33 +93,90 @@ 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`
+This is accomplished by setting the `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.
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.route_drawer = HighVoltage::RouteDrawers::Root
+end
+```
 
 #### Disabling routes
 
-The default routes can be completely removed by changing the
-`HighVoltage.routes` to `false`
+The default routes can be completely removed by setting the `routes` to `false`:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.routes = false
+end
+```
 
-    # config/initializers/high_voltage.rb
-    HighVoltage.routes = false
+#### Page titles and meta-data
 
-Customize
---------
+We suggest using `content_for` and `yield` for setting custom page titles and
+meta-data on High Voltage pages.
 
-High Voltage uses a default path and folder of 'pages', i.e. 'url.com/pages/contact' , 'app/views/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>
+```
+#### 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:
 
-    HighVoltage.content_path = "site/"
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.content_path = 'site/'
+end
+```
+
+#### 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 action-caching you can add the following to your initializer:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVolgate.configure do |config|
+  config.action_caching = true
+  config.action_caching_layout = false # optionally do not cache layout. default is true.
+end
+```
 
-Override
---------
+To enable page-caching:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVolgate.configure do |config|
+  config.page_caching = true
+end
+```
+
+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?
 
@@ -122,97 +184,120 @@ Most common reasons to override?
   * 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:
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.routes = false
+end
+```
+
+Define a route for the new `PagesController`:
+
+```ruby
+# config/routes.rb
+get "/pages/*id" => 'pages#show', as: :page, format: false
 
-    # in config/routes.rb
-    match "/pages/*id" => 'pages#show', :as => :page, :format => false
+# if routing the root path, update for your controller
+root to: 'pages#show', id: 'home'
+```
 
-    # if routing the root path, update for your controller
-    root :to => 'pages#show', :id => 'home'
+Then modify new `PagesController` to include the High Voltage static page concern:
 
-Then modify it to subclass from High Voltage, adding whatever you need:
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
 
-    class PagesController < HighVoltage::PagesController
-      before_filter :authenticate
-      layout :layout_for_page
+  before_filter :authenticate
+  layout :layout_for_page
 
-      protected
-        def layout_for_page
-          case params[:id]
-          when 'home'
-            'home'
-          else
-            'application'
-          end
-        end
+  private
+
+  def layout_for_page
+    case params[:id]
+    when 'home'
+      'home'
+    else
+      'application'
     end
+  end
+end
+```
 
-Custom finding
---------------
+## Custom finding
 
 You can further control the algorithm used to find pages by overriding
 the `page_finder_factory` method:
 
-    class PagesController < HighVoltage::PagesController
-      private
+```ruby
+# app/controllers/pages_controller.rb
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
 
-      def page_finder_factory
-        Rot13PageFinder
-      end
-    end
+  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')
+```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
+    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
--------
+## Testing
 
-You can test your static pages using [RSpec](https://github.com/rspec/rspec-rails) 
+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
-          before do
-            get :show, :id => page
-          end
-
-          it { should respond_with(:success) }
-          it { should render_template(page) }
-        end
+```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
 `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)
 
@@ -222,8 +307,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-2013 thoughtbot. It is free software, and may
 be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

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