sitemap 0.1b2 → 0.1

data/README.rdoc

@@ -2,9 +2,23 @@
 
 A simple ruby on rails sitemap generator.
 
+== Instalation
+
+Install the gem:
+
+  gem install sitemap
+
+Or as a plugin:
+
+  rails plugin install git://github.com/viseztrance/rails-sitemap.git
+
+Then create the initial config file:
+
+  rails g sitemap:install
+
 == Usage
 
-Create a sitemap.rb file in your config directory. Paths can be indexed as follows:
+In your sitemap config file, paths can be indexed as follows:
 
   Sitemap::Generator.instance.load :host => "mywebsite.com" do
     path :root, :priority => 1
@@ -23,6 +37,16 @@ Ping search engines:
 
   rake sitemap:ping
 
+== Setting defaults
+
+You may change the defaults for either <tt>params</tt> or <tt>search</tt> options as follows:
+
+  Sitemap.defaults[:params] = { :format => "html" }
+
+== Limitations
+
+Sitemaps can only have up to 50000 urls and an uncompressed size of 10MB. This issue will be resolved in a future release.
+
 == License
 
 This package is licensed under the MIT license and/or the Creative

data/lib/generators/sitemap/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Create sample sitemap config file.

data/lib/generators/sitemap/install_generator.rb

@@ -0,0 +1,17 @@
+module Sitemap
+
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_config
+        copy_file "sitemap.rb", "config/sitemap.rb"
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/sitemap/templates/sitemap.rb

@@ -0,0 +1,26 @@
+Sitemap::Generator.instance.load :host => "mywebsite.com" do
+
+  # Sample path:
+  #   path :faq
+  # The specified path must exist in your routes file (usually specified through :as).
+
+  # Sample path with params:
+  #   path :faq, :params => { :format => "html", :filter => "recent" }
+  # Depending on the route, the resolved url could be http://mywebsite.com/frequent-questions.html?filter=recent.
+
+  # Sample resource:
+  #   resources :articles
+
+  # Sample resource with custom objects:
+  #   resources :articles, :objects => proc { Article.published }
+
+  # Sample resource with search options:
+  #   resources :articles, :priority => 0.8, :change_frequency => "monthly"
+
+  # Sample resource with block options:
+  #   resources :activities,
+  #             :skip_index => true,
+  #             :updated_at => proc { |activity| activity.published_at.strftime("%Y-%m-%d") }
+  #             :params => { :subdomain => proc { |activity| activity.location } }
+
+end

data/lib/sitemap.rb

@@ -9,6 +9,7 @@ require "singleton"
 require "builder"
 require "sitemap/railtie"
 require "sitemap/ping"
+require "sitemap/generator"
 
 module Sitemap
 
@@ -23,146 +24,4 @@ module Sitemap
     }
   }
 
-  class Generator
-
-    include Singleton
-
-    SEARCH_ATTRIBUTES = {
-      :updated_at       => "lastmod",
-      :change_frequency => "changefreq",
-      :priority         => "priority"
-    }
-
-    attr_accessor :entries, :host, :routes
-
-    # Instantiates a new object.
-    # Should never be called directly.
-    def initialize
-      self.class.send(:include, Rails.application.routes.url_helpers)
-      self.entries = []
-    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 <tt>http://mywebsite.com/frequent-questions?filter=recent</tt>.
-    #
-    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.entries << {
-        :object => object,
-        :search => search,
-        :params => params
-      }
-    end
-
-    # Adds the associated object types.
-    #
-    # The following will map all Activity entries, as well as the index (<tt>/activities</tt>) 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]
-      objects = options[:objects] ? options[:objects].call : type.to_s.classify.constantize.all
-      options.reject! { |k, v| k == :objects }
-
-      objects.each do |object|
-        path(object, options)
-      end
-    end
-
-    # Parses the loaded data and returns the xml entries.
-    def build
-      instance_exec(self, &routes)
-      xml = Builder::XmlMarkup.new(:indent => 2)
-      file = File.read(File.expand_path("../views/index.xml.builder", __FILE__))
-      instance_eval file
-    end
-
-    # Builds xml entries and saves the data to the specified location.
-    def save(location)
-      file = File.new(location, "w")
-      file.write(build)
-      file.close
-    end
-
-    # URL to the <tt>sitemap.xml</tt> file.
-    def file_url
-      URI::HTTP.build(:host => host, :path => "/sitemap.xml").to_s
-    end
-
-    private
-
-    def get_data(object, data)
-      data.is_a?(Proc) ? data.call(object) : data
-    end
-
-  end
-
 end

data/lib/sitemap/generator.rb

@@ -0,0 +1,145 @@
+module Sitemap
+
+  class Generator
+
+    include Singleton
+
+    SEARCH_ATTRIBUTES = {
+      :updated_at       => "lastmod",
+      :change_frequency => "changefreq",
+      :priority         => "priority"
+    }
+
+    attr_accessor :entries, :host, :routes
+
+    # Instantiates a new object.
+    # Should never be called directly.
+    def initialize
+      self.class.send(:include, Rails.application.routes.url_helpers)
+      self.entries = []
+    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 <tt>http://mywebsite.com/frequent-questions?filter=recent</tt>.
+    #
+    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.entries << {
+        :object => object,
+        :search => search,
+        :params => params
+      }
+    end
+
+    # Adds the associated object types.
+    #
+    # The following will map all Activity entries, as well as the index (<tt>/activities</tt>) 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]
+      objects = options[:objects] ? options[:objects].call : type.to_s.classify.constantize.all
+      options.reject! { |k, v| k == :objects }
+
+      objects.each do |object|
+        path(object, options)
+      end
+    end
+
+    # Parses the loaded data and returns the xml entries.
+    def build
+      instance_exec(self, &routes)
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      file = File.read(File.expand_path("../../views/index.xml.builder", __FILE__))
+      instance_eval file
+    end
+
+    # Builds xml entries and saves the data to the specified location.
+    def save(location)
+      file = File.new(location, "w")
+      file.write(build)
+      file.close
+    end
+
+    # URL to the <tt>sitemap.xml</tt> file.
+    def file_url
+      URI::HTTP.build(:host => host, :path => "/sitemap.xml").to_s
+    end
+
+    private
+
+    def get_data(object, data)
+      data.is_a?(Proc) ? data.call(object) : data
+    end
+
+  end
+
+end

data/lib/sitemap/ping.rb

@@ -7,7 +7,6 @@ module Sitemap
 
     SEARCH_ENGINES = {
       "Google"  => "http://www.google.com/webmasters/tools/ping?sitemap=%s",
-      "Yahoo!"  => "http://search.yahooapis.com/SiteExplorerService/V1/updateNotification?appid=SitemapWriter&url=%s",
       "Ask.com" => "http://submissions.ask.com/ping?sitemap=%s",
       "Bing"    => "http://www.bing.com/webmaster/ping.aspx?siteMap=%s"
     }

data/sitemap.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), "lib")
 
 spec = Gem::Specification.new do |spec|
   spec.name = "sitemap"
-  spec.version = "0.1b2"
+  spec.version = "0.1"
   spec.summary = "Sitemap"
   spec.description = "A simple ruby on rails sitemap generator"
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: sitemap
 version: !ruby/object:Gem::Version
-  version: 0.1b2
-  prerelease: 3
+  version: '0.1'
+  prerelease: 
 platform: ruby
 authors:
 - Daniel Mircea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000Z
+date: 2011-09-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &14319520 !ruby/object:Gem::Requirement
+  requirement: &17823580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14319520
+  version_requirements: *17823580
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &14319100 !ruby/object:Gem::Requirement
+  requirement: &17823140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14319100
+  version_requirements: *17823140
 description: A simple ruby on rails sitemap generator
 email: daniel@viseztrance.com
 executables: []
@@ -41,9 +41,13 @@ extra_rdoc_files:
 - README.rdoc
 - LICENSE
 files:
+- lib/generators/sitemap/USAGE
+- lib/generators/sitemap/templates/sitemap.rb
+- lib/generators/sitemap/install_generator.rb
 - lib/views/index.xml.builder
 - lib/sitemap.rb
 - lib/sitemap/railtie.rb
+- lib/sitemap/generator.rb
 - lib/sitemap/ping.rb
 - lib/tasks/sitemap.rake
 - README.rdoc
@@ -73,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.8