activerecord-databasevalidations 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ef47e663a6ba33d804fe4c0535eb31f6f49027358600b0f737c44c4a77365a9
-  data.tar.gz: cdaced0a4508f5eed741d3392b81c90f63b46feb6d4400a70f4135580d4db155
+  metadata.gz: 19a316a681935a58dfcc28e3b1f61533b939f238c33b5e59168815b659fd46e9
+  data.tar.gz: 652292e8f015dd4a68ed58e3bda8875dc9cd692a073f62690dc25dacb6bd27b5
 SHA512:
-  metadata.gz: eed94b2b60f67811ae807a40c1bc98ef6a55692d80142dd0c4ec79bc8815b357c7e33851fe2d05535f9f71e5e30c71c46ffd0284e43ed0003bca585e3d5c8dd1
-  data.tar.gz: 83f0d060a77ede319afd46ea30deb0ac5271d204948f9f89300d2b818b283adcac739fc5f9a04e8d54ada6b3133c32bdbbc3ebb371911aa1be4065ab191fe76f
+  metadata.gz: 1a3e18729c91ed650c349a68daf2b2187453d8516fac073ca6f518469d775c9180e70e9f775236e8ca2ab5b2e4395ba7a9d8f2d14c0f5ffd142b4fad7a7713f9
+  data.tar.gz: '0659a85b324c4e939b7321e62c651c27a51f61f32fa42dc2f65abdb0c21f2db18f69b078c39864d632125290d144bec6fc5632db736a7c11d394680a4f17d59a'

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 1.0.3 (Mar 6, 2025)
+
+* Disable string truncation helpers for non-MySQL adapters.
+
+# 1.0.2 (Feb 5, 2025)
+
+* Disable size + range validations for non-MySQL adapters.
+
 # 1.0.1 (May 9, 2023)
 
 * Updated gemspec to point to the proper home page.

data/activerecord-databasevalidations.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
   spec.required_ruby_version = '>= 2.5'
 
   spec.add_runtime_dependency "activerecord", ">= 5.2"
@@ -26,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "sqlite3"
 end

data/dev.yml

@@ -0,0 +1,14 @@
+# This file is for Shopify employees development environment.
+# If you are an external contributor you don't have to bother with it.
+name: activerecord-databasevalidations
+
+up:
+  - packages:
+      - mysql_client
+  - ruby
+  - bundler
+  - mysql
+  - custom:
+      name: Create database
+      meet: mysql -uroot -h $MYSQL_HOST -P $MYSQL_PORT -e "CREATE DATABASE database_validations"
+      met?: mysql -uroot -h $MYSQL_HOST -P $MYSQL_PORT database_validations -e "SELECT 1" &> /dev/null

data/lib/active_record/database_validations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module DatabaseValidations
-    VERSION = "1.0.1"
+    VERSION = "1.0.3"
   end
 end

data/lib/active_record/validations/adapter_helper.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Validations
+    module AdapterHelper
+      def mysql_adapter?(connection)
+        connection.is_a?(ConnectionAdapters::AbstractMysqlAdapter)
+      end
+    end
+  end
+end

data/lib/active_record/validations/database_constraints.rb

@@ -1,9 +1,12 @@
 require 'active_model/validations/bytesize'
 require 'active_model/validations/not_null'
+require 'active_record/validations/adapter_helper'
 
 module ActiveRecord
   module Validations
     class DatabaseConstraintsValidator < ActiveModel::EachValidator
+      include Validations::AdapterHelper
+
       attr_reader :constraints
 
       VALID_CONSTRAINTS = Set[:size, :not_null, :range]
@@ -35,6 +38,7 @@ module ActiveRecord
 
       def size_validator(klass, column)
         return unless constraints.include?(:size)
+        return unless mysql_adapter?(klass.connection)
         return unless column.text? || column.binary?
 
         maximum, type, encoding = ActiveRecord::DatabaseValidations::MySQL.column_size_limit(column)
@@ -47,6 +51,7 @@ module ActiveRecord
 
       def range_validator(klass, column)
         return unless constraints.include?(:range)
+        return unless mysql_adapter?(klass.connection)
         return unless column.number?
 
         args = { attributes: [column.name.to_sym], class: klass, allow_nil: true }

data/lib/active_record/validations/string_truncator.rb

@@ -1,9 +1,13 @@
+require 'active_record/validations/adapter_helper'
+
 module ActiveRecord
   module DatabaseValidations
     module StringTruncator
       extend ActiveSupport::Concern
+      include Validations::AdapterHelper
 
       def truncate_value_to_field_limit(field, value)
+        return value unless mysql_adapter?(self.class.connection)
         return if value.nil?
 
         column = self.class.columns_hash[field.to_s]

data/test/database_constraints_validator_test.rb

@@ -43,6 +43,23 @@ class Num < ActiveRecord::Base
   validates :decimal, :unsigned_decimal, :tinyint, :smallint, :mediumint, :int, :bigint, :unsigned_int, database_constraints: :range
 end
 
+class SQLiteModel < ActiveRecord::Base
+  self.abstract_class = true
+  establish_connection(adapter: "sqlite3", database: ":memory:")
+  connection.create_table("not_my_sql_models", force: true) do |t|
+    t.text "text_column"
+    t.bigint "bigint_column"
+    t.string "not_null_column", null: false
+    t.string "null_column"
+  end
+end
+
+class NotMySQLModel < SQLiteModel
+  validates :text_column, database_constraints: :size
+  validates :bigint_column, database_constraints: :range
+  validates :not_null_column, database_constraints: :not_null
+end
+
 class DatabaseConstraintsValidatorTest < Minitest::Test
   include DataLossAssertions
 
@@ -103,6 +120,14 @@ class DatabaseConstraintsValidatorTest < Minitest::Test
     assert_equal Encoding.find('utf-8'), subvalidators.first.encoding
   end
 
+  def test_skips_size_and_range_validators_for_non_mysql_adapter
+    record = NotMySQLModel.new(not_null_column: "something")
+    assert(record.valid?)
+
+    record.not_null_column = nil
+    refute(record.valid?)
+  end
+
   def test_not_null_columns_with_a_default_value
     assert Foo.new.valid?
     assert Foo.new(checked: 1).valid?

data/test/string_truncator_test.rb

@@ -23,6 +23,19 @@ class MagicalCreature < ActiveRecord::Base
   truncate_to_field_limit :another_string
 end
 
+class MagicalSqliteCreature < ActiveRecord::Base
+  establish_connection(adapter: "sqlite3", database: ":memory:")
+  connection.create_table("magical_sqlite_creatures", force: true) do |t|
+    t.string :string, limit: 255
+    t.string :another_string, limit: 255
+  end
+
+  include ActiveRecord::DatabaseValidations::StringTruncator
+
+  before_validation truncate_string(:string)
+  truncate_to_field_limit :another_string
+end
+
 class StringTruncatorTest < Minitest::Test
   def test_handles_nil_gracefully
     u_nil = MagicalCreature.create!(string: 'present', tinytext: 'present')
@@ -72,4 +85,14 @@ class StringTruncatorTest < Minitest::Test
     u6 = MagicalCreature.new(another_string: 'a' * 256)
     assert_equal 'a' * 255, u6.another_string
   end
+
+  def test_skips_truncate_for_non_mysql_adapter
+    record = MagicalSqliteCreature.new(string: 'a' * 256)
+    assert(record.valid?)
+    assert_equal 'a' * 256, record.string
+
+    record.another_string = 'a' * 256
+    assert(record.valid?)
+    assert_equal 'a' * 256, record.another_string
+  end
 end

data/test/test_helper.rb

@@ -18,7 +18,7 @@ module DataLossAssertions
 
     persisted_values = record.reload.attributes.slice(*attributes)
     refute_equal provided_values, persisted_values
-  rescue RangeError
+  rescue ActiveRecord::RangeError, ActiveRecord::StatementInvalid, ActiveModel::RangeError
     pass
   end
 
@@ -33,8 +33,17 @@ module DataLossAssertions
   end
 end
 
-Minitest::Test = MiniTest::Unit::TestCase unless defined?(MiniTest::Test)
-
-database_yml = YAML.load_file(File.expand_path('../database.yml', __FILE__))
-ActiveRecord::Base.establish_connection(database_yml['test'])
+mysql_host = ENV.fetch("MYSQL_HOST") { "localhost" }
+mysql_port = ENV.fetch("MYSQL_PORT") { 3306 }
+mysql_connection_config = {
+  adapter: "mysql2",
+  database: "database_validations",
+  username: "root",
+  encoding: "utf8mb4",
+  strict: false,
+  host: mysql_host,
+  port: mysql_port,
+}
+
+ActiveRecord::Base.establish_connection(mysql_connection_config)
 I18n.enforce_available_locales = false

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-databasevalidations
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Willem van Bergen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Opt-in validations for your ActiveRecord models based on your MySQL database
   constraints, including text field size, UTF-8 encoding issues, and NOT NULL constraints.
 email:
@@ -89,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -96,6 +110,7 @@ files:
 - README.md
 - Rakefile
 - activerecord-databasevalidations.gemspec
+- dev.yml
 - gemfiles/Gemfile.activerecord52
 - gemfiles/Gemfile.activerecord60
 - lib/active_model/validations/bytesize.rb
@@ -106,14 +121,15 @@ files:
 - lib/active_record/database_validations/varchar_191.rb
 - lib/active_record/database_validations/varchar_255.rb
 - lib/active_record/database_validations/version.rb
+- lib/active_record/validations/adapter_helper.rb
 - lib/active_record/validations/database_constraints.rb
 - lib/active_record/validations/string_truncator.rb
 - lib/active_record/validations/typed_column.rb
 - lib/activerecord-databasevalidations.rb
 - lib/activerecord/databasevalidations.rb
+- shipit.rubygems.yml
 - test/bytesize_validator_test.rb
 - test/data_loss_test.rb
-- test/database.yml
 - test/database_constraints_validator_test.rb
 - test/not_null_validator_test.rb
 - test/string_truncator_test.rb
@@ -122,8 +138,8 @@ files:
 homepage: https://github.com/Shopify/activerecord-databasevalidations
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  allowed_push_host: https://rubygems.org
 rdoc_options: []
 require_paths:
 - lib
@@ -138,14 +154,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Add validations to your ActiveRecord models based on MySQL database constraints.
 test_files:
 - test/bytesize_validator_test.rb
 - test/data_loss_test.rb
-- test/database.yml
 - test/database_constraints_validator_test.rb
 - test/not_null_validator_test.rb
 - test/string_truncator_test.rb

data/test/database.yml

@@ -1,8 +0,0 @@
-test:
-  adapter: mysql2
-  database: database_validations
-  #username: travis
-  host: localhost
-  username: root
-  encoding: utf8mb4
-  strict: false