human_attribute_values 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba4d8f82ab6d1ec5068314fa9bf38c142ce4daf2
-  data.tar.gz: 01bcc9f1794567a7444f6ba79a19e207caaac650
+SHA256:
+  metadata.gz: 9bf3ef8dbbc1af598f4127f79107630115af5bce63f4ab15b3c071b175a84706
+  data.tar.gz: 138d8b185d3642412d4b7c47310c5ea2dab45cb04d1b167538cbd9b4af1f0616
 SHA512:
-  metadata.gz: ce963781d0c18eb70cfbff1e08cdf5b31451798a0087babf766f37dd7093a07d8ce83b7e0e76163a61b7d11aee90a02a509b0806fb59d8c36f26de2948c25f7f
-  data.tar.gz: 6d4d9f4af755e47fb842d0958385c10fbfe0553cad8ad333dcdd2f6179812e4cf91c410352b2417f5c85c8e22379583f62584218afba9d29f0aa35a782c10781
+  metadata.gz: 96aa93382dc9817f6c87efffb829c11e5ef84752b2f63ad31c160e3836163a0f64f0f0138ec40882a6b99152d6a22dbac08538978359b6e7d8c4245d82645d4a
+  data.tar.gz: d4c94332f5a6b74ae988874179ba0b5dc02a0b784fac8286e153717977fd059d2b10f5724d301f6b5a0cb537f9b1bd9d0d9f12814979354c09a2b873031f1d53

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+Please keep to the changelog format described on [keepachangelog.com](http://keepachangelog.com).
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.2.1] - 2019-02-08
+### Added
+- Support for rails 6 beta
+
+## [1.2.0] - 2018-10-21
+### Fixed
+- Replace dots for all types of values (not only Numeric)
+### Removed
+- Drop support for EOL rubies (2.2.10 and below)
+
+## [1.1.1] - 2018-09-01
+### Added
+- Added a changelog.
+- Also include HumanAttributeValues into ActiveModel::Model.
+### Changed
+- Instead of aborting and returning '' for associations of ActiveRecord::Base the lookup now proceeds with `assoc_attribute.to_s` as key (not meant to be done anyways).
+### Removed
+- Drop support for rails 4.1.8, including HumanAttributeValues into ActiveModel::Model does not add class method.

data/README.md

@@ -2,7 +2,7 @@
 [![Build Status](https://travis-ci.org/RST-J/human_attribute_values.svg?branch=master)](https://travis-ci.org/RST-J/human_attribute_values)
 [![Gem Version](https://badge.fury.io/rb/human_attribute_values.svg)](http://badge.fury.io/rb/human_attribute_values)
 
-human_attribute_values is a Rails plugin which provides translation for model attribute values using the Rails I18n API (analogously to [human_attribute_name](http://apidock.com/rails/v4.1.8/ActiveModel/Translation/human_attribute_name)).
+human_attribute_values is a Rails plugin which provides translation for model attribute values using the Rails I18n API (analogously to [human_attribute_name](https://apidock.com/rails/v4.2.7/ActiveModel/Translation/human_attribute_name)).
 
 ## Installation
 ```
@@ -10,16 +10,22 @@ gem install human_attribute_values
 ```
 
 ## Supported versions
-  * Rails: >= 4.1.8
-  * Ruby: MRI >= 2.0 and Rubinius (JRuby should also work though)
+  * Rails: >= 4.2.10
+  * Ruby: MRI >= 2.3.0
 
 ## Usage
-The gem defines ``human_attribute_value`` on each model, both as instance and as class method.
-To translate a value it uses the I18n API. The translations are looked up from the current locale file under the key ``'activerecord.values.model_name.attribute_name.value'`` by default.
+The gem defines ``human_attribute_value`` as instance and class method on ``ActiveRecord::Base`` and ``ActiveModel::Model``.
+To translate a value it uses the I18n API. The translations are looked up from the current locale file under the key ``'activerecord.values.model_name.attribute_name.value'`` respectively ``'activemodel.values.model_name.attribute_name.value'`` by default.
 
-Locale:
+### Locale:
 ```yml
 en:
+  activemodel:
+    values:
+      file_model:
+        content_type:
+          application/pdf: PDF
+          application/vnd_openxmlformats-officedocument_spreadsheetml_sheet: Excel/Calc
   activerecord:
     values:
       schroedinger:
@@ -28,8 +34,10 @@ en:
           alive: You opened the box and kitty purrs.
 ```
 
-Translations:
+### Translations:
 ```ruby
+# For ActiveRecord
+
 class Schroedinger < ActiveRecord::Base
   enum cat_status: {dead_and_alive: 0, alive: 1, dead: 2}
 end
@@ -46,6 +54,22 @@ Schroedinger.human_attribute_value(:cat_status, :alive)
 Schroedinger.human_attribute_value(:cat_status, :dead)
  => "dead"
 
+# For ActiveModel (the same except the lookup namespace)
+class FileModel
+  include ActiveModel::Model
+
+  attr_accessor :content_type
+end
+
+file = FileModel.new(content_type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+file.human_attribute_value(:content_type)
+ => "Excel/Calc"
+
+FileModel.human_attribute_value(:content_type, 'application/pdf')
+ => "PDF"
+
+FileModel.human_attribute_value(:content_type, 'text/plain')
+ => "text/plain"
 ```
 
 ### Boolean values
@@ -72,5 +96,9 @@ en:
           '42': 'the answer to life, the universe and everything'
 ```
 
+### Strings and Symbols
+Starting with version 1.2.0, dots in strings and symbols (actually in all values) are also replaced by an underscore for the lookup (before this was only done for numbers).
+
+
 ### Child classes
 For models with single table inheritance (STI), the lookup will start with the translations for the class and go up through the class hierarchy and use the translation for the closest parent if there is any.

data/lib/human_attribute_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'human_attribute_values/human_attribute_value'
 
 module HumanAttributeValues

data/lib/human_attribute_values/human_attribute_value.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module HumanAttributeValues
   extend ActiveSupport::Concern
 
-  included {}
-
   def human_attribute_value(attribute, options = {})
-    value = self.send attribute
+    value = public_send(attribute)
     self.class.human_attribute_value(attribute, value, options)
   end
 
   module ClassMethods
     def human_attribute_value(attribute, value, options = {})
-      return '' if value.nil?
-      # do not translate values of associations
-      return '' if reflect_on_all_associations.any? { |assoc| assoc.name == attribute.to_sym }
-      options = { count: 1 }.merge!(options)
-      parts = attribute.to_s.split(".")
+      return '' if value.nil? || value == ''
+
+      options = {count: 1}.merge!(options)
+      parts = attribute.to_s.split('.')
       attribute = parts.pop
-      namespace = parts.join("/") unless parts.empty?
-      value_scope = "#{self.i18n_scope}.values"
+      namespace = parts.join('/') unless parts.empty?
+      value_scope = "#{i18n_scope}.values"
+
       # dots would mean a new nesting level in YAML files
-      key = value.is_a?(Numeric) ? value.to_s.gsub('.', '_') : value
+      key = value.to_s.tr('.', '_')
+
       if namespace
         defaults = lookup_ancestors.map do |klass|
           :"#{value_scope}.#{klass.model_name.i18n_key}/#{namespace}.#{attribute}.#{key}"
@@ -30,14 +31,16 @@ module HumanAttributeValues
           :"#{value_scope}.#{klass.model_name.i18n_key}.#{attribute}.#{key}"
         end
       end
+
       defaults << :"values.#{attribute}.#{key}"
       defaults << options.delete(:default) if options[:default]
       defaults << value.to_s
+
       options[:default] = defaults
-      I18n.translate(defaults.shift, options)
+      I18n.t(defaults.shift, **options)
     end
   end
 end
 
-
-ActiveRecord::Base.send :include, HumanAttributeValues
+ActiveRecord::Base.include HumanAttributeValues
+ActiveModel::Model.include HumanAttributeValues

data/lib/human_attribute_values/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HumanAttributeValues
-  VERSION = "1.0.0"
+  VERSION = "1.2.2"
 end

data/test/active_model_test.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ActiveModelTest < ActiveSupport::TestCase
+  test 'value with count config' do
+    instance = ActiveModelModel.new
+    instance.string_attr = 'goose'
+    assert_equal('one goose', instance.human_attribute_value(:string_attr), 'should use the mapping for count option 1 by default')
+    assert_equal('one goose', instance.human_attribute_value(:string_attr, count: 1), 'should use the mapping for count option 1 when explicitly specified')
+    assert_equal('some geese', instance.human_attribute_value(:string_attr, count: 2), 'should use the mapping for count other if count is not 1')
+  end
+
+  test 'value without count config' do
+    instance = ActiveModelModel.new
+    instance.integer_attr = 2
+    assert_equal('odd prime', instance.human_attribute_value(:integer_attr), 'should successfully translate without a count option')
+    assert_equal('odd prime', instance.human_attribute_value(:integer_attr, count: 1), 'should successfully translate with count option 1')
+    assert_equal('odd prime', instance.human_attribute_value(:integer_attr, count: 2), 'should successfully translate with count option 2')
+  end
+
+  test 'mime type definition with a dot' do
+    instance = ActiveModelModel.new
+    instance.string_attr = 'application/x-my.mime1'
+    assert_equal('Custom Mime Type 1', instance.human_attribute_value(:string_attr), 'should successfully translate the mime type with dot')
+
+    instance.string_attr = 'application/x-my.untranslated_mime'
+    assert_equal('application/x-my.untranslated_mime', instance.human_attribute_value(:string_attr), 'should return the unmodified value for an untranslated mime type with dot')
+  end
+
+  test 'hierarchy resolution for STI models' do
+    grandchild = ActiveModelGrandChild.new
+    grandchild.inherited_attr = :one
+    assert_equal('active model grandchild value 1', grandchild.human_attribute_value(:inherited_attr), 'should use value for the actual class if present')
+
+    grandchild.inherited_attr = :two
+    assert_equal('active model child value 2', grandchild.human_attribute_value(:inherited_attr), 'should use value for the direct ancestor if it has a mapping')
+
+    grandchild.inherited_attr = :three
+    assert_equal('active model parent value 3', grandchild.human_attribute_value(:inherited_attr), 'should use value for the first parent class which has a mapping for the value')
+
+    grandchild.inherited_attr = :four
+    assert_equal('four', grandchild.human_attribute_value(:inherited_attr), 'should yield the value if there is no mapping in the type hierarchy')
+  end
+
+  test 'resolution of boolean values' do
+    instance = ActiveModelModel.new
+    instance.boolean_attr = false
+    assert_equal('This is false', instance.human_attribute_value(:boolean_attr), 'should translate boolean false')
+
+    instance.boolean_attr = true
+    assert_equal('true', instance.human_attribute_value(:boolean_attr), 'should return the stringified boolean if there is no mapping')
+  end
+
+  test 'resolution for numeric values' do
+    instance = ActiveModelModel.new
+    instance.decimal_attr = '2.71'.to_d
+    instance.float_attr = 3.14
+    instance.integer_attr = 9001
+    assert_equal('e', instance.human_attribute_value(:decimal_attr), 'should translate a decimal')
+    assert_equal('Pi', instance.human_attribute_value(:float_attr), 'should translate a float')
+    assert_equal('over 9000', instance.human_attribute_value(:integer_attr), 'should translate an integer')
+
+    instance.decimal_attr = '9.99'.to_d
+    instance.float_attr = 1.5
+    instance.integer_attr = 1001
+    assert_equal('9.99', instance.human_attribute_value(:decimal_attr), 'should return the stringified decimal if there is no mapping')
+    assert_equal('1.5', instance.human_attribute_value(:float_attr), 'should return the stringified float if there is no mapping')
+    assert_equal('1001', instance.human_attribute_value(:integer_attr), 'should return the stringified integer if there is no mapping')
+  end
+end

data/test/{human_attribute_values_test.rb → active_record_test.rb}

@@ -1,25 +1,31 @@
-require 'test_helper'
+# frozen_string_literal: true
 
-class HumanAttributeValuesTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, HumanAttributeValues
-  end
+require 'test_helper'
 
-  test "attribute with count config" do
+class ActiveRecordTest < ActiveSupport::TestCase
+  test 'attribute with count config' do
     answer = TheAnswer.new(ultimate_truth: '42')
     assert_equal('was calculated by Deep Thought', answer.human_attribute_value(:ultimate_truth), 'should use the mapping for count option 1 by default')
     assert_equal('was calculated by Deep Thought', answer.human_attribute_value(:ultimate_truth, count: 1), 'should use the mapping for count option 1 when explicitly specified')
     assert_equal('there is only one ultimate answer', answer.human_attribute_value(:ultimate_truth, count: 2), 'should use the mapping for count other if count is not 1')
   end
 
-  test "attribute without count config" do
+  test 'attribute without count config' do
     answer = TheAnswer.new(ultimate_truth: 'wissen ist Nacht')
     assert_equal('coined by Prof. Dr. Abdul Nachtigaller', answer.human_attribute_value(:ultimate_truth), 'should successfully translate without a count option')
     assert_equal('coined by Prof. Dr. Abdul Nachtigaller', answer.human_attribute_value(:ultimate_truth, count: 1), 'should successfully translate with count option 1')
     assert_equal('coined by Prof. Dr. Abdul Nachtigaller', answer.human_attribute_value(:ultimate_truth, count: 2), 'should successfully translate with count option 2')
   end
 
-  test "hierarchy resolution for STI models" do
+  test 'mime type definition with a dot' do
+    answer = TheAnswer.new(ultimate_truth: 'application/x-my.mime2')
+    assert_equal('Custom Mime Type 2', answer.human_attribute_value(:ultimate_truth), 'should successfully translate the mime type with dot')
+
+    answer.ultimate_truth = 'application/x-my.untranslated_mime'
+    assert_equal('application/x-my.untranslated_mime', answer.human_attribute_value(:ultimate_truth), 'should return the unmodified value for an untranslated mime type with dot')
+  end
+
+  test 'hierarchy resolution for STI models' do
     grandchild = GrandChild.new(field: '1')
     assert_equal('grandchild value 1', grandchild.human_attribute_value(:field), 'should use value for the actual class if present')
 
@@ -33,7 +39,7 @@ class HumanAttributeValuesTest < ActiveSupport::TestCase
     assert_equal('4', grandchild.human_attribute_value(:field), 'should yield the value if there is no mapping in the type hierarchy')
   end
 
-  test "resolution of boolean values" do
+  test 'resolution of boolean values' do
     boolean_model = BooleanModel.new(boolean_field: true)
     assert_equal('This is true', boolean_model.human_attribute_value(:boolean_field), 'should translate boolean true')
 
@@ -41,7 +47,7 @@ class HumanAttributeValuesTest < ActiveSupport::TestCase
     assert_equal('false', boolean_model.human_attribute_value(:boolean_field), 'should return the stringified boolean if there is no mapping')
   end
 
-  test "resolution for numeric values" do
+  test 'resolution for numeric values' do
     numeric_model = NumericModel.new(integer_field: 1, decimal_field: 1.0)
     assert_equal('One', numeric_model.human_attribute_value(:integer_field), 'should translate an integer')
     assert_equal('One point zero', numeric_model.human_attribute_value(:decimal_field), 'should translate a decimal')
@@ -52,12 +58,14 @@ class HumanAttributeValuesTest < ActiveSupport::TestCase
     assert_equal('2.0', numeric_model.human_attribute_value(:decimal_field), 'should return the stringified decimal if there is no mapping')
   end
 
-  test "resolution for associations" do
-    lexicon = Lexicon.new(the_answer: TheAnswer.new)
-    assert_equal('', lexicon.human_attribute_value(:the_answer), 'should return empty string for associations')
+  test 'resolution for associations' do
+    lexicon = Lexicon.new
+    the_answer = TheAnswer.new(lexicon: lexicon)
+    assert_equal(lexicon.to_s, the_answer.human_attribute_value(:lexicon), 'should return .to_s for associations 1')
+    assert_equal(lexicon.the_answers.to_s, lexicon.human_attribute_value(:the_answers), 'should return .to_s for associations 2')
   end
 
-  test "resolution for enums" do
+  test 'resolution for enums' do
     enum_model = EnumModel.new(status: :dead_and_alive)
     assert_equal('The box has not been opened yet', enum_model.human_attribute_value(:status), 'should use the enumerated values for lookup')
 

data/test/dummy/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Dummy::Application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

data/test/dummy/app/models/active_model_child.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ActiveModelChild < ActiveModelParent
+end

data/test/dummy/app/models/active_model_grand_child.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ActiveModelGrandChild < ActiveModelChild
+end

data/test/dummy/app/models/active_model_model.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ActiveModelModel
+  include ActiveModel::Model
+
+  attr_accessor :boolean_attr, :decimal_attr, :integer_attr, :float_attr, :string_attr
+end

data/test/dummy/app/models/active_model_parent.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ActiveModelParent
+  include ActiveModel::Model
+
+  attr_accessor :inherited_attr
+end

data/test/dummy/app/models/active_model_sibling.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ActiveModelSibling < ActiveModelParent
+end

data/test/dummy/app/models/boolean_model.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class BooleanModel < ActiveRecord::Base
 end

data/test/dummy/app/models/child.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Child < Parent
 end

data/test/dummy/app/models/enum_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class EnumModel < ActiveRecord::Base
   enum status: {dead_and_alive: 0, alive: 1, dead: 2}
 end

data/test/dummy/app/models/file_model.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FileModel
+  include ActiveModel::Model
+
+  attr_accessor :content_type
+end

data/test/dummy/app/models/grand_child.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class GrandChild < Child
 end

data/test/dummy/app/models/lexicon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lexicon < ActiveRecord::Base
-  belongs_to :the_answer
+  has_many :the_answers
 end

data/test/dummy/app/models/numeric_model.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class NumericModel < ActiveRecord::Base
 end