validation_hints 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '093064f733917dd331d9ecaa77e6a9204dbff272010de712ae70c05965f5b271'
-  data.tar.gz: 0b33c6d54febdd3dab42c30230deb3df6d5a9f3e5dd1ed24110d70e7e616e207
+  metadata.gz: 417c0455d8dedf1c33c7cf608af48ec92ecb6b1d913f60f58ac0d7b91d0eb58d
+  data.tar.gz: 216254f45fa84b4370828da2830d79689fbd3971da68fa0e4e891873ed40029f
 SHA512:
-  metadata.gz: c74d07e79ea487b1f81559dd0b92fc887f38f3483a0c99593453c61957b82ee3fdabdc0b762c3e28cd40247df788d161b77557e7908a8928a4471888dc188f25
-  data.tar.gz: 944ce03510f53c545b27bf9c813649fb8994a7cf64e200693b93a4fbe363b11eb60f14eea93cd7600f032ae5af0719a37614dc1fc39504b59343dbd82f27d860
+  metadata.gz: 2a961271d6a978a874745411c8251e8fb255c974917da3dbcaad7e469caada854ef7f9437d0de8972d266348a3d054e5952bb81cd42f5ed3515d1c45d1a435e6
+  data.tar.gz: 974c699d5c1acaf13dd0494156cd8d46f5628f6b9ef9d874c873804d33d75d6df745fd62fc5fa8db41210cca236f9a5642df2da571dd55ecb5e245527417326d

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project are documented here.
 
+## 6.2.0
+
+I18n lookup chain and documentation (Phase 2).
+
+### Added
+
+- `activemodel.hints` and `activerecord.hints` locale scopes (format + lookup chain).
+- `test/active_model/i18n_test.rb` — app override and `human_attribute_name` coverage.
+- README: requirements, API, I18n lookup order, and `config/locales` override examples.
+
+### Changed
+
+- `generate_message` / `full_message` I18n fallback chain mirrors Rails errors (with `hints` namespace).
+- `full_message` passes `base: @base` to `human_attribute_name` and resolves format via scoped `hints.format` keys.
+
 ## 6.1.0
 
 Rails 7 compatibility for `ActiveModel::Hints` and expanded test coverage (Phase 1).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validation_hints (6.1.0)
+    validation_hints (6.2.0)
       activerecord (>= 7.0, < 7.1)
 
 GEM
@@ -264,7 +264,7 @@ CHECKSUMS
   thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
   timeout (0.6.1) sha256=78f57368a7e7bbadec56971f78a3f5ecbcfb59b7fcbb0a3ed6ddc08a5094accb
   tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
-  validation_hints (6.1.0)
+  validation_hints (6.2.0)
   websocket-driver (0.8.0) sha256=ed0dba4b943c22f17f9a734817e808bc84cdce6a7e22045f5315aa57676d4962
   websocket-extensions (0.1.5) sha256=1c6ba63092cda343eb53fc657110c71c754c56484aad42578495227d717a8241
   zeitwerk (2.7.5) sha256=d8da92128c09ea6ec62c949011b00ed4a20242b255293dd66bf41545398f73dd

data/README.md

@@ -1,34 +1,93 @@
+# validation_hints
 
-## Validation Hints
+Proactive validation hints derived from model validators — complementary to Rails `errors` (which react after `valid?` fails).
 
-Delivers hints derived from the validation on a model.
+**Requirements:** Ruby >= 3.2, Rails / Active Record 7.0.x (`>= 7.0`, `< 7.1`). Used by [inline_forms](https://github.com/acesuares/inline_forms).
 
-### Install
+## Install
 
 ```ruby
-gem 'validation_hints'
+# Gemfile
+gem "validation_hints", "~> 6.2"
 ```
 
-### Example
+Rails apps load the gem via `ValidationHints::Railtie` (no manual `require`).
+
+## Example
 
 ```ruby
-class Person < ActiveRecord::Base
-  validates :name, :presence => true
-  validates :password, :length => { :within => 1...5 }
+class Person < ApplicationRecord
+  validates :name, presence: true
+  validates :password, length: { within: 1...5 }
 end
+
+Person.new.hints[:name]      # => ["can't be blank"]
+Person.new.hints[:password]  # => ["must be between 1 and 4 characters"]
+
+Person.new.hints.full_messages_for(:name)  # => ["Name can't be blank"]
+Person.new.has_validations_for?(:name)     # => true
 ```
 
-```ruby
-Person.new.hints[:name] => ["can't be blank"]
-Person.new.hints[:password] => ["must not be shorter than 1 characters", "must not be longer than 4 characters"]
-Person.new.hints.messages => {:id=>[], :password=>["must not be shorter than 1 characters", "must not be longer than 4 characters"], :name => ["can't be blank"] }
+## API (stable)
+
+| Method | Description |
+|--------|-------------|
+| `model.hints` | `ActiveModel::Hints` for the instance |
+| `hints[:attribute]` | Short hint strings for an attribute |
+| `hints.full_messages_for(attr)` | Attribute label + hint (used by inline_forms tooltips) |
+| `has_validations?` / `has_validations_for?(attr)` | Whether to show hint UI |
+
+## I18n
+
+Default copy lives in the gem at `lib/validation_hints/locale/en.yml` under the `hints` namespace.
+
+Lookup order mirrors Rails **errors**, but uses **`hints`** instead of `errors`:
+
+1. `activerecord.hints.models.<model>.attributes.<attr>.<type>`
+2. `activerecord.hints.models.<model>.<type>`
+3. `activerecord.hints.messages.<type>`
+4. `activemodel.hints.messages.<type>`
+5. `hints.attributes.<attr>.<type>`
+6. `hints.messages.<type>`
+
+Full messages (`full_messages_for`) use `hints.format` with the same scoping (`activerecord.hints.format`, `activemodel.hints.format`, `hints.format`).
+
+### App overrides
+
+Add a locale file, e.g. `config/locales/validation_hints.en.yml`:
+
+```yaml
+en:
+  activerecord:
+    hints:
+      format: "%{attribute}: %{message}"
+      messages:
+        presence: "is required"
+      models:
+        apartment:
+          attributes:
+            name:
+              presence: "enter a name for this apartment"
 ```
 
-### Disclaimer
+Per-attribute overrides without a model block:
+
+```yaml
+en:
+  hints:
+    attributes:
+      name:
+        presence: "is required"
+```
 
-It's work in progress.
-validation_hints was for the most part derived from activerecord-3.2.3/lib/active_record/errors.rb
+Attribute labels in full messages come from the normal Rails path (`activerecord.attributes.<model>.<attr>`), same as errors.
 
+## Tests
 
+```bash
+bundle exec rake test
+```
 
+## History
 
+See [CHANGELOG.md](CHANGELOG.md).

data/lib/active_model/hints.rb

@@ -153,10 +153,14 @@ module ActiveModel
       return message if attribute == :base
 
       attr_name = attribute.to_s.tr(".", "_").humanize
-      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name, base: @base)
+
+      format_defaults = i18n_format_defaults
+      format_key = format_defaults.shift
+
       I18n.t(
-        :"hints.format",
-        default: "%{attribute} %{message}",
+        format_key,
+        default: format_defaults,
         attribute: attr_name,
         message: message
       )
@@ -273,28 +277,50 @@ module ActiveModel
     end
 
     def i18n_defaults(attribute, type, options)
-      attribute_name = attribute.to_s.delete_suffix("[]").remove(/\[\d+\]/)
+      attribute_name = attribute.to_s.remove(/\[\d+\]/)
+
+      defaults = model_hint_defaults(attribute_name, type)
+      defaults << options[:message] if options[:message]
 
       if @base.class.respond_to?(:i18n_scope)
         scope = @base.class.i18n_scope
-        model_defaults = @base.class.lookup_ancestors.flat_map do |klass|
-          [
-            :"#{scope}.hints.models.#{klass.model_name.i18n_key}.attributes.#{attribute_name}.#{type}",
-            :"#{scope}.hints.models.#{klass.model_name.i18n_key}.#{type}"
-          ]
-        end
-      else
-        model_defaults = []
+        defaults << :"#{scope}.hints.messages.#{type}"
       end
 
-      defaults = model_defaults
-      defaults << options[:message] if options[:message]
-      defaults << :"#{@base.class.i18n_scope}.hints.messages.#{type}" if @base.class.respond_to?(:i18n_scope)
+      defaults << :"activemodel.hints.messages.#{type}"
       defaults << :"hints.attributes.#{attribute_name}.#{type}"
       defaults << :"hints.messages.#{type}"
       defaults.compact.flatten
     end
 
+    def model_hint_defaults(attribute_name, type)
+      return [] unless @base.class.respond_to?(:i18n_scope)
+
+      scope = @base.class.i18n_scope
+      @base.class.lookup_ancestors.flat_map do |klass|
+        [
+          :"#{scope}.hints.models.#{klass.model_name.i18n_key}.attributes.#{attribute_name}.#{type}",
+          :"#{scope}.hints.models.#{klass.model_name.i18n_key}.#{type}"
+        ]
+      end
+    end
+
+    def i18n_format_defaults
+      defaults = []
+
+      if @base.class.respond_to?(:i18n_scope)
+        scope = @base.class.i18n_scope
+        @base.class.lookup_ancestors.each do |klass|
+          defaults << :"#{scope}.hints.models.#{klass.model_name.i18n_key}.format"
+        end
+        defaults << :"#{scope}.hints.format"
+      end
+
+      defaults << :"activemodel.hints.format"
+      defaults << :"hints.format"
+      defaults << "%{attribute} %{message}"
+    end
+
     def normalize_message(attribute, message, options = {})
       case message
       when Symbol

data/lib/validation_hints/locale/en.yml

@@ -1,5 +1,13 @@
 ---
 en:
+  activemodel:
+    hints:
+      format: "%{attribute} %{message}"
+
+  activerecord:
+    hints:
+      format: "%{attribute} %{message}"
+
   hints:
     format: "%{attribute} %{message}"
 

data/lib/validation_hints/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module ValidationHints
-  VERSION = "6.1.0"
+  VERSION = "6.2.0"
 end

data/test/active_model/i18n_test.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ActiveModelHintsI18nTest < Minitest::Test
+  def setup
+    @person = Person.new
+    @backend = I18n.backend
+    @kv = I18n::Backend::KeyValue.new({})
+    I18n.backend = I18n::Backend::Chain.new(@kv, @backend)
+  end
+
+  def teardown
+    I18n.backend = @backend
+  end
+
+  def test_activerecord_hints_messages_override
+    @kv.store_translations(:en, activerecord: { hints: { messages: { presence: "is required" } } })
+
+    assert_includes @person.hints[:name], "is required"
+  end
+
+  def test_activerecord_hints_model_attribute_override
+    @kv.store_translations(
+      :en,
+      activerecord: {
+        hints: {
+          models: {
+            person: {
+              attributes: {
+                name: { presence: "needs a name" }
+              }
+            }
+          }
+        }
+      }
+    )
+
+    assert_equal ["needs a name"], @person.hints[:name]
+  end
+
+  def test_hints_attributes_override
+    @kv.store_translations(:en, hints: { attributes: { name: { presence: "name hint" } } })
+
+    assert_equal ["name hint"], @person.hints[:name]
+  end
+
+  def test_top_level_hints_messages_override
+    @kv.store_translations(:en, hints: { messages: { presence: "fill this in" } })
+
+    assert_includes @person.hints[:name], "fill this in"
+  end
+
+  def test_full_message_uses_activerecord_human_attribute_name
+    @kv.store_translations(:en, activerecord: { attributes: { person: { name: "Your name" } } })
+
+    assert_equal ["Your name can't be blank"], @person.hints.full_messages_for(:name)
+  end
+
+  def test_full_message_format_override
+    @kv.store_translations(:en, activerecord: { hints: { format: "%{attribute}: %{message}" } })
+
+    assert_equal ["Name: can't be blank"], @person.hints.full_messages_for(:name)
+  end
+end

data/test/validation_hints_test.rb

@@ -4,7 +4,7 @@ require "test_helper"
 
 class ValidationHintsTest < Minitest::Test
   def test_version
-    assert_equal "6.1.0", ValidationHints::VERSION
+    assert_equal "6.2.0", ValidationHints::VERSION
   end
 
   def test_locale_path_exists

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validation_hints
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Ace Suares
@@ -114,6 +114,7 @@ files:
 - lib/validation_hints/validations_patch.rb
 - lib/validation_hints/version.rb
 - test/active_model/hints_test.rb
+- test/active_model/i18n_test.rb
 - test/test_helper.rb
 - test/validation_hints_test.rb
 - validation_hints.gemspec