meta-tags 1.4.1 → 1.5.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.5.0 (May 7, 2013)
+
+Features:
+
+  - Added "prev" and "next" links support
+  - Added refresh meta tag support
+
 ## 1.4.1 (March 14, 2013)
 
 Bugfixes:

data/README.md

@@ -105,6 +105,41 @@ 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)
 
+### Pagination links
+
+Previous and next links indicate indicate the relationship between individual
+URLs. Using these attributes is a strong hint to Google that you want us to
+treat these pages as a logical sequence.
+
+    set_meta_tags :prev => "http://yoursite.com/url?page=1"
+    # <link rel="prev" href="http://yoursite.com/url?page=1" />
+    set_meta_tags :next => "http://yoursite.com/url?page=3"
+    # <link rel="next" href="http://yoursite.com/url?page=3" />
+
+Further reading:
+
+* [Pagination](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=1663744)
+* [Pagination with rel="next" and rel="prev"](http://googlewebmastercentral.blogspot.ca/2011/09/pagination-with-relnext-and-relprev.html)
+
+### Refresh interval and redirect URL
+
+Meta refresh is a method of instructing a web browser to automatically
+refresh the current web page or frame after a given time interval. It is also
+possible to instruct the browser to fetch a different URL when the page is
+refreshed, by including the alternative URL in the content parameter. By
+setting the refresh time interval to zero (or a very low value), this allows
+meta refresh to be used as a method of URL redirection.
+
+    set_meta_tags :refresh => 5
+    # <meta content="5" http-equiv="refresh" />
+    set_meta_tags :refresh => '5;url=http://example.com'
+    # <meta content="5;url=http://example.com" http-equiv="refresh" />
+
+Further reading:
+
+* [Meta refresh](http://en.wikipedia.org/wiki/Meta_refresh)
+* [What is the Meta Refresh Tag](http://webdesign.about.com/od/metataglibraries/a/aa080300a.htm)
+
 ### Hashes
 
 Any namespace can be built just passing any symbol name and a Hash. For example:
@@ -238,6 +273,9 @@ To set meta tags you can use following methods:
     <% title 'Member Login' %>
     <% description 'Member login page.' %>
     <% keywords 'Member login page.' %>
+    <% nofollow %>
+    <% noindex %>
+    <% refresh 3 %>
 
 Also there is `set_meta_tags` method exists:
 
@@ -270,8 +308,11 @@ 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;
-* `:og` — add Open Graph tags (Hash).
-* `:twitter` — add Twitter tags (Hash).
+* `:prev` — add prev link tag;
+* `:prev` — add next link tag;
+* `:og` — add Open Graph tags (Hash);
+* `:twitter` — add Twitter tags (Hash);
+* `:refresh` — refresh interval and optionally url to redirect to.
 
 And here are a few examples to give you ideas.
 
@@ -331,24 +372,6 @@ And in your pjax templates:
         <!-- HTML goes here -->
     <% end %>
 
-## 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
+## Author
 
-* [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)
-* [Tom Coleman](https://github.com/tmeasday) (contributor)
-* [Guille Lopez](https://github.com/guillelopez) (contributor)
-* [Holger Frohloff](https://github.com/jazzgumpy) (contributor)
-* [Jakub Wojtysiak](https://github.com/schiza) (contributor)
-* [Matthew Callis](https://github.com/MatthewCallis) (contributor)
-* [Andre Luiz Carvalho](https://github.com/alcarvalho) (contributor)
+[Dmytro Shteflyuk](https://github.com/kpumuk), [http://kpumuk.info](http://kpumuk.info/)

data/lib/meta_tags/version.rb

@@ -1,3 +1,3 @@
 module MetaTags
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

data/lib/meta_tags/view_helper.rb

@@ -105,7 +105,7 @@ module MetaTags
     #
     # @see #display_meta_tags
     #
-    def noindex(noindex)
+    def noindex(noindex = true)
       set_meta_tags(:noindex => noindex)
       noindex
     end
@@ -121,11 +121,27 @@ module MetaTags
     #
     # @see #display_meta_tags
     #
-    def nofollow(nofollow)
+    def nofollow(nofollow = true)
       set_meta_tags(:nofollow => nofollow)
       nofollow
     end
 
+    # Set the refresh meta tag
+    #
+    # @param [Integer, String] refresh a refresh value.
+    # @return [Integer, String] passed value.
+    #
+    # @example
+    #   refresh 5
+    #   refresh "5;url=http://www.example.com/"
+    #
+    # @see #display_meta_tags
+    #
+    def refresh(refresh)
+      set_meta_tags(:refresh => refresh)
+      refresh
+    end
+
     # Set default meta tag values and display meta tags. This method
     # should be used in layout file.
     #
@@ -142,6 +158,9 @@ module MetaTags
     # @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.
+    # @option default [String] :prev (nil) add prev link tag;
+    # @option default [String] :next (nil) add next link tag.
+    # @option default [String, Integer] :refresh (nil) meta refresh tag;
     # @option default [Hash] :open_graph ({}) add Open Graph meta tags.
     # @return [String] HTML meta tags to render in HEAD section of the
     #   HTML document.
@@ -182,6 +201,11 @@ module MetaTags
       meta_tags.delete(:noindex)
       meta_tags.delete(:nofollow)
 
+      # refresh
+      if refresh = meta_tags.delete(:refresh)
+        result << tag(:meta, 'http-equiv' => 'refresh', :content => refresh.to_s) unless refresh.blank?
+      end
+
       # hashes
       meta_tags.each do |property, data|
         if data.is_a?(Hash)
@@ -190,9 +214,11 @@ module MetaTags
         end
       end
 
-      # canonical
-      result << tag(:link, :rel => :canonical, :href => meta_tags[:canonical]) unless meta_tags[:canonical].blank?
-      meta_tags.delete(:canonical)
+      # canonical, prev and next
+      [ :canonical, :prev, :next ].each do |tag_name|
+        next unless href = meta_tags.delete(tag_name)
+        result << tag(:link, :rel => tag_name, :href => href)
+      end
 
       # user defined
       meta_tags.each do |name, data|

data/spec/meta_tags_spec.rb

@@ -248,6 +248,27 @@ describe MetaTags::ViewHelper do
     end
   end
 
+  context 'displaying refresh' do
+    it 'displays refresh when "refresh" is used' do
+      subject.refresh(5)
+      subject.display_meta_tags(:site => 'someSite').should include('<meta content="5" http-equiv="refresh" />')
+    end
+
+    it 'displays refresh when "set_meta_tags" used' do
+      subject.set_meta_tags(:refresh => 5)
+      subject.display_meta_tags(:site => 'someSite').should include('<meta content="5" http-equiv="refresh" />')
+    end
+
+    it 'should use custom refresh if given' do
+      subject.refresh("5;url=http://example.com/")
+      subject.display_meta_tags(:site => 'someSite').should include(%Q{<meta content="5;url=http://example.com/" http-equiv="refresh" />})
+    end
+
+    it 'should display nothing by default' do
+      subject.display_meta_tags(:site => 'someSite').should_not include('http-equiv="refresh"')
+    end
+  end
+
   context 'displaying noindex' do
     it 'should display noindex when "noindex" used' do
       subject.noindex(true)
@@ -339,6 +360,36 @@ describe MetaTags::ViewHelper do
     end
   end
 
+  context 'displaying prev url' do
+    it 'should not display prev url by default' do
+      subject.display_meta_tags(:site => 'someSite').should_not include('<link href="http://example.com/base/url" rel="prev" />')
+    end
+
+    it 'should display prev url when "set_meta_tags" used' do
+      subject.set_meta_tags(:prev => 'http://example.com/base/url')
+      subject.display_meta_tags(:site => 'someSite').should include('<link href="http://example.com/base/url" rel="prev" />')
+    end
+
+    it 'should display default prev url' do
+      subject.display_meta_tags(:site => 'someSite', :prev => 'http://example.com/base/url').should include('<link href="http://example.com/base/url" rel="prev" />')
+    end
+  end
+
+  context 'displaying next url' do
+    it 'should not display next url by default' do
+      subject.display_meta_tags(:site => 'someSite').should_not include('<link href="http://example.com/base/url" rel="next" />')
+    end
+
+    it 'should display next url when "set_meta_tags" used' do
+      subject.set_meta_tags(:next => 'http://example.com/base/url')
+      subject.display_meta_tags(:site => 'someSite').should include('<link href="http://example.com/base/url" rel="next" />')
+    end
+
+    it 'should display default next url' do
+      subject.display_meta_tags(:site => 'someSite', :next => 'http://example.com/base/url').should include('<link href="http://example.com/base/url" rel="next" />')
+    end
+  end
+
   context 'displaying Open Graph meta tags' do
     it 'should display meta tags specified with :open_graph' do
       subject.set_meta_tags(:open_graph => {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: meta-tags
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 1
-  - 4
-  - 1
-  version: 1.4.1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-14 00:00:00 -04:00
+date: 2013-05-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency