meta-tags 1.2.6 → 1.3.0

data/.travis.yml

@@ -2,7 +2,6 @@ rvm:
   - 1.8.7
   - 1.9.2
   - ree
-  - jruby
 
 notifications:
   recipients:

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 1.3.0 (February 13, 2013)
+
+Features:
+
+  - Added Hash and Array as possible contents for the meta tags. Check README for details
+  - Added support of string meta tag names
+  - Allow to disable noindex and nofollow using `false` as a value
+
+Bugfixes:
+
+  - Do not display title HTML tag when title is blank
+  - Do not display OpenGraph tags when content is empty
+
 ## 1.2.6 (March 4, 2012)
 
 Features:

data/README.md

@@ -105,6 +105,29 @@ 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)
 
+### Hashes
+
+Any namespace can be built just passing any symbol name and a Hash. For example:
+
+    set_meta_tags :foo => {
+      :bar => "lorem",
+      :baz => {
+        :qux => "ipsum"
+      }
+    }
+    # <meta property="foo:bar" content="lorem"/>
+    # <meta property="foo:baz:qux" content="ipsum"/>
+
+### Arrays
+
+Repeated meta tags can be built just using an Array inside a Hash. For example:
+
+    set_meta_tags :og => {
+        :image = ["http://example.com/rock.jpg", "http://example.com/rock2.jpg"]
+    }
+    #<meta property="og:image" content="http://example.com/rock.jpg" />
+    #<meta property="og:image" content="http://example.com/rock2.jpg" />
+
 ### Open Graph
 
 To turn your web pages into graph objects, you'll need to add Open Graph
@@ -112,21 +135,47 @@ 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'
+    set_meta_tags :og => {
+      :title    => 'The Rock',
+      :type     => 'video.movie',
+      :url      => 'http://www.imdb.com/title/tt0117500/',
+      :image    => 'http://ia.media-imdb.com/rock.jpg',
+      :video    => {
+        :director => 'http://www.imdb.com/name/nm0000881/',
+        :writer   => ['http://www.imdb.com/name/nm0918711/', 'http://www.imdb.com/name/nm0177018/']
+      }
     }
     # <meta property="og:title" content="The Rock"/>
-    # <meta property="og:type" content="movie"/>
+    # <meta property="og:type" content="video.movie"/>
     # <meta property="og:url" content="http://www.imdb.com/title/tt0117500/"/>
     # <meta property="og:image" content="http://ia.media-imdb.com/rock.jpg"/>
+    # <meta property="og:video:director" content="http://www.imdb.com/name/nm0000881/"/>
+    # <meta property="og:video:writer" content="http://www.imdb.com/name/nm0918711/"/>
+    # <meta property="og:video:writer" content="http://www.imdb.com/name/nm0177018/"/>
 
 Further reading:
 
 * [Open Graph protocol](http://developers.facebook.com/docs/opengraph/)
 
+### Twitter Cards
+
+Twitter cards make it possible for you to attach media experiences to Tweets that link to your content.
+There are 3 card types (summary, photo and player). Here's an example for summary:
+
+    set_meta_tags :twitter => {
+      :card => "summary",
+      :site => "@username"
+    }
+    # <meta property="twitter:card" content="summary"/>
+    # <meta property="twitter:site" content="@username"/>
+
+Take in consideration that if you're already using OpenGraph to describe data on your page, it’s easy to generate a Twitter card without duplicating your tags and data. When the Twitter card processor looks for tags on your page, it first checks for the Twitter property, and if not present, falls back to the supported Open Graph property. This allows for both to be defined on the page independently, and minimizes the amount of duplicate markup required to describe your content and experience.
+
+Further reading:
+
+* [Twitter Cards Documentation](https://dev.twitter.com/docs/cards/)
+
+
 ## MetaTags Usage
 
 First, add this code to your main layout:
@@ -205,7 +254,8 @@ Use these options to customize the title format:
 * `: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).
+* `:og` — add Open Graph tags (Hash).
+* `:twitter` — add Twitter tags (Hash).
 
 And here are a few examples to give you ideas.
 
@@ -213,7 +263,7 @@ And here are a few examples to give you ideas.
     <%= 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' } %>
+    <%= display_meta_tags :og => { :title => 'The Rock', :type => 'video.movie' } %>
 
 ### Allowed values
 
@@ -281,3 +331,4 @@ There are several plugins influenced me to create this one:
 * Kristoffer Renholm (contributor)
 * [Jürg Lehni](https://github.com/lehni) (contributor)
 * [Tom Coleman](https://github.com/tmeasday) (contributor)
+* [Guille Lopez](https://github.com/guillelopez) (contributor)

data/lib/meta_tags/controller_helper.rb

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

data/lib/meta_tags/version.rb

@@ -1,3 +1,3 @@
 module MetaTags
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
 end

data/lib/meta_tags/view_helper.rb

@@ -4,7 +4,7 @@ module MetaTags
   module ViewHelper
     # Get meta tags for the page.
     def meta_tags
-      @meta_tags ||= {}
+      @meta_tags ||= HashWithIndifferentAccess.new
     end
 
     # Set meta tags for the page.
@@ -157,7 +157,8 @@ module MetaTags
       result = []
 
       # title
-      result << content_tag(:title, build_full_title(meta_tags))
+      title = build_full_title(meta_tags)
+      result << content_tag(:title, title) unless title.blank?
 
       # description
       description = normalize_description(meta_tags[:description])
@@ -175,13 +176,15 @@ module MetaTags
         content = [meta_tags[:noindex] && 'noindex', meta_tags[:nofollow] && 'nofollow'].compact.join(', ')
         result << tag(:meta, :name => noindex_name, :content => content) unless content.blank?
       else
-        result << tag(:meta, :name => noindex_name,  :content => 'noindex')  if meta_tags[:noindex]
-        result << tag(:meta, :name => nofollow_name, :content => 'nofollow') if meta_tags[:nofollow]
+        result << tag(:meta, :name => noindex_name,  :content => 'noindex')  if meta_tags[:noindex] && meta_tags[:noindex] != false
+        result << tag(:meta, :name => nofollow_name, :content => 'nofollow') if meta_tags[:nofollow] && meta_tags[:nofollow] != false
       end
 
-      # Open Graph
-      (meta_tags[:open_graph] || {}).each do |property, content|
-        result << tag(:meta, :property => "og:#{property}", :content => content)
+      # hashes
+      meta_tags.each do |property, content|
+        if content.is_a?(Hash)
+          result.concat process_tree(property, content)
+        end
       end
 
       # canonical
@@ -191,6 +194,21 @@ module MetaTags
       result.respond_to?(:html_safe) ? result.html_safe : result
     end
 
+    # Recursive function to process all the hashes and arrays on meta tags
+    def process_tree(property, content)
+      result = []
+      if content.is_a?(Hash)
+        content.each do |key, value|
+          result.concat process_tree("#{property}:#{key}", value)
+        end
+      else
+        Array(content).each do |c|
+          result << tag(:meta, :property => "#{property}", :content => c) unless c.blank?
+        end
+      end
+      result
+    end
+
     # Returns full page title as a string without surrounding <title> tag.
     #
     # The only case when you may need this helper is when you use pjax. This means
@@ -237,8 +255,8 @@ module MetaTags
       end
 
       def normalize_open_graph(meta_tags)
-        meta_tags ||= {}
-        meta_tags[:open_graph] = meta_tags.delete(:og) if meta_tags.key?(:og)
+        meta_tags = (meta_tags || {}).with_indifferent_access
+        meta_tags[:og] = meta_tags.delete(:open_graph) if meta_tags.key?(:open_graph)
         meta_tags
       end
 

data/spec/controller_helper_spec.rb

@@ -34,7 +34,7 @@ describe MetaTags::ControllerHelper do
     it 'should set meta tags from instance variables' do
       subject.index
       subject.rendered.should be_true
-      subject.meta_tags.should == { :title => 'title', :keywords => 'key1, key2, key3', :description => 'description' }
+      subject.meta_tags.should == { 'title' => 'title', 'keywords' => 'key1, key2, key3', 'description' => 'description' }
     end
   end
 

data/spec/meta_tags_spec.rb

@@ -73,6 +73,12 @@ describe MetaTags::ViewHelper do
   end
 
   context 'displaying title' do
+    it 'should not display title if blank' do
+      subject.display_meta_tags.should == ''
+      subject.title('')
+      subject.display_meta_tags.should == ''
+    end
+
     it 'should use website name if title is empty' do
       subject.display_meta_tags(:site => 'someSite').should == '<title>someSite</title>'
     end
@@ -164,6 +170,11 @@ describe MetaTags::ViewHelper do
   end
 
   context 'displaying description' do
+    it 'should not display description if blank' do
+      subject.description('')
+      subject.display_meta_tags.should == ''
+    end
+
     it 'should display description when "description" used' do
       subject.description('someDescription')
       subject.display_meta_tags(:site => 'someSite').should include('<meta content="someDescription" name="description" />')
@@ -197,6 +208,14 @@ describe MetaTags::ViewHelper do
   end
 
   context 'displaying keywords' do
+    it 'should not display keywords if blank' do
+      subject.keywords('')
+      subject.display_meta_tags.should == ''
+
+      subject.keywords([])
+      subject.display_meta_tags.should == ''
+    end
+
     it 'should display keywords when "keywords" used' do
       subject.keywords('some-keywords')
       subject.display_meta_tags(:site => 'someSite').should include('<meta content="some-keywords" name="keywords" />')
@@ -248,6 +267,12 @@ describe MetaTags::ViewHelper do
     it 'should display nothing by default' do
       subject.display_meta_tags(:site => 'someSite').should_not include('<meta content="noindex"')
     end
+
+    it "should display nothing if given false" do
+      subject.set_meta_tags(:noindex => false)
+      subject.display_meta_tags(:site => 'someSite').should_not include('<meta content="robots"')
+      subject.display_meta_tags(:site => 'someSite').should_not include('<meta content="noindex"')
+    end
   end
 
   context 'displaying nofollow' do
@@ -337,6 +362,20 @@ describe MetaTags::ViewHelper do
       end
     end
 
+    it 'should display meta tags with hashes and arrays' do
+      subject.set_meta_tags(:foo => {
+        :bar => "lorem",
+        :baz => {
+          :qux => ["lorem", "ipsum"]
+        }
+      })
+      subject.display_meta_tags(:site => 'someSite').tap do |content|
+        content.should include('<meta content="lorem" property="foo:bar" />')
+        content.should include('<meta content="lorem" property="foo:baz:qux" />')
+        content.should include('<meta content="ipsum" property="foo:baz:qux" />')
+      end
+    end
+
     it 'should use deep merge when displaying open graph meta tags' do
       subject.set_meta_tags(:og => { :title => 'Facebook Share Title' })
       subject.display_meta_tags(:og => { :description => 'Facebook Share Description' }).tap do |content|
@@ -344,6 +383,34 @@ describe MetaTags::ViewHelper do
         content.should include('<meta content="Facebook Share Description" property="og:description" />')
       end
     end
+
+    it "should not display meta tags without content" do
+      subject.set_meta_tags(:open_graph => {
+        :title       => '',
+        :description => ''
+      })
+      subject.display_meta_tags(:site => 'someSite').tap do |content|
+        content.should_not include('<meta content="" property="og:title" />')
+        content.should_not include('<meta content="" property="og:description" />')
+      end
+    end
+  end
+
+  context 'while handling string meta tag names' do
+    it 'should work with common parameters' do
+      subject.display_meta_tags('site' => 'someSite', 'title' => 'someTitle').should == '<title>someSite | someTitle</title>'
+    end
+
+    it 'should work with open graph parameters' do
+      subject.set_meta_tags('og' => {
+        'title'       => 'facebook title',
+        'description' => 'facebook description'
+      })
+      subject.display_meta_tags(:site => 'someSite').tap do |content|
+        content.should include('<meta content="facebook title" property="og:title" />')
+        content.should include('<meta content="facebook description" property="og:description" />')
+      end
+    end
   end
 
   context '.display_title' do

data/spec/spec_helper.rb

@@ -11,15 +11,18 @@ shared_examples_for '.set_meta_tags' do
   end
 
   it 'should use deep merge when updating meta tags' do
-    subject.set_meta_tags(:open_graph => { :title => 'hello' })
-    subject.meta_tags[:open_graph].should == { :title => 'hello' }
+    subject.set_meta_tags(:og => { :title => 'hello' })
+    subject.meta_tags[:og].should == { 'title' => 'hello' }
+
+    subject.set_meta_tags(:og => { :description => 'world' })
+    subject.meta_tags[:og].should == { 'title' => 'hello', 'description' => 'world' }
 
-    subject.set_meta_tags(:open_graph => { :description => 'world' })
-    subject.meta_tags[:open_graph].should == { :title => 'hello', :description => 'world' }
+    subject.set_meta_tags(:og => { :admin => { :id => 1 } } )
+    subject.meta_tags[:og].should == { 'title' => 'hello', 'description' => 'world', 'admin' => { 'id' => 1 } }
   end
 
-  it 'should normalize :og to :open_graph' do
-    subject.set_meta_tags(:og => { :title => 'hello' })
-    subject.meta_tags[:open_graph].should == { :title => 'hello' }
+  it 'should normalize :open_graph to :og' do
+    subject.set_meta_tags(:open_graph => { :title => 'hello' })
+    subject.meta_tags[:og].should == { 'title' => 'hello' }
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: meta-tags
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 6
-  version: 1.2.6
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-04 00:00:00 Z
+date: 2013-02-13 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack
@@ -113,6 +114,7 @@ files:
 - spec/controller_helper_spec.rb
 - spec/meta_tags_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/kpumuk/meta-tags
 licenses: []
 
@@ -142,10 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Collection of SEO helpers for Ruby on Rails.
 test_files: []
 
-has_rdoc: