high_voltage 1.0.1 → 1.1.0

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

data/lib/high_voltage/version.rb

@@ -0,0 +1,3 @@
+module HighVoltage
+  VERSION = '1.1.0'.freeze
+end

data/spec/controllers/pages_controller_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController do
+
+  render_views
+
+  context "using default configuration" do
+
+    describe "on GET to /pages/exists" do
+      before { get :show, :id => 'exists' }
+
+      it "should respond with success and render template" do
+        response.should be_success
+        response.should render_template('exists')
+      end
+
+      it "should use the default layout used by ApplicationController" do
+        response.should render_template("layouts/application")
+      end
+    end
+
+    describe "on GET to /pages/dir/nested" do
+      before { get :show, :id => 'dir/nested' }
+
+      it "should respond with success and render template" do
+        response.should be_success
+        response.should render_template('pages/dir/nested')
+      end
+    end
+
+    it "should raise a routing error for an invalid page" do
+      lambda { get :show, :id => "invalid" }.should raise_error(ActionController::RoutingError)
+    end
+
+    it "should raise a routing error for a page in another directory" do
+      lambda { get :show, :id => "../other/wrong" }.should raise_error(ActionController::RoutingError)
+    end
+
+    it "should raise missing template error for valid page with invalid partial" do
+      lambda { get :show, :id => "exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+    end
+  end
+
+  context "using custom layout" do
+    before(:all) do
+      @original_layout = HighVoltage::layout
+      HighVoltage::layout = "alternate"
+    end
+
+    after(:all) do
+      HighVoltage::layout = @original_layout
+    end
+
+    describe "on GET to /pages/exists" do
+      before { get :show, :id => "exists" }
+      
+      it "should use the custom configured layout" do
+        response.should_not render_template("layouts/application")
+        response.should render_template("layouts/alternate")
+      end
+    end
+  end
+
+  context "using custom content path" do
+    before(:all) do
+      @original_content_path = HighVoltage::content_path
+      HighVoltage::content_path = "other_pages/"
+    end
+
+    after(:all) do
+      HighVoltage::content_path = @original_content_path
+    end
+
+    describe "on GET to /other_pages/also_exists" do
+      before { get :show, :id => 'also_exists' }
+
+      it "should respond with success and render template" do
+        response.should be_success
+        response.should render_template('other_pages/also_exists')
+      end
+    end
+
+    describe "on GET to /other_pages/also_dir/nested" do
+      before { get :show, :id => 'also_dir/also_nested' }
+
+      it "should respond with success and render template" do
+        response.should be_success
+        response.should render_template('other_pages/also_dir/also_nested')
+      end
+    end
+
+    it "should raise a routing error for an invalid page" do
+      lambda { get :show, :id => "also_invalid" }.should raise_error(ActionController::RoutingError)
+    end
+
+    it "should raise a routing error for a page in another directory" do
+      lambda { get :show, :id => "../other/wrong" }.should raise_error(ActionController::RoutingError)
+    end
+
+    it "should raise missing template error for valid page with invalid partial" do
+      lambda { get :show, :id => "also_exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+    end
+  end
+
+
+end

data/spec/controllers/subclassed_pages_controller_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SubclassedPagesController do
+
+  render_views
+
+  describe "on GET to /subclassed_pages/also_exists" do
+    before { get :show, :id => 'also_exists' }
+
+    it "should respond with success and render template" do
+      response.should be_success
+      response.should render_template('also_exists')
+    end
+
+    it "should use the custom configured layout" do
+      response.should_not render_template("layouts/application")
+      response.should render_template('layouts/alternate')
+    end
+  end
+
+  describe "on GET to /subclassed_pages/also_dir/nested" do
+    before { get :show, :id => 'also_dir/also_nested' }
+
+    it "should respond with success and render template" do
+      response.should be_success
+      response.should render_template('other_pages/also_dir/also_nested')
+    end
+  end
+
+  it "should raise a routing error for an invalid page" do
+    lambda { get :show, :id => "invalid" }.should raise_error(ActionController::RoutingError)
+  end
+
+  it "should raise a routing error for a page in another directory" do
+    lambda { get :show, :id => "../other/wrong" }.should raise_error(ActionController::RoutingError)
+  end
+
+  it "should raise missing template error for valid page with invalid partial" do
+    lambda { get :show, :id => "also_exists_but_references_nonexistent_partial" }.should raise_error(ActionView::MissingTemplate)
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/subclassed_pages_controller.rb

@@ -0,0 +1,7 @@
+class SubclassedPagesController < HighVoltage::PagesController
+  layout 'alternate'
+
+  def content_path
+    'other_pages/'
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/alternate.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy - Alternate Layout</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/other/wrong.html.erb

@@ -0,0 +1 @@
+cant get here from pages

data/spec/dummy/app/views/other_pages/also_dir/also_nested.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %> from a nested dir

data/spec/dummy/app/views/other_pages/also_exists.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %>

data/spec/dummy/app/views/other_pages/also_exists_but_references_nonexistent_partial.html.erb

@@ -0,0 +1,2 @@
+hello <%= 'world' %>
+<%= render 'nonexistent' %>

data/spec/dummy/app/views/pages/dir/nested.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %> from a nested dir

data/spec/dummy/app/views/pages/exists.html.erb

@@ -0,0 +1 @@
+hello <%= 'world' %>

data/spec/dummy/app/views/pages/exists_but_references_nonexistent_partial.html.erb

@@ -0,0 +1,2 @@
+hello <%= 'world' %>
+<%= render 'nonexistent' %>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "high_voltage"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,25 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end