limitable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c12a16cc4494f377161bf1391268d66e74cce94d4483c0f62a9d6cca7aa7ec
-  data.tar.gz: 5d691e45c1b9a244289781285dcaf05445e2b965ff3116c1b5492da1c2284741
+  metadata.gz: 40858400b0402bc9997ba697359789cf32255fc366d746a79d9fefb01c725ef1
+  data.tar.gz: d8719386f9528e0f9c508ece436f02259cc620a9692f84466eef205c2d4eab09
 SHA512:
-  metadata.gz: 2b9c14a552cd790b9dd0ddce4d8e8dda51b9407eef62abf5a72c86ea0f7de08343699a6e88809632f2630048cd6f5a696fb7af414eb1e4493f6f943b246a7e49
-  data.tar.gz: 06ab70e18d5063028f850fca942a96638456f14611f6ff1c51d7c26c3e1c5f2a70c3794e214036aa574bb97dfa5ed416e145532c6100bae3512d3a845249f229
+  metadata.gz: cf6db368c846bd59f870c569d31a49f7bcb6a2d9e5cb508256b9acdbd9cf8b28582db914d0320af77354f8ea2517bcbbbcbb106861934fcbba96a52d25a89513
+  data.tar.gz: 205f0c6ced808e91f8c3475c0377093f52688e2b7e2c7b26e06e7071969f1c55a6692d1d271470b6f035eed45151910e604e04e23b6c66c28bfa3cd3c66013c4

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.1.0](https://github.com/benmelz/limitable/compare/v1.0.1...v1.1.0) (2023-07-17)
+
+
+### Features
+
+* support for binary column limits ([#14](https://github.com/benmelz/limitable/issues/14)) ([43224d1](https://github.com/benmelz/limitable/commit/43224d1351052833246b94666b7aca76f8c89aa5)), closes [#3](https://github.com/benmelz/limitable/issues/3)
+
+## [1.0.1](https://github.com/benmelz/limitable/compare/v1.0.0...v1.0.1) (2023-06-09)
+
+
+### Bug Fixes
+
+* consider serialized values for custom types ([#7](https://github.com/benmelz/limitable/issues/7)) ([86cf913](https://github.com/benmelz/limitable/commit/86cf91307211411db3582fa3d780df6f96663bfb))
+
 # 1.0.0 (2023-05-30)
 
 

data/README.md

@@ -34,16 +34,16 @@ gem install limitable
 
 ## Usage
 
-Once included in a model, `Limitable` will scan `integer`, `string` and `text` columns for size limits
-and define _byte size_ validations accordingly. Limits are configurable through `ActiveRecord` migrations.
+Once included in a model, `Limitable` will scan `integer`, `string`, `text` and `binary` columns for size limits,
+defining byte size validations accordingly. Limits are configurable through `ActiveRecord` migrations.
 
 ### Quick Start
 
-To enable these database limit validations globally:
+To enable database limit validations globally:
 
 ```ruby
 class ApplicationRecord < ActiveRecord::Base
-  include Limitable::Base
+  extend Limitable::Base
 
   # ...
 end
@@ -61,8 +61,8 @@ end
 
 ### SQL Adapters
 
-`Limitable` is designed to be SQL adapter agnostic, however although some adapters have different default
-default behaviors than others.
+`Limitable` is designed to be SQL adapter agnostic, however different adapters have different default behaviors that
+affect their integration with this library.
 
 #### `mysql2`
 
@@ -72,12 +72,13 @@ limits in your database migrations/schema unless you want to change them from th
 #### `pg`
 
 PostgreSQL has and reports hard limits on its integer columns, however it supports and defaults to unlimited
-string/text columns. If you wish for limits to be set, they must be explicitly set in your database migrations/schema.
+string/text/binary columns. If you wish for limits to be validated on those columns, they must be explicitly set in your
+database migrations/schema.
 
 #### `sqlite3`
 
 SQLite has hard limits on most of its column types, but it does not report them to active record. If you wish for limits
-to be picked up, they must be explicitly set in your database migrations/schema.
+to be validated, they must be explicitly set in your database migrations/schema.
 
 ## Development
 

data/lib/limitable/version.rb

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

data/lib/limitable.rb

@@ -8,13 +8,13 @@ require_relative 'limitable/version'
 # == Limitable
 #
 # Module that declares database limit validations when included in an ActiveRecord model class. Supports limit
-# inferences on integer, string and text columns.
+# inferences on integer, string, text and binary columns.
 #
 module Limitable
   class << self
     def included(klass)
-      safe_column_names(klass)&.each do |column_name|
-        add_limit_validation klass, klass.column_for_attribute(column_name), klass.type_for_attribute(column_name)
+      safe_column_names(klass).each do |column_name|
+        attach_limit_validator_if_needed klass, column_name
       end
     end
 
@@ -23,52 +23,51 @@ module Limitable
     def safe_column_names(klass)
       klass.column_names
     rescue ActiveRecord::ActiveRecordError, ArgumentError
-      nil
+      []
     end
 
-    def add_limit_validation(klass, column, type)
+    def attach_limit_validator_if_needed(klass, column_name)
+      column = klass.column_for_attribute column_name
       limit = column.sql_type_metadata.limit
       return if limit.blank?
 
       case column.type
       when :integer
-        add_integer_limit_validation klass, column.name, limit, type
-      when :string, :text
-        add_string_limit_validation klass, column.name, limit, type
+        klass.validate(&build_integer_limit_validator(column_name, limit))
+      when :binary, :string, :text
+        klass.validate(&build_string_limit_validator(column_name, limit))
       end
     end
 
-    def add_integer_limit_validation(klass, column_name, limit, type)
+    def build_integer_limit_validator(column_name, limit)
       min, max = integer_limit_range limit
-      integer_type_normalizer = method :integer_type_normalizer
-      klass.validate do
-        value = integer_type_normalizer.call self[column_name], type
-        next unless value.is_a?(Integer)
+      lambda do
+        value = begin
+          self.class.type_for_attribute(column_name).serialize self[column_name]
+        rescue ActiveModel::RangeError => e
+          e.message.match(/(?<number>\d+) is out of range/)[:number].to_i
+        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
       end
     end
 
-    def integer_limit_range(limit)
-      max = ('1' * (limit * 8)).to_i(2) / 2
-      min = -max
-      [min, max]
-    end
-
-    def integer_type_normalizer(value, type)
-      type.serialize value
-    rescue ActiveModel::RangeError
-      value.to_i
-    end
-
-    def add_string_limit_validation(klass, column_name, limit, type)
-      klass.validate do
-        value = type.serialize self[column_name]
+    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)
       end
     end
+
+    def integer_limit_range(limit)
+      max = (1 << ((limit * 8) - 1)) - 1
+      min = -max
+      [min, max]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limitable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Melz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -70,7 +70,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.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/benmelz/limitable/blob/v1.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []