high_voltage 2.2.0 → 3.0.0

data/lib/high_voltage/page.rb

@@ -0,0 +1,44 @@
+module HighVoltage
+  class Page
+    attr_reader :content_path, :file_path
+
+    def initialize(content_path, file_path)
+      @content_path = content_path
+      @file_path = file_path
+    end
+
+    def id
+      file_path.gsub(content_path, "").gsub(html_file_pattern, "")
+    end
+
+    def valid?
+      exists? && file_in_content_path? && !directory? && !partial? && html?
+    end
+
+    private
+
+    def exists?
+      File.exists?(file_path)
+    end
+
+    def file_in_content_path?
+      file_path.start_with?(content_path)
+    end
+
+    def directory?
+      FileTest.directory?(file_path)
+    end
+
+    def partial?
+      File.basename(file_path).first == "_"
+    end
+
+    def html?
+      !file_path.match(html_file_pattern).nil?
+    end
+
+    def html_file_pattern
+      /\.(html)(\.[a-z]+)?$/
+    end
+  end
+end

data/lib/high_voltage/page_collector.rb

@@ -0,0 +1,23 @@
+module HighVoltage
+  require "find"
+
+  class PageCollector
+    attr_reader :content_path
+
+    def initialize(content_path)
+      @content_path = content_path.to_s
+    end
+
+    def page_ids
+      pages.select(&:valid?).map(&:id)
+    end
+
+    private
+
+    def pages
+      Find.find(content_path).map do |file_path|
+        HighVoltage::Page.new(content_path, file_path)
+      end
+    end
+  end
+end

data/lib/high_voltage/page_finder.rb

@@ -27,11 +27,25 @@ module HighVoltage
 
     def clean_path
       path = Pathname.new("/#{clean_id}")
-      path.cleanpath.to_s[1..-1]
+      path.cleanpath.to_s[1..-1].tap do |p|
+        if p.blank?
+          raise InvalidPageIdError.new "Invalid page id: #{@page_id}"
+        end
+      end
     end
 
     def clean_id
-      @page_id.tr("^#{VALID_CHARACTERS}", '')
+      @page_id.tr("^#{VALID_CHARACTERS}", "").tap do |id|
+        if invalid_page_id?(id)
+          raise InvalidPageIdError.new "Invalid page id: #{@page_id}"
+        end
+      end
+    end
+
+    def invalid_page_id?(id)
+      id.blank? || (id.first == ".")
     end
   end
+
+  class InvalidPageIdError < StandardError; end
 end

data/lib/high_voltage/version.rb

@@ -1,3 +1,3 @@
 module HighVoltage
-  VERSION = '2.2.0'.freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/high_voltage.rb

@@ -3,6 +3,8 @@ require 'active_support/core_ext/module/attribute_accessors'
 
 require 'high_voltage/configuration'
 require 'high_voltage/constraints/root_route'
+require "high_voltage/page"
+require "high_voltage/page_collector"
 require 'high_voltage/page_finder'
 require 'high_voltage/route_drawers/default'
 require 'high_voltage/route_drawers/root'

data/spec/constraints/root_route_spec.rb

@@ -1,21 +1,36 @@
-require 'spec_helper'
+require "spec_helper"
 
-describe HighVoltage::Constraints::RootRoute, '.matches?' do
-  it 'returns true when the view file exists' do
+describe HighVoltage::Constraints::RootRoute, ".matches?" do
+  it "returns true when the view file exists" do
     request = double(path: 'index')
-    Dir.stub(:glob).and_return(['about.html.erb'])
+    file_path = Rails.root.join("app", "views", "pages", "index.html*").to_s
+
+    allow(Dir).to receive(:glob).with(file_path).and_return(["about.html.erb"])
+
+    result = HighVoltage::Constraints::RootRoute.matches?(request)
+
+    expect(result).to be true
+  end
+
+  it "returns true when the view file exists and url ends with .html" do
+    request = double(path: "index.html")
+    file_path = Rails.root.join("app", "views", "pages", "index.html*").to_s
+
+    allow(Dir).to receive(:glob).with(file_path).and_return(["about.html.erb"])
 
     result = HighVoltage::Constraints::RootRoute.matches?(request)
 
-    expect(result).to be_true
+    expect(result).to be true
   end
 
-  it 'returns false when the view files does not exist' do
+  it "returns false when the view files does not exist" do
     request = double(path: 'index')
-    File.stub(:glob).and_return([])
+    file_path = Rails.root.join("app", "views", "pages", "index", ".html*").to_s
+
+    allow(File).to receive(:glob).with(file_path).and_return([])
 
     result = HighVoltage::Constraints::RootRoute.matches?(request)
 
-    expect(result).to be_false
+    expect(result).to be false
   end
 end

data/spec/controllers/pages_controller_spec.rb

@@ -1,108 +1,113 @@
-require 'spec_helper'
+# 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' }
+  context "using default configuration" do
+    describe "on GET to /pages/exists" do
+      before { get :show, id: "exists" }
 
-      it 'responds with success and render template' do
+      it "responds with success and render template" do
         expect(response).to be_success
-        expect(response).to render_template('exists')
+        expect(response).to render_template("exists")
       end
 
-      it 'uses the default layout used by ApplicationController' do
-        expect(response).to render_template('layouts/application')
+      it "uses the default layout used by ApplicationController" do
+        expect(response).to render_template("layouts/application")
       end
     end
 
-    describe 'on GET to /pages/dir/nested' do
-      before { get :show, :id => 'dir/nested' }
+    describe "on GET to /pages/dir/nested" do
+      before { get :show, id: "dir/nested" }
 
-      it 'responds with success and render template' do
+      it "responds with success and render template" do
         expect(response).to be_success
-        expect(response).to render_template('pages/dir/nested')
+        expect(response).to render_template("pages/dir/nested")
       end
     end
 
-    it 'raises a routing error for an invalid page' do
-      expect { get :show, id: 'invalid' }
-        .to raise_error(ActionController::RoutingError)
+    it "raises a routing error for an invalid page" do
+      expect { get :show, id: "invalid" }.
+        to raise_error(ActionController::RoutingError)
     end
 
-    it 'raises a routing error for a page in another directory' do
-      expect { get :show, id: '../other/wrong' }
-        .to raise_error(ActionController::RoutingError)
+    it "raises a routing error for a page in another directory" do
+      expect { get :show, id: "../other/wrong" }.
+        to raise_error(ActionController::RoutingError)
     end
 
-    it 'raises a missing template error for valid page with invalid partial' do
-      expect { get :show, id: 'exists_but_references_nonexistent_partial' }
-        .to raise_error(ActionView::MissingTemplate)
+    it "raises a missing template error for valid page with invalid partial" do
+      expect { get :show, id: "exists_but_references_nonexistent_partial" }.
+        to raise_error(ActionView::MissingTemplate)
     end
   end
 
-  context 'using custom layout' do
+  context "using custom layout" do
     before(:each) do
-      HighVoltage.layout = 'alternate'
+      HighVoltage.layout = "alternate"
     end
 
-    describe 'on GET to /pages/exists' do
-      before { get :show, :id => 'exists' }
+    describe "on GET to /pages/exists" do
+      before { get :show, id: "exists" }
 
-      it 'uses the custom configured layout' do
-        expect(response).not_to render_template('layouts/application')
-        expect(response).to render_template('layouts/alternate')
+      it "uses the custom configured layout" do
+        expect(response).not_to render_template("layouts/application")
+        expect(response).to render_template("layouts/alternate")
       end
     end
   end
 
-  context 'using custom content path' do
+  context "using custom content path" do
     before(:each) do
-      HighVoltage.content_path = 'other_pages/'
+      HighVoltage.content_path = "other_pages/"
       Rails.application.reload_routes!
     end
 
-    describe 'on GET to /other_pages/also_exists' do
-      before { get :show, :id => 'also_exists' }
+    describe "on GET to /other_pages/also_exists" do
+      before { get :show, id: "also_exists" }
 
-      it 'responds with success and render template' do
+      it "responds with success and render template" do
         expect(response).to be_success
-        expect(response).to render_template('other_pages/also_exists')
+        expect(response).to 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' }
+    describe "on GET to /other_pages/also_dir/nested" do
+      before { get :show, id: "also_dir/also_nested" }
 
-      it 'responds with success and render template' do
+      it "responds with success and render template" do
         expect(response).to be_success
-        expect(response).to render_template('other_pages/also_dir/also_nested')
+        expect(response).to render_template("other_pages/also_dir/also_nested")
       end
     end
 
-    it 'raises a routing error for an invalid page' do
-      expect { get :show, id: 'also_invalid' }
-        .to raise_error(ActionController::RoutingError)
+    it "raises a routing error for an invalid page" do
+      expect { get :show, id: "also_invalid" }.
+        to raise_error(ActionController::RoutingError)
+
+      expect { get :show, id: "√®ø" }.
+        to raise_error(ActionController::RoutingError)
     end
 
-    context 'page in another directory' do
-      it 'raises a routing error' do
-        expect { get :show, id: '../other_wrong' }
-          .to raise_error(ActionController::RoutingError)
+    context "page in another directory" do
+      it "raises a routing error" do
+        expect { get :show, id: "../other_wrong" }.
+          to raise_error(ActionController::RoutingError)
       end
 
-      it 'raises a routing error when using a Unicode exploit' do
-        expect { get :show, id: '/\\../other/wrong' }
-          .to raise_error(ActionController::RoutingError)
+      it "raises a routing error when using a Unicode exploit" do
+        expect { get :show, id: "/\\../other/wrong" }.
+          to raise_error(ActionController::RoutingError)
       end
     end
 
-    it 'raises a missing template error for valid page with invalid partial' do
-      id = 'also_exists_but_references_nonexistent_partial'
+    it "raises a missing template error for valid page with invalid partial" do
+      id = "also_exists_but_references_nonexistent_partial"
 
-      expect { get :show, id: id }
-        .to raise_error(ActionView::MissingTemplate)
+      expect { get :show, id: id }.
+        to raise_error(ActionView::MissingTemplate)
     end
   end
 end

data/spec/fake_app.rb

@@ -0,0 +1,15 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end
+
+# Create a rails app
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = "test"
+    config.eager_load = false
+    config.action_controller.perform_caching = true
+    config.action_controller.cache_store = :memory_store
+    config.root = "spec/fixtures"
+  end
+end
+Dummy::Application.initialize!

data/spec/fixtures/app/views/pages/_partial.html.erb

@@ -0,0 +1 @@
+partial

data/spec/fixtures/app/views/pages/text.txt.erb

@@ -0,0 +1 @@
+text page

data/spec/fixtures/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/high_voltage/configuration_spec.rb

@@ -7,11 +7,8 @@ describe HighVoltage::Configuration do
     before(:each) do
       HighVoltage.configure do |config|
         ActiveSupport::Deprecation.silence do
-          config.action_caching = config_value
-          config.action_caching_layout = config_value
           config.content_path = config_value
           config.layout = config_value
-          config.page_caching = config_value
           config.parent_engine = config_value
           config.route_drawer = config_value
           config.routes = config_value
@@ -25,64 +22,10 @@ describe HighVoltage::Configuration do
       end
     end
 
-    it { expect(HighVoltage.action_caching).to eq config_value }
-    it { expect(HighVoltage.action_caching_layout).to eq config_value }
     it { expect(HighVoltage.content_path).to eq config_value }
     it { expect(HighVoltage.layout).to eq config_value }
-    it { expect(HighVoltage.page_caching).to eq config_value }
     it { expect(HighVoltage.parent_engine).to eq config_value }
     it { expect(HighVoltage.route_drawer).to eq config_value }
     it { expect(HighVoltage.routes).to eq config_value }
   end
-
-  describe '#action_caching=' do
-    it 'displays a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
-
-      HighVoltage.configure do |config|
-        config.action_caching = true
-      end
-
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
-    end
-  end
-
-  describe '#action_caching_layout=' do
-    it 'displays a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
-
-      HighVoltage.configure do |config|
-        config.action_caching_layout = true
-      end
-
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
-    end
-  end
-
-  describe '#page_caching=' do
-    it 'displays a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
-
-      HighVoltage.configure do |config|
-        config.page_caching = true
-      end
-
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
-    end
-  end
-
-  describe '#set_default_configuration' do
-    it 'defaults caching without a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
-
-      Class.new do
-        extend HighVoltage::Configuration
-      end
-
-      expect(ActiveSupport::Deprecation).not_to have_received(:warn)
-    end
-  end
 end

data/spec/high_voltage/page_collector_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe HighVoltage::PageCollector do
+  it "produces an array of all page_ids under pages/" do
+    expect(HighVoltage.page_ids).to eq [
+      "also_dir/also_nested",
+      "also_exists",
+      "also_exists_but_references_nonexistent_partial",
+      "dir/nested",
+      "exists",
+      "exists_but_references_nonexistent_partial",
+      "rot13"
+    ]
+  end
+
+  it "produces an array of all page_ids under other_pages/" do
+    with_content_path("other_pages/") do
+      expect(HighVoltage.page_ids).to eq [
+        "also_dir/also_nested",
+        "also_exists",
+        "also_exists_but_references_nonexistent_partial",
+      ]
+    end
+  end
+
+  private
+
+  def with_content_path(path)
+    original_content_path = HighVoltage.content_path
+    HighVoltage.content_path = path
+
+    yield
+
+    HighVoltage.content_path = original_content_path
+  end
+end

data/spec/high_voltage/page_finder_spec.rb

@@ -1,34 +1,54 @@
-require 'spec_helper'
+# encoding: utf-8
+
+require "spec_helper"
 
 describe HighVoltage::PageFinder do
-  it 'produces the name of an existing template' do
-    expect(find('existing')).to eq 'pages/existing'
+  it "produces the name of an existing template" do
+    expect(find("existing")).to eq "pages/existing"
   end
 
-  it 'produces the name of a nested template' do
-    expect(find('dir/nested')).to eq 'pages/dir/nested'
+  it "produces the name of a nested template" do
+    expect(find("dir/nested")).to eq "pages/dir/nested"
   end
 
-  it 'uses a custom content path' do
-    with_content_path('other_pages/') do
-      expect(find('also_exists')).to eq 'other_pages/also_exists'
+  it "uses a custom content path" do
+    with_content_path("other_pages/") do
+      expect(find("also_exists")).to eq "other_pages/also_exists"
     end
   end
 
-  it 'exposes the content path' do
-    with_content_path('another_thing/') do
-      expect(page_finder.content_path).to eq 'another_thing/'
+  it "exposes the content path" do
+    with_content_path("another_thing/") do
+      expect(page_finder.content_path).to eq "another_thing/"
     end
   end
 
-  it 'provides the page_id' do
+  it "provides the page_id" do
     subclass = Class.new(HighVoltage::PageFinder) do
       def page_name
         "the page is #{page_id}"
       end
     end
 
-    expect(subclass.new('sweet page').page_name).to eq 'the page is sweet page'
+    expect(subclass.new("sweet page").page_name).to eq "the page is sweet page"
+  end
+
+  it "removes invalid characters from the page_id" do
+    expect(find("b\\a…d√")).to eq "pages/bad"
+  end
+
+  context "sanitized page_id" do
+    it "throws an exception if the page_id is empty" do
+      expect { find("\\…√") }.to raise_error HighVoltage::InvalidPageIdError
+    end
+
+    it "throws an exception if the page_id is just a file extension" do
+      expect { find("\\√.zip") }.to raise_error HighVoltage::InvalidPageIdError
+    end
+  end
+
+  it "throws an exception if the path is empty" do
+    expect { find("關於我們/合作伙伴") }.to raise_error HighVoltage::InvalidPageIdError
   end
 
   private
@@ -37,7 +57,7 @@ describe HighVoltage::PageFinder do
     page_finder(page_id).find
   end
 
-  def page_finder(page_id = 'whatever')
+  def page_finder(page_id = "whatever")
     HighVoltage::PageFinder.new(page_id)
   end
 

data/spec/high_voltage/page_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+describe HighVoltage::Page do
+  it "produces the id for a page" do
+    page = page(full_file_path("exists.html.erb"))
+
+    expect(page.id).to eq "exists"
+  end
+
+  it "produces the id for a page in a subdirectory" do
+    page = page(full_file_path("dir/nested.html.erb"))
+
+    expect(page.id).to eq "dir/nested"
+  end
+
+  it "is valid for a page" do
+    page = page(full_file_path("exists.html.erb"))
+
+    expect(page).to be_valid
+  end
+
+  it "is valid for a page in a subdirectory" do
+    page = page(full_file_path("dir/nested.html.erb"))
+
+    expect(page).to be_valid
+  end
+
+  it "is invalid for a directory" do
+    page = page(full_file_path("dir"))
+
+    expect(page).to_not be_valid
+  end
+
+  it "is invalid for a partial" do
+    page = page(full_file_path("_partial.html.erb"))
+
+    expect(page).to_not be_valid
+  end
+
+  it "is invalid for a non-existent page" do
+    page = page(full_file_path("nonexistent.html.erb"))
+
+    expect(page).to_not be_valid
+  end
+
+  it "is invalid for a text page" do
+    page = page(full_file_path("text.txt.erb"))
+
+    expect(page).to_not be_valid
+  end
+
+  private
+
+  def full_content_path
+    HighVoltage.full_path.to_s
+  end
+
+  def page(file_path)
+    HighVoltage::Page.new(full_content_path, file_path)
+  end
+
+  def full_file_path(file_path)
+    "#{full_content_path}#{file_path}"
+  end
+end

data/spec/spec_helper.rb

@@ -1,17 +1,21 @@
-ENV['RAILS_ENV'] = 'test'
+ENV["RAILS_ENV"] = "test"
 
-require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require "pry"
+require "active_model/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "rspec/rails"
 
-require 'pry'
-require 'rails/test_help'
-require 'rspec/expectations'
-require 'rspec/rails'
+require "high_voltage"
+require "fake_app"
 
 Rails.backtrace_cleaner.remove_silencers!
 
-Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |file| require file }
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |file| require file }
 
 RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+
   config.after(:each) do
     HighVoltage.set_default_configuration
     Rails.application.reload_routes!
@@ -23,5 +27,14 @@ RSpec.configure do |config|
 
   config.include RSpec::Matchers
   config.mock_with :rspec
-  config.order = 'random'
+  config.order = "random"
+
+  if Rails::VERSION::MAJOR >= 5
+    require "rails-controller-testing"
+
+    config.include(
+      Rails::Controller::Testing::TemplateAssertions,
+      type: :controller,
+    )
+  end
 end

data/spec/support/http_method_shim.rb

@@ -0,0 +1,15 @@
+# Rails 5 deprecates calling HTTP action methods with positional arguments
+# in favor of keyword arguments. However, the keyword argument form is only
+# supported in Rails 5+. Since we support back to 4, we need some sort of shim
+# to avoid super noisy deprecations when running tests.
+module HTTPMethodShim
+  def get(path, params = nil, headers = nil)
+    super(path, params: params, headers: headers)
+  end
+end
+
+if Rails::VERSION::MAJOR >= 5
+  RSpec.configure do |config|
+    config.include HTTPMethodShim, type: :controller
+  end
+end