page_title_helper 1.0.1 → 5.0.0

data/Rakefile

@@ -1,24 +1,14 @@
-require 'rake'
+# frozen_string_literal: true
+
+require 'bundler/setup'
 require 'rake/testtask'
-require 'rake/rdoctask'
-require 'yard'
 
-desc 'Default: run unit tests.'
-task :default => :test
+include Rake::DSL
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "page_title_helper"
-    gemspec.summary = "Simple, internationalized and DRY page titles and headings for rails."
-    gemspec.email = "lukas.westermann@gmail.com"
-    gemspec.homepage = "http://github.com/lwe/page_title_helper"
-    gemspec.authors = ["Lukas Westermann"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task default: :test
 
 desc 'Test the page_title_helper plugin.'
 Rake::TestTask.new(:test) do |t|
@@ -26,47 +16,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
-
-desc 'Generate documentation for gravatarify. (requires yard)'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = ['lib/**/*.rb']
-  t.options = [
-      "--readme", "README.md",
-      "--title", "page_title_helper API Documentation"
-  ]
-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'
-    dirs = {
-      'Libraries' => 'lib',
-      'Unit tests' => 'test'
-    }.map { |name,dir| [name, File.join(File.dirname(__FILE__), dir)] }
-    CodeStatistics.new(*dirs).to_s
-  end
-  
-  desc 'Report code coverage to HTML (doc/coverage) and shell (requires rcov).'
-  task :coverage do |t|
-    rm_f "doc/coverage"
-    mkdir_p "doc/coverage"
-    rcov = %(rcov -Ilib:test --exclude '\/gems\/' -o doc/coverage -T test/*_test.rb )
-    system rcov
-  end
-end
-
-desc 'Start IRB console with loaded test/test_helper.rb and PageTitleHelper.'
-task :console do |t|
-  chdir File.dirname(__FILE__)
-  exec 'irb -Ilib -r test/test_helper.rb -r page_title_helper'
-end
-
-desc 'Clean up generated files.'
-task :clean do |t|
-  FileUtils.rm_rf "doc"
-  FileUtils.rm_rf "pkg"
-end

data/lib/page_title_helper.rb

@@ -1,104 +1,108 @@
+# frozen_string_literal: true
+
 # 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)
+# Licence:: MIT-Licence (https://www.opensource.org/licenses/mit-license.php)
 #
 # See documentation for +page_title+ for usage examples and more informations.
+require 'active_support'
 
 # PageTitleHelper
 module PageTitleHelper
-
-  # http://github.com/thoughtbot/paperclip/blob/master/lib/paperclip/interpolations.rb
+  # https://github.com/thoughtbot/paperclip/blob/master/lib/paperclip/interpolations.rb
   module Interpolations
-    # Represents the environment which is passed into each interpolation call.
-    class TitleEnv < ::Struct.new(:options, :view, :controller, :title); end
-    
     extend self
-    
+
     def self.interpolate(pattern, *args)
       instance_methods(false).sort.reverse.inject(pattern.to_s.dup) do |result, tag|
-        result.gsub(/:#{tag}/) do |match|
+        result.gsub(/:#{tag}/) do |_match|
           send(tag, *args)
         end
       end
     end
-    
+
     def app(env)
-      env.options[:app] || I18n.translate(:'app.name', :default => File.basename(RAILS_ROOT).humanize)
+      env[:app] || I18n.translate('app.name', default: File.basename(Rails.root).humanize)
     end
-    
+
     def title(env)
-      env.title
+      env[:title]
     end
   end
-  
+
   # Add new, custom, interpolation.
   def self.interpolates(key, &block)
     Interpolations.send(:define_method, key, &block)
   end
-  
+
   # Default options, which are globally referenced and can
   # be changed globally, which might be useful in some cases.
   def self.options
     @options ||= {
-      :format => :default,
-      :default => :'app.tagline',
-      :suffix => :title
+      format: :default,
+      default: :'app.tagline'
     }
   end
-  
+
   # Defined alias formats, pretty useful.
   def self.formats
     @formats ||= {
-      :app => ":app",
-      :default => ':title - :app',
-      :title => ":title"
+      app: ':app',
+      default: ':title - :app',
+      title: ':title'
     }
   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)
+
+  def page_title(options = nil)
     return page_title!(yield) if block_given? # define title
-        
+
     options = PageTitleHelper.options.merge(options || {}).symbolize_keys!
     options[:format] ||= :title # handles :format => false
-    options.assert_valid_keys(:app, :suffix, :default, :format)
-    
-    # construct basic env to pass around
-    env = Interpolations::TitleEnv.new(options, self, self.controller)
-    
+    options.assert_valid_keys(:app, :default, :format)
+
     # read page title and split into 'real' title and customized format
-    env.title = @_page_title || I18n.translate(i18n_template_key(options[:suffix]), :default => options[:default])
-    env.title, options[:format] = *(env.title << options[:format]) if env.title.is_a?(Array)
-    
+    title = @_page_title ||= page_title_from_translation(options[:default])
+    title, options[:format] = *(title << options[:format]) if title.is_a?(Array)
+
     # handle format aliases
-    format = options[:format]
-    format = PageTitleHelper.formats[format] if PageTitleHelper.formats.include?(format)
-    
+    format = options.delete(:format)
+    if PageTitleHelper.formats.include?(format)
+      format = PageTitleHelper.formats[format]
+    end
+
+    # construct basic env to pass around
+    env = { title: title, app: options.delete(:app), options: options, view: self }
+
     # interpolate format
-    Interpolations.interpolate format, env
+    Interpolations.interpolate(format, env)
   end
-  
+
   protected
-  
-    # Find current title key based on currently rendering template.
-    #
-    # 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 i18n_template_key(suffix = nil)
-      @_first_render.template_path.gsub(/\.[^\/]*\Z/, '').tr('/', '.') + (suffix.present? ? ".#{suffix}" : "")
+
+    # Find translation for `controller.action.title` combination, falls back to
+    # `controller.title` or supplied default if no title was found.
+    def page_title_from_translation(default)
+      base = controller.controller_path.tr('/', '.')
+      action = params[:action].to_s
+
+      keys = [:"#{base}.#{action}.title"]
+      keys << :"#{base}.new.title" if action == 'create'
+      keys << :"#{base}.edit.title" if action == 'update'
+      keys << :"#{base}.title"
+      keys << default
+
+      I18n.translate(keys.shift, default: keys)
     end
-end
+end
+
+# include helper methods in ActionView
+ActiveSupport.on_load(:action_view) { include PageTitleHelper }

data/lib/page_title_helper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PageTitleHelper
+  VERSION = '5.0.0'
+end

data/page_title_helper.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'page_title_helper/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'page_title_helper'
+  s.version     = PageTitleHelper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = 'Simple, internationalized and DRY page titles and headings for Rails.'
+  s.description = 'Simple, internationalized and DRY page titles and headings for Rails.'
+
+  s.required_ruby_version = '>= 2.5.0'
+
+  s.authors  = ['Lukas Westermann']
+  s.email    = ['lukas.westermann@gmail.com']
+  s.homepage = 'https://github.com/lwe/page_title_helper'
+
+  s.files            = %w{Gemfile LICENSE README.md CODE_OF_CONDUCT.md CHANGELOG.md Rakefile page_title_helper.gemspec} + Dir['**/*.{rb,yml}']
+  s.test_files       = s.files.grep(%r{^(test|spec)/})
+  s.require_path     = 'lib'
+
+  s.license          = 'MIT'
+
+  s.add_dependency 'rails', '>= 5.2.0', '< 6.2'
+
+  s.add_development_dependency 'rake', '>= 10.3.2'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'rubocop', '~> 0.82.0'
+  s.add_development_dependency 'rubocop-rails', '~> 2.5.2'
+end

data/test/en.yml

@@ -5,7 +5,17 @@ en:
       page_title: custom contacts title
     myhaml:
       title: this is haml!
-  placeholder: Displaying {{name}}
+  admin:
+    account:
+      title: Account administration
+      show:
+        title: Account
+      new:
+        title: New account
+      edit:
+        title: Edit account
+        
+  placeholder: "Displaying %{name}"
   app:
     tagline: Default
     other_tagline: Other default

data/test/multiple_formats_test.rb

@@ -1,73 +1,73 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
 require 'test_helper'
-require 'page_title_helper'
 
-class MultipleFormatsTest < ActiveSupport::TestCase  
-  context "#page_title supporting multiple formats through arrays" do
+class MultipleFormatsTest < ActiveSupport::TestCase
+  context '#page_title supporting multiple formats through arrays' do
     setup do
-      @view = ActionView::Base.new
-      @view.template = ActionView::Template.new "contacts/list.html.erb"      
+      @view = TestView.new('contacts', 'list')
     end
-    
-    should "accept an array passed in the page_title block and use the second argument as format" do
-      @view.page_title { ["Oh my...!", ":title // :app"] }
-      assert_equal "Oh my...! // Page title helper", @view.page_title
+
+    should 'accept an array passed in the page_title block and use the second argument as format' do
+      @view.page_title { ['Oh my...!', ':title // :app'] }
+      assert_equal 'Oh my...! // Page title helper', @view.page_title
     end
-    
-    should "still return title as string and not the array" do
-      assert_equal "Oh my...!", @view.page_title { ["Oh my...!", ":title // :app"] }
+
+    should 'still return title as string and not the array' do
+      assert_equal('Oh my...!', @view.page_title { ['Oh my...!', ':title // :app'] })
     end
   end
-  
-  context "#page_title with format aliases" do
+
+  context '#page_title with format aliases' do
     setup do
-      PageTitleHelper.formats[:myformat] = ":title <-> :app"      
-      @view = ActionView::Base.new
-      @view.template = ActionView::Template.new "contacts/list.html.erb"      
+      PageTitleHelper.formats[:myformat] = ':title <-> :app'
+      @view = TestView.new('contacts', 'list')
     end
-    
-    should "have a default alias named :app" do
-      assert_equal "Page title helper", @view.page_title(:format => :app)      
+
+    should 'have a default alias named :app' do
+      assert_equal 'Page title helper', @view.page_title(format: :app)
     end
-    
-    should "allow custom aliases to be defined and used" do
-      @view.page_title { "Test" }
-      assert_equal "Test <-> Page title helper", @view.page_title(:format => :myformat)
+
+    should 'allow custom aliases to be defined and used' do
+      @view.page_title { 'Test' }
+      assert_equal 'Test <-> Page title helper', @view.page_title(format: :myformat)
     end
-        
-    should "fallback to default format, if array is not big enough (i.e. only contains single element...)" do
-      assert_equal "Test", @view.page_title { ["Test"] }
-      assert_equal "Test - Page title helper", @view.page_title
+
+    should 'fallback to default format, if array is not big enough (i.e. only contains single element...)' do
+      assert_equal('Test', @view.page_title { ['Test'] })
+      assert_equal 'Test - Page title helper', @view.page_title
     end
-    
-    context "used with the array block" do
-      should "also allow aliases returned in that array thingy" do
-        assert_equal "Test", @view.page_title { ["Test", :myformat] }
-        assert_equal "Test <-> Page title helper", @view.page_title
-      end 
-            
-      should "override locally supplied :format arguments" do
-        assert_equal "Something", @view.page_title { ["Something", "* * * :title * * *"] }
-        assert_equal "* * * Something * * *", @view.page_title(:format => "-= :title =-") # yeah, using x-tra ugly titles :)
+
+    context 'used with the array block' do
+      should 'also allow aliases returned in that array thingy' do
+        assert_equal('Test', @view.page_title { ['Test', :myformat] })
+        assert_equal 'Test <-> Page title helper', @view.page_title
+      end
+
+      should 'override locally supplied :format arguments' do
+        assert_equal('Something', @view.page_title { ['Something', '* * * :title * * *'] })
+        assert_equal '* * * Something * * *', @view.page_title(format: '-= :title =-') # yeah, using x-tra ugly titles :)
       end
     end
   end
-  
-  context "#page_title, aliases and YAML" do
+
+  context '#page_title, aliases and YAML' do
     setup do
-      I18n.load_path = [File.join(File.dirname(__FILE__), "en_wohaapp.yml")]
+      I18n.load_path = [File.join(File.dirname(__FILE__), 'en_wohaapp.yml')]
       I18n.reload!
-      PageTitleHelper.formats[:promo] = ":app > :title"
-      @view = ActionView::Base.new
+      PageTitleHelper.formats[:promo] = ':app > :title'
+      @view = TestView.new
     end
-    
-    should "allow to overide format through YAML" do
-      @view.template = 'pages/features.html.haml'
+
+    should 'allow to overide format through YAML' do
+      @view.controller! 'pages', 'features'
       assert_equal 'Wohaapp > Feature comparison', @view.page_title
     end
-    
-    should "handle raw string formats from YAML as well" do
-      @view.template = 'pages/signup.html.haml'
+
+    should 'handle raw string formats from YAML as well' do
+      @view.controller! 'pages', 'signup'
       assert_equal 'Sign up for Wohaapp now!', @view.page_title
     end
   end
-end
+end

data/test/page_title_helper_test.rb

@@ -1,117 +1,135 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
 require 'test_helper'
-require 'page_title_helper'
-require 'ostruct'
 
 class PageTitleHelperTest < ActiveSupport::TestCase
-  context "PageTitleHelper" do
+  context 'PageTitleHelper' do
     setup do
       I18n.load_path = [File.join(File.dirname(__FILE__), 'en.yml')]
       I18n.reload!
-    
-      @view = ActionView::Base.new
-      @view.template_path = "contacts/list.html.erb"
+
+      @view = TestView.new('contacts', 'list')
     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'}))
+
+    context '::Interpolations' do
+      should 'interpolate :app and :title' do
+        assert_equal 'Page title helper', PageTitleHelper::Interpolations.app({})
+        assert_equal 'Appname', PageTitleHelper::Interpolations.app(app: 'Appname')
+        assert_equal 'untitled', PageTitleHelper::Interpolations.title(title: 'untitled')
       end
 
-      should "allow adding custom interpolations" do
+      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' }))
+
+        assert_equal 'anna', PageTitleHelper::Interpolations.app_reverse(app: 'Anna')
+        assert_equal 'ppa', PageTitleHelper::Interpolations.interpolate(':app_reverse', 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)
+      should 'interpolate in correct order, i.e. longest first' do
+        PageTitleHelper.interpolates(:foobar) { |_env| 'foobar' }
+        PageTitleHelper.interpolates(:foobar_test) { |_env| 'foobar_test' }
+        PageTitleHelper.interpolates(:title_foobar) { |_env| 'title_foobar' }
+
+        assert_equal 'title_foobar / foobar_test / foobar / foobar_x', PageTitleHelper::Interpolations.interpolate(':title_foobar / :foobar_test / :foobar / :foobar_x', {})
       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" }
+
+    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      
+      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
-    
-    context "#page_title! (define)" do
-      should "set page title" do
+
+    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"
+      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
     end
-    
-    context "#page_title (rendering)" do
-      should "read default title from I18n, based on template" do
+
+    context '#page_title (rendering)' do
+      should 'read default title from I18n, based on controller/action' 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)
+
+      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 "print custom app name if :app defined and :format => :app" do
-        assert_equal "Some app", @view.page_title(:app => 'Some app', :format => :app)
+      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 "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')
+      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 "return just title if :format => false is passed" do
-        assert_equal 'untitled', @view.page_title { "untitled" }
-        assert_equal "untitled", @view.page_title(:format => false)
+      should 'render translated :"app.tagline" if no title is available' do
+        @view.controller! 'view/does', 'not_exist'
+        assert_equal 'Default - Page title helper', @view.page_title
       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)
+
+      should 'render use controller.title as first fallback, if no title exists' do
+        @view.controller! 'admin/account', 'index'
+        assert_equal 'Account administration - Page title helper', @view.page_title(default: 'Other default')
       end
-        
-      should "render translated :'app.tagline' if no title is available" do
-        @view.template_path = 'view/does/not_exist.html.erb'
-        assert_equal "Default - Page title helper", @view.page_title
+
+      should 'not fallback to controller.title if controller.action.title exists' do
+        @view.controller! 'admin/account', 'show'
+        assert_equal 'Account - Page title helper', @view.page_title(default: 'Other default')
       end
 
-      should "render custom 'default' string, if title is not available" do
-        @view.template_path = 'view/does/not_exist.html.erb'
-        assert_equal 'Some default - Page title helper', @view.page_title(:default => 'Some default')
+      should 'fallback to controller.new.title if create has no title' do
+        @view.controller! 'admin/account', 'create'
+        assert_equal 'New account - Page title helper', @view.page_title(default: 'Other default')
       end
 
-      should "render custom default translation, if title is not available" do
-        @view.template_path = 'view/does/not_exist.html.erb'
-        assert_equal 'Other default - Page title helper', @view.page_title(:default => :'app.other_tagline')
+      should 'fallback to controller.edit.title if update has no title' do
+        @view.controller! 'admin/account', 'update'
+        assert_equal 'Edit account - Page title helper', @view.page_title(default: 'Other default')
       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)
+      should 'render custom "default" string, if title is not available nor controller.title' do
+        @view.controller! 'view/does', 'not_exist'
+        assert_equal 'Some default - Page title helper', @view.page_title(default: 'Some default')
+      end
+
+      should 'render custom default translation, if title is not available nor controller.title' do
+        @view.controller! 'view/does', 'not_exist'
+        assert_equal 'Other default - Page title helper', @view.page_title(default: :'app.other_tagline')
+      end
+    end
+
+    context 'README.md' do
+      should 'interpolate :controller' do
+        PageTitleHelper.interpolates(:controller) { |env| env[:view].controller.controller_name.humanize }
+        assert_equal 'contacts.list.title - Test', @view.page_title(format: ':title - :controller')
       end
-      
-      should "work with other template engines, like HAML" do
-        @view.template_path = 'contacts/myhaml.html.haml'
-        assert_equal 'this is haml! - Page title helper', @view.page_title
-      end      
     end
   end
 end