middleman-search_engine_sitemap 1.0.0.rc → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7129a08b5e62d5c403c2f259a09a412f78505e1
-  data.tar.gz: 92665355ff2df8644df9a824931963eadb5defd2
+  metadata.gz: a708a284c7a60e8ddd971f9f7c9e3753f3b347ac
+  data.tar.gz: cf8301d6a3c9f1466428affc4be879b3f859e466
 SHA512:
-  metadata.gz: 101d3144f9547fd7eda5568f7456d7982328b30bcffd3f9ee5bd6e274de64b4a14e0e913fd4398f9708b9fc6ba7925e441c43b7589bdf474832f482ed27ff7cc
-  data.tar.gz: 82922fcf9f4361b6b9e753971cff429994cfd0c4c7fbeed18b2833b5b3627ab68de08f5f2ae24478e11246027e0e59fbc9f96c4c84d9554178f82a0c1f0cee90
+  metadata.gz: c8e32be778fb3ea11b6eae752c6dca5ec4f23652d797c4b1ba630cd81138d3a87bd539de094e8e1cd17a9919ee0ff2ba9ac1410a13a05d00db591d8063d4b95f
+  data.tar.gz: 3818a199d1856ed6e6efc3582f815231a88328be24aac6c67723a967f454d7e5ab4a9da8bbcf612291b21110e0aa974b682e763af6e5ac6e65b895a1caab5932

data/README.md

@@ -1,12 +1,29 @@
 # 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)
+[![Code Climate](https://codeclimate.com/github/Aupajo/middleman-search_engine_sitemap.png)](https://codeclimate.com/github/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.
+[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.
+
+This project aims to simplify including the sitemap XML file along with your Middleman site, so that you can better instruct search engines on how to index your pages.
+
+For more information on the standard itself, please visit http://www.sitemaps.org/.
 
 ## Installation
 
-TODO: Write installation instructions
+Add this line to your Middleman site's Gemfile:
+
+```ruby
+gem 'middleman-search_engine_sitemap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-search_engine_sitemap
 
 ## Usage
 
@@ -18,17 +35,16 @@ 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.
+Pages have a priority of 0.5 and a change frequency of `monthly` by default.
 
-You can change this by passing in options:
+You can change these values by passing in options to the `activate` directive:
 
 ```ruby
 activate :search_engine_sitemap, default_priority: 0.5,
-                                 default_change_frequency: "monthly",
-                                 sitemap_xml_path: "sitemap.xml"
+                                 default_change_frequency: "monthly"
 ```
 
-You can override the priority or change frequency on page by using frontmatter:
+You can override the priority or change frequency on particular pages by using frontmatter:
 
 ```erb
 ---
@@ -40,7 +56,11 @@ change_frequency: daily
 Welcome to my blog!
 ```
 
-### On priority
+### Priority
+
+A number between 0.0 and 1.0, representing how important the page is, relevant to other pages on your site.
+
+The default value is 0.5.
 
 From [sitemaps.org](http://www.sitemaps.org/protocol.html):
 
@@ -50,6 +70,12 @@ From [sitemaps.org](http://www.sitemaps.org/protocol.html):
 
 > 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.
 
+### Change Frequency
+
+Possible values are: `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, `never`.
+
+The default value is `monthly`.
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/middleman-search_engine_sitemap/fork )

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

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

data/lib/middleman/search_engine_sitemap/version.rb

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

data/lib/middleman/search_engine_sitemap.rb

@@ -11,7 +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'
 
-      def before_configuration
+      def after_configuration
         register_extension_templates
       end
 

data/spec/features/sitemap_feature_spec.rb

@@ -7,7 +7,6 @@ describe "Search engine sitemaps", :feature do
   it "produces a sitemap" do
     run_site 'dummy' do
       set :url_root, 'http://example.com'
-
       activate :search_engine_sitemap
     end
 
@@ -35,4 +34,33 @@ describe "Search engine sitemaps", :feature do
       'changefreq' => 'daily'
     )
   end
+
+  it "works with directory indexes" do
+    run_site 'dummy' do
+      set :url_root, 'http://example.com'
+      activate :directory_indexes
+      activate :search_engine_sitemap
+    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'
+    )
+  end
 end

data/spec/support/middleman_server_helpers.rb

@@ -24,7 +24,7 @@ module MiddlemanServerHelpers
       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__)
+        require File.expand_path('../../../lib/middleman/search_engine_sitemap', __FILE__)
 
         instance_exec(&block)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-search_engine_sitemap
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc
+  version: 1.0.0
 platform: ruby
 authors:
 - Pete Nicholls
@@ -108,11 +108,9 @@ files:
 - 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
@@ -138,9 +136,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.1

data/lib/middleman-search_engine_sitemap.rb

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

data/lib/middleman_extension.rb

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