sitemap_generator 4.0.1 → 4.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (4.0.1)
+    sitemap_generator (4.1.0)
       builder
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 ## Features
 
 * Framework agnostic
-* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Geo sitemaps][sitemap_geo], [Mobile sitemaps][sitemap_mobile] and [Alternate Links][alternate_links]
+* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Geo sitemaps][sitemap_geo], [Mobile sitemaps][sitemap_mobile], [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
 * Supports read-only filesystems like Heroku via uploading to a remote host like Amazon S3
 * Compatible with Rails 2 & 3 and tested with Ruby REE, 1.9.2 & 1.9.3
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
@@ -103,6 +103,7 @@ That's it!  Welcome to the future!
 
 ## Changelog
 
+* v4.1.0: [PageMap sitemap][using_pagemaps] support.
 * v4.0.1: Add a post install message regarding the naming convention change.
 * **v4.0: NEW, NON-BACKWARDS COMPATIBLE CHANGES.**  See above for more info. `create_index` defaults to `:auto`.  Define `SitemapGenerator::SimpleNamer` class for simpler custom namers compatible with the new naming conventions.  Deprecate `sitemaps_namer`, `sitemap_index_namer` and their respective namer classes.  It's more just that their usage is discouraged.  Support `nofollow` option on alternate links.  Fix formatting of `publication_date` in News sitemaps.
 * v3.4: Support [alternate links][alternate_links] for urls; Support configurable options in the `SitemapGenerator::S3Adapter`
@@ -827,15 +828,15 @@ end
 
 #### Supported options
 
-* `:publication_name`
-* `:publication_language`
-* `:publication_date`
-* `:genres`
-* `:access`
-* `:title`
-* `:keywords`
-* `:stock_tickers`
-
+* `:news` - Hash
+    * `:publication_name`
+    * `:publication_language`
+    * `:publication_date`
+    * `:genres`
+    * `:access`
+    * `:title`
+    * `:keywords`
+    * `:stock_tickers`
 
 ### Image Sitemaps
 
@@ -854,12 +855,12 @@ end
 
 #### Supported options
 
-* `:loc` Required, location of the image
-* `:caption`
-* `:geo_location`
-* `:title`
-* `:license`
-
+* `:images` - Array of hashes
+    * `:loc` Required, location of the image
+    * `:caption`
+    * `:geo_location`
+    * `:title`
+    * `:license`
 
 ### Video Sitemaps
 
@@ -885,9 +886,27 @@ end
 
 #### Supported options
 
-* `:thumbnail_loc` - Required, string.
-
-
+* `:video`/`:videos` - Hash or array of hashes, respectively
+    * `:thumbnail_loc` - String, URL of the thumbnail image.
+    * `:title` - String, title of the video.
+    * `:description` - String, description of the video.
+    * `:content_loc` - String, URL.  One of content_loc or player_loc must be present.
+    * `:player_loc` - String, URL.  One of content_loc or player_loc must be present.
+    * `:allow_embed` - Boolean, attribute of player_loc.
+    * `:autoplay` - Boolean, default true.  Attribute of player_loc.
+    * `:duration` - Integer or string.  Duration in seconds.
+    * `:expiration_date`
+    * `:rating`
+    * `:view_count` - Integer or string.
+    * `:publication_date`
+    * `:tags` - Array of string tags.
+    * `:tag` - String, single tag.
+    * `:category`
+    * `:family_friendly`- Boolean
+    * `:gallery_loc` - String, URL.
+    * `:gallery_title` - Title attribute of the gallery location element
+    * `:uploader`
+    * `:uploader_info` - Info attribute of uploader element
 
 ### Geo Sitemaps
 
@@ -904,8 +923,40 @@ end
 
 #### Supported options
 
-* `:format` Required, either 'kml' or 'georss'
+* `:geo` - Hash
+    * `:format` - Required, string, either `'kml'` or `'georss'`
+
+### PageMap Sitemaps
+
+Pagemaps can be added by passing a `:pagemap` hash to `add`. The hash must contain a `:dataobjects` key with an array of dataobject hashes. Each dataobject hash contains a `:type` and `:id`, and an optional array of `:attributes`.  Each attribute hash can contain two keys: `:name` and `:value`, with string values.  For more information consult the [official documentation on PageMaps][using_pagemaps].
+
+#### Supported options
+
+* `:pagemap` - Hash
+    * `:dataobjects` - Required, array of hashes
+        * `:type` - Required, string, type of the object
+        * `:id` - String, ID of the object
+        * `:attributes` - Array of hashes
+            * `:name` - Required, string, name of the attribute.
+            * `:value` - String, value of the attribute.
 
+#### Example:
+
+```ruby
+SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+SitemapGenerator::Sitemap.create do
+  add('/blog/post', :pagemap => {
+    :dataobjects => [{
+      :type => 'document',
+      :id   => 'hibachi',
+      :attributes => [
+        { :name => 'name',   :value => 'Dragon' },
+        { :name => 'review', :value => '3.5' },
+      ]
+    }]
+  })
+end
+```
 
 ### Alternate Links
 
@@ -930,9 +981,10 @@ end
 
 #### Supported options
 
-* `:href` - Required, string.
-* `:lang`  - Required, string.
-* `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
+* `:alternate`/`:alternates` - Hash or array of hashes, respectively
+    * `:href` - Required, string.
+    * `:lang`  - Required, string.
+    * `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
 
 ## Raison d'être
 
@@ -1010,6 +1062,7 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [sitemap_news]:http://www.google.com/support/webmasters/bin/topic.py?hl=en&topic=10078
 [sitemap_geo]:http://www.google.com/support/webmasters/bin/topic.py?hl=en&topic=14688
 [sitemap_mobile]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=34648
+[sitemap_pagemap]:https://developers.google.com/custom-search/docs/structured_data#addtositemap
 [sitemap_protocol]:http://sitemaps.org/protocol.php
 [video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
 [image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
@@ -1019,3 +1072,4 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [include_index_change]:https://github.com/kjvarga/sitemap_generator/issues/70
 [ehoch]:https://github.com/ehoch
 [alternate_links]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=2620865
+[using_pagemaps]:https://developers.google.com/custom-search/docs/structured_data#pagemaps

data/VERSION

@@ -1 +1 @@
-4.0.1
+4.1.0

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -36,6 +36,7 @@ module SitemapGenerator
               xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0"
               xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"
               xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0"
+              xmlns:pagemap="http://www.google.com/schemas/sitemap-pagemap/1.0"
               xmlns:xhtml="http://www.w3.org/1999/xhtml"
             >
         HTML

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -29,6 +29,7 @@ module SitemapGenerator
       # * +news+
       # * +mobile+
       # * +alternate+/+alternates+
+      # * +pagemap+
       def initialize(path, options={})
         options = options.dup
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
@@ -36,9 +37,10 @@ module SitemapGenerator
           path = sitemap.location.path_in_public
         end
 
-        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :host, :images, :video, :geo, :news, :videos, :mobile, :alternate, :alternates)
+        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :host, :images, :video, :geo, :news, :videos, :mobile, :alternate, :alternates, :pagemap)
         SitemapGenerator::Utilities.reverse_merge!(options, :priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :images => [], :news => {}, :videos => [], :mobile => false, :alternates => [])
         raise "Cannot generate a url without a host" unless SitemapGenerator::Utilities.present?(options[:host])
+
         if video = options.delete(:video)
           options[:videos] = video.is_a?(Array) ? options[:videos].concat(video) : options[:videos] << video
         end
@@ -59,7 +61,8 @@ module SitemapGenerator
           :videos     => options[:videos],
           :geo        => options[:geo],
           :mobile     => options[:mobile],
-          :alternates => options[:alternates]
+          :alternates => options[:alternates],
+          :pagemap    => options[:pagemap]
         )
       end
 
@@ -141,6 +144,18 @@ module SitemapGenerator
           unless SitemapGenerator::Utilities.blank?(self[:mobile])
             builder.mobile :mobile
           end
+
+          unless SitemapGenerator::Utilities.blank?(self[:pagemap])
+            builder.pagemap :PageMap do
+              SitemapGenerator::Utilities.as_array(self[:pagemap][:dataobjects]).each do |dataobject|
+                builder.pagemap :DataObject, :type => dataobject[:type], :id => dataobject[:id] do
+                  SitemapGenerator::Utilities.as_array(dataobject[:attributes]).each do |attribute|
+                    builder.pagemap :Attribute, attribute[:value], :name => attribute[:name]
+                  end
+                end
+              end
+            end
+          end
         end
         builder << '' # Force to string
       end

data/lib/sitemap_generator/utilities.rb

@@ -49,6 +49,18 @@ module SitemapGenerator
       hash
     end
 
+    # Make a list of `value` if it is not a list already.  If `value` is
+    # nil, an empty list is returned.  If `value` is already a list, return it unchanged.
+    def as_array(value)
+      if value.nil?
+        []
+      elsif value.is_a?(Array)
+        value
+      else
+        [value]
+      end
+    end
+    
     # Rounds the float with the specified precision.
     #
     #   x = 1.337

data/spec/sitemap_generator/pagemap_sitemap_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe "SitemapGenerator" do
+
+  it "should add the pagemap sitemap element" do
+    pagemap_xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('my_page.html', {
+      :host => 'http://www.example.com',
+
+      :pagemap => {
+        :dataobjects => [
+          {
+            type: 'document',
+            id: 'hibachi',
+            attributes: [
+              {name: 'name', value: 'Dragon'},
+              {name: 'review', value: 3.5},
+            ]
+          },
+          {
+            type: 'stats',
+            attributes: [
+              {name: 'installs', value: 2000},
+              {name: 'comments', value: 200},
+            ]
+          }
+        ]
+      }
+    }).to_xml
+
+    doc = Nokogiri::XML.parse(pagemap_xml_fragment)
+
+    url = doc.at_xpath("//url")
+    loc = url.at_xpath("loc")
+    loc.text.should == 'http://www.example.com/my_page.html'
+
+    pagemap = doc.at_xpath("//PageMap")
+    pagemap.children.count.should == 2
+    pagemap.at_xpath('//DataObject').attributes['type'].value.should == 'document'
+    pagemap.at_xpath('//DataObject').attributes['id'].value.should == 'hibachi'
+    pagemap.at_xpath('//DataObject').children.count.should == 2
+    first_attribute = pagemap.at_xpath('//DataObject').children.first
+    second_attribute = pagemap.at_xpath('//DataObject').children.last
+    first_attribute.text.should == 'Dragon'
+    first_attribute.attributes['name'].value.should == 'name'
+    second_attribute.text.should == '3.5'
+    second_attribute.attributes['name'].value.should == 'review'
+
+    xml_fragment_should_validate_against_schema(pagemap, 'http://www.google.com/schemas/sitemap-pagemap/1.0', 'sitemap-pagemap')
+  end
+end

data/spec/sitemap_generator/utilities_spec.rb

@@ -47,4 +47,23 @@ describe SitemapGenerator::Utilities do
       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
 end

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

@@ -0,0 +1,97 @@
+
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://www.google.com/schemas/sitemap-pagemap/1.0"
+    xmlns="http://www.google.com/schemas/sitemap-pagemap/1.0"
+    elementFormDefault="qualified">
+
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for the PageMap Sitemap extension. This schema defines the
+    PageMap-specific elements only; the core Sitemap elements are defined
+    separately.
+
+    Copyright 2011 Google Inc. All Rights Reserved.
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="PageMap">
+  <xsd:complexType>
+    <xsd:sequence>
+      <xsd:element name="Template" minOccurs="0">
+        <xsd:annotation>
+          <xsd:documentation>
+            Template file specification. Can be used for overriding the
+            default rendering of search results delivered via
+            Google Custom Search Engine.
+          </xsd:documentation>
+        </xsd:annotation>
+        <xsd:complexType>
+          <xsd:attribute name="src" type="xsd:anyURI" use="required">
+            <xsd:annotation>
+              <xsd:documentation>
+                Reference to a template file. A template file contains a set of
+                ResultSpecs, which, given DataObjects of appropriate types on
+                the page, renders a search result based on the key-value pairs
+                found in those DataObjects. If the template file is not
+                specified, Google will use the default predefined set of
+                templates tailored to popular content.
+              </xsd:documentation>
+            </xsd:annotation>
+          </xsd:attribute>
+        </xsd:complexType>
+      </xsd:element>
+      <xsd:element name="DataObject" minOccurs="0" maxOccurs="unbounded">
+        <xsd:complexType>
+          <xsd:sequence>
+            <xsd:element name="Attribute" minOccurs="0" maxOccurs="unbounded">
+              <xsd:annotation>
+                <xsd:documentation>
+                  Either 'value' attribute or text content must be set, but
+                  not both.
+                </xsd:documentation>
+              </xsd:annotation>
+              <xsd:complexType>
+                <xsd:simpleContent>
+                  <xsd:extension base="xsd:string">
+                    <xsd:attribute name="name" type="xsd:string" use="required">
+                      <xsd:annotation>
+                        <xsd:documentation>
+                          Name of the attribute.
+                        </xsd:documentation>
+                      </xsd:annotation>
+                    </xsd:attribute>
+                    <xsd:attribute name="value" type="xsd:string">
+                      <xsd:annotation>
+                        <xsd:documentation>
+                          Value of the attribute.
+                        </xsd:documentation>
+                      </xsd:annotation>
+                    </xsd:attribute>
+                  </xsd:extension>
+                </xsd:simpleContent>
+              </xsd:complexType>
+            </xsd:element>
+          </xsd:sequence>
+          <xsd:attribute name="type" type="xsd:string" use="required">
+            <xsd:annotation>
+              <xsd:documentation>
+                Type of the object.
+              </xsd:documentation>
+            </xsd:annotation>
+          </xsd:attribute>
+          <xsd:attribute name="id" type="xsd:string">
+            <xsd:annotation>
+              <xsd:documentation>
+                ID of the object.
+              </xsd:documentation>
+            </xsd:annotation>
+          </xsd:attribute>
+        </xsd:complexType>
+      </xsd:element>
+    </xsd:sequence>
+  </xsd:complexType>
+</xsd:element>
+
+</xsd:schema>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000Z
+date: 2013-06-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70331845270060 !ruby/object:Gem::Requirement
+  requirement: &70338921097240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331845270060
+  version_requirements: *70338921097240
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70331845269600 !ruby/object:Gem::Requirement
+  requirement: &70338921096640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331845269600
+  version_requirements: *70338921096640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70331845267820 !ruby/object:Gem::Requirement
+  requirement: &70338921096180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331845267820
+  version_requirements: *70338921096180
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70331845267400 !ruby/object:Gem::Requirement
+  requirement: &70338921095700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70331845267400
+  version_requirements: *70338921095700
 description: SitemapGenerator is an XML Sitemap generator written in Ruby with automatic
   Rails integration.  It supports Video, News, Image and Geo sitemaps and includes
   Rake tasks for managing your sitemaps.
@@ -115,6 +115,7 @@ files:
 - spec/sitemap_generator/link_set_spec.rb
 - spec/sitemap_generator/mobile_sitemap_spec.rb
 - spec/sitemap_generator/news_sitemap_spec.rb
+- spec/sitemap_generator/pagemap_sitemap_spec.rb
 - spec/sitemap_generator/sitemap_generator_spec.rb
 - spec/sitemap_generator/sitemap_groups_spec.rb
 - spec/sitemap_generator/sitemap_location_spec.rb
@@ -131,6 +132,7 @@ files:
 - spec/support/schemas/sitemap-geo.xsd
 - spec/support/schemas/sitemap-mobile.xsd
 - spec/support/schemas/sitemap-news.xsd
+- spec/support/schemas/sitemap-pagemap.xsd
 - spec/support/schemas/sitemap-video.xsd
 - spec/support/schemas/sitemap.xsd
 - spec/support/xml_macros.rb
@@ -161,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4173052129675694505
+      hash: -1019294574066130331
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4173052129675694505
+      hash: -1019294574066130331
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -196,6 +198,7 @@ test_files:
 - spec/sitemap_generator/link_set_spec.rb
 - spec/sitemap_generator/mobile_sitemap_spec.rb
 - spec/sitemap_generator/news_sitemap_spec.rb
+- spec/sitemap_generator/pagemap_sitemap_spec.rb
 - spec/sitemap_generator/sitemap_generator_spec.rb
 - spec/sitemap_generator/sitemap_groups_spec.rb
 - spec/sitemap_generator/sitemap_location_spec.rb
@@ -212,6 +215,7 @@ test_files:
 - spec/support/schemas/sitemap-geo.xsd
 - spec/support/schemas/sitemap-mobile.xsd
 - spec/support/schemas/sitemap-news.xsd
+- spec/support/schemas/sitemap-pagemap.xsd
 - spec/support/schemas/sitemap-video.xsd
 - spec/support/schemas/sitemap.xsd
 - spec/support/xml_macros.rb