duckpond 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49a48ab6dd27f5acfb06ff204a3679299aabab0d
-  data.tar.gz: adeae633ba2f56c289cff8b0f3ae902e2f63e2d2
+  metadata.gz: bb40e8e7d8b6bdc3292b4ddfb0bc5548af7df234
+  data.tar.gz: 4ecca5d9961fc6accd02237c9cd136d8b3c729eb
 SHA512:
-  metadata.gz: 21d67910df3b44f7aac195706ab565b3e20b23549d73251f8ba7dba36f31d033c2e293333d3c17b33b83555b23a345b6b73e97be7ba3cf49b9c19338d64b6c3a
-  data.tar.gz: 2cbf35d78a704430210fff5e7fe78aea5da7c04aba15d484e420501a8b5e4ec26948f6682e019687fed20fd32ed04964d9ea5d7615dcfd5b091b8f5a32184c36
+  metadata.gz: 6665633fd874275fbcef6e1e292966849e5e558ac65230cc7fa78dbb26430b88ad8c0c0eb6e23730c2b397532fb31debbf02c493908f5e21143baf6b4553619f
+  data.tar.gz: 7d9d32e81cf6fd3fbb0b20986c552c0a3d37dd0b6a9ee9de266a427f3672455640f4c25cff2991ce16a93173cbff92a847980e1b38b297dc5d0186bcd1c6b8ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    duckpond (1.0.2)
+    duckpond (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -50,16 +50,16 @@ following contract describes classes which respond to #length and #to_s
 Once you've declared a contract, you can compare objects to it to see if the contract is 
 fulfilled by the object:
 
-  MyContract.fulfilled_by? "Hello"
-  => true
-  MyContract.fulfilled_by? 12
-  => false
+    MyContract.fulfills? "Hello"
+    => true
+    MyContract.fulfills? 12
+    => false
 
-There is also a "bang" version of the fulfilled_by method, that raises an error instead 
+There is also a "bang" version of the #fulfills method, that raises an error instead 
 of returning false.
 
-  MyContract.fulfilled_by! 12
-  => RAISES ERROR!!
+    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:
@@ -87,7 +87,7 @@ And then be implemented in a method like this:
 
     class Emailer
       def send(email)
-        IEmailable.fulfilled_by! email
+        IEmailable.fulfills! email
         email.send
       end
     end

data/docs/the_solution.txt

@@ -11,14 +11,14 @@ end
 # Then use it to check stuff!
 #
 
-ObjContract.fulfilled_by? "Hello"
+ObjContract.fulfills? "Hello"
 => true (or false if not fulfilled)
 
 #
 # The "bang" version will raise an error if the object isn't the duck.
 #
 
-ObjContract.fulfilled_by! "Hello"
+ObjContract.fulfills! "Hello"
 => true (or error if not fulfilled)
 
 #
@@ -27,7 +27,7 @@ ObjContract.fulfilled_by! "Hello"
 
 class Foo
   def self.bar(obj)
-    ObjContract.fulfilled_by! obj
+    ObjContract.fulfills! obj
 
     obj.foo!
     fooinator = Test::Fooinator.new

data/lib/duckpond/contract.rb

@@ -11,10 +11,27 @@ module DuckPond
 
     class << self
 
+      #
+      # clauses
+      #
+      # Gets this contract's list of clauses or returns
+      # an empty array if uninitialized.
+      #
       def clauses
         @clauses ||= []
       end
 
+      #
+      # each_clause
+      #
+      # Iterator for clauses
+      #
+      def each_clause
+        0.upto(clauses.size-1) do |i|
+          yield @clauses[i]
+        end
+      end
+
       #
       # has_method
       #
@@ -30,25 +47,32 @@ module DuckPond
       # Facilitates composition of multiple contracts
       #
       def include_clauses_from(other_contract)
-        other_contract.clauses.each do |other_contracts_quacking|
-          has_method other_contracts_quacking
+        other_contract.each_clause do |other_clause|
+          has_method other_clause
         end
       end
 
       #
-      # fulfilled_by?
+      # fulfills?
       #
-      def fulfilled_by?(obj)
+      # Returns true if this contract fulfills the passed-in object,
+      # otherwise false.
+      #
+      def fulfills?(obj)
         inspection = DuckPond::Inspection.new(obj)
         return false unless inspection.fulfilled_by? self
         true
       end
 
       #
-      # fulfilled_by!
+      # fulfills!
+      #
+      # Raises a ContractInfringementError unless this contract fulfills
+      # the passed in object, otherwise returns true.
       #
-      def fulfilled_by!(obj)
-        raise ContractInfringementError unless fulfilled_by?(obj)
+      def fulfills!(obj)
+        raise ContractInfringementError unless fulfills?(obj)
+        true
       end
     end
   end

data/lib/duckpond/inspection.rb

@@ -1,8 +1,8 @@
 #
 # DuckPond::Inspection
 #
-# The duckpond analysis class is essentially just a wrapper for the inspected
-# object, used here to avoid un-nessecary monkey patching.
+# The duckpond inspection class is essentially just a wrapper for an inspected
+# object (the subject).
 #
 module DuckPond
   class Inspection
@@ -27,7 +27,7 @@ module DuckPond
     # by the contract's clauses.
     #
     def fulfilled_by?(contract)
-      contract.clauses.each do |clause|
+      contract.each_clause do |clause|
         return false unless @subject.respond_to? clause
       end
       true

data/lib/duckpond/version.rb

@@ -1,3 +1,3 @@
 module DuckPond
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/classes/contracts/composite_contract.rb

@@ -0,0 +1,6 @@
+module DuckPond
+  class CompositeContract < Contract
+    include_clauses_from LengthContract
+    has_method :chunky_bacon
+  end
+end

data/spec/classes/contracts/length_contract.rb

@@ -0,0 +1,5 @@
+module DuckPond
+  class LengthContract < DuckPond::Contract
+    has_method :length
+  end
+end

data/spec/contract_spec.rb

@@ -12,64 +12,52 @@ module DuckPond
       end
     end
 
-    class LengthContract < DuckPond::Contract
-      has_method :length
-    end
- 
-    describe 'fulfilled_by?' do
+
+    #
+    # see spec/classes/length_contract.rb
+    #
+    describe 'fulfills?' do
       context 'when the object is fulfilled by the contract' do
         it 'returns true' do
-          expect(LengthContract.fulfilled_by?("Hello")).to eq true
+          expect(LengthContract.fulfills?("Hello")).to eq true
         end
       end
       context 'when the object is not fulfilled by the contract' do
         it 'returns false' do
-          expect(LengthContract.fulfilled_by?(2)).to eq false
+          expect(LengthContract.fulfills?(2)).to eq false
         end
       end
     end
-
-    describe 'fulfilled_by!' do
+    describe 'fulfills!' do
       context 'when the object is fulfilled by the contract' do
         it 'returns true' do
-          expect{LengthContract.fulfilled_by!("Hello")}.to_not raise_error
+          expect{LengthContract.fulfills!("Hello")}.to_not raise_error
         end
       end
       context 'when the object is not fulfilled by the contract' do
         it 'returns false' do
-          expect{LengthContract.fulfilled_by!(2)}.to raise_error
+          expect{LengthContract.fulfills!(2)}.to raise_error
         end
       end
     end
-  end
 
-  class MyContract < Contract
-    has_method :foo
-    has_method :bar
-  end
-
-  describe MyContract do
-    context '.clauses' do
-      it 'quacks like foo and bar' do
-        clauses = MyContract.clauses
-        expect(clauses.length).to eq 2
-        expect(clauses).to include :foo
-        expect(clauses).to include :bar
+    describe '.clauses' do
+      it 'returns the clauses for this contract' do
+        clauses = LengthContract.clauses
+        expect(clauses.length).to eq 1
+        expect(clauses).to include :length
       end
     end
   end
 
-  class MySimilarContract < Contract
-    include_clauses_from MyContract
-    has_method :chunky_bacon
-  end
-
-  describe MySimilarContract do
+  #
+  # See spec/classes/composite_contract.rb
+  #
+  describe CompositeContract do
     it 'retains its parents quackings' do
-      clauses = MySimilarContract.clauses
-      expect(clauses.length).to eq 3 
-      expect(clauses).to include :foo
-      expect(clauses).to include :bar
+      clauses = CompositeContract.clauses
+      expect(clauses.length).to eq 2 
+      expect(clauses).to include :length
       expect(clauses).to include :chunky_bacon
     end
   end

data/spec/inspection_spec.rb

@@ -11,24 +11,19 @@ module DuckPond
     end
 
     describe '#fulfilled_by?' do
-
-      class MyChunkyBaconContract < Contract
-        has_method :chunky_bacon
-      end
-
-      context 'when the sighted object quacks like the duck' do
+      context 'when the inspected object is fulfilled by the contract' do
         it 'returns true' do
-          obj = OpenStruct.new(:chunky_bacon => :mmm)
+          obj = OpenStruct.new(:length => 2)
           inspection = Inspection.new(obj)
-          expect(inspection.fulfilled_by? MyChunkyBaconContract).to be true
+          expect(inspection.fulfilled_by? LengthContract).to be true
         end
       end
 
-      context 'when the sighted object does not quack like the duck' do
+      context 'when the inspected object is not fulfilled by the contract' do
         it 'returns false' do
-          obj = OpenStruct.new(:vegan_fallafal => :yuck)
+          obj = OpenStruct.new(:size => 2)
           inspection = Inspection.new(obj)
-          expect(inspection.fulfilled_by? MyChunkyBaconContract).to be false
+          expect(inspection.fulfilled_by? LengthContract).to be false
         end
       end
 

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'duckpond'
-require 'classes/fooinator'
+require 'classes/contracts/length_contract'
+require 'classes/contracts/composite_contract'
 require 'coveralls'
 
 Coveralls.wear!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckpond
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Mikey Hogarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,8 @@ files:
 - lib/duckpond/contract.rb
 - lib/duckpond/inspection.rb
 - lib/duckpond/version.rb
-- spec/classes/fooinator.rb
+- spec/classes/contracts/composite_contract.rb
+- spec/classes/contracts/length_contract.rb
 - spec/contract_spec.rb
 - spec/inspection_spec.rb
 - spec/spec_helper.rb
@@ -85,12 +86,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Explicit duck-typing for ruby
 test_files:
-- spec/classes/fooinator.rb
+- spec/classes/contracts/composite_contract.rb
+- spec/classes/contracts/length_contract.rb
 - spec/contract_spec.rb
 - spec/inspection_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/classes/fooinator.rb

@@ -1,10 +0,0 @@
-module Duckpond
-  module Test
-    class Fooinator
-      def bar(obj)
-        obj
-      end
-    end
-  end
-end
-