sitemap_generator 0.2.4 → 0.2.5

data/README.md

@@ -3,6 +3,8 @@ SitemapGenerator
 
 This plugin enables ['enterprise-class'][enterprise_class] Google Sitemaps to be easily generated for a Rails site as a rake task, using a simple 'Rails Routes'-like DSL.
 
+**Now supporting Rails 3 as of version 0.2.5!**
+
 Foreword
 -------
 
@@ -10,78 +12,52 @@ Unfortunately, Adam Salter passed away in 2009.  Those who knew him know what an
 
 [Karl Varga](http://github.com/kjvarga) has taken over development of SitemapGenerator.  The canonical repository is [http://github.com/kjvarga/sitemap_generator][canonical_repo]
 
-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. 
+Installation
+=======
 
-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.)
+**Rails 3:**
 
-and
+1. Add the gem to your <tt>Gemspec</tt>
 
-b) How would you infer the correct series of links for the following route?
+    <code>gem 'sitemap_generator'</code>
 
-    map.zipcode 'location/:state/:city/:zipcode', :controller => 'zipcode', :action => 'index'
+2. `$ rake sitemap:install`
     
-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
+**Rails 2.x: As a gem**
 
-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.
-
-Other "difficult" Sitemap issues, solved by this plugin:
-
-- Support for more than 50,000 urls (using a Sitemap Index file)
-- Gzip of Sitemap files
-- Variable priority of links
-- Paging/sorting links (e.g. my_list?page=3)
-- SSL host links (e.g. https:)
-- Rails apps which are installed on a sub-path (e.g. example.com/blog_app/)
-
-Installation
-=======
+1. Add the gem as a dependency in your <tt>config/environment.rb</tt>
 
-**As a gem**
-
-1. Add the gem as a dependency in your config/environment.rb
-
-    <code>config.gem 'sitemap_generator', :lib => false, :source => 'http://gemcutter.org'</code>
+    <code>config.gem 'sitemap_generator', :lib => false</code>
 
 2. `$ rake gems:install`
 
-3. Add the following line to your RAILS_ROOT/Rakefile
+3. Add the following to your <tt>RAILS_ROOT/Rakefile</tt>
 
-    <code>require 'sitemap_generator/tasks' rescue LoadError</code>
+    <pre>begin
+      require 'sitemap_generator/tasks'
+    rescue Exception => e
+      puts "Warning, couldn't load gem tasks: #{e.message}! Skipping..."
+    end</pre>
 
 4. `$ rake sitemap:install`
 
-**As a plugin**
-
-1. Install plugin as normal
+**Rails 2.x: As a plugin**
 
-    <code>$ ./script/plugin install git://github.com/kjvarga/sitemap_generator.git</code>
+1. <code>$ ./script/plugin install git://github.com/kjvarga/sitemap_generator.git</code>
 
 ----
 
-Installation should create a 'config/sitemap.rb' file which will contain your logic for generation of the Sitemap files. (If you want to recreate this file manually run `rake sitemap:install`)
+Installation creates a <tt>config/sitemap.rb</tt> file which will contain your logic for generating the Sitemap files.  If you want to create this file manually run <code>rake sitemap:install</code>.
 
-You can run `rake sitemap:refresh` as needed to create Sitemap files. This will also ping all the ['major'][sitemap_engines] search engines. (if you want to disable all non-essential output run the rake task thusly `rake -s sitemap:refresh`)
+You can run <code>rake sitemap:refresh</code> as needed to create Sitemap files. This will also ping all the ['major'][sitemap_engines] search engines.  If you want to disable all non-essential output run the rake task with <code>rake -s sitemap:refresh</code>.
 
 Sitemaps with many urls (100,000+) take quite a long time to generate, so if you need to refresh your Sitemaps regularly you can set the rake task up as a cron job. Most cron agents will only send you an email if there is output from the cron task.
 
-Optionally, you can add the following to your robots.txt file, so that robots can find the sitemap file.
+Optionally, you can add the following to your <code>public/robots.txt</code> file, so that robots can find the sitemap file.
 
     Sitemap: <hostname>/sitemap_index.xml.gz
     
-The robots.txt Sitemap URL should be the complete URL to the Sitemap Index, such as: `http://www.example.org/sitemap_index.xml.gz`
+The Sitemap URL in the robots file should be the complete URL to the Sitemap Index, such as <tt>http://www.example.org/sitemap_index.xml.gz</tt>
 
 
 Example 'config/sitemap.rb'
@@ -130,12 +106,55 @@ Example 'config/sitemap.rb'
     file = File.join(Rails.root, 'vendor/plugins/cadability_client/config/sitemap.rb')
     eval(open(file).read, binding, file)
 
-Notes
+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.
+
+Other "difficult" Sitemap issues, solved by this plugin:
+
+- Support for more than 50,000 urls (using a Sitemap Index file)
+- Gzip of Sitemap files
+- Variable priority of links
+- Paging/sorting links (e.g. my_list?page=3)
+- SSL host links (e.g. https:)
+- Rails apps which are installed on a sub-path (e.g. example.com/blog_app/)
+
+Compatibility
 =======
 
-1) Tested/working on Rails 1.x.x <=> 2.x.x, no guarantees made for Rails 3.0.
+Tested and working on:
+
+- **Rails** 3.0.0, sitemap_generator version >= 0.2.5
+- **Rails** 1.x - 2.3.5 sitemap_generator version < 0.2.5
+- **Ruby** 1.8.7, 1.9.1
+
+Notes
+=======
 
-2) For large sitemaps it may be useful to split your generation into batches to avoid running out of memory. E.g.:
+1) For large sitemaps it may be useful to split your generation into batches to avoid running out of memory. E.g.:
 
     # add movies
     Movie.find_in_batches(:batch_size => 1000) do |movies|
@@ -144,7 +163,7 @@ Notes
       end
     end
 
-3) New Capistrano deploys will remove your Sitemap files, unless you run `rake sitemap:refresh`. The way around this is to create a cap task:
+2) New Capistrano deploys will remove your Sitemap files, unless you run `rake sitemap:refresh`. The way around this is to create a cap task:
 
     after "deploy:update_code", "deploy:copy_old_sitemap"
 
@@ -154,7 +173,7 @@ Notes
       end
     end
 
-4) If generation of your sitemap fails for some reason, the old sitemap will remain in public/.  This ensures that robots will always find a valid sitemap.  Running silently (`rake -s sitemap:refresh`) and with email forwarding setup you'll only get an email if your sitemap fails to build, and no notification when everything is fine - which will be most of the time.
+3) If generation of your sitemap fails for some reason, the old sitemap will remain in public/.  This ensures that robots will always find a valid sitemap.  Running silently (`rake -s sitemap:refresh`) and with email forwarding setup you'll only get an email if your sitemap fails to build, and no notification when everything is fine - which will be most of the time.
 
 Known Bugs
 ========

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rake'
 require 'rake/rdoctask'
+require 'rubygems'
+gem 'rspec', '1.3.0'
 require 'spec/rake/spectask'
 
 begin
@@ -7,7 +9,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "sitemap_generator"
     gem.summary = %Q{Easily generate enterprise class Sitemaps for your Rails site using a simple 'Rails Routes'-like DSL and a single Rake task}
-    gem.description = %Q{Installs as a plugin or Gem to easily generate enterprise class Sitemaps readable by all search engines.  Automatically ping search engines to notify them of new sitemaps, including Google, Yahoo and Bing. Provides rake tasks to easily manage your sitemaps.  Won't clobber your old sitemaps if the new one fails to generate. Setup a cron schedule and never worry about your sitemaps again.}
+    gem.description = %Q{A Rails 3-compatible gem to easily generate enterprise class Sitemaps readable by all search engines.  Automatically ping search engines to notify them of new sitemaps, including Google, Yahoo and Bing. Provides rake tasks to easily manage your sitemaps.  Won't clobber your old sitemaps if the new one fails to generate. Setup a cron schedule and never worry about your sitemaps again.}
     gem.email = "kjvarga@gmail.com"
     gem.homepage = "http://github.com/kjvarga/sitemap_generator"
     gem.authors = ["Adam Salter", "Karl Varga"]
@@ -25,6 +27,7 @@ task :default => :test
 namespace :test do
   task :gem => ['test:prepare:gem', 'multi_spec']
   task :plugin => ['test:prepare:plugin', 'multi_spec']
+  task :rails3 => ['test:prepare:rails3', 'multi_spec']
   
   task :multi_spec do
     Rake::Task['spec'].invoke
@@ -44,6 +47,11 @@ namespace :test do
       rm_rf(local_path('spec/mock_app_plugin/public/sitemap*'))
     end
 
+    task :rails3 do
+      ENV["SITEMAP_RAILS"] = 'rails3'
+      rm_rf(local_path('spec/mock_rails3_gem/public/sitemap*'))
+    end
+    
     def local_path(path)
       File.join(File.dirname(__FILE__), path)
     end

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/sitemap_generator.rb

@@ -1,7 +1,10 @@
 require 'sitemap_generator/mapper'
 require 'sitemap_generator/link'
-require 'sitemap_generator/link_set'
+require 'sitemap_generator/rails_helper'
 require 'sitemap_generator/helper'
+require 'sitemap_generator/link_set'
+
+require 'sitemap_generator/railtie' if SitemapGenerator::RailsHelper.rails3?
 
 module SitemapGenerator
   silence_warnings do
@@ -19,5 +22,5 @@ module SitemapGenerator
     :sitemap_index  => File.join(self.root, 'templates/sitemap_index.builder'),
     :sitemap_xml    => File.join(self.root, 'templates/xml_sitemap.builder'),
     :sitemap_sample => File.join(self.root, 'templates/sitemap.rb'),
-  }
-end
+  }  
+end

data/lib/sitemap_generator/helper.rb

@@ -1,10 +1,7 @@
-require 'sitemap_generator'
-require 'action_controller'
-
 module SitemapGenerator
+  # UrlHelpers are included by the rake tasks.  This is not ideal, but should
+  # suffice until things are better organized.
   module Helper
-    include ActionController::UrlWriter
-
     def self.included(base)
       base.class_eval do
         def self.default_url_options(options = nil)
@@ -14,18 +11,18 @@ module SitemapGenerator
     end
 
     def load_sitemap_rb
-      sitemap_mapper_file = File.join(RAILS_ROOT, 'config/sitemap.rb')
+      sitemap_mapper_file = File.join(Rails.root, 'config/sitemap.rb')
       eval(open(sitemap_mapper_file).read)
     end
-    
+
     def url_with_hostname(path)
       URI.join(SitemapGenerator::Sitemap.default_host, path).to_s
     end
-    
+
     def w3c_date(date)
        date.utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")
     end
-    
+
     def ping_search_engines(sitemap_index)
       require 'open-uri'
       index_location = CGI.escape(url_with_hostname(sitemap_index))

data/lib/sitemap_generator/link_set.rb

@@ -1,4 +1,5 @@
-require File.dirname(__FILE__) + '/helper'
+require 'builder'
+require 'action_view'
 
 module SitemapGenerator
   class LinkSet
@@ -62,7 +63,7 @@ module SitemapGenerator
       buffer = ""
       xml = Builder::XmlMarkup.new(:target => buffer)
       eval(File.read(SitemapGenerator.templates[:sitemap_xml]), binding)
-      filename = File.join(RAILS_ROOT, "public", file)
+      filename = File.join(Rails.root, "public", file)
       write_file(filename, buffer)
       show_progress("Sitemap", filename, buffer) if verbose
       links.clear
@@ -74,7 +75,7 @@ module SitemapGenerator
       buffer = ""
       xml = Builder::XmlMarkup.new(:target => buffer)
       eval(File.read(SitemapGenerator.templates[:sitemap_index]), binding)
-      filename = File.join(RAILS_ROOT, "public", index_file)
+      filename = File.join(Rails.root, "public", index_file)
       write_file(filename, buffer)
       show_progress("Sitemap Index", filename, buffer) if verbose
       links.clear
@@ -144,24 +145,24 @@ module SitemapGenerator
 
     # Copy templates/sitemap.rb to config if not there yet.
     def install_sitemap_rb
-      if File.exist?(File.join(RAILS_ROOT, 'config/sitemap.rb'))
+      if File.exist?(File.join(Rails.root, 'config/sitemap.rb'))
         puts "already exists: config/sitemap.rb, file not copied"
       else
-        FileUtils.cp(SitemapGenerator.templates[:sitemap_sample], File.join(RAILS_ROOT, 'config/sitemap.rb'))
+        FileUtils.cp(SitemapGenerator.templates[:sitemap_sample], File.join(Rails.root, 'config/sitemap.rb'))
         puts "created: config/sitemap.rb"
       end
     end
 
     # Remove config/sitemap.rb if exists.
     def uninstall_sitemap_rb
-      if File.exist?(File.join(RAILS_ROOT, 'config/sitemap.rb'))
-        File.rm(File.join(RAILS_ROOT, 'config/sitemap.rb'))
+      if File.exist?(File.join(Rails.root, 'config/sitemap.rb'))
+        File.rm(File.join(Rails.root, 'config/sitemap.rb'))
       end
     end
 
     # Clean sitemap files in output directory.
     def clean_files
-      FileUtils.rm(Dir[File.join(RAILS_ROOT, 'public/sitemap*.xml.gz')])
+      FileUtils.rm(Dir[File.join(Rails.root, 'public/sitemap*.xml.gz')])
     end
 
     # Ping search engines passing sitemap location.

data/lib/sitemap_generator/rails_helper.rb

@@ -0,0 +1,28 @@
+module SitemapGenerator
+  module RailsHelper
+    # Returns whether this environment is using ActionPack
+    # version 3.0.0 or greater.
+    #
+    # @return [Boolean]
+    def self.rails3?
+      # The ActionPack module is always loaded automatically in Rails >= 3
+      return false unless defined?(ActionPack) && defined?(ActionPack::VERSION)
+
+      version =
+        if defined?(ActionPack::VERSION::MAJOR)
+          ActionPack::VERSION::MAJOR
+        else
+          # Rails 1.2
+          ActionPack::VERSION::Major
+        end
+
+      # 3.0.0.beta1 acts more like ActionPack 2
+      # for purposes of this method
+      # (checking whether block helpers require = or -).
+      # This extra check can be removed when beta2 is out.
+      version >= 3 &&
+        !(defined?(ActionPack::VERSION::TINY) &&
+          ActionPack::VERSION::TINY == "0.beta")
+    end
+  end
+end

data/lib/sitemap_generator/railtie.rb

@@ -0,0 +1,7 @@
+module SitemapGenerator
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../../../tasks/sitemap_generator_tasks.rake', __FILE__)
+    end
+  end
+end

data/tasks/sitemap_generator_tasks.rake

@@ -21,6 +21,18 @@ namespace :sitemap do
   task 'refresh:no_ping' => ['sitemap:create']
 
   task :create => [:environment] do
+    # TODO: Move away from auto-instantiating SitemapGenerator::Sitemap
+    # and move to a more natural Sitemap.new or similar.
+    if SitemapGenerator::RailsHelper.rails3?
+      SitemapGenerator::Sitemap.class_eval do
+        include Rails.application.routes.url_helpers
+      end
+    else
+      require 'action_controller'
+      SitemapGenerator::Sitemap.class_eval do
+        include ActionController::UrlWriter
+      end
+    end    
     SitemapGenerator::Sitemap.create_files
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sitemap_generator
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Adam Salter
@@ -10,20 +15,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-01 00:00:00 -07:00
+date: 2010-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Installs as a plugin or Gem to easily generate enterprise class Sitemaps readable by all search engines.  Automatically ping search engines to notify them of new sitemaps, including Google, Yahoo and Bing. Provides rake tasks to easily manage your sitemaps.  Won't clobber your old sitemaps if the new one fails to generate. Setup a cron schedule and never worry about your sitemaps again.
+  type: :development
+  version_requirements: *id001
+description: A Rails 3-compatible gem to easily generate enterprise class Sitemaps readable by all search engines.  Automatically ping search engines to notify them of new sitemaps, including Google, Yahoo and Bing. Provides rake tasks to easily manage your sitemaps.  Won't clobber your old sitemaps if the new one fails to generate. Setup a cron schedule and never worry about your sitemaps again.
 email: kjvarga@gmail.com
 executables: []
 
@@ -41,6 +48,8 @@ files:
 - lib/sitemap_generator/link.rb
 - lib/sitemap_generator/link_set.rb
 - lib/sitemap_generator/mapper.rb
+- lib/sitemap_generator/rails_helper.rb
+- lib/sitemap_generator/railtie.rb
 - lib/sitemap_generator/tasks.rb
 - rails/install.rb
 - rails/uninstall.rb
@@ -61,18 +70,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Easily generate enterprise class Sitemaps for your Rails site using a simple 'Rails Routes'-like DSL and a single Rake task