xml-sitemap 1.0.1

data/README

@@ -0,0 +1,37 @@
+== About XmlSitemap
+
+XmlSitemap is a gem to build website XML sitemaps.
+
+== How To Use
+
+require 'rubygems'
+require 'xml-sitemap'
+
+== Example
+
+# Somewhere in controller
+
+pages = Page.all(:order => [:updated_at.desc] # DM model
+
+@map = XmlSitemap::Map.new('somedomain.com') do |m|
+  m.add(:url => '/', :period => :daily, :priority => 1.0)
+  m.add(:url => '/contractors', :period => :daily, :priority => 1.0)
+  pages.each do |p|
+    m.add(
+      :url => url_for_page(p),
+      :updated => p.updated_at,
+      :priority => 0.5,
+      :period => :never
+    )
+  end
+end
+
+# ... then render it in your view
+<%= @map.render %>
+
+== Options
+
+:url - page path, relative to domain (ex.: /test), String.
+:period - freqchange attribute, Symbol, :none, :never, :always, :hourly, :daily, :weekly, :monthly, :yearly
+:priority - priority attribute, Float class,(0.0..1.0)
+:updated - (optional) last_update attribute, Time class

data/lib/xml-sitemap.rb

@@ -0,0 +1,58 @@
+module XmlSitemap
+  PERIODS = [:none, :always, :hourly, :daily, :weekly, :monthly, :yearly, :never]
+
+  class Item
+    attr_reader :path
+    attr_reader :updated
+    attr_reader :priority
+    attr_reader :changefreq
+    
+    def initialize(opts={})
+      @path = opts[:url] if opts.key?(:url)
+      @updated = opts[:updated] || Time.now
+      @priority = opts[:priority] || 0.5
+      @changefreq = opts[:period] || :never
+    end
+  end
+
+  class Map
+    attr_reader :domain, :items
+    attr_reader :buffer
+    
+    # Creates new Map class for specified domain
+    def initialize(domain)
+      @domain = domain
+      @items = []
+      yield self if block_given?
+    end
+    
+    # Yields Map class for easier access
+    def generate
+      raise ArgumentError, 'Block required' unless block_given?
+      yield self
+    end
+    
+    # Add new item to sitemap list
+    def add(opts)
+      @items << XmlSitemap::Item.new(opts)
+    end
+    
+    # Render XML
+    def render
+      return '' if @items.size == 0
+      output = []
+      output << '<?xml version="1.0" encoding="UTF-8"?>'
+      output << '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">'
+      @items.each do |item|
+        output << '<url>'
+          output << "<loc>http://#{@domain}#{item.path.to_s}</loc>"
+          output << "<lastmod>#{item.updated.to_date}</lastmod>"
+          output << "<changefreq>#{item.changefreq.to_s}</changefreq>"
+          output << "<priority>#{item.priority.to_s}</priority>"
+        output << '</url>'
+      end
+      output << '</urlset>'
+      return output.join("\n")
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: xml-sitemap
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-18 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Easy XML sitemap generation for Ruby/Rails application
+email: dan.sosedoff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/xml-sitemap.rb
+has_rdoc: true
+homepage: http://sosedoff.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: No-dependency XML sitemap generator. Can be used for any Ruby application (Rails/Merb/Sinatra).
+test_files: []
+