limitable 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40858400b0402bc9997ba697359789cf32255fc366d746a79d9fefb01c725ef1
-  data.tar.gz: d8719386f9528e0f9c508ece436f02259cc620a9692f84466eef205c2d4eab09
+  metadata.gz: fa345bff02b1a03c0ef3b2515de75383f9e1f55d2cf397fcd2660fe0a66b0746
+  data.tar.gz: 3f467cd6b86b8b97b1d7b9d749d0a507b943d9395c4691503cd051360d6ce557
 SHA512:
-  metadata.gz: cf6db368c846bd59f870c569d31a49f7bcb6a2d9e5cb508256b9acdbd9cf8b28582db914d0320af77354f8ea2517bcbbbcbb106861934fcbba96a52d25a89513
-  data.tar.gz: 205f0c6ced808e91f8c3475c0377093f52688e2b7e2c7b26e06e7071969f1c55a6692d1d271470b6f035eed45151910e604e04e23b6c66c28bfa3cd3c66013c4
+  metadata.gz: 6f3d2b2a5ba1904d1a6537bf635cc5ba1c8c374d381ae92fab53b44895e0df3c961ecfbd5bb6dd9440622bb256c5c994cf29a73f416fbea96d0974ea16fa5d46
+  data.tar.gz: e14012f9cb14604324304088be9cb9cd6dc620e40b2e5233f0d2964386ebccbd4fe755e12859cd95be2a73d3d60bb5c6c3c78bb5d747aca65aa8ff26120d35ea

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [2.0.0](https://github.com/benmelz/limitable/compare/v1.1.0...v2.0.0) (2023-07-30)
+
+
+* feat!: custom translations (#15) ([bacc785](https://github.com/benmelz/limitable/commit/bacc7858d7d506bba60bad2f1d39c32732136aa3)), closes [#15](https://github.com/benmelz/limitable/issues/15) [#12](https://github.com/benmelz/limitable/issues/12)
+
+
+### BREAKING CHANGES
+
+* reword default validation error messages
+
 # [1.1.0](https://github.com/benmelz/limitable/compare/v1.0.1...v1.1.0) (2023-07-17)
 
 

data/README.md

@@ -59,6 +59,22 @@ class MyModel < ApplicationRecord
 end
 ```
 
+### Translations
+
+`Limitable` ships with i18n support for its validation error messages. Each column type has its own translation key,
+outlined alongside their default values in `lib/limitable/locale/en.yml`.
+
+Each validator will pass a `limit` parameter (min/max integer for integer columns, bytes for string/text/binary),
+which can be used to make the messages less ambiguous if desired.
+
+e.g.
+
+```yaml
+en:
+  limitable:
+    string_limit_exceeded: "may not exceed %{limit} characters"
+```
+
 ### SQL Adapters
 
 `Limitable` is designed to be SQL adapter agnostic, however different adapters have different default behaviors that

data/lib/limitable/locale/en.yml

@@ -0,0 +1,8 @@
+en:
+  limitable:
+    integer_limit_exceeded:
+      upper: "is too large"
+      lower: "is too small"
+    string_limit_exceeded: "is too long"
+    text_limit_exceeded: "is too long"
+    binary_limit_exceeded: "is too large"

data/lib/limitable/locale.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'i18n'
+
+module Limitable
+  # == Limitable::Locale
+  #
+  # Loads the default limitable custom translations into i18n.
+  #
+  module Locale
+    I18n.load_path << File.expand_path('locale/en.yml', __dir__)
+  end
+end

data/lib/limitable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Limitable
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/limitable.rb

@@ -3,6 +3,7 @@
 require 'active_record'
 require 'i18n'
 require_relative 'limitable/base'
+require_relative 'limitable/locale'
 require_relative 'limitable/version'
 
 # == Limitable
@@ -32,10 +33,8 @@ module Limitable
       return if limit.blank?
 
       case column.type
-      when :integer
-        klass.validate(&build_integer_limit_validator(column_name, limit))
-      when :binary, :string, :text
-        klass.validate(&build_string_limit_validator(column_name, limit))
+      when :integer, :string, :text, :binary
+        klass.validate(&send(:"build_#{column.type}_limit_validator", column_name, limit))
       end
     end
 
@@ -49,18 +48,35 @@ module Limitable
         end
         next unless value.is_a? Integer
 
-        errors.add column_name, I18n.t('errors.messages.greater_than_or_equal_to', count: min) if value < min
-        errors.add column_name, I18n.t('errors.messages.less_than_or_equal_to', count: max) if value > max
+        errors.add column_name, I18n.t('limitable.integer_limit_exceeded.lower', limit: min) if value < min
+        errors.add column_name, I18n.t('limitable.integer_limit_exceeded.upper', limit: max) if value > max
       end
     end
 
     def build_string_limit_validator(column_name, limit)
       lambda do
         value = self.class.type_for_attribute(column_name).serialize self[column_name]
-        value = value.to_s if value.is_a? ActiveModel::Type::Binary::Data
         next unless value.is_a?(String) && value.bytesize > limit
 
-        errors.add column_name, I18n.t('errors.messages.too_long.other', count: limit)
+        errors.add column_name, I18n.t('limitable.string_limit_exceeded', limit: limit)
+      end
+    end
+
+    def build_text_limit_validator(column_name, limit)
+      lambda do
+        value = self.class.type_for_attribute(column_name).serialize self[column_name]
+        next unless value.is_a?(String) && value.bytesize > limit
+
+        errors.add column_name, I18n.t('limitable.text_limit_exceeded', limit: limit)
+      end
+    end
+
+    def build_binary_limit_validator(column_name, limit)
+      lambda do
+        value = self.class.type_for_attribute(column_name).serialize self[column_name]
+        next unless value.is_a?(ActiveModel::Type::Binary::Data) && value.to_s.bytesize > limit
+
+        errors.add column_name, I18n.t('limitable.binary_limit_exceeded', limit: limit)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limitable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Benjamin Melz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -63,6 +63,8 @@ files:
 - README.md
 - lib/limitable.rb
 - lib/limitable/base.rb
+- lib/limitable/locale.rb
+- lib/limitable/locale/en.yml
 - lib/limitable/version.rb
 homepage: https://github.com/benmelz/limitable
 licenses:
@@ -70,7 +72,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/benmelz/limitable
   source_code_uri: https://github.com/benmelz/limitable
-  changelog_uri: https://github.com/benmelz/limitable/blob/v1.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/benmelz/limitable/blob/v2.0.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []