type_validator 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74eb421ea1f47501223d2373ffc493ada6b69a2707b5a958c5570dc6d554cb91
-  data.tar.gz: a1462cca7867b4110a34628c64a758ec6fc9966a7ffe81b84434cfe6a2134e53
+  metadata.gz: ba79f5bd84487f22cc5c8c6147373f6c85a45fa3a75eb30d5b5206a7aca5a10e
+  data.tar.gz: 4e43d6578742bf34ac3ef1670e6fd266b481834484f94e97722ac1594993389b
 SHA512:
-  metadata.gz: 5d11e5db37ba9ccdd7619ee093e3f973fb93ad8bfbddfbc53304608b3ec09efc3415b658b69cb8dfb49f9b6a328e2e9cd1f5f45250284ec7541c4b2eae73aa64
-  data.tar.gz: c67081c3c93240f2f49c4c74736405ffc364e0f069adaa1694ca2a6125110f94aa78c905d73108fefb9717a7e20ba35311a2c833084c1f091f98f6ffa69e03d9
+  metadata.gz: 721ae336cca31a9b8f884e70c24da3f8f73de887baf080208d2cea65b8b336e368e0608d1fa7862c746a918e63e146f82a3b868f104669093053bd2ef2b4916a
+  data.tar.gz: 5a2ede7c1908ae96b60e0398acbbb3ac02d30dd51886bbaccd3299617b62747541a046739ef93aadc6933f3afa90ee379cee7a21b3854bc3fb6f03f332b1fcf4

data/README.md

@@ -1,10 +1,23 @@
+[![Gem](https://img.shields.io/gem/v/type_validator.svg?style=flat-square)](https://rubygems.org/gems/type_validator)
 [![Build Status](https://travis-ci.com/serradura/type_validator.svg?branch=master)](https://travis-ci.com/serradura/type_validator)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cf8b233beedae37b82dd/maintainability)](https://codeclimate.com/github/serradura/type_validator/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/serradura/type_validator/badge.svg?branch=master)](https://coveralls.io/github/serradura/type_validator?branch=master)
 
 # TypeValidator
 
 Adds type validation for classes with [`ActiveModel::Validations >= 3.2`](https://api.rubyonrails.org/classes/ActiveModel/Validations.html).
 
+- [TypeValidator](#typevalidator)
+  - [Required Ruby version](#required-ruby-version)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Default validation](#default-validation)
+    - [`allow_nil` option and `strict` mode](#allownil-option-and-strict-mode)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
 ## Required Ruby version
 > \>= 2.2.0
 
@@ -26,7 +39,7 @@ Or install it yourself as:
 
 ## Usage
 
-Use one or all of the type validations into your models/classes:
+Use any of the type validations below into your models/classes:
 
 **[Object#instance_of?](https://ruby-doc.org/core-2.6.4/Object.html#method-i-instance_of-3F)**
 
@@ -88,18 +101,45 @@ validates :account_types, type: { array_of: [String, Symbol] }
 validates :account_types, type: { array_with: ['foo', 'bar'] }
 ```
 
-### All the validations above accept:
-
-- `allow_nil` option. e.g:. e.g:
-    ```ruby
-    validates :name, type: { is_a: String }, allow_nil: true
-    ```
-- `strict: true` option or the usage of `validates!`method. e.g:
-    ```ruby
-    validates :name, type: { is_a: String }, strict: true
-    #or
-    validates! :name, type: { is_a: String }
-    ```
+### Default validation
+
+By default, you can define the attribute type directly (without a hash). e.g.
+
+```ruby
+validates :name, type: String
+# or
+validates :name, type: [String, Symbol]
+```
+
+To changes this behavior you can set another strategy to validates the attributes types:
+
+```ruby
+TypeValidator.default_validation = :instance_of
+
+# Tip: Create an initializer if you are in a Rails application.
+```
+
+And these are the available options to define the default validation:
+-  `kind_of` *(default)*
+-  `is_a`
+-  `instance_of`
+
+### `allow_nil` option and `strict` mode
+
+You can use the `allow_nil` option with any of the type validations. e.g.
+
+```ruby
+validates :name, type: { is_a: String }, allow_nil: true
+```
+
+And any of the validations work with the`strict: true` option
+or with the `validates!` method. e.g.
+
+```ruby
+validates :name, type: { is_a: String }, strict: true
+#or
+validates! :name, type: { is_a: String }
+```
 
 ## Development
 

data/lib/type_validator.rb

@@ -16,9 +16,13 @@ class TypeValidator < ActiveModel::EachValidator
   private
 
     def validate_type_of(attribute, value)
+      if expected = options[:with] || options[:in]
+        return send("validate_#{self.class.default_validation}", value, expected)
+      end
+
       if expected = options[:instance_of]; return validate_instance_of(value, expected); end
-      if expected = options[:is_a]       ; return validate_kind_of(value, expected)    ; end
       if expected = options[:kind_of]    ; return validate_kind_of(value, expected)    ; end
+      if expected = options[:is_a]       ; return validate_is_a(value, expected)       ; end
       if expected = options[:klass]      ; return validate_klass(value, expected)      ; end
       if expected = options[:respond_to] ; return validate_respond_to(value, expected) ; end
       if expected = options[:array_of]   ; return validate_array_of(value, expected)   ; end
@@ -42,6 +46,7 @@ class TypeValidator < ActiveModel::EachValidator
 
       "must be a kind of: #{types.map { |klass| klass.name }.join(', ')}"
     end
+    alias_method :validate_is_a, :validate_kind_of
 
     def validate_klass(value, klass)
       require_a_class(value)
@@ -80,4 +85,5 @@ class TypeValidator < ActiveModel::EachValidator
 end
 
 require 'type_validator/version'
+require 'type_validator/default_validation'
 require 'type_validator/error'

data/lib/type_validator/default_validation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class TypeValidator
+  DEFAULT_VALIDATION_OPTIONS = %w[instance_of is_a kind_of].freeze
+
+  def self.default_validation
+    @default_validation ||= :kind_of
+  end
+
+  def self.default_validation=(option)
+    if DEFAULT_VALIDATION_OPTIONS.include?(String(option))
+      @default_validation = option.to_sym
+    else
+      raise Error::InvalidDefaultValidation.new(option)
+    end
+  end
+end

data/lib/type_validator/error.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_model'
-
 class TypeValidator
   module Error
     class InvalidDefinition < ArgumentError
@@ -13,5 +11,18 @@ class TypeValidator
 
       private_constant :OPTIONS
     end
+
+    class InvalidDefaultValidation < ArgumentError
+      OPTIONS =
+        TypeValidator::DEFAULT_VALIDATION_OPTIONS
+          .map { |option| ":#{option}" }
+          .join(', ')
+
+      def initialize(option)
+        super "#{option.inspect} is an invalid option. Please use one of these: #{OPTIONS}"
+      end
+
+      private_constant :OPTIONS
+    end
   end
 end

data/lib/type_validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TypeValidator
-  VERSION = '0.11.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: type_validator
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -86,6 +86,7 @@ files:
 - bin/console
 - bin/setup
 - lib/type_validator.rb
+- lib/type_validator/default_validation.rb
 - lib/type_validator/error.rb
 - lib/type_validator/version.rb
 - test.sh