module Sitemap class Generator include Singleton SEARCH_ATTRIBUTES = { :updated_at => "lastmod", :change_frequency => "changefreq", :priority => "priority" } attr_accessor :store, :host, :routes, :fragments # Instantiates a new object. # Should never be called directly. def initialize self.class.send(:include, Rails.application.routes.url_helpers) self.fragments = [] self.store = Store.new(:max_entries => Sitemap.defaults[:max_urls]) self.store.before_reset do |entries| self.process_fragment! end end # Sets the urls to be indexed. # # The +host+, or any other global option can be set here: # # Sitemap::Generator.instance.load :host => "mywebsite.com" do # ... # end # # Simple paths can be added as follows: # # Sitemap::Generator.instance.load :host => "mywebsite.com" do # path :faq # end # # Object collections are supported too: # # Sitemap::Generator.instance.load :host => "mywebsite.com" do # resources :activities # end # # Search options such as frequency and priority can be declared as an options hash: # # Sitemap::Generator.instance.load :host => "mywebsite.com" do # path :root, :priority => 1 # path :faq, :priority => 0.8, :change_frequency => "daily" # resources :activities, :change_frequency => "weekly" # end # def load(options = {}, &block) options.each do |k, v| self.send("#{k}=", v) end self.routes = block end # Adds the specified url or object (such as an ActiveRecord model instance). # In either case the data is being looked up in the current application routes. # # Params can be specified as follows: # # # config/routes.rb # match "/frequent-questions" => "static#faq", :as => "faq" # # # config/sitemap.rb # path :faq, :params => { :filter => "recent" } # # The resolved url would be http://mywebsite.com/frequent-questions?filter=recent. # def path(object, options = {}) params = Sitemap.defaults[:params].clone.merge!(options[:params] || {}) params[:host] ||= host # Use global host if none was specified. params.merge!(params) { |type, value| get_data(object, value) } search = Sitemap.defaults[:search].clone.merge!(options.select { |k, v| SEARCH_ATTRIBUTES.keys.include?(k) }) search.merge!(search) { |type, value| get_data(object, value) } self.store << { :object => object, :search => search, :params => params } end # Adds the associated object types. # # The following will map all Activity entries, as well as the index (/activities) page: # # resources :activities # # You can also specify which entries are being mapped: # # resources :articles, :objects => proc { Article.published } # # To skip the index action and map only the records: # # resources :articles, :skip_index => true # # As with the path, you can specify params through the +params+ options hash. # The params can also be build conditionally by using a +proc+: # # resources :activities, :params => { :host => proc { |activity| [activity.location, host].join(".") } }, :skip_index => true # # In this case the host will change based the each of the objects associated +location+ attribute. # Because the index page doesn't have this attribute it's best to skip it. # def resources(type, options = {}) path(type) unless options[:skip_index] link_params = options.reject { |k, v| k == :objects } get_objects = lambda { options[:objects] ? options[:objects].call : type.to_s.classify.constantize } get_objects.call.find_each(:batch_size => Sitemap.defaults[:query_batch_size]) do |object| path(object, link_params) end end # Parses the loaded data and returns the xml entries. def render(object = "fragment") xml = Builder::XmlMarkup.new(:indent => 2) file = File.read(File.expand_path("../../views/#{object}.xml.builder", __FILE__)) instance_eval file end # Creates a temporary file from the existing entries. def process_fragment! file = Tempfile.new("sitemap.xml") file.write(render) file.close self.fragments << file end # Generates fragments. def build! instance_exec(self, &routes) process_fragment! unless store.entries.empty? end # Creates the sitemap index file and saves any existing fragments. def save(location) if fragments.length == 1 FileUtils.mv(fragments.first.path, location) else remove_saved_files(location) root = File.join(Pathname.new(location).dirname, "sitemaps") Dir.mkdir(root) unless File.directory?(root) fragments.each_with_index do |fragment, i| file_pattern = File.join(root, "sitemap-fragment-#{i + 1}.xml") FileUtils.mv(fragment.path, file_pattern) end file = File.new(location, "w") file.write(render "index") file.close end end # URL to the sitemap file. # # Defaults to sitemap.xml. def file_url(path = "sitemap.xml") URI::HTTP.build(:host => host, :path => File.join("/", path)).to_s end def remove_saved_files(location) root = File.join(Pathname.new(location).dirname, "sitemaps") Dir[File.join(root, "sitemap-fragment-*.xml")].each { |file| File.unlink(file) } File.unlink(location) if File.exist?(location) end private def get_data(object, data) data.is_a?(Proc) ? data.call(object) : data end end end