attestor 1.0.0 → 2.0.0

data/lib/attestor/validations/reporter.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Attestor
+
+  module Validations
+
+    # @private
+    module Reporter
+
+      def validate(object)
+        validate! object
+        Report.new(object)
+      rescue InvalidError => error
+        Report.new(error.object, error)
+      end
+
+    end # module Reporter
+
+  end # module Validations
+
+end # module Attestor

data/lib/attestor/validations/validator.rb

@@ -4,86 +4,31 @@ module Attestor
 
   module Validations
 
-    # Describe a validator for class instances
-    #
-    # @example
-    #   validator = Validator.new(:foo, only: :baz)
-    #
-    #   validator.used_in_context? :baz # => true
-    #   validator.validate object
-    #
-    # @api private
+    # @private
     class Validator
+      include Reporter
 
-      # @!scope class
-      # @!method new(name, except: [], only: [])
-      # Creates a named item with blacklist or whitelist of contexts
-      #
-      # @param  [#to_sym] name
-      # @option [#to_sym, Array<#to_sym>] :except
-      # @option [#to_sym, Array<#to_sym>] :only
-      #
-      # @return [Attestor::Validations::Validator]
-
-      # @private
       def initialize(name = :invalid, except: nil, only: nil, &block)
         @name      = name.to_sym
         @whitelist = normalize(only)
         @blacklist = normalize(except)
         @block     = block
-        generate_id
         freeze
       end
 
-      # @!attribute [r] name
-      # The name of the item
-      #
-      # @return [Symbol]
-      attr_reader :name
-
-      # Compares an item to another one
-      #
-      # @param [Object] other
-      #
-      # @return [Boolean]
-      def ==(other)
-        other.instance_of?(self.class) ? id.equal?(other.id) : false
-      end
+      attr_reader :name, :whitelist, :blacklist, :block
 
-      # Checks if the item should be used in given context
-      #
-      # @param [#to_sym] context
-      #
-      # @return [Boolean]
       def used_in_context?(context)
         symbol = context.to_sym
         whitelisted?(symbol) && !blacklisted?(symbol)
       end
 
-      # Validates given object
-      #
-      # @param [Object] object
-      #
-      # @raise [Attestor::InvalidError]
-      #   if object doesn't match validation rule
-      #
-      # @return [undefined]
-      def validate(object)
+      def validate!(object)
         block ? object.instance_eval(&block) : object.__send__(name)
       end
 
-      protected
-
-      # @!attribute [r] id
-      # The item's identity
-      #
-      # @return [String]
-      attr_reader :id
-
       private
 
-      attr_reader :whitelist, :blacklist, :block
-
       def whitelisted?(symbol)
         whitelist.empty? || whitelist.include?(symbol)
       end
@@ -92,10 +37,6 @@ module Attestor
         blacklist.include? symbol
       end
 
-      def generate_id
-        @id = [name, whitelist, blacklist].hash
-      end
-
       def normalize(list)
         Array(list).map(&:to_sym).uniq
       end

data/lib/attestor/validations/validators.rb

@@ -4,72 +4,44 @@ module Attestor
 
   module Validations
 
-    # The collection of validations used by class instances
-    #
-    # @api private
+    # @private
     class Validators
       include Enumerable
+      include Reporter
 
-      # @!scope class
-      # @!method new(items = [])
-      # Creates an immutable collection with optional list of items
-      #
-      # @param [Array<Attestor::Validators::Validator>] items
-      #
-      # @return [Attestor::Validators]
-
-      # @private
       def initialize(*items)
         @items = items.flatten
         freeze
       end
 
-      # Iterates through the collection
-      #
-      # @yield the block
-      # @yieldparam [Attestor::Validators::Validator] item
-      #   items from the collection
-      #
-      # @return [Enumerator]
       def each
         block_given? ? items.each { |item| yield(item) } : to_enum
       end
 
-      # Returns validators used in given context
-      #
-      # @param  [#to_sym] context
-      #
-      # @return [Attestor::Validators]
       def set(context)
-        validators = select { |item| item.used_in_context? context }
-
-        self.class.new(validators)
+        self.class.new select { |item| item.used_in_context? context }
       end
 
-      # Returns validators updated by a new validator with given args
-      #
-      # @param  [Array] args
-      #
-      # @return [Attestor::Validators]
       def add_validator(*args, &block)
-        add_item Validator, *args, &block
+        self.class.new items, Validator.new(*args, &block)
       end
 
-      # Returns validators updated by a new validator with given args
-      #
-      # @param  [Array] args
-      #
-      # @return [Attestor::Validators]
       def add_delegator(*args, &block)
-        add_item Delegator, *args, &block
+        self.class.new items, Delegator.new(*args, &block)
+      end
+
+      def validate!(object)
+        results = errors(object)
+        return if results.empty?
+        fail InvalidError.new object, results.map(&:messages).flatten
       end
 
       private
 
       attr_reader :items
 
-      def add_item(type, *args, &block)
-        self.class.new items, type.new(*args, &block)
+      def errors(object)
+        map { |validator| validator.validate(object) }.select(&:invalid?)
       end
 
     end # class Validators

data/lib/attestor/validations.rb

@@ -7,12 +7,23 @@ module Attestor
 
     # Calls all validators for given context
     #
+    # @param [#to_sym] context
+    #
     # @raise [Attestor::Validations::InvalidError] if validators fail
     # @raise [NoMethodError] if some of validators are not implemented
     #
     # @return [undefined]
+    def validate!(context = :all)
+      self.class.validators.set(context).validate! self
+    end
+
+    # Calls all validators for given context and return validation results
+    #
+    # @param (see #validate!)
+    #
+    # @return [undefined]
     def validate(context = :all)
-      self.class.validators.set(context).each { |item| item.validate(self) }
+      self.class.validators.set(context).validate self
     end
 
     # Raises InvalidError with a corresponding message

data/lib/attestor/version.rb

@@ -4,6 +4,6 @@ module Attestor
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 
 end # module Attestor

data/lib/attestor.rb

@@ -5,8 +5,10 @@ require "extlib"
 require_relative "attestor/version"
 
 require_relative "attestor/invalid_error"
+require_relative "attestor/report"
 
 require_relative "attestor/validations"
+require_relative "attestor/validations/reporter"
 require_relative "attestor/validations/validator"
 require_relative "attestor/validations/delegator"
 require_relative "attestor/validations/validators"

data/spec/features/example_spec.rb

@@ -56,7 +56,7 @@ describe "Base example" do
       validates { ConsistencyPolicy.new(debet, credit) }
       validates :limited, except: :blocked
       validate  only: :blocked do
-        internal.validate
+        internal.validate!
       end
 
       private
@@ -87,11 +87,11 @@ describe "Base example" do
   end
 
   it "works fine" do
-    expect { a_to_a.validate }.not_to raise_error
-    expect { b_to_a.validate }.not_to raise_error
+    expect { a_to_a.validate! }.not_to raise_error
+    expect { b_to_a.validate! }.not_to raise_error
 
-    expect { a_to_b.validate }.to raise_error Attestor::InvalidError
-    expect { b_to_a.validate :blocked }.to raise_error Attestor::InvalidError
+    expect { a_to_b.validate! }.to raise_error Attestor::InvalidError
+    expect { b_to_a.validate! :blocked }.to raise_error Attestor::InvalidError
   end
 
   after do

data/spec/support/policies.rb

@@ -3,11 +3,11 @@
 # Definitions for testing compound policies
 
 def valid_policy
-  double valid?: true, invalid?: false, validate: nil
+  double validate!: nil, validate: double(valid?: true, invalid?: false)
 end
 
 def invalid_policy
-  double valid?: false, invalid?: true, validate: nil
+  double validate!: nil, validate: double(valid?: false, invalid?: true)
 end
 
 shared_examples "creating a node" do
@@ -27,12 +27,12 @@ end # shared examples
 shared_examples "failing validation" do
 
   it "[raises exception]" do
-    expect { subject.validate }.to raise_error Attestor::InvalidError
+    expect { subject.validate! }.to raise_error Attestor::InvalidError
   end
 
   it "[adds itself to exception]" do
     begin
-      subject.validate
+      subject.validate!
     rescue => error
       expect(error.object).to eq subject
     end
@@ -43,7 +43,7 @@ end # shared examples
 shared_examples "passing validation" do
 
   it "[raises exception]" do
-    expect { subject.validate }.not_to raise_error
+    expect { subject.validate! }.not_to raise_error
   end
 
 end # shared examples

data/spec/tests/policy/and_spec.rb

@@ -17,7 +17,7 @@ describe Attestor::Policy::And do
 
   end # context
 
-  describe "#validate" do
+  describe "#validate!" do
 
     context "when all the parts are valid" do
 
@@ -35,6 +35,6 @@ describe Attestor::Policy::And do
 
     end # context
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Policy::Base::Not

data/spec/tests/policy/node_spec.rb

@@ -2,13 +2,13 @@
 
 describe Attestor::Policy::Node do
 
-  let(:policy_class)  { Attestor::Policy }
+  let(:policy_module) { Attestor::Policy       }
   let(:invalid_error) { Attestor::InvalidError }
 
   describe ".new" do
 
     it "creates a policy" do
-      expect(subject).to be_kind_of policy_class
+      expect(subject).to be_kind_of policy_module
     end
 
     it "creates a collection" do
@@ -39,35 +39,35 @@ describe Attestor::Policy::Node do
 
   describe "#each" do
 
-    let(:branches) { 3.times.map { double } }
+    let(:branches) { 3.times.map { |n| double validate: n } }
 
     it "returns an enumerator" do
       expect(subject.each).to be_kind_of Enumerator
     end
 
-    it "iterates through brances" do
+    it "iterates through branches' validation reports" do
       subject = described_class.new(branches)
-      expect(subject.to_a).to eq branches
+      expect(subject.to_a).to eq [0, 1, 2]
     end
 
   end # each
 
-  describe "#validate" do
+  describe "#validate!" do
 
     let(:message) { Attestor::Validations::Message.new :base, subject }
 
     it "raises InvalidError" do
-      expect { subject.validate }.to raise_error invalid_error
+      expect { subject.validate! }.to raise_error invalid_error
     end
 
     it "adds the :invalid message" do
       begin
-        subject.validate
+        subject.validate!
       rescue => error
         expect(error.messages).to contain_exactly message
       end
     end
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Attestor::Policy::Node

data/spec/tests/policy/not_spec.rb

@@ -17,7 +17,7 @@ describe Attestor::Policy::Not do
 
   end # context
 
-  describe "#validate" do
+  describe "#validate!" do
 
     context "when a part is invalid" do
 
@@ -35,6 +35,6 @@ describe Attestor::Policy::Not do
 
     end # context
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Policy::Base::Not

data/spec/tests/policy/or_spec.rb

@@ -17,7 +17,7 @@ describe Attestor::Policy::Or do
 
   end # context
 
-  describe "#validate" do
+  describe "#validate!" do
 
     context "when valid part exists" do
 
@@ -35,6 +35,6 @@ describe Attestor::Policy::Or do
 
     end # context
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Policy::Base::Not

data/spec/tests/policy/xor_spec.rb

@@ -17,7 +17,7 @@ describe Attestor::Policy::Xor do
 
   end # context
 
-  describe "#validate" do
+  describe "#validate!" do
 
     context "when both valid and invalid parts exist" do
 
@@ -43,6 +43,6 @@ describe Attestor::Policy::Xor do
 
     end # context
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Policy::Base::Not

data/spec/tests/policy_spec.rb

@@ -51,54 +51,6 @@ describe Attestor::Policy do
 
   end # describe .new
 
-  describe "#valid?" do
-
-    context "when #validate method fails" do
-
-      before { allow(subject).to receive(:validate) { fail invalid } }
-
-      it "returns false" do
-        expect(subject.valid?).to eq false
-      end
-
-    end
-
-    context "when #validate method passes" do
-
-      before { allow(subject).to receive(:validate) { nil } }
-
-      it "returns true" do
-        expect(subject.valid?).to eq true
-      end
-
-    end
-
-  end # describe #valid?
-
-  describe "#invalid?" do
-
-    context "when #validate method fails" do
-
-      before { allow(subject).to receive(:validate) { fail invalid } }
-
-      it "returns true" do
-        expect(subject.invalid?).to eq true
-      end
-
-    end
-
-    context "when #validate method passes" do
-
-      before { allow(subject).to receive(:validate) { nil } }
-
-      it "returns false" do
-        expect(subject.invalid?).to eq false
-      end
-
-    end
-
-  end # describe #invalid?
-
   describe "#and" do
 
     it "calls .and class factory method with self" do

data/spec/tests/report_spec.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+describe Attestor::Report do
+
+  let(:invalid_error) { Attestor::InvalidError }
+
+  let(:messages) { ["foo"] }
+  let(:object)   { double  }
+  let(:error)    { invalid_error.new   object, messages }
+  subject        { described_class.new object, error    }
+
+  describe ".new" do
+
+    it "creates an immutable object" do
+      expect(subject).to be_frozen
+    end
+
+  end # describe .new
+
+  describe "#object" do
+
+    it "is initialized" do
+      expect(subject.object).to eq object
+    end
+
+  end # describe #object
+
+  describe "#error" do
+
+    it "is initialized" do
+      expect(subject.error).to eq error
+    end
+
+    it "is set to nil by default" do
+      expect(described_class.new(object).error).to be_nil
+    end
+
+  end # describe #error
+
+  describe "#valid?" do
+
+    context "when the #error is set" do
+
+      it "returns false" do
+        expect(subject.valid?).to eq false
+      end
+
+    end # context
+
+    context "when the #error is not set" do
+
+      subject { described_class.new object }
+
+      it "returns true" do
+        expect(subject.valid?).to eq true
+      end
+
+    end # context
+
+  end # describe #valid?
+
+  describe "#invalid?" do
+
+    context "when the #error is set" do
+
+      it "returns true" do
+        expect(subject.invalid?).to eq true
+      end
+
+    end # context
+
+    context "when the #error is not set" do
+
+      subject { described_class.new object }
+
+      it "returns false" do
+        expect(subject.invalid?).to eq false
+      end
+
+    end # context
+
+  end # describe #invalid?
+
+  describe "#messages" do
+
+    context "when the #error is set" do
+
+      it "returns error's messages" do
+        expect(subject.messages).to eq messages
+      end
+
+    end # context
+
+    context "when the #error is not set" do
+
+      subject { described_class.new object }
+
+      it "returns an empty array" do
+        expect(subject.messages).to eq []
+      end
+
+    end # context
+
+  end # describe #messages
+
+end # describe Attestor::Report

data/spec/tests/validations/delegator_spec.rb

@@ -13,17 +13,17 @@ describe Attestor::Validations::Delegator do
 
   end # describe .new
 
-  describe "#validate" do
+  describe "#validate!" do
 
     let(:object) { double foo: valid_policy }
 
     context "when initialized without a block" do
 
       subject { described_class.new "foo" }
-      after   { subject.validate object   }
+      after   { subject.validate! object   }
 
       it "delegates validation to named method" do
-        expect(object).to receive_message_chain(:foo, :validate)
+        expect(object).to receive_message_chain(:foo, :validate!)
       end
 
     end # context
@@ -31,14 +31,14 @@ describe Attestor::Validations::Delegator do
     context "when initialized with a block" do
 
       subject { described_class.new { foo } }
-      after   { subject.validate object }
+      after   { subject.validate! object }
 
       it "delegates validation to block" do
-        expect(object).to receive_message_chain(:foo, :validate)
+        expect(object).to receive_message_chain(:foo, :validate!)
       end
 
     end # context
 
-  end # describe #validate
+  end # describe #validate!
 
 end # describe Attestor::Validations::Delegator

data/spec/tests/validations/message_spec.rb

@@ -18,7 +18,7 @@ describe Attestor::Validations::Message do
 
   describe ".new" do
 
-    context "with a symbol argument" do
+    context "with a symbolic argument" do
 
       subject { described_class.new :invalid, scope, foo: "bar" }