middleman-search_engine_sitemap 1.0.0.rc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7129a08b5e62d5c403c2f259a09a412f78505e1
+  data.tar.gz: 92665355ff2df8644df9a824931963eadb5defd2
+SHA512:
+  metadata.gz: 101d3144f9547fd7eda5568f7456d7982328b30bcffd3f9ee5bd6e274de64b4a14e0e913fd4398f9708b9fc6ba7925e441c43b7589bdf474832f482ed27ff7cc
+  data.tar.gz: 82922fcf9f4361b6b9e753971cff429994cfd0c4c7fbeed18b2833b5b3627ab68de08f5f2ae24478e11246027e0e59fbc9f96c4c84d9554178f82a0c1f0cee90

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Nicholls
+
+MIT License
+
+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,59 @@
+# Middleman Search Engine Sitemap
+
+[![Build Status](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap.png?branch=master)](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap)
+
+Adds a sitemap.xml file (following the sitemaps.org protocol) to your Middleman site for major search engines including Google.
+
+## Installation
+
+TODO: Write installation instructions
+
+## Usage
+
+Inside your `config.rb`:
+
+```ruby
+set :url_root, 'http://example.com'
+
+activate :search_engine_sitemap
+```
+
+Pages have a priority of 0.5 and a change frequency of "monthly" by default.
+
+You can change this by passing in options:
+
+```ruby
+activate :search_engine_sitemap, default_priority: 0.5,
+                                 default_change_frequency: "monthly",
+                                 sitemap_xml_path: "sitemap.xml"
+```
+
+You can override the priority or change frequency on page by using frontmatter:
+
+```erb
+---
+title: Blog
+priority: 1.0
+change_frequency: daily
+---
+
+Welcome to my blog!
+```
+
+### On priority
+
+From [sitemaps.org](http://www.sitemaps.org/protocol.html):
+
+> Valid values range from 0.0 to 1.0. **This value does not affect how your pages are compared to pages on other sites**–it only lets the search engines know which pages you deem most important for the crawlers.
+
+> Please note that the priority you assign to a page is not likely to influence the position of your URLs in a search engine's result pages. Search engines may use this information when selecting between URLs on the same site, so you can use this tag to increase the likelihood that your most important pages are present in a search index.
+
+> Also, please note that assigning a high priority to all of the URLs on your site is not likely to help you. Since the priority is relative, it is only used to select between URLs on your site.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/middleman-search_engine_sitemap/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

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-search_engine_sitemap.rb

@@ -0,0 +1,2 @@
+# Handle Middleman's require strategy
+require 'middleman/search_engine_sitemap'

data/lib/middleman/search_engine_sitemap.rb

@@ -0,0 +1,59 @@
+require "middleman-core"
+require "middleman/search_engine_sitemap/version"
+require "builder"
+
+module Middleman
+  module SearchEngineSitemap
+    TEMPLATES_DIR = File.expand_path(File.join('..', 'search_engine_sitemap', 'templates'), __FILE__)
+
+    class Extension < Middleman::Extension
+      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'
+
+      def before_configuration
+        register_extension_templates
+      end
+
+      def manipulate_resource_list(resources)
+        resources << sitemap_resource
+      end
+
+      private
+
+      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_resource
+        source_file = template('sitemap.xml.builder')
+
+        Middleman::Sitemap::Resource.new(app.sitemap, sitemap_xml_path, source_file).tap do |resource|
+          resource.add_metadata(options: { layout: false }, locals: sitemap_locals)
+        end
+      end
+
+      def sitemap_locals
+        {
+          default_priority: options.default_priority,
+          default_change_frequency: options.default_change_frequency
+        }
+      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
+
+      def sitemap_xml_path
+        options.sitemap_xml_path
+      end
+    end
+  end
+end
+
+::Middleman::Extensions.register(:search_engine_sitemap, ::Middleman::SearchEngineSitemap::Extension)

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

@@ -0,0 +1,11 @@
+xml.instruct!
+xml.urlset 'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9' do
+  sitemap.resources.select { |page| page.path =~ /\.html/ }.each do |page|
+    xml.url do
+      xml.loc File.join(url_root, page.path)
+      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

data/lib/middleman/search_engine_sitemap/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module SearchEngineSitemap
+    VERSION = "1.0.0.rc"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+# Auto-register extension for Middleman

data/middleman-search_engine_sitemap.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman/search_engine_sitemap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-search_engine_sitemap"
+  spec.version       = Middleman::SearchEngineSitemap::VERSION
+  spec.authors       = ["Pete Nicholls"]
+  spec.email         = ["pete@metanation.com"]
+  spec.summary       = %q{Adds a sitemap.xml file to your Middleman site for search engines.}
+  spec.description   = %q{Adds a sitemap.xml file (following the sitemaps.org protocol) to your Middleman site for major search engines including Google.}
+  spec.homepage      = "https://github.com/Aupajo/middleman-search_engine_sitemap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_runtime_dependency "middleman-core", "~> 3.2.0"
+  spec.add_runtime_dependency "builder"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "nokogiri"
+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/blog.html

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

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

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

data/spec/features/sitemap_feature_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe "Search engine sitemaps", :feature do
+  include XmlHelpers
+
+  it "produces a sitemap" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+
+      activate :search_engine_sitemap
+    end
+
+    visit '/sitemap.xml'
+    
+    schema = File.expand_path('../../../sitemap.xsd', __FILE__)
+    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'
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+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|
+  # Will be the default in RSpec 3
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.include MiddlemanServerHelpers, :feature
+end

data/spec/support/middleman_server_helpers.rb

@@ -0,0 +1,42 @@
+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 pagination 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,51 @@
+module XmlHelpers
+  extend RSpec::Matchers::DSL
+
+  matcher :validate_against_schema do |schema|
+    @schema = schema
+
+    match do |actual|
+      xsd = Nokogiri::XML::Schema(File.read(@schema))
+      @validation_errors = xsd.validate(actual)
+      @validation_errors.empty?
+    end
+
+    failure_message_for_should 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_for_should 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,158 @@
+--- !ruby/object:Gem::Specification
+name: middleman-search_engine_sitemap
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc
+platform: ruby
+authors:
+- Pete Nicholls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !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
+  Middleman site for major search engines including Google.
+email:
+- pete@metanation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-search_engine_sitemap.rb
+- lib/middleman/search_engine_sitemap.rb
+- lib/middleman/search_engine_sitemap/templates/sitemap.xml.builder
+- lib/middleman/search_engine_sitemap/version.rb
+- lib/middleman_extension.rb
+- middleman-search_engine_sitemap.gemspec
+- sitemap.xsd
+- spec/dummy/source/about.html
+- spec/dummy/source/blog.html
+- spec/dummy/source/home.html
+- spec/dummy/source/layouts/layout.erb
+- 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/Aupajo/middleman-search_engine_sitemap
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.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/blog.html
+- spec/dummy/source/home.html
+- spec/dummy/source/layouts/layout.erb
+- spec/features/sitemap_feature_spec.rb
+- spec/spec_helper.rb
+- spec/support/middleman_server_helpers.rb
+- spec/support/xml_helpers.rb