sitemap 0.1b

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Daniel Mircea, The Geeks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,21 @@
+= Sitemap
+
+A simple ruby on rails sitemap generator.
+
+== Usage
+
+Create a sitemap.rb file in your config directory. Paths can be indexed as follows:
+
+  Sitemap.instance.render :host => "mywebsite.com" do
+    path :root, :priority => 1
+    path :faq, :priority => 0.5, :change_frequency => "weekly"
+    resources :activities, :format => "html"
+    resources :articles, :objects => proc { Article.published }
+  end
+
+Please read the docs for a more comprehensive list of options.
+
+== License
+
+This package is licensed under the MIT license and/or the Creative
+Commons Attribution-ShareAlike.

data/Rakefile

@@ -0,0 +1,37 @@
+require "rake/rdoctask"
+require "rake/testtask"
+
+spec = Gem::Specification.load(File.expand_path("sitemap.gemspec", File.dirname(__FILE__)))
+
+desc "Default: run sitemap unit tests."
+task :default => :test
+
+desc "Test the sitemap plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+# Create the documentation.
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include "README.rdoc", "lib/**/*.rb"
+  rdoc.options = spec.rdoc_options
+end
+
+desc "Push new release to rubyforge and git tag"
+task :push do
+  sh "git push"
+  puts "Tagging version #{spec.version} .."
+  sh "git tag v#{spec.version}"
+  sh "git push --tag"
+  puts "Building and pushing gem .."
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem push #{spec.name}-#{spec.version}.gem"
+end
+
+desc "Install #{spec.name} locally"
+task :install do
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem install #{spec.name}-#{spec.version}.gem"
+end

data/lib/sitemap.rb

@@ -0,0 +1,168 @@
+#
+# = sitemap.rb - Sitemap
+#
+# Author:: Daniel Mircea daniel@viseztrance.com
+# Copyright:: 2011 (c) Daniel Mircea, {The Geeks}[http://thegeeks.ro]
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+
+require "singleton"
+require "builder"
+require "sitemap/railtie"
+require "sitemap/ping"
+
+module Sitemap
+
+  VERSION = Gem::Specification.load(File.expand_path("../sitemap.gemspec", File.dirname(__FILE__))).version.to_s
+
+  mattr_accessor :defaults
+
+  self.defaults = {
+    :params => {},
+    :search => {
+      :updated_at => proc { |obj| obj.updated_at.strftime("%Y-%m-%d") if obj.respond_to?(:updated_at) }
+    }
+  }
+
+  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.instance.render :host => "mywebsite.com" do
+    #     ...
+    #   end
+    #
+    # Simple paths can be added as follows:
+    #
+    #   Sitemap.instance.render :host => "mywebsite.com" do
+    #     path :faq
+    #   end
+    #
+    # Object collections are supported too:
+    #
+    #   Sitemap.instance.render :host => "mywebsite.com" do
+    #     resources :activities
+    #   end
+    #
+    # Search options such as frequency and priority can be declared as an options hash:
+    #
+    #   Sitemap.instance.render :host => "mywebsite.com" do
+    #     path :root, :priority => 1
+    #     path :faq, :priority => 0.8, :change_frequency => "daily"
+    #     resources :activities, :change_frequency => "weekly"
+    #   end
+    #
+    def render(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.respond_to?(:call) ? data.call(object) : data
+    end
+
+  end
+
+end

data/lib/sitemap/ping.rb

@@ -0,0 +1,24 @@
+require "net/http"
+require "cgi"
+
+module Sitemap
+
+  module Ping
+
+    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"
+    }
+
+    def self.send_request(file_path = false)
+      SEARCH_ENGINES.each do |name, url|
+        request = url % CGI.escape(file_path || Sitemap::Generator.instance.file_url)
+        Net::HTTP.get(URI.parse(request))
+      end
+    end
+
+  end
+
+end

data/lib/sitemap/railtie.rb

@@ -0,0 +1,13 @@
+require "rails"
+
+module Sitemap
+
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      load "tasks/sitemap.rake"
+    end
+
+  end
+
+end

data/lib/tasks/sitemap.rake

@@ -0,0 +1,19 @@
+namespace :sitemap do
+
+  def setup
+    require File.join(Rails.root, "config", "sitemap")
+  end
+
+  desc "Generates a new sitemap."
+  task :generate => :environment do
+    setup
+    path = File.join(Rails.public_path, "sitemap.xml")
+    Sitemap::Generator.instance.save path
+  end
+
+  desc "Ping engines."
+  task :ping => :environment do
+    Sitemap::Ping.send_request ENV["LOCATION"]
+  end
+
+end

data/lib/views/index.xml.builder

@@ -0,0 +1,15 @@
+xml.instruct!
+xml.urlset :xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9" do
+
+  entries.each do |entry|
+    xml.url do
+      xml.loc polymorphic_url(entry[:object], entry[:params])
+      entry[:search].each do |type, value|
+        next if !value || value.blank?
+        xml.tag! SEARCH_ATTRIBUTES[type], value.to_s
+      end
+    end
+  end
+
+end
+

data/sitemap.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "lib")
+
+spec = Gem::Specification.new do |spec|
+  spec.name = "sitemap"
+  spec.version = "0.1b"
+  spec.summary = "Sitemap"
+  spec.description = "A simple ruby on rails sitemap generator"
+
+  spec.authors << "Daniel Mircea"
+  spec.email = "daniel@viseztrance.com"
+  spec.homepage = "http://github.com/viseztrance/rails-sitemap"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "nokogiri"
+
+  spec.files = Dir["{lib,docs}/**/*"] + ["README.rdoc", "LICENSE", "Rakefile", "sitemap.gemspec"]
+  spec.test_files = Dir["test/**/*"]
+  spec.require_paths = ["lib"]
+
+  spec.has_rdoc = true
+  spec.rdoc_options << "--main" << "README.rdoc" << "--title" <<  "Sitemap" << "--line-numbers"
+                       "--webcvs" << "http://github.com/viseztrance/rails-sitemap"
+  spec.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+end

data/test/setup.rb

@@ -0,0 +1,49 @@
+module TestApp
+
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+  end
+
+end
+
+TestApp::Application.initialize!
+
+TestApp::Application.routes.draw do
+
+  root :to => "main#index"
+
+  match "/questions" => "static#faq", :as => "faq"
+
+  resources :activities
+
+end
+
+module SitemapTestSetup
+
+  def create_db
+    # Database
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :activities do |t|
+        t.string :name
+        t.text :contents
+        t.string :location
+        t.timestamps
+      end
+    end
+    1.upto(8) do |i|
+      options = {
+        :name => "Coding #{i}",
+        :contents => "Lorem ipsum dolor sit",
+        :location => "someplace-#{i}"
+      }
+      Activity.create!(options)
+    end
+  end
+
+  def drop_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+end

data/test/singleton.rb

@@ -0,0 +1,24 @@
+# Reset singleton
+# http://blog.ardes.com/2006/12/11/testing-singletons-with-ruby
+class << Singleton
+
+  def included_with_reset(klass)
+
+    included_without_reset(klass)
+
+    class << klass
+
+      def reset_instance
+        Singleton.send :__init__, self
+        self
+      end
+
+    end
+
+  end
+
+  alias_method :included_without_reset, :included
+
+  alias_method :included, :included_with_reset
+
+end

data/test/sitemap_test.rb

@@ -0,0 +1,139 @@
+require "test/unit"
+require "rubygems"
+require "rails"
+require "action_controller/railtie" # Rails 3.1
+require "active_record"
+require "nokogiri"
+
+require File.expand_path("singleton", File.dirname(__FILE__))
+require File.expand_path("setup", File.dirname(__FILE__))
+require File.expand_path("../lib/sitemap", File.dirname(__FILE__))
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+class Activity < ActiveRecord::Base; end
+
+class SitemapTest < Test::Unit::TestCase
+
+  include SitemapTestSetup
+
+  def setup
+    create_db
+    Sitemap::Generator.reset_instance
+  end
+
+  def teardown
+    drop_db
+  end
+
+  def test_xml_response
+    Sitemap::Generator.instance.render(:host => "someplace.com") {}
+    doc = Nokogiri::XML(Sitemap::Generator.instance.build)
+    assert doc.errors.empty?
+    assert_equal doc.root.name, "urlset"
+  end
+
+  def test_path_route
+    urls = ["http://someplace.com/", "http://someplace.com/questions"]
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      path :root
+      path :faq
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/loc"
+    assert_equal elements.length, urls.length
+    elements.each_with_index do |element, i|
+      assert_equal element.text, urls[i]
+    end
+  end
+
+  def test_resources_route
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      resources :activities
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/loc"
+    assert_equal elements.length, Activity.count + 1
+    assert_equal elements.first.text, "http://someplace.com/activities"
+    elements[1..-1].each_with_index do |element, i|
+      assert_equal element.text, "http://someplace.com/activities/#{i + 1}"
+    end
+  end
+
+  def test_custom_resource_objects
+    activities = [Activity.first, Activity.last]
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      resources :activities, :objects => proc { activities }, :skip_index => true
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/loc"
+    assert_equal elements.length, activities.length
+    activities.each_with_index do |activity, i|
+      assert_equal elements[i].text, "http://someplace.com/activities/%d" % activity.id
+    end
+  end
+
+  def test_params_options
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      path :faq, :params => { :host => "anotherplace.com", :format => "html", :filter => "recent" }
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/loc"
+    assert_equal elements.first.text, "http://anotherplace.com/questions.html?filter=recent"
+  end
+
+  def test_params_blocks
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      resources :activities, :skip_index => true, :params => { :host => proc { |obj| [obj.location, host].join(".") } }
+    end
+    activities = Activity.all
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/loc"
+    elements.each_with_index do |element, i|
+      assert_equal element.text, "http://%s.someplace.com/activities/%d" % [activities[i].location, activities[i].id]
+    end
+  end
+
+  def test_search_attribute_options
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      path :faq, :priority => 1, :change_frequency => "always"
+      resources :activities, :change_frequency => "weekly"
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    assert_equal doc.xpath("//url/priority").first.text, "1"
+    elements = doc.xpath "//url/changefreq"
+    assert_equal elements[0].text, "always"
+    elements[1..-1].each do |element|
+      assert_equal element.text, "weekly"
+    end
+  end
+
+  def test_search_attribute_blocks
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      resources :activities, :priority => proc { |obj| obj.id <= 2 ? 1 : 0.5 }, :skip_index => true
+    end
+    activities = Activity.all
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    elements = doc.xpath "//url/priority"
+    elements.each_with_index do |element, i|
+      value = activities[i].id <= 2 ? "1" : "0.5"
+      assert_equal element.text, value
+    end
+  end
+
+  def test_discards_empty_search_attributes # Empty or false (boolean).
+    Sitemap::Generator.instance.render(:host => "someplace.com") do
+      path :faq, :priority => "", :change_frequency => lambda { |e| return false}, :updated_at => Date.today
+    end
+    doc = Nokogiri::HTML(Sitemap::Generator.instance.build)
+    assert_equal doc.xpath("//url/priority").count, 0
+    assert_equal doc.xpath("//url/changefreq").count, 0
+    assert_equal doc.xpath("//url/lastmod").text, Date.today.to_s
+  end
+
+  def test_file_url
+    Sitemap::Generator.instance.render(:host => "someplace.com") {}
+    assert_equal Sitemap::Generator.instance.file_url, "http://someplace.com/sitemap.xml"
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sitemap
+version: !ruby/object:Gem::Version
+  version: 0.1b
+  prerelease: 3
+platform: ruby
+authors:
+- Daniel Mircea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &24552460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *24552460
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &24552040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *24552040
+description: A simple ruby on rails sitemap generator
+email: daniel@viseztrance.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE
+files:
+- lib/views/index.xml.builder
+- lib/sitemap.rb
+- lib/sitemap/railtie.rb
+- lib/sitemap/ping.rb
+- lib/tasks/sitemap.rake
+- README.rdoc
+- LICENSE
+- Rakefile
+- sitemap.gemspec
+- test/singleton.rb
+- test/setup.rb
+- test/sitemap_test.rb
+homepage: http://github.com/viseztrance/rails-sitemap
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --title
+- Sitemap
+- --line-numbers
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Sitemap
+test_files:
+- test/singleton.rb
+- test/setup.rb
+- test/sitemap_test.rb