xml-sitemap 1.2.2 → 1.3.0

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
   - 1.8.7
   - 1.9.2
-  - ree
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,3 +1,2 @@
-source 'http://rubygems.org'
-
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,6 +1,6 @@
-# XmlSitemap
+# XmlSitemap [![Build Status](https://secure.travis-ci.org/sosedoff/xml-sitemap.png?branch=master)](http://travis-ci.org/sosedoff/xml-sitemap)
 
-XmlSitemap is a Ruby library that provides an easy way to generate XML sitemaps and indexes.
+XmlSitemap is a ruby library that provides an easy way to generate XML sitemaps and indexes.
 
 It does not have any web-framework dependencies and could be used in any ruby-based application.
 
@@ -8,7 +8,15 @@ It does not have any web-framework dependencies and could be used in any ruby-ba
 
 Install via rubygems:
 
-    $ gem install xml-sitemap
+```
+gem install xml-sitemap
+```
+
+Or using latest source code:
+
+```
+rake install
+```
   
 ## Configuration
 
@@ -36,7 +44,11 @@ map = XmlSitemap::Map.new('domain.com') do |m|
   # Specify last modification date and update frequiency
   m.add 'page4', :updated => Date.today, :period => :never
 end
+```
 
+Render map output:
+
+```ruby
 # Render the sitemap XML
 map.render
 
@@ -59,20 +71,22 @@ map = XmlSitemap.new('foobar.com')
 map = XmlSitemap.map('foobar.com')
 ```
   
-By default XmlSitemap creates a map with link to homepage of your domain. It's a priority 1.0. Default priority is 0.5.
+By default XmlSitemap creates a map with link to homepage of your domain. 
 
-List of periods:
+Homepage priority is `1.0`. Default page priority is set to `0.5`
 
-- :none,
-- :always
-- :hourly
-- :daily
-- :weekly
-- :monthly
-- :yearly
-- :never
+List of available update periods:
 
-## XmlSitemap::Map
+- `:none`
+- `:always`
+- `:hourly`
+- `:daily`
+- `:weekly`
+- `:monthly`
+- `:yearly`
+- `:never`
+
+### Generating Maps
 
 When creating a new map object, you can specify a set of options.
 
@@ -82,13 +96,23 @@ map = XmlSitemap::Map.new('mydomain.com', options)
 
 Available options:
 
-- :secure - Will add all sitemap items with https prefix. *(default: false)*
-- :home   - Disable homepage autocreation, but you still can do that manually. *(default: true)*
-- :root   - Force all links to fall under the main domain. You can add full urls (not paths) if set to false. *(default: true)*
-- :time   - Provide a creation time for the sitemap. (default: current time)
-- :group  - Group name for sitemap index. *(default: sitemap)* 
+- `:secure` - Will add all sitemap items with https prefix. *(default: false)*
+- `:home`   - Disable homepage autocreation, but you still can do that manually. *(default: true)*
+- `:root`   - Force all links to fall under the main domain. You can add full urls (not paths) if set to false. *(default: true)*
+- `:time`   - Provide a creation time for the sitemap. (default: current time)
+- `:group`  - Group name for sitemap index. *(default: sitemap)* 
+
+### Render Engines
+
+XmlSitemap has a few different rendering engines. You can select one passing argument to `render` method. 
+
+Available engines:
 
-## XmlSitemap::Index
+- `:string` - Uses plain strings (for performance). Default.
+- `:builder` - Uses Builder::XmlMarkup.
+- `:nokogiri` - Uses Nokogiri library. Requires `nokogiri` gem.
+
+### Sitemap Indexes
 
 Regular sitemap does not support more than 50k records, so if you're generating a huge sitemap you need to use XmlSitemap::Index.
 
@@ -101,6 +125,7 @@ map = XmlSitemap::Map.new('domain.com')
 map.add 'page'
     
 index = XmlSitemap::Index.new
+
 # or via shortcut
 index = XmlSitemap.index
 
@@ -114,14 +139,9 @@ index.render
 index.render_to('/path/to/file.xml')
 ```
 
-## Authors & Contributors
-
-- [Dan Sosedoff](https://github.com/sosedoff) (author)
-- [Dan Healy](https://github.com/danhealy)
-
 ## License
 
-Copyright © 2010-2011 Dan Sosedoff.
+Copyright © 2010-2013 Dan Sosedoff.
 
 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:
 

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler'
+require 'bundler/gem_tasks'
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:test) do |t|

data/lib/xml-sitemap.rb

@@ -8,6 +8,7 @@ begin
 rescue LoadError
 end
 
+require 'xml-sitemap/version'
 require 'xml-sitemap/options'
 require 'xml-sitemap/render_engine'
 require 'xml-sitemap/item'

data/lib/xml-sitemap/item.rb

@@ -5,15 +5,22 @@ module XmlSitemap
     # ISO8601 regex from here: http://www.pelagodesign.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
     ISO8601_REGEX = /^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/
 
-    attr_reader :target, :updated, :priority, :changefreq, :validate_time
+    attr_reader :target, :updated, :priority, :changefreq, :validate_time, :image_location, :image_caption, :image_geolocation, :image_title, :image_license
 
     def initialize(target, opts={})
-      @target         = target.to_s.strip
-      @updated        = opts[:updated]  || Time.now
-      @priority       = opts[:priority] || DEFAULT_PRIORITY
-      @changefreq     = opts[:period]   || :weekly
-      @validate_time  = (opts[:validate_time] != false)
-      
+      @target            = target.to_s.strip
+      @updated           = opts[:updated]  || Time.now
+      @priority          = opts[:priority] || DEFAULT_PRIORITY
+      @changefreq        = opts[:period]   || :weekly
+      @validate_time     = (opts[:validate_time] != false)
+
+      # Refer to http://support.google.com/webmasters/bin/answer.py?hl=en&answer=178636 for requirement to support images in sitemap
+      @image_location    = opts[:image_location]
+      @image_caption     = opts[:image_caption]
+      @image_geolocation = opts[:image_geolocation]
+      @image_title       = opts[:image_title]
+      @image_license     = opts[:image_license]
+
       unless @updated.kind_of?(Time) || @updated.kind_of?(Date) || @updated.kind_of?(String)
         raise ArgumentError, "Time, Date, or ISO8601 String required for :updated!"
       end

data/lib/xml-sitemap/options.rb

@@ -9,13 +9,14 @@ module XmlSitemap
     :yearly,
     :never
   ].freeze
-  
+
   MAP_SCHEMA_OPTIONS = {
     'xsi:schemaLocation' => "http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd",
     'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",
+    'xmlns:image'        => "http://www.google.com/schemas/sitemap-image/1.1",
     'xmlns'              => "http://www.sitemaps.org/schemas/sitemap/0.9"
   }.freeze
-  
+
   INDEX_SCHEMA_OPTIONS = {
     'xsi:schemaLocation' => "http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd",
     'xmlns:xsi'          => "http://www.w3.org/2001/XMLSchema-instance",

data/lib/xml-sitemap/render_engine.rb

@@ -1,18 +1,30 @@
 module XmlSitemap
   module RenderEngine
     private
-    
+
     # Render with Nokogiri gem
     #
     def render_nokogiri
       unless defined? Nokogiri
         raise ArgumentError, "Nokogiri not found!"
       end
+
       builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
         xml.urlset(XmlSitemap::MAP_SCHEMA_OPTIONS) { |s|
           @items.each do |item|
             s.url do |u|
               u.loc        item.target
+
+              if item.image_location
+                u["image"].image do |a|
+                  a["image"].loc                 item.image_location
+                  a["image"].caption             item.image_caption     if item.image_caption
+                  a["image"].title               item.image_title       if item.image_title
+                  a["image"].license             item.image_license     if item.image_license
+                  a["image"].geo_location        item.image_geolocation if item.image_geolocation
+                end
+              end
+
               u.lastmod    item.lastmod_value
               u.changefreq item.changefreq.to_s
               u.priority   item.priority.to_s
@@ -22,16 +34,28 @@ module XmlSitemap
       end
       builder.to_xml
     end
-    
+
     # Render with Builder gem
     #
-    def render_bulder
+    def render_builder
       xml = Builder::XmlMarkup.new(:indent => 2)
       xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+
       xml.urlset(XmlSitemap::MAP_SCHEMA_OPTIONS) { |s|
         @items.each do |item|
           s.url do |u|
             u.loc        item.target
+
+            if item.image_location
+              u.image :image do |a|
+                a.tag!("image:loc")           { |b| b.text! item.image_location }
+                a.tag!("image:caption")       { |b| b.text! item.image_caption }        if item.image_caption
+                a.tag!("image:title")         { |b| b.text! item.image_title }          if item.image_title
+                a.tag!("image:license")       { |b| b.text! item.image_license }        if item.image_license
+                a.tag!("image:geo_location")  { |b| b.text! item.image_geolocation }    if item.image_geolocation
+              end
+            end
+
             u.lastmod    item.lastmod_value
             u.changefreq item.changefreq.to_s
             u.priority   item.priority.to_s
@@ -39,31 +63,45 @@ module XmlSitemap
         end
       }.to_s
     end
-    
+
     # Render with plain strings
     #
     def render_string
       result = '<?xml version="1.0" encoding="UTF-8"?>' + "\n<urlset"
-        
+
       XmlSitemap::MAP_SCHEMA_OPTIONS.each do |key, val|
-        result += ' ' + key + '="' + val + '"'
+        result << ' ' + key + '="' + val + '"'
       end
-      
-      result += ">\n"
-      
+
+      result << ">\n"
+
       item_results = []
       @items.each do |item|
         item_string  = "  <url>\n"
-        item_string += "    <loc>#{CGI::escapeHTML(item.target)}</loc>\n"
-        item_string += "    <lastmod>#{item.lastmod_value}</lastmod>\n"
-        item_string += "    <changefreq>#{item.changefreq}</changefreq>\n"
-        item_string += "    <priority>#{item.priority}</priority>\n"
-        item_string += "  </url>\n"
-        
+        item_string << "    <loc>#{CGI::escapeHTML(item.target)}</loc>\n"
+
+        # Format and image tag specifications found in http://support.google.com/webmasters/bin/answer.py?hl=en&answer=178636
+        if item.image_location
+          item_string << "    <image:image>\n"
+          item_string << "      <image:loc>#{CGI::escapeHTML(item.image_location)}</image:loc>\n"
+          item_string << "      <image:caption>#{CGI::escapeHTML(item.image_caption)}</image:caption>\n"               if item.image_caption
+          item_string << "      <image:title>#{CGI::escapeHTML(item.image_title)}</image:title>\n"                     if item.image_title
+          item_string << "      <image:license>#{CGI::escapeHTML(item.image_license)}</image:license>\n"               if item.image_license
+          item_string << "      <image:geo_location>#{CGI::escapeHTML(item.image_geolocation)}</image:geo_location>\n" if item.image_geolocation
+          item_string << "    </image:image>\n"
+        end
+
+        item_string << "    <lastmod>#{item.lastmod_value}</lastmod>\n"
+        item_string << "    <changefreq>#{item.changefreq}</changefreq>\n"
+        item_string << "    <priority>#{item.priority}</priority>\n"
+        item_string << "  </url>\n"
+
         item_results << item_string
       end
+
+      result << item_results.join("")
+      result << "</urlset>\n"
       
-      result = result + item_results.join("") + "</urlset>\n"
       result
     end
   end

data/lib/xml-sitemap/version.rb

@@ -1,3 +1,9 @@
 module XmlSitemap
-  VERSION = '1.2.2'
+  unless defined?(::XmlSitemap::VERSION)
+    VERSION = '1.3.0'
+  end
+
+  def self.version
+    XmlSitemap::VERSION
+  end
 end

data/spec/fixtures/encoded_image_map.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://foobar.com/</loc>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+      <image:title>Image Title</image:title>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+      <image:caption>Image Caption</image:caption>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+      <image:license>Image License</image:license>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+      <image:geo_location>Image GeoLocation</image:geo_location>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=image support string</loc>
+    <image:image>
+      <image:loc>http://foobar.com/foo.gif</image:loc>
+      <image:caption>Image Caption</image:caption>
+      <image:title>Image Title</image:title>
+      <image:license>Image License</image:license>
+      <image:geo_location>Image GeoLocation</image:geo_location>
+    </image:image>
+    <lastmod>2011-06-01T00:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>

data/spec/index_spec.rb

@@ -1,70 +1,71 @@
 require 'spec_helper'
 
 describe XmlSitemap::Index do
-  before :all do
-    @base_time = Time.gm(2011, 6, 1, 0, 0, 1)
-  end
-  
-  it 'should be valid if no sitemaps were supplied' do
-    index = XmlSitemap::Index.new
-    index.render.should == fixture('empty_index.xml')
-  end
-  
-  it 'should raise error if passing a wrong object' do
-    index = XmlSitemap::Index.new
-    proc { index.add(nil) }.should raise_error ArgumentError, 'XmlSitemap::Map object requred!'
-  end
-  
-  it 'should raise error if passing an empty sitemap' do
-    map = XmlSitemap::Map.new('foobar.com', :home => false)
-    index = XmlSitemap::Index.new
-    proc { index.add(map) }.should raise_error ArgumentError, 'Map is empty!'
-  end
-  
-  it 'should render a proper index' do
-    m1 = XmlSitemap::Map.new('foobar.com', :time => @base_time) { |m| m.add('about') }
-    m2 = XmlSitemap::Map.new('foobar.com', :time => @base_time) { |m| m.add('about') }
-    
-    index = XmlSitemap::Index.new do |i|
-      i.add(m1)
-      i.add(m2)
+  let(:base_time) { Time.gm(2011, 6, 1, 0, 0, 1) }
+
+  describe '#new' do
+    it 'should be valid if no sitemaps were supplied' do
+      index = XmlSitemap::Index.new
+      index.render.split("\n")[2..-1].join("\n").should == fixture('empty_index.xml').split("\n")[2..-1].join("\n")
+    end
+
+    it 'should raise error if passing a wrong object' do
+      index = XmlSitemap::Index.new
+      expect { index.add(nil) }.to raise_error ArgumentError, 'XmlSitemap::Map object requred!'
+    end
+
+    it 'should raise error if passing an empty sitemap' do
+      map = XmlSitemap::Map.new('foobar.com', :home => false)
+      index = XmlSitemap::Index.new
+      expect { index.add(map) }.to raise_error ArgumentError, 'Map is empty!'
     end
-    
-    index.render.should == fixture('sample_index.xml')
   end
-  
-  it 'should save index contents to the filesystem' do
-    m1 = XmlSitemap::Map.new('foobar.com', :time => @base_time) { |m| m.add('about') }
-    m2 = XmlSitemap::Map.new('foobar.com', :time => @base_time) { |m| m.add('about') }
-    
-    index = XmlSitemap::Index.new do |i|
-      i.add(m1)
-      i.add(m2)
+
+  describe '#render' do
+    it 'renders a proper index' do
+      m1 = XmlSitemap::Map.new('foobar.com', :time => base_time) { |m| m.add('about') }
+      m2 = XmlSitemap::Map.new('foobar.com', :time => base_time) { |m| m.add('about') }
+
+      index = XmlSitemap::Index.new do |i|
+        i.add(m1)
+        i.add(m2)
+      end
+
+      index.render.split("\n")[2..-1].join("\n").should == fixture('sample_index.xml').split("\n")[2..-1].join("\n")
     end
-    
-    path = "/tmp/index_#{Time.now.to_i}.xml"
-    index.render_to(path)
-    File.read(path).should == fixture('sample_index.xml')
-    File.delete(path) if File.exists?(path)
   end
-  
-  it 'should have separate running offsets for different map groups' do
-    m1 = XmlSitemap::Map.new('foobar.com', :time => @base_time, :group => "first")  { |m| m.add('about') }
-    m2 = XmlSitemap::Map.new('foobar.com', :time => @base_time, :group => "second") { |m| m.add('about') }
-    m3 = XmlSitemap::Map.new('foobar.com', :time => @base_time, :group => "second") { |m| m.add('about') }
-    m4 = XmlSitemap::Map.new('foobar.com', :time => @base_time, :group => "third")  { |m| m.add('about') }
-    
-    index = XmlSitemap::Index.new do |i|
-      i.add(m1)
-      i.add(m2)
-      i.add(m3)
-      i.add(m4)
+
+  describe '#render_to' do
+    let(:index_path) { "/tmp/xml_index.xml" }
+
+    after :all do
+      File.delete_if_exists(index_path)
+    end
+
+    it 'saves index contents to the filesystem' do
+      m1 = XmlSitemap::Map.new('foobar.com', :time => base_time) { |m| m.add('about') }
+      m2 = XmlSitemap::Map.new('foobar.com', :time => base_time) { |m| m.add('about') }
+
+      index = XmlSitemap::Index.new do |i|
+        i.add(m1)
+        i.add(m2)
+      end
+
+      index.render_to(index_path)
+      File.read(index_path).split("\n")[2..-1].join("\n").should eq(fixture('sample_index.xml').split("\n")[2..-1].join("\n"))
+    end
+
+    it 'should have separate running offsets for different map groups' do
+      maps = %w(first second second third).map do |name|
+        XmlSitemap::Map.new('foobar.com', :time => base_time, :group => name)  { |m| m.add('about') }
+      end
+
+      index = XmlSitemap::Index.new do |i|
+        maps.each { |m| i.add(m) }
+      end
+
+      index.render_to(index_path)
+      File.read(index_path).split("\n")[2..-1].join("\n").should eq(fixture('group_index.xml').split("\n")[2..-1].join("\n"))
     end
-    
-    path = "/tmp/index_#{Time.now.to_i}.xml"
-    index.render_to(path)
-    File.read(path).should == fixture('group_index.xml')
-    File.delete(path) if File.exists?(path)
   end
-  
 end

data/spec/item_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe 'XmlSitemap::Item' do
-  it 'should raise ArgumentError if invalid :period value was passed' do
-    proc { XmlSitemap::Item.new('hello', :period => :foobar) }.
-      should raise_error ArgumentError, "Invalid :period value 'foobar'"
+  describe '#new' do
+    it 'raises ArgumentError if invalid :period value was passed' do
+      proc { XmlSitemap::Item.new('hello', :period => :foobar) }.
+        should raise_error ArgumentError, "Invalid :period value 'foobar'"
+    end
   end
 end

data/spec/map_spec.rb

@@ -2,172 +2,232 @@ require 'benchmark'
 require 'spec_helper'
 
 describe XmlSitemap::Map do
-  before :all do
-    @base_time = Time.gm(2011, 6, 1, 0, 0, 1)
-    @extra_time = Time.gm(2011, 7, 1, 0, 0, 1)
-  end
-  
-  it 'should not allow empty domains' do
-    proc { XmlSitemap::Map.new(nil) }.should raise_error ArgumentError
-    proc { XmlSitemap::Map.new('') }.should raise_error ArgumentError
-    proc { XmlSitemap::Map.new(' ') }.should raise_error ArgumentError
-  end
-  
-  it 'should not allow empty urls' do
-    map = XmlSitemap::Map.new('foobar.com')
-    proc { map.add(nil)  }.should raise_error ArgumentError
-    proc { map.add('')   }.should raise_error ArgumentError
-    proc { map.add('  ') }.should raise_error ArgumentError
-  end
-  
-  it 'should have a home path by default' do
-    map = XmlSitemap::Map.new('foobar.com')
-    map.empty?.should == false
-    map.items.first.target.should == 'http://foobar.com/'
-  end
-  
-  it 'should not have a home path with option' do
-    map = XmlSitemap::Map.new('foobar.com', :home => false)
-    map.empty?.should == true
-  end
-  
-  it 'should autocomplete path with no starting slash' do
-    map = XmlSitemap::Map.new('foobar.com')
-    map.add('about').target.should == 'http://foobar.com/about'
-  end
-  
-  it 'should allow full urls in items' do
-    map = XmlSitemap::Map.new('foobar.com', :root => false)
-    map.add('https://foobar.com/path').target.should == 'https://foobar.com/path'
-    map.add('path2').target.should == 'http://foobar.com/path2'
-  end
-  
-  it 'should render urls in https mode' do
-    map = XmlSitemap::Map.new('foobar.com', :secure => true)
-    map.add('path').target.should == 'https://foobar.com/path'
-  end
-  
-  it 'should properly set entry time' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    map.add('hello').updated.should == @base_time
-    map.add('world', :updated => @extra_time).updated.should == Time.gm(2011, 7, 1, 0, 0, 1)
-  end
-  
-  it 'should help me test performance' do
-    pending "comment this line to run benchmarks, takes roughly 30 seconds"
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    50000.times do |i|
-      map.add("hello#{i}")
-    end
-    
-    Benchmark.bm do |x|
-      x.report("render(:builder)")  { map.render(:builder)  }
-      x.report("render(:nokogiri)") { map.render(:nokogiri) }
-      x.report("render(:string)")   { map.render(:string)   }
+  let(:base_time)  { Time.gm(2011, 6, 1, 0, 0, 1) }
+  let(:extra_time) { Time.gm(2011, 7, 1, 0, 0, 1) }
+
+  describe '#new' do
+    it 'should not allow empty domains' do
+      expect { XmlSitemap::Map.new(nil) }.to raise_error ArgumentError
+      expect { XmlSitemap::Map.new('') }.to raise_error ArgumentError
+      expect { XmlSitemap::Map.new(' ') }.to raise_error ArgumentError
+    end
+
+    it 'should not allow empty urls' do
+      map = XmlSitemap::Map.new('foobar.com')
+
+      expect { map.add(nil)  }.to raise_error ArgumentError
+      expect { map.add('')   }.to raise_error ArgumentError
+      expect { map.add('  ') }.to raise_error ArgumentError
+    end
+
+    it 'should have a default home path' do
+      map = XmlSitemap::Map.new('foobar.com')
+      map.should_not be_empty
+      map.items.first.target.should eq('http://foobar.com/')
+    end
+
+    context 'with :home => false' do
+      it 'should have no home path' do
+        map = XmlSitemap::Map.new('foobar.com', :home => false)
+        map.should be_empty
+      end
     end
   end
-  
-  it 'should raise Argument error if no time or date were provided' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    proc { map.add('hello', :updated => 5) }.
-      should raise_error ArgumentError, "Time, Date, or ISO8601 String required for :updated!"
-  end
-  
-  it 'should not raise Argument error if a iso8601 string is provided' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    proc { map.add('hello', :updated => "2011-09-12T23:18:49Z") }.
-      should_not raise_error
-    map.add('world', :updated => @extra_time.utc.iso8601).updated.should == Time.gm(2011, 7, 1, 0, 0, 1).utc.iso8601
-  end
-  
-  it 'should not raise Argument error if a string is provided with :validate_time => false' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    proc { map.add('hello', :validate_time => false, :updated => 'invalid data') }.
-      should_not raise_error
-  end
-  
-  it 'should raise Argument error if an invalid string is provided' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    proc { map.add('hello', :updated => 'invalid data') }.
-      should raise_error ArgumentError, "String provided to :updated did not match ISO8601 standard!"
-  end
-  
-  it 'should have properly encoded entities' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    map.add('/path?a=b&c=d&e=sample string')
-    map.render.should == fixture('encoded_map.xml')
-  end
-  
-  it 'should have properly encoded entities using nokogiri render' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    map.add('/path?a=b&c=d&e=sample string')
-    s = map.render(:nokogiri)
-    # ignore ordering of urlset attributes by dropping first two lines
-    s.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
-  end
-  
-  it 'should have properly encoded entities using string render' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    map.add('/path?a=b&c=d&e=sample string')
-    s = map.render(:string)
-    # ignore ordering of urlset attributes by dropping first two lines
-    s.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
-  end
-  
-  it 'should not allow more than 50k records' do
-    map = XmlSitemap::Map.new('foobar.com')
-    proc {
-      1.upto(50001) { |i| map.add("url#{i}") }
-    }.should raise_error RuntimeError, 'Only up to 50k records allowed!'
-  end
-  
-  it 'should not allow urls longer than 2048 characters' do
-    long_string = (1..2049).to_a.map { |i| "a" }.join
-    
-    map = XmlSitemap::Map.new('foobar.com')
-    proc {
-      map.add(long_string)
-    }.should raise_error ArgumentError, "Target can't be longer than 2,048 characters!"
+
+  describe '#add' do
+    it 'should autocomplete path with no starting slash' do
+      map = XmlSitemap::Map.new('foobar.com')
+      map.add('about').target.should eq('http://foobar.com/about')
+    end
+
+    it 'should allow full urls in items' do
+      map = XmlSitemap::Map.new('foobar.com', :root => false)
+      map.add('https://foobar.com/path').target.should eq('https://foobar.com/path')
+      map.add('path2').target.should eq('http://foobar.com/path2')
+    end
+
+    it 'should render urls in https mode' do
+      map = XmlSitemap::Map.new('foobar.com', :secure => true)
+      map.add('path').target.should eq('https://foobar.com/path')
+    end
+
+    it 'should set entry time' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      map.add('hello').updated.should eq(base_time)
+      map.add('world', :updated => extra_time).updated.should eq(Time.gm(2011, 7, 1, 0, 0, 1))
+    end
+
+    it 'should raise Argument error if no time or date were provided' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      expect { map.add('hello', :updated => 5) }.
+        to raise_error ArgumentError, "Time, Date, or ISO8601 String required for :updated!"
+    end
+
+    it 'should not raise Argument error if a iso8601 string is provided' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      expect { map.add('hello', :updated => "2011-09-12T23:18:49Z") }.not_to raise_error
+      map.add('world', :updated => extra_time.utc.iso8601).updated.should eq(Time.gm(2011, 7, 1, 0, 0, 1).utc.iso8601)
+    end
+
+    it 'should not raise Argument error if a string is provided with :validate_time => false' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      expect { map.add('hello', :validate_time => false, :updated => 'invalid data') }.not_to raise_error
+    end
+
+    it 'should raise Argument error if an invalid string is provided' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      expect { map.add('hello', :updated => 'invalid data') }.
+        to raise_error ArgumentError, "String provided to :updated did not match ISO8601 standard!"
+    end
+
+    it 'should not allow more than 50k records' do
+      map = XmlSitemap::Map.new('foobar.com')
+      expect {
+        1.upto(50001) { |i| map.add("url#{i}") }
+      }.to raise_error RuntimeError, 'Only up to 50k records allowed!'
+    end
+
+    it 'should not allow urls longer than 2048 characters' do
+      long_string = (1..2049).to_a.map { |i| "a" }.join
+
+      map = XmlSitemap::Map.new('foobar.com')
+      expect {
+        map.add(long_string)
+      }.to raise_error ArgumentError, "Target can't be longer than 2,048 characters!"
+    end
   end
-  
-  it 'should save contents to the filesystem' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time) do |m|
-      m.add('about')
-      m.add('terms')
-      m.add('privacy')
-    end
-    path = "/tmp/sitemap_#{Time.now.to_i}.xml"
-    map.render_to(path)
-    File.read(path).should == fixture('saved_map.xml')
-    File.delete(path) if File.exists?(path)
+
+  describe '#render' do
+
+    before do
+      opts1 = { :image_location => "http://foobar.com/foo.gif"}
+      opts2 = { :image_location => "http://foobar.com/foo.gif", :image_title => "Image Title"}
+      opts3 = { :image_location => "http://foobar.com/foo.gif", :image_caption => "Image Caption"}
+      opts4 = { :image_location => "http://foobar.com/foo.gif", :image_license => "Image License"}
+      opts5 = { :image_location => "http://foobar.com/foo.gif", :image_geolocation => "Image GeoLocation"}
+      opts6 = { :image_location => "http://foobar.com/foo.gif",
+                :image_title    => "Image Title",
+                :image_caption  => "Image Caption",
+                :image_license  => "Image License",
+                :image_geolocation => "Image GeoLocation"}
+
+      @map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      @map.add('/path?a=b&c=d&e=image support string', opts1)
+      @map.add('/path?a=b&c=d&e=image support string', opts2)
+      @map.add('/path?a=b&c=d&e=image support string', opts3)
+      @map.add('/path?a=b&c=d&e=image support string', opts4)
+      @map.add('/path?a=b&c=d&e=image support string', opts5)
+      @map.add('/path?a=b&c=d&e=image support string', opts6)
+    end
+
+    it 'should have properly encoded entities' do
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+      map.add('/path?a=b&c=d&e=sample string')
+      map.render.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
+    end
+
+    context 'with builder engine' do
+      it 'should have properly encoded entities' do
+        map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+        map.add('/path?a=b&c=d&e=sample string')
+        s = map.render(:builder)
+        # ignore ordering of urlset attributes by dropping first two lines
+        s.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
+      end
+    end
+
+    context 'with nokogiri engine' do
+      it 'should have properly encoded entities' do
+        map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+        map.add('/path?a=b&c=d&e=sample string')
+        s = map.render(:nokogiri)
+        # ignore ordering of urlset attributes by dropping first two lines
+        s.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
+      end
+
+      it 'should have properly encoded entities with image support' do
+        s = @map.render(:nokogiri)
+        s.split("\n")[2..-1].join("\n").should == fixture('encoded_image_map.xml').split("\n")[2..-1].join("\n")
+      end
+    end
+
+    context 'with string engine' do
+      it 'should have properly encoded entities' do
+        map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+        map.add('/path?a=b&c=d&e=sample string')
+        s = map.render(:string)
+        # ignore ordering of urlset attributes by dropping first two lines
+        s.split("\n")[2..-1].join("\n").should == fixture('encoded_map.xml').split("\n")[2..-1].join("\n")
+      end
+
+      it 'should have properly encoded entities with image support' do
+        s = @map.render(:string)
+        s.split("\n")[2..-1].join("\n").should == fixture('encoded_image_map.xml').split("\n")[2..-1].join("\n")
+      end
+    end
   end
-  
-  it 'should save gzip contents to the filesystem' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    
-    path = "/tmp/sitemap.xml"
-    path_gzip = path + ".gz"
-    
-    map.render_to(path)
-    map.render_to(path_gzip, :gzip => true)
-    
-    checksum(File.read(path)).should == checksum(gunzip(path_gzip))
-    
-    File.delete(path) if File.exists?(path)
-    File.delete(path_gzip) if File.exists?(path_gzip)
+
+  describe '#render_to' do
+    it 'should save contents to the filesystem' do
+      path = "/tmp/sitemap_#{Time.now.to_i}.xml"
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time) do |m|
+        m.add('about')
+        m.add('terms')
+        m.add('privacy')
+      end
+
+      map.render_to(path)
+
+      File.read(path).split("\n")[2..-1].join("\n").should eq(fixture('saved_map.xml').split("\n")[2..-1].join("\n"))
+      File.delete(path) if File.exists?(path)
+    end
+
+    context 'with :gzip => true' do
+      it 'should save gzip contents to the filesystem' do
+        map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+
+        path = "/tmp/sitemap.xml"
+        path_gzip = path + ".gz"
+
+        map.render_to(path)
+        map.render_to(path_gzip, :gzip => true)
+
+        checksum(File.read(path)).should eq(checksum(gunzip(path_gzip)))
+
+        File.delete(path) if File.exists?(path)
+        File.delete(path_gzip) if File.exists?(path_gzip)
+      end
+
+      it 'should add .gz extension if comression is enabled' do
+        map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+        path = '/tmp/sitemap.xml'
+        path_gzip = path + ".gz"
+
+        map.render_to(path)
+        map.render_to(path, :gzip => true)
+
+        checksum(File.read(path)).should eq(checksum(gunzip(path_gzip)))
+
+        File.delete(path) if File.exists?(path)
+        File.delete(path_gzip) if File.exists?(path_gzip)
+      end
+    end
   end
-  
-  it 'should add .gz extension if comression is enabled' do
-    map = XmlSitemap::Map.new('foobar.com', :time => @base_time)
-    path = '/tmp/sitemap.xml'
-    path_gzip = path + ".gz"
-    
-    map.render_to(path)
-    map.render_to(path, :gzip => true)
-    
-    checksum(File.read(path)).should == checksum(gunzip(path_gzip))
-    
-    File.delete(path) if File.exists?(path)
-    File.delete(path_gzip) if File.exists?(path_gzip)
+
+  describe 'performance' do
+    it 'should test rendering time' do
+      pending "comment this line to run benchmarks, takes roughly 30 seconds"
+      map = XmlSitemap::Map.new('foobar.com', :time => base_time)
+
+      50000.times do |i|
+        map.add("hello#{i}")
+      end
+
+      Benchmark.bm do |x|
+        x.report("render(:builder)")  { map.render(:builder)  }
+        x.report("render(:nokogiri)") { map.render(:nokogiri) }
+        x.report("render(:string)")   { map.render(:string)   }
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -29,3 +29,13 @@ def gunzip(path)
   end
   contents
 end
+
+module FileHelper
+  def delete_if_exists(path)
+    File.delete(path) if File.exists?(path)
+  end
+end
+
+class File
+  extend FileHelper
+end

data/spec/xmlsitemap_spec.rb

@@ -1,12 +1,27 @@
 require 'spec_helper'
 
 describe 'XmlSitemap' do
-  it 'creates a Map via shortcut' do
-    XmlSitemap.new('foo.com').should be_a XmlSitemap::Map
-    XmlSitemap.map('foo.com').should be_a XmlSitemap::Map
+  describe '#new' do
+    it 'returns a new map instance' do
+      XmlSitemap.new('foo.com').should be_a XmlSitemap::Map
+    end
   end
-  
-  it 'creates an Index via shortcut' do
-    XmlSitemap.index.should be_a XmlSitemap::Index
+
+  describe '#map' do
+    it 'returns a new map instance' do
+      XmlSitemap.map('foo.com').should be_a XmlSitemap::Map
+    end
+  end
+
+  describe '#index' do
+    it 'returns a new index instancet' do
+      XmlSitemap.index.should be_a XmlSitemap::Index
+    end
+  end
+
+  describe '#version' do
+    it 'returns current version string' do
+      XmlSitemap.version.should eq(XmlSitemap::VERSION)
+    end
   end
 end

data/xml-sitemap.gemspec

@@ -2,7 +2,7 @@ require File.expand_path('../lib/xml-sitemap/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "xml-sitemap"
-  s.version     = XmlSitemap::VERSION.dup
+  s.version     = XmlSitemap::VERSION
   s.summary     = "Simple XML sitemap generator for Ruby/Rails applications."
   s.description = "Provides a wrapper to generate XML sitemaps and sitemap indexes."
   s.homepage    = "http://github.com/sosedoff/xml-sitemap"
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake',      '~> 0.8'
   s.add_development_dependency 'rspec',     '~> 2.6'
   s.add_development_dependency 'simplecov', '~> 0.4'
-  s.add_development_dependency 'nokogiri',  '~> 1.5.0'
+  s.add_development_dependency 'nokogiri',  '~> 1.5'
   
   s.add_runtime_dependency      'builder',  '>= 2.0'
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-23 00:00:00.000000000Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2166022840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2166022840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2166022080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2166022080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2166021560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +53,31 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2166021560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2166021100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *2166021100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2166020560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166020560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Provides a wrapper to generate XML sitemaps and sitemap indexes.
 email:
 - dan.sosedoff@gmail.com
@@ -87,6 +112,7 @@ files:
 - lib/xml-sitemap/render_engine.rb
 - lib/xml-sitemap/version.rb
 - spec/fixtures/empty_index.xml
+- spec/fixtures/encoded_image_map.xml
 - spec/fixtures/encoded_map.xml
 - spec/fixtures/group_index.xml
 - spec/fixtures/sample_index.xml
@@ -110,20 +136,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -987931989253574637
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -987931989253574637
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Simple XML sitemap generator for Ruby/Rails applications.
 test_files:
 - spec/fixtures/empty_index.xml
+- spec/fixtures/encoded_image_map.xml
 - spec/fixtures/encoded_map.xml
 - spec/fixtures/group_index.xml
 - spec/fixtures/sample_index.xml