RubyGems - milk-it-sitemapper - Versions diffs - 0.2.0 → 0.3.0 - Mend

milk-it-sitemapper 0.2.0 → 0.3.0

Files changed (6) hide show

data/README.rdoc CHANGED Viewed

@@ -7,17 +7,132 @@ auto generation.
   You can install the development version with
-  % sudo gem sources -a http://gems.github.com # (you only need to do this once)
-  % sudo gem install milk-it-sitemapper
+  % sudo gem install milk-it-sitemapper -s http://gems.github.com
   Or the release version with
   % sudo gem install sitemapper
-== Example
+== Examples
-TODO: examples
+=== Ruby On Rails
+Sitemapper will automagically generate a sitemap.xml file for you when
+your rails application start, this sitemap.xml will include all your
+URLs that Sitemapper consider 'static', for example:
+  map.todo '/to-do' # Sitemapper will consider this as static
+  map.articles '/articles/:year/:month' # Will be considered this dynamic
+  map.connect '*path' # Will be considered dynamic
+The generation of your sitemap.xml will happen on your application boot,
+but it won't delete any URL previous added (we hope to be able to do so
+very soon - a merge).
+In your application, you can use the accessors provided by Sitemapper to
+dynamically add URLs, for example, supose a blog app:
+  class ArticlesController < ApplicationController
+    ...
+    def create
+      # do all the creation stuff
+      map_url(article_url(@article)) # add the URL to your sitemap
+    end
+    def destroy
+      # do all the deletion stuff
+      unmap_url(article_url(@article))
+    end
+    ...
+  end
+You can also do it on your sweepers (which is a better choice)
+  class ArticleSweeper < ActionController::Caching::Sweeper
+    observe Article, Account
+    def after_create(record)
+      # expire everything you need
+      map_url(polymorphic_url(record))
+    end
+    def after_destroy(record)
+      # expire everything you need
+      map_url(polymorphic_url(record))
+    end
+  end
+=== Merb
+Sorry, we do not support Merb yet. (Actually, it will depend on the
+demand)
+=== Other SEO techniques
+With SEO, you'll have some view helpers to easily apply some SEO
+techniques to your website/webapp.
+In your application layout, just do it:
+  <head>
+      <%= title('My Personal Blog') %>
+      <%= page_meta %>
+  </head>
+And in your action views, you put this:
+  <% page(:title => 'Contact',
+    :desc => 'Here you'll can contact our customer support ...',
+    :keywords => 'contact, support, customer') %>
+In this case, the view will be rendered in this way:
+  <head>
+      <title>Contact :: My Personal Blog</title>
+      <meta name="description" content="Here you'll can contact our customer support ..." />
+      <meta name="keywords" content="contact, support, customer" />
+  </head>
+If you want to change the title separator, just do:
+    ...
+    <%= title('My Personal Blog', :separator => ' - ') %>
+    ...
+Or, you can als use any object that respond to title or name (for
+page title), short_description or description, tag_list or keywords.
+  <% page(@event) %>
+If you need to change the default method lookup for page, you have two ways:
+==== Add an initializer with the following content (that will change the default method lookup sequence):
+  Sitemapper.meta_lookup = {:title => [:my_default_title_method, :my_second_default_title_method]
+    :desc => [:my_default_description_method, :my_second_default_description_method],
+    :keywords => [:my_default_keywords_method, :my_second_default_keywords_methods]
+  }
+==== Configure per object (yes, object, not just ActiveRecord descendents) lookups:
+  class MyObject
+    map_fields :title => :weird_title, :desc => :weird_description, :keywords => :weird_keywords
+    ...
+  end
+If you want to suggest any other SEO technique, suggest it on
+carlos@milk-it.net
+=== Hope you enjoy!
+== 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/Rakefile CHANGED Viewed

@@ -17,6 +17,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Sitemaper'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.main = 'README.rdoc'
 end

data/init.rb CHANGED Viewed

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

data/lib/sitemapper/helpers.rb CHANGED Viewed

@@ -18,27 +18,30 @@ module Sitemapper
       @_title = defs.delete(:title)
       @_desc  = defs.delete(:desc)
       @_keys  = defs.delete(:keywords)
+      return nil # dummies safe!
     end
     def page_with_object(defs) # :nodoc:
       return page_without_object(defs) if defs.is_a?(Hash)
-      @_title = if defs.respond_to?(:title)
-        defs.title
-      elsif defs.respond_to?(:name)
-        defs.name
-      end
-      @_desc  = if defs.respond_to?(:short_description)
-        defs.short_description
-      elsif defs.respond_to?(:description)
-        defs.description
-      end
-      @_keys  = if defs.respond_to?(:tag_list)
-        defs.tag_list
-      elsif defs.respond_to?(:keywords)
-        defs.keywords
-      end
+      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
+      @_title = lookup_method.call(defs, :title)
+      @_desc  = lookup_method.call(defs, :desc)
+      @_keys  = lookup_method.call(defs, :keywords)
     end
-    alias_method_chain :page, :object
+    alias_method :page_without_object, :page
+    alias_method :page, :page_with_object
     # Returns the title of the page with the website title
     #

data/lib/sitemapper.rb CHANGED Viewed

@@ -1,12 +1,14 @@
+$:.unshift(File.dirname(__FILE__))
 require 'sitemapper/helpers'
 require 'sitemapper/map'
 require 'sitemapper/accessors'
+require 'sitemapper/object_mapper'
 module Sitemapper
-  MAJOR, MINOR, TINY = 0, 2, 0 #:nodoc:
+  MAJOR, MINOR, TINY = 0, 3, 0 #:nodoc:
   # Get the running version of Sitemapper
-  def version
+  def self.version
     [MAJOR, MINOR, TINY].join('.')
   end
@@ -17,4 +19,30 @@ module Sitemapper
   def self.map
     @map or raise 'Uninitialized Sitemapper.map'
   end
+  # Define the default meta lookup for objects on <tt>page</tt> helper
+  #
+  # <tt>lookup</tt> is a hash with the following options:
+  #
+  # * <tt>:desc</tt> method to look for page description
+  # * <tt>:keywords</tt> method to look for page keywords
+  # * <tt>:title</tt> method to look for page title
+  #
+  # All these arguments can be an Array, String or Symbol and will
+  # be used to lookup a valid method when you call <tt>page</tt> using
+  # something different of a Hash as argument. For example:
+  #
+  # <% page(@contact) %>
+  #
+  def self.meta_lookup=(lookup)
+    @meta_lookup = lookup
+  end
+  def self.meta_lookup
+    @meta_lookup || {
+      :desc     => [:short_description, :description],
+      :keywords => [:tag_list, :keywords],
+      :title    => [:title, :name]
+    }
+  end
 end

metadata CHANGED Viewed

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