RubyGems - page_title_helper - Versions diffs - 0.7.1 → 1.0.0 - Mend

page_title_helper 0.7.1 → 1.0.0

Files changed (12) hide show

data/.gitignore +1 -0
data/README.md +14 -19
data/VERSION.yml +3 -3
data/lib/page_title_helper.rb +14 -24
data/rails/init.rb +4 -0
data/test/multiple_formats_test.rb +7 -5
data/test/page_title_helper_test.rb +106 -98
data/test/test_helper.rb +2 -1
metadata +3 -6
data/init.rb +0 -1
data/page_title_helper.gemspec +0 -56
data/test/mocks.rb +0 -20

data/.gitignore CHANGED Viewed

@@ -1,3 +1,4 @@
 doc/
 pkg/
 .yardoc
+*.gemspec

data/README.md CHANGED Viewed

@@ -22,34 +22,33 @@ The format etc. is of course configurable, just head down to the options.
 ## Installation
-As gem (from gemcutter.org, since version 0.7.0):
+As gem (from gemcutter.org, as of version 0.7.0):
     sudo gem install page_title_helper [-s http://gemcutter.org]
     # then add the following line to config/environment.rb
     config.gem 'page_title_helper', :source => 'http://gemcutter.org'
-Or old school as Rails plugin:
+or as plain old Rails plugin:
     ./script/plugin install git://github.com/lwe/page_title_helper.git
 ## Customize titles
-Need a custom title, or need to fill in some placeholders? Just provide a block, in e.g.
+Need a custom title, or need to fill in some placeholders? Just use the _bang_ method (`page_title!`), in e.g.
 `contacts/show.html.erb` the requirement is to display the contacts name in the
 `<title>-tag`as well as in the heading?
-    <h1><%=h page_title { @contact.name } %></h1>
+    <h1><%=h page_title!(@contact.name) %></h1>
 A call to `page_title` will now return the contacts name, neat :) if for example the
-`<h1>` does not match the +title+, then
-well, just do something like:
+`<h1>` does not match the `<title>`, then well, just do something like:
-    <% page_title { @contact.name + " (" + @contact.company.name + ")" } %>
+    <% page_title!(@contact.name + " (" + @contact.company.name + ")") %>
     <h1><%=h @contact.name %></h1>
-Guess, that's it. Of course it's also possible to use `translate` within the `page_title` block, so
-to translate customzied titles, like:
+Guess, that's it. Of course it's also possible to use `translate` with `page_title!`, to
+translate customzied titles, like:
     # in config/locales/en.yml:
     en:
@@ -58,10 +57,7 @@ to translate customzied titles, like:
           title: "Welcome back, {{name}}"
     # in app/views/dashboard/index.html.erb:
-    <h1><%=h page_title { t '.title', :name => @user.first_name } %></h1>
-Btw - a helpful rule-of-thumb: if `page_title` is used with a block a title is **defined**,
-if it's used without the current title is rendered.
+    <h1><%=h page_title!(t('.title', :name => @user.first_name)) %></h1>
 ## More fun with <tt>:format</tt>
@@ -82,16 +78,16 @@ controller:
 To access just the title, without any magic app stuff interpolated or appended, use:
-    page_title { "untitled" }
+    page_title! "untitled"
     page_title :format => false # => "untitled"
 Need a custom format for a single title? Just return an array:
     # in the view:
-    <h1><%= h(page_title { [@contact.name, ":title from :company - :app"] } %></h1> # => <h1>Franz Meyer</h1>
+    <h1><%=h page_title!(@contact.name, ":title from :company - :app") %></h1> # => <h1>Franz Meyer</h1>
     # in the <head>
-    <title><%= h(page_title) %></title> # => this time it will use custom title like "Franz Meyer from ABC Corp. - MyCoolApp"
+    <title><%=h(page_title) %></title> # => this time it will use custom title like "Franz Meyer from ABC Corp. - MyCoolApp"
 To streamline that feature a bit and simplify reuse of often used formats, it's now possible to define format aliases like:
@@ -100,7 +96,7 @@ To streamline that feature a bit and simplify reuse of often used formats, it's
     PageTitleHelper.formats[:promo] = ":app - :title" # show app first for promo pages :)
     # then in the view to display a contact...
-    page_title { [@contact.name, :with_company] }
+    page_title! @contact.name, :with_company
     # ...or for the promo page via config/locales/en.yml (!)
     en:
@@ -109,8 +105,7 @@ To streamline that feature a bit and simplify reuse of often used formats, it's
           title:
             - "Features comparison"
             - !ruby/sym promo
 Pretty, cool, aint it? The special `:format => :app` works also with the `formats` hash. Then there is also a
 `:default` format, which should be used to override the default format.

data/VERSION.yml CHANGED Viewed

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

data/lib/page_title_helper.rb CHANGED Viewed

@@ -56,11 +56,14 @@ module PageTitleHelper
     }
   end
+  # Specify page title
+  def page_title!(*args)
+    @_page_title = args.size > 1 ? args : args.first
+    @_page_title.is_a?(Array) ? @_page_title.first : @_page_title
+  end
   def page_title(options = nil, &block)
-    if block_given? # define title
-      @_page_title = yield
-      return @_page_title.is_a?(Array) ? @_page_title.first : @_page_title
-    end
+    return page_title!(yield) if block_given? # define title
     options = PageTitleHelper.options.merge(options || {}).symbolize_keys!
     options[:format] ||= :title # handles :format => false
@@ -81,25 +84,12 @@ module PageTitleHelper
     Interpolations.interpolate format, env
   end
-  protected
-    # Access +ActionView+s internal <tt>@_first_render</tt> variable, to access
-    # template first rendered, this is to help create the DRY-I18n-titles magic,
-    # 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.
-    #
-    # Also ensure that the extensions (like <tt>.html.erb</tt> or
-    # <tt>.html.haml</tt>) have been stripped of and translated in the sense
-    # of converting <tt>/</tt> to <tt>.</tt>.
-    def first_render_path_translated
-      @_first_render.template_path.gsub(/\.[^\/]*\Z/, '').tr('/', '.')
-    end
-    def i18n_template_key(suffix = nil)
-      first_render_path_translated + (suffix.present? ? ".#{suffix}" : "")
+  protected
+    # Find current title key based on currently rendering template, same
+    # code as in {ActionView::Helpers::TranslationHelpers} to get that <tt>'.relative_key'</tt>
+    # magic working.
+    def i18n_template_key(suffix = :title)
+      template.path_without_format_and_extension.gsub(%r{/_?}, '.') + ".#{suffix}"
     end
-end
-# tie stuff together
-if Object.const_defined?('ActionView')
-  ActionView::Base.send(:include, PageTitleHelper)
 end

data/rails/init.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'page_title_helper'
+# include helper methods in ActionView
+ActionView::Base.send(:include, PageTitleHelper) if defined?(ActionView)

data/test/multiple_formats_test.rb CHANGED Viewed

@@ -1,11 +1,11 @@
 require 'test_helper'
 require 'page_title_helper'
-require 'mocks'
 class MultipleFormatsTest < ActiveSupport::TestCase
   context "#page_title supporting multiple formats through arrays" do
     setup do
-      @view = MockView.new
+      @view = ActionView::Base.new
+      @view.template = ActionView::Template.new "contacts/list.html.erb"
     end
     should "accept an array passed in the page_title block and use the second argument as format" do
@@ -21,7 +21,8 @@ class MultipleFormatsTest < ActiveSupport::TestCase
   context "#page_title with format aliases" do
     setup do
       PageTitleHelper.formats[:myformat] = ":title <-> :app"
-      @view = MockView.new
+      @view = ActionView::Base.new
+      @view.template = ActionView::Template.new "contacts/list.html.erb"
     end
     should "have a default alias named :app" do
@@ -56,15 +57,16 @@ class MultipleFormatsTest < ActiveSupport::TestCase
       I18n.load_path = [File.join(File.dirname(__FILE__), "en_wohaapp.yml")]
       I18n.reload!
       PageTitleHelper.formats[:promo] = ":app > :title"
+      @view = ActionView::Base.new
     end
     should "allow to overide format through YAML" do
-      @view = MockView.new('pages/features.html.haml')
+      mock(@view).template { ActionView::Template.new 'pages/features.html.haml' }
       assert_equal 'Wohaapp > Feature comparison', @view.page_title
     end
     should "handle raw string formats from YAML as well" do
-      @view = MockView.new('pages/signup.html.haml')
+      mock(@view).template { ActionView::Template.new 'pages/signup.html.haml' }
       assert_equal 'Sign up for Wohaapp now!', @view.page_title
     end
   end

data/test/page_title_helper_test.rb CHANGED Viewed

@@ -1,109 +1,117 @@
 require 'test_helper'
 require 'page_title_helper'
 require 'ostruct'
-require 'mocks'
+class PageTitleHelperTest < ActiveSupport::TestCase
+  context "PageTitleHelper" do
+    setup do
+      I18n.load_path = [File.join(File.dirname(__FILE__), 'en.yml')]
+      I18n.reload!
+      @view = ActionView::Base.new
+      @view.template = ActionView::Template.new "contacts/list.html.erb"
+    end
+    context "::Interpolations" do
+      should "interpolate :app and :title" do
+        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
-class PageTitleHelperTest < ActiveSupport::TestCase
-  def setup
-    I18n.load_path = [File.join(File.dirname(__FILE__), 'en.yml')]
-    I18n.reload!
-  end
-  test "interpolations" do
-    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) { |env| app(env).reverse.downcase }
+      should "allow adding custom interpolations" do
+        # extend Interpolations
+        PageTitleHelper.interpolates(:app_reverse) { |env| app(env).reverse.downcase }
-    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 "that interpolations which are equaly named do match in correct order (longest first)" do
-    PageTitleHelper.interpolates(:foobar) { "foobar" }
-    PageTitleHelper.interpolates(:foobar_test) { "foobar_test" }
-    PageTitleHelper.interpolates(:title_foobar) { "title_foobar" }
+        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
+      should "interpolate in correct order, i.e. longest first" do
+        PageTitleHelper.interpolates(:foobar) { "foobar" }
+        PageTitleHelper.interpolates(:foobar_test) { "foobar_test" }
+        PageTitleHelper.interpolates(:title_foobar) { "title_foobar" }
-    assert_equal "title_foobar / foobar_test / foobar / foobar_x", PageTitleHelper::Interpolations.interpolate(":title_foobar / :foobar_test / :foobar / :foobar_x", nil)
-  end
-  test "setting title to 'foo' returns 'foo'" do
-    view = MockView.new
-    view.page_title { "foo" }
-    assert_equal 'foo - Page title helper', view.page_title
-  end
-  test "reading defaults from I18n" do
-    view = MockView.new 'contacts/list.html.erb'
-    assert_equal 'contacts.list.title - Page title helper', view.page_title
-  end
-  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 "Some app", view.page_title(:app => 'Some app', :format => :app)
-  end
-  test "custom formatting options" do
-    view = MockView.new
-    view.page_title { "test" }
+        assert_equal "title_foobar / foobar_test / foobar / foobar_x", PageTitleHelper::Interpolations.interpolate(":title_foobar / :foobar_test / :foobar / :foobar_x", nil)
+      end
+    end
+    context "#page_title (define w/ block)" do
+      should "return title from block and render with app name" do
+        assert_equal 'foo', @view.page_title { "foo" }
+        assert_equal 'foo - Page title helper', @view.page_title
+      end
+      should "set custom title using a translation with a placeholder" do
+        assert_equal "Displaying Bella", @view.page_title { I18n.t(:placeholder, :name => 'Bella') }
+        assert_equal "Displaying Bella - Page title helper", @view.page_title
+      end
+    end
-    assert_equal "Some app :: test", view.page_title(:app => "Some app", :format => ':app :: :title')
-    assert_equal "Some app / test", view.page_title(:format => 'Some app / :title')
-  end
-  test "return value of block to be used as heading" do
-    view = MockView.new
-    assert_equal "untitled", view.page_title { "untitled" }
-  end
-  test "calling :format => false returns just current title, without any interpolations etc." do
-    view = MockView.new
-    view.page_title { "untitled" }
-    assert_equal "untitled", view.page_title(:format => false)
+    context "#page_title! (define)" do
+      should "set page title" do
+        assert_equal 'test', @view.page_title!('test')
+        assert_equal 'test - Page title helper', @view.page_title
+      end
+      should "set page title and interpret second argument as custom format" do
+        PageTitleHelper.formats[:bang] = ":title !! :app"
+        assert_equal 'test', @view.page_title!('test', :bang)
+        assert_equal 'test !! Page title helper', @view.page_title
+      end
+    end
-    i18n_view = MockView.new 'contacts/list.html.erb'
-    assert_equal "contacts.list.title", i18n_view.page_title(:format => false)
-  end
-  test "custom title using a translation with a placeholder" do
-    view = MockView.new
-    view.page_title { I18n.t :placeholder, :name => 'Bella' }
-    assert_equal "Displaying Bella - Page title helper", 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 "Default - Page title helper", 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 'Some default - Page title helper', 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 'Other default - Page title helper', 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 'custom contacts title - Page title helper', view.page_title(:suffix => :page_title)
+    context "#page_title (rendering)" do
+      should "read default title from I18n, based on template" do
+        assert_equal 'contacts.list.title - Page title helper', @view.page_title
+      end
+      should "only print app name if :format => :app" do
+        assert_equal 'Page title helper', @view.page_title(:format => :app)
+      end
+      should "print custom app name if :app defined and :format => :app" do
+        assert_equal "Some app", @view.page_title(:app => 'Some app', :format => :app)
+      end
+      should "use custom format, if :format option is defined" do
+        assert_equal 'test', @view.page_title { "test" }
+        assert_equal "Some app :: test", @view.page_title(:app => "Some app", :format => ':app :: :title')
+        assert_equal "Some app / test", @view.page_title(:format => 'Some app / :title')
+      end
+      should "return just title if :format => false is passed" do
+        assert_equal 'untitled', @view.page_title { "untitled" }
+        assert_equal "untitled", @view.page_title(:format => false)
+      end
+      should "return title if :format => false and when using the DRY-I18n titles" do
+        assert_equal "contacts.list.title", @view.page_title(:format => false)
+      end
+      should "render translated :'app.tagline' if no title is available" do
+        mock(@view).template { ActionView::Template.new('view/does/not_exist.html.erb') }
+        assert_equal "Default - Page title helper", @view.page_title
+      end
+      should "render custom 'default' string, if title is not available" do
+        mock(@view).template { ActionView::Template.new('view/does/not_exist.html.erb') }
+        assert_equal 'Some default - Page title helper', @view.page_title(:default => 'Some default')
+      end
+      should "render custom default translation, if title is not available" do
+        mock(@view).template { ActionView::Template.new('view/does/not_exist.html.erb') }
+        assert_equal 'Other default - Page title helper', @view.page_title(:default => :'app.other_tagline')
+      end
+      should "render auto-title using custom suffix 'page_title'" do
+        assert_equal 'custom contacts title - Page title helper', @view.page_title(:suffix => :page_title)
+      end
+      should "work with other template engines, like HAML" do
+        mock(@view).template { ActionView::Template.new('contacts/myhaml.html.haml') }
+        assert_equal 'this is haml! - Page title helper', @view.page_title
+      end
+    end
   end
-  test "ensure that it works with other template engines, like .html.haml" do
-    view = MockView.new('contacts/myhaml.html.haml')
-    assert_equal 'this is haml! - Page title helper', view.page_title
-  end
 end

data/test/test_helper.rb CHANGED Viewed

@@ -1,8 +1,9 @@
 require 'rubygems'
 require 'active_support'
 require 'action_view'
+require File.join(File.dirname(__FILE__), '..', 'rails', 'init')
-unless Object.const_defined?('IRB')
+unless defined?(IRB)
   require 'active_support/test_case'
   require 'shoulda'
   require 'rr'

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_title_helper
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Lukas Westermann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-11 00:00:00 +01:00
+date: 2009-11-20 00:00:00 +01:00
 default_executable:
 dependencies: []
@@ -28,12 +28,10 @@ files:
 - README.md
 - Rakefile
 - VERSION.yml
-- init.rb
 - lib/page_title_helper.rb
-- page_title_helper.gemspec
+- rails/init.rb
 - test/en.yml
 - test/en_wohaapp.yml
-- test/mocks.rb
 - test/multiple_formats_test.rb
 - test/page_title_helper_test.rb
 - test/test_helper.rb
@@ -66,7 +64,6 @@ signing_key:
 specification_version: 3
 summary: Simple, internationalized and DRY page titles and headings for rails.
 test_files:
-- test/mocks.rb
 - test/multiple_formats_test.rb
 - test/page_title_helper_test.rb
 - test/test_helper.rb

data/init.rb DELETED Viewed

	@@ -1 +0,0 @@
1	- require File.join(File.dirname(__FILE__), 'lib', 'page_title_helper')

data/page_title_helper.gemspec DELETED Viewed

@@ -1,56 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-Gem::Specification.new do |s|
-  s.name = %q{page_title_helper}
-  s.version = "0.7.1"
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Lukas Westermann"]
-  s.date = %q{2009-11-11}
-  s.email = %q{lukas.westermann@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION.yml",
-     "init.rb",
-     "lib/page_title_helper.rb",
-     "page_title_helper.gemspec",
-     "test/en.yml",
-     "test/en_wohaapp.yml",
-     "test/mocks.rb",
-     "test/multiple_formats_test.rb",
-     "test/page_title_helper_test.rb",
-     "test/test_helper.rb"
-  ]
-  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.5}
-  s.summary = %q{Simple, internationalized and DRY page titles and headings for rails.}
-  s.test_files = [
-    "test/mocks.rb",
-     "test/multiple_formats_test.rb",
-     "test/page_title_helper_test.rb",
-     "test/test_helper.rb"
-  ]
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end

data/test/mocks.rb DELETED Viewed

@@ -1,20 +0,0 @@
-class MockRender
-  def initialize(template_path = 'contacts/index.html.erb')
-    @template_path = template_path
-  end
-  def template_path; @template_path; end
-end
-class MockView
-  include PageTitleHelper
-  def initialize(template_path = 'contacts/index.html.erb')
-    @_first_render = MockRender.new template_path
-  end
-  def content_for(sym, &block)
-    instance_variable_set('@content_for_' + sym.to_s, yield)
-  end
-  def controller; nil; end
-end