simple_validate 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4db1a522454d744858748c2a133394aa53445dc4
-  data.tar.gz: f2aefa1bdb0dfdaa75c3e09048a3528d447eddbe
+SHA256:
+  metadata.gz: 4be4e322ba8383ab04495306a2ed7b71db142d32062e50f11fc6c27a60632491
+  data.tar.gz: 1aeaad50c99f01008917a593b73fbe0c87e45e72548d5a479f4d8e646756109b
 SHA512:
-  metadata.gz: 8199d16f338ed071e96058e1b5c3729f8f77b500729fd24fcfcf457aec63d5966052dd14c9427e0fda7131bcd669af6960371525f64e5445bf8b0cdc54a18db3
-  data.tar.gz: 009e75ade7581bbd0e31636558f66601f06e0eec28565e54231c475f0ce40a95d829672f33cafd43d7042c2d17ce46da391c650280164f55795379b374ec88da
+  metadata.gz: 04b3f8dcbe4ab31acd3b65a407e1c561dcc2a6a813551b9bb7227e2b8c37b143ad157c0165099ccb0d1fd2759c81fbe7b679010274f79cde3b48c84b98eabd0a
+  data.tar.gz: 383a7560fd119a51047ca27d0dbc790cfd1127b9b09533ad6ab590e365a419d62509dee923814a7b9aa8cf5aafc7702a5206f66354cec01635e71748e532476a

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

data/README.md

@@ -1,9 +1,8 @@
-
-# SimpleValidate
+# Simple Validate
 
 [![Build Status](https://travis-ci.org/nikkypx/simple_validate.svg?branch=master)](https://travis-ci.org/nikkypx/simple_validate)
 
-Borrowing ideas from [validatable](https://github.com/jnunemaker/validatable) and Rails validations, this is a library for validations for any ruby object.
+> Borrowing ideas from [validatable](https://github.com/jnunemaker/validatable) and Rails validations, this is a library for validations for any ruby object.
 
 ## Installation
 
@@ -35,7 +34,9 @@ class Person
   validates_presence_of :name, :age
   validates_numericality_of :age
 end
+```
 
+```ruby
 => p = Person.new
 => #<Person:0x007f9431536408>
 => p.valid?
@@ -49,10 +50,8 @@ end
 
 ### Presence
 
-* It is possible to pass a different message to any validation.
-
 ```ruby
-  validates_presence_of :attribute, message: 'NOT HERE'
+  validates_presence_of :attribute
 ```
 
 ### Numericality
@@ -64,7 +63,7 @@ end
 ### Format
 
 ```ruby
-  validates_format_of :attribute, with: /.*/
+  validates_format_of :attribute, with: /[A-Z]+/
 ```
 
 ### Length
@@ -77,10 +76,37 @@ end
   validates_length_of :attribute, in: 6..9
 ```
 
+### Inclusion and Exclusion
+
+```ruby
+  validates_inclusion_of :domain, in: [:net, :com]
+  validates_exclusion_of :name, in: [:Bojack, :Horseman]
+```
+
+### Options
+
+#### Custom error messages
+
+* It is possible to pass a custom error message to any validation.
+
+```ruby
+  validates_presence_of :attribute, message: 'attribute is required!'
+```
+
+#### Conditional validation
+
+* It is possible to pass an `if` option with a proc for a conditional validation
+
+```ruby
+  validates_presence_of :attribute, if: Proc.new { true }
+```
+
+
 ## Development
 
 `$ rake` to run the specs
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nikkypx/simple_validate.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: %i[rubocop spec]

data/lib/simple_validate/validates_base.rb

@@ -1,11 +1,11 @@
 module SimpleValidate
   class ValidatesBase
-    attr_reader :message
-    attr_accessor :attribute
+    attr_accessor :message, :attribute, :condition
 
-    def initialize(attribute, message)
-      @message   = message
-      @attribute = attribute
+    def initialize(attribute, message, condition)
+      self.message   = message
+      self.attribute = attribute
+      self.condition = condition
     end
   end
 end

data/lib/simple_validate/validates_exclusion_of.rb

@@ -0,0 +1,8 @@
+module SimpleValidate
+  class ValidatesExclusionOf < ValidatesSetBase
+    def valid?(instance)
+      raise ArgumentError if set.empty? || !options.fetch(:in).is_a?(Array)
+      !set.include?(instance.send(attribute).to_s)
+    end
+  end
+end

data/lib/simple_validate/validates_format_of.rb

@@ -1,13 +1,16 @@
 module SimpleValidate
   class ValidatesFormatOf < ValidatesBase
+    attr_accessor :regex
 
     def initialize(attribute, options)
-      @regex = options[:with]
-      super(attribute, options[:message] || "is incorrect format")
+      self.regex = options[:with]
+      super(attribute, options[:message] ||
+        'is incorrect format', options[:if] || proc { true })
     end
 
     def valid?(instance)
-      !!(instance.send(attribute) =~ @regex)
+      raise ArgumentError if regex.nil? || !regex.is_a?(Regexp)
+      !!(instance.send(attribute) =~ regex)
     end
   end
 end

data/lib/simple_validate/validates_inclusion_of.rb

@@ -0,0 +1,8 @@
+module SimpleValidate
+  class ValidatesInclusionOf < ValidatesSetBase
+    def valid?(instance)
+      raise ArgumentError if set.empty? || !options.fetch(:in).is_a?(Array)
+      set.include?(instance.send(attribute).to_s)
+    end
+  end
+end

data/lib/simple_validate/validates_length_of.rb

@@ -1,21 +1,20 @@
 module SimpleValidate
-  class ValidatesLengthOf
-    attr_reader :attribute
+  class ValidatesLengthOf < ValidatesBase
     class InvalidLengthOption < ArgumentError; end
+    attr_reader :attribute
+    attr_accessor :options
 
-    VALID_LENGTH_OPTIONS = %i(maximum minimum in is)
+    VALID_LENGTH_OPTIONS = %i[maximum minimum in is].freeze
 
     def initialize(attribute, options)
-      @message          = options.delete(:message)
-      @attribute        = attribute
-      @options          = options
-      check_options(@options)
-      @length_validator = @options.select { |k, _| VALID_LENGTH_OPTIONS.include?(k) }
+      super(attribute, options.delete(:message), options.delete(:if) ||
+        proc { true })
+      self.options = options
     end
 
     def message
       @message ||= begin
-                     case @length_validator.keys.first
+                     case validator
                      when :minimum
                        'is too short'
                      when :maximum
@@ -27,18 +26,15 @@ module SimpleValidate
     end
 
     def validator
-      @options.entries.first
+      options.keys.first
     end
 
-    def check_options(options)
-      if options.keys.size > 1 || !VALID_LENGTH_OPTIONS.include?(options.keys.first)
-        raise InvalidLengthOption, "Invalid length option given #{@options.keys}"
-      end
+    def valid_length
+      options.values.first
     end
 
     def valid_length?(actual_length)
-      validator_key, valid_length = @length_validator.entries.first
-      case validator_key
+      case validator
       when :minimum
         actual_length >= valid_length
       when :maximum
@@ -51,6 +47,14 @@ module SimpleValidate
     end
 
     def valid?(instance)
+      if options.keys.size > 1
+        raise ArgumentError, 'Only one length argument can be provided'
+      end
+
+      unless VALID_LENGTH_OPTIONS.include?(options.keys.first)
+        raise InvalidLengthOption, "Invalid length option given #{options.keys}"
+      end
+
       actual_length = instance.send(attribute).length
       valid_length?(actual_length)
     end

data/lib/simple_validate/validates_numericality_of.rb

@@ -1,7 +1,8 @@
 module SimpleValidate
   class ValidatesNumericalityOf < ValidatesBase
     def initialize(attribute, options)
-      super(attribute, options[:message] || 'must be a number')
+      super(attribute, options[:message] ||
+        'must be a number', options[:if] || proc { true })
     end
 
     def valid?(instance)

data/lib/simple_validate/validates_presence_of.rb

@@ -1,8 +1,8 @@
 module SimpleValidate
   class ValidatesPresenceOf < ValidatesBase
-
     def initialize(attribute, options)
-      super(attribute, options[:message] || "can't be empty")
+      super(attribute, options[:message] ||
+        "can't be empty", options[:if] || proc { true })
     end
 
     def valid?(instance)

data/lib/simple_validate/validates_set_base.rb

@@ -0,0 +1,14 @@
+require 'set'
+
+module SimpleValidate
+  class ValidatesSetBase < ValidatesBase
+    attr_accessor :set, :options
+
+    def initialize(attribute, options)
+      self.options = options
+      self.set = Set.new(Array(options[:in]).map(&:to_s))
+      super(attribute, options[:message] ||
+        'breaks inclusion/exclusion rules', options[:if] || proc { true })
+    end
+  end
+end

data/lib/simple_validate/version.rb

@@ -1,3 +1,3 @@
 module SimpleValidate
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'.freeze
 end

data/lib/simple_validate.rb

@@ -1,10 +1,16 @@
-require 'simple_validate/version'
-require 'simple_validate/validates_base'
-require 'simple_validate/validates_presence_of'
-require 'simple_validate/validates_format_of'
-require 'simple_validate/validates_numericality_of'
-require 'simple_validate/validates_length_of'
+%w[base
+   presence_of
+   format_of
+   numericality_of
+   length_of
+   set_base
+   inclusion_of
+   exclusion_of].each do |validation|
+     require "simple_validate/validates_#{validation}"
+   end
+
 require 'simple_validate/errors'
+require 'simple_validate/version'
 require 'active_support/all'
 
 module SimpleValidate
@@ -26,18 +32,20 @@ module SimpleValidate
 
   module ClassMethods
     def method_missing(method, *args, &block)
-      if respond_to_missing?(method)
-        add_validations(args, const_get("#{method}".classify))
+      if respond_to?(method)
+        add_validations(args, const_get(method.to_s.classify))
       else
         super
       end
     end
 
     def respond_to_missing?(method, include_private = false)
-      "#{method}" =~ /(validates_
+      method.to_s =~ /(validates_
                        (format|
                         presence|
                         numericality|
+                        inclusion|
+                        exclusion|
                         length)_of)
       /x || super
     end
@@ -55,7 +63,7 @@ module SimpleValidate
 
     def validate(instance)
       validations.each do |validation|
-        unless validation.valid?(instance)
+        if validation.condition.call && !validation.valid?(instance)
           instance.errors.add(validation.attribute, validation.message)
         end
       end

data/simple_validate.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'simple_validate/version'
@@ -14,11 +13,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/nikkypx/simple_validate'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
-  spec.add_dependency 'activesupport',       '~> 4.2'
-  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_validate
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Nick Palaniuk
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: '3.0'
+        version: '0'
 description: Validations for any ruby object
 email:
 - npalaniuk@gmail.com
@@ -47,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -55,10 +70,13 @@ files:
 - lib/simple_validate.rb
 - lib/simple_validate/errors.rb
 - lib/simple_validate/validates_base.rb
+- lib/simple_validate/validates_exclusion_of.rb
 - lib/simple_validate/validates_format_of.rb
+- lib/simple_validate/validates_inclusion_of.rb
 - lib/simple_validate/validates_length_of.rb
 - lib/simple_validate/validates_numericality_of.rb
 - lib/simple_validate/validates_presence_of.rb
+- lib/simple_validate/validates_set_base.rb
 - lib/simple_validate/version.rb
 - simple_validate.gemspec
 homepage: https://github.com/nikkypx/simple_validate
@@ -81,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Validations for any plain old ruby object
 test_files: []
-has_rdoc: