RubyGems - lwe-page_title_helper - Versions diffs - 0.5.0 → 0.6.1 - Mend

lwe-page_title_helper 0.5.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

data/README.rdoc +5 -2
data/Rakefile +5 -2
data/VERSION.yml +2 -2
data/lib/page_title_helper.rb +23 -17
data/page_title_helper.gemspec +3 -4
data/test/page_title_helper_test.rb +30 -1
data/test/test_helper.rb +6 -2
metadata +3 -3

data/README.rdoc CHANGED Viewed

@@ -1,7 +1,7 @@
 = Page title helper
 Ever wondered if there was an easier and DRY-way to set your page titles (and/or headings). Backed
-byRails (>= 2.3) new support for <i>I18n</i> the solution is a simple helper method.
+by Rails (only tested on 2.3.x) and it's new <tt>I18n</tt>-class the solution is a simple helper method.
 In your layout add this to your <tt><head>-section</tt>:
@@ -98,10 +98,13 @@ Note, currently it only makes sense to set <tt>:format</tt> and/or <tt>:default<
 == Some (maybe useful) interpolations
-    # internationalized controller names, with fallback
+The internationalized controller name, with fallback to just display the humanized name:
     PageTitleHelper.interpolates :controller do |env|
       I18n.t env.controller.controller_path.tr('/','.') + '.controller', :default => env.controller.controller_name.humanize
     end
+<b>Note:</b> Where should I put these, as well as the default options? I'd put them in a new file at <tt>config/initializers/page_title.rb</tt> or someting like that.
 == Licence and copyright
 Copyright (c) 2009 Lukas Westermann (Zurich, Switzerland), released under the MIT license

data/Rakefile CHANGED Viewed

@@ -35,6 +35,9 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
 end
 namespace :metrics do
+  desc 'Report all metrics, i.e. stats and code coverage.'
+  task :all => [:stats, :coverage]
   desc 'Report code statistics for library and tests to shell.'
   task :stats do |t|
     require 'code_statistics'
@@ -54,10 +57,10 @@ namespace :metrics do
   end
 end
-desc 'Start IRB console with loaded test/test_helper.rb and sqlite db.'
+desc 'Start IRB console with loaded test/test_helper.rb and PageTitleHelper.'
 task :console do |t|
   chdir File.dirname(__FILE__)
-  exec 'irb -Ilib/ -r page_title_helper'
+  exec 'irb -Ilib -r test/test_helper.rb -r page_title_helper'
 end
 desc 'Clean up generated files.'

data/VERSION.yml CHANGED Viewed

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

data/lib/page_title_helper.rb CHANGED Viewed

@@ -1,3 +1,12 @@
+# PageTitleHelper provides an +ActionView+ helper method to simplify adding
+# custom titles to pages.
+#
+# Author:: Lukas Westermann
+# Copyright:: Copyright (c) 2009 Lukas Westermann (Zurich, Switzerland)
+# Licence:: MIT-Licence (http://www.opensource.org/licenses/mit-license.php)
+#
+# See documentation for +page_title+ for usage examples and more informations.
 require 'ostruct'
 # PageTitleHelper
@@ -5,13 +14,8 @@ module PageTitleHelper
   module Interpolations
     extend self
-    # Returns a sorted list of all interpolations.
-    def self.all
-      self.instance_methods(false).sort
-    end
     def self.interpolate(pattern, *args)
-      all.reverse.inject(pattern.dup) do |result, tag|
+      instance_methods(false).sort.reverse.inject(pattern.dup) do |result, tag|
         result.gsub(/:#{tag}/) do |match|
           send(tag, *args)
         end
@@ -43,29 +47,28 @@ module PageTitleHelper
   end
   def page_title(options = nil, &block)
-    if block_given?
+    if block_given? # define title
       content_for(:page_title) { yield }
       return read_page_title_content_block
     end
-    options = PageTitleHelper.options.merge(options || {})
+    options = PageTitleHelper.options.merge(options || {}).symbolize_keys!
     options.assert_valid_keys(:app, :suffix, :default, :format)
-    # construct basic env
+    # construct basic env to pass around
     env = OpenStruct.new(:options => options, :view => self, :controller => self.controller)
     # just return the applications name
     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?
+    env.title = read_page_title_content_block
+    env.title = I18n.translate(i18n_template_key(options[:suffix]), :default => options[:default]) if env.title.blank?
     # return page title if format is set explicitly set to false
-    return page_title if options[:format] == false
+    return env.title if options[:format] == false
-    # else -> interpolate
-    env.title = page_title
+    # interpolate title
     Interpolations.interpolate options[:format], env
   end
@@ -86,12 +89,15 @@ module PageTitleHelper
     # and also kind of a hack, because this really seems to be some sort if
     # internal variable, that's why it's "abstracted" away as well.
     #
-    def read_first_render_path
-      @_first_render.template_path
+    # Also ensure that the extensions (like <tt>.html.erb</tt> or
+    # <tt>.html.haml</tt>) have been stripped of.
+    def first_render_path_without_extension
+      p = @_first_render.template_path
+      p[0,p.index('.')]
     end
     def i18n_template_key(suffix = nil)
-      ikey = read_first_render_path.gsub(/\.html\.erb$/, '').tr('/', '.')
+      ikey = first_render_path_without_extension.tr('/', '.')
       ikey = ikey + "." + suffix.to_s unless suffix.nil?
       ikey
     end

data/page_title_helper.gemspec CHANGED Viewed

@@ -2,11 +2,11 @@
 Gem::Specification.new do |s|
   s.name = %q{page_title_helper}
-  s.version = "0.5.0"
+  s.version = "0.6.1"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lukas Westermann"]
-  s.date = %q{2009-07-07}
+  s.date = %q{2009-09-10}
   s.email = %q{lukas.westermann@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,11 +24,10 @@ Gem::Specification.new do |s|
      "test/page_title_helper_test.rb",
      "test/test_helper.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/lwe/page_title_helper}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{Simple, internationalized and DRY page titles and headings for rails.}
   s.test_files = [
     "test/page_title_helper_test.rb",

data/test/page_title_helper_test.rb CHANGED Viewed

@@ -22,8 +22,12 @@ class MockView
   def controller; nil; end
 end
-I18n.backend.store_translations :en, :contacts => { :list => { :title => 'contacts.list.title' }}
+# store translations
+I18n.backend.store_translations :en, :contacts => {
+  :list => { :title => 'contacts.list.title', :page_title => 'custom contacts title' },
+  :myhaml => { :title => 'this is haml!' }}
 I18n.backend.store_translations :en, :placeholder => 'Displaying {{name}}'
+I18n.backend.store_translations :en, :app => { :tagline => 'Default', :other_tagline => 'Other default' }
 class PageTitleHelperTest < ActiveSupport::TestCase
   test "interpolations" do
@@ -90,4 +94,29 @@ class PageTitleHelperTest < ActiveSupport::TestCase
     view.page_title { I18n.t :placeholder, :name => 'Bella' }
     assert_equal "Page title helper - Displaying Bella", view.page_title
   end
+  test "render translated :'app.tagline' if no title is available" do
+    view = MockView.new 'view/does/not_exist.html.erb'
+    assert_equal "Page title helper - Default", view.page_title
+  end
+  test "render custom 'default' string, if title is not available" do
+    view = MockView.new 'view/does/not_exist.html.erb'
+    assert_equal 'Page title helper - Some default', view.page_title(:default => 'Some default')
+  end
+  test "render custom default translation, if title is not available" do
+    view = MockView.new 'view/does/not_exist.html.erb'
+    assert_equal 'Page title helper - Other default', view.page_title(:default => :'app.other_tagline')
+  end
+  test "render auto-title using custom suffix 'page_title'" do
+    view = MockView.new 'contacts/list.html.erb'
+    assert_equal 'Page title helper - custom contacts title', view.page_title(:suffix => :page_title)
+  end
+  test "ensure that it works with other template engines, like .html.haml" do
+    view = MockView.new('contacts/myhaml.html.haml')
+    assert_equal 'Page title helper - this is haml!', view.page_title
+  end
 end

data/test/test_helper.rb CHANGED Viewed

@@ -1,7 +1,11 @@
 require 'rubygems'
-require 'test/unit'
 require 'active_support'
-require 'active_support/test_case'
+require 'action_view'
+unless Object.const_defined?('IRB')
+  require 'test/unit'
+  require 'active_support/test_case'
+end
 ROOT = File.expand_path File.dirname(File.dirname(__FILE__))
 RAILS_ROOT = '/this/is/just/for/testing/page_title_helper'

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lwe-page_title_helper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Lukas Westermann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-07-07 00:00:00 -07:00
+date: 2009-09-10 00:00:00 -07:00
 default_executable:
 dependencies: []
@@ -33,7 +33,7 @@ files:
 - page_title_helper.gemspec
 - test/page_title_helper_test.rb
 - test/test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/lwe/page_title_helper
 post_install_message:
 rdoc_options: