sitemap_generator_ftbpro 5.0.4

data/spec/sitemap_generator/utilities_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe SitemapGenerator::Utilities do
+
+  describe "assert_valid_keys" do
+    it "should raise error on invalid keys" do
+      lambda {
+        SitemapGenerator::Utilities.assert_valid_keys({ :name => "Rob", :years => "28" }, :name, :age)
+      }.should raise_exception(ArgumentError)
+      lambda {
+        SitemapGenerator::Utilities.assert_valid_keys({ :name => "Rob", :age => "28" }, "name", "age")
+      }.should raise_exception(ArgumentError)
+    end
+
+    it "should not raise error on valid keys" do
+      lambda {
+        SitemapGenerator::Utilities.assert_valid_keys({ :name => "Rob", :age => "28" }, :name, :age)
+      }.should_not raise_exception
+
+      lambda {
+        SitemapGenerator::Utilities.assert_valid_keys({ :name => "Rob" }, :name, :age)
+      }.should_not raise_exception
+    end
+  end
+
+  describe "titleize" do
+    it "should titleize words and replace underscores" do
+      SitemapGenerator::Utilities.titleize('google').should == 'Google'
+      SitemapGenerator::Utilities.titleize('amy_and_jon').should == 'Amy And Jon'
+    end
+  end
+
+  describe "truthy?" do
+    it "should be truthy" do
+      ['1', 1, 't', 'true', true].each do |value|
+        SitemapGenerator::Utilities.truthy?(value).should be_true
+      end
+      SitemapGenerator::Utilities.truthy?(nil).should be_false
+    end
+  end
+
+  describe "falsy?" do
+    it "should be falsy" do
+      ['0', 0, 'f', 'false', false].each do |value|
+        SitemapGenerator::Utilities.falsy?(value).should be_true
+      end
+      SitemapGenerator::Utilities.falsy?(nil).should be_false
+    end
+  end
+
+  describe "as_array" do
+    it "should return an array unchanged" do
+      SitemapGenerator::Utilities.as_array([]).should == []
+      SitemapGenerator::Utilities.as_array([1]).should == [1]
+      SitemapGenerator::Utilities.as_array([1,2,3]).should == [1,2,3]
+    end
+
+    it "should return empty array on nil" do
+      SitemapGenerator::Utilities.as_array(nil).should == []
+    end
+
+    it "should make array of item otherwise" do
+      SitemapGenerator::Utilities.as_array('').should == ['']
+      SitemapGenerator::Utilities.as_array(1).should == [1]
+      SitemapGenerator::Utilities.as_array('hello').should == ['hello']
+      SitemapGenerator::Utilities.as_array({}).should == [{}]
+    end
+  end
+
+  describe "append_slash" do
+    SitemapGenerator::Utilities.append_slash('').should == ''
+    SitemapGenerator::Utilities.append_slash(nil).should == ''
+    SitemapGenerator::Utilities.append_slash(Pathname.new('')).should == ''
+    SitemapGenerator::Utilities.append_slash('tmp').should == 'tmp/'
+    SitemapGenerator::Utilities.append_slash(Pathname.new('tmp')).should == 'tmp/'
+    SitemapGenerator::Utilities.append_slash('tmp/').should == 'tmp/'
+    SitemapGenerator::Utilities.append_slash(Pathname.new('tmp/')).should == 'tmp/'
+  end
+
+  describe "ellipsis" do
+    it "should not modify when less than or equal to max" do
+      (1..10).each do |i|
+        string = 'a'*i
+        SitemapGenerator::Utilities.ellipsis(string, 10).should == string
+      end
+    end
+
+    it "should replace last 3 characters with ellipsis when greater than max" do
+      (1..5).each do |i|
+        string = 'aaaaa' + 'a'*i
+        SitemapGenerator::Utilities.ellipsis(string, 5).should == 'aa...'
+      end
+    end
+
+    it "should not freak out when string too small" do
+      SitemapGenerator::Utilities.ellipsis('a', 1).should == 'a'
+      SitemapGenerator::Utilities.ellipsis('aa', 1).should == '...'
+      SitemapGenerator::Utilities.ellipsis('aaa', 1).should == '...'
+    end
+  end
+end

data/spec/sitemap_generator/video_sitemap_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe "SitemapGenerator" do
+  let(:url_options) do
+    {
+      :host => 'http://example.com',
+      :path => 'cool_video.html'
+    }
+  end
+
+  let(:video_options) do
+    {
+      :thumbnail_loc => 'http://example.com/video1_thumbnail.png',
+      :title => 'Cool Video',
+      :content_loc => 'http://example.com/cool_video.mpg',
+      :player_loc => 'http://example.com/cool_video_player.swf',
+      :gallery_loc => 'http://example.com/cool_video_gallery',
+      :gallery_title => 'Gallery Title',
+      :allow_embed => true,
+      :autoplay => 'id=123',
+      :description => 'An new perspective in cool video technology',
+      :tags => %w(tag1 tag2 tag3),
+      :category => 'cat1',
+      :uploader => 'sokrates',
+      :uploader_info => 'http://sokrates.example.com',
+      :expiration_date => Time.at(0),
+      :publication_date => Time.at(0),
+      :family_friendly => true,
+      :view_count => 123,
+      :duration => 456,
+      :rating => 0.499999999,
+      :price => 123.45,
+      :price_currency => 'CAD',
+      :price_resolution => 'HD',
+      :price_type => 'rent'
+    }
+  end
+
+  # Return XML for the <URL> element.
+  def video_xml(video_options)
+    SitemapGenerator::Builder::SitemapUrl.new(url_options[:path], {
+      :host => url_options[:host],
+      :video => video_options
+    }).to_xml
+  end
+
+  # Return a Nokogiri document from the XML.  The root of the document is the <URL> element.
+  def video_doc(xml)
+    Nokogiri::XML.parse("<root xmlns:video='#{SitemapGenerator::SCHEMAS['video']}'>#{xml}</root>")
+  end
+
+  # Validate the contents of the video element
+  def validate_video_element(video_doc, video_options)
+    video_doc.at_xpath('video:thumbnail_loc').text.should == video_options[:thumbnail_loc]
+    video_doc.at_xpath("video:thumbnail_loc").text.should == video_options[:thumbnail_loc]
+    video_doc.at_xpath("video:gallery_loc").text.should   == video_options[:gallery_loc]
+    video_doc.at_xpath("video:gallery_loc").attribute('title').text.should == video_options[:gallery_title]
+    video_doc.at_xpath("video:title").text.should         == video_options[:title]
+    video_doc.at_xpath("video:view_count").text.should    == video_options[:view_count].to_s
+    video_doc.at_xpath("video:duration").text.should      == video_options[:duration].to_s
+    video_doc.at_xpath("video:rating").text.should        == ('%0.1f' % video_options[:rating])
+    video_doc.at_xpath("video:content_loc").text.should   == video_options[:content_loc]
+    video_doc.at_xpath("video:category").text.should      == video_options[:category]
+    video_doc.xpath("video:tag").collect(&:text).should   == video_options[:tags]
+    video_doc.at_xpath("video:expiration_date").text.should  == video_options[:expiration_date].iso8601
+    video_doc.at_xpath("video:publication_date").text.should == video_options[:publication_date].iso8601
+    video_doc.at_xpath("video:player_loc").text.should    == video_options[:player_loc]
+    video_doc.at_xpath("video:player_loc").attribute('allow_embed').text.should == (video_options[:allow_embed] ? 'yes' : 'no')
+    video_doc.at_xpath("video:player_loc").attribute('autoplay').text.should    == video_options[:autoplay]
+    video_doc.at_xpath("video:uploader").text.should      == video_options[:uploader]
+    video_doc.at_xpath("video:uploader").attribute("info").text.should == video_options[:uploader_info]
+    video_doc.at_xpath("video:price").text.should == video_options[:price].to_s
+    video_doc.at_xpath("video:price").attribute("resolution").text.should == video_options[:price_resolution].to_s
+    video_doc.at_xpath("video:price").attribute("type").text.should == video_options[:price_type].to_s
+    video_doc.at_xpath("video:price").attribute("currency").text.should == video_options[:price_currency].to_s
+    xml_fragment_should_validate_against_schema(video_doc, 'sitemap-video', 'xmlns:video' => SitemapGenerator::SCHEMAS['video'])
+  end
+
+  it "should add a valid video sitemap element" do
+    xml = video_xml(video_options)
+    doc = video_doc(xml)
+    doc.at_xpath("//url/loc").text.should == File.join(url_options[:host], url_options[:path])
+    validate_video_element(doc.at_xpath('//url/video:video'), video_options)
+  end
+
+  it "should support multiple video elements" do
+    xml = video_xml([video_options, video_options])
+    doc = video_doc(xml)
+    doc.at_xpath("//url/loc").text.should == File.join(url_options[:host], url_options[:path])
+    doc.xpath('//url/video:video').count.should == 2
+    doc.xpath('//url/video:video').each do |video|
+      validate_video_element(video, video_options)
+    end
+  end
+
+  it "should default allow_embed to 'yes'" do
+    xml = video_xml(video_options.merge(:allow_embed => nil))
+    doc = video_doc(xml)
+    doc.at_xpath("//url/video:video/video:player_loc").attribute('allow_embed').text.should == 'yes'
+  end
+
+  it "should not include optional elements if they are not passed" do
+    optional = [:player_loc, :content_loc, :category, :tags, :tag, :uploader, :gallery_loc, :family_friendly, :publication_date, :expiration_date, :view_count, :rating, :duration]
+    required_options = video_options.delete_if { |k,v| optional.include?(k) }
+    xml = video_xml(required_options)
+    doc = video_doc(xml)
+    optional.each do |element|
+      doc.at_xpath("//url/video:video/video:#{element}").should be_nil
+    end
+  end
+
+  it "should not include autoplay param if blank" do
+    xml = video_xml(video_options.tap {|v| v.delete(:autoplay) })
+    doc = video_doc(xml)
+    doc.at_xpath("//url/video:video/video:player_loc").attribute('autoplay').should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# require 'simplecov'
+# SimpleCov.start
+
+require "bundler/setup"
+Bundler.require
+require 'rspec/autorun'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+SitemapGenerator.verbose = false
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.include(FileMacros)
+  config.include(XmlMacros)
+
+  # Pass :focus option to +describe+ or +it+ to run that spec only
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding :integration => true
+end

data/spec/support/file_macros.rb

@@ -0,0 +1,39 @@
+module FileMacros
+  module ExampleMethods
+
+    def files_should_be_identical(first, second)
+      identical_files?(first, second).should be(true)
+    end
+
+    def files_should_not_be_identical(first, second)
+      identical_files?(first, second).should be(false)
+    end
+
+    def file_should_exist(file)
+      File.exists?(file).should be(true), "File #{file} should exist"
+    end
+
+    def directory_should_exist(dir)
+      File.exists?(dir).should be(true), "Directory #{dir} should exist"
+      File.directory?(dir).should be(true), "#{dir} should be a directory"
+    end
+
+    def directory_should_not_exist(dir)
+      File.exists?(dir).should be(false), "Directory #{dir} should not exist"
+    end
+
+    def file_should_not_exist(file)
+      File.exists?(file).should be(false), "File #{file} should not exist"
+    end
+
+    def identical_files?(first, second)
+      file_should_exist(first)
+      file_should_exist(second)
+      open(second, 'r').read.should == open(first, 'r').read
+    end
+  end
+
+  def self.included(receiver)
+    receiver.send :include, ExampleMethods
+  end
+end

data/spec/support/schemas/siteindex.xsd

@@ -0,0 +1,73 @@
+<?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 index files.
+    Last Modifed 2009-04-08
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="sitemapindex">
+  <xsd:annotation>
+    <xsd:documentation>
+      Container for a set of up to 50,000 sitemap URLs.
+      This is the root element of the XML file.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:complexType>
+    <xsd:sequence>
+      <xsd:element name="sitemap" type="tSitemap" maxOccurs="unbounded"/>
+    </xsd:sequence>
+  </xsd:complexType>
+</xsd:element>
+
+<xsd:complexType name="tSitemap">
+  <xsd:annotation>
+    <xsd:documentation>
+      Container for the data needed to describe a sitemap.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:all>
+    <xsd:element name="loc" type="tLocSitemap"/>
+    <xsd:element name="lastmod" type="tLastmodSitemap" minOccurs="0"/>
+  </xsd:all>
+</xsd:complexType>
+
+<xsd:simpleType name="tLocSitemap">
+  <xsd:annotation>
+    <xsd:documentation>
+      REQUIRED: The location URI of a sitemap.
+      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="tLastmodSitemap">
+  <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:schema>

data/spec/support/schemas/sitemap-geo.xsd

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsd:schema
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://www.google.com/geo/schemas/sitemap/1.0"
+    xmlns="http://www.google.com/geo/schemas/sitemap/1.0"
+    elementFormDefault="qualified">
+
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for the Geo Sitemap extension. This schema defines the
+    Geo-specific elements only; the core Sitemap elements are defined
+    separately.
+
+    Help Center documentation for the Geo Sitemap extension:
+
+      http://www.google.com/support/webmasters/bin/topic.py?topic=14688
+
+    Copyright 2010 Google Inc. All Rights Reserved.
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="geo">
+  <xsd:complexType>
+    <xsd:sequence>
+      <xsd:element name="format">
+        <xsd:annotation>
+          <xsd:documentation>
+            Specifies the format of the geo content.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:simpleType>
+          <xsd:restriction base="xsd:string">
+            <xsd:pattern value="[kK][mM][lL]|[kK][mM][zZ]|[gG][eE][oO][rR][sS][sS]"/>
+          </xsd:restriction>
+        </xsd:simpleType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:complexType>
+</xsd:element>
+
+</xsd:schema>

data/spec/support/schemas/sitemap-mobile.xsd

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsd:schema
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://www.google.com/schemas/sitemap-mobile/1.0"
+    xmlns="http://www.google.com/schemas/sitemap-mobile/1.0"
+    elementFormDefault="qualified">
+
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for the Mobile Sitemap extension. This schema defines the
+    Mobile-specific elements only; the core Sitemap elements are defined
+    separately.
+
+    Help Center documentation for the Mobile Sitemap extension:
+
+      http://www.google.com/support/webmasters/bin/topic.py?topic=8493
+
+    Copyright 2010 Google Inc. All Rights Reserved.
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="mobile">
+  <xsd:annotation>
+    <xsd:documentation>
+      Mobile sitemaps just contain an empty "mobile" tag to identify a
+      URL as having mobile content.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:complexType/>
+</xsd:element>
+
+</xsd:schema>

data/spec/support/schemas/sitemap-news.xsd

@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://www.google.com/schemas/sitemap-news/0.9"
+    xmlns="http://www.google.com/schemas/sitemap-news/0.9"
+    elementFormDefault="qualified">
+
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for the News Sitemap extension.  This schema defines the
+    News-specific elements only; the core Sitemap elements are defined
+    separately.
+
+    Help Center documentation for the News Sitemap extension:
+
+      http://www.google.com/support/news_pub/bin/topic.py?topic=11666
+
+    Copyright 2010 Google Inc. All Rights Reserved.
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="news">
+  <xsd:complexType>
+    <xsd:sequence>
+      <xsd:element name="publication">
+        <xsd:annotation>
+          <xsd:documentation>
+            The publication in which the article appears.  Required.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:element name="name" type="xsd:string">
+              <xsd:annotation>
+                <xsd:documentation>
+                  Name of the news publication. It must exactly match
+                  the name as it appears on your articles in news.google.com,
+                  omitting any trailing parentheticals.
+                  For example, if the name appears in Google News as
+                  "The Example Times (subscription)", you should use
+                  "The Example Times".  Required.
+                </xsd:documentation>
+              </xsd:annotation>
+            </xsd:element>
+            <xsd:element name="language">
+              <xsd:annotation>
+                <xsd:documentation>
+                  Language of the publication.  It should be an
+                  ISO 639 Language Code (either 2 or 3 letters); see:
+                    http://www.loc.gov/standards/iso639-2/php/code_list.php
+                  Exception: For Chinese, please use zh-cn for Simplified
+                  Chinese or zh-tw for Traditional Chinese.  Required.
+                </xsd:documentation>
+              </xsd:annotation>
+              <xsd:simpleType>
+                <xsd:restriction base="xsd:string">
+                  <xsd:pattern value="zh-cn|zh-tw|([a-z]{2,3})"/>
+                </xsd:restriction>
+              </xsd:simpleType>
+            </xsd:element>
+          </xsd:sequence>
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="access" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            Accessibility of the article.  Required if access is not open,
+            otherwise this tag should be omitted.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:simpleType>
+          <xsd:restriction base="xsd:string">
+            <xsd:enumeration value="Subscription"/>
+            <xsd:enumeration value="Registration"/>
+          </xsd:restriction>
+        </xsd:simpleType>
+      </xsd:element>
+      <xsd:element name="genres" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            A comma-separated list of properties characterizing the content
+            of the article, such as "PressRelease" or "UserGenerated".
+            For a list of possible values, see:
+              http://www.google.com/support/news_pub/bin/answer.py?answer=93992
+            Required if any genres apply to the article, otherwise this tag
+            should be omitted.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:simpleType>
+          <xsd:restriction base="xsd:string">
+            <xsd:pattern value="(PressRelease|Satire|Blog|OpEd|Opinion|UserGenerated)(, *(PressRelease|Satire|Blog|OpEd|Opinion|UserGenerated))*"/>
+          </xsd:restriction>
+        </xsd:simpleType>
+      </xsd:element>
+      <xsd:element name="publication_date">
+        <xsd:annotation>
+          <xsd:documentation>
+            Article publication date in W3C format, specifying the complete
+            date (YYYY-MM-DD) with optional timestamp.  See:
+              http://www.w3.org/TR/NOTE-datetime
+            Please ensure that you give the original date and time at which
+            the article was published on your site; do not give the time
+            at which the article was added to your Sitemap.  Required.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:simpleType>
+          <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:element>
+      <xsd:element name="title" type="xsd:string" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            Title of the news article.  Optional, but highly recommended.
+            Note: The title may be truncated for space reasons when shown
+            on Google News.
+          </xsd:documentation>
+        </xsd:annotation>
+      </xsd:element>
+      <xsd:element name="keywords" type="xsd:string" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            Comma-separated list of keywords describing the topic of
+            the article.  Keywords may be drawn from, but are not limited to,
+            the list of existing Google News keywords; see:
+              http://www.google.com/support/news_pub/bin/answer.py?answer=116037
+            Optional.
+          </xsd:documentation>
+        </xsd:annotation>
+      </xsd:element>
+      <xsd:element name="stock_tickers" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            Comma-separated list of up to 5 stock tickers of the companies,
+            mutual funds, or other financial entities that are the main subject
+            of the article.  Relevant primarily for business articles.
+            Each ticker must be prefixed by the name of its stock exchange,
+            and must match its entry in Google Finance.
+            For example, "NASDAQ:AMAT" (but not "NASD:AMAT"),
+            or "BOM:500325" (but not "BOM:RIL").  Optional.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:simpleType>
+          <xsd:restriction base="xsd:string">
+            <xsd:pattern value="(\w+:\w+(, *\w+:\w+){0,4})?"/>
+          </xsd:restriction>
+        </xsd:simpleType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:complexType>
+</xsd:element>
+
+</xsd:schema>