i18n_rails_helpers 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6b2f04d8cc2a83a85df37f146256516f2095dd7a
-  data.tar.gz: b0c33d11110e084d74062d842822f042d0e59b66
+SHA256:
+  metadata.gz: f7cac95e65c93521ee679616d514393c8fb0c7db16dbb284a0e4aa3d8d9f2860
+  data.tar.gz: fe5f13d1e2ba4f152e394adf9b1baadb7e4d4a3edc2667b551328d0c92bec359
 SHA512:
-  metadata.gz: 4ee7552f09a4a83705014c5b458240be6407332795fa6ed7925f12020f7f0672d8e5954a8326c0d62d7e764db2c5ce60ddb3987033b0190b22b0b35b63a3d3da
-  data.tar.gz: a273b5cf78607e2cde6cf94323cdc73acb22b8392ca92746ea476480b06f6db285ab58977396682f923ea2437c6e3466b412bde1c9bfa4309d63e65180a8f16a
+  metadata.gz: b2896f9666bfecf52e6f22964001a4f0bd9bf002e1ab256913a26ac617592affdfa102958f13a33125b75516f152e4063bad8099d6ed48347e479ad829e0a728
+  data.tar.gz: 045aecc3d6f2d2c08b0c454d8b645ef69556a024e01e580d3551f6f4eac383ce3ca844b3d18a2964a6d4a6fbea3377be27cf9cc6426659a560ced922b585fe7f

data/README.md

@@ -1,27 +1,182 @@
-I18nRailsHelpers
-================
+# I18nRailsHelpers
 
 [![Build Status](https://secure.travis-ci.org/huerlisi/i18n_rails_helpers.png)](http://travis-ci.org/huerlisi/i18n_rails_helpers)
 
 Rails i18n view helpers for things like crud actions, models and and attributes.
 
-Install
-=======
+- [Install](#install)
+- [Examples](#examples)
+  - [View Helpers](#view-helpers)
+    - [t_attr](#t_attr)
+    - [t_title](#t_title)
+    - [t_action](#t_action)
+    - [t_confirm_delete](#t_confirm_delete)
+    - [t_select_prompt](#t_select_prompt)
+  - [Controller Helpers](#controller-helpers)
+    - [redirect_notice](#redirect_notice)
+    - [t_attr](#t_attr-1)
+    - [t_title](#t_title-1)
+    - [t_action](#t_action-1)
+  - [Model helpers](#model-helpers)
+    - [enum_attribute_t methods](#enum_attribute_t-methods)
+    - [t_enum](#t_enum)
+  - [Required translations in locales (`config/locales/zz.yml`)](#required-translations-in-locales-configlocaleszzyml)
+- [License](#license)
 
-In Rails simply add
+## Install
 
-    gem 'i18n_rails_helpers'
+In Rails simply add this to your Gemfile:
 
-Example
-=======
+```ruby
+gem 'i18n_rails_helpers'
+```
 
-    t_attr('first_name')          # 'Vorname' # when called in patients_controller views
-    t_model                       # 'Konto' # when called in patients_controller views
-    t_title('delete')             # 'Konto löschen' # when called in accounts_controller views
-    t_action('index')             # 'Liste'
-    t_confirm_delete(@account)    # 'Konto Kasse wirklich löschen'
+## Examples
 
-License
-=======
+### View Helpers
+
+#### t_attr
+
+```ruby
+t_attr('first_name', Patient) # en: 'First name' de: 'Vorname' - when called from views of any controller
+t_attr('first_name')          # en: 'First name' de: 'Vorname' - when called in patients_controller views
+t_attr(:first_name)           # en: 'First name' de: 'Vorname' - can also be called with symbols
+```
+
+#### t_title
+
+```ruby
+t_title(:index)   # en: "%{model} index" ,  de: "%{model} Liste"
+t_title(:edit)    # en: "Edit %{model}",    de: "%{model} bearbeiten"
+t_title(:update)  # en: "Edit %{model}",    de: "%{model} bearbeiten"
+t_title(:show)    # en: "Show %{model}",    de: "%{model} anzeigen"
+t_title(:new)     # en: "New %{model}",     de: "%{model} erfassen"
+t_title(:create)  # en: "New %{model}",     de: "%{model} erfassen"
+t_title(:delete)  # en: "Delete %{model}",  de: "%{model} löschen"
+t_title(:destroy) # en: "Delete %{model}",  de: "%{model} löschen"
+```
+
+#### t_action
+
+```ruby
+t_action(:index)    # en: "Index",     de: "Liste"
+t_action(:edit)     # en: "Edit",      de: "Bearbeiten"
+t_action(:update)   # en: "Edit",      de: "Bearbeiten"
+t_action(:show)     # en: "Show",      de: "Anzeigen"
+t_action(:new)      # en: "New",       de: "Erfassen"
+t_action(:create)   # en: "New",       de: "Erfassen"
+t_action(:delete)   # en: "Delete",    de: "Löschen"
+t_action(:destroy)  # en: "Delete",    de: "Löschen"
+t_action(:cancel)   # en: "Abbrechen", de: "Abbrechen"
+t_action(:back)     # en: "Back",      de: "Zurück"
+t_action(:previous) # en: "Previous",  de: "Zurück"
+t_action(:next)     # en: "Next",      de: "Weiter"
+```
+
+#### t_confirm_delete
+
+```ruby
+t_confirm_delete(@account) # en: 'Really delete account Kasse?' de: 'Konto Kasse wirklich löschen?'
+```
+
+#### t_select_prompt
+
+```ruby
+t_select_prompt(@account) # en: 'Select Account' de: 'Konto auswählen'
+```
+
+### Controller Helpers
+
+#### redirect_notice
+
+```ruby
+def create
+  # ...
+  redirect_to some_path, redirect_notice           # => 'Klient erstellt.'
+  redirect_to some_path, redirect_notice(@client)  # => 'Klient Example Client erstellt.'
+end
+
+def update
+  # ...
+  redirect_to some_path, redirect_notice           # => 'Klient geändert.'
+  redirect_to some_path, redirect_notice(@client)  # => 'Klient Example Client geändert.'
+end
+
+
+def destroy
+  # ...
+  redirect_to some_path, redirect_notice           # => 'Klient gelöscht.'
+  redirect_to some_path, redirect_notice(@client)  # => 'Klient Example Client gelöscht.'
+end
+```
+
+#### t_attr
+
+- [t_attr](#t_attr)
+
+#### t_title
+
+- [t_title](#t_title)
+
+#### t_action
+
+- [t_action](#t_action)
+
+### Model helpers
+
+#### enum_attribute_t methods
+
+Automaticly generated enum attribut translation methods.
+
+*[Required translations](#required-translations-in-locales-configlocaleszzyml)*.
+
+```ruby
+# Client model
+enum gender: { undefined: 0, female: 1, male: 2, xy: 3 }
+
+# in use
+Client.first.gender    # => 'female'
+Client.first.gender_t  # de: => 'Frau', en: => 'Woman'
+Client.first.genders_t # => { undefined: 'Nicht definiert', female: 'Frau', male: 'Mann' }
+```
+
+#### t_enum
+
+```ruby
+# Client model
+enum gender: { undefined: 0, female: 1, male: 2, xy: 3 }
+
+Client.first.gender # => 'female'
+Client.first.t_enum(:gender) # de: => 'Frau', en: => 'Women'
+Client.first.t_enum(:gender, :male) # de: => 'Mann', en: => 'Men'
+```
+
+### Required translations in locales (`config/locales/zz.yml`)
+
+```yaml
+---
+de:
+  activerecord:
+    attributes:
+      client:
+        genders:
+          undefined: Nicht definiert
+          female: Frau
+          male: Mann
+---
+en:
+  activerecord:
+    attributes:
+      client:
+        genders:
+          undefined: Not defined
+          female: Women
+          male: Man
+---
+fr:
+# ...
+```
+
+## License
 
 Released under the MIT license.

data/app/helpers/i18n_helpers.rb

@@ -1,10 +1,10 @@
 module I18nHelpers
   # Returns translated identifier
   def t_page_head
-    if params[:id] and resource
-      return "%s %s" % [t_title, resource.to_s]
+    if params[:id] && resource
+      "#{t_title} #{resource}"
     else
-      return t_title
+      t_title
     end
   end
 
@@ -18,12 +18,8 @@ module I18nHelpers
   #   t_attr('first_name')          => 'Vorname' # when called in patients_controller views
   #
   def t_attr(attribute, model = nil)
-    if model.is_a? Class
-      model_class = model
-    elsif model.nil?
-      model_class = controller_name.classify.constantize
-    end
-    model_class.human_attribute_name(attribute)
+    model ||= controller_name.classify.constantize
+    model.human_attribute_name(attribute)
   end
 
   # Returns translated name for the given +model+.
@@ -37,18 +33,16 @@ module I18nHelpers
   #   t_model              => 'Konto' # when called in patients_controller views
   #
   def t_model(model = nil)
-    if model.is_a? ActiveModel::Naming
-      return model.model_name.human
-    elsif model.class.is_a? ActiveModel::Naming
-      return model.class.model_name.human
-    elsif model.is_a? Class
-      model_name = model.name.underscore
-    elsif model.nil?
-      model_name = controller_name.singularize
-    else
-      model_name = model.class.name.underscore
-    end
-    I18n::translate(model_name, :scope => [:activerecord, :models])
+    return model.model_name.human if model.is_a? ActiveModel::Naming
+    return model.class.model_name.human if model.class.is_a? ActiveModel::Naming
+    model_key = if model.is_a? Class
+                  model.name.underscore
+                elsif model.nil?
+                  controller_name.singularize
+                else
+                  model.class.name.underscore
+                end
+    I18n.t("activerecord.models.#{model_key}")
   end
 
   # Returns translated title for current +action+ on +model+.
@@ -67,19 +61,15 @@ module I18nHelpers
   #   #{controller_name}.#{action}.title
   #
   # Example:
-  #   t_title('new', Account') => 'Konto anlegen'
-  #   t_title('delete')        => 'Konto löschen' # when called in accounts_controller views
-  #   t_title                  => 'Konto ändern'  # when called in accounts_controller edit view
+  #   t_title('new', Account) => 'Konto anlegen'
+  #   t_title('delete')       => 'Konto löschen' # when called in accounts_controller views
+  #   t_title                 => 'Konto ändern'  # when called in accounts_controller edit view
   #
   def t_title(action = nil, model = nil)
-    action ||= action_name
-    if model
-      context = model.name.pluralize.underscore
-    else
-      context = controller_name.underscore
-    end
-
-    I18n::translate("#{context}.#{action}.title", :default => [:"crud.title.#{action}"], :model => t_model(model))
+    model_key = model&.model_name&.i18n_key || model&.class&.model_name&.i18n_key ||
+      controller_name.underscore
+    I18n.t("#{model_key}.#{action || action_name}.title",
+      default: [:"crud.title.#{action || action_name}"], model: t_model(model))
   end
   alias :t_crud :t_title
 
@@ -95,8 +85,7 @@ module I18nHelpers
   #   t_action                  => 'Ändern'  # when called in an edit view
   #
   def t_action(action = nil, model = nil)
-    action ||= action_name
-    I18n::translate(action, :scope => 'crud.action', :model => t_model(model))
+    I18n.t("crud.action.#{action || action_name}", model: t_model(model))
   end
 
   # Returns translated deletion confirmation for +record+.
@@ -107,7 +96,7 @@ module I18nHelpers
   #   t_confirm_delete(@account) => 'Konto Kasse wirklich löschen'
   #
   def t_confirm_delete(record)
-    I18n::translate('messages.confirm_delete', :model => t_model(record), :record => record.to_s)
+    I18n.t('messages.confirm_delete', model: t_model(record), record: record.to_s)
   end
 
   # Returns translated drop down field prompt for +model+.
@@ -118,6 +107,6 @@ module I18nHelpers
   #   t_select_prompt(Account) => 'Konto auswählen'
   #
   def t_select_prompt(model = nil)
-    I18n::translate('messages.select_prompt', :model => t_model(model))
+    I18n.t('messages.select_prompt', model: t_model(model))
   end
 end

data/config/locales/de.yml

@@ -4,6 +4,10 @@ de:
     select_prompt:  "%{model} auswählen"
 
   crud:
+    notices:
+      create: "%{model} %{record}erstellt."
+      update: "%{model} %{record}geändert."
+      destroy: "%{model} %{record}gelöscht."
     title:
       index:  "%{model} Liste"
       edit:   "%{model} bearbeiten"

data/config/locales/en.yml

@@ -4,6 +4,10 @@ en:
     select_prompt:  "Select %{model}"
 
   crud:
+    notices:
+      create: "%{model} %{record}created."
+      update: "%{model} %{record}changed."
+      destroy: "%{model} %{record}deleted."
     title:
       index:  "%{model} index"
       edit:   "Edit %{model}"

data/lib/i18n_rails_helpers/controller_helpers.rb

@@ -0,0 +1,17 @@
+
+module I18nRailsHelpers
+  module ControllerHelpers
+    delegate :t_attr, :t_model, :t_action, to: :helpers
+
+    # returns a redirect notice for create, update and destroy actions
+    #
+    # Example in ClientsController:
+    #   redirect_to some_path, redirect_notice           # => 'Klient geändert.'
+    #   redirect_to some_path, redirect_notice(@client)  # => 'Klient Example Client geändert.'
+    #
+    def redirect_notice(record = nil)
+      { notice: I18n.t("crud.notices.#{action_name}", model: helpers.t_model,
+        record: record.present? ? "#{record} " : '') }
+    end
+  end
+end

data/lib/i18n_rails_helpers/engine.rb

@@ -1,4 +1,6 @@
 require 'rails'
+require 'i18n_rails_helpers/model_helpers'
+require 'i18n_rails_helpers/controller_helpers'
 
 module I18nRailsHelpers
   class Engine < Rails::Engine
@@ -6,6 +8,12 @@ module I18nRailsHelpers
       ActionView::Base.send :include, I18nHelpers
       ActionView::Base.send :include, ContextualLinkHelpers
       ActionView::Base.send :include, ListLinkHelpers
+      ActionController::Base.class_eval { include ControllerHelpers }
+
+      ActiveRecord::Base.class_eval do
+        include ModelHelpers
+        after_initialize :define_enum_t_methods
+      end
     end
   end
 end

data/lib/i18n_rails_helpers/model_helpers.rb

@@ -0,0 +1,40 @@
+module I18nRailsHelpers
+  module ModelHelpers
+    # enum attrubute_t and attributes_t return translated enum values
+    #
+    # Example:
+    #   in the Client model
+    #     enum gender: { undefined: 0, female: 1, male: 2 }
+    #   in use
+    #     Client.first.gender    # => 'female'
+    #     Client.first.gender_t  # => 'Frau'
+    #     Client.first.genders_t # => { undefined: 'Nicht definiert', female: 'Frau', male: 'Mann' }
+    #
+    # Requires:
+    #   locale key: activerecord.attributes.#{model_name}.#{enum}.#{enum_value_key}
+    #   eg.:        activerecord.attributes.client.genders.female                    # => 'Frau'
+    #
+    def define_enum_t_methods
+      defined_enums.each do |enum_attr, values|
+        self.class.send(:define_method, "#{enum_attr}_t") { t_enum(enum_attr) }
+        self.class.send(:define_method, "#{enum_attr.pluralize}_t") do
+          t_enum_values(enum_attr, values)
+        end
+      end
+    end
+
+    def t_enum_values(enum_attr, values)
+      values.map do |enum_val_key, _|
+        [enum_val_key.to_sym, t_enum(enum_attr, enum_val_key)]
+      end.to_h
+    end
+
+    # translate enum fields value
+    def t_enum(enum_attr, enum_value = nil)
+      enum_value ||= public_send(enum_attr)
+      I18n.t(
+        "activerecord.attributes.#{model_name.i18n_key}.#{enum_attr.to_s.pluralize}.#{enum_value}"
+      )
+    end
+  end
+end

data/lib/i18n_rails_helpers/version.rb

@@ -1,3 +1,3 @@
 module I18nRailsHelpers
-  VERSION = "2.0.1"
+  VERSION = '2.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n_rails_helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Simon Huerlimann (CyT)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails i18n view helpers for things like crud actions, models and and
-  attributes.
+description: Rails i18n view helpers for things like crud actions, models and attributes.
 email:
 - simon.huerlimann@cyt.ch
 executables: []
@@ -105,7 +104,9 @@ files:
 - config/locales/en.yml
 - lib/boot_form_builder.rb
 - lib/i18n_rails_helpers.rb
+- lib/i18n_rails_helpers/controller_helpers.rb
 - lib/i18n_rails_helpers/engine.rb
+- lib/i18n_rails_helpers/model_helpers.rb
 - lib/i18n_rails_helpers/version.rb
 homepage: https://github.com/huerlisi/i18n_rails_helpers
 licenses:
@@ -127,9 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: I18n Rails helpers
 test_files: []
-has_rdoc: