xml-sitemap 1.0.5 → 1.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

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

data/README.md

@@ -0,0 +1,91 @@
+XmlSitemap
+==========
+
+XmlSitemap is a Ruby library that provides an easy way to generate XML sitemaps and indexes.
+
+It does not have any web-framework dependencies thus might be used almost anywhere.
+
+## Installing XmlSitemap
+
+    $ gem install xml-sitemap
+  
+## Sample usage
+
+In your Gemfile:
+
+    gem 'xml-sitemap'
+  
+Simple map usage:
+
+    map = XmlSitemap::Map.new('domain.com') do |m|
+      # Adds a simple page
+      m.add '/page1'  
+      
+      # You can drop leading slash, it will be automatically added
+      m.add 'page2'
+      
+      # Set the page priority
+      m.add 'page3', :priority => 0.2
+      
+      # Specify last modification date and update frequiency
+      m.add 'page4', :updated => Date.today, :period => :never
+    end
+    
+    map.render                           # => render to XML
+    map.render_to('/path/to/file.xml')   # => render into a file
+  
+By default XmlSitemap creates a map with link to homepage of your domain. It's a priority 1.0. Default priority is 0.5.
+
+List of periods:
+
+- :none,
+- :always
+- :hourly
+- :daily
+- :weekly
+- :monthly
+- :yearly
+- :never
+
+## XmlSitemap::Map
+
+When creating a new map object, you can specify a set of options.
+
+    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)
+
+## XmlSitemap::Index
+
+Regular sitemap does not support more than 50k records, so if you generation a huge sitemap you need to use XmlSitemap::Index.
+Index is just a collection of links to all the website's sitemaps.
+
+Usage:
+
+    map = XmlSitemap::Map.new('domain.com')
+    map.add 'page'
+    
+    index = XmlSitemap::Index.new
+    index.add map
+    
+    index.render                          # => render index to XML
+    index.render_to('/path/to/file.xml')  # => render into a file
+    
+## TODO
+
+- Gzip sitemaps and index file
+
+## License
+
+Copyright © 2010 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/xml-sitemap.rb

@@ -1,98 +1,6 @@
 require 'time'
+require 'builder'
 
-module XmlSitemap
-  PERIODS = [:none, :always, :hourly, :daily, :weekly, :monthly, :yearly, :never]
-
-  class Item
-    attr_reader :path
-    attr_reader :updated
-    attr_reader :priority
-    attr_reader :changefreq
-    
-    def initialize(opts={})
-      @path = opts[:url] if opts.key?(:url)
-      @updated = opts[:updated] || Time.now
-      @priority = opts[:priority] || 1.0
-      @changefreq = opts[:period] || :weekly
-    end
-  end
-
-  class Map
-    attr_reader :domain, :items
-    attr_reader :buffer
-    attr_reader :created_at
-    attr_accessor :index_path
-    
-    # Creates new Map class for specified domain
-    def initialize(domain)
-      @domain = domain
-      @created_at = Time.now
-      @items = []
-      yield self if block_given?
-    end
-    
-    # Yields Map class for easier access
-    def generate
-      raise ArgumentError, 'Block required' unless block_given?
-      yield self
-    end
-    
-    # Add new item to sitemap list
-    def add(opts)
-      @items << XmlSitemap::Item.new(opts)
-    end
-    
-    # Get map items count
-    def size
-      @items.size
-    end
-    
-    # Render XML
-    def render
-      return '' if @items.size == 0
-      output = []
-      output << '<?xml version="1.0" encoding="UTF-8"?>'
-      output << '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">'
-      @items.each do |item|
-        output << '<url>'
-          output << "<loc>http://#{@domain}#{item.path.to_s}</loc>"
-          output << "<lastmod>#{item.updated.utc.iso8601}</lastmod>"
-          output << "<changefreq>#{item.changefreq.to_s}</changefreq>"
-          output << "<priority>#{item.priority.to_s}</priority>"
-        output << '</url>'
-      end
-      output << '</urlset>'
-      return output.join("\n")
-    end
-  end
-  
-  class Index
-    attr_reader :domain, :maps
-    
-    def initialize(domain)
-      @domain = domain
-      @maps = []
-    end
-    
-    # Add XmlSitemap::Map item to sitemap index
-    def add(map)
-      raise 'XmlSitemap::Map object requred!' unless map.kind_of?(Map)
-      @maps << {:loc => "http://#{@domain}/#{map.index_path}", :lastmod => map.created_at.utc.iso8601}
-    end
-    
-    # Generate sitemap XML index
-    def render
-      output = [] ; map_id = 1
-      output << '<?xml version="1.0" encoding="UTF-8"?>'
-      output << '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
-      @maps.each do |m|
-        output << '<sitemap>'
-        output << "<loc>#{m[:loc]}</loc>"
-        output << "<lastmod>#{m[:lastmod]}</lastmod>"
-        output << '</sitemap>'
-      end
-      output << '</sitemapindex>'
-      return output.join("\n")
-    end
-  end
-end
+require 'xml-sitemap/options'
+require 'xml-sitemap/map'
+require 'xml-sitemap/index'

data/lib/xml-sitemap/index.rb

@@ -0,0 +1,50 @@
+module XmlSitemap
+  class Index
+    attr_reader :maps
+    
+    def initialize(opts={})
+      @maps   = []
+      @offset = 0
+      
+      yield self if block_given?
+    end
+    
+    # Add map object to index
+    def add(map)
+      raise ArgumentError, 'XmlSitemap::Map object requred!' unless map.kind_of?(XmlSitemap::Map)
+      raise ArgumentError, 'Map is empty!' if map.empty?
+      
+      @maps << {
+        :loc     => map.index_url(@offset),
+        :lastmod => map.created_at.utc.iso8601
+      }
+      @offset += 1
+    end
+    
+    # Generate sitemap XML index
+    def render
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+      xml.urlset(XmlSitemap::INDEX_SCHEMA_OPTIONS) { |s|
+        @maps.each do |item|
+          s.sitemap do |m|
+            m.loc        item[:loc]
+            m.lastmod    item[:lastmod]
+          end
+        end
+      }.to_s
+    end
+    
+    # Render XML sitemap index into the file
+    def render_to(path, opts={})
+      overwrite = opts[:overwrite] || true
+      path = File.expand_path(path)
+      
+      if File.exists?(path) && !overwrite
+        raise RuntimeError, "File already exists and not overwritable!"
+      end
+      
+      File.open(path, 'w') { |f| f.write(self.render) }
+    end
+  end
+end

data/lib/xml-sitemap/map.rb

@@ -0,0 +1,112 @@
+module XmlSitemap
+  class Item
+    attr_reader :target, :updated, :priority, :changefreq
+    
+    def initialize(target, opts={})
+      @target     = target.to_s.strip
+      @updated    = opts[:updated]  || Time.now.utc
+      @priority   = opts[:priority] || 0.5
+      @changefreq = opts[:period]   || :weekly
+    end
+  end
+
+  class Map
+    attr_reader   :domain, :items
+    attr_reader   :buffer
+    attr_reader   :created_at
+    attr_reader   :root
+    
+    # Creates new Map class for specified domain
+    def initialize(domain, opts={})
+      @domain     = domain.to_s.strip
+      raise ArgumentError, 'Domain required!' if @domain.empty?
+      
+      @created_at = opts[:time]   || Time.now.utc
+      @secure     = opts[:secure] || false
+      @home       = opts.key?(:home) ? opts[:home] : true
+      @root       = opts.key?(:root) ? opts[:root] : true
+      @items      = []
+      
+      self.add('/', :priority => 1.0) if @home === true
+      
+      yield self if block_given?
+    end
+    
+    # Yields Map class for easier access
+    def generate
+      raise ArgumentError, 'Block required' unless block_given?
+      yield self
+    end
+    
+    # Add new item to sitemap list
+    def add(target, opts={})
+      raise RuntimeError, 'Only less than 50k records allowed!' if @items.size >= 50000
+      raise ArgumentError, 'Target required!' if target.nil?
+      raise ArgumentError, 'Target is empty!' if target.to_s.strip.empty?
+      
+      opts[:updated] = @created_at unless opts.key?(:updated)
+      item = XmlSitemap::Item.new(process_target(target), opts)
+      @items << item
+      item
+    end
+    
+    # Get map items count
+    def size
+      @items.size
+    end
+    
+    # Returns true if sitemap does not have any items
+    def empty?
+      @items.empty?
+    end
+    
+    # Generate full url for path
+    def url(path='')
+      "#{@secure ? 'https' : 'http'}://#{@domain}#{path}"
+    end
+    
+    # Get full url for index
+    def index_url(offset)
+      "http://#{@domain}/sitemap-#{offset}.xml"
+    end
+    
+    # Render XML
+    def render
+      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
+            u.lastmod    item.updated.utc.iso8601
+            u.changefreq item.changefreq.to_s
+            u.priority   item.priority.to_s
+          end
+        end
+      }.to_s
+    end
+    
+    # Render XML sitemap into the file
+    def render_to(path, opts={})
+      overwrite = opts[:overwrite] || true
+      path = File.expand_path(path)
+      
+      if File.exists?(path) && !overwrite
+        raise RuntimeError, "File already exists and not overwritable!"
+      end
+      
+      File.open(path, 'w') { |f| f.write(self.render) }
+    end
+    
+    protected
+  
+    # Process target path or url
+    def process_target(str)
+      if @root == true
+        url(str =~ /^\// ? str : "/#{str}")
+      else
+        str =~ /^(http|https)/i ? str : url(str =~ /^\// ? str : "/#{str}")
+      end
+    end
+  end
+end

data/lib/xml-sitemap/options.rb

@@ -0,0 +1,22 @@
+module XmlSitemap
+  PERIODS = [
+    :none,
+    :always,
+    :hourly,
+    :daily,
+    :weekly,
+    :monthly,
+    :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'              => "http://www.sitemaps.org/schemas/sitemap/0.9"
+  }.freeze
+  
+  INDEX_SCHEMA_OPTIONS = {
+    'xmlns' => "http://www.sitemaps.org/schemas/sitemap/0.9"
+  }.freeze
+end

data/lib/xml-sitemap/version.rb

@@ -0,0 +1,3 @@
+module XmlSitemap
+  VERSION = '1.1.0'
+end

data/spec/fixtures/empty_index.xml

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

data/spec/fixtures/encoded_map.xml

@@ -0,0 +1,15 @@
+<?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-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/path?a=b&amp;c=d&amp;e=sample string</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>

data/spec/fixtures/sample_index.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <sitemap>
+    <loc>http://foobar.com/sitemap-0.xml</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+  </sitemap>
+  <sitemap>
+    <loc>http://foobar.com/sitemap-1.xml</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+  </sitemap>
+</urlset>

data/spec/fixtures/saved_map.xml

@@ -0,0 +1,27 @@
+<?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-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/about</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/terms</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>http://foobar.com/privacy</loc>
+    <lastmod>2011-06-01T05:00:01Z</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>

data/spec/fixtures/simple_map.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://www.example.com/</loc>
+    <lastmod>2005-01-01</lastmod>
+    <changefreq>monthly</changefreq>
+    <priority>0.8</priority>
+  </url>
+</urlset>

data/spec/index_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe XmlSitemap::Index do
+  before :all do
+    @base_time = Time.mktime(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)
+    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)
+    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
+end

data/spec/map_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe XmlSitemap::Map do
+  before :all do
+    @base_time = Time.mktime(2011, 6, 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 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 not allow more than 50k records' do
+    map = XmlSitemap::Map.new('foobar.com')
+    proc {
+      1.upto(50000) { |i| map.add("url#{i}") }
+    }.should raise_error RuntimeError, 'Only less than 50k records allowed!'
+  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)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'XmlSitemap', 'lib/xml-sitemap'
+end
+
+require 'xml-sitemap'
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.read(File.join(fixture_path, file))
+end

data/xml-sitemap.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/xml-sitemap/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "xml-sitemap"
+  s.version     = XmlSitemap::VERSION.dup
+  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"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+  
+  s.add_development_dependency 'rake', '~> 0.8'
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'simplecov', '~> 0.4'
+  
+  s.add_runtime_dependency 'builder', '~> 3.0'
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+  
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: xml-sitemap
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 5
-  version: 1.0.5
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -15,12 +10,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 -05:00
+date: 2011-06-23 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: Easy XML sitemap generation for Ruby/Rails application
-email: dan.sosedoff@gmail.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
+description: Provides a wrapper to generate XML sitemaps and sitemap indexes.
+email: 
+- dan.sosedoff@gmail.com
 executables: []
 
 extensions: []
@@ -28,8 +67,25 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
 - lib/xml-sitemap.rb
+- lib/xml-sitemap/index.rb
+- lib/xml-sitemap/map.rb
+- lib/xml-sitemap/options.rb
+- lib/xml-sitemap/version.rb
+- spec/fixtures/empty_index.xml
+- spec/fixtures/encoded_map.xml
+- spec/fixtures/sample_index.xml
+- spec/fixtures/saved_map.xml
+- spec/fixtures/simple_map.xml
+- spec/index_spec.rb
+- spec/map_spec.rb
+- spec/spec_helper.rb
+- xml-sitemap.gemspec
 has_rdoc: true
 homepage: http://github.com/sosedoff/xml-sitemap
 licenses: []
@@ -44,25 +100,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: No-dependency XML sitemap generator. Can be used for any Ruby application (Rails/Merb/Sinatra).
-test_files: []
-
+summary: Simple XML sitemap generator for Ruby/Rails applications.
+test_files: 
+- spec/fixtures/empty_index.xml
+- spec/fixtures/encoded_map.xml
+- spec/fixtures/sample_index.xml
+- spec/fixtures/saved_map.xml
+- spec/fixtures/simple_map.xml
+- spec/index_spec.rb
+- spec/map_spec.rb
+- spec/spec_helper.rb

data/README

@@ -1,37 +0,0 @@
-== About XmlSitemap
-
-XmlSitemap is a gem to build website XML sitemaps.
-
-== How To Use
-
-require 'rubygems'
-require 'xml-sitemap'
-
-== Example
-
-# Somewhere in controller
-
-pages = Page.all(:order => [:updated_at.desc] # DM model
-
-@map = XmlSitemap::Map.new('somedomain.com') do |m|
-  m.add(:url => '/', :period => :daily, :priority => 1.0)
-  m.add(:url => '/contractors', :period => :daily, :priority => 1.0)
-  pages.each do |p|
-    m.add(
-      :url => url_for_page(p),
-      :updated => p.updated_at,
-      :priority => 0.5,
-      :period => :never
-    )
-  end
-end
-
-# ... then render it in your view
-<%= @map.render %>
-
-== Options
-
-:url - page path, relative to domain (ex.: /test), String.
-:period - freqchange attribute, Symbol, :none, :never, :always, :hourly, :daily, :weekly, :monthly, :yearly
-:priority - priority attribute, Float class,(0.0..1.0)
-:updated - (optional) last_update attribute, Time class