smart_titles 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmM2MjRlNTYzMzZhNDdmM2ZkNmIzNDQ3MTExN2I1NzQ5ZDU0YjYwYw==
+  data.tar.gz: !binary |-
+    NzM4Y2Q3YjRmNzI0ZWM3NDljYjcwYjVjYTkwNTE5NTUzOGViN2M5Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzBlNGY3YzgzMTg2YTYwM2JmYTUzMzI1MGIzNWViZjVkMWYyM2ZiODkxNmZi
+    MWNhMjY3Y2M0Yzk4MmVjOTMyYzhhYzBjNjE0ZTdjNWE1MTRiYTRkODUzM2Q5
+    ZjVhMTc5NDdhNzkzY2NkMTc2NTdmMTQwYjVkM2UyNmM2MDBmYTc=
+  data.tar.gz: !binary |-
+    MTM2ODMyZDU1NzY3ZDVkODNiOTEzODg0YzY1ZTYxOWFlY2MxOTdiMDRhMmY1
+    YjgxMDcwYWVmMzNmOTVlMTUxOTZjNTFjN2RiNWUyYTQ2MmZmNTNlM2EyNWI4
+    ZTQ0Y2QwMzQ3MzhlNmViYTAzMDA5NDFkNmI5N2FkYzA4ODI4Y2U=

data/Readme.md

@@ -12,8 +12,7 @@ If you don't want to display it inside the page simply remove an equality sign:
     <% title "Title for a browser window" %>
     <h1>Different title for the page</h1>
 
-This gem is under development and [therefore](http://semver.org/) API can change between minor versions until the 1.0.0.
-It works only with Rails 3.1 and higher.
+The gem uses [Semantic Versioning](http://semver.org/). It works with Rails 3.1 and higher.
 
 Installation
 ---
@@ -27,7 +26,7 @@ And run:
 
 Integration
 ---
-You have to insert the following code inside the `<title>` tag in your layout:
+Insert `head_title` inside the `<title>` tag in your layout:
 
     <title><%= head_title "Default title" %></title>
 
@@ -35,10 +34,12 @@ The default title is displayed only if you haven't specified title in your view.
 
 With Internationalization
 ---
-If you are using I18n in your Rails application static titles are specified in the locale file:
+It is easy to translate titles using built-in Rails I18n.
 
     en:
-      title: Default title
+      layouts:
+        application:
+          title: Default title
       pages:
         index:
           title: All pages
@@ -49,7 +50,11 @@ And then you should just call `title` without any arguments.
 
     <%= title %>
 
-Note that you _have to call it_ even if you don't output it.
+The same goes for `head_title`:
+
+    <title><%= head_title %></title>
+
+Note that you _have to call `title`_ even if you don't output it.
 
     <% title %>
 
@@ -57,17 +62,15 @@ Dynamic titles are set as usual:
 
     <%= title @page.title %>
 
-"Default title" will be only used by `head_title` if you call it with no arguments and there will be no title set by the current page.
-
-    <title><%= head_title %></title>
-
 Title Template
 ---
-If you want to add your website name to all of your titles just add :title_template translation
+If you want to add your website name to all of your titles just add title_template translation
 
     en:
-      title: The Coolest Store
-      title_template: %{title} from the Coolest Store
+      layouts:
+        application:
+          title: The Coolest Store
+          title_template: %{title} from the Coolest Store
       products:
         index:
           title: Products
@@ -76,6 +79,20 @@ And now products#index page will have "Products from the Coolest Store" browser'
 
 Changelog
 ---
+
+### 0.4.0
+The website title and template translations can now be scoped by layout. Example:
+
+    layouts:
+      application:
+        title: My Website
+        title_template: "%{title} - My Website"
+      admin:
+        title: Web Admin
+
+Also, this prevents h1 from showing default title when translation is missing if you use cascading I18n backend.
+The old-style global translations still do work.
+
 ### 0.3.2
 Page title is no longer double-escaped.
 

data/lib/smart_titles/helper.rb

@@ -1,6 +1,4 @@
 module SmartTitles
-  MISSING_TRANSLATION = Object.new
-
   module Helper
     # <title><%= head_title %></title>
     # Will return title if it was set for the current page.
@@ -17,9 +15,10 @@ module SmartTitles
     #     head_title     # => The Coolest Store
     #     title "Drinks" # => <h1>Drinks</h1>
     #     head_title     # => Drinks from the Coolest Store
-    def head_title(default_title = t(:title))
-      if title = page_title
-        t(:title_template, title: title, default: title)
+    def head_title(default_title = t('.title', default: :title))
+      if content_for?(:page_title)
+        title = content_for(:page_title)
+        t('.title_template', title: title, default: [:title_template, title])
       else
         default_title
       end
@@ -28,24 +27,23 @@ module SmartTitles
     # Convinient helper method that will:
     # * Set custom title for the current page if it is passed. Otherwise the title will be automatically set 
     # * Return the title passed or looked up from locale wrapped into h1 tag
-    def title(custom_title = nil)
-      title = custom_title || page_title
-      title &&= title.html_safe
-      provide(:page_title, title)
-      content_tag(:h1, page_title) if page_title
-    end
-
-  private
-
-    # This is a page title that was set by the #title helper method
-    # It defaults to ".title" translation
-    def page_title
-      if content_for?(:page_title)
-        content_for(:page_title)
+    def title(custom_title_or_options = nil)
+      case custom_title_or_options
+      when Hash
+        options = custom_title_or_options
       else
-        translation = t('.title', default: MISSING_TRANSLATION)
-        translation unless translation.equal? MISSING_TRANSLATION
+        options = {}
+        custom_title = custom_title_or_options
       end
+
+      title = custom_title
+      title ||= begin t('.title', options.merge(raise: true))
+                rescue I18n::MissingTranslationData
+                end
+
+      title &&= title.html_safe
+      provide(:page_title, title)
+      content_tag(:h1, title) if title
     end
   end
 end

data/lib/smart_titles/version.rb

@@ -1,3 +1,3 @@
 module SmartTitles
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/smart_titles.gemspec

@@ -14,10 +14,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport'
   s.add_dependency 'actionpack'
-  s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
 end

data/test/smart_titles/helper_test.rb

@@ -17,19 +17,24 @@ class SmartTitlesHelperTest < ActionView::TestCase
 
 
   def test_custom_title
-    store_global_title
+    store_layout_title
     store_page_title
     assert_equal "<h1>Hi</h1>", title("Hi")
   end
 
   def test_translated_title
-    store_global_title
+    store_layout_title
     store_page_title
     assert_equal "<h1>New post</h1>", title
   end
 
+  def test_translated_title_with_options
+    store_translations posts: { new: { title: "New post - %{category}" } }
+    assert_equal "<h1>New post - News</h1>", title(category: "News")
+  end
+
   def test_no_page_title
-    store_global_title
+    store_layout_title
     assert_nil title
   end
 
@@ -39,21 +44,21 @@ class SmartTitlesHelperTest < ActionView::TestCase
 
 
   def test_head_title_with_custom_title
-    store_global_title
+    store_layout_title
     store_page_title
     title("Hi")
     assert_equal "Hi", head_title
   end
 
   def test_head_title_with_translated_title
-    store_global_title
+    store_layout_title
     store_page_title
     title
     assert_equal "New post", head_title
   end
 
   def test_head_title_with_translated_global_title
-    store_global_title
+    store_layout_title
     assert_equal "My Website", head_title
   end
 
@@ -73,7 +78,7 @@ class SmartTitlesHelperTest < ActionView::TestCase
 
 
   def test_head_title_with_template_and_translated_titles
-    store_global_title
+    store_layout_title
     store_page_title
     store_title_template
     title
@@ -81,7 +86,7 @@ class SmartTitlesHelperTest < ActionView::TestCase
   end
 
   def test_head_title_with_template_and_custom_title
-    store_global_title
+    store_layout_title
     store_page_title
     store_title_template
     title("Hi")
@@ -89,11 +94,20 @@ class SmartTitlesHelperTest < ActionView::TestCase
   end
 
   def test_head_title_with_template_and_translated_title
-    store_global_title
+    store_layout_title
     store_title_template
     assert_equal "My Website", head_title
   end
 
+  def test_head_title_old
+    store_old_global_title
+    assert_equal "My Website", head_title
+
+    store_page_title
+    title
+    assert_equal "d New post b", head_title
+  end
+
 
   def test_head_title_template_is_escaped
     store_translations title_template: '"%{title}"'
@@ -145,11 +159,16 @@ private
     store_page_title
   end
 
-  def store_global_title
-    store_translations title: "My Website"
+  def store_layout_title
+    store_translations layouts: { application: { title: "My Website" } }
   end
 
   def store_title_template
+    store_translations layouts: { application: { title_template: "d %{title} b" } }
+  end
+
+  def store_old_global_title
+    store_translations title: "My Website"
     store_translations title_template: "d %{title} b"
   end
 

metadata

@@ -1,64 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: smart_titles
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Semyon Perepelitsa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
+  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
+- !ruby/object:Gem::Dependency
   prerelease: false
+  name: actionpack
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
 description: 
 email: sema@sema.in
 executables: []
@@ -82,29 +61,27 @@ files:
 homepage: http://github.com/semaperepelitsa/smart_titles
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Really convenient way to set up page titles in a Rails application.
 test_files:
 - test/smart_titles/helper_test.rb
 - test/test_helper.rb
-has_rdoc: