sitemapper 0.3.1 → 0.3.2

data/init.rb

@@ -1,7 +1 @@
 require 'sitemapper'
-
-if Object.const_defined?('Rails')
-  require 'sitemapper/adapters/rails_adapter'
-  Sitemapper::Adapters::RailsAdapter.install!
-end
-Object.send(:include, Sitemapper::ObjectMapper)

data/lib/sitemapper.rb

@@ -1,15 +1,17 @@
 $:.unshift(File.dirname(__FILE__))
 require 'sitemapper/helpers'
+require 'sitemapper/sitemap_xml'
 require 'sitemapper/map'
+require 'sitemapper/map_index'
 require 'sitemapper/accessors'
 require 'sitemapper/object_mapper'
 
 module Sitemapper
-  MAJOR, MINOR, TINY = 0, 3, 0 #:nodoc:
+  MAJOR, MINOR, PATCH = 0, 3, 0 #:nodoc:
 
   # Get the running version of Sitemapper
   def self.version
-    [MAJOR, MINOR, TINY].join('.')
+    [MAJOR, MINOR, PATCH].join('.')
   end
 
   def self.map=(map)
@@ -17,7 +19,31 @@ module Sitemapper
   end
 
   def self.map
-    @map or raise 'Uninitialized Sitemapper.map'
+    @map
+  end
+
+  def self.map_index=(index)
+    @map_index = index
+  end
+
+  def self.map_index
+    @map_index
+  end
+    
+  # Returns the site root (previously defined with site_root=)
+  def self.site_root
+    @@site_root ||= 'http://www.example.com/' 
+  end
+
+  # Set the site root for the generated URLs
+  #
+  # * <tt>root</tt> is the root, (ex.: http://www.example.com)
+  def self.site_root=(root)
+    @@site_root = root
+  end
+
+  def self.urlfy(url_or_path)
+    url_or_path =~ /^https?:/ ? url_or_path : URI.join(self.site_root, url_or_path)
   end
 
   # Define the default meta lookup for objects on <tt>page</tt> helper
@@ -46,3 +72,9 @@ module Sitemapper
     }
   end
 end
+
+if Object.const_defined?('Rails')
+  require 'sitemapper/adapters/rails_adapter'
+  Sitemapper::Adapters::RailsAdapter.install!
+end
+Object.send(:include, Sitemapper::ObjectMapper)

data/lib/sitemapper/accessors.rb

@@ -0,0 +1,25 @@
+module Sitemapper
+  module Accessors
+    def map_url(url, opts={})
+      Sitemapper::map.map_url(url, opts)
+    end
+
+    def map_path(path, opts={})
+      Sitemapper::map.map_path(path, opts)
+    end
+
+    def unmap_url(url)
+      Sitemapper::map.unmap_url(url)
+    end
+
+    def unmap_path(path)
+      Sitemapper::map.unmap_path(path)
+    end
+
+    def map_urls
+      Sitemapper::map.map_urls do
+        yield
+      end
+    end
+  end
+end

data/lib/sitemapper/adapters/rails_adapter.rb

@@ -2,14 +2,15 @@ module Sitemapper
   module Adapters
     module RailsAdapter
       module RoutesMapperExtension
-        include Sitemapper::Accessors
-
         def self.included(base)
           base.class_eval do
             alias_method_chain :named_route, :sitemap
             alias_method_chain :connect, :sitemap
             alias_method_chain :root, :sitemap
           end
+          path = File.join(Rails.root, 'public', 'sitemap_static.xml.gz')
+          File.unlink(path) if File.exists?(path)
+          @@map = Sitemapper::map_index.build_map(path)
         end
 
         def named_route_with_sitemap(name, path, options = {})
@@ -34,7 +35,7 @@ module Sitemapper
           method = options[:conditions][:method] rescue :get
           # TODO: extract options to map
           unless path =~ /[:*]/ || method != :get
-            map_path(path)
+            @@map.map_path(path)
           end
         end
       end
@@ -42,9 +43,10 @@ module Sitemapper
       # Install routing hooks, view helpers and initialize the
       # sitemap.xml file
       def self.install!
-        Sitemapper::Map.site_root = ActionController::Base.relative_url_root rescue
+        Sitemapper::site_root = ActionController::Base.relative_url_root rescue
                                     ActionController::AbstractRequest.relative_url_root
-        Sitemapper::map = Sitemapper::Map.new(File.join(Rails.root, 'public', 'sitemap.xml'))
+        Sitemapper::map_index = Sitemapper::MapIndex.new(File.join(Rails.root, 'public', 'sitemap_index.xml.gz'))
+        Sitemapper::map = Sitemapper::map_index.build_map(File.join(Rails.root, 'public', 'sitemap_dynamic.xml.gz'))
         ActionController::Routing::RouteSet::Mapper.send :include, RoutesMapperExtension
         ActionView::Base.send :include, Sitemapper::Helpers
         ActionController::Base.send :include, Sitemapper::Accessors

data/lib/sitemapper/map.rb

@@ -1,34 +1,11 @@
 require 'rexml/document'
 require 'thread'
 require 'uri'
+require 'zlib'
 
 module Sitemapper
-  class Map
-    SCHEMA = 'http://www.sitemaps.org/schemas/sitemap/0.9' #:nodoc:
-    INDENT = -1 #:nodoc:
-
-    # Returns the site root (previously defined with site_root=)
-    def self.site_root
-      @@site_root ||= 'http://www.example.com/' 
-    end
-
-    # Set the site root for the generated URLs
-    #
-    # * <tt>root</tt> is the root, (ex.: http://www.example.com)
-    def self.site_root=(root)
-      @@site_root = root
-    end
-
-    # Initialize a map
-    #
-    # * <tt>file</tt> is the path to the (new or existent) sitemap.xml
-    def initialize(file)
-      @builder = REXML::Document.new(File.exists?(file)? File.read(file) : nil)
-      @locker = Mutex.new
-      @file = file
-      @write = true
-      initialize_map
-    end
+  class Map < SitemapXML
+    @@root_tag = 'urlset'
 
     # Map the given localization
     #
@@ -42,19 +19,19 @@ module Sitemapper
     #
     # See http://www.sitemaps.org/protocol.php
     def map_url(loc, opts={})
-      @locker.synchronize do
-        set_url_node(loc, opts)
+      self.locker.synchronize do
+        loc = Sitemapper.urlfy(loc)
+        lastmod, changefreq, priority = extract_options(opts)
+        url = get_url(loc) || self.builder.root.add_element('url')
+        (url.elements['loc'] || url.add_element('loc')).text = loc
+        (url.elements['lastmod'] || url.add_element('lastmod')).text = lastmod.strftime('%Y-%m-%d') if lastmod
+        (url.elements['changefreq'] || url.add_element('change_freq')).text = changefreq.to_s if changefreq
+        (url.elements['priority'] || url.add_element('priority')).text = '%.2f' % priority if priority
+
         write_file
       end
     end
-
-    # Map the given path
-    #
-    # <tt>path</tt> is the path to be mapped
-    # <tt>opts</tt> is a hash containing options for this url (see <tt>map_url</tt>)
-    def map_path(path, opts={})
-      map_url(URI.join(Map.site_root, path), opts)
-    end
+    alias map_path map_url
 
     # Map multiple URLs and write once (at the end)
     #
@@ -70,42 +47,24 @@ module Sitemapper
       yield(self)
       @write = true
 
-      @locker.synchronize { write_file }
+      self.locker.synchronize { write_file }
     end
 
     # Unmap the given localization (<tt>loc</tt>)
     #
     # * <tt>loc</tt> is the URL to be unmaped
     def unmap_url(loc)
-      @locker.synchronize do
-        unset_url_node(loc)
-        write_file
+      self.locker.synchronize do
+        if url = get_url(Sitemapper.urlfy(loc))
+          url.remove
+          write_file
+        end
       end
     end
-
-    # Unmap the given path
-    #
-    # * <tt>loc</tt> is the Path t be unmaped
-    def unmap_path(loc)
-      unmap_url(URI.join(Map.site_root, loc))
-    end
+    alias map_path map_url
 
     private
 
-    def set_url_node(loc, opts)
-      lastmod, changefreq, priority = extract_options(opts)
-      url = get_url(loc) || @builder.root.add_element('url')
-      (url.elements['loc'] || url.add_element('loc')).text = loc
-      (url.elements['lastmod'] || url.add_element('lastmod')).text = lastmod.strftime('%Y-%m-%d') if lastmod
-      (url.elements['changefreq'] || url.add_element('change_freq')).text = changefreq.to_s if changefreq
-      (url.elements['priority'] || url.add_element('priority')).text = '%.2f' % priority if priority
-    end
-
-    def unset_url_node(loc)
-      url = get_url(loc)
-      url.remove if url
-    end
-
     # Extract the options to map an URL
     #
     # see <tt>map_url</tt> to understand.
@@ -119,24 +78,7 @@ module Sitemapper
 
     # Return the Element for the given <tt>url</tt>
     def get_url(url)
-      @builder.elements["//url[loc='#{url}']"]
-    end
-
-    # Write the file to disk (run only synchronized with @locker)
-    def write_file
-      File.open(@file, 'w') {|file| @builder.write(file, INDENT)} if @write
-    end
-
-    # Initialize the map (called on the boot, normally)
-    def initialize_map
-      if @builder.root.nil?
-        @builder << REXML::XMLDecl.new('1.0', 'UTF-8')
-        @builder.add_element('urlset', 'xmlns' => SCHEMA)
-      else
-        raise InvalidMap unless @builder.root.attributes.key? 'xmlns'
-      end
+      self.builder.elements["//url[loc='#{url}']"]
     end
   end
-
-  class InvalidMap < StandardError; end
 end

data/lib/sitemapper/map_index.rb

@@ -0,0 +1,53 @@
+# <?xml version="1.0" encoding="UTF-8"?>
+# <sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+#   <sitemap>
+#       <loc>http://www.example.com/sitemap1.xml.gz</loc>
+#       <lastmod>2004-10-01T18:23:17+00:00</lastmod>
+#   </sitemap>
+#   <sitemap>
+#       <loc>http://www.example.com/sitemap2.xml.gz</loc>
+#       <lastmod>2005-01-01</lastmod>
+#   </sitemap>
+# </sitemapindex>
+require 'rexml/document'
+require 'thread'
+require 'uri'
+require 'zlib'
+
+module Sitemapper
+  class MapIndex < SitemapXML
+    @@root_tag = 'sitemapindex'
+
+    def build_map(file, url_or_path=nil, lastmod=nil)
+      add_map(url_or_path || File.basename(file), lastmod)
+      map = Map.new(file)
+    end
+
+    def add_map(url_or_path, lastmod=nil)
+      self.locker.synchronize do
+        url_or_path = Sitemapper.urlfy(url_or_path)
+        map = get_sitemap(url_or_path) || self.builder.root.add_element('sitemap')
+        (map.elements['loc'] || map.add_element('sitemap')).text = url_or_path
+        (map.elements['lastmod'] || map.add_element('lastmod')).text = lastmod.strftime('%Y-%m-%d') if lastmod
+      
+        write_file
+      end
+    end
+
+    def remove_map(url_or_path)
+      self.locker.synchronize do
+        if map = get_sitemap(Sitemapper.urlfy(url_or_path))
+          map.remove
+          write_file
+        end
+      end
+    end
+
+    private
+
+    # Return the sitemap Element for the given <tt>url</tt>
+    def get_sitemap(url)
+      self.builder.elements["//sitemap[loc='#{url}']"]
+    end
+  end
+end

data/lib/sitemapper/object_mapper.rb

@@ -0,0 +1,6 @@
+module Sitemapper
+  module ObjectMapper
+    attr_accessor :sitemapper_config
+    alias map_fields sitemapper_config=
+  end
+end

data/lib/sitemapper/sitemap_xml.rb

@@ -0,0 +1,71 @@
+require 'zlib'
+require 'stringio'
+
+module Sitemapper
+  class SitemapXML
+    SCHEMA = 'http://www.sitemaps.org/schemas/sitemap/0.9' #:nodoc:
+    INDENT = -1 #:nodoc:
+    @@root_tag = nil
+
+    # Initialize a map
+    #
+    # * <tt>file</tt> is the path to the (new or existent) sitemap.xml
+    def initialize(file)
+      @file = file
+      @write = true
+      @gzip = @file =~ /gz$/i
+      initialize_map
+    end
+
+    protected
+
+    def locker
+      @locker ||= Mutex.new
+    end
+
+    def builder
+      @builder
+    end
+
+    # Write the file to disk (run only synchronized with @locker)
+    def write_file
+      File.open(@file, 'w') do |file|
+        content = ''
+        @builder.write(content, INDENT)
+
+        if @gzip
+          gz = Zlib::GzipWriter.new(file)
+          gz.write content
+          gz.close
+        else
+          file.write(content)
+        end
+      end if @write
+    end
+
+    # Initialize the map (called on the boot, normally)
+    def initialize_map
+      @builder = REXML::Document.new(if File.exists?(@file)
+        content = nil
+        if @gzip
+          Zlib::GzipReader.open(@file) {|gz| content = gz.read}
+        else
+          content = File.read(@file)
+        end
+        content
+      else
+        nil
+      end)
+
+      if @builder.root.nil?
+        @builder << REXML::XMLDecl.new('1.0', 'UTF-8')
+        @builder.add_element(@@root_tag, 'xmlns' => SCHEMA)
+        write_file
+      else
+        raise InvalidMap unless @builder.root.attributes.key? 'xmlns'
+      end
+    end
+  end
+
+  class InvalidMap < StandardError; end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sitemapper
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Carlos Junior
@@ -40,8 +40,12 @@ files:
 - init.rb
 - tasks/sitemaper_tasks.rake
 - lib/sitemapper.rb
+- lib/sitemapper/accessors.rb
 - lib/sitemapper/helpers.rb
 - lib/sitemapper/map.rb
+- lib/sitemapper/sitemap_xml.rb
+- lib/sitemapper/map_index.rb
+- lib/sitemapper/object_mapper.rb
 - lib/sitemapper/adapters/rails_adapter.rb
 has_rdoc: true
 homepage: http://redmine.milk-it.net/projects