type_validator 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4c476ec164e1a9b0de994b41e374307ef6dd2d3a893b8b18b905b60472dd8e
-  data.tar.gz: e9be80d3aca12db0140cac027ffed3a5d3e2f3ab67c5e5267711cc5f7db6502e
+  metadata.gz: 16bbf2c1f264c32540b3a2a0b455dc14a5b808a85ff17ab2f2774070ac7a95a2
+  data.tar.gz: a7c6e27a77306aa5b79b9040c8823bb5da18d5bcd2e807b1de1b1a1f7f0c982a
 SHA512:
-  metadata.gz: da1a3abe19d8fb978109034d3341dc654d590e218eed093c31dae86e61b46327e7a8cdecd0a7fd8f3bff98fc0ea8187064c49ea74c42414441738885a43aa14c
-  data.tar.gz: 26b5661893d5699fff7ee08aff15e120dd57542b2147477c85467a5e3c796e749a2ed53913985d4cd3b6a345da782254ef16fe29c7d4c992b0d71f7f94398ee0
+  metadata.gz: 67949f5d4714cb33c9d2c6d759361993d0b28426644bacde350a86f597849e8313d13083d15abc046da4e03fe57226b9a6679dfc46b623be65f2f30ace13d672
+  data.tar.gz: 94af44dc82dbb1c52cbc2a7ea109e29d997db51a91852e409a7e2a5c1843aeb6e61fa353cc3a25e42f6305fed93b9f4646f2ac308aaacb45779f0a13777801d3

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -18,12 +18,4 @@ before_install:
 
 install: bundle install --jobs=3 --retry=3
 
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - "./cc-test-reporter before-build"
-
 script: "./.travis.sh"
-
-after_success:
-  - "./cc-test-reporter after-build -t simplecov"

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-activemodel_version = ENV.fetch('ACTIVEMODEL_VERSION', '6.1')
+activemodel_version = ENV.fetch('ACTIVEMODEL_VERSION', '6.0')
 
 activemodel = case activemodel_version
               when '3.2' then '3.2.22'
@@ -14,7 +14,7 @@ activemodel = case activemodel_version
               when '5.2' then '5.2.3'
               end
 
-if activemodel_version < '6.1'
+if activemodel_version < '6.0'
   gem 'activemodel', activemodel, require: false
   gem 'activesupport', activemodel, require: false
 end
@@ -24,5 +24,9 @@ group :test do
   gem 'simplecov', require: false
 end
 
+if RUBY_VERSION >= '2.6.0' && activemodel_version >= '6.0'
+  gem 'coveralls', require: false
+end
+
 # Specify your gem's dependencies in type_validator.gemspec
 gemspec

data/README.md

@@ -1,10 +1,9 @@
 [![Build Status](https://travis-ci.com/serradura/type_validator.svg?branch=master)](https://travis-ci.com/serradura/type_validator)
+[![Coverage Status](https://coveralls.io/repos/github/serradura/type_validator/badge.svg?branch=master)](https://coveralls.io/github/serradura/type_validator?branch=master)
 
 # TypeValidator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/type_validator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Adds type validation for classes with [`ActiveModel::Validations >= 3.2`](https://api.rubyonrails.org/classes/ActiveModel/Validations.html).
 
 ## Installation
 
@@ -24,7 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use one or all of the type validations into your models/classes:
+
+```ruby
+validates :name, type: { is_a: String }
+# or
+validates :name, type: { kind_of: String }
+
+# Use an array to verify if the attribute is an instance of one of the classes
+
+validates :status, type: { is_a: [String, Symbol]}
+# or
+validates :status, type: { kind_of: [String, Symbol]}
+```
+
+```ruby
+validates :handler, type: { respond_to: :call }
+```
+
+```ruby
+# Verifies if the attribute value is the class or a subclass.
+
+validates :handler, type: { klass: Handler }
+```
+
+```ruby
+validates :account_types, type: { array_of: String }
+
+# or use an array to verify if the attribute is an instance of one of the classes
+
+validates :account_types, type: { array_of: [String, Symbol] }
+```
+
+```ruby
+# Verifies if the attribute value is an array with some or all the expected values.
+
+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 }
+    ```
 
 ## Development
 
@@ -34,7 +81,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/type_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/serradura/type_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -42,4 +89,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TypeValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/type_validator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TypeValidator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/serradura/type_validator/blob/master/CODE_OF_CONDUCT.md).

data/lib/type_validator/by_array_of.rb

@@ -5,9 +5,8 @@ require 'active_model'
 class TypeValidator
   class ByArrayOf
     def self.invalid?(value, options)
-      types, allow_nil = Array(options[:array_of]), options[:allow_nil]
+      types = Array(options[:array_of])
 
-      return if (allow_nil && value.nil?)
       return if value.is_a?(Array) && !value.empty? && value.all? { |value| types.any? { |type| value.is_a?(type) } }
 
       "must be an array of: #{types.map { |klass| klass.name }.join(', ')}"

data/lib/type_validator/by_array_with.rb

@@ -5,11 +5,10 @@ require 'active_model'
 class TypeValidator
   class ByArrayWith
     def self.invalid?(value, options)
-      expected, allow_nil = options[:array_with], options[:allow_nil]
+      expected = options[:array_with]
 
       raise ArgumentError, "#{expected} must be an array" unless expected.is_a?(Array)
 
-      return if (allow_nil && value.nil?)
       return if value.is_a?(Array) && !value.empty? && (value - expected).empty?
 
       "must be an array with: #{expected.join(', ')}"

data/lib/type_validator/by_kind_of.rb

@@ -6,9 +6,8 @@ class TypeValidator
   class ByKindOf
     def self.invalid?(value, options)
       types = Array(options[:is_a] || options[:kind_of])
-      allow_nil = options[:allow_nil]
 
-      return if (allow_nil && value.nil?) || types.any? { |type| value.is_a?(type) }
+      return if types.any? { |type| value.is_a?(type) }
 
       "must be a kind of: #{types.map { |klass| klass.name }.join(', ')}"
     end

data/lib/type_validator/by_klass.rb

@@ -5,12 +5,12 @@ require 'active_model'
 class TypeValidator
   class ByKlass
     def self.invalid?(value, options)
-      klass, allow_nil = options[:klass], options[:allow_nil]
+      klass = options[:klass]
 
       require_a_class(value)
       require_a_class(klass)
 
-      return if (allow_nil && value.nil?) || (value == klass || value < klass)
+      return if value == klass || value < klass
 
       "must be the or a subclass of `#{klass.name}`"
     end

data/lib/type_validator/by_respond_to.rb

@@ -5,9 +5,9 @@ require 'active_model'
 class TypeValidator
   class ByRespondTo
     def self.invalid?(value, options)
-      method_name, allow_nil = options[:respond_to], options[:allow_nil]
+      method_name = options[:respond_to]
 
-      return if (allow_nil && value.nil?) || value.respond_to?(method_name)
+      return if value.respond_to?(method_name)
 
       "must respond to the method `#{method_name}`"
     end

data/lib/type_validator/version.rb

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

data/lib/type_validator.rb

@@ -8,6 +8,7 @@ class TypeValidator < ActiveModel::EachValidator
 
     raise Error::InvalidDefinition.new(attribute) unless strategy
 
+    return if options[:allow_nil] && value.nil?
     return unless error = strategy.invalid?(value, options)
 
     raise TypeError, "#{attribute} #{error}" if options[:strict]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: type_validator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rodrigo Serradura
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.sh"
 - ".travis.yml"