high_voltage 0.9.1 → 1.0.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright 2010 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

@@ -0,0 +1,136 @@
+High Voltage
+============
+
+Rails engine for static pages.
+
+... but be careful. [Danger!](http://www.youtube.com/watch?v=HD5tnb2RBYg)
+
+Static pages?
+-------------
+
+Yeah, like "About us", "Directions", marketing pages, etc.
+
+Installation
+------------
+
+    $ gem install high_voltage
+
+Include in your Gemfile:
+
+    gem "high_voltage"
+
+For Rails versions prior to 3.0, use the rails2 branch of high_voltage:
+https://github.com/thoughtbot/high_voltage/tree/rails2    
+
+Usage
+-----
+
+Write your static pages and put them in the RAILS_ROOT/app/views/pages directory.
+
+    $ mkdir app/views/pages
+    $ touch app/views/pages/about.html.erb
+
+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")
+
+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")
+
+Bam.
+
+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'
+
+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.
+
+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
+
+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.
+
+Create a PagesController of your own:
+
+    $ rails generate controller pages
+
+Override the default route:
+
+    # in config/routes.rb
+    resources :pages
+
+Then modify it to subclass from High Voltage, adding whatever you need:
+
+    class PagesController < HighVoltage::PagesController
+      before_filter :authenticate
+      layout :layout_for_page
+
+      protected
+        def layout_for_page
+          case params[:id]
+          when 'home'
+            'home'
+          else
+            'application'
+          end
+        end
+    end
+
+Testing
+-------
+
+Just a suggestion, but you can test your pages using Shoulda pretty easily:
+
+    class PagesControllerTest < ActionController::TestCase
+      tests PagesController
+
+      %w(earn_money screencast about contact).each do |page|
+        context "on GET to /pages/#{page}" do
+          setup { get :show, :id => page }
+
+          should_respond_with :success
+          should_render_template page
+        end
+      end
+    end
+
+If you're not using a custom PagesController be sure to test <code>HighVoltage::PagesController</code> instead.
+
+Enjoy!
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+High Voltage is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+Thank you to all [the contributors](https://github.com/thoughtbot/high_voltage/contributors)!
+
+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.

data/app/controllers/high_voltage/pages_controller.rb

@@ -2,7 +2,13 @@ class HighVoltage::PagesController < ApplicationController
 
   unloadable
 
-  rescue_from ActionView::MissingTemplate, :with => :invalid_page
+  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
@@ -10,12 +16,13 @@ class HighVoltage::PagesController < ApplicationController
 
   protected
 
-    def invalid_page
-      render :nothing => true, :status => 404
+    def current_page
+      "pages/#{clean_path}"
     end
 
-    def current_page
-      "pages/#{params[:id].to_s.downcase}"
+    def clean_path
+      path = Pathname.new "/#{params[:id]}"
+      path.cleanpath.to_s[1..-1]
     end
 
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  resources :pages, :controller => 'high_voltage/pages', :only => :show
+  match '/pages/*id' => 'high_voltage/pages#show', :as => :page
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: high_voltage
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 1
-  version: 0.9.1
+  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors: 
 - Dan Croak
@@ -15,11 +10,13 @@ authors:
 - Tammer Saleh
 - Nick Quaranto
 - Tristan Dunn
+- Chad Pytel
+- Joe Ferris
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 -04:00
+date: 2011-06-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -32,14 +29,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- MIT-LICENSE
+- README.md
 - app/controllers/high_voltage/pages_controller.rb
 - config/routes.rb
-- init.rb
-- install.rb
 - lib/high_voltage/engine.rb
 - lib/high_voltage.rb
-- MIT-LICENSE
-- README.markdown
 has_rdoc: true
 homepage: http://github.com/thoughtbot/high_voltage
 licenses: []
@@ -54,23 +49,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple static page rendering controller

data/README.markdown

@@ -1,90 +0,0 @@
-High Voltage
-============
-
-Rails engine for static pages.
-
-... but be careful. [Danger!](http://www.youtube.com/watch?v=HD5tnb2RBYg)
-
-Static pages?
--------------
-
-Yeah, like "About us", "Directions", marketing pages, etc.
-
-Installation
-------------
-
-    $ gem install high_voltage
-
-Usage
------
-
-Write your static pages and put them in the RAILS_ROOT/app/views/pages directory.
-
-    mkdir app/views/pages
-    touch app/views/pages/about.html.erb
-
-After putting something interesting there, you can link to it from anywhere in your app with:
-
-    link_to "About", page_path("about")
-
-Bam.
-
-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:
-
-    map.root :controller => 'pages', :action => 'show', :id => 'home'
-
-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.
-
-You'll notice in your config/routes.rb file that the High Voltage routes are generated by:
-
-    HighVoltage::Routes.draw(map)
-
-Override
---------
-
-Most common reasons to override? Authentication, layouts.
-
-Create a PagesController of your own:
-
-    script/generate controller pages
-
-Then modify it to subclass from High Voltage, adding whatever you need:
-
-    class PagesController < HighVoltage::PagesController
-      before_filter :authenticate
-      layout "danger"
-    end
-
-Testing
--------
-
-Just a suggestion, but you can test your pages using Shoulda pretty easily:
-
-    class PagesControllerTest < ActionController::TestCase
-      tests PagesController
-
-      %w(earn_money screencast about contact).each do |page|
-        context "on GET to /pages/#{page}" do
-          setup { get :show, :id => page }
-
-          should_respond_with :success
-          should_render_template page
-        end
-      end
-    end
-
-If you're not using a custom PagesController be sure to test <code>HighVoltage::PagesController</code> instead.
-
-Enjoy!
-
-License
--------
-
-Copyright (c) thoughtbot, inc -- released under the MIT license.

data/init.rb

@@ -1 +0,0 @@
-require 'high_voltage'

data/install.rb

@@ -1,7 +0,0 @@
-line = "HighVoltage::Routes.draw(map)"
-path = "config/routes.rb"
-
-puts "inserting #{line} into #{path}"
-
-content = File.read(path).sub(/^(end\s*)$/) {|match| "  #{line}\n#{match}" }
-File.open(path, 'wb') { |file| file.write(content) }