middleman-sitemap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 794ac84510f4da06044e9db6407660b1bbeea74e
+  data.tar.gz: 99cbee50bebadacedad2ef096639b3f17e56c863
+SHA512:
+  metadata.gz: 83589b2674c20bafeb03c3d1b9c399ab1cbedca92b0dfc0455813803e1a94d2f3c701a8bcbcb9b8313d224ffca6d3b4db6188c2a3efc01ab01afb9f684dee6af
+  data.tar.gz: 20a02c5c1b6becb936757b0c2327d37cd0ab8fbd1fc464b3fdcc1fa7f57497bfb7566190140e1708b53c798fee95c0698ba5941c0eb0e7cb868d949c59ead615

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore tmp
+/tmp
+
+# Ignore vendor
+/vendor
+.bundle

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+
+script: "bundle exec rake test"

data/Gemfile

@@ -0,0 +1,19 @@
+# If you have OpenSSL installed, we recommend updating
+# the following line to use "https"
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in middleman-sitemap.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'fivemat'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Larry Staton Jr.
+
+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,74 @@
+# Middleman-Sitemap
+
+`middleman-sitemap` is an extension for the [Middleman] static site generator that adds sitemap functionality. By default, the sitemap is GZIP'd.
+
+## Installation
+
+If you're just getting started, install the `middleman` gem and generate a new project:
+
+```
+gem install middleman
+middleman init MY_PROJECT
+```
+
+If you already have a Middleman project: Add `gem "middleman-sitemap"` to your `Gemfile` and run `bundle install`
+
+## Configuration
+
+```
+activate :sitemap
+```
+
+## Options
+
+### GZIP
+
+GZIP is on by default, so the extension will produce a sitemap.xml.gz file in addition to the sitemap.xml file.
+
+If you don't want to create a GZIP file, pass `false` during activation.
+
+```
+activate :sitemap, :gzip => false
+```
+
+### Hostname
+
+The default hostname is set to "http://www.example.com". You probably want to change this to your hostname.
+
+```
+activate :sitemap, :hostname => "http://www.apple.com"
+```
+
+
+## Build & Dependency Status
+
+[![Build Status](https://travis-ci.org/statonjr/middleman-sitemap.png)][travis]
+
+## Community
+
+The official community forum is available at: http://forum.middlemanapp.com
+
+## Bug Reports
+
+Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems: https://github.com/middleman/middleman-blog/issues
+
+The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit [Pull Requests](https://help.github.com/articles/using-pull-requests) containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
+
+## How to Run Cucumber Tests
+
+1. Checkout Repository: `git clone https://github.com/statonjr/middleman-sitemap.git`
+2. Install Bundler: `gem install bundler`
+3. Run `bundle install` inside the project root to install the gem dependencies.
+4. Run test cases: `bundle exec rake test`
+
+## Donate
+
+[Click here to lend your support to Middleman](https://spacebox.io/s/4dXbHBorC3)
+
+## License
+
+Copyright (c) 2014 Larry Staton Jr. MIT Licensed, see [LICENSE] for details.
+
+[middleman]: http://middlemanapp.com
+[travis]: http://travis-ci.org/statonjr/middleman-sitemap
+[LICENSE]: https://github.com/statonjr/middleman-sitemap/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task :test => ['cucumber']
+
+task :default => :test

data/features/gzip.feature

@@ -0,0 +1,28 @@
+Feature: GZIP sitemap build
+
+  Scenario: Sitemap should be gzipped by default
+    Given a successfully built app at "gzip-app"
+    Then the following files should exist:
+      | build/sitemap.xml.gz |
+      | build/sitemap.xml |
+
+  Scenario: Sitemap should not be gzipped when option set to false
+    Given a fixture app "gzip-app"
+    And a file named "config.rb" with:
+      """
+      activate :sitemap, :gzip => false
+      """
+    And a successfully built app at "gzip-app"
+    When I cd to "build"
+    Then the following files should not exist:
+      | build/sitemap.xml.gz |
+
+Scenario: Sitemap should not be gzipped when option set to false
+  Given a fixture app "gzip-app"
+  And a file named "config.rb" with:
+    """
+    activate :sitemap, :hostname => "http://www.apple.com"
+    """
+  And a successfully built app at "gzip-app"
+  When I cd to "build"
+  Then the file "sitemap.xml" should contain "http://www.apple.com"

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-sitemap')

data/fixtures/gzip-app/config.rb

@@ -0,0 +1 @@
+activate :sitemap

data/fixtures/gzip-app/source/something.html

@@ -0,0 +1,5 @@
+---
+priority: 0.7
+changefreq: daily
+---
+something

data/lib/middleman-sitemap.rb

@@ -0,0 +1,44 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+class Sitemap < ::Middleman::Extension
+  option :gzip, true, 'Whether or not to GZIP the resulting file'
+  option :hostname, "http://www.example.com", "The hostname for your website"
+
+  def initialize(app, options_hash={}, &block)
+    # Call super to build options from the options_hash
+    super
+
+    # Require libraries only when activated
+    # require 'necessary/library'
+
+    # set up your extension
+    # puts options.my_option
+  end
+
+  def after_build
+    require 'erb'
+    @pages = app.sitemap.resources.find_all{ |p| p.source_file.match(/\.html/) }
+    @hostname = options.hostname
+    template = Tilt::ERBTemplate.new(File.expand_path(File.join("#{File.dirname(__FILE__)}", "../templates/sitemap.xml.erb")))
+    sitemap = template.render(self)
+    outfile = File.join(app.build_dir, "sitemap.xml")
+    File.open(outfile, 'w') {|f| f.write(sitemap) }
+    if options.gzip
+      gzip_file(File.read(outfile))
+    end
+  end
+
+  def gzip_file(sitemap)
+    require 'zlib'
+    File.open(File.join(@app.build_dir, "sitemap.xml.gz"), 'wb') do |f|
+      gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
+      gz.write sitemap
+      gz.close
+    end
+  end
+
+end
+
+::Middleman::Extensions.register(:sitemap, Sitemap)

data/lib/middleman_extension.rb

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

data/middleman-sitemap.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-sitemap"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Larry Staton Jr."]
+  s.email       = ["larry@larrystaton.com"]
+  s.homepage    = "http://bitbucket.org/statonjr/middleman-sitemap"
+  s.summary     = %q{Builds a sitemap.xml for your site}
+  s.description = %q{Builds a sitemap.xml for your site}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.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.2.2"])
+
+end

data/templates/sitemap.xml.erb

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<% @pages.each do |p| %>
+  <url>
+    <loc><%= @hostname %><%= p.url.gsub(/\/$/, '') %></loc>
+    <lastmod><%= Date.today.to_time.iso8601 %></lastmod>
+    <changefreq><%= p.data.changefreq || 'weekly' %></changefreq>
+    <priority><%= p.data.priority || '0.5' %></priority>
+  </url>
+<% end %>
+</urlset>

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: middleman-sitemap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Larry Staton Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+description: Builds a sitemap.xml for your site
+email:
+- larry@larrystaton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/gzip.feature
+- features/support/env.rb
+- fixtures/gzip-app/config.rb
+- fixtures/gzip-app/source/index.html
+- fixtures/gzip-app/source/javascripts/test.js
+- fixtures/gzip-app/source/something.html
+- fixtures/gzip-app/source/stylesheets/test.css
+- lib/middleman-sitemap.rb
+- lib/middleman_extension.rb
+- middleman-sitemap.gemspec
+- templates/sitemap.xml.erb
+homepage: http://bitbucket.org/statonjr/middleman-sitemap
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Builds a sitemap.xml for your site
+test_files:
+- features/gzip.feature
+- features/support/env.rb
+has_rdoc: