page_title_helper 1.0.1 → 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83ca84d323ad19f09e49b6ee6333f2cd3c06f0e2e3f8748b8081a204fdebc4ac
+  data.tar.gz: 4c9affff4ee6f51d0dfccb906ec4406e5a50032da651fcc92be19603368741e0
+SHA512:
+  metadata.gz: 19879f1e33647398e8d15ee0b3adbaacd29a6645fd89b33838fddf11f469a577abf2467a368f6b352e61ad4db8fc71f0ac4f5e918112b16c59ab84751bfca0a2
+  data.tar.gz: c28883f1bd9cefd68c8f121b4caced4bd946ffec08d5e10f4e33f8a6008ed825132886362b97afa36a642ce05e02b22182899743daeb56515962e24ac9e51fdd

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Page title helper change log
+
+All notable changes to this project will be documented in this file.
+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
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### 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)
+
+### Removed
+- Drop support for Ruby < 2.4 (#93)
+
+## 3.0.0
+
+### Added
+- 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)
+- Test against Ruby 2.2
+- Use Appraisal for building with different Rails versions (#19)
+
+### Changed
+- 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)
+- Drop support for Ruby 1.9.x (#24)
+
+### Fixed
+- 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at (lukas dot westermann at gmail dot com).
+All complaints will be reviewed and investigated and will result in a response
+that is deemed necessary and appropriate to the circumstances. The project team
+is obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[https://contributor-covenant.org/version/1/4/][version].
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,178 +1,224 @@
 # Page title helper
 
-Ever wondered if there was an easier and DRY-way to set your page titles (and/or headings). Backed
-by Rails (only tested on 2.3.x) and it's new `I18n`-class the solution is a simple helper method.
-
-In your layout add this to your `<head>-section`:
-
-      ...
-      <title><%=h page_title %></title>
-      ...
-      
-That's it. Now just add your translations, to the locales, in e.g. `config/locales/en.yml`:
-
-      en:
-        contacts:
-          index:
-            title: "Contacts"
-            
-When `contacs/index.html.erb` is rendered, the key `:en, :contacts, :index, :title`
-is looked up and printed, together with the applications basename, like: `My cool app - Contacts`.
+[![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 to inflect titles from controllers and actions.
+
+In your layout, add this to your `<head>`-section:
+
+```html
+<title><%= page_title %></title>
+```
+
+That's it. Now just add translations, in e.g. `config/locales/en.yml`:
+
+```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`.
 The format etc. is of course configurable, just head down to the options.
 
 ## Installation
 
-As gem (from gemcutter.org, as of version 0.7.0):
+As gem (from rubygems.org):
+
+```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'
+```
 
-    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 as plain old Rails plugin:
+## Translated titles
 
-    ./script/plugin install git://github.com/lwe/page_title_helper.git
+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]
+```
+
+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?
-
-    <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:
-
-    <% 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` with `page_title!`, to
-translate customzied titles, like:
-
-    # in config/locales/en.yml:
-    en:
-      dashboard:
-        index:
-          title: "Welcome back, {{name}}"
-
-    # in app/views/dashboard/index.html.erb:
-    <h1><%=h page_title!(t('.title', :name => @user.first_name)) %></h1>
-
-## More fun with <tt>:format</tt>
-
-The `:format` option is used to specify how a title is formatted, i.e. if the app name is
-prependor 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"
-    
-Adding custom interpolations is as easy as defining a block, for example to access the current
-controller:
-
-    PageTitleHelper.interpolates :controller do |env|
-      env.controller.controller_name.humanize
-    end
-    
-    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:
-
-    page_title! "untitled"
-    page_title :format => false # => "untitled"
-    
+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>
+```
+
+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>
+```
+
+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`:
+
+```yaml
+en:
+  dashboard:
+    index:
+      title: "Welcome back, {{name}}"
+```
+
+In `app/views/dashboard/index.html.erb`:
+```html
+<h1><%= page_title!(t('.title', name: @user.first_name)) %></h1>
+```
+
+## 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:
+
+```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:
+
+```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"
+```
+
+To access just the title, without any magic app stuff interpolated or appended,
+use:
+
+```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><%=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"
-    
-To streamline that feature a bit and simplify reuse of often used formats, it's now possible to define format aliases like:
-
-    # in an initializer:
-    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...
-    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
-
-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.
+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 an initializer, e.g., `config/initializers/page_title_helper.rb`:
+
+```ruby
+PageTitleHelper.formats[:with_company] = ":title from :company - :app"
+# show app first for promo pages :)
+PageTitleHelper.formats[:promo] = ":app - :title" 
+```
+
+Then in the view to display a contact:
+
+```ruby
+page_title! @contact.name, :with_company
+```
+
+Or for the promo page via `config/locales/en.yml` (!):
+
+```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 the 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>
-  <tr>
-    <td><tt>:suffix</tt></td>
-    <td>Not happy with the fact that the translations must be named like
-        <tt>en -> contacts -> index -> title</tt>, but prefer e.g. them to be suffixed with
-        <tt>page_title</tt>? Then just set <tt>:suffix => :page_title</tt>.</td>
-    <td><tt>:title</tt></td>
-    <td>symbol or string</td>
-  </tr>
-</table>
-</p>
-
-If an option should be set globally it's possible to change the default options hash as follows:
-
-    PageTitleHelper.options[:suffix] = :page_title
-    
-Note, currently it only makes sense to set `:default` and/or `:page_title` 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"
-    
-    # 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.
+```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"
+```
+
+_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:
+The internationalized controller name, with fallback to just display the
+humanized name:
+
+```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](CODE_OF_CONDUCT.md) in discussions and contributions.
+Thanks!
+
+## Maintainers
+
+* [@lwe - Lukas Westermann](https://github.com/lwe)
+* [@oliverklee - Oliver Klee](https://github.com/oliverklee)
 
-    PageTitleHelper.interpolates :controller do |env|
-      I18n.t env.controller.controller_path.tr('/','.') + '.controller', :default => env.controller.controller_name.humanize
-    end
-    
-_Note:_ Put this kind of stuff into an initilizer, like `config/initializers/page_title.rb` or someting like that.
-    
 ## 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