middleman-search_engine_sitemap 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d6ccd1ba637f06ce4a5dedd39154b24a4b9079
-  data.tar.gz: eddcd8d0e1c1f38d3b568e450396a5ccb321d3bf
+  metadata.gz: 4164db2143eb8eb720c369f6afdf832256984bd7
+  data.tar.gz: 40aa7565fbb304a50cff7a570ef2a091f3e9f35c
 SHA512:
-  metadata.gz: 509ad95ca794f96b6667c0981a97d09f12d293a1e348bc70e04ee056558866261d262f154c7e930b1fec3d7fddf75e53f00bdabff40f32d2e7d152d4f43e1456
-  data.tar.gz: 8a6a95138e433a28387542bd2570e56f9578260949c22a051e2c67f973dfecac7cf526483ebe357650e137dff80162f8d8210fcf2bbd75ca9089ef0152d1ac8c
+  metadata.gz: 353eebf7471a31e5b6593ea93fc5d30e64e3220c008fce44ab950cea102deb0243d203962f89f72b73de797bf0cf782be7576520443428f95a6fb82f3f724bad
+  data.tar.gz: 89c2bf8f47763ace920328264586327e6b01d4cb2dbabaa6ff302536eda51e95bc68114f86e71811e9c699dc8dc2e0a6691d287677c94aef98975fce56a451f5

data/README.md

@@ -57,7 +57,7 @@ activate :search_engine_sitemap, exclude_attr: 'hidden'
 
 You would then be able to use `hidden: true` in place of `hide_from_sitemap: true`.
 
-### Settings
+## Settings
 
 Pages have a priority of 0.5 and a change frequency of `monthly` by default.
 
@@ -102,6 +102,17 @@ Possible values are: `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`,
 
 The default value is `monthly`.
 
+### Custom page exclusion
+
+You can also use `exclude_if` to exclude pages based on more complex requirements. For example:
+
+```ruby
+# Exclude all pages which have a date that's after today
+activate :search_engine_sitemap, exclude_if: ->(resource) {
+  resource.data.date && resource.data.date > Date.today
+}
+```
+
 ### Customising the URL
 
 Sometimes, you might want to perform some processing the URL:

data/lib/middleman/search_engine_sitemap.rb

@@ -12,6 +12,7 @@ module Middleman
       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'
+      option :exclude_if, ->(resource) { false }
 
       def after_configuration
         register_extension_templates
@@ -44,7 +45,7 @@ module Middleman
       end
 
       def not_excluded?(resource)
-        !resource.ignored? && !resource.data[options.exclude_attr]
+        !resource.ignored? && !resource.data[options.exclude_attr] && !options.exclude_if.call(resource)
       end
 
       def page_ext

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

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

data/lib/middleman/search_engine_sitemap/version.rb

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

data/spec/dummy/source/ignored-by-proc.html

@@ -0,0 +1,3 @@
+---
+ignored_by_proc: true
+---

data/spec/features/sitemap_feature_spec.rb

@@ -91,4 +91,19 @@ describe "Search engine sitemaps", :feature do
     'changefreq' => 'monthly'
     )
   end
+
+  it "ignores resources based on exclude_if result" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :search_engine_sitemap,
+        exclude_if: ->(resource) { resource.data.ignored_by_proc }
+
+      ignore '/ignored.html'
+    end
+
+    visit '/sitemap.xml'
+    doc = Nokogiri::XML(last_response.body)
+
+    expect(doc.to_s).not_to include('http://example.com/ignored-by-proc.html')
+  end
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search_engine_sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Pete Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2014-11-29 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
@@ -116,6 +116,7 @@ files:
 - spec/dummy/source/about.html
 - spec/dummy/source/blog.html
 - spec/dummy/source/home.html
+- spec/dummy/source/ignored-by-proc.html
 - spec/dummy/source/ignored-in-frontmatter.html
 - spec/dummy/source/ignored.html
 - spec/dummy/source/layouts/layout.erb
@@ -133,17 +134,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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Adds a sitemap.xml file to your Middleman site for search engines.
@@ -151,6 +152,7 @@ test_files:
 - spec/dummy/source/about.html
 - spec/dummy/source/blog.html
 - spec/dummy/source/home.html
+- spec/dummy/source/ignored-by-proc.html
 - spec/dummy/source/ignored-in-frontmatter.html
 - spec/dummy/source/ignored.html
 - spec/dummy/source/layouts/layout.erb