milk-it-sitemapper 0.3.0 → 0.3.1

data/README.rdoc

@@ -68,6 +68,21 @@ You can also do it on your sweepers (which is a better choice)
 Sorry, we do not support Merb yet. (Actually, it will depend on the
 demand)
 
+=== Mapping multiple URLs
+
+If you need to map multiple urls, it's high recommended to use #map_urls, to do so:
+
+  map.map_urls do |map|
+    map.map_url('http://www.example.org/about')
+    ...
+  end
+
+  or, if you are in a Sweeper or Controller
+
+  map_urls do |map|
+   ...
+  end
+
 === Other SEO techniques
 
 With SEO, you'll have some view helpers to easily apply some SEO
@@ -121,18 +136,18 @@ If you need to change the default method lookup for page, you have two ways:
     ...
   end
 
-If you want to suggest any other SEO technique, suggest it on
-carlos@milk-it.net
+If you don't specify all the fields, it'll be merged with the Sitemapper.meta_lookup config.
 
 === Hope you enjoy!
 
+If you want to suggest any other SEO technique, suggest it on carlos@milk-it.net
+
 == To do:
 
  * Add sitemap options to routes
  * Create separate files for dynamic and static routes (then, we'll can
    delete all the static on startup)
  * Write test code (sorry, I really didn't it)
- * Write the Sitemapper::Map#map_urls method
 
 Copyright (c) 2008 Carlos Júnior, released under the MIT license
 Copyright (c) 2008 Milk-it Software House, released under the MIT license

data/lib/sitemapper/helpers.rb

@@ -21,24 +21,20 @@ module Sitemapper
       return nil # dummies safe!
     end
 
-    def page_with_object(defs) # :nodoc:
-      return page_without_object(defs) if defs.is_a?(Hash)
+    def page_with_object(obj) # :nodoc:
+      obj = begin
+        lookup = Sitemapper.meta_lookup.merge(obj.class.sitemapper_config || {})
+        defs = {}
+        [:title, :desc, :keywords].each do |key|
+          method = lookup[key]
+          method = method.find {|m| obj.respond_to?(m)} if method.is_a?(Array)
 
-      lookup_method = lambda do |obj, key|
-        methods = obj.class.respond_to?(:sitemapper_config)? obj.class.sitemapper_config : Sitemapper.meta_lookup
-        methods = methods[key]
-        method = if methods.is_a?(Array)
-          methods.find {|m| obj.respond_to?(m)}
-        elsif methods.is_a?(String) || methods.is_a?(Symbol)
-          methods
-        end
-        logger.debug(">>> #{method}")
-        return method.nil?? nil : obj.send(method)
-      end # Do you think it's ugly? You have to see my grandma in underwear
+          defs[key] = method.nil?? nil : obj.send(method)
+        end # Do you think it's ugly? You have to see my grandma in underwear
+        defs
+      end unless obj.is_a?(Hash)
 
-      @_title = lookup_method.call(defs, :title)
-      @_desc  = lookup_method.call(defs, :desc)
-      @_keys  = lookup_method.call(defs, :keywords)
+      return page_without_object(obj)
     end
     alias_method :page_without_object, :page
     alias_method :page, :page_with_object

data/lib/sitemapper/map.rb

@@ -9,7 +9,7 @@ module Sitemapper
 
     # Returns the site root (previously defined with site_root=)
     def self.site_root
-      @@site_root || 'http://www.example.com/'
+      @@site_root ||= 'http://www.example.com/' 
     end
 
     # Set the site root for the generated URLs
@@ -26,6 +26,7 @@ module Sitemapper
       @builder = REXML::Document.new(File.exists?(file)? File.read(file) : nil)
       @locker = Mutex.new
       @file = file
+      @write = true
       initialize_map
     end
 
@@ -41,14 +42,8 @@ module Sitemapper
     #
     # See http://www.sitemaps.org/protocol.php
     def map_url(loc, opts={})
-      lastmod, changefreq, priority = extract_options(opts)
       @locker.synchronize do
-        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
-
+        set_url_node(loc, opts)
         write_file
       end
     end
@@ -61,8 +56,21 @@ module Sitemapper
       map_url(URI.join(Map.site_root, path), opts)
     end
 
-    def map_urls #:nodoc:
-      # TODO: method to add various URLs and just write in the end
+    # Map multiple URLs and write once (at the end)
+    #
+    # Usage:
+    # 
+    #   map.map_urls do |map|
+    #     map.map_url('http://www.example.com/about')
+    #     map.unmap_url('http://www.example.com/contact')
+    #   end
+    #
+    def map_urls
+      @write = false
+      yield(self)
+      @write = true
+
+      @locker.synchronize { write_file }
     end
 
     # Unmap the given localization (<tt>loc</tt>)
@@ -70,9 +78,7 @@ module Sitemapper
     # * <tt>loc</tt> is the URL to be unmaped
     def unmap_url(loc)
       @locker.synchronize do
-        url = get_url(loc)
-        url.remove if url
-
+        unset_url_node(loc)
         write_file
       end
     end
@@ -86,6 +92,20 @@ module Sitemapper
 
     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.
@@ -104,7 +124,7 @@ module Sitemapper
 
     # Write the file to disk (run only synchronized with @locker)
     def write_file
-      File.open(@file, 'w') {|file| @builder.write(file, INDENT)}
+      File.open(@file, 'w') {|file| @builder.write(file, INDENT)} if @write
     end
 
     # Initialize the map (called on the boot, normally)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: milk-it-sitemapper
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Carlos Junior