RubyGems - sitemapper - Versions diffs - 0.2.0 - Mend

sitemapper 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +121 -0
data/Rakefile +22 -0
data/init.rb +6 -0
data/install.rb +2 -0
data/lib/sitemapper.rb +20 -0
data/lib/sitemapper/adapters/rails_adapter.rb +54 -0
data/lib/sitemapper/helpers.rb +91 -0
data/lib/sitemapper/map.rb +122 -0
data/tasks/sitemaper_tasks.rake +4 -0
data/test/sitemapper_test.rb +8 -0
metadata +83 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Carlos Júnior, Milk-it Software House
+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 ADDED Viewed

@@ -0,0 +1,121 @@
+= Sitemapper - Easy SEO engine
+Sitemapper will help you in various SEO techniques such as sitemap.xml
+auto generation.
+== Installation
+  You can install the development version with
+  % sudo gem install milk-it-sitemapper -s http://gems.github.com
+  Or the release version with
+  % sudo gem install sitemapper
+== 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 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)
+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 ADDED Viewed

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+desc 'Default: run unit tests.'
+task :default => :test
+desc 'Test the sitemaper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+desc 'Generate documentation for the sitemaper plugin.'
+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('lib/**/*.rb')
+end

data/init.rb ADDED Viewed

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

data/install.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ puts "ATTENTION!!!"
2	+ puts "You have to setup config.action_controller.relative_url_root\non your config to Sitemapper work correctly!"

data/lib/sitemapper.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'sitemapper/helpers'
+require 'sitemapper/map'
+require 'sitemapper/accessors'
+module Sitemapper
+  MAJOR, MINOR, TINY = 0, 2, 0 #:nodoc:
+  # Get the running version of Sitemapper
+  def version
+    [MAJOR, MINOR, TINY].join('.')
+  end
+  def self.map=(map)
+    @map = map
+  end
+  def self.map
+    @map or raise 'Uninitialized Sitemapper.map'
+  end
+end

data/lib/sitemapper/adapters/rails_adapter.rb ADDED Viewed

@@ -0,0 +1,54 @@
+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
+        end
+        def named_route_with_sitemap(name, path, options = {})
+          map_if_possible(path, options)
+          named_route_without_sitemap(name, path, options)
+        end
+        def connect_with_sitemap(path, options = {})
+          map_if_possible(path, options)
+          connect_without_sitemap(path, options)
+        end
+        def root_with_sitemap(options = {})
+          map_if_possible('/', options)
+          root_without_sitemap(options)
+        end
+        private
+        def map_if_possible(path, options)
+          # Don't map dynamic URLs
+          method = options[:conditions][:method] rescue :get
+          # TODO: extract options to map
+          unless path =~ /[:*]/ || method != :get
+            map_path(path)
+          end
+        end
+      end
+      # Install routing hooks, view helpers and initialize the
+      # sitemap.xml file
+      def self.install!
+        Sitemapper::Map.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'))
+        ActionController::Routing::RouteSet::Mapper.send :include, RoutesMapperExtension
+        ActionView::Base.send :include, Sitemapper::Helpers
+        ActionController::Base.send :include, Sitemapper::Accessors
+      end
+    end
+  end
+end

data/lib/sitemapper/helpers.rb ADDED Viewed

@@ -0,0 +1,91 @@
+module Sitemapper
+  module Helpers
+    # Set the page data for title and meta tags
+    #
+    # ==== Parameters
+    # * <tt>:title</tt> the title of the page
+    # * <tt>:desc</tt> the description of the current page
+    # * <tt>:keywords</tt> the keywords that represent the current page
+    #
+    # ==== The parameter can also be an object that respond to (used preferentially on this order):
+    # * <tt>title</tt> OR <tt>name</tt> (for title)
+    # * <tt>short_description</tt> OR <tt>description</tt> (for description)
+    # * <tt>tag_list</tt> OR <tt>keywords</tt> (for keywords)
+    #
+    # See <tt>page_meta</tt> for further information and examples.
+    #
+    def page(defs)
+      @_title = defs.delete(:title)
+      @_desc  = defs.delete(:desc)
+      @_keys  = defs.delete(:keywords)
+    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
+    end
+    alias_method_chain :page, :object
+    # Returns the title of the page with the website title
+    #
+    # ==== Parameters
+    #
+    # * the first parameter is the website title
+    # * the second parameter is a options hash:
+    #   * <tt>:separator</tt> is the separator of the page and the website title
+    #
+    # See <tt>page_meta</tt> for further information and examples.
+    #
+    def title(title, opts={})
+      separator = opts[:separator] || ' :: '
+      content_tag(:title, @_title.nil?? title : "#{@_title}#{separator}#{title}")
+    end
+    # Returns the meta tags for the current page, for example:
+    #
+    #   app/views/foo/bar.html.erb
+    #
+    #   page(:title => 'Foo bar!',
+    #     :description => 'Lorem ipsum dollar sit amet',
+    #     :keywords => 'lorem, ipsum dollar, sit, amet')
+    #
+    #   app/views/layouts/application.html.erb
+    #
+    #   ...
+    #   <head>
+    #       <%= title('My Webste') %>
+    #       <%= page_meta %>
+    #   </head>
+    #   ...
+    #
+    # The example above will output the following on the rendered page:
+    #
+    #   ...
+    #   <head>
+    #       <title>Foo bar! :: My Website</title>
+    #       <meta name="description" content="Lorem ipsum dollar sit amet" />
+    #       <meta name="keywords" content="lore, ipsum dollar, sit, amet" />
+    #   </head>
+    #
+    def page_meta
+      res = ''
+      res << tag(:meta, :name => 'description', :content => @_desc) if @_desc
+      res << tag(:meta, :name => 'keywords', :content => @_keys) if @_desc
+      return res
+    end
+  end
+end

data/lib/sitemapper/map.rb ADDED Viewed

@@ -0,0 +1,122 @@
+require 'rexml/document'
+require 'thread'
+require 'uri'
+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
+      initialize_map
+    end
+    # Map the given localization
+    #
+    # <tt>loc</tt> is the URL to me mapped
+    # <tt>opts</tt> is a hash with the following parameters:
+    #
+    # * <tt>url</tt> or <tt>path</tt> is the complete URL or path (ex.: /articles/rails-doesnt-scale) [required]
+    # * <tt>lastmod</tt> a date object to the last modification [optional]
+    # * <tt>changefreq</tt> the frequency of change (:daily, :monthly, :yearly) [optional]
+    # * <tt>priority</tt> the priority of the URL (0..1) [optional]
+    #
+    # 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
+        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
+    def map_urls #:nodoc:
+      # TODO: method to add various URLs and just write in the end
+    end
+    # Unmap the given localization (<tt>loc</tt>)
+    #
+    # * <tt>loc</tt> is the URL to be unmaped
+    def unmap_url(loc)
+      @locker.synchronize do
+        url = get_url(loc)
+        url.remove if url
+        write_file
+      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
+    private
+    # Extract the options to map an URL
+    #
+    # see <tt>map_url</tt> to understand.
+    def extract_options(opts)
+      lastmod = opts.delete(:lastmod)
+      changefreq = opts.delete(:changefreq)
+      priority = opts.delete(:priority)
+      [lastmod, changefreq, priority]
+    end
+    # 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)}
+    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
+    end
+  end
+  class InvalidMap < StandardError; end
+end

data/tasks/sitemaper_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sitemaper do
+#   # Task goes here
+# end

data/test/sitemapper_test.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'test/unit'
+class SitemaperTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: sitemapper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Carlos Junior
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-01-06 00:00:00 -02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "2.1"
+    version:
+description: Sitemapper helps you to apply SEO techniques on your Ruby on Rails application, including auto generation of a sitemap.
+email:
+- carlos@milk-it.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+files:
+- README.rdoc
+- Rakefile
+- MIT-LICENSE
+- install.rb
+- init.rb
+- tasks/sitemaper_tasks.rake
+- lib/sitemapper.rb
+- lib/sitemapper/helpers.rb
+- lib/sitemapper/map.rb
+- lib/sitemapper/adapters/rails_adapter.rb
+has_rdoc: true
+homepage: http://redmine.milk-it.net/projects
+post_install_message: |
+    Thank you for using Sitemapper.
+    Consider help us to maintain Sitemapper by donating (github.com/milk-it/sitemapper) if you like it!
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- Sitemapper
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: sitemapper
+rubygems_version: 1.3.1
+signing_key:
+specification_version: 2
+summary: Sitemapper helps you to apply SEO techniques on your Ruby on Rails application, including auto generation of a sitemap.
+test_files:
+- test/sitemapper_test.rb