duckpond 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b23a24b35895377f4668b651a7aaa75dcbd77054
-  data.tar.gz: 9be4575cb42cf0ffbb398cb78ecac73c178f3ba0
+  metadata.gz: ed77b024ca7fdcad68dff17391aeb0de607e7da9
+  data.tar.gz: e00d0cc54ecc3dea1b83eb7a75bcea3382b784bc
 SHA512:
-  metadata.gz: 37eb854f411be6a4480173f7a18fa94a0ef8886637f975714b1ec1ccad66cb9f6afbef019474a8ff4f269df7d41b28209afac03f947b14b4da4f7bcf3db495f5
-  data.tar.gz: c4a7d9df1277b9fad7083e1c5aa1e76e247891fa1311d366f2ba47082b9be5ef7d0bda5d6fe4af99a666458f3d0d6c05ef88dc8ad8b9f646f1e1dee8ae872cca
+  metadata.gz: f79bd621cd72f4e2ca362633e25c4433ea9ba3f1242dd69ae2410061035768bef3f2c8b38cf91fe924394f01ac6c4801e71fba1fb121bc6eff1504ddc972d75b
+  data.tar.gz: d214ef206b663b6d7b84b7cf05239d4f4105ff68d460934200e53f36e709952c70ba3cb4a1c2bbe2d8ab3f9de4e011665bfb2ed82bf407a27c20a29a531e46d6

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+
+script: bundle exec rspec spec

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in duckpond.gemspec
 gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -1,12 +1,25 @@
 PATH
   remote: .
   specs:
-    duckpond (1.0.0)
+    duckpond (1.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.2.5)
     rake (10.3.2)
+    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)
+      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)
 
 PLATFORMS
   ruby
@@ -15,3 +28,4 @@ DEPENDENCIES
   bundler (~> 1.3)
   duckpond!
   rake
+  rspec

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/duckpond.svg)](http://badge.fury.io/rb/duckpond)
+[![Build Status](https://travis-ci.org/mikeyhogarth/duckpond.svg?branch=master)](https://travis-ci.org/mikeyhogarth/duckpond)
+
 # Duckpond
 
 Explicit duck typing for ruby.
@@ -35,40 +38,63 @@ Or install it yourself as:
 
 ## Usage
 
-Usage is demonstrated in 'the_solution_spec', but in a nutshell you can create 
-"duck" classes by inheriting from DuckPond::Duck. This file should be commented
-extensively as it describes the contract the duck represents. 
+Usage is demonstrated in '[the_solution_spec](spec/the_solution_spec.rb)', but in a nutshell you can create 
+"contract" classes by inheriting from DuckPond::Contract. This file should be commented
+extensively as it describes the contract the duck represents. The "has_method" method
+can be used to specify methods as symbols. 
 
-    class MyDuck < DuckPond::Duck
-      quacks_like :length
+    class MyContract < DuckPond::Contract
+      has_method :length  
+      has_method :to_s
     end
 
-Once you've declared a duck, you can use "binoculars" to see if objects quack like
+Once you've declared a contract, you can use "binoculars" to see if objects quack like
 that duck:
 
     obj = "Hello World"
     sighting = DuckPond::Binoculars.identify(obj)
-    sighting.quacks_like? MyDuck
+    sighting.quacks_like? MyContract
     => true
 
 There are other syntaxes:
 
     #This syntax gets all the comparison done in one line
-    DuckPond::Binoculars.confirm(obj, MyDuck)
+    DuckPond::Binoculars.confirm(obj, MyContract)
     => true
 
     #This syntax does the same thing, but raises an excaption instead of returning false 
-    DuckPond::Binoculars.confirm!(obj, MyDuck)
+    DuckPond::Binoculars.confirm!(obj, MyContract)
 
 
-Ducks can be combined into composite "super ducks" - ducks which are made up of various other ducks:
+Ducks 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 MySuperDuck < DuckPond::Duck
-      quacks_like MyDuck
-      quacks_like MyOtherDuck
+    class MyCompositeConrtact < DuckPond::Contract
+      include_methods_from MyContract
+      include_methods_from MyOtherContract
     end
 
-the quacks_like method has been aliased to looks_like too - you can say something looks_like or quacks_like any item, whichever you prefer (in case you didn't want "quack" methods in your ever so serious project!).
+
+A *serious duck* might look like this:
+
+    class IEmailable < DuckPond::Contract
+      #send: should send the results of :message via email to :to
+      has_method :send
+
+      #to: Should be an email address to which this will be sent
+      has_method :to
+
+      #message: The message to send
+      has_method :message
+    end
+
+And then be implemented in a method like this:
+
+    class Emailer
+      def send(email)
+        DuckPond::Binoculars.confirm!(email, IEmailable)
+        email.send
+      end
+    end
 
 
 ## Contributing

data/lib/duckpond/binoculars.rb

@@ -8,7 +8,7 @@
 #
 module DuckPond
   class Binoculars
-    class WrongDuckError < TypeError;end
+    class ContractInfringementError < TypeError;end
 
     # The sighted object
     attr_reader :sighting
@@ -48,7 +48,7 @@ module DuckPond
     # does not quack like the duck.
     #
     def self.confirm!(obj, duck)
-      raise WrongDuckError unless confirm(obj, duck)
+      raise ContractInfringementError unless confirm(obj, duck)
     end
 
   end

data/lib/duckpond/contract.rb

@@ -0,0 +1,49 @@
+# 
+# DuckPond::Contract
+#
+# 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
+  class Contract
+    class << self
+
+      def clauses
+        @clauses ||= []
+      end
+
+      #
+      # has_method
+      #
+      # Adds a method expectation to the contract
+      #
+      def has_method(method_name)
+        clauses << method_name
+      end
+
+
+      #
+      # include_clauses_from
+      #
+      # Facilitates composition of multiple contracts
+      #
+      def include_clauses_from(other_contract)
+        other_contract.clauses.each do |other_contracts_quacking|
+          has_method other_contracts_quacking
+        end
+      end
+
+      
+      #
+      # quacks_like?
+      #
+      # The main quack checking method for a duck
+      #
+      def quacks_like?(method)
+        clauses.include?(method)
+      end
+
+    end
+  end
+end

data/lib/duckpond/sighting.rb

@@ -27,8 +27,8 @@ module DuckPond
     # by the duck's quacks.
     #
     def quacks_like?(duck)
-      duck.quacks.each do |quack|
-        return false unless @sighted_object.respond_to? quack
+      duck.clauses.each do |clause|
+        return false unless @sighted_object.respond_to? clause
       end
       true
     end

data/lib/duckpond/version.rb

@@ -1,3 +1,3 @@
 module Duckpond
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/duckpond.rb

@@ -1,5 +1,5 @@
 require 'duckpond/version'
-require 'duckpond/duck'
+require 'duckpond/contract'
 require 'duckpond/binoculars'
 require 'duckpond/sighting'
 

data/spec/binoculars_spec.rb

@@ -24,27 +24,27 @@ module DuckPond
 
     describe '.confirm' do
 
-      class StringDuck < Duck
-        quacks_like :to_s
-        quacks_like :length
+      class StringContract < Contract
+        has_method :to_s
+        has_method :length
       end
 
       context 'when given a ruby object and a duck class that it quacks like' do
         it 'returns true' do
-          expect(DuckPond::Binoculars.confirm("Hello World", StringDuck)).to be true
+          expect(DuckPond::Binoculars.confirm("Hello World", StringContract)).to be true
         end
       end
 
       context 'when given a ruby object and a duck class that it doesnt quacks like' do
         it 'returns false' do
-          expect(DuckPond::Binoculars.confirm(Object.new, StringDuck)).to be false
+          expect(DuckPond::Binoculars.confirm(Object.new, StringContract)).to be false
         end
       end
     end
 
     describe '.confirm!' do
       it 'behaves like the un-banged version, but raises an error if it doesnt quack right' do
-        expect {DuckPond::Binoculars.confirm!(Object.new, StringDuck)}.to raise_error
+        expect {DuckPond::Binoculars.confirm!(Object.new, StringContract)}.to raise_error
       end
     end
 

data/spec/duck_spec.rb

@@ -2,51 +2,51 @@ require 'spec_helper'
 
 module DuckPond
 
-  describe Duck do
+  describe Contract do
     describe 'attributes' do
-      context '.quackings' do
+      context '.clauses' do
         it 'responds to and memoizes the result' do
-          expect(Duck).to respond_to :quacks
-          expect(Duck.quacks).to be_an Array
-          expect(Duck.quacks).to be_empty
+          expect(Contract).to respond_to :clauses
+          expect(Contract.clauses).to be_an Array
+          expect(Contract.clauses).to be_empty
         end
       end
     end
   end
 
-  class MyDuck < Duck
-    quacks_like :foo
-    quacks_like :bar
+  class MyContract < Contract
+    has_method :foo
+    has_method :bar
   end
 
-  describe MyDuck do
-    context '.quackings' do
+  describe MyContract do
+    context '.clauses' do
       it 'quacks like foo and bar' do
-        quacks = MyDuck.quacks
-        expect(quacks.length).to eq 2
-        expect(quacks).to include :foo
-        expect(quacks).to include :bar
+        clauses = MyContract.clauses
+        expect(clauses.length).to eq 2
+        expect(clauses).to include :foo
+        expect(clauses).to include :bar
       end
     end
 
     describe '.quacks_like?' do
       it 'returns true if the argument is in the quackings' do
-        expect(MyDuck.quacks_like? :foo).to be true
-        expect(MyDuck.quacks_like? :chunky_bacon).to be false
+        expect(MyContract.quacks_like? :foo).to be true
+        expect(MyContract.quacks_like? :chunky_bacon).to be false
       end
     end
   end
 
-  class MySimilarDuck < Duck
-    quacks_like MyDuck
-    quacks_like :chunky_bacon
+  class MySimilarContract < Contract
+    include_clauses_from MyContract
+    has_method :chunky_bacon
   end
 
-  describe MySimilarDuck do
+  describe MySimilarContract do
     it 'retains its parents quackings' do
-      expect(MySimilarDuck.quacks_like? :chunky_bacon).to be true
-      expect(MySimilarDuck.quacks_like? :foo).to be true
-      expect(MySimilarDuck.quacks_like? :bar).to be true
+      expect(MySimilarContract.quacks_like? :chunky_bacon).to be true
+      expect(MySimilarContract.quacks_like? :foo).to be true
+      expect(MySimilarContract.quacks_like? :bar).to be true
     end
   end
 

data/spec/sighting_spec.rb

@@ -13,15 +13,15 @@ module DuckPond
 
     describe '#quacks_like?' do
 
-      class MyChunkyBaconDuck < Duck
-        quacks_like :chunky_bacon
+      class MyChunkyBaconContract < Contract
+        has_method :chunky_bacon
       end
 
       context 'when the sighted object quacks like the duck' do
         it 'returns true' do
           obj = OpenStruct.new(:chunky_bacon => :mmm)
           sighting = Sighting.new(obj)
-          expect(sighting.quacks_like? MyChunkyBaconDuck).to be true
+          expect(sighting.quacks_like? MyChunkyBaconContract).to be true
         end
       end
 
@@ -29,7 +29,7 @@ module DuckPond
         it 'returns false' do
           obj = OpenStruct.new(:vegan_fallafal => :yuck)
           sighting = Sighting.new(obj)
-          expect(sighting.quacks_like? MyChunkyBaconDuck).to be false
+          expect(sighting.quacks_like? MyChunkyBaconContract).to be false
         end
       end
 

data/spec/the_solution_spec.rb

@@ -9,9 +9,9 @@ module DuckPond
         # First, declare a duck.
         #
 
-        class ObjDuck < DuckPond::Duck
-          quacks_like :to_s
-          quacks_like :length
+        class ObjContract < DuckPond::Contract
+          has_method :to_s
+          has_method :length
         end
 
         #
@@ -36,7 +36,7 @@ module DuckPond
         # And now you can compare your sightings with your ducks!
         #
 
-        result = sighting.quacks_like?(ObjDuck)
+        result = sighting.quacks_like?(ObjContract)
         expect(result).to be true
 
         #
@@ -45,7 +45,7 @@ module DuckPond
 
         binoculars = DuckPond::Binoculars.new
         sighting = binoculars.identify(obj)
-        raise TypeError unless sighting.quacks_like?(ObjDuck)
+        raise TypeError unless sighting.quacks_like?(ObjContract)
        
         #
         # But because this trio of lines are so common, a
@@ -53,14 +53,14 @@ module DuckPond
         # once:
         #
 
-        result = DuckPond::Binoculars.confirm(obj, ObjDuck)
+        result = DuckPond::Binoculars.confirm(obj, ObjContract)
         expect(result).to be true
 
         #
         # The "bang" version will raise an error if the object isn't the duck.
         #
         
-        expect { DuckPond::Binoculars.confirm!(Object.new, ObjDuck) }.to raise_error TypeError
+        expect { DuckPond::Binoculars.confirm!(Object.new, ObjContract) }.to raise_error TypeError
 
 
         #
@@ -69,7 +69,7 @@ module DuckPond
         
         class Foo
           def self.bar(obj)
-            DuckPond::Binoculars.confirm!(obj,ObjDuck) 
+            DuckPond::Binoculars.confirm!(obj,ObjConrtact) 
 
             obj.foo!
             fooinator = Test::Fooinator.new
@@ -83,7 +83,7 @@ module DuckPond
         #
         # Final Tips: 
         #
-        # * Ducks should be commented liberally. They form the descripiton
+        # * Contracts should be commented liberally. They form the descripiton
         # of a contract just as interfaces would in strongly typed languages.
         # Developers will be prompted to consult the duck when they see a pair
         # of binoculars in your code, so make sure they find what they're looking

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckpond
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mikey Hogarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -54,7 +56,7 @@ files:
 - duckpond.gemspec
 - lib/duckpond.rb
 - lib/duckpond/binoculars.rb
-- lib/duckpond/duck.rb
+- lib/duckpond/contract.rb
 - lib/duckpond/sighting.rb
 - lib/duckpond/version.rb
 - spec/binoculars_spec.rb
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Explicit duck-typing for ruby
@@ -96,4 +98,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/the_problem_spec.rb
 - spec/the_solution_spec.rb
-has_rdoc: 

data/lib/duckpond/duck.rb

@@ -1,56 +0,0 @@
-# 
-# DuckPond::Duck
-#
-# Ducks are essentially "contracts" or "interfaces". They are not intended
-# to ever be instantiated, and are completely configured at the class level.
-#
-module DuckPond
-  class Duck
-    class << self
-
-      def quacks
-        @quacks ||= []
-      end
-      
-      #
-      # quacks_like
-      #
-      # Use this to specify that this duck quacks with
-      # a certain method, or quacks like another duck.
-      #
-      def quacks_like(item)
-        if item.is_a? Symbol
-          quacks << item
-        elsif item.ancestors.include? DuckPond::Duck
-          add_quacks_from item
-        else
-          raise TypeError
-        end
-      end
-      alias :looks_like :quacks_like
-
-      #
-      # quacks_like?
-      #
-      # The main quack checking method for a duck
-      #
-      def quacks_like?(method)
-        quacks.include?(method)
-      end
-      alias :looks_like? :quacks_like
-
-      private
-      #
-      # add_quacks_from
-      #
-      # add the quacks from another duck
-      #
-      def add_quacks_from(other_duck)
-        other_duck.quacks.each do |other_ducks_quacking|
-          quacks_like other_ducks_quacking
-        end
-      end
-
-    end
-  end
-end