duckpond 1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e412869c6899468637cccaf6debbf31ffef6fd7a
-  data.tar.gz: aaf49e52a9f2c35987260541a3c888d7cf89e7c6
+  metadata.gz: 6c635271dca4ed930b071dc968a417b806c7cfb1
+  data.tar.gz: 4a8da65e653dadfac684a2204199d9f9acd3d9c4
 SHA512:
-  metadata.gz: f14ccc6e1268198efc50b0116e0fa4a4c0d4ec52ffeee97e4bf92f2fbf2396bf4a682614f08204310112a52fb24ec8b2c99ff7bb87e302b5bf8eb10d42c738b1
-  data.tar.gz: 42995441b44f631d907cec3d3e5d8849b2f0266cb84f16a01a627e2e202c042459b139ae9f2ad82dcb440630db0f267e08d8c1ac92aa55817049067da936a440
+  metadata.gz: 52973252980ae5be14a152965de3f0faffc8cc0de46489ee3002a07f4f457b30cf92298e453c37d79d4e80911a42f90ccd37aecfc58cc460966f87a6e337f822
+  data.tar.gz: d426f2173a3cc9baae657ddb8782d1f9749870a1f2ddfbd1350fba3af971e1ba043bedc53341e7f53506f28208249fd078e76425da321191c1dbacb59e944677

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
   - jruby-19mode 
 
 script: bundle exec rspec spec

data/Gemfile.lock

@@ -1,52 +1,53 @@
 PATH
   remote: .
   specs:
-    duckpond (1.1.4)
+    duckpond (1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    mime-types (2.3)
-    multi_json (1.10.1)
+    json (1.8.3)
     rake (0.9.6)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.1)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.1)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
-    simplecov (0.8.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.3.0)
+    tins (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  bundler (~> 1.10)
   coveralls
   duckpond!
   rake (~> 0)
   rspec
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -7,7 +7,7 @@
 Explicit duck typing for ruby.
 
 
-## Inspiration
+## Introduction
 
 Duck Typing can make code confusing and unreadable, particularly 
 when multiple developers are working on the same project or when 
@@ -35,6 +35,8 @@ Or install it yourself as:
 
 ## Usage
 
+There is now a [screencast](https://www.youtube.com/watch?v=XTFigHzAfsk&feature=youtu.be) demonstrating the duckpond gem! 
+
 Usage is demonstrated in '[the_solution](docs/the_solution.txt)', but in a nutshell you 
 create "contract" classes by inheriting from DuckPond::Contract. These classes should 
 be commented extensively. 
@@ -56,10 +58,13 @@ fulfilled by the object:
     => false
 
 There is also a "bang" version of the #fulfills method, that raises an error instead 
-of returning false.
+of returning false. The error message details why it got raised.
+
+    MyContract.fulfills! :foo 
+    => DuckPond::Contract::ContractInfringementError:
+       One or more clauses from MyContract were not fulfilled by :foo (Symbol) 
+       Expected subject to respond to method 'length'
 
-    MyContract.fulfills! 12
-    => RAISES ERROR!!
 
 Contracts can be combined into composite "super contracts" - contracts which are made up of 
 various other contracts. This ties in with the reccomendation of preferring composition over inheritance:
@@ -127,11 +132,11 @@ And then be implemented in a method like this:
 
 ## Compatibility
 
-CI tests exist for the following rubies, so they definately work and there's no reason all 1.9.x rubies wouldnt' work either:
+CI tests exist for the following rubies, other versions are not supported but should still work;
 
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
   - jruby-19mode 
 
 

data/duckpond.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 0"
 end

data/lib/duckpond/clause/method_clause.rb

@@ -4,43 +4,58 @@
 # Satisfied if the subject responds to the method represented
 # by this clause.
 #
+# Available Options:
+#
+# :method_name    => The name of the method to check for / call
+# :given_args     => Arguments to pass into the method
+# :responds_with  => What you would expect the method to respond with
+#
+#
 module DuckPond
   class MethodClause < Clause
 
-    def method_name
-      @options[:method_name]
-    end
-
-    #
-    # satisfied_by?
     #
-    # A subject satisfies a method clause if it responds to that method.
+    # legal_assesment
     #
-    def satisfied_by?(subject)
-
-      # Check the method actually exists.
-      return false unless subject.respond_to? method_name
-
-      # Unless a block was given, or a response is required, we're done!
-      return true unless @options[:block] || @options[:responds_with]
-
-      # If we get this far, we need to tap into the result of the method
-      # call, as the user is interrogating it somehow.
-      response_when_called(subject, method_name, @options[:given_args])
-        .tap do |response_when_called|
-        if @options[:block]
-          return false unless @options[:block].call(response_when_called)
+    def legal_assesment(subject)
+      Lawyer.new do |lawyer|
+        unless subject.respond_to? method
+          lawyer.unsatisfied! "Expected subject to respond to method '#{method}'"
         end
-        if @options[:responds_with]
-          return false unless response_when_called == @options[:responds_with]
+
+        if @block || expected_response
+          response_when_called(subject, method, args).tap do |response_when_called|
+            if @block
+              unless @block.call(response_when_called)
+                lawyer.unsatisfied! "Block did not respond with 'true' for method #{method}"
+              end
+            end
+            
+            if expected_response
+              unless response_when_called == expected_response
+                lawyer.unsatisfied! "Expected method #{method} to return #{expected_response} but got #{response_when_called}"  
+              end
+            end
+          end
         end
       end
-      true
     end
 
     private 
     def response_when_called(subject, method, args = [])
-      subject.send(method_name, *args)
+      subject.send(method, *args)
+    end
+
+    def method
+      @options[:method_name]
+    end
+
+    def expected_response
+      @options[:responds_with]
+    end
+
+    def args
+      @options[:given_args]
     end
 
   end

data/lib/duckpond/clause.rb

@@ -6,14 +6,26 @@
 module DuckPond
   class Clause
 
-    attr_reader :options
+    attr_reader :options, :block
 
     #
     # initialize
     #
     def initialize(opts={}, block)
       @options = opts
-      @options[:block] = block
+      @block = block
     end
+
+    def satisfied_by?(subject)
+      self.legal_assesment(subject).satisfied?
+    end
+
+    def legal_assesment
+      # it is the responsibility of clauses to provide a #legal_assesment
+      # method - this should return a lawyer who is either satisfied or 
+      # not satisfied that the subject fulfills the clause.
+      raise NotImplementedError
+    end
+
   end
 end

data/lib/duckpond/contract/contract_infringement_error.rb

@@ -0,0 +1,19 @@
+module DuckPond
+  class Contract
+    class ContractInfringementError < TypeError
+      def initialize(contract, subject, inspection = nil)
+        @contract     = contract
+        @subject      = subject
+        @messages     = inspection.messages
+      end
+      
+      def message
+        %Q{
+        One or more clauses from #{@contract} were not fulfilled by #{@subject} (#{@subject.class}) 
+        #{@messages.join(', ') if @messages.any?}
+        }
+      end
+    
+    end
+  end
+end

data/lib/duckpond/contract/convinience_methods.rb

@@ -0,0 +1,24 @@
+#
+# Contract::ConvinienceMethods
+#
+# A set of methods used to make adding clauses easier for the user.
+#
+module DuckPond
+  class Contract
+    module ConvinienceMethods
+      #
+      # has_method
+      #
+      # Adds a method clause to the contract
+      #
+      def has_method(method_name, opts = {})
+        if block_given?
+          has_clause(MethodClause, opts.merge(:method_name => method_name), &Proc.new)
+        else
+          has_clause(MethodClause, opts.merge(:method_name => method_name))
+        end
+      end
+
+    end
+  end
+end

data/lib/duckpond/contract.rb

@@ -1,3 +1,6 @@
+require 'duckpond/contract/convinience_methods'
+require 'duckpond/contract/contract_infringement_error'
+
 # 
 # DuckPond::Contract
 #
@@ -7,7 +10,7 @@
 #
 module DuckPond
   class Contract
-    class ContractInfringementError < TypeError;end
+    extend DuckPond::Contract::ConvinienceMethods
 
     class << self
 
@@ -41,20 +44,6 @@ module DuckPond
         clauses << clause_klass.new(opts, block)
       end
 
-
-      #
-      # has_method
-      #
-      # Adds a method clause to the contract
-      #
-      def has_method(method_name, opts = {})
-        if block_given?
-          has_clause(MethodClause, opts.merge(:method_name => method_name), &Proc.new)
-        else
-          has_clause(MethodClause, opts.merge(:method_name => method_name))
-        end
-      end
-
       #
       # include_clauses_from
       #
@@ -62,7 +51,7 @@ module DuckPond
       #
       def include_clauses_from(other_contract)
         other_contract.each_clause do |other_clause|
-          has_method other_clause.method_name
+          has_clause other_clause.class, other_clause.options, &other_clause.block
         end
       end
 
@@ -73,11 +62,13 @@ module DuckPond
       # otherwise false.
       #
       def fulfills?(obj)
-        inspection = DuckPond::Inspection.new(obj)
-        return false unless inspection.fulfilled_by? self
-        true
+        DuckPond::Inspection.new(obj).tap do |inspection|
+          return inspection.fulfilled_by? self
+        end
       end
 
+      alias_method :fulfilled_by?, :fulfills?
+
       #
       # fulfills!
       #
@@ -85,9 +76,17 @@ module DuckPond
       # the passed in object, otherwise returns true.
       #
       def fulfills!(obj)
-        raise ContractInfringementError unless fulfills?(obj)
-        true
+        DuckPond::Inspection.new(obj).tap do |inspection|
+          unless inspection.fulfilled_by? self
+            raise ContractInfringementError.new(self, obj, inspection)
+          else
+            return true
+          end
+        end
       end
+
+      alias_method :fulfilled_by!, :fulfills!
+
     end
   end
 end

data/lib/duckpond/inspection.rb

@@ -16,7 +16,13 @@ module DuckPond
     # Construct with any ruby object. 
     #
     def initialize(subject)
-      @subject = subject
+      @subject    = subject
+      @satisfied  = true
+      @messages   = []
+    end
+
+    def messages
+      @messages.flatten.uniq
     end
 
     # 
@@ -28,9 +34,18 @@ module DuckPond
     #
     def fulfilled_by?(contract)
       contract.each_clause do |clause|
-        return false unless clause.satisfied_by?(@subject)
+        clause.legal_assesment(@subject).tap do |lawyer|
+          unless lawyer.satisfied?
+            @satisfied = false
+            @messages << lawyer.messages 
+          end
+        end
       end
-      true
+      @satisfied
+    end
+
+    def satisfied?
+      @satisfied
     end
   end
 end

data/lib/duckpond/lawyer.rb

@@ -0,0 +1,30 @@
+#
+# DuckPond::Lawyer
+#
+# The lawyer class is responsible for maintaining the sate of satisfaction
+# between a subject and its contract. Typically these are used in clauses.
+#
+module DuckPond
+  class Lawyer
+
+    def initialize
+      @satisfied = true
+      @messages = []
+      yield self if block_given?
+    end
+
+    def satisfied?
+      @satisfied
+    end
+
+    def messages
+      @messages
+    end
+
+    def unsatisfied!(msg = nil)
+      @satisfied = false
+      @messages << msg unless msg.nil?
+    end
+  end
+
+end

data/lib/duckpond/version.rb

@@ -1,3 +1,3 @@
 module DuckPond
-  VERSION = "1.2"
+  VERSION = "1.2.1"
 end

data/lib/duckpond.rb

@@ -1,4 +1,5 @@
 require 'duckpond/version'
+require 'duckpond/lawyer'
 require 'duckpond/contract'
 require 'duckpond/inspection'
 

data/spec/clauses/{method_clause_spec.rb → method_clause/method_clause_spec.rb}

@@ -12,7 +12,7 @@ module DuckPond
       context 'when constructed with a method name option' do
         it 'adds that method name as an attribute' do
           clause = MethodClause.new({:method_name => :foo}, nil)
-          expect(clause.method_name).to eq :foo
+          expect(clause.options[:method_name]).to eq :foo
         end
       end
     end
@@ -24,12 +24,12 @@ module DuckPond
 
         context 'when the subject responds to the clauses method' do 
           it 'returns true' do
-            expect(clause.satisfied_by? 'Hello').to eq true
+            expect(clause.satisfied_by?('Hello')).to eq true
           end
         end
         context 'when the subject responds to the clauses method' do 
           it 'returns false' do
-            expect(clause.satisfied_by? 42).to eq false
+            expect(clause.satisfied_by?(42)).to eq false
           end
         end
       end

data/spec/clauses/method_clause/method_clause_usage_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'MethodClause usage' do
+
+  #
+  # see spec/classes/specific_length_contract.rb
+  #
+  describe SpecificLengthContract do
+    it 'checks a methods response is correct' do
+      expect(SpecificLengthContract.fulfills?("Hello")).to eq true
+      expect(SpecificLengthContract.fulfills?("Yello")).to eq false
+      expect(SpecificLengthContract.fulfills?("Goodbye")).to eq false
+    end
+  end
+
+  describe SpecificLengthBehaviourContract do
+    it 'checks the given block against the subjects method repsonse' do
+      expect(SpecificLengthBehaviourContract.fulfills?('Hello')).to eq true
+      expect(SpecificLengthBehaviourContract.fulfills?('Goodbye')).to eq false
+    end
+  end
+
+  describe SpecificIncludeBehaviourContract do
+    it 'checks the given block against the subjects method response' do
+      expect(SpecificIncludeBehaviourContract.fulfills?('Hello')).to eq true
+      expect(SpecificLengthBehaviourContract.fulfills?('Goodbye')).to eq false  
+    end
+  end
+
+end

data/spec/contract_spec.rb

@@ -36,7 +36,7 @@ module DuckPond
       end
       context 'when the object is not fulfilled by the contract' do
         it 'returns false' do
-          expect{LengthContract.fulfills!(2)}.to raise_error
+         expect{LengthContract.fulfills!(2)}.to raise_error DuckPond::Contract::ContractInfringementError
         end
       end
     end
@@ -45,36 +45,11 @@ module DuckPond
       it 'returns the clauses for this contract' do
         clauses = LengthContract.clauses
         expect(clauses.length).to eq 1
-        expect(clauses.map(&:method_name)).to include :length
+        expect(clauses.first.options[:method_name]).to eq :length
       end
     end
   end
 
-  #
-  # see spec/classes/specific_length_contract.rb
-  #
-  describe SpecificLengthContract do
-    it 'checks a methods response is correct' do
-      expect(SpecificLengthContract.fulfills?("Hello")).to eq true
-      expect(SpecificLengthContract.fulfills?("Yello")).to eq false
-      expect(SpecificLengthContract.fulfills?("Goodbye")).to eq false
-    end
-  end
-
-  describe SpecificLengthBehaviourContract do
-    it 'checks the given block against the subjects method repsonse' do
-      expect(SpecificLengthBehaviourContract.fulfills?('Hello')).to eq true
-      expect(SpecificLengthBehaviourContract.fulfills?('Goodbye')).to eq false
-    end
-  end
-
-  describe SpecificIncludeBehaviourContract do
-    it 'checks the given block against the subjects method response' do
-      expect(SpecificIncludeBehaviourContract.fulfills?('Hello')).to eq true
-      expect(SpecificLengthBehaviourContract.fulfills?('Goodbye')).to eq false  
-    end
-  end
-
   #
   # See spec/classes/composite_contract.rb
   #
@@ -82,8 +57,11 @@ module DuckPond
     it 'retains its parents quackings' do
       clauses = CompositeContract.clauses
       expect(clauses.length).to eq 2 
-      expect(clauses.map(&:method_name)).to include :length
-      expect(clauses.map(&:method_name)).to include :chunky_bacon
+      clauses.map {|c|c.options[:method_name]}.tap do |method_names|
+        expect(method_names).to include :length
+        expect(method_names).to include :chunky_bacon
+      end
     end
   end
+
 end

data/spec/lawyer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module DuckPond
+  describe Lawyer do
+    describe 'constructor' do
+      it 'yields itself if passed a block' do 
+        oid_1 = nil
+        oid_2 = Lawyer.new do |lawyer|
+          oid_1 = lawyer.object_id
+        end.object_id
+        expect(oid_1).to eq oid_2
+      end
+    end
+    describe 'unsatisified!' do
+      it 'sets the lawyers satisfied flag to false' do
+        lawyer = Lawyer.new
+        expect(lawyer.satisfied?).to be true
+
+        lawyer.unsatisfied!
+        expect(lawyer.satisfied?).to be false
+      end
+    end
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: duckpond
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.1
 platform: ruby
 authors:
 - Mikey Hogarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Explicit duck-typing for ruby
@@ -45,9 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -60,16 +60,21 @@ files:
 - lib/duckpond/clause.rb
 - lib/duckpond/clause/method_clause.rb
 - lib/duckpond/contract.rb
+- lib/duckpond/contract/contract_infringement_error.rb
+- lib/duckpond/contract/convinience_methods.rb
 - lib/duckpond/inspection.rb
+- lib/duckpond/lawyer.rb
 - lib/duckpond/version.rb
 - spec/classes/contracts/composite_contract.rb
 - spec/classes/contracts/length_contract.rb
 - spec/classes/contracts/specific_include_behaviour_contract.rb
 - spec/classes/contracts/specific_length_behaviour_contract.rb
 - spec/classes/contracts/specific_length_contract.rb
-- spec/clauses/method_clause_spec.rb
+- spec/clauses/method_clause/method_clause_spec.rb
+- spec/clauses/method_clause/method_clause_usage_spec.rb
 - spec/contract_spec.rb
 - spec/inspection_spec.rb
+- spec/lawyer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mikeyhogarth/duckpond
 licenses:
@@ -81,17 +86,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Explicit duck-typing for ruby
@@ -101,7 +106,10 @@ test_files:
 - spec/classes/contracts/specific_include_behaviour_contract.rb
 - spec/classes/contracts/specific_length_behaviour_contract.rb
 - spec/classes/contracts/specific_length_contract.rb
-- spec/clauses/method_clause_spec.rb
+- spec/clauses/method_clause/method_clause_spec.rb
+- spec/clauses/method_clause/method_clause_usage_spec.rb
 - spec/contract_spec.rb
 - spec/inspection_spec.rb
+- spec/lawyer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: