attestor 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbf1e027054a7c3baeeaa39f6e66f515e1b3fa2e
-  data.tar.gz: 546765bd0a8dfee528fa5ed45f3fe7a3b07047cf
+  metadata.gz: b4755994f9e2305a2cd5ee6e243fc47fe5f5b404
+  data.tar.gz: 149e89d4ed18c39bf51df1d75933b5e06fe4c5f0
 SHA512:
-  metadata.gz: bfa470608fa7882248c256abd5e594a7ed4d50cef97fbc230425a89703b1cd6c652586b57a760a76b78b9611a76ad41f0f58eb2573e2e3f50c88f2aabfd903df
-  data.tar.gz: 5694b759f83f0b281fc102753dce9537512510157e79a22941fd312d5ed141b7e62e7b1b6072d54035b43995e735b74ce746109acc43c9c5a6197b4553d2ea3c
+  metadata.gz: 0daa45d47fef84269ac1f27a62f985ab6c585cef0c73d2be5de736a3ecfb9357f2632b1557f28dfdfd93caf75b222bc9a032e2370154d2c20ae1026a941d853f
+  data.tar.gz: 0107fd28176f7b61ff7c6240eac3ab2c6b781c1ccbda0091507f0d6b8190ebc04fe0fee7bf8e63aadfed30f17c2f454b4865b05dbede51fac771387791d9023c

data/README.md

@@ -101,6 +101,15 @@ en:
         inconsistent: "Credit differs from debet by %{fraud}"
 ```
 
+Alternatively, you can describe validation in the block (called in the scope of instance):
+
+```ruby
+class Transfer
+  # ...
+  validate(:consistent) { invalid :inconsistent if credit.sum != debet.sum }
+end
+```
+
 To run validations use the `#validate` instance method:
 
 ```ruby
@@ -202,6 +211,17 @@ en:
         consistency: "The transfer is inconsistent"
 ```
 
+Alternatively, you can describe a policy in the block (called in the scope of instance):
+
+```ruby
+class Transfer
+  # ...
+  follow_policy :consistency, only: :fair_trade do
+    ConsistencyPolicy.new(debet.sum, credit.sum)
+  end
+end
+```
+
 Complex Policies
 ----------------
 

data/lib/attestor.rb

@@ -8,6 +8,7 @@ require_relative "attestor/invalid_error"
 
 require_relative "attestor/validations"
 require_relative "attestor/validations/validator"
+require_relative "attestor/validations/follower"
 require_relative "attestor/validations/validators"
 require_relative "attestor/validations/message"
 

data/lib/attestor/invalid_error.rb

@@ -6,24 +6,20 @@ module Attestor
   class InvalidError < RuntimeError
 
     # @!scope class
-    # @!method new(object, validations: nil, messages: [], context: :all)
+    # @!method new(object, messages = nil)
     # Creates an exception for given object
     #
     # @param  [Object] object
     #   The invalid object
-    # @option [Array<String>] :messages
+    # @param [String, Array<String>] messages
     #   The list of validation error messages
-    # @option [Symbol] :context
-    #   The list of context for validation
-    # @option [Array<Symbol>] :validations
-    #   The list of all validations that was checked out
     #
     # @return [Attestor::InvalidError]
 
     # @private
-    def initialize(object, messages = [])
+    def initialize(object, messages = nil)
       @object   = object
-      @messages = messages.dup.freeze
+      @messages = Array(messages)
       freeze
     end
 

data/lib/attestor/policy.rb

@@ -16,20 +16,19 @@ module Attestor
       end
     end
 
-    # Builds the policy class
+    # Builds a policy class with given attributes
     #
     # @example
     #   MyPolicy = Attestor::Policy.new(:foo, :bar) do
     #     attr_reader :baz
     #   end
     #
-    # @attribute [Array<#to_sym>] attributes
-    #   the list of attributes
-    # @attribute [Proc] block
+    # @param [Array<#to_sym>] attributes
+    # @param [Proc] block
     #
     # @yield the block in the scope of created class
     #
-    # @return [Class]
+    # @return [Class] the policy class, based on Struct
     def self.new(*attributes, &block)
       Struct.new(*attributes) do
         include Attestor::Policy

data/lib/attestor/validations.rb

@@ -36,7 +36,7 @@ module Attestor
     #     the name converted to string
     def invalid(name, options = {})
       message = Message.new(name, self, options)
-      fail InvalidError.new self, [message]
+      fail InvalidError.new self, message
     end
 
     # @private
@@ -51,6 +51,7 @@ module Attestor
         @validators ||= Validators.new
       end
 
+      # @!method follow_validator(name, except: nil, only: nil)
       # Registers a validator
       #
       # Mutates the class by changing its {#validators} attribute!
@@ -63,24 +64,24 @@ module Attestor
       #   the white list of contexts for validation
       #
       # @return [Attestor::Validators] the updated collection
-      def validate(name, options = {})
-        @validators = validators.add(name, options)
+      def validate(*args)
+        @validators = validators.add_validator(*args)
       end
 
+      # @!method follow_policy(name, except: nil, only: nil)
       # Registers a followed policy
       #
       # Mutates the class by changing its {#validators} attribute!
       #
       # @param [#to_sym] name
-      # @param [Hash] options
-      # @option options [#to_sym, Array<#to_sym>] :except
+      # @option [#to_sym, Array<#to_sym>] :except
       #   the black list of contexts for validation
-      # @option options [#to_sym, Array<#to_sym>] :only
+      # @option [#to_sym, Array<#to_sym>] :only
       #   the white list of contexts for validation
       #
       # @return [Attestor::Collection] the updated collection
-      def follow_policy(name, options = {})
-        @validators = validators.add(name, options.merge(policy: true))
+      def follow_policy(*args)
+        @validators = validators.add_follower(*args)
       end
 
     end # module ClassMethods

data/lib/attestor/validations/follower.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Attestor
+
+  module Validations
+
+    # Describe a policy follower for class instances
+    #
+    # The follower not only calls an instance method (as validator does),
+    # but checks whether the result is valid and raises an exception otherwise.
+    #
+    # @example
+    #   follower = Validator.new(:foo, only: :baz) { FooPolicy.new(foo) }
+    #
+    # @api private
+    class Follower < Validator
+
+      # Validates a policy
+      #
+      # @param [Object] object
+      #
+      # @raise [Attestor::InvalidError] if a policy isn't valid
+      #
+      # @return [undefined]
+      def validate(object)
+        policy = super(object)
+        return if policy.valid?
+        object.__send__ :invalid, name
+      end
+
+    end # class Follower
+
+  end # module Validations
+
+end # module Attestor

data/lib/attestor/validations/validator.rb

@@ -7,7 +7,7 @@ module Attestor
     # Describe a validator for class instances
     #
     # @example
-    #   validator = Validator.new(:foo, policy: :bar, only: :baz)
+    #   validator = Validator.new(:foo, only: :baz)
     #
     #   validator.used_in_context? :baz # => true
     #   validator.validate object
@@ -26,11 +26,11 @@ module Attestor
       # @return [Attestor::Validations::Validator]
 
       # @private
-      def initialize(name, except: nil, only: nil, policy: nil)
+      def initialize(name, except: nil, only: nil, &block)
         @name      = name.to_sym
-        @policy    = policy
         @whitelist = normalize(only)
         @blacklist = normalize(except)
+        @block     = block
         generate_id
         freeze
       end
@@ -41,14 +41,6 @@ module Attestor
       # @return [Symbol]
       attr_reader :name
 
-      # @!method policy?
-      # Whether the validator uses a policy
-      #
-      # @return [Boolean]
-      def policy?
-        @policy ? true : false
-      end
-
       # Compares an item to another one
       #
       # @param [Object] other
@@ -77,8 +69,7 @@ module Attestor
       #
       # @return [undefined]
       def validate(object)
-        result = object.__send__(name)
-        object.__send__(:invalid, name) if policy? && result.invalid?
+        block ? object.instance_eval(&block) : object.__send__(name)
       end
 
       protected
@@ -91,7 +82,7 @@ module Attestor
 
       private
 
-      attr_reader :whitelist, :blacklist
+      attr_reader :whitelist, :blacklist, :block
 
       def whitelisted?(symbol)
         whitelist.empty? || whitelist.include?(symbol)

data/lib/attestor/validations/validators.rb

@@ -19,8 +19,8 @@ module Attestor
       # @return [Attestor::Validators]
 
       # @private
-      def initialize(items = [])
-        @items = items
+      def initialize(*items)
+        @items = items.flatten
         freeze
       end
 
@@ -32,40 +32,46 @@ module Attestor
       #
       # @return [Enumerator]
       def each
-        block_given? ? @items.each { |item| yield(item) } : to_enum
+        block_given? ? items.each { |item| yield(item) } : to_enum
       end
 
-      # Returns validators updated by new item
+      # Returns validators used in given context
       #
-      # @param  [#to_sym] name
-      # @param  [Hash] options
-      # @option options [Array<#to_sym>] :except
-      # @option options [Array<#to_sym>] :only
-      # @option options [Symbol, nil] :policy
+      # @param  [#to_sym] context
       #
       # @return [Attestor::Validators]
-      def add(name, options = {})
-        item = Validator.new(name, options)
-        return self if include? item
-
-        self.class.new(@items + [item])
+      def set(context)
+        validators = select { |item| item.used_in_context? context }
+        (validators == items) ? self : self.class.new(validators)
       end
 
-      # Returns validators used in given context
+      # Returns validators updated by a new validator with given args
       #
-      # @param  [#to_sym] context
+      # @param  [Array] args
       #
       # @return [Attestor::Validators]
-      def set(context)
-        validators = select { |item| item.used_in_context? context }
+      def add_validator(*args)
+        add_item Validator, *args
+      end
 
-        self.class.new(validators)
+      # Returns validators updated by a new follower with given args
+      #
+      # @param  [Array] args
+      #
+      # @return [Attestor::Validators]
+      def add_follower(*args)
+        add_item Follower, *args
       end
 
       private
 
       attr_reader :items
 
+      def add_item(type, *args)
+        item = type.new(*args)
+        include?(item) ? self : self.class.new(items, item)
+      end
+
     end # class Validators
 
   end # module Validations

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 = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 
 end # module Attestor

data/spec/tests/invalid_error_spec.rb

@@ -48,10 +48,6 @@ describe Attestor::InvalidError do
       expect(subject.messages).to eq %w(cad cam)
     end
 
-    it "is immutable" do
-      expect(subject.messages).to be_frozen
-    end
-
   end # describe #messages
 
 end # describe Attestor::ValidError

data/spec/tests/validations/follower_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require "support/policies"
+
+describe Attestor::Validations::Follower do
+
+  let(:validator) { Attestor::Validations::Validator }
+  subject { described_class.new "foo" }
+
+  describe ".new" do
+
+    it { is_expected.to be_kind_of validator }
+
+  end # describe .new
+
+  describe "#validate" do
+
+    after { subject.validate object }
+
+    context "when a policy is valid" do
+
+      let(:object) { double foo: valid_policy }
+
+      it "calls policy method and passes" do
+        expect(object).to receive :foo
+        expect(object).not_to receive :invalid
+      end
+
+    end # context
+
+    context "when a policy is invalid" do
+
+      let(:object) { double foo: invalid_policy }
+
+      it "calls policy method and fails" do
+        expect(object).to receive :foo
+        expect(object).to receive(:invalid).with(:foo)
+      end
+
+    end # context
+
+  end # describe #validate
+
+end # describe Attestor::Validations::Follower

data/spec/tests/validations/validator_spec.rb

@@ -38,10 +38,6 @@ describe Attestor::Validations::Validator do
         .to eq(described_class.new "foo", only: %i(bar))
     end
 
-    it "accepts array option :policy" do
-      expect { described_class.new "foo", policy: :bar }.not_to raise_error
-    end
-
   end # describe .new
 
   describe "#name" do
@@ -52,19 +48,6 @@ describe Attestor::Validations::Validator do
 
   end # describe .name
 
-  describe "#policy?" do
-
-    it "is set to false by default" do
-      expect(subject.policy?).to eq false
-    end
-
-    it "can be initialized" do
-      subject = described_class.new "foo", policy: 1
-      expect(subject.policy?).to eq true
-    end
-
-  end # describe #policy?
-
   describe "#==" do
 
     subject { described_class.new :foo, except: [:foo], only: %i(bar) }
@@ -171,11 +154,11 @@ describe Attestor::Validations::Validator do
 
   describe "#validate" do
 
+    let(:object) { double foo: nil }
     after { subject.validate object }
 
-    context "when a #policy isn't set" do
+    context "when no block initialized" do
 
-      let(:object) { double foo: nil }
       subject { described_class.new :foo }
 
       it "calls validation method" do
@@ -184,32 +167,12 @@ describe Attestor::Validations::Validator do
 
     end # context
 
-    context "when a #policy is set to valid policy" do
+    context "when block initialized" do
 
-      let(:object) { double foo: valid_policy }
-      subject { described_class.new :foo, policy: true }
-
-      it "calls policy method" do
-        expect(object).to receive(:foo)
-      end
+      subject { described_class.new(:baz) { foo } }
 
-      it "doesn't call #invalid" do
-        expect(object).not_to receive(:invalid)
-      end
-
-    end # context
-
-    context "when a #policy is set to valid policy" do
-
-      let(:object) { double foo: invalid_policy, invalid: nil }
-      subject { described_class.new :foo, policy: true }
-
-      it "calls policy method" do
-        expect(object).to receive(:foo)
-      end
-
-      it "calls #invalid with name" do
-        expect(object).to receive(:invalid).with(:foo)
+      it "calls a block" do
+        expect(object).to receive :foo
       end
 
     end # context

data/spec/tests/validations/validators_spec.rb

@@ -3,6 +3,7 @@
 describe Attestor::Validations::Validators do
 
   let(:validator_class) { Attestor::Validations::Validator }
+  let(:follower_class)  { Attestor::Validations::Follower  }
 
   describe ".new" do
 
@@ -31,30 +32,88 @@ describe Attestor::Validations::Validators do
 
   end # describe #each
 
-  describe "#add" do
+  describe "#add_validator" do
 
-    context "without options" do
+    context "without contexts" do
 
-      let(:result) { subject.add("foo") }
+      let(:result) { subject.add_validator "foo" }
 
       it "returns validators" do
         expect(result).to be_kind_of described_class
       end
 
+      it "adds validator (not a follower)" do
+        item = result.first
+        expect(item).to be_kind_of validator_class
+        expect(item).not_to be_kind_of follower_class
+      end
+
+      it "assigns a name" do
+        item = result.first
+        expect(item.name).to eq :foo
+      end
+
+      it "preserves existing items" do
+        expect(result.add_validator(:bar).map(&:name))
+          .to contain_exactly :foo, :bar
+      end
+
+    end # context
+
+    context "with contexts" do
+
+      let(:result) { subject.add_validator "foo", only: [:foo] }
+
       it "adds item to validators" do
+        expect(result.map(&:name)).to eq [:foo]
+        expect(result.set(:foo).map(&:name)).to eq [:foo]
+        expect(result.set(:all).map(&:name)).to eq []
+      end
+
+    end # context
+
+    context "existing validator" do
+
+      subject { described_class.new.add_validator "foo" }
+
+      it "returns itself" do
+        expect(subject.add_validator "foo").to eq subject
+      end
+
+    end # context
+
+  end # describe #add_validator
+
+  describe "#add_follower" do
+
+    context "without contexts" do
+
+      let(:result) { subject.add_follower "foo" }
+
+      it "returns validators" do
+        expect(result).to be_kind_of described_class
+      end
+
+      it "adds a follower" do
+        item = result.first
+        expect(item).to be_kind_of follower_class
+      end
+
+      it "assigns a name" do
         item = result.first
         expect(item.name).to eq :foo
       end
 
       it "preserves existing items" do
-        expect(result.add(:bar).map(&:name)).to contain_exactly :foo, :bar
+        expect(result.add_follower(:bar).map(&:name))
+          .to contain_exactly :foo, :bar
       end
 
     end # context
 
-    context "with options" do
+    context "with contexts" do
 
-      let(:result) { subject.add "foo", only: [:foo] }
+      let(:result) { subject.add_follower "foo", only: [:foo] }
 
       it "adds item to validators" do
         expect(result.map(&:name)).to eq [:foo]
@@ -66,23 +125,23 @@ describe Attestor::Validations::Validators do
 
     context "existing validator" do
 
-      subject { described_class.new.add "foo" }
+      subject { described_class.new.add_follower "foo" }
 
       it "returns itself" do
-        expect(subject.add "foo").to eq subject
+        expect(subject.add_follower "foo").to eq subject
       end
 
     end # context
 
-  end # describe #add
+  end # describe #add_follower
 
-  describe "#context" do
+  describe "#set" do
 
     subject do
       described_class.new
-        .add("foo", only:   %w(cad cam))
-        .add("bar", except: %w(cad))
-        .add("baz", except: %w(cam))
+        .add_validator("foo", only:   %w(cad cam))
+        .add_validator("bar", except: %w(cad))
+        .add_validator("baz", except: %w(cam))
     end
 
     it "returns a collection" do
@@ -95,6 +154,6 @@ describe Attestor::Validations::Validators do
       expect(subject.set("all").map(&:name)).to contain_exactly :bar, :baz
     end
 
-  end # describe #context
+  end # describe #set
 
 end # describe Attestor::Validators

data/spec/tests/validations_spec.rb

@@ -5,14 +5,15 @@ require "support/policies" # for #valid_policy and #invalid_policy definitions
 describe Attestor::Validations do
 
   let(:validators_class) { Attestor::Validations::Validators }
-  let(:validator_class)  { Attestor::Validations::Validator }
+  let(:validator_class)  { Attestor::Validations::Validator  }
+  let(:follower_class)   { Attestor::Validations::Follower   }
   let(:collection_class) { Attestor::Validations::Validators }
-  let(:item_class)       { Attestor::Validations::Item }
-  let(:message_class)    { Attestor::Validations::Message }
-  let(:invalid_error)    { Attestor::InvalidError }
-  let(:test_class)       { Class.new.send(:include, described_class) }
+  let(:item_class)       { Attestor::Validations::Item       }
+  let(:message_class)    { Attestor::Validations::Message    }
+  let(:invalid_error)    { Attestor::InvalidError            }
 
-  before { Test = test_class }
+  let(:test_class) { Class.new.send(:include, described_class) }
+  before { Test = test_class                }
   after  { Object.send :remove_const, :Test }
 
   subject { test_class.new }
@@ -37,10 +38,7 @@ describe Attestor::Validations do
 
       it "registers a validator" do
         expect(test_class.validators.map(&:name)).to eq [:foo]
-      end
-
-      it "sets a validator's policy to false" do
-        expect(test_class.validators.first).not_to be_policy
+        expect(test_class.validators.first).not_to be_kind_of follower_class
       end
 
     end # context
@@ -65,12 +63,9 @@ describe Attestor::Validations do
 
       before { test_class.follow_policy :foo }
 
-      it "registers a validator" do
+      it "registers a follower" do
         expect(test_class.validators.map(&:name)).to eq [:foo]
-      end
-
-      it "sets a validator's policy to true" do
-        expect(test_class.validators.first).to be_policy
+        expect(test_class.validators.first).to be_kind_of follower_class
       end
 
     end # context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attestor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: extlib
@@ -81,6 +81,7 @@ files:
 - lib/attestor/policy/or.rb
 - lib/attestor/policy/xor.rb
 - lib/attestor/validations.rb
+- lib/attestor/validations/follower.rb
 - lib/attestor/validations/message.rb
 - lib/attestor/validations/validator.rb
 - lib/attestor/validations/validators.rb
@@ -97,6 +98,7 @@ files:
 - spec/tests/policy/or_spec.rb
 - spec/tests/policy/xor_spec.rb
 - spec/tests/policy_spec.rb
+- spec/tests/validations/follower_spec.rb
 - spec/tests/validations/message_spec.rb
 - spec/tests/validations/validator_spec.rb
 - spec/tests/validations/validators_spec.rb
@@ -131,6 +133,7 @@ test_files:
 - spec/tests/invalid_error_spec.rb
 - spec/tests/validations_spec.rb
 - spec/tests/validations/message_spec.rb
+- spec/tests/validations/follower_spec.rb
 - spec/tests/validations/validator_spec.rb
 - spec/tests/validations/validators_spec.rb
 - spec/tests/policy/or_spec.rb