activerecord-databasevalidations 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbf207cb2907bee539a88662d3db30dc5ed839798cbfd9cfd85825477c2eb239
-  data.tar.gz: daf34dab34b3d74bfc478c96f83fb49e6058a04fdd5351200fdb845707f87967
+  metadata.gz: 2f077f16b8f0e2832a0e5d50c3e4ce45953725296ce0bcf31f1715413e362c2e
+  data.tar.gz: 8f82f37b686c7cdd222dae109c1a13caabfcc1086e5be71d0defee5b02dc89a8
 SHA512:
-  metadata.gz: 8e9be16afadaa21e4954ef0f5cee4d3a890831e3b3b18b19b020363121d774138bd98063ba40334988825f4fd4821daf5ca495f6f76e5fa42a17155ec962d2d2
-  data.tar.gz: b4dbec89f5d44fd5a6235147fe8dd98a97cb6e4a37cca1e804d977091c80ea4054d781b7fcf61e9fb93a9bfcf02c191606ac2b751e20efe1a8aa75cdb0da62af
+  metadata.gz: 5e34412eb9b7662b4a972de4bfff63cc7ff5eb40880965ad9531ce8aed174d0d203015481f6b7c2b4bfe16bc0a1ffd9081ea88e4ceefb2d0f2ddf886cad6457e
+  data.tar.gz: e36e86a6bbbc6ed588a23a2b509193f0dfa788957a3d1c2b7ea06e81e8e957f41b8e529a2be5f24d087d83f1a67f63e00e06d7278a9289d800d561f1f6a8b22e

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# Unreleased
+
+# 1.0.0 (May 12, 2021)
+
+* Removed the utf8mb3 validator as it is a bit anachronistic in 2021.
+
 # 0.5.1 (May 22, 2020)
 
 * Fix various Ruby 2.7 warnings

data/README.md

@@ -30,7 +30,7 @@ to validate based on the database constraints.
 ``` ruby
 class Foo < ActiveRecord::Base
   validates :boolean_field, database_constraints: :not_null
-  validates :string_field, database_constraints: [:size, :basic_multilingual_plane]
+  validates :string_field, database_constraints: [:size]
   validates :decimal_field, :integer_field, database_constraints: :range
 end
 ```
@@ -50,8 +50,6 @@ You have to specify what conatrints you want to validate for. Valid values are:
 - `:range` to validate the numeric range of a column based on it's type.
 - `:size` to validate for the size of textual and binary columns. It will pick character
   size or bytesize based on the column's type.
-- `:basic_multilingual_plane` to validate that all characters for text fields are inside
-  the basic multilingual plane of unicode (unless you use the utf8mb4 character set).
 - `:not_null` to validate a NOT NULL contraint.
 
 The validations will only be created if it makes sense for the column, e.g. a `:not_null`
@@ -63,7 +61,7 @@ You can also instantiate the validators yourself:
 
 ``` ruby
 class Bar < ActiveRecord::Base
-  validates :string_field, bytesize: { maximum: 255 }, basic_multilingual_plane: true
+  validates :string_field, bytesize: { maximum: 255 }
   validates :string_field, not_null: true
 end
 ```

data/activerecord-databasevalidations.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.5'
 
   spec.add_runtime_dependency "activerecord", ">= 5.2"
-  spec.add_runtime_dependency "rejectu"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/active_record/database_validations/locale/en.yml

@@ -4,5 +4,4 @@ en:
     # The value :count is available when applicable. Can be used for pluralization.
     messages:
       too_many_bytes: "is too long (maximum is %{count} bytes)"
-      characters_outside_basic_multilingual_plane: "contains characters outside Unicode's basic multilingual plane"
       must_be_set: "must be set"

data/lib/active_record/database_validations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module DatabaseValidations
-    VERSION = "0.5.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/active_record/validations/database_constraints.rb

@@ -1,13 +1,12 @@
 require 'active_model/validations/bytesize'
 require 'active_model/validations/not_null'
-require 'active_model/validations/basic_multilingual_plane'
 
 module ActiveRecord
   module Validations
     class DatabaseConstraintsValidator < ActiveModel::EachValidator
       attr_reader :constraints
 
-      VALID_CONSTRAINTS = Set[:size, :basic_multilingual_plane, :not_null, :range]
+      VALID_CONSTRAINTS = Set[:size, :not_null, :range]
 
       SIZE_VALIDATORS_FOR_TYPE = {
         characters: ActiveModel::Validations::LengthValidator,
@@ -55,12 +54,6 @@ module ActiveRecord
         ActiveModel::Validations::NumericalityValidator.new(args)
       end
 
-      def basic_multilingual_plane_validator(klass, column)
-        return unless constraints.include?(:basic_multilingual_plane)
-        return unless column.text? && column.collation =~ /\Autf8(?:mb3)?_/
-        ActiveModel::Validations::BasicMultilingualPlaneValidator.new(attributes: [column.name.to_sym], class: klass)
-      end
-
       def attribute_validators(klass, attribute)
         @constraint_validators[attribute] ||= begin
           column_definition = klass.columns_hash[attribute.to_s]
@@ -74,7 +67,6 @@ module ActiveRecord
           [
             not_null_validator(klass, column),
             size_validator(klass, column),
-            basic_multilingual_plane_validator(klass, column),
             range_validator(klass, column),
           ].compact
         end

data/test/data_loss_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 ActiveRecord::Migration.suppress_messages do
-  ActiveRecord::Migration.create_table("unicorns", force: true, options: "CHARACTER SET utf8mb3") do |t|
+  ActiveRecord::Migration.create_table("unicorns", force: true) do |t|
     t.column :string,           "VARCHAR(40)"
     t.column :tinytext,         "TINYTEXT"
     t.column :blob,             "BLOB"
@@ -97,11 +97,4 @@ class DataLossTest < Minitest::Test
     refute_data_loss Unicorn.new(blob: [].pack('x65535')) # 65535 is bytesize limit of blob field
     assert_data_loss Unicorn.new(blob: [].pack('x65536'))
   end
-
-  def test_utf8mb3_field_sliently_truncates_strings_after_first_4byte_character
-    emoji = "\u{1F4A9}"
-    assert_equal 1, emoji.length
-    assert_equal 4, emoji.bytesize
-    assert_data_loss Unicorn.new(string: emoji)
-  end
 end

data/test/database.yml

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

data/test/database_constraints_validator_test.rb

@@ -13,10 +13,6 @@ ActiveRecord::Migration.suppress_messages do
     t.integer  :unchecked,     null: false
   end
 
-  ActiveRecord::Migration.create_table("bars", force: true, options: "CHARACTER SET utf8mb4") do |t|
-    t.string   :mb4_string
-  end
-
   ActiveRecord::Migration.create_table("empties", force: true)
 
   ActiveRecord::Migration.create_table("nums", force: true) do |t|
@@ -34,11 +30,7 @@ end
 class Foo < ActiveRecord::Base
   validates :string, :tinytext, :varbinary, :blob, database_constraints: :size
   validates :checked, database_constraints: :not_null
-  validates :not_null_text, database_constraints: [:size, :basic_multilingual_plane]
-end
-
-class Bar < ActiveRecord::Base
-  validates :mb4_string, database_constraints: :basic_multilingual_plane
+  validates :not_null_text, database_constraints: [:size]
 end
 
 class Empty < ActiveRecord::Base
@@ -55,10 +47,10 @@ class DatabaseConstraintsValidatorTest < Minitest::Test
   include DataLossAssertions
 
   def test_argument_validation
-    assert_raises(ArgumentError) { Bar.validates(:mb4_string, database_constraints: []) }
-    assert_raises(ArgumentError) { Bar.validates(:mb4_string, database_constraints: true) }
-    assert_raises(ArgumentError) { Bar.validates(:mb4_string, database_constraints: :bogus) }
-    assert_raises(ArgumentError) { Bar.validates(:mb4_string, database_constraints: [:size, :bogus]) }
+    assert_raises(ArgumentError) { Foo.validates(:string, database_constraints: []) }
+    assert_raises(ArgumentError) { Foo.validates(:string, database_constraints: true) }
+    assert_raises(ArgumentError) { Foo.validates(:string, database_constraints: :bogus) }
+    assert_raises(ArgumentError) { Foo.validates(:string, database_constraints: [:size, :bogus]) }
   end
 
   def test_column_validation
@@ -104,10 +96,9 @@ class DatabaseConstraintsValidatorTest < Minitest::Test
   def test_not_null_text_field_defines_requested_bytesize_validator_and_unicode_validator
     validator = Foo._validators[:not_null_text].first
     subvalidators = validator.attribute_validators(Foo, :not_null_text)
-    assert_equal 2, subvalidators.length
+    assert_equal 1, subvalidators.length
 
     assert_kind_of ActiveModel::Validations::BytesizeValidator, subvalidators.first
-    assert_kind_of ActiveModel::Validations::BasicMultilingualPlaneValidator, subvalidators.second
     assert_equal 65535, subvalidators.first.options[:maximum]
     assert_equal Encoding.find('utf-8'), subvalidators.first.encoding
   end
@@ -118,13 +109,6 @@ class DatabaseConstraintsValidatorTest < Minitest::Test
     refute Foo.new(checked: nil).valid?
   end
 
-  def test_should_not_create_a_validator_for_a_utf8mb4_field
-    assert Bar._validators[:mb4_string].first.attribute_validators(Bar, :mb4_string).empty?
-    emoji = Bar.new(mb4_string: '')
-    assert emoji.valid?
-    refute_data_loss emoji
-  end
-
   def test_decimal_range
     subvalidators = Num._validators[:decimal].first.attribute_validators(Num, :decimal)
     assert_equal 1, subvalidators.length
@@ -219,7 +203,6 @@ class DatabaseConstraintsValidatorTest < Minitest::Test
 
     assert_equal ["is too long (maximum is 40 characters)"], foo.errors[:string]
     assert_equal ["must be set"], foo.errors[:checked]
-    assert_equal ["contains characters outside Unicode's basic multilingual plane"], foo.errors[:not_null_text]
   end
 
   def test_encoding_craziness

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-databasevalidations
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Willem van Bergen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rejectu
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +98,6 @@ files:
 - activerecord-databasevalidations.gemspec
 - gemfiles/Gemfile.activerecord52
 - gemfiles/Gemfile.activerecord60
-- lib/active_model/validations/basic_multilingual_plane.rb
 - lib/active_model/validations/bytesize.rb
 - lib/active_model/validations/not_null.rb
 - lib/active_record/database_validations.rb
@@ -126,7 +111,6 @@ files:
 - lib/active_record/validations/typed_column.rb
 - lib/activerecord-databasevalidations.rb
 - lib/activerecord/databasevalidations.rb
-- test/basic_multilingual_plane_validator_test.rb
 - test/bytesize_validator_test.rb
 - test/data_loss_test.rb
 - test/database.yml
@@ -139,7 +123,7 @@ homepage: https://github.com/wvanbergen/activerecord-database_validations
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,12 +138,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Add validations to your ActiveRecord models based on MySQL database constraints.
 test_files:
-- test/basic_multilingual_plane_validator_test.rb
 - test/bytesize_validator_test.rb
 - test/data_loss_test.rb
 - test/database.yml

data/lib/active_model/validations/basic_multilingual_plane.rb

@@ -1,27 +0,0 @@
-require 'rejectu/rejectu'
-
-module ActiveModel
-  module Validations
-    class BasicMultilingualPlaneValidator < ActiveModel::EachValidator
-      OUTSIDE_BMP = /[^\u{0}-\u{FFFF}]/
-
-      def validate_each(record, attribute, value)
-        return if value.nil?
-        return if value.to_s.encoding != Encoding::UTF_8
-
-        unless Rejectu.valid?(value.to_s)
-          errors_options = options.except(:characters_outside_basic_multilingual_plane)
-          default_message = options[:characters_outside_basic_multilingual_plane]
-          errors_options[:message] ||= default_message if default_message
-          record.errors.add(attribute, :characters_outside_basic_multilingual_plane, **errors_options)
-        end
-      end
-    end
-
-    module HelperMethods
-      def validates_basic_multilingual_plane_of(*attr_names)
-        validates_with ActiveModel::Validations::BasicMultilingualPlaneValidator, _merge_attributes(attr_names)
-      end
-    end
-  end
-end

data/test/basic_multilingual_plane_validator_test.rb

@@ -1,54 +0,0 @@
-# encoding: utf-8
-require 'test_helper'
-
-class BasicMultilingualPlaneValidatorTest < Minitest::Test
-
-  class Model
-    include ActiveModel::Validations
-
-    attr_accessor :unicode
-    validates :unicode, basic_multilingual_plane: true
-  end
-
-  def setup
-    @model = Model.new
-  end
-
-  def test_basic_multilingual_plane_string
-    @model.unicode = 'basic multilingual ünicode'
-    assert @model.valid?
-
-  end
-
-  def test_emoji
-    @model.unicode = '💩'
-    assert @model.invalid?
-    assert_equal ["contains characters outside Unicode's basic multilingual plane"], @model.errors[:unicode]
-  end
-
-  def test_nil
-    @model.unicode = nil
-    assert @model.valid?
-  end
-
-  def test_different_type
-    @model.unicode = 1
-    assert @model.valid?
-  end
-
-  def test_non_unicode_encoding
-    @model.unicode = 'ü'.encode('ISO-8859-15')
-    assert @model.valid?
-  end
-
-  def test_utf8mb3_japanese
-    @model.unicode = 'これは普通なストリングです'
-    assert @model.valid?
-  end
-
-  def test_utf8mb4_kanji
-    @model.unicode = '𠜎𠜱𠝹𠱓𠱸𠲖𠳏𠳕𠴕𠵼𠵿𠸎𠸏𠹷'
-    assert @model.invalid?
-    assert_equal ["contains characters outside Unicode's basic multilingual plane"], @model.errors[:unicode]
-  end
-end