sitemap_generator 1.3.9 → 1.3.10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (1.3.8)
+    sitemap_generator (1.3.9)
 
 GEM
   remote: http://rubygems.org/
@@ -28,13 +28,13 @@ GEM
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
-    json (1.4.6)
-    json_pure (1.4.6)
+    json (1.5.1)
+    json_pure (1.5.1)
     linecache (0.43)
     mocha (0.9.10)
       rake
     nokogiri (1.4.4)
-    rack (1.1.0)
+    rack (1.1.1)
     rails (2.3.8)
       actionmailer (= 2.3.8)
       actionpack (= 2.3.8)
@@ -57,7 +57,7 @@ GEM
     sqlite3-ruby (1.3.1)
     text-format (1.0.0)
       text-hyphen (~> 1.0.0)
-    text-hyphen (1.0.0)
+    text-hyphen (1.0.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -6,7 +6,7 @@ SitemapGenerator generates Sitemaps for your Rails application.  The Sitemaps ad
 Features
 -------
 
-- Supports [Video sitemaps][sitemap_video] and [Image sitemaps][sitemap_images]
+- Supports [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], and [Geo sitemaps][geo_tags]
 - Rails 2.x and 3.x compatible
 - Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 - Handles millions of links
@@ -18,6 +18,7 @@ Features
 Changelog
 -------
 
+- v1.4.0: [Geo sitemap][geo_tags] support, support for generate multiple sitemap sets with different filenames
 - v1.3.0: Support setting the sitemaps path
 - v1.2.0: Verified working with Rails 3 stable release
 - v1.1.0: [Video sitemap][sitemap_video] support
@@ -140,6 +141,17 @@ Supported video options include:
 * `category`
 * `gallery_loc`
 * `uploader` (use `uploader_info` to set the info attribute)
+
+Geo Sitemaps
+-----------
+
+Page with geo data can be added by passing a <tt>:geo</tt> Hash to <tt>add()</tt>.  The Hash only supports one tag of <tt>:format</tt>.  Google provides an [example of a geo sitemap link here][geo_tags].  Note that the sitemap does not actually contain your KML or GeoRSS.  It merely links to a page that has this content.
+
+    sitemap.add('/stores/1234.xml', :geo => { :format => 'kml' })
+
+Supported geo options include:
+
+* `format` Required, either 'kml' or 'georss'
     
 Configuration
 ======
@@ -192,6 +204,15 @@ You must set the <tt>default_host</tt> that is to be used when adding links to y
 
 The hostname must include the full protocol.
 
+Sitemap Filenames
+----------
+
+By default sitemaps have the name <tt>sitemap1.xml.gz</tt>, <tt>sitemap2.xml.gz</tt>, etc with the sitemap index having name <tt>sitemap_index.xml.gz</tt>.
+
+If you want to change the <tt>sitemap</tt> portion of the name you can set it as shown below.  The surrounding structure of numbers, extensions, and _index will stay the same.  For example:
+
+    SitemapGenerator::Sitemap.filename = "geo_sitemap"
+
 Example Configuration File
 ---------
 
@@ -227,6 +248,42 @@ Example Configuration File
       end
     end
 
+Generating Multiple Sets Of Sitemaps
+----------
+
+To generate multiple sets of sitemaps you can create multiple configuration files.  Each should contain a different <tt>SitemapGenerator::Sitemap.filename</tt> to avoid overwriting the previous set. (Of course you can keep the default name of 'sitemap' in one of them.)  You can then build each set with a separate rake task.  For example:
+
+    rake sitemap:refresh
+    rake sitemap:refresh CONFIG_FILE="config/geo_sitemap.rb"
+    
+The first one uses the default config file at <tt>config/sitemap.rb</tt>.  Your first config file might look like this:
+
+    # config/sitemap.rb
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      Store.each do |store
+        sitemap.add store_path(store)
+      end
+    end
+
+And the second:
+
+    # config/geo_sitemap.rb
+    SitemapGenerator::Sitemap.filename = "geo_sitemap"
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      Store.each do |store
+        sitemap.add "stores/#{store.id}.xml", :geo => { :format => 'kml' }
+      end
+    end
+
+After running both rake tasks you'll have the following files in your <tt>public</tt> directory (or wherever you set the sitemaps_path):
+
+    geo_sitemap_index.xml.gz
+    geo_sitemap1.xml.gz
+    sitemap_index.xml.gz
+    sitemap1.xml.gz
+
 Raison d'être
 -------
 
@@ -299,6 +356,7 @@ Thanks (in no particular order)
 - [Adrian Mugnolo](http://github.com/xymbol)
 - [Jason Weathered](http://github.com/jasoncodes)
 - [Andy Stewart](http://github.com/airblade)
+- [Brian Armstrong](https://github.com/barmstrong) for geo sitemaps
 
 Copyright (c) 2009 Karl Varga released under the MIT license
 
@@ -311,4 +369,5 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [sitemap_video]:http://www.google.com/support/webmasters/bin/topic.py?topic=10079
 [sitemap_protocol]:http://sitemaps.org/protocol.php
 [video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
-[image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
+[image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
+[geo_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=94555

data/README.md.orig

@@ -0,0 +1,374 @@
+SitemapGenerator
+================
+
+SitemapGenerator generates Sitemaps for your Rails application.  The Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.  You specify the contents of your Sitemap using a configuration file, à la Rails Routes.  A set of rake tasks is included to help you manage your Sitemaps.
+
+Features
+-------
+
+- Supports [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], and [Geo sitemaps][geo_tags]
+- Rails 2.x and 3.x compatible
+- Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
+- Handles millions of links
+- Compresses Sitemaps using GZip
+- Notifies Search Engines (Google, Yahoo, Bing, Ask, SitemapWriter) of new sitemaps
+- Ensures your old Sitemaps stay in place if the new Sitemap fails to generate
+- You set the hostname (and protocol) of the links in your Sitemap
+
+Changelog
+-------
+
+- v1.4.0: [Geo sitemap][geo_tags] support, support for generate multiple sitemap sets with different filenames
+- v1.3.0: Support setting the sitemaps path
+- v1.2.0: Verified working with Rails 3 stable release
+- v1.1.0: [Video sitemap][sitemap_video] support
+- v0.2.6: [Image Sitemap][sitemap_images] support
+- v0.2.5: Rails 3 prerelease support (beta)
+
+Foreword
+-------
+
+Adam Salter first created SitemapGenerator while we were working together in Sydney, Australia.  Unfortunately, he passed away in 2009.  Since then I have taken over development of SitemapGenerator.
+
+Those who knew him know what an amazing guy he was, and what an excellent Rails programmer he was.  His passing is a great loss to the Rails community.
+
+The canonical repository is now: [http://github.com/kjvarga/sitemap_generator][canonical_repo]
+
+Install
+=======
+
+**Rails 3:**
+
+1. Add the gem to your `Gemfile`
+
+      gem 'sitemap_generator'
+
+2. `$ rake sitemap:install`
+
+You don't need to include the tasks in your `Rakefile` because the tasks are loaded for you.
+
+**Pre Rails 3: As a gem**
+
+1. Add the gem as a dependency in your <tt>config/environment.rb</tt>
+
+      config.gem 'sitemap_generator', :lib => false
+
+2. `$ rake gems:install`
+
+3. Add the following to your `Rakefile`
+
+      begin
+        require 'sitemap_generator/tasks'
+      rescue Exception => e
+        puts "Warning, couldn't load gem tasks: #{e.message}! Skipping..."
+      end
+
+4. `$ rake sitemap:install`
+
+**Pre Rails 3: As a plugin**
+
+1. `$ ./script/plugin install git://github.com/kjvarga/sitemap_generator.git`
+
+Usage
+======
+
+<code>rake sitemap:install</code> creates a <tt>config/sitemap.rb</tt> file which contains your logic for generating the Sitemap files.
+
+Once you have configured your sitemap in <tt>config/sitemap.rb</tt> (see Configuration below) run <code>rake sitemap:refresh</code> as needed to create/rebuild your Sitemap files.  Sitemaps are generated into the <tt>public/</tt> folder and are named <tt>sitemap_index.xml.gz</tt>, <tt>sitemap1.xml.gz</tt>, <tt>sitemap2.xml.gz</tt>, etc.
+
+Using <code>rake sitemap:refresh</code> will notify major search engines to let them know that a new Sitemap is available (Google, Yahoo, Bing, Ask, SitemapWriter).  To generate new Sitemaps without notifying search engines (for example when running in a local environment) use <code>rake sitemap:refresh:no_ping</code>.
+
+To ping Yahoo you will need to set your Yahoo AppID in <tt>config/sitemap.rb</tt>.  For example: <code>SitemapGenerator::Sitemap.yahoo_app_id = "my_app_id"</code>
+
+To disable all non-essential output (only errors will be displayed) run the rake tasks with the <code>-s</code> option.  For example <code>rake -s sitemap:refresh</code>.
+
+Cron
+-----
+
+To keep your Sitemaps up-to-date, setup a cron job.  Make sure to pass the <code>-s</code> option to silence rake.  That way you will only get email when the sitemap build fails.
+
+If you're using Whenever, your schedule would look something like the following:
+
+    # config/schedule.rb
+    every 1.day, :at => '5:00 am' do
+      rake "-s sitemap:refresh"
+    end
+
+Robots.txt
+----------
+
+You should add the Sitemap index file to <code>public/robots.txt</code> to help search engines find your Sitemaps.  The URL should be the complete URL to the Sitemap index file.  For example:
+
+    Sitemap: http://www.example.org/sitemap_index.xml.gz
+
+Image Sitemaps
+-----------
+
+Images can be added to a sitemap URL by passing an <tt>:images</tt> array to <tt>add()</tt>.  Each item in the array must be a Hash containing tags defined by the [Image Sitemap][image_tags] specification.  For example:
+
+    sitemap.add('/index.html', :images => [{ :loc => 'http://www.example.com/image.png', :title => 'Image' }])
+
+Supported image options include:
+
+* `loc` Required, location of the image
+* `caption`
+* `geo_location`
+* `title`
+* `license`
+
+Video Sitemaps
+-----------
+
+A video can be added to a sitemap URL by passing a <tt>:video</tt> Hash to <tt>add()</tt>.  The Hash can contain tags defined by the [Video Sitemap specification][video_tags].  To associate more than one <tt>tag</tt> with a video, pass the tags as an array with the key <tt>:tags</tt>.
+
+    sitemap.add('/index.html', :video => { :thumbnail_loc => 'http://www.example.com/video1_thumbnail.png', :title => 'Title', :description => 'Description', :content_loc => 'http://www.example.com/cool_video.mpg', :tags => %w[one two three], :category => 'Category' })
+
+Supported video options include:
+
+* `thumbnail_loc` Required
+* `title` Required
+* `description` Required
+* `content_loc` Depends.  At least one of `player_loc` or `content_loc` is required
+* `player_loc` Depends. At least one of `player_loc` or `content_loc` is required
+* `expiration_date` Recommended
+* `duration` Recommended
+* `rating`
+* `view_count`
+* `publication_date`
+* `family_friendly`
+* `tags` A list of tags if more than one tag.
+* `tag` A single tag.  See `tags`
+* `category`
+* `gallery_loc`
+* `uploader` (use `uploader_info` to set the info attribute)
+
+Geo Sitemaps
+-----------
+
+Page with geo data can be added by passing a <tt>:geo</tt> Hash to <tt>add()</tt>.  The Hash only supports one tag of <tt>:format</tt>.  Google provides an [example of a geo sitemap link here][geo_tags].  Note that the sitemap does not actually contain your KML or GeoRSS.  It merely links to a page that has this content.
+
+    sitemap.add('/restaurants/1234.kml', :geo => { :format => 'kml' })
+
+Supported geo options include:
+
+* `format` Required, either 'kml' or 'georss'
+    
+Configuration
+======
+
+The sitemap configuration file can be found in <tt>config/sitemap.rb</tt>.  When you run a rake task to refresh your sitemaps this file is evaluated.  It contains all your configuration settings, as well as your sitemap definition.
+
+Sitemap Links
+----------
+
+The Root Path <tt>/</tt> and Sitemap Index file are automatically added to your sitemap.  Links are added to the Sitemap output in the order they are specified.  Add links to your sitemap by calling <tt>add_links</tt>, passing a black which receives the sitemap object.  Then call <tt>add(path, options)</tt> on the sitemap to add a link.
+
+For Example:
+
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      sitemap.add '/reports'
+    end
+
+The Rails URL helpers are automatically included for you if Rails is detected.  So in your call to <tt>add</tt> you can use them to generate paths for your active records, e.g.:
+
+    Article.find_each do |article|
+      sitemap.add article_path(article), :lastmod => article.updated_at
+    end
+
+For large sitemaps it is advisable to iterate through your Active Records in batches to avoid loading all records into memory at once.  As of Rails 2.3.2 you can use <tt>ActiveRecord::Base#find_each</tt> or <tt>ActiveRecord::Base#find_in_batches</tt> to do batched finds, which can significantly improve sitemap performance.
+
+Valid [options to <tt>add</tt>](http://sitemaps.org/protocol.php#xmlTagDefinitions) are:
+
+* `priority`  The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0.  Default _0.5_
+* `changefreq`  One of: always, hourly, daily, weekly, monthly, yearly, never. Default _weekly_
+* `lastmod` Time instance. The date of last modification.  Default `Time.now`
+* `host` Optional host for the link's URL.  Defaults to `default_host`
+    
+Sitemaps Path
+----------
+
+By default sitemaps are generated into <tt>public/</tt>.  You can customize the location for your generated sitemaps by setting <tt>sitemaps_path</tt> to a path relative to your public directory.  The directory will be created for you if it does not already exist.
+
+For example:
+
+    SitemapGenerator::Sitemap.sitemaps_path = 'sitemaps/'
+
+Will generate sitemaps into the `public/sitemaps/` directory.  If you want your sitemaps to be findable by robots, you need to specify the location of your sitemap index file in your <tt>public/robots.txt</tt>.
+
+Sitemaps Host
+----------
+
+You must set the <tt>default_host</tt> that is to be used when adding links to your sitemap.  The hostname should match the host that the sitemaps are going to be served from.  For example:
+
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+
+The hostname must include the full protocol.
+
+Sitemap Filenames
+----------
+
+By default sitemaps have the name <tt>sitemap1.xml.gz</tt>, <tt>sitemap2.xml.gz</tt>, etc with the sitemap index having name <tt>sitemap_index.xml.gz</tt>.
+
+If you want to change the <tt>sitemap</tt> portion of the name you can set it as shown below.  The surrounding structure of numbers, extensions, and _index will stay the same.  For example:
+
+    SitemapGenerator::Sitemap.filename = "geo_sitemap"
+
+Example Configuration File
+---------
+
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.yahoo_app_id = nil # Set to your Yahoo AppID to ping Yahoo
+
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      # Put links creation logic here.
+      #
+      # The Root Path ('/') and Sitemap Index file are added automatically.
+      # Links are added to the Sitemap output in the order they are specified.
+      #
+      # Usage: sitemap.add path, options
+      #        (default options are used if you don't specify them)
+      #
+      # Defaults: :priority => 0.5, :changefreq => 'weekly',
+      #           :lastmod => Time.now, :host => default_host
+
+      # add '/articles'
+      sitemap.add articles_path, :priority => 0.7, :changefreq => 'daily'
+
+      # add all articles
+      Article.all.each do |a|
+        sitemap.add article_path(a), :lastmod => a.updated_at
+      end
+
+      # add news page with images
+      News.all.each do |news|
+        images = news.images.collect do |image|
+          { :loc => image.url, :title => image.name }
+        end
+        sitemap.add news_path(news), :images => images
+      end
+    end
+
+Generating Multiple Sets Of Sitemaps
+----------
+
+To generate multiple sets of sitemaps you can create multiple configuration files.  Each should contain a different <tt>SitemapGenerator::Sitemap.filename</tt> to avoid overwriting the previous set. (Of course you can keep the default name of 'sitemap' in one of them.)  You can then build each set with a separate rake task.  For example:
+
+    rake sitemap:refresh
+    rake sitemap:refresh CONFIG_FILE="config/geo_sitemap.rb"
+<<<<<<< HEAD
+
+The first one uses the default config file at <tt>config/sitemap.rb</tt>.  Your two config files might look like this:
+=======
+    
+The first one uses the default config file at <tt>config/sitemap.rb</tt>.  Your first config file might look like this:
+>>>>>>> lets you build multiple sitemap sets
+
+    # config/sitemap.rb
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      Store.each do |store
+        sitemap.add store_path(store)
+      end
+    end
+
+<<<<<<< HEAD
+=======
+And the second:
+>>>>>>> lets you build multiple sitemap sets
+
+    # config/geo_sitemap.rb
+    SitemapGenerator::Sitemap.filename = "geo_sitemap"
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.add_links do |sitemap|
+      Store.each do |store
+        sitemap.add store_path(store, :format => :kml), :geo => { :format => 'kml' }
+      end
+    end
+
+Raison d'être
+-------
+
+Most of the Sitemap plugins out there seem to try to recreate the Sitemap links by iterating the Rails routes. In some cases this is possible, but for a great deal of cases it isn't.
+
+a) There are probably quite a few routes in your routes file that don't need inclusion in the Sitemap. (AJAX routes I'm looking at you.)
+
+and
+
+b) How would you infer the correct series of links for the following route?
+
+    map.zipcode 'location/:state/:city/:zipcode', :controller => 'zipcode', :action => 'index'
+
+Don't tell me it's trivial, because it isn't. It just looks trivial.
+
+So my idea is to have another file similar to 'routes.rb' called 'sitemap.rb', where you can define what goes into the Sitemap.
+
+Here's my solution:
+
+    Zipcode.find(:all, :include => :city).each do |z|
+      sitemap.add zipcode_path(:state => z.city.state, :city => z.city, :zipcode => z)
+    end
+
+Easy hey?
+
+Other Sitemap settings for the link, like `lastmod`, `priority`, `changefreq` and `host` are entered automatically, although you can override them if you need to.
+
+Compatibility
+=======
+
+Tested and working on:
+
+- **Rails** 3.0.0
+- **Rails** 1.x - 2.3.8
+- **Ruby** 1.8.6, 1.8.7, 1.8.7 Enterprise Edition, 1.9.1
+
+Notes
+=======
+
+1) New Capistrano deploys will remove your Sitemap files, unless you run `rake sitemap:refresh`. The way around this is to create a cap task to copy the sitemaps from the previous deploy:
+
+    after "deploy:update_code", "deploy:copy_old_sitemap"
+
+    namespace :deploy do
+      task :copy_old_sitemap do
+          run "if [ -e #{previous_release}/public/sitemap_index.xml.gz ]; then cp #{previous_release}/public/sitemap* #{current_release}/public/; fi"
+      end
+    end
+
+Known Bugs
+========
+
+- There's no check on the size of a URL which [isn't supposed to exceed 2,048 bytes][sitemaps_xml].
+- Currently only supports one Sitemap Index file, which can contain 50,000 Sitemap files which can each contain 50,000 urls, so it _only_ supports up to 2,500,000,000 (2.5 billion) urls. I personally have no need of support for more urls, but plugin could be improved to support this.
+
+Wishlist & Coming Soon
+========
+
+- Support for read-only filesystems
+- Support for plain Ruby and Merb sitemaps
+
+Thanks (in no particular order)
+========
+
+- [Alex Soto](http://github.com/apsoto) for video sitemaps
+- [Alexadre Bini](http://github.com/alexandrebini) for image sitemaps
+- [Dan Pickett](http://github.com/dpickett)
+- [Rob Biedenharn](http://github.com/rab)
+- [Richie Vos](http://github.com/jerryvos)
+- [Adrian Mugnolo](http://github.com/xymbol)
+- [Jason Weathered](http://github.com/jasoncodes)
+- [Andy Stewart](http://github.com/airblade)
+- [Brian Armstrong](https://github.com/barmstrong) for geo sitemaps
+
+Copyright (c) 2009 Karl Varga released under the MIT license
+
+[canonical_repo]:http://github.com/kjvarga/sitemap_generator
+[enterprise_class]:https://twitter.com/dhh/status/1631034662 "I use enterprise in the same sense the Phusion guys do - i.e. Enterprise Ruby. Please don't look down on my use of the word 'enterprise' to represent being a cut above. It doesn't mean you ever have to work for a company the size of IBM. Or constantly fight inertia, writing crappy software, adhering to change management practices and spending hours in meetings... Not that there's anything wrong with that - Wait, what?"
+[sitemaps_org]:http://www.sitemaps.org/protocol.php "http://www.sitemaps.org/protocol.php"
+[sitemaps_xml]:http://www.sitemaps.org/protocol.php#xmlTagDefinitions "XML Tag Definitions"
+[sitemap_generator_usage]:http://wiki.github.com/adamsalter/sitemap_generator/sitemapgenerator-usage "http://wiki.github.com/adamsalter/sitemap_generator/sitemapgenerator-usage"
+[sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636
+[sitemap_video]:http://www.google.com/support/webmasters/bin/topic.py?topic=10079
+[sitemap_protocol]:http://sitemaps.org/protocol.php
+[video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
+[image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
+[geo_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=94555

data/VERSION

@@ -1 +1 @@
-1.3.9
+1.3.10

data/lib/sitemap_generator.rb

@@ -27,4 +27,5 @@ module SitemapGenerator
 
   self.root = File.expand_path(File.join(File.dirname(__FILE__), '../'))
   self.templates = SitemapGenerator::Templates.new(self.root)
+
 end

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -41,6 +41,7 @@ module SitemapGenerator
                 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"
               xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
               xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"
+              xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0"
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -14,7 +14,7 @@ module SitemapGenerator
           path = path.sitemap_path
         end
 
-        options.assert_valid_keys(:priority, :changefreq, :lastmod, :host, :images, :video)
+        options.assert_valid_keys(:priority, :changefreq, :lastmod, :host, :images, :video, :geo)
         options.reverse_merge!(:priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :host => Sitemap.default_host, :images => [])
         self.merge!(
           :path => path,
@@ -24,7 +24,8 @@ module SitemapGenerator
           :host => options[:host],
           :loc => URI.join(options[:host], path).to_s,
           :images => prepare_images(options[:images], options[:host]),
-          :video => options[:video]
+          :video => options[:video],
+          :geo => options[:geo]
         )
       end
 
@@ -76,6 +77,13 @@ module SitemapGenerator
               end
             end
           end
+
+          unless self[:geo].blank?
+            geo = self[:geo]
+            builder.geo :geo do
+              builder.geo :format, geo[:format] if geo[:format]
+            end
+          end
         end
         builder << '' # Force to string
       end

data/lib/sitemap_generator/link_set.rb

@@ -7,7 +7,7 @@ module SitemapGenerator
   class LinkSet
     include ActionView::Helpers::NumberHelper  # for number_with_delimiter
 
-    attr_reader :default_host, :public_path, :sitemaps_path
+    attr_reader :default_host, :public_path, :sitemaps_path, :filename
     attr_accessor :sitemap, :sitemap_index
     attr_accessor :verbose, :yahoo_app_id
 
@@ -18,7 +18,7 @@ module SitemapGenerator
     #
     # TODO: Refactor so that we can have multiple instances
     # of LinkSet.
-    def create(&block)
+    def create(config_file = 'config/sitemap.rb', &block)
       require 'sitemap_generator/interpreter'
 
       start_time = Time.now
@@ -27,7 +27,7 @@ module SitemapGenerator
         self.sitemap = SitemapGenerator::Builder::SitemapFile.new(@public_path, new_sitemap_path)
       end
 
-      SitemapGenerator::Interpreter.new(self, &block)
+      SitemapGenerator::Interpreter.new(self, config_file, &block)
       unless self.sitemap.finalized?
         self.sitemap_index.add(self.sitemap)
         puts self.sitemap.summary if verbose
@@ -52,10 +52,14 @@ module SitemapGenerator
     #
     # <tt>default_host</tt> hostname including protocol to use in all sitemap links
     #   e.g. http://en.google.ca
-    def initialize(public_path = nil, sitemaps_path = nil, default_host = nil)
+    #
+    # <tt>filename</tt> used in the name of the file like "#{@filename}1.xml.gzip" and "#{@filename}_index.xml.gzip"
+    #   Defaults to <tt>sitemap</tt>
+    def initialize(public_path = nil, sitemaps_path = nil, default_host = nil, filename = 'sitemap')
       @default_host = default_host
       @public_path = public_path
       @sitemaps_path = sitemaps_path
+      @filename = filename
 
       if @public_path.nil?
         @public_path = File.join(::Rails.root, 'public/') rescue 'public/'
@@ -158,13 +162,19 @@ module SitemapGenerator
       self.sitemap.sitemap_path = new_sitemap_path unless self.sitemap.finalized?
     end
 
+    def filename=(value)
+      @filename = value
+      self.sitemap_index.sitemap_path = sitemap_index_path unless self.sitemap_index.finalized?
+      self.sitemap.sitemap_path = new_sitemap_path unless self.sitemap.finalized?
+    end
+
     protected
 
     # Return the current sitemap filename with index.
     #
     # The index depends on the length of the <tt>sitemaps</tt> array.
     def new_sitemap_path
-      File.join(self.sitemaps_path || '', "sitemap#{self.sitemap_index.sitemaps.length + 1}.xml.gz")
+      File.join(self.sitemaps_path || '', "#{@filename}#{self.sitemap_index.sitemaps.length + 1}.xml.gz")
     end
 
     # Return the current sitemap index filename.
@@ -172,7 +182,7 @@ module SitemapGenerator
     # At the moment we only support one index file which can link to
     # up to 50,000 sitemap files.
     def sitemap_index_path
-      File.join(self.sitemaps_path || '', 'sitemap_index.xml.gz')
+      File.join(self.sitemaps_path || '', "#{@filename}_index.xml.gz")
     end
   end
 end

data/tasks/sitemap_generator_tasks.rake

@@ -38,6 +38,6 @@ namespace :sitemap do
 
   task :create => ['sitemap:require_environment'] do
     SitemapGenerator::Sitemap.verbose = verbose
-    SitemapGenerator::Sitemap.create
+    SitemapGenerator::Sitemap.create(ENV["CONFIG_FILE"])
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sitemap_generator
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 1
   - 3
-  - 9
-  version: 1.3.9
+  - 10
+  version: 1.3.10
 platform: ruby
 authors: 
 - Karl Varga
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 -08:00
+date: 2011-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,11 +111,13 @@ extensions: []
 
 extra_rdoc_files: 
 - README.md
+- README.md.orig
 files: 
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
+- README.md.orig
 - Rakefile
 - VERSION
 - lib/sitemap_generator.rb