high_voltage 0.9.4 → 1.1.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-3.1.0" do
+  gem "rails", "3.1.0"
+end
+
+appraise "rails-3.0.10" do
+  gem "rails", "3.0.10"
+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.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.3.8)
+      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)
+    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

@@ -1,5 +1,4 @@
-High Voltage
-============
+# High Voltage [![Build Status](http://travis-ci.org/thoughtbot/high_voltage.png)](http://travis-ci.org/thoughtbot/high_voltage)
 
 Rails engine for static pages.
 
@@ -19,8 +18,9 @@ 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    
+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
 -----
@@ -38,6 +38,10 @@ 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
@@ -53,12 +57,29 @@ 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):
+
+    match '/:id' => 'high_voltage/pages#show', :as => :static, :via => :get
+
 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
 
+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
 --------
 
@@ -66,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:
 
@@ -74,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:
 
@@ -115,6 +137,11 @@ If you're not using a custom PagesController be sure to test <code>HighVoltage::
 
 Enjoy!
 
+Contributing
+------------
+
+Please see CONTRIBUTING.md for details.
+
 Credits
 -------
 

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Default: run the unit tests."
+task :default => [:all]
+
+desc 'Test the plugin under all supported Rails versions.'
+task :all => ["appraisal:install"] do |t|
+  exec('rake appraisal spec')
+end

data/app/controllers/high_voltage/pages_controller.rb

@@ -1,9 +1,10 @@
 class HighVoltage::PagesController < ApplicationController
 
   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,7 +18,16 @@ class HighVoltage::PagesController < ApplicationController
   protected
 
     def current_page
-      "pages/#{params[:id].to_s.downcase}"
+      "#{content_path}#{clean_path}"
+    end
+
+    def clean_path
+      path = Pathname.new "/#{params[:id]}"
+      path.cleanpath.to_s[1..-1]
+    end
+
+    def content_path
+      HighVoltage::content_path
     end
 
 end

data/config/routes.rb

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

data/gemfiles/rails-3.0.10.gemfile

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

data/gemfiles/rails-3.0.10.gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: /Users/jferris/Source/high_voltage
+  specs:
+    high_voltage (1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.10)
+      actionpack (= 3.0.10)
+      mail (~> 2.2.19)
+    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)
+    activerecord (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+    activesupport (3.0.10)
+    appraisal (0.3.8)
+      bundler
+      rake
+    arel (2.0.10)
+    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)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.10)
+      actionmailer (= 3.0.10)
+      actionpack (= 3.0.10)
+      activerecord (= 3.0.10)
+      activeresource (= 3.0.10)
+      activesupport (= 3.0.10)
+      bundler (~> 1.0)
+      railties (= 3.0.10)
+    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)
+    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)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  capybara (>= 0.4.0)
+  high_voltage!
+  rails (= 3.0.10)
+  rspec-rails
+  sqlite3

data/gemfiles/rails-3.1.0.gemfile

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

data/gemfiles/rails-3.1.0.gemfile.lock

@@ -0,0 +1,137 @@
+PATH
+  remote: /Users/jferris/Source/high_voltage
+  specs:
+    high_voltage (1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    appraisal (0.3.8)
+      bundler
+      rake
+    arel (2.2.1)
+    bcrypt-ruby (3.0.0)
+    builder (3.0.0)
+    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.7.0)
+    ffi (1.0.9)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json_pure (1.5.4)
+      spruz (~> 0.2.8)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.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
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    spruz (0.2.13)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  capybara (>= 0.4.0)
+  high_voltage!
+  rails (= 3.1.0)
+  rspec-rails
+  sqlite3

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.1.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