middleman-search_engine_sitemap 1.0.1 → 1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4706cd09a6993f06326a3bbdd0d72e92c6a57f70
-  data.tar.gz: 273f1b9b18575a93d59a3bd2ecf74976d7181542
+  metadata.gz: b3b58083244aa3f27819c34c0e6025e0746116d0
+  data.tar.gz: 548c765f5c78920a45ac94422bae157ad4e6afe7
 SHA512:
-  metadata.gz: f9a59d58b24e6aee83c09270038350d8422037f5183136441b54ae38ec016506fa6f7806ace33e7ec8663c794561c6c0ab09fc1ba77ca95c65b2014fd90e9b74
-  data.tar.gz: 5879500523aee627a9253875529e1f5a6e0dd9ff1c1660467c9ec37415299017f4792efe5ae19a1d84c2dd7d6728c2b525d3e05b87c364c26f2adde4e9eef882
+  metadata.gz: 5504652ca4c7661a1ef4018e0c4f61f88b207ebf85c839e0241221694d889e404757f45ea3f6b55c7280ef167b59caf210a4b4da050ff1cb71a00487dbe4ec7c
+  data.tar.gz: ccbfeb3dd221018e47829c1af11063c739093da9a3d77babbcc1b556c949b7f6127f5c43b3eaf96aab28618e5c4bab5fbaab288fb0a3dc5b42a8ffd75c5ffeff

data/README.md

@@ -3,6 +3,8 @@
 [![Build Status](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap.png?branch=master)](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap)
 [![Code Climate](https://codeclimate.com/github/Aupajo/middleman-search_engine_sitemap.png)](https://codeclimate.com/github/Aupajo/middleman-search_engine_sitemap)
 [![Dependency Status](https://gemnasium.com/Aupajo/middleman-search_engine_sitemap.svg)](https://gemnasium.com/Aupajo/middleman-search_engine_sitemap)
+[![Gem
+Version](https://badge.fury.io/rb/middleman-search_engine_sitemap.svg)](http://badge.fury.io/rb/middleman-search_engine_sitemap)
 
 [Sitemaps](http://www.sitemaps.org/) are an open standard to tell search engines (such as Google) about each page on your site, how often they're updated, and how important each page is, relative to other pages on your site.
 
@@ -38,6 +40,27 @@ activate :search_engine_sitemap
 
 The sitemap will become available at [http://localhost:4567/sitemap.xml](http://localhost:4567/sitemap.xml).
 
+## Excluding pages
+
+You can add a `hide_from_sitemap` attribute to your page's frontmatter to omit it from the sitemap:
+
+```erb
+---
+title: My hidden page
+hide_from_sitemap: true
+---
+
+Shh. Don't tell anyone I'm here.
+```
+
+If you would like to use a different frontmatter attribute, you can specify it in the extension options:
+
+```ruby
+activate :search_engine_sitemap, exclude_attr: 'hidden'
+```
+
+You would then be able to use `hidden: true` in place of `hide_from_sitemap: true`.
+
 ### Settings
 
 Pages have a priority of 0.5 and a change frequency of `monthly` by default.

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

@@ -1,6 +1,6 @@
 xml.instruct!
 xml.urlset 'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9' do
-  sitemap.resources.select { |page| page.path.end_with?('.html') }.each do |page|
+  resources_for_sitemap.each do |page|
     xml.url do
       xml.loc File.join(url_root, page.url)
       xml.lastmod File.mtime(page.source_file).iso8601

data/lib/middleman/search_engine_sitemap/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module SearchEngineSitemap
-    VERSION = "1.0.1"
+    VERSION = "1.1.0.pre"
   end
 end

data/lib/middleman/search_engine_sitemap.rb

@@ -10,6 +10,7 @@ module Middleman
       option :default_priority, 0.5, 'Default page priority for search engine sitemap'
       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'
 
       def after_configuration
         register_extension_templates
@@ -19,8 +20,32 @@ module Middleman
         resources << sitemap_resource
       end
 
+      def resource_in_sitemap?(resource)
+        is_page?(resource) && not_excluded?(resource)
+      end
+
+      helpers do
+        def resources_for_sitemap
+          sitemap.resources.select do |resource|
+            extensions[:search_engine_sitemap].resource_in_sitemap?(resource)
+          end
+        end
+      end
+
       private
 
+      def is_page?(resource)
+        resource.path.end_with?(page_ext)
+      end
+
+      def not_excluded?(resource)
+        !resource.ignored? && !resource.data[options.exclude_attr]
+      end
+
+      def page_ext
+        File.extname(app.index_file)
+      end
+
       def register_extension_templates
         # We call reload_path to register the templates directory with Middleman.
         # The path given to app.files must be relative to the Middleman site's root.

data/spec/dummy/source/ignored-in-frontmatter.html

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

data/spec/features/sitemap_feature_spec.rb

@@ -4,10 +4,12 @@ require 'nokogiri'
 describe "Search engine sitemaps", :feature do
   include XmlHelpers
 
-  it "produces a sitemap" do
+  it "produces a valid sitemap" do
     run_site 'dummy' do
       set :url_root, 'http://example.com'
       activate :search_engine_sitemap
+      
+      ignore '/ignored.html'
     end
 
     visit '/sitemap.xml'
@@ -33,6 +35,9 @@ describe "Search engine sitemaps", :feature do
       'priority'   => '0.5',
       'changefreq' => 'daily'
     )
+
+    expect(doc.to_s).not_to include('http://example.com/ignored.html')
+    expect(doc.to_s).not_to include('http://example.com/ignored-in-frontmatter.html')
   end
 
   it "works with directory indexes" do
@@ -40,6 +45,8 @@ describe "Search engine sitemaps", :feature do
       set :url_root, 'http://example.com'
       activate :directory_indexes
       activate :search_engine_sitemap
+
+      ignore '/ignored.html'
     end
 
     visit '/sitemap.xml'
@@ -62,5 +69,8 @@ describe "Search engine sitemaps", :feature do
       'priority'   => '0.5',
       'changefreq' => 'daily'
     )
+
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search_engine_sitemap
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0.pre
 platform: ruby
 authors:
 - Pete Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -116,6 +116,8 @@ files:
 - spec/dummy/source/about.html
 - spec/dummy/source/blog.html
 - spec/dummy/source/home.html
+- spec/dummy/source/ignored-in-frontmatter.html
+- spec/dummy/source/ignored.html
 - spec/dummy/source/layouts/layout.erb
 - spec/features/sitemap_feature_spec.rb
 - spec/spec_helper.rb
@@ -136,9 +138,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -149,6 +151,8 @@ test_files:
 - spec/dummy/source/about.html
 - spec/dummy/source/blog.html
 - spec/dummy/source/home.html
+- spec/dummy/source/ignored-in-frontmatter.html
+- spec/dummy/source/ignored.html
 - spec/dummy/source/layouts/layout.erb
 - spec/features/sitemap_feature_spec.rb
 - spec/spec_helper.rb