alexrabarts-big_sitemap 0.1.3 → 0.2.0

data/README.markdown

@@ -1,17 +1,23 @@
 # BigSitemap
 
-## DESCRIPTION:
+## DESCRIPTION
 
 BigSitemap is a Sitemap generator specifically designed for large sites (although it works equally well with small sites).  It splits large Sitemaps into multiple files, gzips the files to minimize bandwidth usage, batches database queries so it doesn't take your site down, can be set up with just a few lines of code and is compatible with just about any framework.
 
-## INSTALL:
+## INSTALL
 
 * Via git: git clone git://github.com/alexrabarts/big_sitemap.git
 * Via gem: gem install alexrabarts-big_sitemap -s http://gems.github.com
 
-## SYNOPSIS:
+## SYNOPSIS
 
-The minimum required to generated a sitemap is:
+The minimum required to generate a sitemap is:
+
+<pre>
+  BigSitemap.new(:base_url => 'http://example.com').add(:model => MyModel, :path => 'my_controller').generate
+</pre>
+
+You can put this in a rake/thor task and create a cron job to run it periodically.  It should be enough for most Rails/Merb applications.  Note that the methods are chainable, although you can call them on an instance variable if you prefer:
 
 <pre>
   sitemap = BigSitemap.new(:base_url => 'http://example.com')
@@ -19,10 +25,12 @@ The minimum required to generated a sitemap is:
   sitemap.generate
 </pre>
 
-You can put this in a rake/thor task and create a cron job to run it periodically.  It should be enough for most Rails/Merb applications.
+### 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 don't need to do anything unless you want to include a subset of records.  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.
 
+### URL Format
+
 To generate the URLs, BigSitemap will combine the constructor arguments with the <code>to_param</code> method of each instance returned (provided by ActiveRecord but not DataMapper).  If this method is not present, <code>id</code> will be used.  The URL is constructed as:
 
 <pre>
@@ -30,6 +38,8 @@ To generate the URLs, BigSitemap will combine the constructor arguments with the
   ":base_url/:path/:id"       # (if to_param does not exist)
 </pre>
 
+### Sitemap Location
+
 BigSitemap knows about the document root of Rails and Merb.  If you are using another framework then you can specify the document root with the <code>:document_root</code> option.  e.g.:
 
 <pre>
@@ -42,18 +52,28 @@ By default, the sitemap files are created under <code>/sitemaps</code>.  You can
   BigSitemap.new(:base_url => 'http://example.com', :path => 'google-sitemaps') # places Sitemaps under /google-sitemaps
 </pre>
 
+### Cleaning the Sitemaps Directory
+
+Calling the <code>clean</code> method will remove all files from the Sitemaps directory.
+
+### Maximum Number of URLs
+
 Sitemaps will be split across several files if more than 50,000 records are returned.  You can customize this limit with the <code>:max_per_sitemap</code> option:
 
 <pre>
   BigSitemap.new(:base_url => 'http://example.com', :max_per_sitemap => 1000) # Max of 1000 URLs per Sitemap
 </pre>
 
-The database is queries in batches to prevent large SQL select statements from locking the database for too long.  By default, the batch size is 1001 (not 1000 due to an obscure bug in DataMapper that appears when an offset of 37000 is used).  You can customize the batch size with the <code>:batch_size</code> option:
+### Batched Database Queries
+
+The database is queried in batches to prevent large SQL select statements from locking the database for too long.  By default, the batch size is 1001 (not 1000 due to an obscure bug in DataMapper that appears when an offset of 37000 is used).  You can customize the batch size with the <code>:batch_size</code> option:
 
 <pre>
   BigSitemap.new(:base_url => 'http://example.com, :batch_size => 5000) # Database is queried in batches of 5,000
 </pre>
 
+### Search Engine Notification
+
 Google, Yahoo!, MSN and Ask are pinged once the Sitemap files are generated.  You can turn one or more of these off:
 
 <pre>
@@ -72,7 +92,7 @@ You must provide an App ID in order to ping Yahoo! (more info at http://develope
   BigSitemap.new(:base_url => 'http://example.com', :yahoo_app_id => 'myYahooAppId') # Yahoo! will now be pinged
 </pre>
 
-## LIMITATIONS:
+## 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).  Patches welcome!
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
-:patch: 3
+:minor: 2
+:patch: 0
 :major: 0

data/lib/big_sitemap.rb

@@ -6,7 +6,7 @@ require 'extlib'
 
 class BigSitemap
   def initialize(options)
-    document_root  = options.delete(:document_root)
+    document_root = options.delete(:document_root)
 
     if document_root.nil?
       if defined? RAILS_ROOT
@@ -37,20 +37,26 @@ class BigSitemap
       'Batch size (:batch_size) must be less than or equal to maximum URLs per sitemap (:max_per_sitemap)'
     ) if @batch_size > @max_per_sitemap
 
-    unless File.exists? @file_path
-      Dir.mkdir(@file_path)
-    end
+    Dir.mkdir(@file_path) unless File.exists? @file_path
   end
 
   def add(options)
     raise ArgumentError, ':model and :path options must be provided' unless options[:model] && options[:path]
     @sources << options
+    self # Chainable
   end
 
-  def generate
-    paths    = []
-    sitemaps = []
+  def clean
+    unless @file_path.nil?
+      Dir.foreach(@file_path) do |f|
+        f = "#{@file_path}/#{f}"
+        File.delete(f) if File.file?(f)
+      end
+    end
+    self # Chainable
+  end
 
+  def generate
     @sources.each do |source|
       klass = source[:model]
 
@@ -101,11 +107,9 @@ class BigSitemap
               param_method = pick_method(r, [:to_param, :id])
               raise ArgumentError, "#{klass} must provide a to_param instance method" if param_method.nil?
 
-              path = {:url => "#{source[:path]}/#{r.send(param_method)}", :last_mod => last_mod}
-
               xml.url do
-                xml.loc("#{@base_url}/#{path[:url]}")
-                xml.lastmod(path[:last_mod].strftime('%Y-%m-%d')) unless path[:last_mod].nil?
+                xml.loc("#{@base_url}/#{source[:path]}/#{r.send(param_method)}")
+                xml.lastmod(last_mod.strftime('%Y-%m-%d')) unless last_mod.nil?
                 xml.changefreq('weekly')
               end
             end
@@ -119,6 +123,7 @@ class BigSitemap
 
     generate_sitemap_index
     ping_search_engines
+    self # Chainable
   end
 
   private

data/test/big_sitemap_test.rb

@@ -35,6 +35,13 @@ class BigSitemapTest < Test::Unit::TestCase
     assert !File.exists?(third_sitemaps_model_file), "#{third_sitemaps_model_file} does not exist"
   end
 
+  should 'clean all sitemap files' do
+    generate_sitemap_files
+    assert Dir.entries(sitemaps_dir).size > 2, "#{sitemaps_dir} is not empty" # ['.', '..'].size == 2
+    @sitemap.clean
+    assert_equal 2, Dir.entries(sitemaps_dir).size, "#{sitemaps_dir} is empty"
+  end
+
   context 'Sitemap index file' do
     should 'contain one sitemapindex element' do
       generate_sitemap_files
@@ -107,6 +114,27 @@ class BigSitemapTest < Test::Unit::TestCase
     end
   end
 
+  context 'add method' do
+    should 'be chainable' do
+      create_sitemap
+      assert_equal BigSitemap, @sitemap.add({:model => TestModel, :path => 'test_controller'}).class
+    end
+  end
+
+  context 'clean method' do
+    should 'be chainable' do
+      create_sitemap
+      assert_equal BigSitemap, @sitemap.clean.class
+    end
+  end
+
+  context 'generate method' do
+    should 'be chainable' do
+      create_sitemap
+      assert_equal BigSitemap, @sitemap.generate.class
+    end
+  end
+
   private
     def delete_tmp_files
       FileUtils.rm_rf(sitemaps_dir)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alexrabarts-big_sitemap
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alex Rabarts
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-10 00:00:00 -07:00
+date: 2009-03-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- VERSION.yml
+- History.txt
 - README.markdown
+- VERSION.yml
 - lib/big_sitemap.rb
+- test/big_sitemap_test.rb
 - test/fixtures
 - test/fixtures/test_model.rb
-- test/big_sitemap_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/alexrabarts/big_sitemap