attestor 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ed10bee06c2caea561384393fd3c3a09d8548aa
-  data.tar.gz: 4a808081721ac3ce602ebcb26c1a733878189112
+  metadata.gz: a3c49413757098c3a6f07dc1148d09e0e5c5abe5
+  data.tar.gz: e28e906e513608a83ee9d43903a14d8c4887f23d
 SHA512:
-  metadata.gz: f2ebc2cd9437e77946faf52f458fe719daa70a8cc9baeda2d33a16e31f5dfd34cdf3c9e588f4199f3e749e8bc29f9eee738936a7d70c688d620ad69d32b037b0
-  data.tar.gz: 36c544456aa601a9b87bbd50568eb27253a866853b06081e714651e7acd37e2f6fdb622827bd55952c250f5cbbb1304f21b13a41d2d53ceb72321857c950b963
+  metadata.gz: 01204cc6953c5a0d06f65f0d568ea9259ab2e6a15d3e5945d353d67e4bfa14f40b1f822962939d3e7f6b1942a1fb7bb15354a72849cc4bc8a052e798ef43e791
+  data.tar.gz: dd468cf1fd35facc245a6e142e745282ed856d9c2eacce6ddecbff27d82d1c3fb1395f0d426bfbb644baac368e5c3c2db31cf053a4d2fbf1adf2770e9697c8bb

data/README.md

@@ -170,6 +170,22 @@ class Transfer
 end
 ```
 
+You can group validations that uses shared context:
+
+```ruby
+class Transfer
+
+  # This is the same as:
+  #
+  # validate :consistent, only: :fair_trade
+  # validate :limited, only: :fair_trade
+  validations only: :fair_trade do
+    validate :consistent
+    validate :limited
+  end
+end
+```
+
 Delegation
 ----------
 

data/lib/attestor.rb

@@ -13,6 +13,7 @@ require_relative "attestor/validations/validator"
 require_relative "attestor/validations/delegator"
 require_relative "attestor/validations/validators"
 require_relative "attestor/validations/message"
+require_relative "attestor/validations/context"
 
 require_relative "attestor/policy/factory"
 require_relative "attestor/policy"

data/lib/attestor/policy.rb

@@ -2,7 +2,7 @@
 
 module Attestor
 
-  # API for policies that validates another objects
+  # API for policies that validate another objects
   module Policy
     # @!parse include Attestor::Validations
     # @!parse extend Attestor::Validations::ClassMethods

data/lib/attestor/rspec.rb

@@ -8,6 +8,8 @@ module Attestor
     include ::RSpec::Mocks::ExampleMethods
 
     # Mocks a valid object
+    #
+    # @return [RSpec::Mocks::Double]
     def valid_spy
       object = spy
       allow(object).to receive(:validate!)
@@ -16,7 +18,11 @@ module Attestor
       object
     end
 
-    # Mocks an invalid object
+    # Mocks an invalid object with given error messages
+    #
+    # @param [String, Array<String>] messages
+    #
+    # @return [RSpec::Mocks::Double]
     def invalid_spy(messages = "invalid")
       object = spy
       error  = InvalidError.new(object, messages)

data/lib/attestor/validations.rb

@@ -111,6 +111,27 @@ module Attestor
         @validators = validators.add_delegator(*args, &block)
       end
 
+      # Groups validations assigned to shared context
+      #
+      # @example
+      #   validations only: :foo do
+      #     validates :bar
+      #     validate  { invalid :foo unless baz }
+      #   end
+      #
+      #   # this is equal to:
+      #
+      #   validates :bar, only: :foo
+      #   validate  { invalid :foo unless baz }, only: :foo
+      #
+      # @param [Hash] options
+      # @param [Proc] block
+      #
+      # @return [undefined]
+      def validations(**options, &block)
+        Context.new(self, options).instance_eval(&block) if block_given?
+      end
+
     end # module ClassMethods
 
     # @private

data/lib/attestor/validations/context.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Attestor
+
+  module Validations
+
+    # @private
+    class Context
+
+      attr_accessor :klass, :options
+
+      def initialize(klass, options)
+        self.klass   = klass
+        self.options = options
+      end
+
+      def validate(name = nil, &block)
+        klass.validate(name, options, &block)
+      end
+
+      def validates(name = nil, &block)
+        klass.validates(name, options, &block)
+      end
+
+    end # class Context
+
+  end # module Validations
+
+end # module Attestor

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

data/spec/tests/validations/context_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe Attestor::Validations::Context do
+
+  let(:klass)   { double validate: nil, validates: nil }
+  let(:options) { { except: :foo, only: :bar }         }
+  let(:name)    { :baz                                 }
+  let(:block)   { proc { :foo }                        }
+  subject       { described_class.new klass, options   }
+
+  describe "#klass" do
+
+    it "is initialized" do
+      expect(subject.klass).to eq klass
+    end
+
+  end # describe #klass
+
+  describe "#options" do
+
+    it "is initialized" do
+      expect(subject.options).to eq options
+    end
+
+  end # describe #options
+
+  describe "#validate" do
+
+    it "is delegated to klass with name and options" do
+      expect(klass).to receive(:validate).with(name, **options)
+      subject.validate name
+    end
+
+    it "is delegated to klass with a block" do
+      expect(klass).to receive(:validate) do |*, &b|
+        expect(b).to eq block
+      end
+      subject.validate(&block)
+    end
+
+  end # describe #validate
+
+  describe "#validates" do
+
+    it "is delegated to klass with name and options" do
+      expect(klass).to receive(:validates).with(name, **options)
+      subject.validates name
+    end
+
+    it "is delegated to klass with a block" do
+      expect(klass).to receive(:validates) do |*, &b|
+        expect(b).to eq block
+      end
+      subject.validates(&block)
+    end
+
+  end # describe #validates
+
+end # describe Attestor::Validations::Context

data/spec/tests/validations_spec.rb

@@ -129,6 +129,39 @@ describe Attestor::Validations do
 
   end # describe .validates
 
+  describe ".validations" do
+
+    let(:options)       { { only: :bar, except: :baz }         }
+    let(:context_class) { Attestor::Validations::Context       }
+    let(:context)       { double validate: nil, validates: nil }
+    before { allow(context_class).to receive(:new) { context } }
+
+    context "with a block" do
+
+      after { test_class.validations(options) { validate :foo } }
+
+      it "initializes a context group" do
+        expect(context_class).to receive(:new).with(test_class, options)
+      end
+
+      it "calls the block in a context's scope" do
+        expect(context).to receive(:validate).with(:foo)
+      end
+
+    end # context
+
+    context "without a block" do
+
+      after { test_class.validations(options) }
+
+      it "does nothing" do
+        expect(context_class).not_to receive(:new)
+      end
+
+    end # context
+
+  end # describe .validations
+
   describe "#invalid" do
 
     shared_examples "raising an error" do |name, options = {}|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attestor
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andrew Kozin
@@ -14,28 +14,28 @@ dependencies:
   name: extlib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
 description: Validations for immutable Ruby objects
@@ -46,13 +46,13 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".metrics"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
+- .coveralls.yml
+- .gitignore
+- .metrics
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
 - Gemfile
 - Guardfile
 - LICENSE
@@ -83,6 +83,7 @@ files:
 - lib/attestor/report.rb
 - lib/attestor/rspec.rb
 - lib/attestor/validations.rb
+- lib/attestor/validations/context.rb
 - lib/attestor/validations/delegator.rb
 - lib/attestor/validations/message.rb
 - lib/attestor/validations/reporter.rb
@@ -103,6 +104,7 @@ files:
 - spec/tests/policy_spec.rb
 - spec/tests/report_spec.rb
 - spec/tests/rspec_spec.rb
+- spec/tests/validations/context_spec.rb
 - spec/tests/validations/delegator_spec.rb
 - spec/tests/validations/message_spec.rb
 - spec/tests/validations/reporter_spec.rb
@@ -119,12 +121,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ~>
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -139,6 +141,7 @@ test_files:
 - spec/tests/invalid_error_spec.rb
 - spec/tests/validations_spec.rb
 - spec/tests/report_spec.rb
+- spec/tests/validations/context_spec.rb
 - spec/tests/validations/message_spec.rb
 - spec/tests/validations/validator_spec.rb
 - spec/tests/validations/reporter_spec.rb