seo_meta_builder 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.1.0 (Mar 12, 2010)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+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

@@ -0,0 +1,15 @@
+= SeoMetaBuilder
+
+Seo Meta Builder is a plugin for Ruby on Rails that lets you easily manage your meta titles and descriptions.
+
+All necessary informations are available on the wiki : http://wiki.github.com/kwi/seo_meta_builder
+
+== Functionalities :
+
+* Help to eradicate duplicate titles and descriptions (Very good for SEO)
+* Easy to set up
+* Build title/description with multiple parameters
+* Works with multiple languages through the I18n Api.
+* Works with Rails 2 and Rails 3
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs for current Rails version"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts =  ["-c"]
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'seo_meta_builder'

data/lib/seo_meta_builder.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+# Build localized titles and description for webpages
+module SeoMetaBuilder
+
+  # Set title and description at the same time
+  def set_page_metas(hash, order = nil)
+    set_page_title(hash, order)
+    set_page_description(hash, order)
+  end
+
+  # Set the page title with an hash of parameters
+  def set_page_title(hash, order = nil, type = :title)
+    @page_title = page_meta_string_builder(type, hash, order)
+  end
+
+  # Set the page description with an hash of parameters
+  def set_page_description(hash, order = nil, type = :description)
+    @page_description = page_meta_string_builder(type, hash, order)
+  end
+
+private
+  def page_meta_auto_hash
+    hash = {}
+    hash[:id] = params[:id] if !params[:id].blank?
+    if !params[:page].blank?
+      (hash[:page] = params[:page].to_i) rescue nil
+    end
+    return hash
+  end
+  
+  AutoOrder = [:id, :page]
+  
+  # Return the default action name to use as scope
+  def page_meta_action_name
+    case params[:action]
+      when 'create'
+        :new
+      when 'update'
+        :edit
+      when 'destroy'
+        :show
+      else
+        params[:action]
+    end
+  end
+  
+  # Return an escaped value for building metas
+  def page_meta_escape_value(val)
+    val.to_s.gsub("<", "&lt;").gsub(">", "&gt;")
+  end
+
+  # Build a meta string for i18n dependings on parameters
+  def page_meta_string_builder(type = :title, hash = {}, order = nil)
+    pt = "page_#{type}"
+    
+    # Build order table
+    order = hash.keys if !order
+    order.each do |k|
+      pt << " - #{k}: %s" if hash[k]
+    end
+
+    # Build values table ordered and escaped
+    values = []
+    order.each do |k|
+      # Escape value :
+      values << page_meta_escape_value(hash[k]) if hash[k]
+    end
+
+    pt = I18n.t(pt, :default => 'no', :scope => :"meta.#{params[:controller]}.#{page_meta_action_name}")
+    
+    # No translation found
+    # So use meta/default translation !
+    if pt == 'no'
+      pt = "page_#{type}"
+      pt << (' - %s' * values.size)
+      pt = I18n.t(pt, :default => pt, :scope => :'meta.default')
+    end
+
+    begin
+      sprintf(pt, *values)
+    rescue Exception
+      raise 'Mal formed string : ' + pt.to_s + ' | for : ' + values.join(' - ').to_s
+    end
+  end
+
+public
+  def page_title
+    @page_title ||= page_meta_string_builder(:title, page_meta_auto_hash, AutoOrder)
+  end
+
+  def page_description
+    @page_description ||= page_meta_string_builder(:description, page_meta_auto_hash, AutoOrder)
+  end
+end
+
+
+# In order to use with rails :
+if defined? ActionView
+  ActionView::Base.send :include, SeoMetaBuilder
+end
+
+if defined? ActionController
+  ActionController::Base.send :include, SeoMetaBuilder
+end

data/spec/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  yo: 'salut'
+  meta:
+    default:
+      page_title: 'Default Title'
+      page_description: 'Default description'
+      "page_title - %s": 'Default Title %s'
+      "page_title - %s - %s": 'Default Title %s - %s'
+    users:
+      index:
+        page_title: 'Members list'
+        page_description: 'Members list description'
+      show:
+        "page_title - login: %s": '%s, member of our site'
+        "page_description - login: %s": '%s is member of our website'

data/spec/locales/fr.yml

@@ -0,0 +1,14 @@
+fr:
+  meta:
+    default:
+      page_title: 'Default Title Fr'
+      page_description: 'Default description Fr'
+      "page_title - %s": 'Default Title %s Fr'
+      "page_title - %s - %s": 'Default Title %s Fr - %s'
+    users:
+      index:
+        page_title: 'Listing des membres' 
+        page_description: 'La page de la liste des membres'
+      show:
+        "page_title - login: %s": '%s, membre de notre site' 
+        "page_description - login: %s": '%s est membre de notre site' 

data/spec/seo_meta_builder/seo_meta_builder_spec.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe :seo_meat_builder do
+  before(:all) do
+    I18n.load_path = []
+    I18n.reload!
+  end
+  
+  before(:each) do
+    @o = SeoMetaTester.new
+  end
+  
+  it "should show page_title when nothing is translated" do
+    @o.page_title.should == 'page_title'
+  end
+  
+  it "should show page_description when nothing is translated" do
+    @o.page_description.should == 'page_description'
+  end
+
+  it "should just load i18n translations test :p" do
+    # Add I18n load_path
+    I18n.load_path = (I18n.load_path << Dir[File.join(File.dirname(__FILE__), '../locales', '*.yml')]).uniq
+    I18n.reload!
+    I18n.locale = :en
+  end
+
+  it "should show correct default for page_title" do
+    @o.page_title.should == 'Default Title'
+  end
+
+  it "should show correct default for page_description" do
+    @o.page_description.should == 'Default description'
+  end
+  
+  it "should show correct default for page_title with auto id parameters" do
+    @o.params = {:controller => :u, :action => :a, :id => 1}
+    @o.page_title.should == 'Default Title 1'
+  end
+  
+  it "should show correct default for page_title with auto id parameters in fr" do
+    I18n.locale = :fr
+    @o.params = {:controller => :u, :action => :a, :id => 1}
+    @o.page_title.should == 'Default Title 1 Fr'
+  end
+  
+  it "should show correct default for page_title with auto id and page parameters" do
+    I18n.locale = :en
+    @o.params = {:controller => :u, :action => :a, :id => 1, :page => 32}
+    @o.page_title.should == 'Default Title 1 - 32'
+  end
+  
+  it "should show correct default for page_title with auto id and page parameters in fr" do
+    I18n.locale = :fr
+    @o.params = {:controller => :u, :action => :a, :id => 1, :page => 32}
+    @o.page_title.should == 'Default Title 1 Fr - 32'
+  end
+  
+  it "should show correct page_title with translation done" do
+    I18n.locale = :en
+    @o.params = {:controller => :users, :action => :index}
+    @o.page_title.should == 'Members list'
+  end
+  
+  it "should show correct page_title with parameters" do
+    I18n.locale = :en
+    @o.params = {:controller => :users, :action => :show}
+    @o.set_page_title(:login => 'kwi')
+    @o.page_title.should == 'kwi, member of our site'
+  end
+  
+  it "should show correct page_title with parameters in fr" do
+    I18n.locale = :fr
+    @o.params = {:controller => :users, :action => :show}
+    @o.set_page_title(:login => 'kwi')
+    @o.page_title.should == 'kwi, membre de notre site'
+  end
+
+  it "should show correct ordered parameters" do
+    I18n.locale = :en
+    @o.params = {:controller => :users, :action => :show}
+    @o.set_page_title({:p1 => :p1, :p3 => :p3, :p2 => :p2, :login => 'kwi'}, [:login, :p1, :p2, :p3])
+    @o.page_title.should == 'page_title - kwi - p1 - p2 - p3'
+  end
+  
+  it "should show not show parameters if no order is specified" do
+    I18n.locale = :en
+    @o.params = {:controller => :users, :action => :show}
+    @o.set_page_title({:p1 => :p1, :p3 => :p3, :p2 => :p2, :login => 'kwi'}, [:login, :p4, :p3])
+    @o.page_title.should == 'Default Title kwi - p3'
+  end
+
+  it "should correctly escape parameters" do
+    I18n.locale = :fr
+    @o.params = {:controller => :users, :action => :show}
+    @o.set_page_title(:login => '<script></script>')
+    @o.page_title.should == '&lt;script&gt;&lt;/script&gt;, membre de notre site'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'spec'
+
+require 'i18n'
+require 'active_support'
+
+require File.dirname(__FILE__) + '/../init.rb'
+
+class SeoMetaTester
+  include SeoMetaBuilder
+  
+  def params=(params)
+    @params = params
+  end
+  
+  def params
+    @params || {:controller => :controller, :action => :index}
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: seo_meta_builder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Seo Meta Builder is a plugin for Ruby on Rails that lets you easily manage your meta titles and descriptions.
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/seo_meta_builder.rb
+- spec/locales/en.yml
+- spec/locales/fr.yml
+- spec/seo_meta_builder/seo_meta_builder_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/seo_meta_builder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: seo_meta_builder
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Manage easily your meta titles and descriptions with Ruby On Rails
+test_files: []
+