page_title_helper 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55bc102d2aea4e7249455a1ee2a3abe10dad47f5ecaa17696267c99bb8f13296
-  data.tar.gz: 50e4677933206d1ef885bee27ed399ae66d4a9042fc62ab0334bbd2914f92684
+  metadata.gz: 83ca84d323ad19f09e49b6ee6333f2cd3c06f0e2e3f8748b8081a204fdebc4ac
+  data.tar.gz: 4c9affff4ee6f51d0dfccb906ec4406e5a50032da651fcc92be19603368741e0
 SHA512:
-  metadata.gz: a7b5d88320875d15e43d63a91e7af8ef923b7c1b2e7ece2c7496ccfb09d31a357297fad26099acf05b2b41ad99f7b650b6ebb652401d9b9741fb56c0f4d355a7
-  data.tar.gz: 830f6bd1d4ae042df641589cd5c2a6755031688fc9ddf05f81c2f23e49e61df9ecaa765888c044fbebaaee7b48b2798437cbfaa3b2367f16e73e4210da297e93
+  metadata.gz: 19879f1e33647398e8d15ee0b3adbaacd29a6645fd89b33838fddf11f469a577abf2467a368f6b352e61ad4db8fc71f0ac4f5e918112b16c59ab84751bfca0a2
+  data.tar.gz: c28883f1bd9cefd68c8f121b4caced4bd946ffec08d5e10f4e33f8a6008ed825132886362b97afa36a642ce05e02b22182899743daeb56515962e24ac9e51fdd

data/CHANGELOG.md

@@ -6,7 +6,6 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 Read more at [Keep a CHANGELOG](https://keepachangelog.com/en/0.3.0/)
 about why a change log is important.
 
-
 ## x.y.z
 
 ### Added
@@ -21,68 +20,60 @@ about why a change log is important.
 
 ### Security
 
+## 5.0.0
+
+### Added
+- Add support for Ruby 3 (#120)
+- Add automatic gem release (#122)
+- Add support for Rails 6.1 (#113, #114)
+- Officially support Ruby 2.7 (#103)
+
+### Removed
+- Drop support for Ruby 2.4 (#109)
+- Drop support for Rails < 5.2 (#104)
+
+### Fixed
+- Use a better-maintained Ruby setup for the CI (#121)
+- Fix warnings in the `.travis.yml` (#106)
+
 ## 4.0.0
 
 ### Added
-- Add support for Rails 6.0
-  ([#94](https://github.com/lwe/page_title_helper/pull/94))
+- Add support for Rails 6.0 (#94)
 
 ### Removed
-- Drop support for Ruby < 2.4
-  ([#93](https://github.com/lwe/page_title_helper/pull/93))
+- Drop support for Ruby < 2.4 (#93)
 
 ## 3.0.0
 
 ### Added
-- Add Ruby 2.4.0 to the build matrix
-  ([#68](https://github.com/lwe/page_title_helper/pull/68))
-- Add a CHANGELOG.md
-  ([#59](https://github.com/lwe/page_title_helper/pull/59))
-- Add RuboCop checking to the CI
-  ([#52](https://github.com/lwe/page_title_helper/pull/52))
-- Add a CODE_OF_CONDUCT.md
-  ([#51](https://github.com/lwe/page_title_helper/pull/51))
-- Update Ruby to 2.3.3 and 2.2.6 on Travis
-  ([#38](https://github.com/lwe/page_title_helper/pull/38))
+- Add Ruby 2.4.0 to the build matrix (#68)
+- Add a CHANGELOG.md (#59)
+- Add RuboCop checking to the CI (#52)
+- Add a CODE_OF_CONDUCT.md (#51)
+- Update Ruby to 2.3.3 and 2.2.6 on Travis (#38)
 - Add Ruby 2.3.0 to the build matrix
-- Re-add Ruby 2.0.0 to the build matrix
-  ([#29](https://github.com/lwe/page_title_helper/pull/29))
+- Re-add Ruby 2.0.0 to the build matrix (#29)
 - Test against Ruby 2.2
-- Use Appraisal for building with different Rails versions
-  ([#19](https://github.com/lwe/page_title_helper/pull/19))
+- Use Appraisal for building with different Rails versions (#19)
 
 ### Changed
-- Replaced Appraisals with specific Gemfiles
-  ([#41](https://github.com/lwe/page_title_helper/pull/41))
-- Delete obsolete init.rb file
-  ([#61](https://github.com/lwe/page_title_helper/pull/61))
-- Add Rails 5.0 to the build matrix
-  ([#42](https://github.com/lwe/page_title_helper/pull/42))
-- Raise RVM and Gem minimum versions
-  ([#3](https://github.com/lwe/page_title_helper/pull/3))
+- Replaced Appraisals with specific Gemfiles (#41)
+- Delete obsolete init.rb file (#61)
+- Add Rails 5.0 to the build matrix (#42)
+- Raise RVM and Gem minimum versions (#3)
 
 ### Removed
-- Drop support for Rails 3.2 and 4.0
-  ([#39](https://github.com/lwe/page_title_helper/pull/39))
-- Drop support for Ruby 1.9.x
-  ([#24](https://github.com/lwe/page_title_helper/pull/24))
+- Drop support for Rails 3.2 and 4.0 (#39)
+- Drop support for Ruby 1.9.x (#24)
 
 ### Fixed
-- Fix @_page_title uninitialized warning
-  ([#62](https://github.com/lwe/page_title_helper/pull/62))
-- Fix the Travis build on Ruby 2.3.3
-  ([#63](https://github.com/lwe/page_title_helper/pull/63))
-- Do do not shell-out to `git` in Gemfile
-  ([#49](https://github.com/lwe/page_title_helper/pull/49))
-- Get the tests to run in Rails 4.2 and 5.0
-  ([#40](https://github.com/lwe/page_title_helper/pull/40))
-- Stop requiring version from the main class
-  ([#47](https://github.com/lwe/page_title_helper/pull/47))
-- Allow the Rails 3.2 build to fail only with Ruby 2.2
-  ([#30](https://github.com/lwe/page_title_helper/pull/30))
-- Allow Rails 3.2 builds to fail
-  ([#26](https://github.com/lwe/page_title_helper/pull/26))
-- Configure Travis for better performance
-  ([#10](https://github.com/lwe/page_title_helper/pull/10))
-- Remove Gemfile.lock
-  ([#1](https://github.com/lwe/page_title_helper/pull/1))
+- Fix @_page_title uninitialized warning (#62)
+- Fix the Travis build on Ruby 2.3.3 (#63)
+- Do do not shell-out to `git` in Gemfile (#49)
+- Get the tests to run in Rails 4.2 and 5.0 (#40)
+- Stop requiring version from the main class (#47)
+- Allow the Rails 3.2 build to fail only with Ruby 2.2 (#30)
+- Allow Rails 3.2 builds to fail (#26)
+- Configure Travis for better performance (#10)
+- Remove Gemfile.lock (#1)

data/README.md

@@ -1,202 +1,224 @@
 # Page title helper
 
-[![Build Status](https://travis-ci.org/lwe/page_title_helper.svg?branch=master)](https://travis-ci.org/lwe/page_title_helper)
+[![GitHub CI Status](https://github.com/lwe/page_title_helper/workflows/CI/badge.svg?branch=main)](https://github.com/lwe/page_title_helper/actions)
 [![Gem Version](https://badge.fury.io/rb/page_title_helper.svg)](https://badge.fury.io/rb/page_title_helper)
 
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-
 ## What does this gem do?
 
-Ever wondered if there was an easier and DRY-way to set your page titles (and/or headings),
-introducing _page title helper_, a small view helper for Rails 4.2 and 5
-to inflect titles from controllers and actions.
+Ever wondered if there was an easier and DRY-way to set your page titles
+(and/or headings), introducing _page title helper_, a small view helper for
+Rails to inflect titles from controllers and actions.
 
 In your layout, add this to your `<head>`-section:
 
-      ...
-      <title><%= page_title %></title>
-      ...
+```html
+<title><%= page_title %></title>
+```
 
 That's it. Now just add translations, in e.g. `config/locales/en.yml`:
 
-      en:
-        contacts:
-          index:
-            title: "Contacts"
+```yaml
+en:
+  contacts:
+    index:
+      title: "Contacts"
+```
 
 When `/contacts/` is requested, the key `:en, :contacts, :index, :title`
-is looked up and printed, together with the applications basename, like: `Contacts - My cool App`.
+is looked up and printed, together with the applications basename, like:
+`Contacts - My cool App`.
 The format etc. is of course configurable, just head down to the options.
 
 ## Installation
 
 As gem (from rubygems.org):
 
-    # then add the following line to Gemfile
-    gem 'page_title_helper'
+```ruby
+# then add the following line to Gemfile
+gem 'page_title_helper'
 
-    # living on the bleeding edge?
-    gem 'page_title_helper', git: 'git://github.com/lwe/page_title_helper.git'
+# living on the bleeding edge?
+gem 'page_title_helper', git: 'git://github.com/lwe/page_title_helper.git'
+```
 
 ## Translated titles
 
-All translated titles are inflected from the current controller and action, so to
-easily explain all lookups, here an example with the corresponding lookups:
+All translated titles are inflected from the current controller and action,
+so to easily explain all lookups, here an example with the corresponding
+lookups:
 
-    Admin::AccountController#index => :'admin.account.index.title'
-                                      :'admin.account.title'
-                                      options[:default]
+```
+Admin::AccountController#index => :'admin.account.index.title'
+                                  :'admin.account.title'
+                                  options[:default]
+```
 
-For `create` and `update` a further fallback to `new.title` and `edit.title` have
-been added, because they certainly are duplicates.
+For `create` and `update` a further fallback to `new.title` and `edit.title`
+have been added, because they certainly are duplicates.
 
 ## Customize titles
 
-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?
+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?
+
+```html
+<h1><%= page_title!(@contact.name) %></h1>
+```
 
-    <h1><%= 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:
 
-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:
+```html
+<% page_title!(@contact.name + " (" + @contact.company.name + ")") %>
+<h1><%= @contact.name %></h1>
+```
 
-    <% page_title!(@contact.name + " (" + @contact.company.name + ")") %>
-    <h1><%= @contact.name %></h1>
+Guess, that's it. Of course it's also possible to use `translate` within
+`page_title!`, to translate custom titles, like:
 
-Guess, that's it. Of course it's also possible to use `translate` within `page_title!`, to
-translate custom titles, like:
+In `config/locales/en.yml`:
 
-    # in config/locales/en.yml:
-    en:
-      dashboard:
-        index:
-          title: "Welcome back, {{name}}"
+```yaml
+en:
+  dashboard:
+    index:
+      title: "Welcome back, {{name}}"
+```
 
-    # in app/views/dashboard/index.html.erb:
-    <h1><%= page_title!(t('.title', name: @user.first_name)) %></h1>
+In `app/views/dashboard/index.html.erb`:
+```html
+<h1><%= page_title!(t('.title', name: @user.first_name)) %></h1>
+```
 
-## More fun with <tt>:format</tt>
+## More fun with <code>:format</code>
 
-The `:format` option is used to specify how a title is formatted, i.e. if the app name is
-prepended or appended or if it contains the account name etc. It uses a similar approach as
-paperclip's path interpolations:
+The `:format` option is used to specify how a title is formatted, i.e. if the
+app name is prepended or appended or if it contains the account name etc.
+It uses a similar approach as paperclip's path interpolations:
 
-    page_title format: ':title / :app' # => "Contacts / My cool app"
+```ruby
+page_title format: ':title / :app' # => "Contacts / My cool app"
+```
 
-Adding custom interpolations is as easy as defining a block, for example to access the current
-controller:
+Adding custom interpolations is as easy as defining a block, for example to
+access the current controller:
 
-    PageTitleHelper.interpolates :controller do |env|
-      env[:view].controller.controller_name.humanize
-    end
+```ruby
+PageTitleHelper.interpolates :controller do |env|
+  env[:view].controller.controller_name.humanize
+end
 
-    page_title format: ':title / :controller / :app' # => "Welcome back / Dashboard / My cool app"
+page_title format: ':title / :controller / :app' # => "Welcome back / Dashboard / My cool app"
+```
 
-To access just the title, without any magic app stuff interpolated or appended, use:
+To access just the title, without any magic app stuff interpolated or appended,
+use:
 
-    page_title! "untitled"
-    page_title format: false # => "untitled"
+```ruby
+page_title! "untitled"
+page_title format: false # => "untitled"
+```
 
 Need a custom format for a single title? Just return an array:
 
-    # in the view:
-    <h1><%= page_title!(@contact.name, ":title from :company - :app") %></h1> # => <h1>Franz Meyer</h1>
+In the view:
+
+```html
+<h1><%= page_title!(@contact.name, ":title from :company - :app") %></h1> # => <h1>Franz Meyer</h1>
+```
+
+In the `<head>`:
+
+```html
+<title><%= page_title %></title> # => this time it will use custom title like "Franz Meyer from ABC Corp. - My cool app"
+```
+
+To streamline that feature a bit and simplify reuse of often used formats,
+it's possible to define format aliases like:
 
-    # in the <head>
-    <title><%= page_title %></title> # => this time it will use custom title like "Franz Meyer from ABC Corp. - My cool app"
+In an initializer, e.g., `config/initializers/page_title_helper.rb`:
 
-To streamline that feature a bit and simplify reuse of often used formats, it's possible to define format aliases like:
+```ruby
+PageTitleHelper.formats[:with_company] = ":title from :company - :app"
+# show app first for promo pages :)
+PageTitleHelper.formats[:promo] = ":app - :title" 
+```
 
-    # in an initializer, e.g. config/initializers/page_title_helper.rb:
-    PageTitleHelper.formats[:with_company] = ":title from :company - :app"
-    PageTitleHelper.formats[:promo] = ":app - :title" # show app first for promo pages :)
+Then in the view to display a contact:
 
-    # then in the view to display a contact...
-    page_title! @contact.name, :with_company
+```ruby
+page_title! @contact.name, :with_company
+```
 
-    # ...or for the promo page via config/locales/en.yml (!)
-    en:
-      pages:
-        features:
-          title:
-            - "Features comparison"
-            - !ruby/sym promo
+Or for the promo page via `config/locales/en.yml` (!):
 
-Pretty, cool, ain't it? The special `format: :app` works also via the `formats` hash. Then there is also a
-`:default` format, which can be used to override the default format.
+```yaml
+en:
+  pages:
+    features:
+      title:
+        - "Features comparison"
+        - !ruby/sym promo
+```
+
+Pretty, cool, ain't it? The special `format: :app` works also via the `formats`
+hash. Then there is also a `:default` format, which can be used to override the
+default format.
 
 ## All options - explained
 
-<table>
-  <tr>
-    <th>Option</th><th>Description</th><th>Default</th><th>Values</th>
-  </tr>
-  <tr>
-    <td><tt>:app</tt></td>
-    <td>Specify the applications name, however it's
-        recommended to define it via translation key <tt>:'app.name'</tt>.</td>
-    <td>Inflected from <tt>Rails.root</tt></td>
-    <td>string</td>
-  </tr>
-  <tr>
-    <td><tt>:default</tt></td>
-    <td>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.</td>
-    <td><tt>:'app.tagline'</tt></td>
-    <td>string, symbol or array of those</td>
-  </tr>
-  <tr>
-    <td><tt>:format</tt></td>
-    <td>Defines the output format, accepts a string containing multiple interpolations, or
-        a symbol to a format alias, see <i>More fun with <tt>:format</tt></i>. If set to
-        +false+, just the current title is returned.</td>
-    <td><tt>:default</tt></td>
-    <td>string, symbol</td>
-  </tr>
-</table>
-</p>
-
-Options can be set globally via `PageTitleHelper.options`. Note, currently it only
-makes sense to set `:default` globally.
+| Option   | Description | Default | Values |
+|----------|-------------|---------|--------|
+|`:app`    | Specify the applications name, however it's recommended to define it via translation key `:'app.name'`. | Inflected from `Rails.root`| string |
+|`:default`| 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 `I18n.translate`'s `:default` option. | `'app.tagline'` | string, symbol or array of those |
+|`:format` | Defines the output format, accepts a string containing multiple interpolations, or a symbol to a format alias, see _More fun with `:format`_. If set to `false`, just the current title is returned. | `:default`| string, symbol |
+
+Options can be set globally via `PageTitleHelper.options`. Note, currently it
+only makes sense to set `:default` globally.
 
 To add or change formats use:
 
-    # change the default format used (if no format is specified):
-    PageTitleHelper.formats[:default] = ":title // :app"
+```ruby
+# change the default format used (if no format is specified):
+PageTitleHelper.formats[:default] = ":title // :app"
 
-    # add a custom format alias (which can be used with page_title(format: :promo))
-    PageTitleHelper.formats[:promo] = ":app // :title"
+# add a custom format alias (which can be used with page_title(format: :promo))
+PageTitleHelper.formats[:promo] = ":app // :title"
+```
 
-_Note:_ it's recommended to add this kind of stuff to an initializer, like e.g.
+_Note:_ It's recommended to add this kind of stuff to an initializer, like e.g.
 `config/initializers/page_title_helper.rb`.
 
 ## A (maybe useful) interpolation
 
-The internationalized controller name, with fallback to just display the humanized name:
-
-    PageTitleHelper.interpolates :controller do |env|
-      c = env[:view].controller
-      I18n.t(c.controller_path.tr('/', '.') + '.controller', default: c.controller_name.humanize)
-    end
+The internationalized controller name, with fallback to just display the
+humanized name:
 
-_Note:_ Put this kind of stuff into an initializer, like `config/initializers/page_title_helper.rb` or something like that.
+```ruby
+PageTitleHelper.interpolates :controller do |env|
+  c = env[:view].controller
+  I18n.t(c.controller_path.tr('/', '.') + '.controller', default: c.controller_name.humanize)
+end
+```
 
+_Note:_ Put this kind of stuff into an initializer, like
+`config/initializers/page_title_helper.rb` or something like that.
 
 ## Contributing
 
 Pull request are more than welcome. Please adhere to our
-[CODE_OF_CONDUCT.md](code of conduct) in discussions and contributions.
+[code of conduct](CODE_OF_CONDUCT.md) in discussions and contributions.
 Thanks!
 
-
 ## Maintainers
 
 * [@lwe - Lukas Westermann](https://github.com/lwe)
 * [@oliverklee - Oliver Klee](https://github.com/oliverklee)
 
-
 ## Licence and copyright
-Copyright (c) 2009 Lukas Westermann (Zurich, Switzerland), released under the MIT license
+Copyright (c) 2009 Lukas Westermann (Zurich, Switzerland), released under the
+MIT license

data/lib/page_title_helper.rb

@@ -75,7 +75,9 @@ module PageTitleHelper
 
     # handle format aliases
     format = options.delete(:format)
-    format = PageTitleHelper.formats[format] if PageTitleHelper.formats.include?(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 }

data/lib/page_title_helper/version.rb

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

data/page_title_helper.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |s|
   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.4.0'
-  s.required_rubygems_version = '>= 1.3.6'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.authors  = ['Lukas Westermann']
   s.email    = ['lukas.westermann@gmail.com']
@@ -22,9 +21,10 @@ Gem::Specification.new do |s|
 
   s.license          = 'MIT'
 
-  s.add_dependency 'rails', '>= 4.2.0', '< 6.1'
+  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.49.0'
+  s.add_development_dependency 'rubocop', '~> 0.82.0'
+  s.add_development_dependency 'rubocop-rails', '~> 2.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_title_helper
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Lukas Westermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.2
 description: Simple, internationalized and DRY page titles and headings for Rails.
 email:
 - lukas.westermann@gmail.com
@@ -105,14 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Simple, internationalized and DRY page titles and headings for Rails.