rspec-sitemap-matchers 0.0.1

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Attila Györffy and Unboxed Consulting
+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,67 @@
+# RSpec sitemap matchers
+
+Sitemap [protocol](http://www.sitemaps.org/protocol.html) matchers for RSpec.
+
+Sitemaps are an easy way to inform search engines about pages on their sites that are available for crawling. In its simplest form, a Sitemap is an XML file that lists URLs for a site along with additional metadata about each URL (when it was last updated, how often it usually changes, and how important it is, relative to other URLs in the site) so that search engines can more intelligently crawl the site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-sitemap-matchers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-sitemap-matchers
+
+These matchers are not loaded by default in order not to pollute the global RSpec matcher namespace and consequentially to be able to specify in which context you would want to make use of them.
+
+You can load them globally via your `spec_helper` (not recommended):
+
+    RSpec.configure do |config|
+      config.include RSpec::Sitemap::Matchers
+    end
+
+… or `include RSpec::Sitemap::Matchers` in an individual spec file (preferred way).
+
+## Usage
+
+These matchers can be used on `File`s, `String`s and any arbitary `IO` instance that has a `:read` method:
+
+    describe "My Sitemap" do
+    
+      subject { File.open(Rails.root + 'tmp' + 'sitemap.xml') }
+
+      it { should include_url("http://www.example.com") }
+      it { should_not include_url("http://www.a-different-example.com") }
+
+    end
+
+The matchers also support more specific attribution matching, such as priorities as per the Sitemap protocol. These can be chained together:
+
+    it { should include_url('http://www.example.com').priority(0.5) }
+
+## Planned features
+
+* More chainable attribute modifiers, such as `lastmod` and `changefreq`
+* Stricter markup and structure validation
+* Encoding validation matcher (Sitemaps must be UTF-8 encoded)
+* `be_a_valid_sitemap` matcher
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write meaningful and readable tests
+4. Make the tests pass (ie implement your changes)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## Copyright
+
+Copyright © 2012 Attila Györffy and [Unboxed Consulting](http://www.unboxedconsulting.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rspec/sitemap/matchers.rb

@@ -0,0 +1,4 @@
+require 'nokogiri'
+
+require "rspec/sitemap/matchers/version"
+require "rspec/sitemap/matchers/include_url"

data/lib/rspec/sitemap/matchers/include_url.rb

@@ -0,0 +1,79 @@
+module RSpec::Sitemap::Matchers
+  class IncludeUrl
+    def initialize(expected_location)
+      @expected_location = expected_location
+    end
+
+    # @api private
+    def matches?(actual)
+      @actual = Nokogiri::XML(actual) { |config| config.noblanks }
+      @nodes = @actual.xpath(construct_xpath)
+      @nodes.any? && attributes_match?
+    end
+
+    def failure_message
+      [].tap do |messages|
+        messages << "expected #{@actual} to include a URL to #{@expected_location}"
+        unmatched_attributes.each { |attribute, actual_value|
+          if actual_value.nil?
+            messages << "with a #{attribute} of #{expected_attributes[attribute]} but the #{attribute} was not set"
+          else
+            messages << "with a #{attribute} of #{expected_attributes[attribute]} but it was set to #{actual_value}"
+          end
+        }
+      end.join(' ')
+    end
+
+    def priority(expected_priority)
+      expected_attributes.merge!(:priority => expected_priority)
+      self
+    end
+
+  private
+
+    def expected_attributes
+      @expected_attributes ||= {}
+    end
+
+    def attributes_match?
+      expected_attributes.all? do |key, value|
+        matched_node.xpath(".//xmlns:#{key}[text()='#{value}']").any?
+      end
+    end
+
+    def matched_attributes
+      attributes = {}
+      matched_node.children.each do |node|
+        attributes[node.name.to_sym] = node.text
+      end
+      attributes
+    end
+
+    def unmatched_attributes
+      # First of all we remove all the attributes that match the expected values
+      remaining_unmatched = expected_attributes.clone.delete_if do |key, expected_value|
+        matched_attributes[key] == expected_value
+      end
+      # Then setting the remaining unmatched attributes to match the actual values found
+      remaining_unmatched.each do |key, value|
+        remaining_unmatched[key] = matched_attributes[key]
+      end
+      remaining_unmatched
+    end
+
+    def matched_node
+      # Using the first node matched to a specified URL as it would not
+      # make sense to have ultiple URL nodes with the same location.
+      @nodes.first
+    end
+
+    def construct_xpath
+      "//xmlns:url/xmlns:loc[text()='#{@expected_location}']/.."
+    end
+
+  end
+
+  def include_url(url)
+    IncludeUrl.new(url)
+  end
+end

data/lib/rspec/sitemap/matchers/version.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Sitemap
+    module Matchers
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rspec-sitemap-matchers.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rspec/sitemap/matchers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Attila Györffy"]
+  gem.email         = ["attila.gyorffy@unboxedconsulting.com"]
+  gem.description   = %q{Sitemaps for RSpec}
+  gem.summary       = %q{Sitemap protocol matchers for RSpec}
+  gem.homepage      = "http://github.com/unboxed/rspec-sitemap-matchers"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rspec-sitemap-matchers"
+  gem.require_paths = ["lib"]
+  gem.version       = RSpec::Sitemap::Matchers::VERSION
+
+  gem.add_runtime_dependency('rspec')
+  gem.add_runtime_dependency('nokogiri')
+
+  gem.add_development_dependency 'rake'
+end

data/spec/rspec/sitemap/matchers/include_url_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+module RSpec::Sitemap::Matchers
+  describe IncludeUrl do
+    include RSpec::Sitemap::Matchers
+  
+    describe "#matches?" do
+
+      shared_examples_for "a matcher that passes or fails" do
+        it "passes" do
+          sitemap.should include_url('http://www.example.com')
+        end
+
+        it "fails" do
+          expect {
+            sitemap.should include_url('http://www.not-an-example.com')
+          }.to raise_error { |error|
+            error.message.should match("to include a URL to http://www.not-an-example.com")
+          }
+        end
+      end
+
+      context "on a File" do
+        it_should_behave_like "a matcher that passes or fails" do
+          let(:sitemap) { fixture('basic') }
+        end
+      end
+      
+      context "on a String" do
+        it_should_behave_like "a matcher that passes or fails" do
+          let(:sitemap) { fixture('basic').read }
+        end
+      end
+
+      context "on any IO object that has a :read method" do
+        before do
+          sitemap.stub(:read).and_return(fixture('basic').read)
+        end
+        
+        it_should_behave_like "a matcher that passes or fails" do
+          let(:sitemap) { mock('sitemap') }
+        end
+      end
+    end
+
+    describe "#priority" do
+      context "when it is set" do
+        let(:sitemap) { fixture('with_valid_priority') }
+        it "passes" do
+          sitemap.should include_url('http://www.example.com').priority('0.5')
+        end
+
+        it "fails" do
+          expect {
+            sitemap.should include_url('http://www.example.com').priority('0.8')
+          }.to raise_error { |error|
+            error.message.should match('to include a URL to http://www.example.com with a priority of 0.8 but it was set to 0.5')
+          }
+        end
+      end
+
+      context "when it is NOT set" do
+        let(:sitemap) { fixture('basic') }
+        it "fails" do
+          expect {
+            sitemap.should include_url('http://www.example.com').priority('0.5')
+          }.to raise_error { |error|
+            error.message.should match('to include a URL to http://www.example.com with a priority of 0.5 but the priority was not set')
+          }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rspec/sitemap/matchers'
+require 'support/fixture_helper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.include FixtureHelper
+end

data/spec/support/fixture_helper.rb

@@ -0,0 +1,5 @@
+module FixtureHelper
+  def fixture(type)
+    File.open(File.expand_path("../../support/fixtures/sitemaps/#{type}.xml", __FILE__))
+  end
+end

data/spec/support/fixtures/sitemaps/basic.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://www.example.com</loc>
+  </url>
+</urlset>

data/spec/support/fixtures/sitemaps/with_valid_priority.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://www.example.com</loc>
+    <priority>0.5</priority>
+  </url>
+</urlset>

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rspec-sitemap-matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Attila Györffy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sitemaps for RSpec
+email:
+- attila.gyorffy@unboxedconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec/sitemap/matchers.rb
+- lib/rspec/sitemap/matchers/include_url.rb
+- lib/rspec/sitemap/matchers/version.rb
+- rspec-sitemap-matchers.gemspec
+- spec/rspec/sitemap/matchers/include_url_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_helper.rb
+- spec/support/fixtures/sitemaps/basic.xml
+- spec/support/fixtures/sitemaps/with_valid_priority.xml
+homepage: http://github.com/unboxed/rspec-sitemap-matchers
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4581193510046784126
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4581193510046784126
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sitemap protocol matchers for RSpec
+test_files:
+- spec/rspec/sitemap/matchers/include_url_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_helper.rb
+- spec/support/fixtures/sitemaps/basic.xml
+- spec/support/fixtures/sitemaps/with_valid_priority.xml