meta-tags 1.2.4 → 1.2.5

data/.gitignore

@@ -2,5 +2,6 @@
 .DS_Store
 .bundle
 .rvmrc
+Gemfile.lock
 doc
 pkg

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby
+
+notifications:
+  recipients:
+    - kpumuk@kpumuk.info

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+## 1.2.4 (April 26, 2011)
+
+Features:
+
+  - Added support for Open Graph meta tags
+
+Bugfixes:
+
+  - Fixed bug with double HTML escaping in title separator
+  - Allow to set meta title without a separator
+
+## 1.2.2, 1.2.3 (June 10, 2010)
+
+Bugfixes:
+
+  - Fixed action\_pack integration (welcome back `alias_method_chain`)
+  - Fixed bug when `@page_*` variables did not work
+
+## 1.2.1 (June 2, 2010)
+
+Bugfixes:
+
+  - Fixed deprecation warning about `html_safe!`
+
+## 1.2.0 (May 31, 2010)
+
+Bugfixes:
+
+  - Fixed bug when title is set through Array, and `:lowercase` is true
+  - Updated `display_meta_tags` to be compatible with rails_xss
+
+## 1.1.1 (November 21, 2009)
+
+Features:
+
+  - Added support for canonical link element
+  - Added YARD documentation
+
+## 1.1.0 (November 5, 2009)
+
+Features:
+
+  - Added ability to specify title as an Array of parts
+  - Added helper for `noindex`
+  - Added `nofollow` meta tag support
+
+Bugfixes:
+
+  - Fixed Rails 2.3 deprecation warnings

data/MIT-LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2008 Dmytro Shteflyuk
+Copyright (c) 2011 Dmytro Shteflyuk
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+# MetaTags: a gem to make your Rails application SEO-friendly
+
+[![Travis-CI build status](https://secure.travis-ci.org/kpumuk/meta-tags.png)](http://travis-ci.org/kpumuk/meta-tags)
+
+Search Engine Optimization (SEO) plugin for Ruby on Rails applications.
+
+## Rails 3
+
+MetaTags master branch now fully supports Rails 3 and is backward
+compatible.
+
+## Installation
+
+Add the "meta-tags" gem to your `Gemfile`.
+
+    gem 'meta-tags', :require => 'meta_tags'
+
+And run `bundle install` command.
+
+## SEO Basics and MetaTags
+
+### Titles
+
+Page titles are very important for Search engines. The titles in the
+browser are displayed in the title bar. The search engines would look at
+the this title bar to determine what the page is all about.
+
+    set_meta_tags :title => 'Member Login'
+    # <title>Some Page Title</title>
+    set_meta_tags :site => 'Site Title', :title => 'Member Login'
+    # <title>Site Title | Page Title</title>
+    set_meta_tags :site => 'Site Title', :title => 'Member Login', :reverse => true
+    # <title>Page Title | Site Title</title>
+
+Recommended title tag length: up to <b>70 characters</b>, <b>10 words</b>.
+
+### Description
+
+Description tags are called meta tags as they are not displayed by the
+browsers as that of titles. But these descriptions may be displayed by
+some search engines. They are used to describe the contents of a page in
+2 or 3 sentences.
+
+    set_meta_tags :description => "All text about keywords, other keywords"
+    # <meta name="description" content="All text about keywords, other keywords" />
+
+Recommended description tag length: up to <b>160 characters</b>.
+
+### Keywords
+
+Meta keywords tag are used to place your keywords that you think a
+surfer would search in Search engines. Repeating keywords unnecessarily
+would be considered spam and you may get permanently banned from SERP's
+
+    set_meta_tags :keywords => %w[keyword1 Keyword2 KeyWord3]
+    # <meta name="keywords" content="keyword1, keyword2, keyword3" />
+
+Recommended keywords tag length: up to <b>255 characters</b>, <b>20 words</b>.
+
+### Noindex
+
+By using the noindex meta tag, you can signal to search engines to not
+include specific pages in their indexes.
+
+    set_meta_tags :noindex => true
+    # <meta name="robots" content="noindex" />
+    set_meta_tags :noindex => 'googlebot'
+    # <meta name="googlebot" content="noindex" />
+
+This is useful for pages like login, password reset, privacy policy, etc.
+
+Further reading:
+
+* [Blocking Google](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=93708)
+* [Using meta tags to block access to your site](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=93710)
+
+### Nofollow
+
+Nofollow meta tag tells a search engine not to follow the links on a specific
+page. It's entirely likely that a robot might find the same links on some
+other page without a nofollow (perhaps on some other site), and so
+still arrives at your undesired page.
+
+    set_meta_tags :nofollow => true
+    # <meta name="robots" content="nofollow" />
+    set_meta_tags :nofollow => 'googlebot'
+    # <meta name="googlebot" content="nofollow" />
+
+Further reading:
+
+* [About rel="nofollow"](http://www.google.com/support/webmasters/bin/answer.py?answer=96569)
+* [Meta tags](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=79812)
+
+### Canonical URL
+
+Canonical link element tells a search engine what is the canonical or main URL
+for a content which have multiple URLs. The search engine will always return
+that URL, and link popularity and authority will be applied to that URL.
+
+    set_meta_tags :canonical => "http://yoursite.com/canonical/url"
+    # <link rel="canonical" href="http://yoursite.com/canonical/url" />
+
+Further reading:
+
+* [About rel="canonical"](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=139394)
+* [Canonicalization](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=139066)
+
+### Open Graph
+
+To turn your web pages into graph objects, you'll need to add Open Graph
+protocol `<meta>` tags to your webpages. The tags allow you to specify
+structured information about your web pages. The more information you provide, the more opportunities your web pages can be surfaced within Facebook today
+and in the future. Here's an example for a movie page:
+
+    set_meta_tags :open_graph => {
+      :title => 'The Rock',
+      :type  => :movie,
+      :url   => 'http://www.imdb.com/title/tt0117500/',
+      :image => 'http://ia.media-imdb.com/rock.jpg'
+    }
+    # <meta property="og:title" content="The Rock"/>
+    # <meta property="og:type" content="movie"/>
+    # <meta property="og:url" content="http://www.imdb.com/title/tt0117500/"/>
+    # <meta property="og:image" content="http://ia.media-imdb.com/rock.jpg"/>
+
+Further reading:
+
+* [Open Graph protocol](http://developers.facebook.com/docs/opengraph/)
+
+## MetaTags Usage
+
+First, add this code to your main layout:
+
+    <head>
+      <%= display_meta_tags :site => 'My website' %>
+    </head>
+
+Then, to set the page title, add this to each of your views (see below for other options):
+
+    <h1><%= title 'My page title' %></h1>
+
+When views are rendered, the page title will be included in the right spots:
+
+    <head>
+      <title>My website | My page title</title>
+    </head>
+    <body>
+      <h1>My page title</h1>
+    </body>
+
+You can find allowed options for `display_meta_tags` method below.
+
+### Using MetaTags in controller
+
+You can define following instance variables:
+
+    @page_title       = 'Member Login'
+    @page_description = 'Member login page.'
+    @page_keywords    = 'Site, Login, Members'
+
+Also you could use `set_meta_tags` method to define all meta tags simultaneously:
+
+    set_meta_tags :title => 'Member Login',
+                  :description => 'Member login page.',
+                  :keywords => 'Site, Login, Members'
+
+You can find allowed options for `set_meta_tags` method below.
+
+### Using MetaTags in view
+
+To set meta tags you can use following methods:
+
+    <% title 'Member Login' %>
+    <% description 'Member login page.' %>
+    <% keywords 'Member login page.' %>
+
+Also there is `set_meta_tags` method exists:
+
+    <% set_meta_tags :title => 'Member Login',
+                     :description => 'Member login page.',
+                     :keywords => 'Site, Login, Members' %>
+
+The `title` method returns title itself, so you can use it to show the title
+somewhere on the page:
+
+    <h1><%= title 'Member Login' %></h1>
+
+If you want to set the title and display another text, use this:
+
+    <h1><%= title 'Member Login', 'Here you can login to the site:' %></h1>
+
+### Allowed options for `display_meta_tags` and `set_meta_tags` methods
+
+Use these options to customize the title format:
+
+* `:site` — site title;
+* `:title` — page title;
+* `:description` — page description;
+* `:keywords` — page keywords;
+* `:prefix` — text between site name and separator;
+* `:separator` — text used to separate website name from page title;
+* `:suffix` — text between separator and page title;
+* `:lowercase` — when true, the page name will be lowercase;
+* `:reverse` — when true, the page and site names will be reversed;
+* `:noindex` — add noindex meta tag; when true, 'robots' will be used, otherwise the string will be used;
+* `:nofollow` — add nofollow meta tag; when true, 'robots' will be used, otherwise the string will be used;
+* `:canonical` — add canonical link tag;
+* `:open_graph` — add Open Graph tags (Hash).
+
+And here are a few examples to give you ideas.
+
+    <%= display_meta_tags :separator => "&mdash;".html_safe %>
+    <%= display_meta_tags :prefix => false, :separator => ":" %>
+    <%= display_meta_tags :lowercase => true %>
+    <%= display_meta_tags :reverse => true, :prefix => false %>
+    <%= display_meta_tags :open_graph => { :title => 'The Rock', :type => 'movie' } %>
+
+### Allowed values
+
+You can specify `:title` as a string or array:
+
+    set_meta_tags :title => ['part1', 'part2'], :site => 'site'
+    # site | part1 | part2
+    set_meta_tags :title => ['part1', 'part2'], :reverse => true, :site => 'site'
+    # part2 | part1 | site
+
+Keywords can be passed as string of comma-separated values, or as an array:
+
+    set_meta_tags :keywords => ['tag1', 'tag2']
+    # tag1, tag2
+
+Description is a string (HTML will be stripped from output string).
+
+## Alternatives
+
+There are several plugins influenced me to create this one:
+
+* [Headliner](https://github.com/mokolabs/headliner)
+* [meta\_on_rals](https://github.com/ashchan/meta_on_rails)
+
+## Credits
+
+* [Dmytro Shteflyuk](https://github.com/kpumuk) (author)
+* [Morgan Roderick](https://github.com/mroderick) (contributor)
+* [Jesse Clark](https://github.com/jesseclark) (contributor)
+* Sergio Cambra (contributor)
+* Kristoffer Renholm (contributor)
+* [Jürg Lehni](https://github.com/lehni) (contributor)

data/Rakefile

@@ -1,16 +1,18 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new(:yard) do |t|
-    t.options = ['--title', 'MetaTags Documentation']
-    if ENV['PRIVATE']
-      t.options.concat ['--protected', '--private']
-    else
-      t.options.concat ['--protected', '--no-private']
-    end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.options = ['--title', 'MetaTags Documentation']
+  if ENV['PRIVATE']
+    t.options.concat ['--protected', '--private']
+  else
+    t.options.concat ['--protected', '--no-private']
   end
-rescue LoadError
-  puts 'Yard not available. Install it with: sudo gem install yard'
 end

data/lib/meta_tags/controller_helper.rb

@@ -32,10 +32,17 @@ module MetaTags
       #
       # See <tt>MetaTags.set_meta_tags</tt> for details.
       def set_meta_tags(meta_tags)
-        @meta_tags ||= {}
-        @meta_tags.merge!(meta_tags || {})
+        meta_tags ||= {}
+        meta_tags[:open_graph] = meta_tags.delete(:og) if meta_tags.key?(:og)
+        self.meta_tags.deep_merge!(meta_tags || {})
       end
       protected :set_meta_tags
+
+      # Get meta tags for the page.
+      def meta_tags
+        @meta_tags ||= {}
+      end
+      protected :meta_tags
     end
   end
 end

data/lib/meta_tags/version.rb

@@ -1,3 +1,3 @@
 module MetaTags
-  VERSION = '1.2.4'
+  VERSION = '1.2.5'
 end

data/lib/meta_tags/view_helper.rb

@@ -2,6 +2,11 @@ module MetaTags
   # Contains methods to use in views and helpers.
   #
   module ViewHelper
+    # Get meta tags for the page.
+    def meta_tags
+      @meta_tags ||= {}
+    end
+
     # Set meta tags for the page.
     #
     # Method could be used several times, and all options passed will
@@ -21,8 +26,7 @@ module MetaTags
     # @see #display_meta_tags
     #
     def set_meta_tags(meta_tags = {})
-      @meta_tags ||= {}
-      @meta_tags.merge!(meta_tags || {})
+      self.meta_tags.deep_merge! normalize_open_graph(meta_tags)
     end
 
     # Set the page title and return it back.
@@ -145,42 +149,12 @@ module MetaTags
     #   </head>
     #
     def display_meta_tags(default = {})
-      meta_tags = (default || {}).merge(@meta_tags || {})
-
-      # Prefix (leading space)
-      prefix = meta_tags[:prefix] === false ? '' : (meta_tags[:prefix] || ' ')
-
-      # Separator
-      separator = meta_tags[:separator] === false ? '' : (meta_tags[:separator] || '|')
-
-      # Suffix (trailing space)
-      suffix = meta_tags[:suffix] === false ? '' : (meta_tags[:suffix] || ' ')
-
-      # Special case: if separator is hidden, do not display suffix/prefix
-      if meta_tags[:separator] == false
-        prefix = suffix = ''
-      end
-
-      # Title
-      title = meta_tags[:title]
-      if meta_tags[:lowercase] === true and !title.blank?
-        title = Array(title).map { |t| t.downcase }
-      end
+      meta_tags = normalize_open_graph(default).deep_merge!(self.meta_tags)
 
       result = []
 
       # title
-      if title.blank?
-        result << content_tag(:title, meta_tags[:site])
-      else
-        title = normalize_title(title).unshift(h(meta_tags[:site]))
-        title.reverse! if meta_tags[:reverse] === true
-        sep = h(prefix) + h(separator) + h(suffix)
-        title = title.join(sep)
-        # We escaped every chunk of the title, so the whole title should be HTML safe
-        title = title.html_safe if title.respond_to?(:html_safe)
-        result << content_tag(:title, title)
-      end
+      result << content_tag(:title, build_full_title(meta_tags))
 
       # description
       description = normalize_description(meta_tags[:description])
@@ -203,8 +177,7 @@ module MetaTags
       end
 
       # Open Graph
-      open_graph = meta_tags[:open_graph] || meta_tags[:og] || {}
-      open_graph.each do |property, content|
+      (meta_tags[:open_graph] || {}).each do |property, content|
         result << tag(:meta, :property => "og:#{property}", :content => content)
       end
 
@@ -226,14 +199,56 @@ module MetaTags
       end
 
       def normalize_description(description)
-        return '' unless description
+        return '' if description.blank?
         truncate(strip_tags(description).gsub(/\s+/, ' '), :length => 200)
       end
 
       def normalize_keywords(keywords)
-        return '' unless keywords
+        return '' if keywords.blank?
         keywords = keywords.flatten.join(', ') if Array === keywords
         strip_tags(keywords).mb_chars.downcase
       end
+
+      def normalize_open_graph(meta_tags)
+        meta_tags ||= {}
+        meta_tags[:open_graph] = meta_tags.delete(:og) if meta_tags.key?(:og)
+        meta_tags
+      end
+
+      def build_full_title(meta_tags)
+        # Prefix (leading space)
+        prefix = meta_tags[:prefix] === false ? '' : (meta_tags[:prefix] || ' ')
+
+        # Separator
+        separator = meta_tags[:separator] === false ? '' : (meta_tags[:separator] || '|')
+
+        # Suffix (trailing space)
+        suffix = meta_tags[:suffix] === false ? '' : (meta_tags[:suffix] || ' ')
+
+        # Special case: if separator is hidden, do not display suffix/prefix
+        if meta_tags[:separator] == false
+          prefix = suffix = ''
+        end
+
+        # Title
+        title = meta_tags[:title]
+        if meta_tags[:lowercase] === true and !title.blank?
+          title = Array(title).map { |t| t.downcase }
+        end
+
+        # title
+        if title.blank?
+          meta_tags[:site]
+        else
+          title = normalize_title(title)
+          title.unshift(h(meta_tags[:site])) unless meta_tags[:site].blank?
+          title.reverse! if meta_tags[:reverse] === true
+          sep = h(prefix) + h(separator) + h(suffix)
+          title = title.join(sep)
+          # We escaped every chunk of the title, so the whole title should be HTML safe
+          title = title.html_safe if title.respond_to?(:html_safe)
+          title
+        end
+      end
   end
 end