attestor 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b4d9f6dfa1931f69062623223fafaf32ec4d158
-  data.tar.gz: a18709a18446af9c58a71287eb9b3d923c125aed
+  metadata.gz: 0ed10bee06c2caea561384393fd3c3a09d8548aa
+  data.tar.gz: 4a808081721ac3ce602ebcb26c1a733878189112
 SHA512:
-  metadata.gz: fadf072439c8efa450e86ff37f7dd5778c67ce7a087eaea4e012e0267d9dce2b877283b76c04b1434b1ab0d17b7a00a48317ddeee766304d7ff08ebb02c66109
-  data.tar.gz: 0c5fccf30fe0cfc574d71b3235da77acc904c3f537f4d9ffb4887184925d42c57d82736f99d0af0954fe000c0bc141cc1793bd15911275485bfcfc648bb235c6
+  metadata.gz: f2ebc2cd9437e77946faf52f458fe719daa70a8cc9baeda2d33a16e31f5dfd34cdf3c9e588f4199f3e749e8bc29f9eee738936a7d70c688d620ad69d32b037b0
+  data.tar.gz: 36c544456aa601a9b87bbd50568eb27253a866853b06081e714651e7acd37e2f6fdb622827bd55952c250f5cbbb1304f21b13a41d2d53ceb72321857c950b963

data/README.md

@@ -86,7 +86,7 @@ Transfer = Struct.new(:debet, :credit) do
 end
 ```
 
-Alternatively, you can describe validation in the block (called in the scope of instance):
+Alternatively, you can describe validation in a block, executed in an instance's scope:
 
 ```ruby
 class Transfer
@@ -95,7 +95,7 @@ class Transfer
 end
 ```
 
-The `#invalid` method translates its argument in a current class scope and raises an exception with that method.
+The `#invalid` method translates its argument and raises an exception with the resulting message.
 
 ```yaml
 # config/locales/en.yml
@@ -107,7 +107,7 @@ en:
         inconsistent: "Credit differs from debet by %{fraud}"
 ```
 
-To run validations use the `#validate!` instance method:
+To validate an object, use its `#validate!` method:
 
 ```ruby
 debet  = OpenStruct.new(sum: 100)
@@ -122,7 +122,8 @@ rescue Attestor::InvalidError => error
 end
 ```
 
-Another option is to use the safe version `#validate`. It rescues from the exception and returns results in a separate report object:
+Alternatively use the safe version `#validate`.
+It rescues from an exception and returns a corresponding report:
 
 ```ruby
 report = transfer.validate  # without the bang
@@ -134,6 +135,8 @@ report.messages             # => ["Credit differs from debet by 10"]
 report.error                # => <Attestor::InvalidError ...>
 ```
 
+Once again, the report collects messages outside of the checked object.
+
 Use of Contexts
 ---------------
 
@@ -155,14 +158,13 @@ fraud_transfer.validate!                 # => InvalidError
 fraud_transfer.validate! :steal_of_money # => PASSES!
 ```
 
-You can use the same validator several times with different contexts.
+You can use the same validator several times with different contexts. They will be used independently from each other.
 
 ```ruby
 class Transfer
   # ...
 
-  # validate :consistent, only: [:fair_trade, :legal]
-  validate :consistent, only: :fair_trade
+  validate :consistent, only: :fair_trade, :consistent
   validate :consistent, only: :legal
 
 end
@@ -183,7 +185,7 @@ ConsistentTransfer = Struct.new(:debet, :credit) do
 end
 ```
 
-Then use `validates` helper:
+Then use `validates` helper (with an "s" at the end):
 
 ```ruby
 class Transfer 
@@ -204,7 +206,7 @@ class Transfer
   end
 ```
 
-The difference between `.validate :something` and `.validates :something` class methods is that:
+The difference between `.validate :something` and `.validates :something` methods is that:
 * `.validate` expects `#something` to make checks and raise error by itself
 * `.validates` expects `#something` to respond to `#validate!`
 
@@ -299,6 +301,33 @@ Policy.not(valid_policy)
 
 As before, you can use any number of policies (except for negation of a single policy) at any number of nesting.
 
+RSpec helpers
+-------------
+
+In a RSpec tests you can use spies for valid and invalid objects:
+
+* `valid_spy` is a spy that returns `nil` in response to `#validate!` and valid report in responce to `#validate`.
+* `invalid_spy` raises on `#validate!` and returns invalid report in responce to `#validate` method call.
+
+```ruby
+require "attestor/rspec"
+
+describe "something" do
+
+  let(:valid_object)   { valid_spy   }
+  let(:invalid_object) { invalid_spy }
+
+  # ...
+end
+```
+
+To check whether an arbitrary object is valid, simply use `#validate` method's result:
+
+```ruby
+expect(object.validate).to be_valid
+expect(object.validate).to be_invalid
+```
+
 Latest changes
 --------------
 
@@ -308,6 +337,8 @@ Latest changes
 
 2. Policies doesn't have `#valid?` and `#invalid?` methods any longer. Both the methods are removed to `#validate` report.
 
+### Version 2.1.0
+
 Compatibility
 -------------
 

data/lib/attestor/rspec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require "rspec"
+
+module Attestor
+
+  # Helpers for validations
+  module RSpec
+    include ::RSpec::Mocks::ExampleMethods
+
+    # Mocks a valid object
+    def valid_spy
+      object = spy
+      allow(object).to receive(:validate!)
+      allow(object).to receive(:validate) { Report.new(object) }
+
+      object
+    end
+
+    # Mocks an invalid object
+    def invalid_spy(messages = "invalid")
+      object = spy
+      error  = InvalidError.new(object, messages)
+      allow(object).to receive(:validate!) { fail error }
+      allow(object).to receive(:validate)  { Report.new(object, error) }
+
+      object
+    end
+
+  end # module RSpec
+
+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.0.0".freeze
+  VERSION = "2.1.0".freeze
 
 end # module Attestor

data/spec/tests/rspec_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+require "attestor/rspec"
+
+describe Attestor::RSpec do
+
+  let(:report_class)  { Attestor::Report       }
+  let(:invalid_error) { Attestor::InvalidError }
+  let(:double_class)  { ::RSpec::Mocks::Double }
+
+  subject { Class.new.send(:include, described_class).new }
+
+  describe "#valid_spy" do
+
+    let(:valid_spy) { subject.valid_spy }
+
+    it "returns a spy" do
+      expect(valid_spy).to be_kind_of(double_class)
+    end
+
+    it "doesn't raise on #validate!" do
+      expect { valid_spy.validate! }.not_to raise_error
+      expect(valid_spy.validate!).to be_nil
+    end
+
+    it "returns a valid report on #validate" do
+      report = valid_spy.validate
+
+      expect(report).to be_kind_of(report_class)
+      expect(report).to be_valid
+      expect(report.object).to eq valid_spy
+    end
+
+  end # describe #valid_spy
+
+  describe "#invalid_spy" do
+
+    context "without messages" do
+
+      let(:invalid_spy) { subject.invalid_spy }
+
+      it "returns a spy" do
+        expect(invalid_spy).to be_kind_of(double_class)
+      end
+
+      it "raises InvalidError on #validate!" do
+        expect { invalid_spy.validate! }.to raise_error(invalid_error)
+      end
+
+      it "adds itself to the exception on #validate!" do
+        begin
+          invalid_spy.validate!
+        rescue => error
+          expect(error.object).to eq invalid_spy
+        end
+      end
+
+      it "returns a valid report on #validate" do
+        report = invalid_spy.validate
+
+        expect(report).to be_kind_of(report_class)
+        expect(report).to be_invalid
+        expect(report.object).to eq invalid_spy
+      end
+
+      it "adds an 'invalid' message to the exception" do
+        report = invalid_spy.validate
+        expect(report.messages).to eq ["invalid"]
+      end
+
+    end # context
+
+    context "with a message" do
+
+      let(:message)     { "error" }
+      let(:invalid_spy) { subject.invalid_spy message }
+
+      it "adds the message to the exception" do
+        report = invalid_spy.validate
+        expect(report.messages).to eq [message]
+      end
+
+    end # context
+
+    context "with a list of messages" do
+
+      let(:messages)    { %w(error exception) }
+      let(:invalid_spy) { subject.invalid_spy(messages) }
+
+      it "adds all the messages to the exception" do
+        report = invalid_spy.validate
+        expect(report.messages).to eq messages
+      end
+
+    end # context
+
+  end # describe #invalid_spy
+
+end # describe Attestor::RSpec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attestor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-04-06 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/report.rb
+- lib/attestor/rspec.rb
 - lib/attestor/validations.rb
 - lib/attestor/validations/delegator.rb
 - lib/attestor/validations/message.rb
@@ -101,6 +102,7 @@ files:
 - spec/tests/policy/xor_spec.rb
 - spec/tests/policy_spec.rb
 - spec/tests/report_spec.rb
+- spec/tests/rspec_spec.rb
 - spec/tests/validations/delegator_spec.rb
 - spec/tests/validations/message_spec.rb
 - spec/tests/validations/reporter_spec.rb
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Validations for immutable Ruby objects
@@ -149,6 +151,7 @@ test_files:
 - spec/tests/policy/negator_spec.rb
 - spec/tests/policy/not_spec.rb
 - spec/tests/policy/node_spec.rb
+- spec/tests/rspec_spec.rb
 - spec/features/example_spec.rb
 - spec/support/policies.rb
 has_rdoc: