high_voltage 1.2.4 → 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/.travis.yml

@@ -1,4 +1,7 @@
-language: ruby
+language:
+  - ruby
+install:
+  - 'bundle install'
 rvm:
   - 1.9.2
   - 1.9.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    high_voltage (1.2.3)
+    high_voltage (2.0.0)
 
 GEM
   remote: http://rubygems.org/

data/NEWS.md

@@ -1,3 +1,7 @@
+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

data/README.md

@@ -64,7 +64,7 @@ route generated by High Voltage itself.
 
 #### 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:
 
 ```ruby
 root :to => 'high_voltage/pages#show', id: 'home'
@@ -72,7 +72,7 @@ root :to => 'high_voltage/pages#show', id: 'home'
 
 Which will render a homepage from app/views/pages/home.html.erb
 
-#### Page title's and meta-data
+#### Page titles and meta-data
 
 We suggest using `content_for` and `yield` for setting custom page titles and
 meta-data on High Voltage pages.
@@ -166,7 +166,14 @@ 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.routes = false
+```
+
+Define a route for the new `PagesController`:
 
 ```ruby
 # config/routes.rb
@@ -176,23 +183,26 @@ get "/pages/*id" => 'pages#show', :as => :page, :format => false
 root :to => 'pages#show', :id => 'home'
 ```
 
-Then modify it to subclass from High Voltage, adding whatever you need:
+Then modify new `PagesController` to include the High Voltage static page concern:
 
 ```ruby
 # app/controllers/pages_controller.rb
-class PagesController < HighVoltage::PagesController
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
+
   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
 ```
 
@@ -203,7 +213,9 @@ the `page_finder_factory` method:
 
 ```ruby
 # app/controllers/pages_controller.rb
-class PagesController < HighVoltage::PagesController
+class PagesController < ApplicationController
+  include HighVoltage::StaticPage
+
   private
 
   def page_finder_factory

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,41 +1,3 @@
 class HighVoltage::PagesController < ApplicationController
-  layout Proc.new { |_| HighVoltage.layout }
-
-  if respond_to?('caches_action')
-    caches_action :show, if: Proc.new {
-      HighVoltage.action_caching
-    }
-  end
-
-  if respond_to?('caches_page')
-    caches_page :show, if: Proc.new {
-      HighVoltage.page_caching
-    }
-  end
-
-  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
-
-  def show
-    render :template => current_page
-  end
-
-  private
-
-  def current_page
-    page_finder.find
-  end
-
-  def page_finder
-    page_finder_factory.new(params[:id])
-  end
-
-  def page_finder_factory
-    HighVoltage::PageFinder
-  end
+  include HighVoltage::StaticPage
 end

data/high_voltage.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   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")

data/lib/high_voltage/engine.rb

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

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

data/spec/controllers/action_caching_controller_spec.rb

@@ -2,25 +2,22 @@ require 'spec_helper'
 
 describe HighVoltage::PagesController, 'action_caching' do
   it 'caches the action when action_caching is set to true', enable_caching: true do
-    HighVoltage.action_caching = true
-
-    load('high_voltage/pages_controller.rb')
-    get :show, id: 'exists'
-
-    action_was_cached(:exists).should be_true
+    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
-    HighVoltage.action_caching = false
-
-    load('high_voltage/pages_controller.rb')
-    get :show, id: 'exists'
-
-    action_was_cached(:exists).should be_false
+    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/page_caching_controller_spec.rb

@@ -5,18 +5,16 @@ describe HighVoltage::PagesController, 'action_caching' do
     controller.should_receive(:cache_page).at_least(:once)
 
     HighVoltage.page_caching = true
-
-    load('high_voltage/pages_controller.rb')
-    get :show, id: 'exists'
+    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
-
-    load('high_voltage/pages_controller.rb')
-    get :show, id: 'exists'
+    concern_reload
+    get :show, id: :exists
   end
 end
 

data/spec/support/concern_reload.rb

@@ -0,0 +1,11 @@
+def concern_reload
+  HighVoltage::PagesController.class_eval do
+    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
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: high_voltage
 version: !ruby/object:Gem::Version
-  version: 1.2.4
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Jankowski
@@ -17,44 +16,39 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -62,7 +56,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -70,33 +63,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Fire in the disco. Fire in the ... taco bell.
@@ -116,6 +105,7 @@ files:
 - NEWS.md
 - README.md
 - Rakefile
+- app/controllers/concerns/high_voltage/static_page.rb
 - app/controllers/high_voltage/pages_controller.rb
 - config/routes.rb
 - high_voltage.gemspec
@@ -184,29 +174,30 @@ files:
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/caching.rb
+- spec/support/concern_reload.rb
 homepage: http://github.com/thoughtbot/high_voltage
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple static page rendering controller
 test_files:
 - spec/constraints/root_route_spec.rb
@@ -267,3 +258,4 @@ test_files:
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/caching.rb
+- spec/support/concern_reload.rb