xml-sitemap 1.1.2 → 1.1.3

data/README.md

@@ -1,38 +1,63 @@
-XmlSitemap
-==========
+# 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.
+It does not have any web-framework dependencies and could be used in any ruby-based application.
 
-## Installing XmlSitemap
+## Installation
+
+Install via rubygems:
 
     $ gem install xml-sitemap
   
-## Sample usage
+## Configuration
+
+Add gem to your Gemfile and you're ready to go:
 
-In your Gemfile:
+```ruby
+gem 'xml-sitemap'
+```
 
-    gem 'xml-sitemap'
+## Usage
   
-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
+Simple usage:
+
+```ruby
+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 (default is 0.5)
+  m.add 'page3', :priority => 0.2
+
+  # Specify last modification date and update frequiency
+  m.add 'page4', :updated => Date.today, :period => :never
+end
+
+# Render the sitemap XML
+map.render
+
+# Render and save XML to the output file
+map.render_to('/path/to/file.xml')
+
+# You can also use compression
+map.render_to('/path/to/file.xml.gz', :gzip => true)
+
+# If you didnt specify .gz extension to the filename,
+# XmlSitemap will automatically append it
+# => content will be saved to /path/to/file.xml.gz
+map.render_to('/path/to/file.xml', :gzip => true)
+```
+
+You can also create a map via shortcut:
+
+```ruby
+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.
 
@@ -51,38 +76,47 @@ List of periods:
 
 When creating a new map object, you can specify a set of options.
 
-    map = XmlSitemap::Map.new('mydomain.com', options)
+```ruby
+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)
+- :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)* 
 
 ## XmlSitemap::Index
 
-Regular sitemap does not support more than 50k records, so if you generation a huge sitemap you need to use XmlSitemap::Index.
+Regular sitemap does not support more than 50k records, so if you're generating 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'
+```ruby
+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
+index = XmlSitemap::Index.new
+# or via shortcut
+index = XmlSitemap.index
+
+# Add a map to the index
+index.add(map)
+
+# Render as XML
+index.render
 
-- Gzip sitemaps and index file
+# Render XML to the output file
+index.render_to('/path/to/file.xml')
+```
 
 ## License
 
-Copyright © 2010 Dan Sosedoff.
+Copyright © 2010-2011 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/lib/xml-sitemap/index.rb

@@ -3,8 +3,8 @@ module XmlSitemap
     attr_reader :maps
     
     def initialize(opts={})
-      @maps   = []
-      @offset = 0
+      @maps     = []
+      @offsets  = Hash.new(0)
       
       yield self if block_given?
     end
@@ -15,10 +15,10 @@ module XmlSitemap
       raise ArgumentError, 'Map is empty!' if map.empty?
       
       @maps << {
-        :loc     => map.index_url(@offset),
+        :loc     => map.index_url(@offsets[map.group]),
         :lastmod => map.created_at.utc.iso8601
       }
-      @offset += 1
+      @offsets[map.group] += 1
     end
     
     # Generate sitemap XML index

data/lib/xml-sitemap/map.rb

@@ -1,11 +1,13 @@
 module XmlSitemap
   class Item
+    DEFAULT_PRIORITY = 0.5
+    
     attr_reader :target, :updated, :priority, :changefreq
     
     def initialize(target, opts={})
       @target     = target.to_s.strip
       @updated    = opts[:updated]  || Time.now
-      @priority   = opts[:priority] || 0.5
+      @priority   = opts[:priority] || DEFAULT_PRIORITY
       @changefreq = opts[:period]   || :weekly
       
       # allow only date or time object
@@ -23,6 +25,7 @@ module XmlSitemap
     attr_reader   :buffer
     attr_reader   :created_at
     attr_reader   :root
+    attr_reader   :group
     
     # Creates new Map class for specified domain
     def initialize(domain, opts={})
@@ -33,6 +36,7 @@ module XmlSitemap
       @secure     = opts[:secure] || false
       @home       = opts.key?(:home) ? opts[:home] : true
       @root       = opts.key?(:root) ? opts[:root] : true
+      @group      = opts[:group] || "sitemap"
       @items      = []
       
       self.add('/', :priority => 1.0) if @home === true
@@ -52,8 +56,14 @@ module XmlSitemap
       raise ArgumentError, 'Target required!' if target.nil?
       raise ArgumentError, 'Target is empty!' if target.to_s.strip.empty?
       
+      url = process_target(target)
+      
+      if url.length > 2048
+        raise ArgumentError, "Target can't be longer than 2,048 characters!"
+      end
+      
       opts[:updated] = @created_at unless opts.key?(:updated)
-      item = XmlSitemap::Item.new(process_target(target), opts)
+      item = XmlSitemap::Item.new(url, opts)
       @items << item
       item
     end
@@ -75,7 +85,7 @@ module XmlSitemap
     
     # Get full url for index
     def index_url(offset)
-      "http://#{@domain}/sitemap-#{offset}.xml"
+      "http://#{@domain}/#{@group}-#{offset}.xml"
     end
     
     # Render XML
@@ -95,15 +105,26 @@ module XmlSitemap
     end
     
     # Render XML sitemap into the file
-    def render_to(path, opts={})
-      overwrite = opts[:overwrite] || true
+    def render_to(path, options={})
+      overwrite = options[:overwrite] == true || true
+      compress  = options[:gzip]      == true || false
+      
       path = File.expand_path(path)
+      path << ".gz" unless path =~ /\.gz\z/i if compress
       
       if File.exists?(path) && !overwrite
         raise RuntimeError, "File already exists and not overwritable!"
       end
       
-      File.open(path, 'w') { |f| f.write(self.render) }
+      File.open(path, 'w') do |f|
+        unless compress
+          f.write(self.render)
+        else
+          gz = Zlib::GzipWriter.new(f)
+          gz.write(self.render)
+          gz.close
+        end
+      end
     end
     
     protected

data/lib/xml-sitemap/version.rb

@@ -1,3 +1,3 @@
 module XmlSitemap
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

data/lib/xml-sitemap.rb

@@ -1,7 +1,31 @@
 require 'time'
 require 'date'
+require 'zlib'
 require 'builder'
 
 require 'xml-sitemap/options'
 require 'xml-sitemap/map'
-require 'xml-sitemap/index'
+require 'xml-sitemap/index'
+
+module XmlSitemap
+  class << self
+    # Shortcut to XmlSitemap::Map.new
+    #
+    # domain  - Primary domain
+    # options - Map options
+    #
+    def map(domain, options={})
+      XmlSitemap::Map.new(domain, options) 
+    end
+    
+    alias :new :map
+    
+    # Shortcut to XmlSitemap::Index.new
+    #
+    # options - Index options
+    # 
+    def index(options={})
+      XmlSitemap::Index.new(options)
+    end
+  end
+end

data/spec/fixtures/group_index.xml

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

data/spec/index_spec.rb

@@ -47,4 +47,24 @@ describe XmlSitemap::Index do
     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)
+    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/map_spec.rb

@@ -71,6 +71,15 @@ describe XmlSitemap::Map do
     }.should raise_error RuntimeError, 'Only less than 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!"
+  end
+  
   it 'should save contents to the filesystem' do
     map = XmlSitemap::Map.new('foobar.com', :time => @base_time) do |m|
       m.add('about')
@@ -82,4 +91,33 @@ describe XmlSitemap::Map do
     File.read(path).should == fixture('saved_map.xml')
     File.delete(path) if File.exists?(path)
   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)
+  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)
+  end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ SimpleCov.start do
   add_group 'XmlSitemap', 'lib/xml-sitemap'
 end
 
+require 'digest'
 require 'xml-sitemap'
 
 def fixture_path
@@ -14,3 +15,17 @@ end
 def fixture(file)
   File.read(File.join(fixture_path, file))
 end
+
+def checksum(content)
+  Digest::SHA1.hexdigest(content)
+end
+
+def gunzip(path)
+  contents = nil
+  File.open(path) do |f|
+    gz = Zlib::GzipReader.new(f)
+    contents = gz.read
+    gz.close
+  end
+  contents
+end

data/spec/xmlsitemap_spec.rb

@@ -0,0 +1,12 @@
+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
+  end
+  
+  it 'creates an Index via shortcut' do
+    XmlSitemap.index.should be_a XmlSitemap::Index
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-25 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2165753020 !ruby/object:Gem::Requirement
+  requirement: &2154904800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2165753020
+  version_requirements: *2154904800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165752460 !ruby/object:Gem::Requirement
+  requirement: &2154904300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2165752460
+  version_requirements: *2154904300
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2165751940 !ruby/object:Gem::Requirement
+  requirement: &2154903840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2165751940
+  version_requirements: *2154903840
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2165751460 !ruby/object:Gem::Requirement
+  requirement: &2154903380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165751460
+  version_requirements: *2154903380
 description: Provides a wrapper to generate XML sitemaps and sitemap indexes.
 email:
 - dan.sosedoff@gmail.com
@@ -75,12 +75,14 @@ files:
 - lib/xml-sitemap/version.rb
 - spec/fixtures/empty_index.xml
 - spec/fixtures/encoded_map.xml
+- spec/fixtures/group_index.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
+- spec/xmlsitemap_spec.rb
 - xml-sitemap.gemspec
 homepage: http://github.com/sosedoff/xml-sitemap
 licenses: []
@@ -102,16 +104,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple XML sitemap generator for Ruby/Rails applications.
 test_files:
 - spec/fixtures/empty_index.xml
 - spec/fixtures/encoded_map.xml
+- spec/fixtures/group_index.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
+- spec/xmlsitemap_spec.rb