subvalid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: edca18185857cfbbc93dbb3314d3d09083c5f200
-  data.tar.gz: af80dce164c5388a450adaba42db36d4f414ca73
+SHA256:
+  metadata.gz: c0653675ee971b2059d362155fd30634850d423b4137cbde73d65516b7ba599b
+  data.tar.gz: e95bcb0dde03e2be59337374573928b70a5ff16f7bf801d1922b4d6cce98e8de
 SHA512:
-  metadata.gz: 9875098c16bcc27ce0acafb0248684536dca09adabfc199c554cd2b4c71d8a7452b4b9b3ecb9e76764e90167cfe98fa01b2fec6d86db6f62839f070b924bf9fb
-  data.tar.gz: e9099ec87e31f154edd3fa4448efe3e2ff7c034cc6538aa77def84fc98d02775850a1782d7ceff0936cc14cf1a438da6c0c8b5d5a57032f5748cc0996549cfa3
+  metadata.gz: 3547b4e243cb436ba8440804932a94abdc1b242f8fd0dd7692864ee35d0964c15ddf5d900438b81bfee4327d5b60767e78daf0631c31dc967aab537dbdd5a542
+  data.tar.gz: f1309e4d68890d1df8fc40a54d61f7099f0c830ed4a1bb813a1bba8fb389ff5e953ff433b22c1e83f371af2fa0cb1306a577a91224dbf2785d9e6f740fb334ea

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.1.6
-  - 2.0.0
+  - 2.6.3
+  - 2.5.5
+  - 2.5.1
+  - 2.3.8
   - ruby-head
-  - jruby-9.0.0.0
+  - jruby-9.2.7.0
+before_install:
+  - gem install bundler --no-doc

data/README.md

@@ -164,6 +164,35 @@ class PersonValidator
 end
 ```
 
+### Length Options
+
+You can specify length constraints in different ways:
+
+```ruby
+class PersonValidator
+  include Subvalid::Validator
+
+  validates :name, length: { minimum: 2 }
+  validates :bio, length: { maximum: 500 }
+  validates :password, length: { in: 6..20 }
+  validates :registration_number, length: { is: 6 }
+end
+```
+
+The possible length constraint options are:
+
+`:minimum` - The attribute cannot have less than the specified length.
+
+`:maximum` - The attribute cannot have more than the specified length.
+
+`:in` (or `:within`) - The attribute length must be included in a given interval. The value for this option must be a range.
+
+`:is` - The attribute length must be equal to the given value.
+
+The default error messages depend on the type of length validation being performed. You can use the `:message` option to specify an error message.
+
+Note that the default error messages are plural. A personalised message should be provided in cases where it is grammatically incorrect, eg, "cannot be shorter than 1 characters".
+
 ## Contact
 
 - [github project](https://github.com/envato/subvalid)

data/lib/subvalid/validators/length_validator.rb

@@ -4,11 +4,19 @@ module Subvalid
       def self.validate(object, validation_result=ValidationResult.new, *args)
         return unless object
         args = args.to_h
+        message = args.delete(:message)
         args.each do |operator, value|
           case operator
+          when :minimum
+            validation_result.add_error(message || "cannot be shorter than #{value} characters") if object.size < value
           when :maximum
-            validation_result.add_error("is too long, maximum is #{value}") if object.size > value
-            # TODO ALL the other operators from http://guides.rubyonrails.org/active_record_validations.html#length
+            validation_result.add_error(message || "cannot be longer than #{value} characters") if object.size > value
+          when :is
+            validation_result.add_error(message || "should have exactly #{value} characters") if object.size != value
+          when :in, :within
+            unless value.include?(object.size)
+              validation_result.add_error(message || "should contain #{value.first} to #{value.last} characters")
+            end
           else
             raise "don't know what to do with operator=#{operator}"
           end

data/lib/subvalid/version.rb

@@ -1,3 +1,3 @@
 module Subvalid
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/subvalid/validator_spec.rb

@@ -17,13 +17,6 @@ describe Subvalid::Validator do
     end
   end
 
-  class TestValidator
-    def self.validate(object, validation_result=ValidationResult.new, *args)
-      validation_result.add_error("testing #{object}")
-    end
-  end
-  Subvalid::ValidatorRegistry.register(:test, TestValidator)
-
   Poro = Struct.new(:foo, :bar, :child, :some_predicate) do
     def to_s
       "I'M A PORO"

data/spec/subvalid/validators/length_validator_spec.rb

@@ -0,0 +1,179 @@
+require "spec_helper"
+
+describe Subvalid::Validators::LengthValidator do
+  Thing = Struct.new(:list)
+  let(:thing) { Thing.new(list) }
+  let(:list) { [] }
+
+  describe '#validate' do
+    context 'when attribute is a string' do
+      context 'with minimum' do
+        class MinValidator
+          include Subvalid::Validator
+          validates :list, length: {minimum: 2}
+        end
+
+        subject(:validator) { MinValidator.validate(thing) }
+
+        it 'returns a validation result' do
+          expect(validator).to be_a(Subvalid::ValidationResult)
+        end
+
+        context 'when the length is just right' do
+          let(:list) { 'a' * 3 }
+          it { is_expected.to be_valid }
+        end
+
+        context 'when the length is too short' do
+          it { is_expected.not_to be_valid }
+
+          it 'shows the default error message' do
+            expect(validator.children[:list].errors).to include("cannot be shorter than 2 characters")
+          end
+        end
+      end
+
+      context 'with maximum' do
+        class MaxValidator
+          include Subvalid::Validator
+          validates :list, length: {maximum: 10}
+        end
+
+        subject(:validator) { MaxValidator.validate(thing) }
+
+        it 'returns a validation result' do
+          expect(validator).to be_a(Subvalid::ValidationResult)
+        end
+
+        context 'when the length is just right' do
+          it { is_expected.to be_valid }
+        end
+
+        context 'when the length is too long' do
+          let(:list) { 'a' * 30 }
+          it { is_expected.not_to be_valid }
+
+          it 'shows the default error message' do
+            expect(validator.children[:list].errors).to include("cannot be longer than 10 characters")
+          end
+        end
+      end
+
+      context 'with exact character count' do
+        class ExactLengthValidator
+          include Subvalid::Validator
+          validates :list, length: {is: 4}
+        end
+
+        subject(:validator) { ExactLengthValidator.validate(thing) }
+
+        it 'returns a validation result' do
+          expect(validator).to be_a(Subvalid::ValidationResult)
+        end
+
+        context 'when the length is just right' do
+          let(:list) { 'a' * 4 }
+          it { is_expected.to be_valid }
+        end
+
+        context 'when the length is too short' do
+          it { is_expected.not_to be_valid }
+        end
+
+        context 'when the length is too long' do
+          let(:list) { 'a' * 5 }
+          it { is_expected.not_to be_valid }
+
+          it 'shows the default error message' do
+            expect(validator.children[:list].errors).to include("should have exactly 4 characters")
+          end
+        end
+      end
+
+      context 'with a range' do
+        context 'when using within' do
+          class WithinValidator
+            include Subvalid::Validator
+            validates :list, length: {within: 2..4}
+          end
+
+          subject(:validator) { WithinValidator.validate(thing) }
+
+          it 'returns a validation result' do
+            expect(validator).to be_a(Subvalid::ValidationResult)
+          end
+
+          context 'when the length is just right' do
+            let(:list) { 'a' * 3 }
+            it { is_expected.to be_valid }
+          end
+
+          context 'when the length is too short' do
+            it { is_expected.not_to be_valid }
+          end
+
+          context 'when the length is too long' do
+            let(:list) { 'a' * 5 }
+            it { is_expected.not_to be_valid }
+
+            it 'shows the default error message' do
+              expect(validator.children[:list].errors).to include("should contain 2 to 4 characters")
+            end
+          end
+        end
+
+        context 'when using in' do
+          class InValidator
+            include Subvalid::Validator
+            validates :list, length: {in: 2..4}
+          end
+
+          subject(:validator) { InValidator.validate(thing) }
+
+          it 'returns a validation result' do
+            expect(validator).to be_a(Subvalid::ValidationResult)
+          end
+
+          context 'when the length is just right' do
+            let(:list) { 'a' * 3 }
+            it { is_expected.to be_valid }
+          end
+
+          context 'when the length is too short' do
+            it { is_expected.not_to be_valid }
+          end
+
+          context 'when the length is too long' do
+            let(:list) { 'a' * 5 }
+            it { is_expected.not_to be_valid }
+
+            it 'shows the default error message' do
+              expect(validator.children[:list].errors).to include("should contain 2 to 4 characters")
+            end
+          end
+        end
+      end
+    end
+
+    context 'when attribute is an array' do
+      context 'with custom message' do
+        class MaxWithMessageValidator
+          include Subvalid::Validator
+          validates :list, length: {maximum: 4, message: "cannot contain more than 5 items"}
+        end
+
+        subject(:validator) { MaxWithMessageValidator.validate(thing) }
+
+        context 'when there are too many elements' do
+          context 'with provided message' do
+            let(:list) { [:a] * 5 }
+
+            it 'shows custom error message' do
+              expect(validator.children[:list].errors).to include("cannot contain more than 5 items")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/subvalid.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: subvalid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Julian Doherty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ files:
 - spec/subvalid/validation_result_spec.rb
 - spec/subvalid/validator_registry_spec.rb
 - spec/subvalid/validator_spec.rb
+- spec/subvalid/validators/length_validator_spec.rb
 - spec/subvalid_spec.rb
 - subvalid.gemspec
 homepage: ''
@@ -121,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Subjective validation for Plain Old Ruby Objects
@@ -131,4 +131,5 @@ test_files:
 - spec/subvalid/validation_result_spec.rb
 - spec/subvalid/validator_registry_spec.rb
 - spec/subvalid/validator_spec.rb
+- spec/subvalid/validators/length_validator_spec.rb
 - spec/subvalid_spec.rb