high_voltage 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f93b914b6966f7141851a562ce82ffe1e218e01
-  data.tar.gz: d6456e304488fec82214e584d9dbd8f261151d69
+  metadata.gz: f6fe8331cf7311ae941daea7a313a66e350a5565
+  data.tar.gz: d1f5bb5ec3984ce97f167a7e4b56c9936ff1a788
 SHA512:
-  metadata.gz: eabead4dde04710b58c97047ca3d0b18af4694696b0e800af9ad0618d08d37c358071999f2fb4a56455857c501d1204a1df73c91c85f58e1fe4d9c71a915d93d
-  data.tar.gz: 8a0b9a4dabe052d01a1b2f4edc91cc7bd15a36eff75ab49d7db3e4c18fe9509203edc214fc2a5d2767022cdfac32c384b94af8023583a5e39944fd94830be8ba
+  metadata.gz: 7b5f88d3c1b88243befa89c0e1c8e1640b9b1556ea070dcbb7eff8bfeab51c88d6907e6746730d9318c4a276f026f45695eefc800e9aba078bc4ee48714860a8
+  data.tar.gz: 949ae450736d58557bc15ecdcd6f33098ae2ada670563b9440e8b65e7883d12154ddc170d3f42d1147133d4452ccabe7d771707eef320779113e32bdccc636a7

data/.gitignore

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

data/.travis.yml

@@ -1,8 +1,18 @@
-language:
-  - ruby
+gemfile:
+  - gemfiles/rails4.0.gemfile
+  - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
 install:
   - 'travis_retry bundle install'
+language:
+  - ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
+  - 2.0.0-p648
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+script: 'bundle exec rake spec'
+notifications:
+  email: false
+sudo: false
+cache: bundler

data/Appraisals

@@ -1,16 +1,13 @@
-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
   end
 end
+
+appraise "rails50" do
+  gem "rails", "~> 5.0.0.beta3"
+  gem "rspec-rails", "3.5.0.beta1"
+  gem "rails-controller-testing"
+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

@@ -1,3 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
+
+gem "appraisal"
+gem "rspec-rails", "~> 3.2"

data/Gemfile.lock

@@ -1,30 +1,31 @@
 PATH
   remote: .
   specs:
-    high_voltage (2.2.0)
+    high_voltage (3.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    actionpack (4.1.1)
-      actionview (= 4.1.1)
-      activesupport (= 4.1.1)
-      rack (~> 1.5.2)
+    actionpack (4.2.5.2)
+      actionview (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rack (~> 1.6)
       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.2)
+    actionview (4.2.5.2)
+      activesupport (= 4.2.5.2)
       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.2)
+    activesupport (4.2.5.2)
+      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.3)
+    loofah (2.0.3)
+      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_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    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.4)
+    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.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
       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.5.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
     thor (0.19.1)
-    thread_safe (0.3.3)
-    tzinfo (1.1.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -75,4 +94,7 @@ DEPENDENCIES
   appraisal
   high_voltage!
   pry
-  rspec-rails
+  rspec-rails (~> 3.2)
+
+BUNDLED WITH
+   1.11.2

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,21 @@
+New for 3.0.0
++ HighVoltage now supports Rails 5.0.0.beta3 and up.
++ Properly handle extensions in root route constraint requests.
++ Removes caching in preparation for Rails 5.
+
+New for 2.4.0
++ Retrieve a list of available static pages via `HighVoltage.page_ids`.
++ Properly handle page ids which are blank when being sanitized.
++ Only provide deprecation warnings around caching when caching is enabled.
+
+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
+
 New for 2.2.0:
 + Deprecate caching because page and action caching was removed in Rails 4
 + Refactor test suite to use rspec `expect` syntax consistently.

data/README.md

@@ -15,13 +15,9 @@ Yeah, like "About us", "Directions", marketing pages, etc.
 Include in your Gemfile:
 
 ```ruby
-gem 'high_voltage', '~> 2.2.0'
+gem 'high_voltage', '~> 3.0.0'
 ```
 
-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
 
 Write your static pages and put them in the RAILS_ROOT/app/views/pages directory.
@@ -32,17 +28,28 @@ Write your static pages and put them in the RAILS_ROOT/app/views/pages directory
 After putting something interesting there, you can link to it from anywhere in your app with:
 
 ```ruby
-link_to 'About', page_path('about')
+<%= link_to 'About', page_path('about') %>
 ```
 
 You can nest pages in a directory structure, if that makes sense from a URL perspective for you:
 
 ```ruby
-link_to 'Q4 Reports', page_path('about/corporate/policies/HR/en_US/biz/sales/Quarter-Four')
+<%= link_to 'Q4 Reports', page_path('about/corporate/policies/HR/en_US/biz/sales/Quarter-Four') %>
 ```
 
 Bam.
 
+You can also get a list of your static pages by calling `HighVoltage.page_ids`
+This might be useful if you need to build a sitemap. For example, if you are
+using the [sitemap_generator](https://github.com/kjvarga/sitemap_generator) gem,
+you could add something like this to your sitemap config file:
+
+```ruby
+HighVoltage.page_ids.each do |page|
+  add page, changefreq: 'monthly'
+end
+```
+
 ## Configuration
 
 #### Routing overview
@@ -157,7 +164,7 @@ end
 
 #### Caching
 
-Caching has been deprecated and will be removed in the next release.
+Built in caching support has been removed in HighVoltage. See [PR 221](https://github.com/thoughtbot/high_voltage/pull/221).
 
 Page caching and action caching can be done via Rails. Visit the [Caching with
 Rails: An overview](http://guides.rubyonrails.org/caching_with_rails.html) guide
@@ -263,6 +270,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)
@@ -272,7 +331,7 @@ and [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers):
 # spec/controllers/pages_controller_spec.rb
 describe PagesController, '#show' do
   %w(earn_money screencast about contact).each do |page|
-    context 'on GET to /pages/#{page}' do
+    context "on GET to /pages/#{page}" do
       before do
         get :show, id: page
       end
@@ -291,20 +350,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]!
+
+[CONTRIBUTING.md]: /CONTRIBUTING.md
+[contributors]: https://github.com/thoughtbot/high_voltage/graphs/contributors
 
-## Credits
+## License
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+High Voltage is copyright © 2009-2016 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/Rakefile

@@ -11,9 +11,14 @@ require 'appraisal'
 RSpec::Core::RakeTask.new(:spec)
 
 desc 'Default'
-task :default => [:all]
+task :default do
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    Rake::Task['spec'].invoke
+  else
+    Rake::Task['appraise'].invoke
+  end
+end
 
-desc 'Test the engine under all supported Rails versions'
-task all: ['appraisal:install'] do |t|
-  exec 'rake appraisal spec'
+task :appraise do
+  exec 'appraisal install && appraisal rake'
 end

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

@@ -6,28 +6,25 @@ 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
 
-    if respond_to?(:caches_action)
-      caches_action :show, layout: HighVoltage.action_caching_layout,
-        if: -> { HighVoltage.action_caching }
-    end
-
-    if respond_to?(:caches_page)
-      caches_page :show, if: -> { HighVoltage.page_caching }
-    end
-
-    hide_action :current_page, :page_finder, :page_finder_factory
+    rescue_from HighVoltage::InvalidPageIdError, with: :invalid_page
   end
 
   def show
     render template: current_page
   end
 
+  def invalid_page
+    raise ActionController::RoutingError, "No such page: #{params[:id]}"
+  end
+
+  private
+
   def current_page
     page_finder.find
   end

data/gemfiles/rails4.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec-rails", "~> 3.2"
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec-rails", "~> 3.2"
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails4.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec-rails", "~> 3.2"
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rspec-rails", "3.5.0.beta1"
+gem "rails", "~> 5.0.0.beta3"
+gem "rails-controller-testing"
+
+gemspec :path => "../"

data/high_voltage.gemspec

@@ -17,7 +17,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency("activesupport", ">= 3.1.0")
-  s.add_development_dependency("appraisal")
   s.add_development_dependency("pry")
-  s.add_development_dependency("rspec-rails")
 end

data/lib/high_voltage/configuration.rb

@@ -1,10 +1,5 @@
 module HighVoltage
   module Configuration
-    CACHING_DEPRECATION_WARNING = <<-WARNING.strip_heredoc.squish
-    Caching support has been deprecated and will be removed
-    in the next release.
-    WARNING
-
     attr_accessor(
       :content_path,
       :home_page,
@@ -14,8 +9,6 @@ module HighVoltage
       :routes,
     )
 
-    attr_reader :action_caching, :action_caching_layout, :page_caching
-
     def configure
       yield self
     end
@@ -24,26 +17,15 @@ module HighVoltage
       base.set_default_configuration
     end
 
-    def action_caching=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
-      @action_caching = value
+    def page_ids
+      HighVoltage::PageCollector.new(HighVoltage.full_path).page_ids
     end
 
-    def action_caching_layout=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
-      @action_caching_layout = value
-    end
-
-    def page_caching=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
-      @page_caching = value
+    def full_path
+      Rails.root.join("app", "views", HighVoltage.content_path)
     end
 
     def set_default_configuration
-      @action_caching = false
-      @action_caching_layout = true
-      @page_caching = false
-
       self.content_path = 'pages/'
       self.home_page = nil
       self.layout = 'application'

data/lib/high_voltage/constraints/root_route.rb

@@ -2,20 +2,27 @@ 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)
+      class << self
+        def matches?(request)
+          page_id = clean_page_path(request.path)
+          pattern = file_pattern(page_id)
 
-        Dir.glob(pattern).any?
-      end
+          Dir.glob(pattern).any?
+        end
 
-      private
+        private
 
-      def self.file_pattern(page_id)
-        "#{content_path}#{page_id}.html*"
-      end
+        def clean_page_path(request_path)
+          request_path.sub(/\.html$/, "")
+        end
+
+        def file_pattern(page_id)
+          "#{content_path}#{page_id}.html*"
+        end
 
-      def self.content_path
-        Rails.root.join('app', 'views', HighVoltage.content_path).to_s
+        def content_path
+          Rails.root.join("app", "views", HighVoltage.content_path).to_s
+        end
       end
     end
   end

data/lib/high_voltage/engine.rb

@@ -1,15 +1,22 @@
 module HighVoltage
   class Engine < Rails::Engine
-    initializer 'Set up default parent engine' do |app|
+    initializer "Set up default parent engine" do |app|
       HighVoltage.parent_engine ||= Rails.application
     end
 
-    initializer 'Require concerns path' do |app|
-      concerns_path = 'app/controllers/concerns'
+    initializer "Require concerns path" do |app|
+      concerns_path = "app/controllers/concerns"
 
       unless app.paths.keys.include?(concerns_path)
         app.paths.add(concerns_path)
       end
     end
+
+    initializer "Require for Rails 3" do |app|
+      if defined?(Rails) && Rails::VERSION::MAJOR == 3
+        require "concerns/high_voltage/static_page"
+        require "high_voltage/pages_controller"
+      end
+    end
   end
 end