high_voltage 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfdb165dc9944d13d14ccfcfab0358c2d575b688
-  data.tar.gz: 769e4a05d918743c86ce21f58b4ab2ea3d8bc838
+  metadata.gz: 56801929181e1df1b48361637a33d0e49431827f
+  data.tar.gz: e5e8b40606fd4863b423cd682ae3bc0426d11af2
 SHA512:
-  metadata.gz: e036c73851faf23320d6b5fccbd8c65cacdb73e736422e0df062cdea64ea8c6a88d26bfc084403a979955eeb695e82d4bc89fdcdd6905516dd7adf85734425b7
-  data.tar.gz: 29b92c7a8e76d78f6084bfbc6987d5022af4a048461eaff10192d32e94bdd217b41ca27e9ac1c42a38e70fae0603519075cba4e7d2f0a9cc78dc5b4ddaf11206
+  metadata.gz: 7baeff6c124d223bbe28962a65ad6fcfdddc7a505c15dd63c6fb0e52530508809c03acee1bc37bd10f65e36aea1d430ef714d00518c38370941d9fc397eaa3f6
+  data.tar.gz: c9dd536f08b5ce08cf6ae7a479e3e4f99556d117611656c7ce795843046627f87da726bb5a83163a6a4131968a8081fbc637b89015d76f41daad9c4fab79d167

data/.gitignore

@@ -4,3 +4,4 @@ pkg/
 *.swp
 *.gem
 gemfiles/*.lock
+spec/fixtures/log/*.log

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    high_voltage (2.3.0)
+    high_voltage (2.4.0)
 
 GEM
   remote: http://rubygems.org/
@@ -95,3 +95,6 @@ DEPENDENCIES
   high_voltage!
   pry
   rspec-rails (~> 3.2.0)
+
+BUNDLED WITH
+   1.10.0

data/NEWS.md

@@ -1,3 +1,8 @@
+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

data/README.md

@@ -15,7 +15,7 @@ Yeah, like "About us", "Directions", marketing pages, etc.
 Include in your Gemfile:
 
 ```ruby
-gem 'high_voltage', '~> 2.3.0`
+gem 'high_voltage', '~> 2.3.0'
 ```
 
 For Rails versions prior to 3.0, use the 0.9.2 tag of high_voltage:
@@ -43,6 +43,17 @@ link_to 'Q4 Reports', page_path('about/corporate/policies/HR/en_US/biz/sales/Qua
 
 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

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/lib/high_voltage/configuration.rb

@@ -25,20 +25,34 @@ module HighVoltage
     end
 
     def action_caching=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      unless value == false
+        ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      end
       @action_caching = value
     end
 
     def action_caching_layout=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      unless value == false
+        ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      end
       @action_caching_layout = value
     end
 
     def page_caching=(value)
-      ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      unless value == false
+        ActiveSupport::Deprecation.warn(CACHING_DEPRECATION_WARNING)
+      end
       @page_caching = value
     end
 
+    def page_ids
+      HighVoltage::PageCollector.new(HighVoltage.full_path).page_ids
+    end
+
+    def full_path
+      Rails.root.join("app", "views", HighVoltage.content_path)
+    end
+
     def set_default_configuration
       @action_caching = false
       @action_caching_layout = true

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,7 +27,11 @@ 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

data/lib/high_voltage/version.rb

@@ -1,3 +1,3 @@
 module HighVoltage
-  VERSION = "2.3.0".freeze
+  VERSION = "2.4.0".freeze
 end

data/spec/fake_app.rb

@@ -6,13 +6,10 @@ end
 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
+    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/high_voltage/configuration_spec.rb

@@ -35,42 +35,87 @@ describe HighVoltage::Configuration do
     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)
+  describe "#action_caching" do
+    context "action caching is enabled" do
+      it 'displays a deprecation warning' do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
 
-      HighVoltage.configure do |config|
-        config.action_caching = true
+        HighVoltage.configure do |config|
+          config.action_caching = true
+        end
+
+        expect(ActiveSupport::Deprecation).to have_received(:warn)
+          .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
       end
+    end
+
+    context "action caching is disabled" do
+      it 'does not display a deprecation warning' do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
+
+        HighVoltage.configure do |config|
+          config.action_caching = false
+        end
 
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+        expect(ActiveSupport::Deprecation).not_to have_received(:warn)
+          .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+      end
     end
   end
 
-  describe '#action_caching_layout=' do
-    it 'displays a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
+  describe "#action_caching_layout" do
+    context "action caching layout is enabled" do
+      it 'displays a deprecation warning' do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
 
-      HighVoltage.configure do |config|
-        config.action_caching_layout = true
+        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
 
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+    context "action caching layout is disabled" do
+      it "does not display a deprecation warning" do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
+
+        HighVoltage.configure do |config|
+          config.action_caching_layout = false
+        end
+
+        expect(ActiveSupport::Deprecation).not_to have_received(:warn)
+          .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+      end
     end
   end
 
-  describe '#page_caching=' do
-    it 'displays a deprecation warning' do
-      allow(ActiveSupport::Deprecation).to receive(:warn)
+  describe "#page_caching" do
+    context "page caching is enabled" do
+      it "displays a deprecation warning" do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
 
-      HighVoltage.configure do |config|
-        config.page_caching = true
+        HighVoltage.configure do |config|
+          config.page_caching = true
+        end
+
+        expect(ActiveSupport::Deprecation).to have_received(:warn)
+          .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
       end
+    end
+
+    context "page caching is disbled" do
+      it "does not display a deprecation warning" do
+        allow(ActiveSupport::Deprecation).to receive(:warn)
 
-      expect(ActiveSupport::Deprecation).to have_received(:warn)
-        .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+        HighVoltage.configure do |config|
+          config.page_caching = false
+        end
+
+        expect(ActiveSupport::Deprecation).not_to have_received(:warn)
+          .with(HighVoltage::Configuration::CACHING_DEPRECATION_WARNING)
+      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

@@ -47,6 +47,10 @@ describe HighVoltage::PageFinder do
     end
   end
 
+  it "throws an exception if the path is empty" do
+    expect { find("關於我們/合作伙伴") }.to raise_error HighVoltage::InvalidPageIdError
+  end
+
   private
 
   def find(page_id)

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: high_voltage
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Matt Jankowski
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,8 @@ files:
 - lib/high_voltage/configuration.rb
 - lib/high_voltage/constraints/root_route.rb
 - lib/high_voltage/engine.rb
+- lib/high_voltage/page.rb
+- lib/high_voltage/page_collector.rb
 - lib/high_voltage/page_finder.rb
 - lib/high_voltage/route_drawers/default.rb
 - lib/high_voltage/route_drawers/root.rb
@@ -105,6 +107,7 @@ files:
 - spec/fixtures/app/views/other_pages/also_dir/also_nested.html.erb
 - spec/fixtures/app/views/other_pages/also_exists.html.erb
 - spec/fixtures/app/views/other_pages/also_exists_but_references_nonexistent_partial.html.erb
+- spec/fixtures/app/views/pages/_partial.html.erb
 - spec/fixtures/app/views/pages/also_dir/also_nested.html.erb
 - spec/fixtures/app/views/pages/also_exists.html.erb
 - spec/fixtures/app/views/pages/also_exists_but_references_nonexistent_partial.html.erb
@@ -112,11 +115,14 @@ files:
 - spec/fixtures/app/views/pages/exists.html.erb
 - spec/fixtures/app/views/pages/exists_but_references_nonexistent_partial.html.erb
 - spec/fixtures/app/views/pages/rot13.html.erb
+- spec/fixtures/app/views/pages/text.txt.erb
 - spec/fixtures/config/database.yml
 - spec/fixtures/config/routes.rb
 - spec/fixtures/public/pages/exists.html
 - spec/high_voltage/configuration_spec.rb
+- spec/high_voltage/page_collector_spec.rb
 - spec/high_voltage/page_finder_spec.rb
+- spec/high_voltage/page_spec.rb
 - spec/high_voltage_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/minimal_spec_helper.rb
@@ -163,6 +169,7 @@ test_files:
 - spec/fixtures/app/views/other_pages/also_dir/also_nested.html.erb
 - spec/fixtures/app/views/other_pages/also_exists.html.erb
 - spec/fixtures/app/views/other_pages/also_exists_but_references_nonexistent_partial.html.erb
+- spec/fixtures/app/views/pages/_partial.html.erb
 - spec/fixtures/app/views/pages/also_dir/also_nested.html.erb
 - spec/fixtures/app/views/pages/also_exists.html.erb
 - spec/fixtures/app/views/pages/also_exists_but_references_nonexistent_partial.html.erb
@@ -170,11 +177,14 @@ test_files:
 - spec/fixtures/app/views/pages/exists.html.erb
 - spec/fixtures/app/views/pages/exists_but_references_nonexistent_partial.html.erb
 - spec/fixtures/app/views/pages/rot13.html.erb
+- spec/fixtures/app/views/pages/text.txt.erb
 - spec/fixtures/config/database.yml
 - spec/fixtures/config/routes.rb
 - spec/fixtures/public/pages/exists.html
 - spec/high_voltage/configuration_spec.rb
+- spec/high_voltage/page_collector_spec.rb
 - spec/high_voltage/page_finder_spec.rb
+- spec/high_voltage/page_spec.rb
 - spec/high_voltage_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/minimal_spec_helper.rb