limitable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6c12a16cc4494f377161bf1391268d66e74cce94d4483c0f62a9d6cca7aa7ec
+  data.tar.gz: 5d691e45c1b9a244289781285dcaf05445e2b965ff3116c1b5492da1c2284741
+SHA512:
+  metadata.gz: 2b9c14a552cd790b9dd0ddce4d8e8dda51b9407eef62abf5a72c86ea0f7de08343699a6e88809632f2630048cd6f5a696fb7af414eb1e4493f6f943b246a7e49
+  data.tar.gz: 06ab70e18d5063028f850fca942a96638456f14611f6ff1c51d7c26c3e1c5f2a70c3794e214036aa574bb97dfa5ed416e145532c6100bae3512d3a845249f229

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2023-05-30)
+
+
+### Features
+
+* limitable ([#1](https://github.com/benmelz/limitable/issues/1)) ([0040aeb](https://github.com/benmelz/limitable/commit/0040aeba6d2b6f40feefe9040b10e412ccc33b59))

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Benjamin Melz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Limitable
+
+Limitable scans your ActiveRecord database schema for column size limits and defines corresponding model validations
+so that you don't have to.
+
+It aims to make your database schema the "one source of truth" about the maximum data sizes your columns can handle.
+More practically, it removes the redundant need for explicit guards such as:
+
+```ruby
+validates :my_string_column, length: { less_than: 256 }
+
+validates :my_integer_column, numericality: { less_than: 2_147_483_647 }
+
+begin
+  # ...
+rescue ActiveRecord::ValueTooLong
+  # ...
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add limitable
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+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.
+
+### Quick Start
+
+To enable these database limit validations globally:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include Limitable::Base
+
+  # ...
+end
+```
+
+To enable database limit validations on a per-model basis:
+
+```ruby
+class MyModel < ApplicationRecord
+  include Limitable
+
+  # ...
+end
+```
+
+### SQL Adapters
+
+`Limitable` is designed to be SQL adapter agnostic, however although some adapters have different default
+default behaviors than others.
+
+#### `mysql2`
+
+MySQL/mariadb has and reports hard limits on all supported column types. As such, you won't need to specify explicit
+limits in your database migrations/schema unless you want to change them from their default values.
+
+#### `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.
+
+#### `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.
+
+## Development
+
+- Run `bin/setup` to install dependencies.
+- Run `bin/rake appraisal rspec` to run the tests.
+- Run `bin/rake rubocop` to run the linter.
+- Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benmelz/limitable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/limitable/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Limitable
+  # == Limitable::Base
+  #
+  # Module that allows for automatic inclusion of Limitable within subclasses when extended in a superclass.
+  #
+  module Base
+    def inherited(klass)
+      super
+      klass.include Limitable
+    end
+  end
+end

data/lib/limitable/version.rb

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

data/lib/limitable.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'i18n'
+require_relative 'limitable/base'
+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.
+#
+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)
+      end
+    end
+
+    private
+
+    def safe_column_names(klass)
+      klass.column_names
+    rescue ActiveRecord::ActiveRecordError, ArgumentError
+      nil
+    end
+
+    def add_limit_validation(klass, column, type)
+      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
+      end
+    end
+
+    def add_integer_limit_validation(klass, column_name, limit, type)
+      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)
+
+        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]
+        next unless value.is_a?(String) && value.bytesize > limit
+
+        errors.add column_name, I18n.t('errors.messages.too_long.other', count: limit)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: limitable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Melz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 'Limitable scans your ActiveRecord database schema for column size limits
+  and defines corresponding model validations so that you don''t have to. '
+email:
+- ben@melz.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/limitable.rb
+- lib/limitable/base.rb
+- lib/limitable/version.rb
+homepage: https://github.com/benmelz/limitable
+licenses:
+- MIT
+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
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Inferred database limit validations for ActiveRecord.
+test_files: []