sitemap_generator 5.0.3 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c25bfb211e9b5d5f074e7565bb9d58fea0c7400
-  data.tar.gz: 005d8b22093bff792bbeed376ac1c0652c077464
+  metadata.gz: 1f409e2e176959553327858497c6817be5f3ceaf
+  data.tar.gz: f2d0c65be82f2c8c5a6dd9277903b74a2057a533
 SHA512:
-  metadata.gz: 4a13b82ea72040baeb1581c415034786c7687d6fe41893225492af6443a4141747b2b24d8714743e7b3fa8a2e31648788fca8815a9e3c9889dab26068b0a0644
-  data.tar.gz: 3ae6b41f3b000363c4e47d50fdaed0019585cf2f0800aef83d5503bbbd0ad253532351390297a6f09cabc5e978163190d5ca2142e223e3b5b497b1c47e62d5c4
+  metadata.gz: 37b97c0e1b85707fdf4b663f5369017160543687d6d0800d96da7a3071ac749a743ebe58480ceb4f1fc5dfdbb8aa92473af43fc880e325a83a3d244df27fcc92
+  data.tar.gz: b2b2899c879a19620c1f7a9bb19e33855234c7c6157e8d13bc3a9468a5b06a74b86d04e09c1a6eac0425d05bcefe918ece2dd7bab37163fd99989baf3103c674

data/Gemfile.lock

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

data/README.md

@@ -117,6 +117,7 @@ That's it!  Welcome to the future!
 
 ## Changelog
 
+* v5.0.4: Don't include the `media` attribute on alternate links unless it's given
 * v5.0.3: Add support for Video sitemaps options `:live` and ':requires_subscription'
 * v5.0.2: Set maximum filesize to 10,000,000 bytes rather than 10,485,760 bytes.
 * v5.0.1: Include new `SitemapGenerator::FogAdapter` ([#138](https://github.com/kjvarga/sitemap_generator/pull/138)).  Fix usage of attr_* methods in LinkSet; don't override custom getters/setters ([#144](https://github.com/kjvarga/sitemap_generator/pull/144)). Fix breaking spec in Ruby 2 ([#142](https://github.com/kjvarga/sitemap_generator/pull/142)).  Include Capistrano 3.x tasks ([#141](https://github.com/kjvarga/sitemap_generator/pull/141)).
@@ -1044,7 +1045,7 @@ end
     * `:href` - Required, string.
     * `:lang`  - Required, string.
     * `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
-    * `:media` - Optional, string.  Specify [media][media targets for responsive design pages].
+    * `:media` - Optional, string.  Specify [media targets for responsive design pages][media].
 
 ## Raison d'être
 

data/VERSION

@@ -1 +1 @@
-5.0.3
+5.0.4

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -37,8 +37,8 @@ module SitemapGenerator
           path = sitemap.location.path_in_public
         end
 
-        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :expires, :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 => [])
+        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :expires, :host, :images, :video, :geo, :news, :videos, :mobile, :alternate, :alternates, :pagemap, :data)
+        SitemapGenerator::Utilities.reverse_merge!(options, :priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :images => [], :news => {}, :videos => [], :mobile => false, :alternates => [], :data => false)
         raise "Cannot generate a url without a host" unless SitemapGenerator::Utilities.present?(options[:host])
 
         if video = options.delete(:video)
@@ -63,7 +63,8 @@ module SitemapGenerator
           :geo        => options[:geo],
           :mobile     => options[:mobile],
           :alternates => options[:alternates],
-          :pagemap    => options[:pagemap]
+          :pagemap    => options[:pagemap],
+          :data       => options[:data]
         )
       end
 
@@ -136,7 +137,9 @@ module SitemapGenerator
 
           self[:alternates].each do |alternate|
             rel = alternate[:nofollow] ? 'alternate nofollow' : 'alternate'
-            builder.xhtml :link, :rel => rel, :hreflang => alternate[:lang].to_s, :href => alternate[:href].to_s, :media => alternate[:media].to_s
+            attributes = { :rel => rel, :hreflang => alternate[:lang].to_s, :href => alternate[:href].to_s }
+            attributes[:media] = alternate[:media].to_s if SitemapGenerator::Utilities.present?(alternate[:media])
+            builder.xhtml :link, attributes
           end
 
           unless SitemapGenerator::Utilities.blank?(self[:geo])
@@ -161,6 +164,12 @@ module SitemapGenerator
               end
             end
           end
+
+          unless SitemapGenerator::Utilities.blank?(self[:data])
+            builder.data {
+              builder.display
+            }
+          end
         end
         builder << '' # Force to string
       end

data/spec/sitemap_generator/alternate_sitemap_spec.rb

@@ -1,6 +1,28 @@
 require 'spec_helper'
 
 describe "SitemapGenerator" do
+  it "should not include media element unless provided" do
+    xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('link_with_alternates.html',
+      :host => 'http://www.example.com',
+      :alternates => [
+        {
+          :lang => 'de',
+          :href => 'http://www.example.de/link_with_alternate.html'
+        }
+      ]
+    ).to_xml
+
+    doc = Nokogiri::XML.parse("<root xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:xhtml='http://www.w3.org/1999/xhtml'>#{xml_fragment}</root>")
+    url = doc.css('url')
+    url.should_not be_nil
+    url.css('loc').text.should == 'http://www.example.com/link_with_alternates.html'
+
+    alternate = url.at_xpath('xhtml:link')
+    alternate.should_not be_nil
+    alternate.attribute('rel').value.should == 'alternate'
+    alternate.attribute('hreflang').value.should == 'de'
+    alternate.attribute('media').should be_nil
+  end
 
   it "should add alternate links to sitemap" do
     xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('link_with_alternates.html',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.0.4
 platform: ruby
 authors:
 - Karl Varga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -93,7 +93,6 @@ files:
 - lib/sitemap_generator/builder/sitemap_index_file.rb
 - lib/sitemap_generator/builder/sitemap_index_url.rb
 - lib/sitemap_generator/builder/sitemap_url.rb
-- lib/sitemap_generator/builder/sitemap_url.rb.orig
 - lib/sitemap_generator/builder.rb
 - lib/sitemap_generator/core_ext/big_decimal.rb
 - lib/sitemap_generator/core_ext/numeric.rb

data/lib/sitemap_generator/builder/sitemap_url.rb.orig

@@ -1,248 +0,0 @@
-require 'builder'
-require 'uri'
-require 'time'
-require 'date'
-
-module SitemapGenerator
-  module Builder
-    # A Hash-like class for holding information about a sitemap URL and
-    # generating an XML <url> element suitable for sitemaps.
-    class SitemapUrl < Hash
-
-      # Return a new instance with options configured on it.
-      #
-      # == Arguments
-      # * sitemap - a Sitemap instance, or
-      # * path, options - a path string and options hash
-      #
-      # == Options
-      # Requires a host to be set.  If passing a sitemap, the sitemap must have a +default_host+
-      # configured.  If calling with a path and options, you must include the <tt>:host</tt> option.
-      #
-      # * +host+
-      # * +priority+
-      # * +changefreq+
-      # * +lastmod+
-      # * +images+
-      # * +video+/+videos+
-      # * +geo+
-      # * +news+
-      # * +mobile+
-      # * +alternate+/+alternates+
-      # * +pagemap+
-      def initialize(path, options={})
-        options = options.dup
-        if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
-          SitemapGenerator::Utilities.reverse_merge!(options, :host => sitemap.location.host, :lastmod => sitemap.lastmod)
-          path = sitemap.location.path_in_public
-        end
-
-        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :expires, :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
-        if alternate = options.delete(:alternate)
-          options[:alternates] = alternate.is_a?(Array) ? options[:alternates].concat(alternate) : options[:alternates] << alternate
-        end
-
-        path = path.to_s.sub(/^\//, '')
-        loc  = path.empty? ? options[:host] : (options[:host].to_s.sub(/\/$/, '') + '/' + path)
-        self.merge!(
-          :priority   => options[:priority],
-          :changefreq => options[:changefreq],
-          :lastmod    => options[:lastmod],
-          :expires    => options[:expires],
-          :host       => options[:host],
-          :loc        => loc,
-          :images     => prepare_images(options[:images], options[:host]),
-          :news       => prepare_news(options[:news]),
-          :videos     => options[:videos],
-          :geo        => options[:geo],
-          :mobile     => options[:mobile],
-          :alternates => options[:alternates],
-          :pagemap    => options[:pagemap]
-        )
-      end
-
-      # Return the URL as XML
-      def to_xml(builder=nil)
-        builder = ::Builder::XmlMarkup.new if builder.nil?
-        builder.url do
-          builder.loc        self[:loc]
-          builder.lastmod    w3c_date(self[:lastmod])      if self[:lastmod]
-          builder.expires    w3c_date(self[:expires])      if self[:expires]
-          builder.changefreq self[:changefreq].to_s        if self[:changefreq]
-          builder.priority   format_float(self[:priority]) if self[:priority]
-          
-          unless SitemapGenerator::Utilities.blank?(self[:news])
-            news_data = self[:news]
-            builder.news:news do
-              builder.news:publication do
-                builder.news :name, news_data[:publication_name].to_s if news_data[:publication_name]
-                builder.news :language, news_data[:publication_language].to_s if news_data[:publication_language]
-              end
-
-              builder.news :access, news_data[:access].to_s if news_data[:access]
-              builder.news :genres, news_data[:genres].to_s if news_data[:genres]
-              builder.news :publication_date, w3c_date(news_data[:publication_date]) if news_data[:publication_date]
-              builder.news :title, news_data[:title].to_s if news_data[:title]
-              builder.news :keywords, news_data[:keywords].to_s if news_data[:keywords]
-              builder.news :stock_tickers, news_data[:stock_tickers].to_s if news_data[:stock_tickers]
-            end
-          end
-
-          self[:images].each do |image|
-            builder.image:image do
-              builder.image :loc, image[:loc]
-              builder.image :caption, image[:caption].to_s             if image[:caption]
-              builder.image :geo_location, image[:geo_location].to_s   if image[:geo_location]
-              builder.image :title, image[:title].to_s                 if image[:title]
-              builder.image :license, image[:license].to_s             if image[:license]
-            end
-          end
-
-          self[:videos].each do |video|
-            builder.video :video do
-              builder.video :thumbnail_loc, video[:thumbnail_loc].to_s
-              builder.video :title, video[:title].to_s
-              builder.video :description, video[:description].to_s
-              builder.video :content_loc, video[:content_loc].to_s           if video[:content_loc]
-              if video[:player_loc]
-                loc_attributes = { :allow_embed => yes_or_no_with_default(video[:allow_embed], true) }
-                loc_attributes[:autoplay] = video[:autoplay].to_s if SitemapGenerator::Utilities.present?(video[:autoplay])
-                builder.video :player_loc, video[:player_loc].to_s, loc_attributes
-              end
-              builder.video :duration, video[:duration].to_s                 if video[:duration]
-              builder.video :expiration_date,  w3c_date(video[:expiration_date])  if video[:expiration_date]
-              builder.video :rating, format_float(video[:rating])       if video[:rating]
-              builder.video :view_count, video[:view_count].to_s             if video[:view_count]
-              builder.video :publication_date, w3c_date(video[:publication_date]) if video[:publication_date]
-              video[:tags].each {|tag| builder.video :tag, tag.to_s }        if video[:tags]
-              builder.video :tag, video[:tag].to_s                           if video[:tag]
-              builder.video :category, video[:category].to_s                 if video[:category]
-              builder.video :family_friendly,  yes_or_no_with_default(video[:family_friendly], true) if video.has_key?(:family_friendly)
-              builder.video :gallery_loc, video[:gallery_loc].to_s, :title => video[:gallery_title].to_s if video[:gallery_loc]
-              builder.video :price, video[:price].to_s, prepare_video_price_attribs(video) if SitemapGenerator::Utilities.present?(video[:price])
-              if video[:uploader]
-                builder.video :uploader, video[:uploader].to_s, video[:uploader_info] ? { :info => video[:uploader_info].to_s } : {}
-              end
-            end
-          end
-
-          self[:alternates].each do |alternate|
-            rel = alternate[:nofollow] ? 'alternate nofollow' : 'alternate'
-<<<<<<< HEAD
-            builder.xhtml :link, :rel => rel, :hreflang => alternate[:lang].to_s, :href => alternate[:href].to_s
-=======
-            builder.xhtml :link, :rel => rel, :hreflang => alternate[:lang], :href => alternate[:href], :media => alternate[:media]
->>>>>>> ddeebe0aa558b4ecc08c7e8d5324842205d20b79
-          end
-
-          unless SitemapGenerator::Utilities.blank?(self[:geo])
-            geo = self[:geo]
-            builder.geo :geo do
-              builder.geo :format, geo[:format].to_s if geo[:format]
-            end
-          end
-
-          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].to_s, :id => dataobject[:id].to_s do
-                  SitemapGenerator::Utilities.as_array(dataobject[:attributes]).each do |attribute|
-                    builder.pagemap :Attribute, attribute[:value].to_s, :name => attribute[:name].to_s
-                  end
-                end
-              end
-            end
-          end
-        end
-        builder << '' # Force to string
-      end
-
-      def news?
-        SitemapGenerator::Utilities.present?(self[:news])
-      end
-
-      protected
-
-      def prepare_video_price_attribs(video)
-        attribs = {}
-        attribs[:currency] = video[:price_currency].to_s # required
-        attribs[:type] = video[:price_type] if SitemapGenerator::Utilities.present?(video[:price_type])
-        attribs[:resolution] = video[:price_resolution] if SitemapGenerator::Utilities.present?(video[:price_resolution])
-        attribs
-      end
-
-      def prepare_news(news)
-        SitemapGenerator::Utilities.assert_valid_keys(news, :publication_name, :publication_language, :publication_date, :genres, :access, :title, :keywords, :stock_tickers) unless news.empty?
-        news
-      end
-
-      # Return an Array of image option Hashes suitable to be parsed by SitemapGenerator::Builder::SitemapFile
-      def prepare_images(images, host)
-        images.delete_if { |key,value| key[:loc] == nil }
-        images.each do |r|
-          SitemapGenerator::Utilities.assert_valid_keys(r, :loc, :caption, :geo_location, :title, :license)
-          r[:loc] = URI.join(host, r[:loc]).to_s
-        end
-        images[0..(SitemapGenerator::MAX_SITEMAP_IMAGES-1)]
-      end
-
-      def w3c_date(date)
-        if date.is_a?(String)
-          date
-        elsif date.respond_to?(:iso8601)
-          date.iso8601.sub(/Z$/i, '+00:00')
-        elsif date.is_a?(Date) && !date.is_a?(DateTime)
-          date.strftime("%Y-%m-%d")
-        else
-          zulutime = if date.is_a?(DateTime)
-            date.new_offset(0)
-          elsif date.respond_to?(:utc)
-            date.utc
-          else
-            nil
-          end
-
-          if zulutime
-            zulutime.strftime("%Y-%m-%dT%H:%M:%S+00:00")
-          else
-            zone = date.strftime('%z').insert(-3, ':')
-            date.strftime("%Y-%m-%dT%H:%M:%S") + zone
-          end
-        end
-      end
-
-      # Accept a string or boolean and return 'yes' or 'no'.  If a string, the
-      # value must be 'yes' or 'no'.  Pass the default value as a boolean using `default`.
-      def yes_or_no(value)
-        if value.is_a?(String)
-          raise ArgumentError.new("Unrecognized value for yes/no field: #{value.inspect}") unless value =~ /^(yes|no)$/i
-          value.downcase
-        else
-          value ? 'yes' : 'no'
-        end
-      end
-
-      # If the value is nil, return `default` converted to either 'yes' or 'no'.
-      # If the value is set, return its value converted to 'yes' or 'no'.
-      def yes_or_no_with_default(value, default)
-        yes_or_no(value.nil? ? default : value)
-      end
-
-      # Format a float to to one decimal precision.
-      # TODO: Use rounding with precision once merged with framework_agnostic.
-      def format_float(value)
-        value.is_a?(String) ? value : ('%0.1f' % value)
-      end
-    end
-  end
-end