duckpond 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c635271dca4ed930b071dc968a417b806c7cfb1
-  data.tar.gz: 4a8da65e653dadfac684a2204199d9f9acd3d9c4
+  metadata.gz: 25f58d57f27f8eea84453a30e35456fc61c0d320
+  data.tar.gz: c37bc4985281d5a60b166ac78f02bb5a680b18db
 SHA512:
-  metadata.gz: 52973252980ae5be14a152965de3f0faffc8cc0de46489ee3002a07f4f457b30cf92298e453c37d79d4e80911a42f90ccd37aecfc58cc460966f87a6e337f822
-  data.tar.gz: d426f2173a3cc9baae657ddb8782d1f9749870a1f2ddfbd1350fba3af971e1ba043bedc53341e7f53506f28208249fd078e76425da321191c1dbacb59e944677
+  metadata.gz: ea56f737804b79577766ea0d0ca015faf6963b6bb8ad2fb3fa545583dfd8c36b3121e145a0011b5c13f8c0676adf513c66e173896976dc359f7ada620c2c7bad
+  data.tar.gz: dcbaddf7457e2eea1e97ae467d42fd260c8dc1a1348218fb88477d488c1a02db80a437f247feeba95f2fd81bfbe0c4270cd3c724f812717e7155db17df8df9e6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    duckpond (1.2)
+    duckpond (1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -50,4 +50,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -9,9 +9,9 @@ Explicit duck typing for ruby.
 
 ## Introduction
 
-Duck Typing can make code confusing and unreadable, particularly 
-when multiple developers are working on the same project or when 
-projects are inherited by new developers. 
+Duck Typing can make code confusing and unreadable, particularly
+when multiple developers are working on the same project or when
+projects are inherited by new developers.
 
 * [the_problem](docs/the_problem.txt) - This outlines the problems with duck typing.
 
@@ -35,11 +35,11 @@ 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! 
+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. 
+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.
 
 The "has_method" method is used to specify which methods the contract expects to see. The
 following contract describes classes which respond to #length and #to_s
@@ -49,24 +49,24 @@ following contract describes classes which respond to #length and #to_s
       has_method :to_s
     end
 
-Once you've declared a contract, you can compare objects to it to see if the contract is 
+Once you've declared a contract, you can compare objects to it to see if the contract is
 fulfilled by the object:
 
-    MyContract.fulfills? "Hello"
+    MyContract.fulfilled_by? "Hello"
     => true
-    MyContract.fulfills? 12
+    MyContract.fulfilled_by? 12
     => false
 
-There is also a "bang" version of the #fulfills method, that raises an error instead 
+There is also a "bang" version of the #fulfilled_by method, that raises an error instead
 of returning false. The error message details why it got raised.
 
-    MyContract.fulfills! :foo 
+    MyContract.fulfilled_by! :foo
     => DuckPond::Contract::ContractInfringementError:
-       One or more clauses from MyContract were not fulfilled by :foo (Symbol) 
+       One or more clauses from MyContract were not fulfilled by :foo (Symbol)
        Expected subject to respond to method 'length'
 
 
-Contracts can be combined into composite "super contracts" - contracts which are made up of 
+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:
 
     class MyCompositeConrtact < DuckPond::Contract
@@ -75,7 +75,7 @@ various other contracts. This ties in with the reccomendation of preferring comp
     end
 
 Another feature of duckpond is the ability to specify what your expected result from a contract should be. For example,
-the following contract expects a subject to have a method called "even" and for that method, when called, to return a 
+the following contract expects a subject to have a method called "even" and for that method, when called, to return a
 true value:
 
     class MyEvenContract < DuckPond::Contract
@@ -83,7 +83,7 @@ true value:
     end
 
 If the method needs args, you can specify those too. This next contract will pass the string "Hell" to the #include? method,
-and expect the value to be true. This contract will therefore be satisfied by strings containing the word "Hell" that are 
+and expect the value to be true. This contract will therefore be satisfied by strings containing the word "Hell" that are
 five characters long (such as the word "Hello"):
 
     class MyHellContract < DuckPond::Contract
@@ -124,7 +124,7 @@ And then be implemented in a method like this:
 
     class Emailer
       def send(email)
-        IEmailable.fulfills! email
+        IEmailable.fulfilled_by! email
         email.send
       end
     end
@@ -137,7 +137,7 @@ CI tests exist for the following rubies, other versions are not supported but sh
   - 2.3.0
   - 2.2.4
   - 2.1.8
-  - jruby-19mode 
+  - jruby-19mode
 
 
 ## Contributing

data/docs/the_solution.txt

@@ -11,14 +11,14 @@ end
 # Then use it to check stuff!
 #
 
-ObjContract.fulfills? "Hello"
+ObjContract.fulfilled_by? "Hello"
 => true (or false if not fulfilled)
 
 #
 # The "bang" version will raise an error if the object isn't the duck.
 #
 
-ObjContract.fulfills! "Hello"
+ObjContract.fulfilled_by! "Hello"
 => true (or error if not fulfilled)
 
 #
@@ -27,7 +27,7 @@ ObjContract.fulfills! "Hello"
 
 class Foo
   def self.bar(obj)
-    ObjContract.fulfills! obj
+    ObjContract.fulfilled_by! obj
 
     obj.foo!
     fooinator = Test::Fooinator.new
@@ -39,7 +39,7 @@ end
 #
 # Viola!
 #
-# Final Tips: 
+# Final Tips:
 #
 # * Contracts should be commented liberally. They form the descripiton
 # of a contract just as interfaces would in strongly typed languages.

data/lib/duckpond/contract.rb

@@ -1,11 +1,11 @@
 require 'duckpond/contract/convinience_methods'
 require 'duckpond/contract/contract_infringement_error'
 
-# 
+#
 # DuckPond::Contract
 #
-# Contracts are essentially lists of properties that a class could have. 
-# They are not intended to ever be instantiated, and are completely 
+# Contracts are essentially lists of properties that a class could have.
+# They are not intended to ever be instantiated, and are completely
 # configured at the class level.
 #
 module DuckPond
@@ -56,26 +56,27 @@ module DuckPond
       end
 
       #
-      # fulfills?
+      # fulfilled_by?
       #
       # Returns true if this contract fulfills the passed-in object,
       # otherwise false.
       #
-      def fulfills?(obj)
+      def fulfilled_by?(obj)
         DuckPond::Inspection.new(obj).tap do |inspection|
           return inspection.fulfilled_by? self
         end
       end
 
-      alias_method :fulfilled_by?, :fulfills?
+      # For backward compatibility
+      alias_method :fulfills?, :fulfilled_by?
 
       #
-      # fulfills!
+      # fulfilled_by!
       #
       # Raises a ContractInfringementError unless this contract fulfills
       # the passed in object, otherwise returns true.
       #
-      def fulfills!(obj)
+      def fulfilled_by!(obj)
         DuckPond::Inspection.new(obj).tap do |inspection|
           unless inspection.fulfilled_by? self
             raise ContractInfringementError.new(self, obj, inspection)
@@ -85,7 +86,8 @@ module DuckPond
         end
       end
 
-      alias_method :fulfilled_by!, :fulfills!
+      # For backward compatibility
+      alias_method :fulfills!, :fulfilled_by!
 
     end
   end

data/lib/duckpond/version.rb

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

data/spec/clauses/method_clause/method_clause_usage_spec.rb

@@ -7,23 +7,23 @@ describe 'MethodClause usage' do
   #
   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
+      expect(SpecificLengthContract.fulfilled_by?("Hello")).to eq true
+      expect(SpecificLengthContract.fulfilled_by?("Yello")).to eq false
+      expect(SpecificLengthContract.fulfilled_by?("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
+      expect(SpecificLengthBehaviourContract.fulfilled_by?('Hello')).to eq true
+      expect(SpecificLengthBehaviourContract.fulfilled_by?('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  
+      expect(SpecificIncludeBehaviourContract.fulfilled_by?('Hello')).to eq true
+      expect(SpecificLengthBehaviourContract.fulfilled_by?('Goodbye')).to eq false
     end
   end
 

data/spec/contract_spec.rb

@@ -15,28 +15,28 @@ module DuckPond
     #
     # see spec/classes/length_contract.rb
     #
-    describe 'fulfills?' do
+    describe 'fulfilled_by?' do
       context 'when the object is fulfilled by the contract' do
         it 'returns true' do
-          expect(LengthContract.fulfills?("Hello")).to eq true
+          expect(LengthContract.fulfilled_by?("Hello")).to eq true
         end
       end
       context 'when the object is not fulfilled by the contract' do
         it 'returns false' do
-          expect(LengthContract.fulfills?(2)).to eq false
+          expect(LengthContract.fulfilled_by?(2)).to eq false
         end
       end
     end
 
-    describe 'fulfills!' do
+    describe 'fulfilled_by!' do
       context 'when the object is fulfilled by the contract' do
         it 'returns true' do
-          expect{LengthContract.fulfills!("Hello")}.to_not raise_error
+          expect{LengthContract.fulfilled_by!("Hello")}.to_not raise_error
         end
       end
       context 'when the object is not fulfilled by the contract' do
         it 'returns false' do
-         expect{LengthContract.fulfills!(2)}.to raise_error DuckPond::Contract::ContractInfringementError
+         expect{LengthContract.fulfilled_by!(2)}.to raise_error DuckPond::Contract::ContractInfringementError
         end
       end
     end
@@ -56,7 +56,7 @@ module DuckPond
   describe CompositeContract do
     it 'retains its parents quackings' do
       clauses = CompositeContract.clauses
-      expect(clauses.length).to eq 2 
+      expect(clauses.length).to eq 2
       clauses.map {|c|c.options[:method_name]}.tap do |method_names|
         expect(method_names).to include :length
         expect(method_names).to include :chunky_bacon

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckpond
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Mikey Hogarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Explicit duck-typing for ruby