dynamic_sitemaps 2.0.0.beta → 2.0.0.beta2

data/lib/dynamic_sitemaps/generator.rb

@@ -1,58 +1,112 @@
 module DynamicSitemaps
   class Generator
-    class << self
-      def generate
-        instance_eval open(DynamicSitemaps.config_path).read
-        generate_index
+    # Generates the sitemap(s) and index based on the configuration file specified in DynamicSitemaps.config_path.
+    # If you supply a block, that block is evaluated instead of the configuration file.
+    def generate(&block)
+      create_temp_dir
+      if block
+        instance_eval &block
+      else
+        instance_eval open(DynamicSitemaps.config_path).read, DynamicSitemaps.config_path
       end
+      generate_index
+      move_to_destination
+      ping_search_engines
+    ensure
+      remove_temp_dir
+    end
 
-      def generate_index
-        IndexGenerator.new(sitemaps).generate
-      end
+    def generate_index
+      IndexGenerator.new(sitemaps).generate
+    end
+
+    def create_temp_dir
+      remove_temp_dir
+      FileUtils.mkdir_p DynamicSitemaps.temp_path
+    end
+
+    def remove_temp_dir
+      FileUtils.rm_rf DynamicSitemaps.temp_path
+    end
 
-      def sitemap(*args, &block)
-        args << {} unless args.last.is_a?(Hash)
-        args.last[:host] ||= host
-        args.last[:folder] ||= folder
-        sitemap = Sitemap.new(*args, &block)
-        sitemaps << SitemapGenerator.new(sitemap).generate
+    def move_to_destination
+      sitemaps.map(&:folder).uniq.each do |folder|
+        destination = "#{DynamicSitemaps.path}/#{folder}"
+        FileUtils.mkdir_p destination
+        FileUtils.rm_rf Dir.glob("#{destination}/*")
+        FileUtils.mv Dir["#{DynamicSitemaps.temp_path}/#{folder}/*"], destination
       end
+      remove_temp_dir
+    end
 
-      def sitemap_for(collection, options = {}, &block)
-        raise "The collection given to `sitemap_for` must respond to #find_each. This is for performance. Use `Model.scoped` to get an ActiveRecord relation that responds to #find_each." unless collection.respond_to?(:find_each)
+    def ping_search_engines
+      Pinger.ping_search_engines_with ping_urls
+    end
 
-        name = options.delete(:name) || collection.model_name.underscore.pluralize.to_sym
-        options[:collection] = collection
+    def sitemap(*args, &block)
+      args << {} unless args.last.is_a?(Hash)
+      args.last[:host] ||= host
+      args.last[:folder] ||= folder
+      sitemap = Sitemap.new(*args, &block)
 
-        sitemap(name, options, &block)
-      end
+      ensure_valid_sitemap_name! sitemap
+      sitemap_names[sitemap.folder] << sitemap.name
 
-      # Array of SitemapResult
-      def sitemaps
-        @sitemaps ||= []
-      end
+      sitemaps << SitemapGenerator.new(sitemap).generate
+    end
+
+    def sitemap_for(collection, options = {}, &block)
+      raise ArgumentError, "The collection given to `sitemap_for` must respond to #find_each. This is for performance. Use `Model.scoped` to get an ActiveRecord relation that responds to #find_each." unless collection.respond_to?(:find_each)
 
-      def host(*args)
-        if args.any?
-          @host = args.first
-          Rails.application.routes.default_url_options[:host] = @host
-        else
-          @host
-        end
+      name = options.delete(:name) || collection.model_name.underscore.pluralize.to_sym
+      options[:collection] = collection
+
+      sitemap(name, options, &block)
+    end
+
+    def ensure_valid_sitemap_name!(sitemap)
+      raise ArgumentError, "Sitemap name :#{sitemap.name} has already been defined for the folder \"#{sitemap.folder}\". Please use `sitemap :other_name do ... end` or `sitemap_for <relation>, name: :other_name`." if sitemap_names[sitemap.folder].include?(sitemap.name)
+      raise ArgumentError, "Sitemap name :#{sitemap.name} conflicts with the index file name #{DynamicSitemaps.index_file_name}. Please change it using `sitemap :other_name do ... end`." if "#{sitemap.name}.xml" == DynamicSitemaps.index_file_name
+    end
+
+    # Array of SitemapResult
+    def sitemaps
+      @sitemaps ||= []
+    end
+
+    # Generated sitemap names
+    def sitemap_names
+      @sitemap_names ||= Hash.new { |h, k| h[k] = [] }
+    end
+
+    # URLs to ping after generation
+    def ping_urls
+      @ping_urls ||= []
+    end
+
+    def host(*args)
+      if args.any?
+        @host = args.first
+        Rails.application.routes.default_url_options[:host] = @host
+      else
+        @host
       end
+    end
 
-      def folder(*args)
-        if args.any?
-          @folder = args.first
-          raise ArgumentError, "Folder can't be blank." if @folder.blank?
+    # Adds a sitemap URL to ping search engines with after generation.
+    def ping_with(sitemap_url)
+      ping_urls << sitemap_url
+    end
 
-          FileUtils.rm_rf Dir.glob("#{DynamicSitemaps.path}/#{folder}/*")
-        else
-          # Ensure that the default folder is set and cleaned.
-          folder DynamicSitemaps.folder if @folder.blank?
+    def folder(*args)
+      if args.any?
+        @folder = args.first
+        raise ArgumentError, "Folder can't be blank." if @folder.blank?
+      else
+        # Ensure that the default folder is set and cleaned.
+        folder DynamicSitemaps.folder if @folder.blank?
 
-          @folder
-        end
+        @folder
       end
     end
   end

data/lib/dynamic_sitemaps/index_generator.rb

@@ -9,10 +9,10 @@ module DynamicSitemaps
 
     def generate
       sitemaps.group_by(&:folder).each do |folder, sitemaps|
-        index_path = "#{DynamicSitemaps.path}/#{folder}/#{DynamicSitemaps.index_file_name}"
+        index_path = "#{DynamicSitemaps.temp_path}/#{folder}/#{DynamicSitemaps.index_file_name}"
 
         if !DynamicSitemaps.always_generate_index && sitemaps.count == 1 && sitemaps.first.files.count == 1
-          file_path = "#{DynamicSitemaps.path}/#{folder}/#{sitemaps.first.files.first}"
+          file_path = "#{DynamicSitemaps.temp_path}/#{folder}/#{sitemaps.first.files.first}"
           FileUtils.copy file_path, index_path
           File.delete file_path
         else

data/lib/dynamic_sitemaps/logger.rb

@@ -0,0 +1,22 @@
+module DynamicSitemaps
+  class Logger
+    class << self
+      def info(message)
+        show message
+        Rails.logger.info message
+      end
+
+      def warn(message)
+        show message
+        Rails.logger.warn message
+      end
+
+      # Shows the message using puts unless testing.
+      def show(message)
+        unless Rails.env.test?
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_sitemaps/pinger.rb

@@ -1,16 +1,17 @@
 module DynamicSitemaps
   class Pinger
     class << self
-      def ping_search_engines
-        sitemap_urls = DynamicSitemaps.sitemap_ping_urls
-        if sitemap_urls.any?
-          puts "Pinging search engines..."
+      def ping_search_engines_with(sitemap_urls)
+        sitemap_urls = [sitemap_urls] unless sitemap_urls.is_a?(Array)
+
+        if sitemap_urls.any? && ping_for_environment?(Rails.env)
+          Logger.info "Pinging search engines..."
 
           sitemap_urls.each do |url|
             ping_search_engines_with_sitemap_url url
           end
 
-          puts "Done pinging search engines."
+          Logger.info "Done pinging search engines."
         end
       end
 
@@ -23,13 +24,17 @@ module DynamicSitemaps
       end
 
       def ping(url)
-        puts "Pinging #{url} ..."
+        Logger.info "Pinging #{url} ..."
         begin
           Net::HTTP.get(URI.parse(url))
         rescue Exception => e
-          puts "Failed to ping #{url} : #{e}"
+          Logger.warn "Failed to ping #{url} : #{e}"
         end
       end
+
+      def ping_for_environment?(env)
+        DynamicSitemaps.ping_environments.map(&:to_s).include?(env.to_s)
+      end
     end
   end
 end

data/lib/dynamic_sitemaps/sitemap.rb

@@ -7,14 +7,6 @@ module DynamicSitemaps
     #   Sitemap.new(:site) do
     #     url root_url
     #   end
-    # 
-    # Using an ActiveRecord relation:
-    # 
-    #   Sitemap.new(:site, Product.visible) do |product|
-    #     url product
-    #     url product_editions_path(product)
-    #   end
-    
     def initialize(*args, &block)
       if args.first.is_a?(Symbol)
         @name = args.shift
@@ -36,7 +28,7 @@ module DynamicSitemaps
     end
 
     def per_page
-      @per_page ||= DynamicSitemaps::DEFAULT_PER_PAGE
+      @per_page ||= DynamicSitemaps.per_page
     end
 
     # Generates sitemap XML files based on this sitemap

data/lib/dynamic_sitemaps/sitemap_generator.rb

@@ -11,6 +11,7 @@ module DynamicSitemaps
     end
 
     def generate
+      ensure_host!
       write_beginning
       write_urls
       write_end
@@ -95,7 +96,7 @@ module DynamicSitemaps
     end
 
     def folder_path
-      "#{DynamicSitemaps.path}/#{folder}"
+      "#{DynamicSitemaps.temp_path}/#{folder}"
     end
 
     def path
@@ -106,6 +107,10 @@ module DynamicSitemaps
       sitemap.host
     end
 
+    def ensure_host!
+      raise "No host specified. Please specify a host using `host \"www.mydomain.com\"` at the top of your sitemap configuration file." if sitemap.host.blank?
+    end
+
     def file
       @file ||= begin
         files << file_name
@@ -146,7 +151,7 @@ module DynamicSitemaps
       if date.is_a?(Date)
         date.strftime("%Y-%m-%d")
       else
-        date.to_datetime.strftime("%Y-%m-%dT%H:%M:%S%:z")
+        date.to_datetime.utc.strftime("%Y-%m-%dT%H:%M:%S%:z")
       end
     end
   end

data/lib/dynamic_sitemaps/tasks/sitemap.rake

@@ -1,12 +1,8 @@
 namespace :sitemap do
   task :generate => :environment do
     start_time = Time.now
-    puts "Generating sitemap..."
+    DynamicSitemaps::Logger.info "Generating sitemap..."
     DynamicSitemaps.generate_sitemap
-    puts "Done generating sitemap in #{Time.now - start_time} seconds."
-
-    if Rails.env.production?
-      DynamicSitemaps::Pinger.ping_search_engines
-    end
+    DynamicSitemaps::Logger.info "Done generating sitemap in #{Time.now - start_time} seconds."
   end
 end

data/lib/dynamic_sitemaps/version.rb

@@ -1,3 +1,3 @@
 module DynamicSitemaps
-  VERSION = "2.0.0.beta"
+  VERSION = "2.0.0.beta2"
 end

data/lib/generators/dynamic_sitemaps/templates/config.rb

@@ -3,5 +3,8 @@ host "www.example.com"
 sitemap :site do
   url root_url, last_mod: Time.now, change_freq: "daily", priority: 1.0
 
+  # Ping search engines after sitemap generation
+  # ping_with "http://#{host}/sitemap.xml"
+  
   # TODO: Add examples
 end

data/test/dummy/app/models/product.rb

@@ -1,3 +1,7 @@
 class Product < ActiveRecord::Base
-  attr_accessible :name, :slug
+  attr_accessible :slug, :featured
+
+  def to_param
+  	slug || id.to_s
+  end
 end

data/test/dummy/config/routes.rb

@@ -1,58 +1,7 @@
 Dummy::Application.routes.draw do
-  # The priority is based upon order of creation:
-  # first created -> highest priority.
+  root to: "home#index"
 
-  # Sample of regular route:
-  #   match 'products/:id' => 'catalog#view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => 'welcome#index'
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  # match ':controller(/:action(/:id))(.:format)'
-end
+  resources :products do
+    resources :comments
+  end
+end

data/test/dummy/config/sitemap.rb

@@ -0,0 +1,5 @@
+host "www.mytest.com"
+
+sitemap :site do
+  url root_url, last_mod: Time.now, change_freq: "daily", priority: 1.0
+end

data/test/dummy/db/migrate/20130211190343_create_products.rb

@@ -1,12 +1,10 @@
 class CreateProducts < ActiveRecord::Migration
   def change
     create_table :products do |t|
-      t.string :name
+      t.boolean :featured, default: false
       t.string :slug
 
       t.timestamps
     end
-
-    add_index :products, :slug
   end
 end

data/test/dummy/db/schema.rb

@@ -14,12 +14,10 @@
 ActiveRecord::Schema.define(:version => 20130211190343) do
 
   create_table "products", :force => true do |t|
-    t.string   "name"
+    t.boolean  "featured",   :default => false
     t.string   "slug"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at",                    :null => false
+    t.datetime "updated_at",                    :null => false
   end
 
-  add_index "products", ["slug"], :name => "index_products_on_slug"
-
 end

data/test/dynamic_sitemaps_test.rb

@@ -1,7 +1,54 @@
 require 'test_helper'
 
 class DynamicSitemapsTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, DynamicSitemaps
+  setup do
+    DynamicSitemaps.reset!
+  end
+
+  test "defaults" do
+    assert_equal Rails.root.join("public").to_s, DynamicSitemaps.path
+    assert_equal "sitemaps", DynamicSitemaps.folder
+    assert_equal "sitemap.xml", DynamicSitemaps.index_file_name
+    assert !DynamicSitemaps.always_generate_index
+    assert_equal Rails.root.join("config", "sitemap.rb").to_s, DynamicSitemaps.config_path
+    assert_equal 50000, DynamicSitemaps.per_page
+    assert_equal ["production"], DynamicSitemaps.ping_environments
+    assert_equal Rails.root.join("tmp", "dynamic_sitemaps").to_s, DynamicSitemaps.temp_path
+  end
+
+  test "configuration block" do
+    DynamicSitemaps.configure do |config|
+      config.folder = "mycustomfolder"
+      config.per_page = 1234
+    end
+
+    assert_equal "mycustomfolder", DynamicSitemaps.folder
+    assert_equal 1234, DynamicSitemaps.per_page
+  end
+
+  test "raises error on blank paths" do
+    assert_nothing_raised do
+      DynamicSitemaps.path = "/my/test/folder"
+      DynamicSitemaps.folder = "my_sitemaps"
+      DynamicSitemaps.config_path = "/my/config.rb"
+    end
+
+    assert_raises ArgumentError do
+      DynamicSitemaps.path = ""
+    end
+
+    assert_raises ArgumentError do
+      DynamicSitemaps.folder = ""
+    end
+
+    assert_raises ArgumentError do
+      DynamicSitemaps.config_path = ""
+    end
+  end
+
+  test "raises error when using old sitemap ping urls" do
+    assert_raises RuntimeError do
+      DynamicSitemaps.sitemap_ping_urls = ["http://test.com/sitemap.xml"]
+    end
   end
 end