high_voltage 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b872bfede94dc9cf0c80856bd435edd5c8014f65
-  data.tar.gz: 742e628313897b06f7579d4c3098c2eab2717440
+  metadata.gz: dfdb165dc9944d13d14ccfcfab0358c2d575b688
+  data.tar.gz: 769e4a05d918743c86ce21f58b4ab2ea3d8bc838
 SHA512:
-  metadata.gz: 181f409611c5c3e699f29d27416b55f5633fc1d1d9af772b5bbc2d8fc17a70fe1308c207698aba65aafc23d91ba515a599a7e95591a8ee4855a856db44374edc
-  data.tar.gz: 8197ebd00469a8e6d1e77b58b26bfa02f2bfa5a32fdffaa13cd441e06448c26fdcb3ca39d3799da7b85be07aa94f454fee0fb6108678385527c464b7a8380e36
+  metadata.gz: e036c73851faf23320d6b5fccbd8c65cacdb73e736422e0df062cdea64ea8c6a88d26bfc084403a979955eeb695e82d4bc89fdcdd6905516dd7adf85734425b7
+  data.tar.gz: 29b92c7a8e76d78f6084bfbc6987d5022af4a048461eaff10192d32e94bdd217b41ca27e9ac1c42a38e70fae0603519075cba4e7d2f0a9cc78dc5b4ddaf11206

data/.gitignore

@@ -1,8 +1,6 @@
 .bundle/
 log/*.log
 pkg/
-spec/dummy/db/*.sqlite3
-spec/dummy/log/*.log
-spec/dummy/tmp/
 *.swp
 *.gem
+gemfiles/*.lock

data/.travis.yml

@@ -1,24 +1,17 @@
 gemfile:
-  - gemfiles/rails3.1.gemfile
-  - gemfiles/rails3.2.gemfile
   - gemfiles/rails4.0.gemfile
   - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
 install:
   - 'travis_retry bundle install'
 language:
   - ruby
-matrix:
-  exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails4.0.gemfile
-    - rvm: 1.9.3
-      gemfile:  gemfiles/rails4.1.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails3.1.gemfile
-    - rvm: 2.1.2
-      gemfile: gemfiles/rails3.1.gemfile
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.5
+  - 2.2.0
 script: 'bundle exec rake spec'
+notifications:
+  email: false
+sudo: false
+cache: bundler

data/Appraisals

@@ -1,16 +1,9 @@
-if RUBY_VERSION >= '2.0'
-  rails_versions = ['~> 3.2.13', '~> 4.0.0', '~> 4.1.0']
-else
-  rails_versions = ['~> 3.1.12', '~> 3.2.13']
-end
+rails_versions = ['~> 4.0.0', '~> 4.1.0', '~> 4.2.0']
 
 rails_versions.each do |rails_version|
   appraise "rails#{rails_version.slice(/\d+\.\d+/)}" do
     gem 'rails', rails_version
-
-    if ['~> 4.0.0', '~> 4.1.0'].include? rails_version
-      gem 'actionpack-action_caching'
-      gem 'actionpack-page_caching'
-    end
+    gem 'actionpack-action_caching'
+    gem 'actionpack-page_caching'
   end
 end

data/CONTRIBUTING.md

@@ -1,4 +1,7 @@
-We love pull requests. Here's a quick guide:
+We love pull requests from everyone. By participating in this project, you
+agree to abide by the thoughtbot [code of conduct].
+
+[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
 1. Fork the repo.
 

data/Gemfile.lock

@@ -1,30 +1,31 @@
 PATH
   remote: .
   specs:
-    high_voltage (2.2.1)
+    high_voltage (2.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (4.1.1)
-      actionview (= 4.1.1)
-      activesupport (= 4.1.1)
-      rack (~> 1.5.2)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
       rack-test (~> 0.6.2)
-    actionview (4.1.1)
-      activesupport (= 4.1.1)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activemodel (4.1.1)
-      activesupport (= 4.1.1)
-      builder (~> 3.1)
-    activesupport (4.1.1)
-      i18n (~> 0.6, >= 0.6.9)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    appraisal (1.0.0)
+    appraisal (1.0.2)
       bundler
       rake
       thor (>= 0.14.0)
@@ -32,39 +33,57 @@ GEM
     coderay (1.1.0)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    i18n (0.6.9)
-    json (1.8.1)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
     method_source (0.8.2)
-    minitest (5.3.3)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.5.2)
-    rack-test (0.6.2)
+    rack (1.6.0)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    railties (4.1.1)
-      actionpack (= 4.1.1)
-      activesupport (= 4.1.1)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.3.1)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rspec-rails (2.14.2)
-      actionpack (>= 3.0)
-      activemodel (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    slop (3.5.0)
+    rake (10.4.2)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.1)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    slop (3.6.0)
     thor (0.19.1)
-    thread_safe (0.3.3)
-    tzinfo (1.1.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -75,4 +94,4 @@ DEPENDENCIES
   appraisal
   high_voltage!
   pry
-  rspec-rails
+  rspec-rails (~> 3.2.0)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010-2014 thoughtbot, inc.
+Copyright 2010-2015 thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/NEWS.md

@@ -1,3 +1,8 @@
+New for 2.3.0:
++ Ruby 2.2 and Rails 4.2 testing
++ Raise InvalidPageIdError when visiting a page with invalid characters
++ Code of Conduct added to Contributing guide
+
 New for 2.2.1:
 + Resolve issue with require statements for Rails 3.x projects
 

data/README.md

@@ -15,7 +15,7 @@ Yeah, like "About us", "Directions", marketing pages, etc.
 Include in your Gemfile:
 
 ```ruby
-gem 'high_voltage', '~> 2.2.1'
+gem 'high_voltage', '~> 2.3.0`
 ```
 
 For Rails versions prior to 3.0, use the 0.9.2 tag of high_voltage:
@@ -263,6 +263,58 @@ end
 Use this to create a custom file mapping, clean filenames for your file
 system, A/B test, and so on.
 
+## Localization
+
+[Rails I18n guides](http://guides.rubyonrails.org/i18n.html).
+
+Add a before filter to the Application controller
+
+```ruby
+# app/controllers/application_controller.rb
+before_action :set_locale
+
+def set_locale
+  I18n.locale = params[:locale] || I18n.default_locale
+end
+```
+
+Disable the default High Voltage routes
+
+```ruby
+# config/initializers/high_voltage.rb
+HighVoltage.configure do |config|
+  config.routes = false
+end
+```
+
+```ruby
+# config/routes.rb
+scope "/:locale", locale: /en|bn|hi/ do
+  get "/pages/:id" => "high_voltage/pages#show", :as => :page, :format => false
+end
+```
+
+Add a static page to the project
+
+```
+# app/views/pages/about.html.erb
+<%= t "hello" %>
+```
+
+Make sure that there are corresponding locale files
+
+```
+/config/locale/bn.yml
+/config/locale/en.yml
+/config/locale/hi.yml
+```
+
+One last note is there is a [know
+issue](https://github.com/thoughtbot/high_voltage/issues/59) with High Voltage.
+
+You'll need to specify routes like this `<%= link_to "About Us", page_path(id:
+"about") %>`
+
 ## Testing
 
 You can test your static pages using [RSpec](https://github.com/rspec/rspec-rails)
@@ -291,20 +343,29 @@ Enjoy!
 
 ## Contributing
 
-Please see [CONTRIBUTING.md](https://github.com/thoughtbot/high_voltage/blob/master/CONTRIBUTING.md)
-for details.
+Please see [CONTRIBUTING.md].
+Thank you, [contributors]!
 
-## Credits
+[CONTRIBUTING.md]: /CONTRIBUTING.md
+[contributors]: https://github.com/thoughtbot/high_voltage/graphs/contributors
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+## License
+
+High Voltage is copyright © 2009-2015 thoughtbot. It is free software, and may
+be redistributed under the terms specified in the [`LICENSE`] file.
 
-High Voltage is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+[`LICENSE`]: /MIT-LICENSE
 
-Thank you to all [the contributors](https://github.com/thoughtbot/high_voltage/contributors)!
+## About thoughtbot
 
+![thoughtbot](https://thoughtbot.com/logo.png)
+
+High Voltage is maintained and funded by thoughtbot, inc.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-## License
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
 
-High Voltage is Copyright © 2009-2014 thoughtbot. It is free software, and may
-be redistributed under the terms specified in the MIT-LICENSE file.
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github

data/app/controllers/concerns/high_voltage/static_page.rb

@@ -6,12 +6,14 @@ module HighVoltage::StaticPage
 
     rescue_from ActionView::MissingTemplate do |exception|
       if exception.message =~ %r{Missing template #{page_finder.content_path}}
-        raise ActionController::RoutingError, "No such page: #{params[:id]}"
+        invalid_page
       else
         raise exception
       end
     end
 
+    rescue_from HighVoltage::InvalidPageIdError, with: :invalid_page
+
     if respond_to?(:caches_action)
       caches_action :show, layout: HighVoltage.action_caching_layout,
         if: -> { HighVoltage.action_caching }
@@ -39,4 +41,8 @@ module HighVoltage::StaticPage
   def page_finder_factory
     HighVoltage::PageFinder
   end
+
+  def invalid_page
+    raise ActionController::RoutingError, "No such page: #{params[:id]}"
+  end
 end

data/gemfiles/{rails3.1.gemfile → rails4.2.gemfile}

@@ -3,6 +3,8 @@
 source "http://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 3.1.12"
+gem "rails", "~> 4.2.0"
+gem "actionpack-action_caching"
+gem "actionpack-page_caching"
 
 gemspec :path => "../"

data/high_voltage.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("activesupport", ">= 3.1.0")
   s.add_development_dependency("pry")
-  s.add_development_dependency("rspec-rails")
+  s.add_development_dependency("rspec-rails", "~> 3.2.0")
 end

data/lib/high_voltage/page_finder.rb

@@ -31,7 +31,17 @@ module HighVoltage
     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.1".freeze
+  VERSION = "2.3.0".freeze
 end

data/spec/constraints/root_route_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 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'])
+    allow(Dir).to receive(:glob).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
     request = double(path: 'index')
-    File.stub(:glob).and_return([])
+    allow(File).to receive(:glob).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,18 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end
+
+# Create a rails app
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = "test"
+    config.paths["public"] = ["spec/fixtures/public"]
+    config.paths["config/routes.rb"] = ["spec/fixtures/config/routes.rb"]
+    config.paths["app/views"] = ["spec/fixtures/app/views"]
+    config.paths["app/controllers"] = ["spec/support/app/controllers"]
+    config.eager_load = false
+    config.action_controller.perform_caching = true
+    config.action_controller.cache_store = :memory_store
+  end
+end
+Dummy::Application.initialize!