middleman-sitemap-xml-generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39126624d004b40536c5f31beb3f23fa8fe821ad
+  data.tar.gz: 0b9325923fc546edb658fdc6bd2b0a3bf14346d3
+SHA512:
+  metadata.gz: 82829eda0cd378195d7cb5e5df2ce21a5c61502803c9f682c6cb0772c3b90d2b21d95b95a9df7ebde0fbeab4c39c82465b06581a55e032a38ad3aee0cfba4dc0
+  data.tar.gz: 57e007bebf44470378ca5af854e2b810136d15221b64285b037389860be421120ef8d87a541103316c5c62bc83c5feadb39762f346bb13f959c81dccebd2d6fe

data/.gitignore

@@ -0,0 +1,10 @@
+# Ignore bundler lock file
+Gemfile.lock
+
+# Ignore pkg folder
+pkg
+
+.bundle
+tmp
+spec/reports
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-search_engine_sitemap.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+(c) 2016 AT-AT
+
+Original:
+Copyright (c) 2014 Pete Nicholls
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,197 @@
+# Middleman-Sitemap-Xml-Generator
+
+
+This extension is a forked and slightly extended version of [Middleman Search Engine Sitemap by Pete Nicholls](https://github.com/Aupajo/middleman-search_engine_sitemap).
+
+Note that this extension has been forked from the release [tagged as v1.3.0](https://github.com/Aupajo/middleman-search_engine_sitemap/releases/tag/v1.3.0) to support Middleman-v3.
+
+Please refer to [the original](https://github.com/Aupajo/middleman-search_engine_sitemap) if you want to get the latest release or a version for Middleman-v4.
+
+
+### Why forked from v1.3.0?
+
+Because I'm not be planning to use Middleman-v4 yet. 8-)
+
+
+## Installation
+
+Add the following line to the Gemfile of your Middleman project:
+
+```ruby
+gem 'middleman-sitemap-xml-generator'
+```
+
+Then as usual, run:
+
+```sh
+bundle install
+```
+
+
+## Usage
+
+To activate and configure this extension, add the following configuration block to Middleman's config.rb:
+
+```ruby
+set :url_root, 'http://example.com'
+activate :sitemap_xml_generator
+```
+
+
+### Options
+
+| Option             | Default                | Description
+| ---                | ---                    | ---
+| default_changefreq | 'monthly'              | Default page priority
+| default_priority   | 0.5                    | Default page priority
+| sitemap_xml_path   | 'sitemap.xml'          | Path to the sitemap.xml
+| exclude_attr       | 'hide_from_sitemap'    | Attribute in `Frontmatter` to exclude from the sitemap
+| process_url        | nil                    | Callable object(responds to #call) to process a URL
+| process_changefreq | nil                    | Callable object to determine a changefreq
+| process_priority   | nil                    | Callable object to determine a priority
+| exclude_if         | ->(resource) { false } | Callable object to exclude from the sitemap
+| extra_ext          | []                     | Extensions allowed to be in the sitemap<br>(needed prefixed "dot")
+| discard_ext        | []                     | Extensions removed from "loc" tag<br>(needed prefixed "dot")
+
+
+## Determination of "changefreq" and "priority"
+
+A value of `changefreq` and `priority` in the sitemap.xml is determined in the following priority.
+
+1. **(Higher)** `Frontmatter` attributes in each file
+
+    ```yaml
+    ---
+    changefreq: daily
+    priority: 1.0
+    ---
+    ```
+
+1. Processing in a `process_changefreq` and a `process_priority` option
+
+    ```ruby
+    activate :sitemap_xml_generator do |f|
+      f.process_changefreq = ->(path, default) {
+        path.end_with?('.foo') ? 'yearly' : default
+      }
+      f.process_priority = ->(path, default) {
+        path.end_with?('.foo') ? 0.9 : default
+      }
+    end
+    ```
+
+    | Argument | Description
+    | ---      | ---
+    | path     | A path prefixed "/" from **Web** root. e.g. `/foo.html`
+    | default  | The same value as `default_changefreq` or `default_priority`
+
+1. **(Lower)** A value in a `default_changefreq` and a `default_priority` option
+
+
+## Excluding pages
+
+
+### Specify in Frontmatter
+
+You can add a `hide_from_sitemap` attribute to `Frontmatter` in the page which is omitted from the sitemap.xml:
+
+```yaml
+---
+hide_from_sitemap: true
+---
+```
+
+If you would like to use a different `Frontmatter` attribute, you can specify it in a `exclude_attr` option:
+
+```ruby
+activate :sitemap_xml_generator do |f|
+  f.exclude_attr = 'invisible'
+end
+```
+
+Then you can omit a page the following way:
+
+```yaml
+---
+invisible: true
+---
+```
+
+
+### Use custom processor
+
+You can also use a `exclude_if` option to exclude pages based on conditions you want:
+
+```ruby
+# Exclude all pages which have a date that's after today
+activate :sitemap_xml_generator do |f|
+  f.exclude_if = ->(resource) {
+    resource.data.date && resource.data.date > Date.today
+  }
+end
+```
+
+| Argument | Description
+| ---      | ---
+| resource | A resource object (`Middleman::Sitemap::Resource`)
+
+
+## Processing a URL in "loc" tag
+
+You can use a `process_url` option to process a URL in "loc" tag in each page in the sitemap.xml:
+
+```ruby
+# This Proc removes a trailing slash from a URL in all "loc" tag.
+activate :sitemap_xml_generator do |f|
+  f.process_url = ->(url) { url.chomp('/') }
+end
+```
+
+| Argument | Description
+| ---      | ---
+| url      | The URL of each page
+
+
+## Adding file in addition to HTML
+
+Only HTML file is added to the sitemap.xml with the default setting.
+
+You can use a `extra_ext` option to add any file to the sitemap.xml:
+
+```ruby
+# This setting adds every file suffixed ".foo" to the sitemap.xml.
+activate :sitemap_xml_generator do |f|
+  f.extra_ext = ['.foo'] # prefixed dot is required.
+end
+```
+
+
+## Excluding a content extension
+
+You can use a `discard_ext` option to exclude a content extension from a address in "loc" tag in the sitemap.xml:
+
+```ruby
+# This setting removes suffixed ".foo" from "loc" tag in the sitemap.xml.
+activate :sitemap_xml_generator do |f|
+  f.discard_ext = ['.foo'] # prefixed dot is required.
+end
+```
+
+Note that this process is executed before the process designated in a `process_url` option.
+
+
+## Workaround for the template reference issue
+
+This extension deals with that [issue](https://github.com/Aupajo/middleman-search_engine_sitemap/issues/5) by [this workaround](https://github.com/Aupajo/middleman-search_engine_sitemap/issues/2#issuecomment-46701165).
+
+
+## Thanks
+
+All ideas, logics, hints and prizes belong to the original author, Pete Nicholls.
+
+And all mistakes belong to me.
+
+
+## License
+
+(c) 2016 AT-AT. MIT Licensed, see [LICENSE](LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/middleman-sitemap-xml-generator.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+::Middleman::Extensions.register(:sitemap_xml_generator) do
+  require 'middleman-sitemap-xml-generator/extension'
+  ::Middleman::SitemapXmlGenerator::Extension
+end

data/lib/middleman-sitemap-xml-generator/extension.rb

@@ -0,0 +1,168 @@
+module Middleman
+  module SitemapXmlGenerator
+    class Extension < ::Middleman::Extension
+      option :default_changefreq, 'monthly', 'Default page priority'
+      option :default_priority, 0.5, 'Default page priority'
+      option :sitemap_xml_path, 'sitemap.xml', 'Path to the sitemap.xml'
+      option :exclude_attr, 'hide_from_sitemap', 'Attribute in Frontmatter to exclude from sitemap'
+      option :process_url, nil, 'Callable object(responds to #call) to process a URL'
+      option :process_changefreq, nil, 'Callable object to determine a changefreq'
+      option :process_priority, nil, 'Callable object to determine a priority'
+      option :exclude_if, ->(resource) { false }, 'Callable object to exclude from the sitemap'
+      option :extra_ext, [], 'Extensions allowed to be in the sitemap(needed prefixed "dot")'
+      option :discard_ext, [], 'Extensions removed from "loc" in the sitemap(needed prefixed "dot")'
+
+      TEMPLATES_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+
+      def initialize(app, options_hash={}, &block)
+        super
+
+        require 'builder'
+      end
+
+
+      public
+
+
+      #
+      # Hooks
+      #
+
+      def after_configuration
+        register_extension_templates
+        prepare_extra_ext_opt
+        prepare_discard_ext_opt
+        watch_vendor_directory
+      end
+
+      def manipulate_resource_list(resources)
+        resources << sitemap_resource
+      end
+
+
+      #
+      # Helpers
+      #
+
+      def resource_in_sitemap?(resource)
+        is_page?(resource) && not_excluded?(resource)
+      end
+
+      def process_changefreq(path)
+        default = options.default_changefreq
+        options.process_changefreq ? options.process_changefreq.call(path, default) : default
+      end
+
+      def process_priority(path)
+        default = options.default_priority
+        options.process_priority ? options.process_priority.call(path, default) : default
+      end
+
+      def process_url(path)
+        path = process_extension path
+        options.process_url ? options.process_url.call(path) : path
+      end
+
+      helpers do
+        def resources_for_sitemap
+          sitemap.resources.select do |resource|
+            extensions[:sitemap_xml_generator].resource_in_sitemap?(resource)
+          end
+        end
+      end
+
+
+      #
+      # Internals
+      #
+
+      private
+
+      def allowed_ext?(resource)
+        options.extra_ext.include? File.extname(resource.path)
+      end
+
+      def filter_valid_extension(value)
+        [value].flatten.select { |ext| ext.match /^\.[^.]+/ }
+      end
+
+      def generate_processor(method_name)
+        self.class.instance_method(method_name.to_sym).bind(self)
+      end
+
+      def is_page?(resource)
+        resource.path.end_with?(page_ext) || allowed_ext?(resource)
+      end
+
+      def not_excluded?(resource)
+        !resource.ignored? \
+          && !resource.data[options.exclude_attr] && !options.exclude_if.call(resource)
+      end
+
+      def page_ext
+        File.extname(app.index_file)
+      end
+
+      def prepare_extra_ext_opt
+        options.extra_ext = filter_valid_extension options.extra_ext
+      end
+
+      def prepare_discard_ext_opt
+        options.discard_ext = filter_valid_extension options.discard_ext
+      end
+
+      def process_extension(path)
+        target_ext = File.extname path
+        if options.discard_ext.include?(target_ext)
+          path = File.join(File.dirname(path), File.basename(path, target_ext))
+        end
+        path
+      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.
+        templates_dir_relative_from_root = \
+          Pathname(TEMPLATES_DIR).relative_path_from(Pathname(app.root))
+        app.files.reload_path(templates_dir_relative_from_root)
+      end
+
+      def sitemap_locals
+        {
+          url_proc: generate_processor(:process_url),
+          changefreq_proc: generate_processor(:process_changefreq),
+          priority_proc: generate_processor(:process_priority)
+        }
+      end
+
+      def sitemap_resource
+        source_file = template('sitemap.xml.builder')
+
+        ::Middleman::Sitemap::Resource.new(app.sitemap, sitemap_xml_path, source_file).tap do |res|
+          res.add_metadata(options: { layout: false }, locals: sitemap_locals)
+        end
+      end
+
+      def sitemap_xml_path
+        options.sitemap_xml_path
+      end
+
+      def template(path)
+        full_path = File.join(TEMPLATES_DIR, path)
+        raise "Template #{full_path} not found" if !File.exist?(full_path)
+        full_path
+      end
+
+      # Workaround for the template reference issue. See below:
+      #   https://github.com/Aupajo/middleman-search_engine_sitemap/issues/5
+      #   https://github.com/Aupajo/middleman-search_engine_sitemap/issues/2#issuecomment-46701165
+      def watch_vendor_directory
+        app.config[:file_watcher_ignore] = (app.config[:file_watcher_ignore].reject do |regexp|
+          regexp == /^vendor(\/|$)/
+        end)
+      end
+
+    end
+  end
+end

data/lib/middleman-sitemap-xml-generator/templates/sitemap.xml.builder

@@ -0,0 +1,11 @@
+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 url_proc.call(File.join(url_root, page.url))
+      xml.lastmod(File.mtime(page.source_file).iso8601) if page.source_file
+      xml.changefreq page.data.changefreq || changefreq_proc.call(page.url)
+      xml.priority page.data.priority || priority_proc.call(page.url)
+    end
+  end
+end

data/lib/middleman-sitemap-xml-generator/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module SitemapXmlGenerator
+    VERSION = '1.0.0'
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-sitemap-xml-generator'

data/middleman-sitemap-xml-generator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 'middleman-sitemap-xml-generator/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'middleman-sitemap-xml-generator'
+  s.version       = Middleman::SitemapXmlGenerator::VERSION
+  s.authors       = ['AT-AT']
+  s.email         = ['dec.alpha21264@gmail.com']
+  s.homepage      = 'https://github.com/AT-AT/middleman-sitemap-xml-generator'
+  s.summary       = %q{Adds a sitemap.xml file to your Middleman site for search engines.}
+  s.description   = %q{Adds a sitemap.xml file to your Middleman site for search engines.}
+  s.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\0")
+  s.test_files    = `git ls-files -- {test,spec,features,fixtures}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency 'middleman-core', '~> 3.4.1'
+  s.add_runtime_dependency 'builder'
+
+  # Additional dependencies
+  s.add_development_dependency 'bundler', '~> 1.5'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'nokogiri', '1.6.3'
+end

data/sitemap.xsd

@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            targetNamespace="http://www.sitemaps.org/schemas/sitemap/0.9"
+            xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+            elementFormDefault="qualified">
+  <xsd:annotation>
+    <xsd:documentation>
+      XML Schema for Sitemap files.
+      Last Modifed 2008-03-26
+    </xsd:documentation>
+  </xsd:annotation>
+
+  <xsd:element name="urlset">
+    <xsd:annotation>
+      <xsd:documentation>
+        Container for a set of up to 50,000 document elements.
+        This is the root element of the XML file.
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:complexType>
+      <xsd:sequence>
+        <xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="strict"/>
+        <xsd:element name="url" type="tUrl" maxOccurs="unbounded"/>
+      </xsd:sequence>
+    </xsd:complexType>
+  </xsd:element>
+
+  <xsd:complexType name="tUrl">
+    <xsd:annotation>
+      <xsd:documentation>
+        Container for the data needed to describe a document to crawl.
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:sequence>
+      <xsd:element name="loc" type="tLoc"/>
+      <xsd:element name="lastmod" type="tLastmod" minOccurs="0"/>
+      <xsd:element name="changefreq" type="tChangeFreq" minOccurs="0"/>
+      <xsd:element name="priority" type="tPriority" minOccurs="0"/>
+      <xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="strict"/>
+    </xsd:sequence>
+  </xsd:complexType>
+
+  <xsd:simpleType name="tLoc">
+    <xsd:annotation>
+      <xsd:documentation>
+        REQUIRED: The location URI of a document.
+        The URI must conform to RFC 2396 (http://www.ietf.org/rfc/rfc2396.txt).
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:restriction base="xsd:anyURI">
+      <xsd:minLength value="12"/>
+      <xsd:maxLength value="2048"/>
+    </xsd:restriction>
+  </xsd:simpleType>
+
+  <xsd:simpleType name="tLastmod">
+    <xsd:annotation>
+      <xsd:documentation>
+        OPTIONAL: The date the document was last modified. The date must conform
+        to the W3C DATETIME format (http://www.w3.org/TR/NOTE-datetime).
+        Example: 2005-05-10
+        Lastmod may also contain a timestamp.
+        Example: 2005-05-10T17:33:30+08:00
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:union>
+      <xsd:simpleType>
+        <xsd:restriction base="xsd:date"/>
+      </xsd:simpleType>
+      <xsd:simpleType>
+        <xsd:restriction base="xsd:dateTime"/>
+      </xsd:simpleType>
+    </xsd:union>
+  </xsd:simpleType>
+
+  <xsd:simpleType name="tChangeFreq">
+    <xsd:annotation>
+      <xsd:documentation>
+        OPTIONAL: Indicates how frequently the content at a particular URL is
+        likely to change. The value "always" should be used to describe
+        documents that change each time they are accessed. The value "never"
+        should be used to describe archived URLs. Please note that web
+        crawlers may not necessarily crawl pages marked "always" more often.
+        Consider this element as a friendly suggestion and not a command.
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:restriction base="xsd:string">
+      <xsd:enumeration value="always"/>
+      <xsd:enumeration value="hourly"/>
+      <xsd:enumeration value="daily"/>
+      <xsd:enumeration value="weekly"/>
+      <xsd:enumeration value="monthly"/>
+      <xsd:enumeration value="yearly"/>
+      <xsd:enumeration value="never"/>
+    </xsd:restriction>
+  </xsd:simpleType>
+
+  <xsd:simpleType name="tPriority">
+    <xsd:annotation>
+      <xsd:documentation>
+        OPTIONAL: The priority of a particular URL relative to other pages
+        on the same site. The value for this element is a number between
+        0.0 and 1.0 where 0.0 identifies the lowest priority page(s).
+        The default priority of a page is 0.5. Priority is used to select
+        between pages on your site. Setting a priority of 1.0 for all URLs
+        will not help you, as the relative priority of pages on your site
+        is what will be considered.
+      </xsd:documentation>
+    </xsd:annotation>
+    <xsd:restriction base="xsd:decimal">
+      <xsd:minInclusive value="0.0"/>
+      <xsd:maxInclusive value="1.0"/>
+    </xsd:restriction>
+  </xsd:simpleType>
+
+</xsd:schema>

data/spec/dummy/source/about.html

@@ -0,0 +1,3 @@
+---
+priority: 0.2
+---

data/spec/dummy/source/allowed-extra-ext.bar

@@ -0,0 +1,2 @@
+---
+---

data/spec/dummy/source/allowed-extra-ext.foo

@@ -0,0 +1,4 @@
+---
+changefreq: daily
+priority: 0.2
+---

data/spec/dummy/source/blog.html

@@ -0,0 +1,3 @@
+---
+changefreq: daily
+---

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

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

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

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

data/spec/dummy/source/layouts/layout.erb

@@ -0,0 +1 @@
+Layout

data/spec/dummy/source/removed-ext-remained.bar

@@ -0,0 +1,4 @@
+---
+changefreq: daily
+priority: 0.2
+---

data/spec/dummy/source/removed-ext.html

@@ -0,0 +1,4 @@
+---
+changefreq: daily
+priority: 0.2
+---

data/spec/dummy/source/removed-extra-ext.foo

@@ -0,0 +1,4 @@
+---
+changefreq: daily
+priority: 0.2
+---

data/spec/dummy/source/values_by_proc.foo

@@ -0,0 +1,2 @@
+---
+---

data/spec/features/sitemap_feature_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'nokogiri'
+require 'pathname'
+
+describe "Generate sitemap.xml", :feature do
+  include XmlHelpers
+
+  it "produces a valid sitemap" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :sitemap_xml_generator
+
+      ignore '/ignored.html'
+    end
+
+    visit '/sitemap.xml'
+
+    schema = Pathname(__dir__) + '../../sitemap.xsd'
+    doc = Nokogiri::XML(last_response.body)
+    expect(doc).to validate_against_schema(schema)
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/home.html',
+      'priority'   => '0.5',
+      'changefreq' => 'monthly'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/about.html',
+      'priority'   => '0.2',
+      'changefreq' => 'monthly'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/blog.html',
+      '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
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :directory_indexes
+      activate :sitemap_xml_generator
+
+      ignore '/ignored.html'
+    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'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/about/',
+      'priority'   => '0.2',
+      'changefreq' => 'monthly'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/blog/',
+      '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
+
+  it "supports custom URL processing" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :directory_indexes
+      activate :sitemap_xml_generator, 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
+
+  it "ignores resources based on exclude_if result" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :sitemap_xml_generator,
+        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
+
+  it "allows resources having a extension which is designated in the option" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :sitemap_xml_generator,
+        extra_ext: ['.foo', 'bar']
+    end
+
+    visit '/sitemap.xml'
+    doc = Nokogiri::XML(last_response.body)
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/allowed-extra-ext.foo',
+      'priority'   => '0.2',
+      'changefreq' => 'daily'
+    )
+
+    expect(doc.to_s).not_to include('http://example.com/allowed-extra-ext.bar')
+  end
+
+  it "removes designated extention from resources" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :sitemap_xml_generator,
+        extra_ext: ['.foo', '.bar'],
+        discard_ext: ['.html', '.foo', 'bar']
+    end
+
+    visit '/sitemap.xml'
+    doc = Nokogiri::XML(last_response.body)
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/removed-ext',
+      'priority'   => '0.2',
+      'changefreq' => 'daily'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/removed-extra-ext',
+      'priority'   => '0.2',
+      'changefreq' => 'daily'
+    )
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/removed-ext-remained.bar',
+      'priority'   => '0.2',
+      'changefreq' => 'daily'
+    )
+  end
+
+  it "set values by procs" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :sitemap_xml_generator,
+        extra_ext: ['.foo'],
+        process_changefreq: ->(path, default){
+          path.end_with?('.foo') ? 'yearly' : default
+        },
+        process_priority: ->(path, default){
+          path.end_with?('.foo') ? 0.9 : default
+        }
+    end
+
+    visit '/sitemap.xml'
+    doc = Nokogiri::XML(last_response.body)
+
+    expect(doc).to contain_node('url').with_children(
+      'loc'        => 'http://example.com/values_by_proc.foo',
+      'priority'   => '0.9',
+      'changefreq' => 'yearly'
+    )
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+# Include support files
+support_files_pattern = File.expand_path('../support/**/*.rb', __FILE__)
+Dir.glob(support_files_pattern).each { |f| require f }
+
+RSpec.configure do |config|
+  config.include MiddlemanServerHelpers, :feature
+end

data/spec/support/middleman_server_helpers.rb

@@ -0,0 +1,41 @@
+require 'middleman/rack'
+require 'rack/test'
+
+module MiddlemanServerHelpers
+  include Rack::Test::Methods
+
+  def app
+    @app.call
+  end
+
+  def visit(path)
+    get(path)
+    raise last_response.errors if !last_response.errors.empty?
+  end
+
+  def find_on_page(string)
+    expect(last_response.body).to include(string)
+  end
+
+  def run_site(path, &block)
+    setup_environment(path)
+
+    @app = lambda do
+      instance = Middleman::Application.server.inst do
+        # Require the extension after the server has booted, as would typically happen.
+        require File.expand_path('../../../lib/middleman_extension', __FILE__)
+
+        instance_exec(&block)
+      end
+
+      instance.class.to_rack_app
+    end
+  end
+
+  private
+
+  def setup_environment(path)
+    ENV['MM_ROOT'] = File.expand_path("../../#{path}", __FILE__)
+    ENV['TEST'] = "true"
+  end
+end

data/spec/support/xml_helpers.rb

@@ -0,0 +1,49 @@
+module XmlHelpers
+  extend RSpec::Matchers::DSL
+
+  matcher :validate_against_schema do |schema|
+    match do |actual|
+      xsd = Nokogiri::XML::Schema(schema.read)
+      @validation_errors = xsd.validate(actual)
+      @validation_errors.empty?
+    end
+
+    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" +
+        @validation_errors.each_with_index.map do |error, i|
+          "  #{i + 1}. #{error}"
+        end.join("\n")
+    end
+  end
+
+  matcher :contain_node do |name|
+    match do |doc|
+      if @attributes
+        doc.css(name).detect do |node|
+          @attributes.all? { |k, v| node.css(k).text == v }
+        end
+      else
+        doc.at_css(name)
+      end
+    end
+
+    chain :with_children do |attributes|
+      @attributes = attributes
+    end
+
+    failure_message do |doc|
+      expected_xml = "<#{name}>\n"
+
+      if @attributes
+        @attributes.each { |k,v| expected_xml << "  <#{k}>#{v}</#{k}>\n" }
+      end
+
+      expected_xml << "</#{name}>"
+
+      "expected XML to contain:\n\n#{expected_xml}\n\ninstead got:\n\n#{doc.to_s}"
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: middleman-sitemap-xml-generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- AT-AT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-15 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.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !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: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+description: Adds a sitemap.xml file to your Middleman site for search engines.
+email:
+- dec.alpha21264@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/middleman-sitemap-xml-generator.rb
+- lib/middleman-sitemap-xml-generator/extension.rb
+- lib/middleman-sitemap-xml-generator/templates/sitemap.xml.builder
+- lib/middleman-sitemap-xml-generator/version.rb
+- lib/middleman_extension.rb
+- middleman-sitemap-xml-generator.gemspec
+- sitemap.xsd
+- spec/dummy/source/about.html
+- spec/dummy/source/allowed-extra-ext.bar
+- spec/dummy/source/allowed-extra-ext.foo
+- 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
+- spec/dummy/source/removed-ext-remained.bar
+- spec/dummy/source/removed-ext.html
+- spec/dummy/source/removed-extra-ext.foo
+- spec/dummy/source/values_by_proc.foo
+- spec/features/sitemap_feature_spec.rb
+- spec/spec_helper.rb
+- spec/support/middleman_server_helpers.rb
+- spec/support/xml_helpers.rb
+homepage: https://github.com/AT-AT/middleman-sitemap-xml-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds a sitemap.xml file to your Middleman site for search engines.
+test_files:
+- spec/dummy/source/about.html
+- spec/dummy/source/allowed-extra-ext.bar
+- spec/dummy/source/allowed-extra-ext.foo
+- 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
+- spec/dummy/source/removed-ext-remained.bar
+- spec/dummy/source/removed-ext.html
+- spec/dummy/source/removed-extra-ext.foo
+- spec/dummy/source/values_by_proc.foo
+- spec/features/sitemap_feature_spec.rb
+- spec/spec_helper.rb
+- spec/support/middleman_server_helpers.rb
+- spec/support/xml_helpers.rb