high_voltage 1.0.0 → 2.0.0

data/lib/high_voltage/constraints/root_route.rb

@@ -0,0 +1,22 @@
+module HighVoltage
+  module Constraints
+    # Routing constraint to validate request.path has a corresponding view
+    class RootRoute
+      def self.matches?(request)
+        pattern = file_pattern(request.path)
+
+        Dir.glob(pattern).any?
+      end
+
+      private
+
+      def self.file_pattern(page_id)
+        "#{content_path}#{page_id}.html*"
+      end
+
+      def self.content_path
+        Rails.root.join('app', 'views', HighVoltage.content_path).to_s
+      end
+    end
+  end
+end

data/lib/high_voltage/engine.rb

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

@@ -0,0 +1,37 @@
+module HighVoltage
+  # A command for finding pages by id. This encapsulates the concepts of
+  # mapping page names to file names.
+  class PageFinder
+    VALID_CHARACTERS = "a-zA-Z0-9~!@$%^&*()#`_+-=<>\"{}|[];',?".freeze
+
+    def initialize(page_id)
+      @page_id = page_id
+    end
+
+    # Produce a template path to the page, in a format understood by
+    # `render :template => find`
+    def find
+      "#{content_path}#{clean_path}"
+    end
+
+    def content_path
+      HighVoltage.content_path
+    end
+
+    protected
+
+    # The raw page id passed in by the user
+    attr_reader :page_id
+
+    private
+
+    def clean_path
+      path = Pathname.new("/#{clean_id}")
+      path.cleanpath.to_s[1..-1]
+    end
+
+    def clean_id
+      @page_id.tr("^#{VALID_CHARACTERS}", '')
+    end
+  end
+end

data/lib/high_voltage/route_drawers/default.rb

@@ -0,0 +1,15 @@
+module HighVoltage
+  module RouteDrawers
+    # Matches routes in the HighVoltage.content_path directory. By default this looks
+    # for /pages/id. e.g. http://www.example.com/pages/about_us
+    class Default
+      def self.match_attributes
+        {
+          "/#{HighVoltage.content_path}*id" => 'high_voltage/pages#show',
+          :as => :page,
+          :format => false
+        }
+      end
+    end
+  end
+end

data/lib/high_voltage/route_drawers/root.rb

@@ -0,0 +1,16 @@
+module HighVoltage
+  module RouteDrawers
+    # Matches routes from root of the domain e.g. http://www.example.com/about_us
+    # Uses HighVoltage::Constraints::RootRoute to validate view exists.
+    class Root
+      def self.match_attributes
+        {
+          "/*id" => 'high_voltage/pages#show',
+          :as => :page,
+          :format => false,
+          :constraints => HighVoltage::Constraints::RootRoute
+        }
+      end
+    end
+  end
+end

data/lib/high_voltage/version.rb

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

data/lib/high_voltage.rb

@@ -1,3 +1,32 @@
+require 'high_voltage/version'
+require 'high_voltage/constraints/root_route'
+require 'high_voltage/page_finder'
+require 'high_voltage/route_drawers/default'
+require 'high_voltage/route_drawers/root'
+require 'active_support/core_ext/module/attribute_accessors'
+
 module HighVoltage
+  mattr_accessor :layout
+  @@layout = 'application'
+
+  mattr_accessor :content_path
+  @@content_path = 'pages/'
+
+  mattr_accessor :route_drawer
+  @@route_drawer = HighVoltage::RouteDrawers::Default
+
+  mattr_accessor :routes
+  @@routes = true
+
+  mattr_accessor :action_caching
+  @@action_caching = false
+
+  mattr_accessor :page_caching
+  @@page_caching = false
+  
+  def self.setup
+    yield self
+  end
+
   require 'high_voltage/engine' if defined?(Rails)
 end

data/spec/constraints/root_route_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe HighVoltage::Constraints::RootRoute, '.matches?' do
+  context 'view file exists' do
+    it 'should return true' do
+      request = double(path: 'index')
+      Dir.stub(:glob).and_return(['about.html.erb'])
+
+      result = HighVoltage::Constraints::RootRoute.matches?(request)
+
+      expect(result).to be_true
+    end
+  end
+
+  context 'view file does not exist' do
+    it 'should return false' do
+      request = double(path: 'index')
+      File.stub(:glob).and_return([])
+
+      result = HighVoltage::Constraints::RootRoute.matches?(request)
+
+      expect(result).to be_false
+    end
+  end
+end

data/spec/controllers/action_caching_controller_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, 'action_caching' do
+  it 'caches the action when action_caching is set to true', enable_caching: true do
+    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
+    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/alternative_finder_controller_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe AlternativeFinderController do
+  render_views
+
+  it 'renders the file from the alternative directory' do
+    get :show, :id => 'ebg13'
+
+    response.should be_success
+    response.should render_template('rot13')
+  end
+end

data/spec/controllers/page_caching_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe HighVoltage::PagesController, 'action_caching' do
+  it 'caches the page when page_caching is set to true', enable_caching: true do
+    controller.should_receive(:cache_page).at_least(:once)
+
+    HighVoltage.page_caching = true
+    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
+    concern_reload
+    get :show, id: :exists
+  end
+end
+

data/spec/controllers/pages_controller_spec.rb

@@ -0,0 +1,128 @@
+# encoding: UTF-8
+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 a routing error for a page in another directory when using a Unicode exploit' 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,40 @@
+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
+
+  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/alternative_finder_controller.rb

@@ -0,0 +1,14 @@
+class AlternativeFinderController < HighVoltage::PagesController
+  private
+
+  def page_finder_factory
+    Rot13PageFinder
+  end
+
+  class Rot13PageFinder < HighVoltage::PageFinder
+    def find
+      paths = super.split('/')
+      "#{paths[0..-2].join('/')}/#{paths[-1].tr('a-z','n-za-m')}"
+    end
+  end
+end

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,3 @@
+class SubclassedPagesController < HighVoltage::PagesController
+  layout 'alternate'
+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/also_dir/also_nested.html.erb

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

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

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

data/spec/dummy/app/views/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/app/views/pages/rot13.html.erb

@@ -0,0 +1 @@
+alternative

data/spec/dummy/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/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