meta-tags 1.1.1 → 1.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 rdoc
 doc
 pkg
-.yardoc
+.yardoc
+.DS_Store

data/README.rdoc

@@ -2,6 +2,11 @@
 
 Search Engine Optimization (SEO) plugin for Ruby on Rails applications.
 
+== Rails 3
+
+MetaTags master branch is now fully supports Rails 3 and is backward
+compatible.
+
 == Installation
 
 There are two options when approaching meta-tags installation:
@@ -11,7 +16,7 @@ There are two options when approaching meta-tags installation:
 
 To install as a gem, add this to your environment.rb:
 
-  config.gem 'meta-tags', :lib => 'meta_tags', :source => 'http://gemcutter.org'
+  config.gem 'meta-tags', :lib => 'meta_tags'
 
 And then run the command:
 
@@ -146,7 +151,7 @@ Also there is +set_meta_tags+ method exists:
                    :description => 'Member login page.',
                    :keywords => 'Site, Login, Members' %>
 
-The +title+ methods returns title itself, so you can use it to show the title
+The +title+ method returns title itself, so you can use it to show the title
 somewhere on the page:
 
   <h1><%= title 'Member Login' %></h1>
@@ -174,14 +179,14 @@ Use these options to customize the title format:
 
 And here are a few examples to give you ideas.
 
-  <%= title :separator => "&mdash;" %>
-  <%= title :prefix => false, :separator => ":" %>
-  <%= title :lowercase => true %>
-  <%= title :reverse => true, :prefix => false %>
+  <%= display_meta_tags :separator => "&mdash;" %>
+  <%= display_meta_tags :prefix => false, :separator => ":" %>
+  <%= display_meta_tags :lowercase => true %>
+  <%= display_meta_tags :reverse => true, :prefix => false %>
 
 === Allowed values
 
-You can specify +title+ as a string or array:
+You can specify <tt>:title</tt> as a string or array:
 
   set_meta_tags :title => ['part1', 'part2'], :site => 'site'
   # site | part1 | part2
@@ -207,3 +212,4 @@ There are several plugins influenced me to create this one:
 * Dmytro Shteflyuk (author) <kpumuk@kpumuk.info> http://kpumuk.info
 * Morgan Roderick (contributor) <morgan@roderick.dk> http://roderick.dk
 * Sergio Cambra (contributor) <sergio@entrecables.com>
+* Kristoffer Renholm (contributor) <kristoffer@renholm.se>

data/Rakefile

@@ -39,7 +39,7 @@ begin
     if ENV['PRIVATE']
       t.options.concat ['--protected', '--private']
     else
-      t.options << '--no-private' 
+      t.options.concat ['--protected', '--no-private']
     end
   end
 rescue LoadError

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 1
+:patch: 0
 :build: 
 :major: 1
-:minor: 1
+:minor: 2

data/init.rb

@@ -1 +1 @@
-require File.dirname(__FILE__) + '/lib/meta_tags'
+require 'meta_tags'

data/lib/meta_tags.rb

@@ -1,8 +1,10 @@
+require 'action_controller'
+require 'action_view'
+
 module MetaTags
+  autoload :ViewHelper,       'meta_tags/view_helper'
+  autoload :ControllerHelper, 'meta_tags/controller_helper'
 end
 
-require File.dirname(__FILE__) + '/meta_tags/view_helper'
-require File.dirname(__FILE__) + '/meta_tags/controller_helper'
-
 ActionView::Base.send :include, MetaTags::ViewHelper
 ActionController::Base.send :include, MetaTags::ControllerHelper

data/lib/meta_tags/controller_helper.rb

@@ -1,43 +1,35 @@
-# Contains methods to use in controllers.
-#
-# You can define several instance variables to set meta tags:
-#   @page_title = 'Member Login'
-#   @page_description = 'Member login page.'
-#   @page_keywords = 'Site, Login, Members'
-#
-# Also you can use +set_meta_tags+ method, that have the same parameters
-# as <tt>MetaTags.set_meta_tags</tt>.
 module MetaTags
+  # Contains methods to use in controllers.
+  #
+  # You can define several instance variables to set meta tags:
+  #   @page_title = 'Member Login'
+  #   @page_description = 'Member login page.'
+  #   @page_keywords = 'Site, Login, Members'
+  #
+  # Also you can use {InstanceMethods#set_meta_tags} method, that have the same parameters
+  # as {ViewHelper#set_meta_tags}.
+  #
   module ControllerHelper
-    def self.included(base)
-      base.send :include, InstanceMethods
-      base.class_eval do
-        alias_method_chain :render, :meta_tags
-      end
-    end
-
-    module InstanceMethods
-      protected
+    # Processes the <tt>@page_title</tt>, <tt>@page_keywords</tt>, and
+    # <tt>@page_description</tt> instance variables and calls +render+.
+    def render(*args, &block)
+      meta_tags = {}
+      meta_tags[:title]       = @page_title       if @page_title
+      meta_tags[:keywords]    = @page_keywords    if @page_keywords
+      meta_tags[:description] = @page_description if @page_description
+      set_meta_tags(meta_tags)
 
-        # Processes the <tt>@page_title</tt>, <tt>@page_keywords</tt>, and
-        # <tt>@page_description</tt> instance variables and calls +render+.
-        def render_with_meta_tags(options = nil, extra_options = {}, &block)
-          meta_tags = {}
-          meta_tags[:title] = @page_title if @page_title
-          meta_tags[:keywords] = @page_keywords if @page_keywords
-          meta_tags[:description] = @page_description if @page_description
-          set_meta_tags(meta_tags)
+      super(*args, &block)
+    end
 
-          render_without_meta_tags(options, extra_options, &block)
-        end
-      
-        # Set meta tags for the page.
-        #
-        # See <tt>MetaTags.set_meta_tags</tt> for details.
-        def set_meta_tags(meta_tags)
-          @meta_tags ||= {}
-          @meta_tags.merge!(meta_tags || {})
-        end
+    # Set meta tags for the page.
+    #
+    # See <tt>MetaTags.set_meta_tags</tt> for details.
+    def set_meta_tags(meta_tags)
+      @meta_tags ||= {}
+      @meta_tags.merge!(meta_tags || {})
     end
+
+    protected :set_meta_tags
   end
-end
+end

data/lib/meta_tags/view_helper.rb

@@ -1,5 +1,6 @@
-# Contains methods to use in views and helpers.
 module MetaTags
+  # Contains methods to use in views and helpers.
+  #
   module ViewHelper
     # Set meta tags for the page.
     #
@@ -7,57 +8,80 @@ module MetaTags
     # be merged. If you will set the same property several times, last one
     # will take precedence.
     #
-    # Examples:
+    # Usually you will not call this method directly. Use {#title}, {#keywords},
+    # {#description} for your daily tasks.
+    #
+    # @param [Hash] meta_tags list of meta tags. See {#display_meta_tags}
+    #   for allowed options.
+    #
+    # @example
     #   set_meta_tags :title => 'Login Page', :description => 'Here you can login'
     #   set_meta_tags :keywords => 'authorization, login'
     #
-    # Usually you will not call this method directly. Use +title+, +keywords+,
-    # +description+ for your daily tasks.
+    # @see #display_meta_tags
     #
-    # See +display_meta_tags+ for allowed options.
     def set_meta_tags(meta_tags = {})
       @meta_tags ||= {}
       @meta_tags.merge!(meta_tags || {})
     end
-  
+
     # Set the page title and return it back.
     #
     # This method is best suited for use in helpers. It sets the page title
     # and returns it (or +headline+ if specified).
     #
-    # Examples:
-    #   <%= title 'Login Page' %> => title='Login Page', return='Login Page'
-    #   <%= title 'Login Page', 'Please login' %> => title='Login Page', return='Please Login'
+    # @param [String, Array] title page title. When passed as an
+    #   +Array+, parts will be joined divided with configured
+    #   separator value (see {#display_meta_tags}).
+    # @param [String] headline the value to return from method. Useful
+    #   for using this method in views to set both page title
+    #   and the content of heading tag.
+    # @return [String] returns +title+ value or +headline+ if passed.
+    #
+    # @example Set HTML title to "Please login", return "Please login"
+    #   title 'Login Page'
+    # @example Set HTML title to "Login Page", return "Please login"
+    #   title 'Login Page', 'Please login'
+    # @example Set title as array of strings
+    #   title :title => ['part1', 'part2'] # => "part1 | part2"
+    #
+    # @see #display_meta_tags
     #
-    # You can specify +title+ as a string or array:
-    #   title :title => ['part1', 'part2']
-    #   # part1 | part2
     def title(title, headline = '')
       set_meta_tags(:title => title)
       headline.blank? ? title : headline
     end
-  
+
     # Set the page keywords.
     #
-    # Keywords can be passed as string of comma-separated values, or as an array:
+    # @param [String, Array] keywords meta keywords to render in HEAD
+    #   section of the HTML document.
+    # @return [String, Array] passed value.
+    #
+    # @example
+    #   keywords 'keyword1, keyword2'
+    #   keywords %w(keyword1 keyword2)
     #
-    #   set_meta_tags :keywords => ['tag1', 'tag2']
-    #   # tag1, tag2
+    # @see #display_meta_tags
     #
-    # Examples:
-    #   <% keywords 'keyword1, keyword2' %>
-    #   <% keywords %w(keyword1 keyword2) %>
     def keywords(keywords)
       set_meta_tags(:keywords => keywords)
       keywords
     end
-  
+
     # Set the page description.
     #
-    # Description is a string (HTML will be stripped from output string).
+    # @param [String] page description to be set in HEAD section of
+    #   the HTML document. Please note, any HTML tags will be stripped
+    #   from output string, and string will be truncated to 200
+    #   characters.
+    # @return [String] passed value.
+    #
+    # @example
+    #   description 'This is login page'
+    #
+    # @see #display_meta_tags
     #
-    # Examples:
-    #   <% description 'This is login page' %>
     def description(description)
       set_meta_tags(:description => description)
       description
@@ -65,11 +89,15 @@ module MetaTags
 
     # Set the noindex meta tag
     #
-    # You can specify noindex as a boolean or string 
+    # @param [Boolean, String] noindex a noindex value.
+    # @return [Boolean, String] passed value.
+    #
+    # @example
+    #   noindex true
+    #   noindex 'googlebot'
+    #
+    # @see #display_meta_tags
     #
-    # Examples:
-    #   <% noindex true %>
-    #   <% noindex 'googlebot' %>
     def noindex(noindex)
       set_meta_tags(:noindex => noindex)
       noindex
@@ -77,123 +105,121 @@ module MetaTags
 
     # Set the nofollow meta tag
     #
-    # You can specify nofollow as a boolean or string 
+    # @param [Boolean, String] nofollow a nofollow value.
+    # @return [Boolean, String] passed value.
+    #
+    # @example
+    #   nofollow true
+    #   nofollow 'googlebot'
+    #
+    # @see #display_meta_tags
     #
-    # Examples:
-    #   <% nofollow true %>
-    #   <% nofollow 'googlebot' %>
     def nofollow(nofollow)
       set_meta_tags(:nofollow => nofollow)
       nofollow
     end
-  
-    # Set default meta tag values and display meta tags.
-    #
-    # This method should be used in layout file.
-    #
-    # Examples:
+
+    # Set default meta tag values and display meta tags. This method
+    # should be used in layout file.
+    #
+    # @param [Hash] default default meta tag values.
+    # @option default [String] :site (nil) site title;
+    # @option default [String] :title ("") page title;
+    # @option default [String] :description (nil) page description;
+    # @option default [String] :keywords (nil) page keywords;
+    # @option default [String, Boolean] :prefix (" ") text between site name and separator; when +false+, no prefix will be rendered;
+    # @option default [String] :separator ("|") text used to separate website name from page title;
+    # @option default [String, Boolean] :suffix (" ") text between separator and page title; when +false+, no suffix will be rendered;
+    # @option default [Boolean] :lowercase (false) when true, the page name will be lowercase;
+    # @option default [Boolean] :reverse (false) when true, the page and site names will be reversed;
+    # @option default [Boolean, String] :noindex (false) add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
+    # @option default [Boolean, String] :nofollow (false) add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
+    # @option default [String] :canonical (nil) add canonical link tag.
+    # @return [String] HTML meta tags to render in HEAD section of the
+    #   HTML document.
+    #
+    # @example
     #   <head>
     #     <%= display_meta_tags :site => 'My website' %>
     #   </head>
     #
-    # Allowed options:
-    # * <tt>:site</tt> -- site title;
-    # * <tt>:title</tt> -- page title;
-    # * <tt>:description</tt> -- page description;
-    # * <tt>:keywords</tt> -- page keywords;
-    # * <tt>:prefix</tt> -- text between site name and separator;
-    # * <tt>:separator</tt> -- text used to separate website name from page title;
-    # * <tt>:suffix</tt> -- text between separator and page title;
-    # * <tt>:lowercase</tt> -- when true, the page name will be lowercase;
-    # * <tt>:reverse</tt> -- when true, the page and site names will be reversed;
-    # * <tt>:noindex</tt> -- add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
-    # * <tt>:nofollow</tt> -- add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
-    # * <tt>:canonical</tt> -- add canonical link tag.
     def display_meta_tags(default = {})
       meta_tags = (default || {}).merge(@meta_tags || {})
 
       # Prefix (leading space)
-      if meta_tags[:prefix]
-        prefix = meta_tags[:prefix]
-      elsif meta_tags[:prefix] === false
-        prefix = ''
-      else
-        prefix = ' '
-      end
-    
+      prefix = meta_tags[:prefix] === false ? '' : (meta_tags[:prefix] || ' ')
+
       # Separator
-      unless meta_tags[:separator].blank?
-        separator = meta_tags[:separator]
-      else
-        separator = '|'
-      end
-    
+      separator = meta_tags[:separator].blank? ? '|' : meta_tags[:separator]
+
       # Suffix (trailing space)
-      if meta_tags[:suffix]
-        suffix = meta_tags[:suffix]
-      elsif meta_tags[:suffix] === false
-        suffix = ''
-      else
-        suffix = ' '
-      end
-    
+      suffix = meta_tags[:suffix] === false ? '' : (meta_tags[:suffix] || ' ')
+
       # Title
       title = meta_tags[:title]
-      if meta_tags[:lowercase] === true
-        title = title.downcase unless title.blank?
+      if meta_tags[:lowercase] === true and !title.blank?
+        title = if title.is_a?(Array)
+          title.map { |t| t.downcase }
+        else
+          title.downcase
+        end
       end
-    
+
+      result = []
+
       # title
       if title.blank?
-        result = content_tag :title, meta_tags[:site]
+        result << content_tag(:title, meta_tags[:site])
       else
         title = normalize_title(title)
         title = [meta_tags[:site]] + title
         title.reverse! if meta_tags[:reverse] === true
         sep = prefix + separator + suffix
-        result = content_tag(:title, title.join(sep))
+        result << content_tag(:title, title.join(sep))
       end
 
       # description
       description = normalize_description(meta_tags[:description])
-      result << "\n" + tag(:meta, :name => :description, :content => description) unless description.blank?
-    
+      result << tag(:meta, :name => :description, :content => description) unless description.blank?
+
       # keywords
       keywords = normalize_keywords(meta_tags[:keywords])
-      result << "\n" + tag(:meta, :name => :keywords, :content => keywords) unless keywords.blank?
+      result << tag(:meta, :name => :keywords, :content => keywords) unless keywords.blank?
 
       # noindex & nofollow
       noindex_name = meta_tags[:noindex].is_a?(String) ? meta_tags[:noindex] : 'robots'
       nofollow_name = meta_tags[:nofollow].is_a?(String) ? meta_tags[:nofollow] : 'robots'
-  
+
       if noindex_name == nofollow_name
         content = [(meta_tags[:noindex] ? 'noindex' : nil), (meta_tags[:nofollow] ? 'nofollow' : nil)].compact.join(', ')
-        result << "\n" + tag(:meta, :name => noindex_name, :content => content) unless content.blank?
+        result << tag(:meta, :name => noindex_name, :content => content) unless content.blank?
       else
-        result << "\n" + tag(:meta, :name => noindex_name, :content => 'noindex') if meta_tags[:noindex]
-        result << "\n" + tag(:meta, :name => nofollow_name, :content => 'nofollow') if meta_tags[:nofollow]
+        result << tag(:meta, :name => noindex_name, :content => 'noindex') if meta_tags[:noindex]
+        result << tag(:meta, :name => nofollow_name, :content => 'nofollow') if meta_tags[:nofollow]
       end
 
       # canonical
-      result << "\n" + tag(:link, :rel => :canonical, :href => meta_tags[:canonical]) unless meta_tags[:canonical].blank?
+      result << tag(:link, :rel => :canonical, :href => meta_tags[:canonical]) unless meta_tags[:canonical].blank?
 
-      return result
+      result = result.join("\n")
+      result.html_safe! if result.respond_to?(:html_safe!)
+      result
     end
-  
+
     private
-  
+
       def normalize_title(title)
         if title.is_a? String
           title = [title]
         end
         title.map { |t| h(strip_tags(t)) }
       end
-    
+
       def normalize_description(description)
         return '' unless description
         truncate(strip_tags(description).gsub(/\s+/, ' '), :length => 200)
       end
-    
+
       def normalize_keywords(keywords)
         return '' unless keywords
         keywords = keywords.flatten.join(', ') if keywords.is_a?(Array)

data/meta-tags.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{meta-tags}
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dmytro Shteflyuk"]
-  s.date = %q{2009-11-21}
+  s.date = %q{2010-05-31}
   s.description = %q{Search Engine Optimization (SEO) plugin for Ruby on Rails applications.}
   s.email = %q{kpumuk@kpumuk.info}
   s.extra_rdoc_files = [
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/kpumuk/meta-tags}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Collection of SEO helpers for Ruby on Rails}
   s.test_files = [
     "spec/meta_tags_spec.rb",
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/meta_tags_spec.rb

@@ -135,6 +135,10 @@ describe MetaTags::ViewHelper do
       @view.display_meta_tags(:site => 'someSite', :title => ['someTitle', 'anotherTitle']).should == '<title>someSite | someTitle | anotherTitle</title>'
     end
 
+    it 'shold allow Arrays in title with :lowercase' do
+      @view.display_meta_tags(:site => 'someSite', :title => ['someTitle', 'anotherTitle'], :lowercase => true).should == '<title>someSite | sometitle | anothertitle</title>'
+    end
+
     it 'shold build title in reverse order if :reverse' do
       @view.display_meta_tags(:site => 'someSite',
                               :title => ['someTitle', 'anotherTitle'],

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: meta-tags
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 +02:00
+date: 2010-05-31 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -44,21 +50,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Collection of SEO helpers for Ruby on Rails