meta-tags 1.2.5 → 1.2.6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.2.6 (March 4, 2012)
+
+Features:
+
+  - jQuery.pjax support via `display_title` method. Check README for details
+
+## 1.2.5 (March 3, 2012)
+
+Bugfixes:
+
+  - Fixed bug with overriding open graph attributes
+  - Fixed incorrect page title when `:site` is is blank
+  - Normalize `:og` attribute to `:open_graph`
+
 ## 1.2.4 (April 26, 2011)
 
 Features:

data/README.md

@@ -231,6 +231,40 @@ Keywords can be passed as string of comma-separated values, or as an array:
 
 Description is a string (HTML will be stripped from output string).
 
+### Using with pjax
+
+[jQuery.pjax](https://github.com/defunkt/jquery-pjax) is a nice solution for navigation
+without full page reload. The main difference is that layout file will not be rendered,
+so page title will not change. To fix this, when using a page fragment, pjax will check
+the fragment DOM element for a `title` or `data-title` attribute and use any value it finds.
+
+MetaTags simplifies this with `display_title` method, which returns fully resolved
+page title (include site, prefix/suffix, etc.) But in this case you will have to
+set default parameters (e.g, `:site`) both in layout file and in your views. To minimize
+code duplication, you can define a helper in `application_helper.rb`:
+
+    def default_meta_tags
+      {
+        :title       => 'Member Login',
+        :description => 'Member login page.',
+        :keywords    => 'Site, Login, Members',
+        :separator   => "—".html_safe,
+      }
+    end
+
+Then in your layout file use:
+
+    <%= display_meta_tags(default_meta_tags) %>
+
+And in your pjax templates:
+
+    <!-- set title here, so we can use it both in "display_title" and in "title" %>
+    <% title "My Page title" %>
+    <%= content_tag :div, :data => { :title => display_title(default_meta_tags) } do %>
+        <h1><%= title %></h1>
+        <!-- HTML goes here -->
+    <% end %>
+
 ## Alternatives
 
 There are several plugins influenced me to create this one:
@@ -246,3 +280,4 @@ There are several plugins influenced me to create this one:
 * Sergio Cambra (contributor)
 * Kristoffer Renholm (contributor)
 * [Jürg Lehni](https://github.com/lehni) (contributor)
+* [Tom Coleman](https://github.com/tmeasday) (contributor)

data/lib/meta_tags/version.rb

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

data/lib/meta_tags/view_helper.rb

@@ -34,9 +34,10 @@ module MetaTags
     # This method is best suited for use in helpers. It sets the page title
     # and returns it (or +headline+ if specified).
     #
-    # @param [String, Array] title page title. When passed as an
+    # @param [nil, String, Array] title page title. When passed as an
     #   +Array+, parts will be joined divided with configured
-    #   separator value (see {#display_meta_tags}).
+    #   separator value (see {#display_meta_tags}). When nil, current
+    #   title will be returned.
     # @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.
@@ -48,12 +49,14 @@ module MetaTags
     #   title 'Login Page', 'Please login'
     # @example Set title as array of strings
     #   title :title => ['part1', 'part2'] # => "part1 | part2"
+    # @example Get current title
+    #   title
     #
     # @see #display_meta_tags
     #
-    def title(title, headline = '')
-      set_meta_tags(:title => title)
-      headline.blank? ? title : headline
+    def title(title = nil, headline = '')
+      set_meta_tags(:title => title) unless title.nil?
+      headline.blank? ? meta_tags[:title] : headline
     end
 
     # Set the page keywords.
@@ -188,6 +191,30 @@ module MetaTags
       result.respond_to?(:html_safe) ? result.html_safe : 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
+    # that your layour file (with display_meta_tags helper) will not be rendered,
+    # so you have to pass default arguments like site title in here. You probably
+    # want to define helper with default options to minimize code duplication.
+    #
+    # @param [Hash] meta_tags list of meta tags.
+    # @option default [String] :site (nil) site title;
+    # @option default [String] :title ("") page title;
+    # @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;
+    #
+    # @example
+    #   <div data-page-container="true" title="<%= display_title :title => 'My Page', :site => 'PJAX Site' %>">
+    #
+    def display_title(default = {})
+      meta_tags = normalize_open_graph(default).deep_merge!(self.meta_tags)
+      build_full_title(meta_tags)
+    end
+
     if respond_to? :safe_helper
       safe_helper :display_meta_tags
     end

data/spec/meta_tags_spec.rb

@@ -35,6 +35,10 @@ describe MetaTags::ViewHelper do
     it 'should respond to "display_meta_tags" helper' do
       subject.should respond_to(:display_meta_tags)
     end
+
+    it 'should respond to "display_title" helper' do
+      subject.should respond_to(:display_title)
+    end
   end
 
   context 'returning values' do
@@ -46,6 +50,11 @@ describe MetaTags::ViewHelper do
       subject.title('some-title', 'some-headline').should == 'some-headline'
     end
 
+    it 'should return title' do
+      subject.title('some-title').should == 'some-title'
+      subject.title.should == 'some-title'
+    end
+
     it 'should return description' do
       subject.description('some-description').should == 'some-description'
     end
@@ -337,5 +346,12 @@ describe MetaTags::ViewHelper do
     end
   end
 
+  context '.display_title' do
+    it 'should display custom title if given' do
+      subject.title('someTitle')
+      subject.display_title(:site => 'someSite', :title => 'defaultTitle').should == 'someSite | someTitle'
+    end
+  end
+
   it_behaves_like '.set_meta_tags'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: meta-tags
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 2
-  - 5
-  version: 1.2.5
+  - 6
+  version: 1.2.6
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-03 00:00:00 Z
+date: 2012-03-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack