subvalid 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c0fec940d79b907b072f1df373e0b6add70f91
-  data.tar.gz: f2993841ad0edc5f065280f9518ed9e0df8d1a19
+  metadata.gz: edca18185857cfbbc93dbb3314d3d09083c5f200
+  data.tar.gz: af80dce164c5388a450adaba42db36d4f414ca73
 SHA512:
-  metadata.gz: f41942e32113e9101e847c787e14fee98ec9b8a50baa6ddaba10d5e25b6ae73bf20b18d6df5fcdcdfae27cda032d24641d19f2452c9323fcbf5ec5e64f628c38
-  data.tar.gz: 4ecd389d43b363882c2378b89b649be4baf2e0dde5ff5df31812b13a8b28bd8b0a813462867df94ce2e2a80fb42d9c8b93c775bddec60cc7d9a59f83cb2aad81
+  metadata.gz: 9875098c16bcc27ce0acafb0248684536dca09adabfc199c554cd2b4c71d8a7452b4b9b3ecb9e76764e90167cfe98fa01b2fec6d86db6f62839f070b924bf9fb
+  data.tar.gz: e9099ec87e31f154edd3fa4448efe3e2ff7c034cc6538aa77def84fc98d02775850a1782d7ceff0936cc14cf1a438da6c0c8b5d5a57032f5748cc0996549cfa3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.1.0, available at [http://contributor-covenant.org/version/1/1/0/](http://contributor-covenant.org/version/1/1/0/)

data/README.md

@@ -7,7 +7,7 @@ you can define it in a separate class - so it's _"subjective"_. (as in **Sub**je
 **valid**ation).
 
 Subvalid was extracted from a project at [Envato](http://envato.com) which
-required complex validation logic at each stage of the object's life cycle:
+requires complex validation logic at each stage of an object's life cycle:
 - Users upload videos. The videos are validated to make sure an actual
   video was uploaded (and not someone's university Powerpoint slides), that
 framerate is good, resolution and codec is acceptable etc. Failure here would
@@ -21,6 +21,10 @@ just leave it as _"incomplete"_, and allow the user to come back later and
 complete it. Once this passes, the item is ready, and we submit it for review to
 our internal review team.
 
+All these steps are done asynchronously, so we need to capture the errors, save
+them to a different field on the item, and carry on to report results back to
+the user.
+
 While
 [ActiveModel::Validations](http://api.rubyonrails.org/classes/ActiveModel/Validations.html)
 is great if you've got simple validation logic, it doesn't cut it for something
@@ -54,6 +58,8 @@ anything. A key design goal is to **not** pollute the objects being validated at
 all
 - Supports nested validation on nested object structures - and nicely handles
   nested errors.
+- DSL and API inspired by ActiveModel::Validations - just simplified and more
+  consistent.
 
 ## Development Status [![travis ci build](https://api.travis-ci.org/envato/subvalid.svg)](https://travis-ci.org/envato/subvalid)
 
@@ -77,12 +83,115 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Say you've got some object:
+```ruby
+Person = Struct.new(:name)
+madlep = Person.new("madlep")
+```
+
+You can validate it with Subvalid like this:
+```ruby
+require 'subvalid'
+
+class PersonValidator
+  include Subvalid::Validator
+
+  validates :name, presence: true
+end
+
+PersonValidator.validate(madlep).valid? # => true
+```
+
+`validate` returns a validation result. You can check if it is `#valid?` or if
+it has `errors` on an attribute
+```ruby
+result = PersonValidator.validate(Person.new(nil))
+result.valid? # => false
+result.errors[:name] # => ["is not present"]
+```
+
+Of course, because Subvalid only cares about duck-types, and not any particular
+modelling framework, this validator works equally well with any type of object -
+so long as it responds to `name`
+
+```ruby
+class Person < ActiveRecord::Base
+end
+
+madlepAR = Person.create(name: "madlep")
+
+PersonValidator.validate(madlepAR).valid? # => true
+```
+
+And you can validate nested data structures
+```ruby
+Video = Struct.new(:title, :length, :author)
+
+class VideoValidator
+  include Subvalid::Validator
+
+  validates :title, presence: true
+  validates :length, presence: true
+  validates :author do
+    validates :name, presence: true
+  end
+end
+
+invalid_video = Video.new(nil, nil, Person.new(nil))
+result = VideoValidator.validate(video)
+result.to_h # => {:title=>{:errors=>["is not present"]}, :length=>{:errors=>["is not present"]}, :author=>{:name=>{:errors=>["is not present"]}}}
+```
+
+
+Or you can DRY up your validation code by composing validators together
+```ruby
+class VideoValidator
+  include Subvalid::Validator
+
+  validates :title, presence: true
+  validates :length, presence: true
+  validates :author, with: PersonValidator
+end
+```
+
+Validator execution on specific fields can be run or skipped at validation time
+by passing an `if` validator proc, which decides if the validation should run
+```ruby
+class PersonValidator
+  include Subvalid::Validator
+
+  validates :postcode, presence: true, if: -> (person) { person.country == "US" }
+end
+```
+
+## Contact
+
+- [github project](https://github.com/envato/subvalid)
+- Bug reports and feature requests are via [github issues](https://github.com/envato/subvalid/issues)
+
+## Maintainers
+
+- [Julian Doherty](https://github.com/madlep)
+
+## License
+
+`Subvalid` uses MIT license. See
+[`LICENSE.txt`](https://github.com/envato/subvalid/blob/master/LICENSE.txt) for
+details.
+
+## Code of conduct
+
+We welcome contribution from everyone. Read more about it in
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/subvalid/blob/master/CODE_OF_CONDUCT.md)
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/subvalid/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+For bug fixes, documentation changes, and small features:
+
+1. Fork it ( https://github.com/subvalid/subvalid/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
 5. Create a new Pull Request
+
+For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction

data/lib/subvalid/validator.rb

@@ -9,6 +9,8 @@ module Subvalid
 
     module DSL
 
+      MODIFIERS = [:if]
+
       def validates(*attributes, **validators, &block)
         if validators.empty? && !block
           raise "no validations or block specified"
@@ -20,20 +22,30 @@ module Subvalid
       end
 
       private
-      ValidatorEntry = Struct.new(:validator, :args)
+      ValidatorEntry = Struct.new(:validator, :modifiers, :args)
       def validations
         @validations ||= Hash.new{|vals,attribute| vals[attribute] = [] }
       end
 
       def add_validations(attributes, validators, block)
+        modifiers, validators = extract_modifiers(validators)
         attributes.each do |attribute|
           validators.each do |validator_key, args|
             validator = ValidatorRegistry[validator_key]
-            validations[attribute] << ValidatorEntry.new(validator, args)
+            validations[attribute] << ValidatorEntry.new(validator, modifiers, args)
           end
-          validations[attribute] << ValidatorEntry.new(BlockValidator, block) if block
+          validations[attribute] << ValidatorEntry.new(BlockValidator, modifiers, block) if block
         end
       end
+
+      def extract_modifiers(validators)
+        modifiers = MODIFIERS.inject([]){|acc, mod_key|
+          modifier_proc = validators.delete(mod_key)
+          acc <<  modifier_proc if modifier_proc
+          acc
+        }
+        [modifiers, validators]
+      end
     end
 
     module API
@@ -46,13 +58,15 @@ module Subvalid
                              end
 
           validators.each do |validator_entry|
-            validator = validator_entry.validator
-            if attribute == :base
-              validator.validate(object, attribute_result, *validator_entry.args)
-            elsif object
-              validator.validate(object.send(attribute), attribute_result, *validator_entry.args)
-            else
-              # no-op if we 're asked to validate an attribute for a nil value - that needs to be caught by a user defined `presence` validation instead
+            if validator_entry.modifiers.map{|m| m.call(object)}.all?
+              validator = validator_entry.validator
+              if attribute == :base
+                validator.validate(object, attribute_result, *validator_entry.args)
+              elsif object
+                validator.validate(object.send(attribute), attribute_result, *validator_entry.args)
+              else
+                # no-op if we 're asked to validate an attribute for a nil value - that needs to be caught by a user defined `presence` validation instead
+              end
             end
           end
 

data/lib/subvalid/validator_registry.rb

@@ -2,7 +2,7 @@ module Subvalid
   class ValidatorRegistry
     class << self
       def [](key)
-        validators[key] or raise "no validator with key=#{key}"
+        validators[key] or raise ArgumentError.new("no validator with key=#{key}")
       end
 
       def register(key, validator)

data/lib/subvalid/version.rb

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

data/spec/subvalid/validator_registry_spec.rb

@@ -13,7 +13,7 @@ describe Subvalid::ValidatorRegistry do
 
     context "when validator doesn't exist" do
       it "raises an error" do
-        expect { described_class[:bad_key] }.to raise_error
+        expect { described_class[:bad_key] }.to raise_error(ArgumentError)
       end
     end
   end

data/spec/subvalid/validator_spec.rb

@@ -11,7 +11,7 @@ describe Subvalid::Validator do
 
 
     validates with: STUB_VALIDATOR
-    validates :foo, with: STUB_VALIDATOR
+    validates :foo, with: STUB_VALIDATOR, if: -> (record) { record.some_predicate? }
     validates :child do
       validates :boz, with: STUB_VALIDATOR
     end
@@ -24,10 +24,14 @@ describe Subvalid::Validator do
   end
   Subvalid::ValidatorRegistry.register(:test, TestValidator)
 
-  Poro = Struct.new(:foo, :bar, :child) do
+  Poro = Struct.new(:foo, :bar, :child, :some_predicate) do
     def to_s
       "I'M A PORO"
     end
+
+    def some_predicate?
+      some_predicate
+    end
   end
 
   PoroChild = Struct.new(:baz, :boz) do
@@ -36,8 +40,16 @@ describe Subvalid::Validator do
     end
   end
 
-  let(:poro) { Poro.new("foo", "bar", 
-                        PoroChild.new("baz", "boz")) }
+  let(:poro) {
+    Poro.new(
+      "foo",
+      "bar",
+      PoroChild.new("baz", "boz"),
+      some_predicate
+    )
+  }
+
+  let(:some_predicate) { true }
 
   describe "#validate" do
     subject { FooValidator.validate(poro) }
@@ -56,6 +68,17 @@ describe Subvalid::Validator do
     it "validates child" do
       expect(subject[:child][:boz].errors).to eq(["testing boz"])
     end
+
+    context "when `if` modifier returns false" do
+      let(:some_predicate) { false }
+      it "doesn't execute validator" do
+        expect(subject[:foo].errors).to eq([])
+      end
+
+      it "executes other validators" do
+        expect(subject[:child][:boz].errors).to eq(["testing boz"])
+      end
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subvalid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Julian Doherty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Subjective validation for Plain Old Ruby Objects