middleman-search_engine_sitemap 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae627731f21974a3a2e38d52098652c47040b6be
-  data.tar.gz: 73712986634d22b38e255cc312d75f5458ab4e81
+  metadata.gz: 82d6ccd1ba637f06ce4a5dedd39154b24a4b9079
+  data.tar.gz: eddcd8d0e1c1f38d3b568e450396a5ccb321d3bf
 SHA512:
-  metadata.gz: 1e71619fa7b3443298bb0c4d1d63eb9069cc3269f9330f5dc984ae927fb86db416287b8f1ff03e066eb88e20d41384f353f6002fa929ee97bd31ef072dc9cef4
-  data.tar.gz: ef3cbab203d35d618eef89da51e0e7c186009eead3b072a6cd643959bf5481f16525f50a14e612e357a3618158635a703404171dd1c1422787e13c5362a4364e
+  metadata.gz: 509ad95ca794f96b6667c0981a97d09f12d293a1e348bc70e04ee056558866261d262f154c7e930b1fec3d7fddf75e53f00bdabff40f32d2e7d152d4f43e1456
+  data.tar.gz: 8a6a95138e433a28387542bd2570e56f9578260949c22a051e2c67f973dfecac7cf526483ebe357650e137dff80162f8d8210fcf2bbd75ca9089ef0152d1ac8c

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.1.1
+  - 2.1.2
+  - 2.1.5

data/README.md

@@ -24,10 +24,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install middleman-search_engine_sitemap
-
 ## Usage
 
 Place the following inside your `config.rb`:
@@ -65,6 +61,8 @@ You would then be able to use `hidden: true` in place of `hide_from_sitemap: tru
 
 Pages have a priority of 0.5 and a change frequency of `monthly` by default.
 
+### Specifying priority and change frequency for a page
+
 You can change these values by passing in options to the `activate` directive:
 
 ```ruby
@@ -72,8 +70,6 @@ activate :search_engine_sitemap, default_priority: 0.5,
                                  default_change_frequency: "monthly"
 ```
 
-### Specifying priority and change frequency for a page
-
 You can override the priority or change frequency for a particular page by using frontmatter:
 
 ```erb
@@ -106,6 +102,18 @@ Possible values are: `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`,
 
 The default value is `monthly`.
 
+### Customising the URL
+
+Sometimes, you might want to perform some processing the URL:
+
+```ruby
+activate :search_engine_sitemap, process_url: -> (url) { url.chomp('/') }
+```
+
+The example above would remove a trailing slash from a URL.
+
+The value passed into `process_url` is any object that responds to `call`.
+
 ## Contributing
 
 1. Fork it ( http://github.com/Aupajo/middleman-search_engine_sitemap/fork )

data/lib/middleman/search_engine_sitemap.rb

@@ -11,6 +11,7 @@ module Middleman
       option :default_change_frequency, 'monthly', 'Default page priority for search engine sitemap'
       option :sitemap_xml_path, 'sitemap.xml', 'Path to search engine sitemap'
       option :exclude_attr, 'hide_from_sitemap'
+      option :process_url, nil, 'Proc for processing a URL'
 
       def after_configuration
         register_extension_templates
@@ -24,6 +25,10 @@ module Middleman
         is_page?(resource) && not_excluded?(resource)
       end
 
+      def process_url(url)
+        options.process_url ? options.process_url.call(url) : url
+      end
+
       helpers do
         def resources_for_sitemap
           sitemap.resources.select do |resource|
@@ -81,4 +86,4 @@ module Middleman
   end
 end
 
-::Middleman::Extensions.register(:search_engine_sitemap, ::Middleman::SearchEngineSitemap::Extension)
+::Middleman::Extensions.register(:search_engine_sitemap, ::Middleman::SearchEngineSitemap::Extension)

data/lib/middleman/search_engine_sitemap/templates/sitemap.xml.builder

@@ -2,10 +2,10 @@ xml.instruct!
 xml.urlset 'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9' do
   resources_for_sitemap.each do |page|
     xml.url do
-      xml.loc File.join(url_root, page.url)
+      xml.loc extensions[:search_engine_sitemap].process_url(File.join(url_root, page.url))
       xml.lastmod File.mtime(page.source_file).iso8601
       xml.changefreq page.data.change_frequency || default_change_frequency
       xml.priority page.data.priority || default_priority
     end
   end
-end
+end

data/lib/middleman/search_engine_sitemap/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module SearchEngineSitemap
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/features/sitemap_feature_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'nokogiri'
+require 'pathname'
 
 describe "Search engine sitemaps", :feature do
   include XmlHelpers
@@ -8,13 +9,13 @@ describe "Search engine sitemaps", :feature do
     run_site 'dummy' do
       set :url_root, 'http://example.com'
       activate :search_engine_sitemap
-      
+
       ignore '/ignored.html'
     end
 
     visit '/sitemap.xml'
-    
-    schema = File.expand_path('../../../sitemap.xsd', __FILE__)
+
+    schema = Pathname(__dir__) + '../../sitemap.xsd'
     doc = Nokogiri::XML(last_response.body)
     expect(doc).to validate_against_schema(schema)
 
@@ -73,4 +74,21 @@ describe "Search engine sitemaps", :feature do
     expect(doc.to_s).not_to include('http://example.com/ignored/')
     expect(doc.to_s).not_to include('http://example.com/ignored-in-frontmatter/')
   end
-end
+
+  it "supports custom URL processing" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :directory_indexes
+      activate :search_engine_sitemap, process_url: ->(url) { url.upcase }
+    end
+
+    visit '/sitemap.xml'
+    doc = Nokogiri::XML(last_response.body)
+
+    expect(doc).to contain_node('url').with_children(
+    'loc'        => 'HTTP://EXAMPLE.COM/HOME/',
+    'priority'   => '0.5',
+    'changefreq' => 'monthly'
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -7,8 +7,5 @@ support_files_pattern = File.expand_path('../support/**/*.rb', __FILE__)
 Dir.glob(support_files_pattern).each { |f| require f }
 
 RSpec.configure do |config|
-  # Will be the default in RSpec 3
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-
   config.include MiddlemanServerHelpers, :feature
-end
+end

data/spec/support/xml_helpers.rb

@@ -2,19 +2,17 @@ module XmlHelpers
   extend RSpec::Matchers::DSL
 
   matcher :validate_against_schema do |schema|
-    @schema = schema
-
     match do |actual|
-      xsd = Nokogiri::XML::Schema(File.read(@schema))
+      xsd = Nokogiri::XML::Schema(schema.read)
       @validation_errors = xsd.validate(actual)
       @validation_errors.empty?
     end
 
-    failure_message_for_should do |actual|
+    failure_message do |actual|
       num_errors = @validation_errors.length
       error_count = "#{num_errors} error#{'s' if num_errors > 1}"
 
-      "expected XML to validate against #{@schema}, got #{error_count}:\n" +
+      "expected XML to validate against #{schema}, got #{error_count}:\n" +
         @validation_errors.each_with_index.map do |error, i|
           "  #{i + 1}. #{error}"
         end.join("\n")
@@ -36,7 +34,7 @@ module XmlHelpers
       @attributes = attributes
     end
 
-    failure_message_for_should do |doc|
+    failure_message do |doc|
       expected_xml = "<#{name}>\n"
 
       if @attributes
@@ -48,4 +46,4 @@ module XmlHelpers
       "expected XML to contain:\n\n#{expected_xml}\n\ninstead got:\n\n#{doc.to_s}"
     end
   end
-end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search_engine_sitemap
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Pete Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Adds a sitemap.xml file (following the sitemaps.org protocol) to your
@@ -102,8 +102,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,17 +133,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Adds a sitemap.xml file to your Middleman site for search engines.