= BigSitemap

BigSitemap is a {Sitemap}[http://sitemaps.org] generator suitable for applications with greater than 50,000 URLs.  It splits large Sitemaps into multiple files, gzips the files to minimize bandwidth usage, batches database queries to minimize memory usage, supports increment updates, can be set up with just a few lines of code and is compatible with just about any framework.

BigSitemap is best run periodically through a Rake/Thor task.

  require 'big_sitemap'

  sitemap = BigSitemap.new(
    :url_options   => {:host => 'example.com'},
    :document_root => "#{APP_ROOT}/public"
  )

  # Add a model
  sitemap.add Product

  # Add another model with some options
  sitemap.add(Post,
    :conditions       => {:published => true},
    :path             => 'articles',
    :change_frequency => 'daily',
    :priority         => 0.5
  )

  # Add a static resource
  sitemap.add_static('http://example.com/about', Time.now, 'monthly', 0.1)

  # Generate the files
  sitemap.generate

The code above will create a minimum of four files:

1. public/sitemaps/sitemap_index.xml.gz
2. public/sitemaps/sitemap_products.xml.gz
3. public/sitemaps/sitemap_posts.xml.gz
4. public/sitemaps/sitemap_static.xml.gz

If your sitemaps grow beyond 50,000 URLs (this limit can be overridden with the <code>:max_per_sitemap</code> option), the sitemap files will be partitioned into multiple files (<code>sitemap_products_1.xml.gz</code>, <code>sitemap_products_2.xml.gz</code>, ...).

=== Framework-specific Classes

Use the framework-specific classes to take advantage of built-in shortcuts.

==== Rails

<code>BigSiteMapRails</code> includes <code>UrlWriter</code> (useful for making use of your Rails routes - see the Location URLs section) and deals with setting the <code>:document_root</code> and <code>:url_options</code> initialization options.

==== Merb

<code>BigSitemapMerb</code> deals with setting the <code>:document_root</code> initialization option.

== Install

Via gem:

  sudo gem install big_sitemap

== Advanced

=== Initialization Options

* <code>:url_options</code> -- hash with <code>:host</code>, optionally <code>:port</code> and <code>:protocol</code>
* <code>:base_url</code> -- string alternative to <code>:url_options</code>, e.g. <code>'https://example.com:8080/'</code>
* <code>:url_path</code> -- string path_name to sitemaps folder, defaults to <code>:document_path</code>
* <code>:document_root</code> -- string
* <code>:document_path</code> -- string document path to generation folder, relative to :document_root, defaults to <code>'sitemaps/'</code>
* <code>:path</code> -- string, alias for ":document_path" for legacy reasons
* <code>:document_full</code> -- string absolute document path to generation folder - defaults to <code>:document_root/:document_path</code>
* <code>:max_per_sitemap</code> -- <code>50000</code>, which is the limit dictated by Google but can be less
* <code>:batch_size</code> -- <code>1001</code> (not <code>1000</code> due to a bug in DataMapper)
* <code>:gzip</code> -- <code>true</code>
* <code>:ping_google</code> -- <code>true</code>
* <code>:ping_yahoo</code> -- <code>false</code>, needs <code>:yahoo_app_id</code>
* <code>:ping_bing</code> -- <code>false</code>
* <code>:ping_ask</code> -- <code>false</code>
* <code>:partial_update</code> -- <code>false</code>

=== Chaining

You can chain methods together:

  BigSitemap.new(:url_options => {:host => 'example.com'}).add(Post).generate

With the Rails-specific class, you could even get away with as little code as:

  BigSitemapRails.new.add(Post).generate

=== Pinging Search Engines

To ping search engines, call <code>ping_search_engines</code> after you generate the sitemap:

  sitemap.generate.ping_search_engines

=== Location URLs

By default, URLs for the "loc" values are generated in the form:

  :base_url/:path|<table_name>/<to_param>|<id>

Alternatively, you can pass a lambda.  For example, to make use of your Rails route helper:

  sitemap.add(Post,
    :location => lambda { |post| post_url(post) }
  )

=== Change Frequency, Priority and Last Modified

You can control "changefreq", "priority" and "lastmod" values for each record individually by passing lambdas instead of fixed values:

  sitemap.add(Post,
    :change_frequency => lambda { |post| ... },
    :priority         => lambda { |post| ... },
    :last_modified    => lambda { |post| ... }
  )

=== Find Methods

Your models must provide either a <code>find_for_sitemap</code> or <code>all</code> class method that returns the instances that are to be included in the sitemap.

Additionally, you models must provide a <code>count_for_sitemap</code> or <code>count</code> class method that returns a count of the instances to be included.

If you're using ActiveRecord (Rails) or DataMapper then <code>all</code> and <code>count</code> are already provided and you can make use of any supported parameter: (:conditions, :limit, :joins, :select, :order, :include, :group)

  sitemap.add(Track,
    :select     => "id, permalink, user_id, updated_at",
    :include    => :user,
    :conditions => "public = 1 AND state = 'finished' AND user_id IS NOT NULL",
    :order      => "id ASC"
  )

If you provide your own <code>find_for_sitemap</code> or <code>all</code> method then it should be able to handle the <code>:offset</code> and <code>:limit</code> options, in the same way that ActiveRecord and DataMapper handle them.  This is especially important if you have more than 50,000 URLs.

=== Partial Update

If you enable <code>:partial_update</code>, the filename will include an id smaller than the id of the first entry. This is perfect to update just the last file with new entries without the need to re-generate files being already there.

=== Lock Generation Process

To prevent another process overwriting from the generated files, use the <code>with_lock</code> method:

  sitemap.with_lock do
    sitemap.generate
  end

=== Cleaning the Sitemaps Directory

Calling the <code>clean</code> method will remove all files from the Sitemaps directory.

== Limitations

If your database is likely to shrink during the time it takes to create the sitemap then you might run into problems (the final, batched SQL select will overrun by setting a limit that is too large since it is calculated from the count, which is queried at the very beginning).  In this case and your database uses incremental primary IDs then you might want to use the <code>:partial_update</code> option, which looks at the last ID instead of paginating.

== TODO

Tests for framework-specific components.

== Credits

Thanks to Alastair Brunton and Harry Love, who's work provided a starting point for this library.

Thanks also to those who have contributed patches:

* Mislav Marohnić
* Jeff Schoolcraft
* Dalibor Nasevic
* Tobias Bielohlawek (http://www.rngtng.com)

== Copyright

Copyright (c) 2010 Stateless Systems (http://statelesssystems.com). See LICENSE for details.