activerecord-databasevalidations 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 090f45578b6802cdbdba1069b5d37a9a36936e53
-  data.tar.gz: 8804b23a035aaa84fa334caa69fa862971bf0ffc
+  metadata.gz: e4aea1bc84aef567070fd2cb3febe2bdb6895daf
+  data.tar.gz: 2e8257b79b80d5b84d791b3ec7dfcffe3d115ea4
 SHA512:
-  metadata.gz: 48f4ce81a05aa5798f73b24997eea4920027318e4c48cdae4824c806a3cee5c84688058f204af0bf074b29360037108939bca38c0389b52f18cd3d3fd52ab941
-  data.tar.gz: 33774245ec628ff1b463559346e3e11699e302b4a41417676caf42ad08b5a8f07f3f613fb0d724c41edd883e7b51b90a660889e75cf4134d9e9526b909c8c438
+  metadata.gz: f7359255dd4cd2ad194d62aca4c6b7c19ffb26c999cb77a8d453b4fc28f7617f4bb4b30e520180a7a3cbf190fccccd08d31ca0d3e776d2d153ef6b4dcb9d41ff
+  data.tar.gz: 320f2a3744403023282bb9399fcc720a6592913142283dd8b3c3ec9e82146de6e7974e78b9678c4cc2e1ac924eb250f9acbe8adb70d9dcb56257b0d492bf96b8

data/README.md

@@ -1,9 +1,9 @@
 # ActiveRecord::DatabaseValidations
 
-Add validations to your ActiveRecord models based on your database constraints. 
+Add validations to your ActiveRecord models based on your database constraints.
 
-This gem is primarily intended for MySQL databases not running in strict mode, 
-which can easily cause data loss. These problems are documented in 
+This gem is primarily intended for MySQL databases not running in strict mode,
+which can easily cause data loss. These problems are documented in
 [DataLossTest](https://github.com/wvanbergen/activerecord-databasevalidations/blob/master/test/data_loss_test.rb)
 
 ## Installation
@@ -29,6 +29,7 @@ to validate based on the database constraints.
 class Foo < ActiveRecord::Base
   validates :boolean_field, database_constraints: :not_null
   validates :string_field, database_constraints: [:size, :basic_multilingual_plane]
+  validates :decimal_field, :integer_field, database_constraints: :range
 end
 ```
 
@@ -44,11 +45,12 @@ end
 
 You have to specify what conatrints you want to validate for. Valid values are:
 
-- `:size` to validate for the size of textual and binary columns. It will pick character 
+- `: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.
-- `:not_null` to validate a NOT NULL contraint.
-- `:basic_multilingual_plane` to validate that all characters for text fields are inside 
+- `: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`
 validation will only be added if the column has a NOT NULL constraint defined on it.
@@ -64,9 +66,31 @@ class Bar < ActiveRecord::Base
 end
 ```
 
-Note that this will create validations without inspecting the column to see if it 
+Note that this will create validations without inspecting the column to see if it
 actually makes sense.
 
+### Replicating MySQL's truncation behavior
+
+Sometimes, truncated a string that goes over the column's limit is the best option, if
+you don't want one field's value being too long prevent the record from saving.
+
+You can use `truncate_string` to replicate MySQL's non-strict truncating behavior, so
+you can prepare yourself for eventually turning on strict mode.
+
+
+``` ruby
+class Unicorn < ActiveRecord::Base
+  include ActiveRecord::DatabaseValidations::StringTruncator
+
+  before_validation truncate_string(:string_field)
+  validates :string_field, database_constraints: [:size]
+end
+```
+
+In this example, it will truncate the string to a size that will fit before validation,
+so the subsequent size validation will now always pass.
+
+
 ## Contributing
 
 1. Fork it (http://github.com/wvanbergen/activerecord-databasevalidations/fork)

data/lib/active_record/database_validations.rb

@@ -3,5 +3,6 @@ require 'active_support/i18n'
 require 'active_record/database_validations/version'
 
 require 'active_record/validations/database_constraints'
+require 'active_record/validations/string_truncator'
 
 I18n.load_path << File.dirname(__FILE__) + '/database_validations/locale/en.yml'

data/lib/active_record/database_validations/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module DatabaseValidations
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/active_record/validations/string_truncator.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module DatabaseValidations
+    module StringTruncator
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def truncate_string(field)
+          column = self.columns_hash[field.to_s]
+          case column.type
+          when :string
+            lambda do
+              return unless self.changes.key?(field.to_s)
+              return if self[field].nil?
+
+              limit = StringTruncator.mysql_textual_column_limit(column)
+              value = self[field].to_s
+              if value.length > limit
+                self[field] = value.slice(0, limit)
+              end
+              return true # to make sure the callback chain doesn't halt
+            end
+
+          when :text
+            lambda do
+              return unless self.changes.key?(field.to_s)
+              return if self[field].nil?
+
+              limit = StringTruncator.mysql_textual_column_limit(column)
+              value = self[field].to_s
+              value.encode!('utf-8') if value.encoding != Encoding::UTF_8
+              if value.bytesize > limit
+                self[field] = value.mb_chars.limit(limit).to_s
+              end
+              return true # to make sure the callback chain doesn't halt
+            end
+          end
+        end
+      end
+
+      def self.mysql_textual_column_limit(column)
+        @mysql_textual_column_limits ||= {}
+        @mysql_textual_column_limits[column] ||= begin
+          raise ArgumentError, "Only UTF-8 textual columns are supported." unless column.text? && column.collation =~ /\Autf8_/
+          column.limit
+        end
+      end
+    end
+  end
+end

data/test/string_truncator_test.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'test_helper'
+
+ActiveRecord::Migration.suppress_messages do
+  ActiveRecord::Migration.create_table("magical_creatures", force: true, options: "CHARACTER SET utf8mb3") do |t|
+    t.string   :string,   limit: 255
+    t.text     :tinytext, limit: 255
+  end
+end
+
+class MagicalCreature < ActiveRecord::Base
+  include ActiveRecord::DatabaseValidations::StringTruncator
+
+  before_validation truncate_string(:string)
+  before_validation truncate_string(:tinytext)
+
+  validates :string, :tinytext, database_constraints: :size
+end
+
+class StringTruncatorTest < Minitest::Test
+  def test_handles_nil_gracefully
+    u_nil = MagicalCreature.create!(string: 'present', tinytext: 'present')
+    u_nil.string, u_nil.tinytext = nil, nil
+    assert_equal ['string', 'tinytext'], u_nil.changed
+    assert u_nil.valid?
+  end
+
+  def test_truncate_varchar_field_using_characters
+    u1 = MagicalCreature.new(string: 'a' * 256)
+    assert u1.valid?
+    assert_equal 'a' * 255, u1.string
+
+    u2 = MagicalCreature.new(string: '漢' * 256)
+    assert u2.valid?
+    assert_equal '漢' * 255, u2.string
+  end
+
+  def test_truncate_text_fields_using_bytes
+    u1 = MagicalCreature.new(string: 'a' * 256)
+    assert u1.valid?
+    assert_equal 'a' * 255, u1.string
+
+    u2 = MagicalCreature.new(tinytext: '漢' * 86)
+    assert u2.valid?
+    assert_equal '漢' * 85, u2.tinytext
+
+    u3 = MagicalCreature.new(tinytext: 'ü' * 128) # note: field limit falls between the two bytes of the last character.
+    assert u3.valid?
+    assert_equal 'ü' * 127, u3.tinytext
+  end
+
+  def test_recoding_support_for_text_fields
+    u4 = MagicalCreature.new(tinytext: ('ü' * 128).encode('ISO-8859-15'))
+    assert u4.valid?
+    assert_equal 'ü' * 127, u4.tinytext
+    assert_equal Encoding::UTF_8, u4.tinytext.encoding
+  end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-databasevalidations
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Willem van Bergen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
 - !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
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   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'
 - !ruby/object:Gem::Dependency
   name: mysql2
   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
@@ -102,8 +102,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.activerecord40
 - Gemfile.activerecord41
@@ -118,6 +118,7 @@ files:
 - lib/active_record/database_validations/locale/en.yml
 - lib/active_record/database_validations/version.rb
 - lib/active_record/validations/database_constraints.rb
+- lib/active_record/validations/string_truncator.rb
 - lib/activerecord-databasevalidations.rb
 - lib/activerecord/databasevalidations.rb
 - test/basic_multilingual_plane_validator_test.rb
@@ -126,6 +127,7 @@ files:
 - test/database.yml
 - test/database_constraints_validator_test.rb
 - test/not_null_validator_test.rb
+- test/string_truncator_test.rb
 - test/test_helper.rb
 homepage: https://github.com/wvanbergen/activerecord-database_validations
 licenses:
@@ -137,17 +139,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Add validations to your ActiveRecord models based on MySQL database constraints.
@@ -158,4 +160,5 @@ test_files:
 - test/database.yml
 - test/database_constraints_validator_test.rb
 - test/not_null_validator_test.rb
+- test/string_truncator_test.rb
 - test/test_helper.rb