lwe-page_title_helper 0.4.0 → 0.5.0

data/README.rdoc

@@ -61,8 +61,8 @@ prependor appended, or if it contains the account name etc. It uses a similar ap
 Adding custom interpolations is as easy as defining a block, for example to access the current
 controller:
 
-    PageTitleHelper.interpolates :controller do |title,options|
-      controller.class.humanize
+    PageTitleHelper.interpolates :controller do |env|
+      env.controller.controller_name.humanize
     end
     
     page_title :format => ':title / :controller / :app' # => "Welcome back / Dashboard / My cool app"
@@ -77,16 +77,31 @@ To access just the title, without any magic app stuff interpolated or appended,
 * <tt>page_title { ... }</tt> - not per se an option, but if a block is given the methods sets a
   custom title and overwrites any DRY-I18n title.
 * <tt>:app</tt> - specifiy the applications name, however it's recommended to define the
-  translation key <tt>:'app.name'</tt>. If set to <tt>true</tt>, just returns the app name,
-  as defined in the translations or based on the +RAILS_ROOT+ humanized basename.
+  translation key <tt>:'app.name'</tt> or use the the fallback behaviour for the humanzied
+  basename of +RAILS_ROOT+.
 * <tt>:default</tt> - string which is displayed when no translation exists and no custom title
   has been specified. Can also be set to a symbol or array to take advantage of
   <tt>I18n.translate</tt>s <tt>:default</tt> option. (Default is <tt>:'app.tagline'</tt>)
 * <tt>:format</tt> - defines the output format, accepts a string containing multiple interpolations,
   see <i>More fun with <tt>:format</tt></i>. If set to +false+, just the current title is returned.
+  If <tt>:format => :app</tt> then just the application name is returned.
   (Default is <tt>":app - :title"</tt>)
 * <tt>:suffix</tt> - not happy with the fact that the translations must be named like
   <tt>en -> contacts -> index -> title</tt>, but prefer e.g. them to be suffixed with
   <tt>page_title</tt>? Then just set <tt>:suffix => :page_title</tt>. (Default <tt>:title</tt>)
 
+If an option should be set globally it's possible to change the default options hash as follows:
+
+    PageTitleHelper.options[:format] = ':title / :app'
+    
+Note, currently it only makes sense to set <tt>:format</tt> and/or <tt>:default</tt> globally.
+
+== Some (maybe useful) interpolations
+
+    # internationalized controller names, with fallback
+    PageTitleHelper.interpolates :controller do |env|
+      I18n.t env.controller.controller_path.tr('/','.') + '.controller', :default => env.controller.controller_name.humanize
+    end
+    
+== Licence and copyright
 Copyright (c) 2009 Lukas Westermann (Zurich, Switzerland), released under the MIT license

data/Rakefile

@@ -63,4 +63,5 @@ end
 desc 'Clean up generated files.'
 task :clean do |t|
   FileUtils.rm_rf "doc"
-end
+  FileUtils.rm_rf "pkg"
+end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 4
+:minor: 5
 :patch: 0

data/lib/page_title_helper.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 # PageTitleHelper
 module PageTitleHelper
   module Interpolations
@@ -16,12 +18,12 @@ module PageTitleHelper
       end
     end
     
-    def app(title, options)
-      options[:app] || I18n.translate(:'app.name', :default => File.basename(RAILS_ROOT).humanize)
+    def app(env)
+      env.options[:app] || I18n.translate(:'app.name', :default => File.basename(RAILS_ROOT).humanize)
     end
     
-    def title(title, options)
-      title
+    def title(env)
+      env.title
     end
   end
   
@@ -45,21 +47,26 @@ module PageTitleHelper
       content_for(:page_title) { yield }
       return read_page_title_content_block
     end
-    
+        
     options = PageTitleHelper.options.merge(options || {})
     options.assert_valid_keys(:app, :suffix, :default, :format)
+
+    # construct basic env
+    env = OpenStruct.new(:options => options, :view => self, :controller => self.controller)
+    
     # just return the applications name
-    return Interpolations.app('', {}) if options[:app] == true
+    return Interpolations.app(env) if options[:format] == :app
     
     # read page title
     page_title = read_page_title_content_block
     page_title = I18n.translate(i18n_template_key(options[:suffix]), :default => options[:default]) if page_title.blank?
     
-    # return page title if format is set explicitly to false
+    # return page title if format is set explicitly set to false
     return page_title if options[:format] == false
     
     # else -> interpolate
-    Interpolations.interpolate options[:format] || ':app - :title', page_title, options
+    env.title = page_title
+    Interpolations.interpolate options[:format], env
   end
   
   protected

data/page_title_helper.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{page_title_helper}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lukas Westermann"]

data/test/page_title_helper_test.rb

@@ -18,27 +18,28 @@ class MockView
   def content_for(sym, &block)
     instance_variable_set('@content_for_' + sym.to_s, yield)
   end
+  
+  def controller; nil; end
 end
 
 I18n.backend.store_translations :en, :contacts => { :list => { :title => 'contacts.list.title' }}
 I18n.backend.store_translations :en, :placeholder => 'Displaying {{name}}'
 
-
 class PageTitleHelperTest < ActiveSupport::TestCase  
   test "interpolations" do    
-    assert_equal 'Page title helper', PageTitleHelper::Interpolations.app('untitled', {})
-    assert_equal 'Appname', PageTitleHelper::Interpolations.app('untitled', { :app => 'Appname' })
-    assert_equal 'untitled', PageTitleHelper::Interpolations.title('untitled', {})
+    assert_equal 'Page title helper', PageTitleHelper::Interpolations.app(OpenStruct.new(:options => {}))
+    assert_equal 'Appname', PageTitleHelper::Interpolations.app(OpenStruct.new(:options => { :app => 'Appname' }))
+    assert_equal 'untitled', PageTitleHelper::Interpolations.title(OpenStruct.new({:title => 'untitled'}))
   end
   
   test "adding custom interpolation" do
     # extend Interpolations
-    PageTitleHelper.interpolates :app_reverse do |title, options|
-      app(title,options).reverse.downcase
+    PageTitleHelper.interpolates :app_reverse do |env|
+      app(env).reverse.downcase
     end
   
-    assert_equal "anna", PageTitleHelper::Interpolations.app_reverse('untitled', { :app => 'Anna' })
-    assert_equal "ppa", PageTitleHelper::Interpolations.interpolate(':app_reverse', 'foo', { :app => 'app' })
+    assert_equal "anna", PageTitleHelper::Interpolations.app_reverse(OpenStruct.new(:options => { :app => 'Anna' }))
+    assert_equal "ppa", PageTitleHelper::Interpolations.interpolate(':app_reverse', OpenStruct.new(:options => { :app => 'app' }))
   end
   
   test "setting title to 'foo' returns 'foo'" do
@@ -52,9 +53,14 @@ class PageTitleHelperTest < ActiveSupport::TestCase
     assert_equal 'Page title helper - contacts.list.title', view.page_title
   end
   
-  test "printing app name only if :app => true" do
+  test "printing app name only if :format => :app" do
+    view = MockView.new
+    assert_equal 'Page title helper', view.page_title(:format => :app)
+  end
+  
+  test "printing custom app name if :app defined and :format => :app" do
     view = MockView.new
-    assert_equal 'Page title helper', view.page_title(:app => true)
+    assert_equal "Some app", view.page_title(:app => 'Some app', :format => :app)
   end
   
   test "custom formatting options" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lwe-page_title_helper
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Lukas Westermann