xml-sitemap 1.2.1 → 1.2.2

data/lib/xml-sitemap.rb

@@ -2,6 +2,7 @@ require 'time'
 require 'date'
 require 'zlib'
 require 'builder'
+require 'cgi'
 begin
   require 'nokogiri'
 rescue LoadError

data/lib/xml-sitemap/index.rb

@@ -2,6 +2,8 @@ module XmlSitemap
   class Index
     attr_reader :maps
     
+    # Initialize a new Index instance
+    #
     def initialize(opts={})
       @maps     = []
       @offsets  = Hash.new(0)
@@ -10,6 +12,9 @@ module XmlSitemap
     end
     
     # Add map object to index
+    #
+    # map - XmlSitemap::Map instance
+    #
     def add(map)
       raise ArgumentError, 'XmlSitemap::Map object requred!' unless map.kind_of?(XmlSitemap::Map)
       raise ArgumentError, 'Map is empty!' if map.empty?
@@ -22,6 +27,7 @@ module XmlSitemap
     end
     
     # Generate sitemap XML index
+    #
     def render
       xml = Builder::XmlMarkup.new(:indent => 2)
       xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
@@ -36,8 +42,14 @@ module XmlSitemap
     end
     
     # Render XML sitemap index into the file
-    def render_to(path, opts={})
-      overwrite = opts[:overwrite] || true
+    #
+    # path    - Output filename
+    # options - Options hash
+    #
+    # options[:ovewrite] - Overwrite file contents (default: true)
+    #
+    def render_to(path, options={})
+      overwrite = options[:overwrite] || true
       path = File.expand_path(path)
       
       if File.exists?(path) && !overwrite

data/lib/xml-sitemap/map.rb

@@ -105,6 +105,12 @@ module XmlSitemap
     
     # Render XML sitemap into the file
     #
+    # path    - Output filename
+    # options - Options hash
+    #
+    # options[:overwrite] - Overwrite the file contents (default: true)
+    # options[:gzip]      - Gzip file contents (default: false)
+    #
     def render_to(path, options={})
       overwrite = options[:overwrite] == true || true
       compress  = options[:gzip]      == true || false

data/lib/xml-sitemap/options.rb

@@ -19,6 +19,6 @@ module XmlSitemap
   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",
-    'xmlns' => "http://www.sitemaps.org/schemas/sitemap/0.9"
+    'xmlns'              => "http://www.sitemaps.org/schemas/sitemap/0.9"
   }.freeze
 end

data/lib/xml-sitemap/version.rb

@@ -1,3 +1,3 @@
 module XmlSitemap
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml-sitemap
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2011-10-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153030780 !ruby/object:Gem::Requirement
+  requirement: &2166022840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *2153030780
+  version_requirements: *2166022840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153029200 !ruby/object:Gem::Requirement
+  requirement: &2166022080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2153029200
+  version_requirements: *2166022080
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2153028680 !ruby/object:Gem::Requirement
+  requirement: &2166021560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2153028680
+  version_requirements: *2166021560
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2153028180 !ruby/object:Gem::Requirement
+  requirement: &2166021100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.5.0
   type: :development
   prerelease: false
-  version_requirements: *2153028180
+  version_requirements: *2166021100
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2153027140 !ruby/object:Gem::Requirement
+  requirement: &2166020560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153027140
+  version_requirements: *2166020560
 description: Provides a wrapper to generate XML sitemaps and sitemap indexes.
 email:
 - dan.sosedoff@gmail.com