rails/activemodel/test/cases/translation_test.rb
Jonathan Hefner b2f49f27ad Improve ActiveModel::Name#human performance
This refactors `ActiveModel::Name#human` to reduce allocations and
improve performance by ~2x when a translation is not defined.

Benchmark script:

```ruby
require "benchmark/memory"
require "benchmark/ips"

class BaseModel
  extend ActiveModel::Translation
end

BlogPost = Class.new(BaseModel)

Benchmark.memory do |x|
  x.report("warmup") { BlogPost.model_name.human }
  x.report("human")  { BlogPost.model_name.human }
end

Benchmark.ips do |x|
  x.report("human")  { BlogPost.model_name.human }
end
```

Before:

```
Calculating -------------------------------------
              warmup   964.242k memsize (    23.575k retained)
                         2.157k objects (   310.000  retained)
                        50.000  strings (    50.000  retained)
               human     4.144k memsize (     0.000  retained)
                        32.000  objects (     0.000  retained)
                         6.000  strings (     0.000  retained)

Warming up --------------------------------------
               human   870.000  i/100ms
Calculating -------------------------------------
               human      8.434k (± 0.8%) i/s -     42.630k in   5.054943s
```

After:

```
Calculating -------------------------------------
              warmup   962.418k memsize (    23.607k retained)
                         2.143k objects (   310.000  retained)
                        50.000  strings (    50.000  retained)
               human     2.112k memsize (     0.000  retained)
                        16.000  objects (     0.000  retained)
                         1.000  strings (     0.000  retained)

Warming up --------------------------------------
               human     1.851k i/100ms
Calculating -------------------------------------
               human     18.492k (± 0.7%) i/s -     92.550k in   5.005100s
```
2022-02-02 11:11:56 -06:00

130 lines
5.2 KiB
Ruby

# frozen_string_literal: true
require "cases/helper"
require "models/person"
class ActiveModelI18nTests < ActiveModel::TestCase
def setup
I18n.backend = I18n::Backend::Simple.new
end
def teardown
I18n.backend.reload!
end
def test_translated_model_attributes
I18n.backend.store_translations "en", activemodel: { attributes: { person: { name: "person name attribute" } } }
assert_equal "person name attribute", Person.human_attribute_name("name")
end
def test_translated_model_attributes_with_default
I18n.backend.store_translations "en", attributes: { name: "name default attribute" }
assert_equal "name default attribute", Person.human_attribute_name("name")
end
def test_translated_model_attributes_using_default_option
assert_equal "name default attribute", Person.human_attribute_name("name", default: "name default attribute")
end
def test_translated_model_attributes_using_default_option_as_symbol
I18n.backend.store_translations "en", default_name: "name default attribute"
assert_equal "name default attribute", Person.human_attribute_name("name", default: :default_name)
end
def test_translated_model_attributes_falling_back_to_default
assert_equal "Name", Person.human_attribute_name("name")
end
def test_translated_model_attributes_using_default_option_as_symbol_and_falling_back_to_default
assert_equal "Name", Person.human_attribute_name("name", default: :default_name)
end
def test_translated_model_attributes_with_symbols
I18n.backend.store_translations "en", activemodel: { attributes: { person: { name: "person name attribute" } } }
assert_equal "person name attribute", Person.human_attribute_name(:name)
end
def test_translated_model_attributes_with_ancestor
I18n.backend.store_translations "en", activemodel: { attributes: { child: { name: "child name attribute" } } }
assert_equal "child name attribute", Child.human_attribute_name("name")
end
def test_translated_model_attributes_with_ancestors_fallback
I18n.backend.store_translations "en", activemodel: { attributes: { person: { name: "person name attribute" } } }
assert_equal "person name attribute", Child.human_attribute_name("name")
end
def test_translated_model_attributes_with_attribute_matching_namespaced_model_name
I18n.backend.store_translations "en", activemodel: { attributes: {
person: { gender: "person gender" },
"person/gender": { attribute: "person gender attribute" }
} }
assert_equal "person gender", Person.human_attribute_name("gender")
assert_equal "person gender attribute", Person::Gender.human_attribute_name("attribute")
end
def test_translated_deeply_nested_model_attributes
I18n.backend.store_translations "en", activemodel: { attributes: { "person/contacts/addresses": { street: "Deeply Nested Address Street" } } }
assert_equal "Deeply Nested Address Street", Person.human_attribute_name("contacts.addresses.street")
end
def test_translated_nested_model_attributes
I18n.backend.store_translations "en", activemodel: { attributes: { "person/addresses": { street: "Person Address Street" } } }
assert_equal "Person Address Street", Person.human_attribute_name("addresses.street")
end
def test_translated_nested_model_attributes_with_namespace_fallback
I18n.backend.store_translations "en", activemodel: { attributes: { addresses: { street: "Cool Address Street" } } }
assert_equal "Cool Address Street", Person.human_attribute_name("addresses.street")
end
def test_translated_model_names
I18n.backend.store_translations "en", activemodel: { models: { person: "person model" } }
assert_equal "person model", Person.model_name.human
end
def test_translated_model_when_missing_translation
assert_equal "Person", Person.model_name.human
end
def test_translated_model_with_namespace
I18n.backend.store_translations "en", activemodel: { models: { 'person/gender': "gender model" } }
assert_equal "gender model", Person::Gender.model_name.human
end
def test_translated_subclass_model
I18n.backend.store_translations "en", activemodel: { models: { child: "child model" } }
assert_equal "child model", Child.model_name.human
end
def test_translated_subclass_model_when_ancestor_translation
I18n.backend.store_translations "en", activemodel: { models: { person: "person model" } }
assert_equal "person model", Child.model_name.human
end
def test_translated_subclass_model_when_missing_translation
assert_equal "Child", Child.model_name.human
end
def test_translated_model_with_default_value_when_missing_translation
assert_equal "dude", Person.model_name.human(default: "dude")
end
def test_translated_model_with_default_key_when_missing_both_translations
assert_equal "Person", Person.model_name.human(default: :this_key_does_not_exist)
end
def test_human_does_not_modify_options
options = { default: "person model" }
Person.model_name.human(options)
assert_equal({ default: "person model" }, options)
end
def test_human_attribute_name_does_not_modify_options
options = { default: "Cool gender" }
Person.human_attribute_name("gender", options)
assert_equal({ default: "Cool gender" }, options)
end
end