schema_validations 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8484a054c29074d10d3fa8dbb06df1206e4f3d3f
-  data.tar.gz: a6d45b80b265de0de5c5d23a33ddfcfbafc4c2e4
+  metadata.gz: 57990870ff9defa81491b9a1ddfeb8070ce0f4da
+  data.tar.gz: 3553e2c896fbde23dc9458ebc4b4c0ddefa67594
 SHA512:
-  metadata.gz: d0e13def81c02bf86fe2a0df3f557cccfc9ec5f50a1501a43bedb5837f3b311a64e13867e8d8bacb682ddfddb068f5ff936d72514d6d3d99be54ebb5cea9412c
-  data.tar.gz: 302f4ea589910494881650a2aae57ed654cadc880622acfc0b645a5d66c89122bbbaff1f55ecc59ebb27efff05af58d0473d4285aa510b4d05907a02f2cea325
+  metadata.gz: 09d958820120ccb7a284996ca3308ed3ecee9971ff194c5c9a8de67f4a4d311cd53ae3fc4e9d0ff51c802e8f607da2343e9f1f07dbd2a6161e25e5b366f26d8b
+  data.tar.gz: 32906f059b3b7ae7eac3ba36b0b400d6edf3ec39bd43d8555f7ce024c983106c3551f83c887dfceee48526305c44645a6ad77f61222fd665473db4f6a1922529

data/README.md

@@ -22,8 +22,7 @@ constraints.
       t.boolean :confirmed, :null => false
     end
 
-In that case :null => false, :limit => 30 and :boolean must be covered on the
-model level.
+In that case the constraints `:null => false`, `:limit => 30` and `:boolean` must be validated on the model level, to avoid ugly database exceptions:
 
     class User < ActiveRecord::Base
       validates :email, :presence => true, :length => { :maximum => 30 }
@@ -32,9 +31,7 @@ model level.
 
 ...which isn't the most DRY approach.
 
-SchemaValidations aims to cover that and does boring work for you. It inspect
-the database and automatically creates validations basing on the schema. After
-installing it your model is as simple as it can be.
+SchemaValidations aims to DRY up your models, doing that boring work for you. It inspects the database and automatically creates validations based on the schema. After installing it your model is as simple as it can be.
 
     class User < ActiveRecord::Base
     end
@@ -42,64 +39,19 @@ installing it your model is as simple as it can be.
 Validations are there but they are created by schema_validations under the
 hood.
 
-## Compatibility
-
-As of version 1.2.0, SchemaValidations supports and is tested on:
-
-<!-- SCHEMA_DEV: MATRIX - begin -->
-<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->
-* ruby **2.1.5** with activerecord **4.2**, using **mysql2**, **postgresql** or **sqlite3**
-
-<!-- SCHEMA_DEV: MATRIX - end -->
-
-Earlier versions of SchemaValidations supported:
-
-*   rails 3.2, 4.1, and 4.2.0
-*   MRI ruby 1.9.3 and 2.1.5
-
 ## Installation
 
 Simply add schema_validations to your Gemfile.
 
     gem "schema_validations"
-
-### What if I want something special?
-
-SchemaValidations is highly customizable. You can configure behavior globally
-via SchemaValidations.setup or per-model via
-SchemaValidations::ActiveRecord::schema_validations, such as:
-
-    class User < ActiveRecord::Base
-      schema_validations :except => :email
-      validates :email, :presence => true, :length => { :in => 5..30 }
-    end
-
-See SchemaValidations::Config for the available options.
-
-### This seems cool, but I'm worried about too much automagic
-
-You can globally turn off automatic creation in
-`config/initializers/schema_validations.rb`:
-
-    SchemaValidations.setup do |config|
-      config.auto_create = false
-    end
-
-Then in any model where you want automatic validations, just do
-
-    class Post < ActiveRecord::Base
-      schema_validations
-    end
-
-You can also pass options as per above.
-
+    
 ## Which validations are covered?
 
 Constraints:
 
 |      Constraint     |                     Validation                           |
 |---------------------|----------------------------------------------------------|
-| :null => false      | validates ... :presence => true                          |
+| `:null => false      | validates ... :presence => true                          |
 | :limit => 100       | validates ... :length => { :maximum => 100 }             |
 | :unique => true     | validates ... :uniqueness => true                        |
 | :unique => true, :case_sensitive => false <br>(If [schema_plus_pg_indexes](https://github.com/SchemaPlus/schema_plus_pg_indexes) is also in use) | validates ... :uniqueness => { :case_sensitive => false } |
@@ -112,6 +64,82 @@ Data types:
 | :float             | :validates ... :numericality => true                                                                           |
 | :integer           | :validates ... :numericality => { :only_integer => true, :greater_than_or_equal_to => ..., :less_than => ... } |
 
+
+## What if I want something special?
+
+SchemaValidations' behavior can be configured globally and per-model.
+
+### Global configuration
+
+In an initializer, such as `config/initializers/schema_validations.rb`, you can set any of these options.  The default values are shown.
+
+```ruby
+SchemaValidations.setup do |config|
+
+    # Whether to automatically create validations based on database constraints.
+    # (Can be set false globally to disable the gem by default, and set true per-model to enable.)
+    config.auto_create = true
+    
+    # Restricts the set of field names to include in automatic validation.
+    # Value is a single name, an array of names, or nil.
+    config.only = nil
+
+    # Restricts the set of validation types to include in automatic validation.
+    # Value is a single type, an array of types, or nil.
+    # A type is specified as, e.g., `:validates_presence_of` or simply `:presence`.
+    config.only_type = nil
+    
+    # A list of field names to exclude from automatic validation.
+    # Value is a single name, an array of names, or nil.
+    # (Providing a value per-model will completely replace a globally-configured list)
+    config.except = nil
+    
+    # A list of validation types to exclude from automatic validation.
+    # Value is a single type, an array of types, or nil.
+    # (Providing a value per-model will completely replace a globally-configured list)
+    config.except_type = nil
+       
+    # The base set of field names to always exclude from automatic validation.
+    # Value is a single name, an array of names, or nil.
+    # (This whitelist applies after all other considerations, global or per-model)
+    config.whitelist = [:created_at, :updated_at, :created_on, :updated_on]
+       
+    # The base set of validation types to always exclude from automatic validation.
+    # Value is a single type, an array of types, or nil.
+    # (This whitelist applies after all other considerations, global or per-model)
+    config.whitelist_type = nil
+end
+```    
+
+### Per-model validation
+
+You can override the global configuration per-model, using the `schema_validations` class method.  All global configuration options are available as keyword options.  For example:
+
+##### Disable per model:
+```ruby
+    class User < ActiveRecord::Base
+      schema_validations auto_create: false
+    end
+```
+
+##### Use a custom validation rather than schema_validations automatic default:
+```ruby
+    class User < ActiveRecord::Base
+      schema_validations except: :email  # don't create default validation for email
+      validates :email, presence: true, length: { in: 5..30 }
+    end
+```
+
+##### Include validations every field, without a whitelist:
+
+```ruby
+    class User < ActiveRecord::Base
+      schema_validations :whitelist => nil
+    end
+```
+
+
+
 ## How do I know what it did?
 If you're curious (or dubious) about what validations SchemaValidations
 defines, you can check the log file.  For every assocation that
@@ -123,14 +151,36 @@ which shows the exact validation definition call.
 
 
 SchemaValidations defines the validations lazily for each class, only creating
-them when they are needed (to validate a record of the class, or in response
+them when they are needed (in order to validate a record of the class, or in response
 to introspection on the class).  So you may need to search through the log
 file for "schema_validations" to find all the validations, and some classes'
 validations may not be defined at all if they were never needed for the logged
 use case.
 
+## Compatibility
+
+As of version 1.2.0, SchemaValidations supports and is tested on:
+
+<!-- SCHEMA_DEV: MATRIX - begin -->
+<!-- These lines are auto-generated by schema_dev based on schema_dev.yml -->
+* ruby **2.1.5** with activerecord **4.2**, using **mysql2**, **postgresql** or **sqlite3**
+
+<!-- SCHEMA_DEV: MATRIX - end -->
+
+Earlier versions of SchemaValidations supported:
+
+*   rails 3.2, 4.1, and 4.2.0
+*   MRI ruby 1.9.3 and 2.1.5
+
+
 ## Release Notes
 
+### 2.0.0
+
+This major version is backwards compatible for most uses.  Only those who specified a per-model `:except` clause would be affected.
+
+* Add whitelist configuration option (thanks to [@allenwq](https://github.com/allenwq)). Previously, overriding `:except` per-model would clobber the default values.  E.g. using the documented example `except: :mail` would accidentally cause validations to be issued `updated_at` to be validated.  Now `:except` works more naturally.  This is however technically a breaking change, hence the version bump.
+
 ### 1.4.0
 
 * Add support for case-insensitive uniqueness.  Thanks to [allenwq](https://github.com/allenwq)

data/lib/schema_validations.rb

@@ -36,11 +36,26 @@ module SchemaValidations
     has_value :only, :default => nil
 
     ##
-    # :attr_accessor: except
+    # :attr_accessor: whitelist
     #
     # List of field names to exclude from automatic validation.
     # Value is a single name, an array of names, or +nil+.  Default is <tt>[:created_at, :updated_at, :created_on, :updated_on]</tt>.
-    has_value :except, :default => [:created_at, :updated_at, :created_on, :updated_on]
+    has_value :whitelist, :default => [:created_at, :updated_at, :created_on, :updated_on]
+
+    ##
+    # :attr_accessor: except
+    #
+    # List of field names to exclude from automatic validation.
+    # Value is a single name, and array of names, or +nil+.  Default is +nil+.
+    has_value :except, :default => nil
+
+    ##
+    # :attr_accessor: whitelist_type
+    #
+    # List of validation types to exclude from automatic validation.
+    # Value is a single type, and array of types, or +nil+.  Default is +nil+.
+    # A type is specified as, e.g., +:validates_presence_of+ or simply +:presence+.
+    has_value :whitelist_type, :default => nil
 
     ##
     # :attr_accessor: except_type

data/lib/schema_validations/active_record/validations.rb

@@ -201,10 +201,12 @@ module SchemaValidations
         if match = macro.to_s.match(/^validates_(.*)_of$/)
           types << match[1].to_sym
         end
-        return false if config.only        and not Array.wrap(config.only).include?(name)
-        return false if config.except      and     Array.wrap(config.except).include?(name)
-        return false if config.only_type   and not (Array.wrap(config.only_type) & types).any?
-        return false if config.except_type and     (Array.wrap(config.except_type) & types).any?
+        return false if config.only           and not Array.wrap(config.only).include?(name)
+        return false if config.except         and     Array.wrap(config.except).include?(name)
+        return false if config.whitelist      and     Array.wrap(config.whitelist).include?(name)
+        return false if config.only_type      and not (Array.wrap(config.only_type) & types).any?
+        return false if config.except_type    and     (Array.wrap(config.except_type) & types).any?
+        return false if config.whitelist_type and     (Array.wrap(config.whitelist_type) & types).any?
         return true
       end
 

data/lib/schema_validations/version.rb

@@ -1,3 +1,3 @@
 module SchemaValidations
-  VERSION = "1.4.0"
+  VERSION = "2.0.0"
 end

data/spec/validations_spec.rb

@@ -21,6 +21,7 @@ describe "Validations" do
         t.string :author, :null => false
         t.string :content, :limit => 200
         t.string :type
+        t.timestamps :null => false
       end
       add_index :reviews, :article_id, :unique => true
 
@@ -175,6 +176,18 @@ describe "Validations" do
       expect(@review.error_on(:author).size).to eq(1)
     end
 
+    it "shouldn't validate the fields in default whitelist" do
+      Review.schema_validations :except => :content
+      expect(Review.new.error_on(:updated_at).size).to eq(0)
+      expect(Review.new.error_on(:created_at).size).to eq(0)
+    end
+
+    it "shouldn't validate the fields in whitelist" do
+      Review.schema_validations :except => :content, whitelist: [:updated_at]
+      expect(Review.new.error_on(:updated_at).size).to eq(0)
+      expect(Review.new.error_on(:created_at).size).to eq(1)
+    end
+
     it "shouldn't validate types passed to :except_type option using full validation" do
       Review.schema_validations :except_type => :validates_length_of
       @review = Review.new(:content => @too_big_content)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_validations
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ronen Barzel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2016-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schema_plus_columns