title 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03f9667e1be4fe850bb8d230b5a564eca382c5e5
-  data.tar.gz: 6151b9dd9a956ef25ffd803f5d65613480c72148
+SHA256:
+  metadata.gz: a5223d4bc45bb6bde8e268cb533e675a4a77628b85518151e10d1033f20ef341
+  data.tar.gz: 9fc368e00d9242fad23bba51657b34e46c54b436c9cc48a54de4abd8c304ad3a
 SHA512:
-  metadata.gz: 22c49852733852b6a395f569f65965db25d04607784eee8f2788c5eeab2a3a58f21eac4b016413165f6cebb03a2461a7b31b3c81d07ce173f0722456831b80c2
-  data.tar.gz: f23398d952d9941c116badc046e8a6003b71837637039b32de85abdabca4dc7dc62a90f963865b5772191a4e259d20b63b0147345a6d22006acd28a5f9b28010
+  metadata.gz: f1ea8d9d9b5eb0cfc566a497e06d09e3bfcfa7cd8a617134c7da91bb84e67b3bf6c57bcdd1b2654a52f2dcb9eea34e7e8b358eee0cd7e26131ef5b8cf8b22052
+  data.tar.gz: 1546ca41e1d44809a45685d846f6de98c42aea2a510218e3aae726a3508fa71209c0fce39006d3cec5910940788aeafc886dcef79405532f0628c142c9b01f3f

data/README.md

@@ -1,5 +1,9 @@
 # Title
 
+[![Build Status](https://travis-ci.org/calebthompson/title.svg)](https://travis-ci.org/calebthompson/title)
+[![Code Climate](https://codeclimate.com/github/calebthompson/title.svg)](https://codeclimate.com/github/calebthompson/title)
+[![Coverage Status](https://coveralls.io/repos/calebthompson/title/badge.svg)](https://coveralls.io/r/calebthompson/title)
+
 Translations for \<title\>s!
 
 ## Usage
@@ -9,6 +13,8 @@ Add to your translations:
 ```yaml
 en:
   titles:
+    # titles.application defaults to the sigficant portion of
+    # AppName::Application, which would be:
     application: AppName
     dashboards:
       show: Dashboard
@@ -31,6 +37,19 @@ def to_s
 end
 ```
 
+You can pass additional values to the `#title` helper, which can be referenced
+in your translations:
+
+```erb
+<title><%= title(user_name: current_user.name) %></title>
+```
+
+```yaml
+en:
+  titles:
+    application: '%{user_name} - AppName'
+```
+
 ## Acknowledgement
 
 Though the idea of translating titles was arrived at seperately, [Brandon

data/Rakefile

@@ -1 +1,7 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: :rspec
+task release: :rspec

data/app/helpers/title/title_helper.rb

@@ -1,20 +1,21 @@
 module Title
   module TitleHelper
-    def title
-      PageTitle.new(controller_path, action_name, controller.view_assigns.symbolize_keys).to_s
+    def title(additional_context = {})
+      context = controller.view_assigns.merge(additional_context).symbolize_keys
+      PageTitle.new(controller_path, action_name, context).to_s
     end
 
     class PageTitle
       def initialize(controller_path, action_name, context)
         @controller_path = controller_path
-        @action_name = action_name
+        @action_name = adjusted_action_name(action_name)
         @context = context
       end
 
       def to_s
         I18n.t(
           [:titles, controller_name, action_name].join('.'),
-          context.merge(default: [application_title, guess_title])
+          **safe_context.merge(default: defaults)
         )
       end
 
@@ -30,9 +31,38 @@ module Title
         Rails.application.class.to_s.split('::').first
       end
 
+      def defaults
+        default_keys_in_lookup_path + [application_title, guess_title]
+      end
+
       def controller_name
         controller_path.gsub('/', '.')
       end
+
+      def default_keys_in_lookup_path
+        defaults = []
+        lookup_path = controller_name.split('.')
+        while lookup_path.length > 0
+          defaults << ['titles', *lookup_path, 'default'].join('.').to_sym
+          lookup_path.pop
+        end
+        defaults.reverse
+      end
+
+      def adjusted_action_name(action_name)
+        case action_name
+        when 'create'
+          'new'
+        when 'update'
+          'edit'
+        else
+          action_name
+        end
+      end
+
+      def safe_context
+        context.except(*I18n::RESERVED_KEYS)
+      end
     end
   end
 end

data/lib/title.rb

@@ -1,3 +1,6 @@
+app = File.expand_path('../../app', __FILE__)
+$LOAD_PATH.unshift(app) unless $LOAD_PATH.include?(app)
+
 require 'title/version'
 require 'rails/engine'
 require 'title/engine'

data/lib/title/version.rb

@@ -1,3 +1,3 @@
 module Title
-  VERSION = '0.0.3'
+  VERSION = '0.0.8'
 end

data/spec/helpers/title_helper_spec.rb

@@ -1,4 +1,6 @@
-require 'rubygems'
+require 'coveralls'
+Coveralls.wear!
+
 require 'title'
 
 describe Title::TitleHelper do
@@ -15,6 +17,14 @@ describe Title::TitleHelper do
     expect(helper.title).to eq('Not Dummy')
   end
 
+  it 'uses a :default key at an arbitrary point in the lookup path' do
+    stub_rails
+    stub_controller_and_action('engine/users', :show)
+    load_translations(engine: { default: 'Engine name' })
+
+    expect(helper.title).to eq 'Engine name'
+  end
+
   it 'matches controller/action to translation and uses that title' do
     stub_rails
     stub_controller_and_action(:dashboards, :show)
@@ -27,20 +37,39 @@ describe Title::TitleHelper do
     stub_rails
     stub_controller_and_action(:users, :show)
     load_translations(users: { show: '%{name}' })
-    helper.stub_chain(:controller, :view_assigns, :symbolize_keys).and_return({ name: 'Caleb' })
+    allow(helper).to receive_message_chain(:controller, :view_assigns).and_return('name' => 'Caleb')
 
     expect(helper.title).to eq('Caleb')
   end
 
+  it 'can accept a hash of extra context in addition to the view assigns' do
+    stub_rails
+    stub_controller_and_action(:users, :show)
+    load_translations(users: { show: '%{greeting} %{name}' })
+    allow(helper).to receive_message_chain(:controller, :view_assigns).and_return('name' => 'Caleb')
+
+    expect(helper.title(greeting: 'Hello')).to eq('Hello Caleb')
+  end
+
+  it 'makes context safe to be passed as interpolation options' do
+    stub_rails
+    stub_controller_and_action(:users, :show)
+    load_translations(users: { show: 'User' })
+    allow(helper).to receive_message_chain(:controller, :view_assigns).and_return('scope' => 'Foo')
+
+    expect(helper.title).to eq('User')
+  end
+
   def stub_rails
-    helper.stub(:controller_path).and_return('dashboards')
-    helper.stub(:action_name)
-    helper.stub_chain(:controller, :view_assigns, :symbolize_keys).and_return({})
-    Rails.stub_chain(:application, :class).and_return('Dummy::Application')
+    allow(helper).to receive(:controller_path).and_return('dashboards')
+    allow(helper).to receive(:action_name)
+    allow(helper).to receive_message_chain(:controller, :view_assigns).and_return({})
+    allow(Rails).to receive_message_chain(:application, :class).and_return('Dummy::Application')
   end
 
   def stub_controller_and_action(controller, action)
-    helper.stub(controller_path: controller.to_s, action_name: action.to_s)
+    allow(helper).to receive(:controller_path).and_return(controller.to_s)
+    allow(helper).to receive(:action_name).and_return(action.to_s)
   end
 
   def helper

data/title.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
 
   spec.add_dependency 'rails', '>= 3.1'
   spec.add_dependency 'i18n'

metadata

@@ -1,83 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: title
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Caleb Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Abuses I18n to set HTML <title>s
@@ -87,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -110,17 +138,16 @@ require_paths:
 - app
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: I18n your <title>s