rspec-contracts 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce4b2a2faf48c3f9f368745eed2e0a33243fe872
-  data.tar.gz: 8f01e23a2eed146f5bbe6407cd44fbaa51700cb8
+  metadata.gz: 87b15ff10f754beb89ee5b1d4243b8aea51ca5c3
+  data.tar.gz: b28190904c6dc5fd3c909ee73cdbb7c9dd4df3ac
 SHA512:
-  metadata.gz: dbd6c1a8c64c9fcd1778ae4596abab1ed6f4d1e8d8015f376b6598ad6eb6ccf2670cb534e24c5149853886ca47620ac8f05964312f65f32e95fe5ed4d5dbf880
-  data.tar.gz: bad52385149dc5c04ca685fe0551ab9414ec17db7dbbb54faa42330e3d0ccdf9043fe32ebc4e5bc16227abe722874712178e2effbf85d4ec380c83c62e7cca8d
+  metadata.gz: 27e3827e0404171952cdc793c8032caf74182e1621b2ad932c1d33cbf116ab63fd4ea8fcbbb4bde6bc8493f08c4ce4b9912341a02780b6d8e1eb2cb79cefe738
+  data.tar.gz: f3f091d6f3f01819b6122727b678992068ef2304f59e7036777ef4ce49200d43c9352ce106a9b95e12d5c8b0e71da657037da8ba921aece444f346db428246ec

data/History.md

@@ -1,3 +1,8 @@
+### Version 0.0.2
+2014-3-15
+
+* Verify contracts by observing arguments and return values
+
 ### Version 0.0.1
 2014-3-4
 

data/README.md

@@ -1,6 +1,9 @@
-## Conjure
+## rspec-contracts
+[![Gem Version](https://badge.fury.io/rb/rspec-contracts.png)](http://badge.fury.io/rb/rspec-contracts)
+[![Build Status](https://travis-ci.org/brianauton/rspec-contracts.png?branch=master)](https://travis-ci.org/brianauton/rspec-contracts)
+[![Code Climate](https://codeclimate.com/github/brianauton/rspec-contracts.png)](https://codeclimate.com/github/brianauton/rspec-contracts)
 
-Automatic contract checking for your RSpec suite
+Automatic contract verification for your RSpec suite
 
 ### Requirements
 

data/lib/rspec/contracts/core_syntax.rb

@@ -1,12 +1,14 @@
-require "rspec/core/example_group"
+require "rspec/core"
+require "rspec/contracts/interface"
 require "rspec/contracts/interface_proxy"
 
 module RSpec
   module Core
     class ExampleGroup
       def self.fulfill_contract(*interface_names)
-        interface_names.each do |interface_name|
-          Contracts::InterfaceProxy.create interface_name, described_class
+        interface_names.each do |name|
+          interface = Contracts::Interface.find_or_create name
+          Contracts::InterfaceProxy.create interface, described_class
         end
       end
     end

data/lib/rspec/contracts/double.rb

@@ -1,5 +1,6 @@
-require "rspec/mocks/test_double"
-require "rspec/contracts/proxy"
+require "rspec/mocks"
+require "rspec/contracts/interface"
+require "rspec/contracts/mock_proxy"
 
 module RSpec
   module Contracts
@@ -7,12 +8,12 @@ module RSpec
       include Mocks::TestDouble
 
       def initialize(interface_name, *args)
-        @interface_name = interface_name
-        __initialize_as_test_double interface_name, *args
+        @interface = Interface.find_or_create interface_name
+        super
       end
 
       def __build_mock_proxy(order_group)
-        Proxy.new self, order_group, @interface_name
+        MockProxy.new self, order_group, @interface
       end
     end
   end

data/lib/rspec/contracts/fulfillment.rb

@@ -1,23 +1,31 @@
-require "rspec/contracts/requirement"
-require "rspec/contracts/requirement_view"
+require "rspec/contracts/interface_fulfillment"
 
 module RSpec
   module Contracts
     class Fulfillment
-      def initialize(requirement_group)
-        @requirement_group = requirement_group
+      attr_reader :interface_fulfillments
+
+      def initialize(interfaces, implementors)
+        @implementors = implementors
+        @interface_fulfillments = interfaces.map do |interface|
+          InterfaceFulfillment.new interface, implementors_for(interface)
+        end
       end
 
       def complete?
-        false
+        incomplete_interfaces.empty?
+      end
+
+      def incomplete_interfaces
+        interface_fulfillments.reject(&:complete?)
       end
 
-      def unfulfilled_requirements
-        @requirement_group.requirements
+      def messages_count
+        interface_fulfillments.map(&:messages_count).inject(&:+) || 0
       end
 
-      def requirements_count
-        @requirement_group.requirements.count
+      def implementors_for(interface)
+        @implementors.select{ |i| i.interface_names.include? interface.name }
       end
     end
   end

data/lib/rspec/contracts/fulfillment_view.rb

@@ -1,3 +1,5 @@
+require "rspec/contracts/message_view"
+
 module RSpec
   module Contracts
     class FulfillmentView
@@ -6,27 +8,25 @@ module RSpec
       end
 
       def render
-        @fulfillment.complete? ? render_complete : render_incomplete
-      end
-
-      def render_complete
-        "#{contracts_count} verified."
+        ([summary] + unfulfilled_views).join "\n"
       end
 
-      def render_incomplete
-        lines = unfulfilled_views
-        lines.unshift("WARNING: #{unfulfilled_views.count} of #{contracts_count} unverified.")
-        lines.join "\n"
+      def summary
+        unverified = unfulfilled_views.count
+        verified = @fulfillment.messages_count - unverified
+        "#{contracts_count}, #{verified} verified, #{unverified} unverified"
       end
 
       def unfulfilled_views
-        @fulfillment.unfulfilled_requirements.map do |requirement|
-          RSpec::Contracts::RequirementView.new(requirement).render
-        end
+        @fulfillment.incomplete_interfaces.map do |fulfillment|
+          fulfillment.unfulfilled_messages.map do |message|
+            RSpec::Contracts::MessageView.new(fulfillment.interface.name, message).render
+          end
+        end.flatten
       end
 
       def contracts_count
-        pluralize @fulfillment.requirements_count, "contract"
+        pluralize @fulfillment.messages_count, "contract"
       end
 
       def pluralize(number, noun)

data/lib/rspec/contracts/implementor.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Contracts
+    class Implementor
+      attr_reader :interface_names, :messages
+
+      def initialize
+        @interface_names = []
+        @messages = []
+      end
+
+      def add_message(message)
+        messages << message
+      end
+
+      def self.collection
+        @collection ||= {}
+      end
+
+      def self.all
+        collection.values
+      end
+
+      def self.find_or_create(subject)
+        collection[subject] ||= new
+      end
+    end
+  end
+end

data/lib/rspec/contracts/interface.rb

@@ -0,0 +1,30 @@
+require "rspec/contracts/interface_group"
+
+module RSpec
+  module Contracts
+    class Interface
+      attr_reader :name, :messages
+
+      def initialize(name)
+        @name = name
+        @messages = []
+      end
+
+      def add_message(message)
+        @messages << message
+      end
+
+      def self.all
+        @all ||= InterfaceGroup.new
+      end
+
+      def self.find_or_create(name)
+        all.find_or_create name
+      end
+
+      def unique_messages
+        messages.uniq(&:to_hash)
+      end
+    end
+  end
+end

data/lib/rspec/contracts/interface_fulfillment.rb

@@ -0,0 +1,34 @@
+module RSpec
+  module Contracts
+    class InterfaceFulfillment
+      attr_reader :interface
+
+      def initialize(interface, implementors)
+        @interface = interface
+        @implementors = implementors
+      end
+
+      def complete?
+        unfulfilled_messages.empty?
+      end
+
+      def unfulfilled_messages
+        interface.unique_messages.reject{ |r| fulfilled_by_all? r }
+      end
+
+      def messages_count
+        interface.unique_messages.count
+      end
+
+      private
+
+      def fulfilled_by_all?(message)
+        @implementors.all?{ |i| fulfilled_by? message, i }
+      end
+
+      def fulfilled_by?(message, implementor)
+        implementor.messages.any? { |m| message.fully_described_by? m }
+      end
+    end
+  end
+end

data/lib/rspec/contracts/interface_group.rb

@@ -0,0 +1,21 @@
+require "rspec/contracts/interface"
+
+module RSpec
+  module Contracts
+    class InterfaceGroup
+      include Enumerable
+
+      def initialize
+        @collection = {}
+      end
+
+      def find_or_create(name)
+        @collection[name] ||= Interface.new(name)
+      end
+
+      def each(&block)
+        @collection.values.each(&block)
+      end
+    end
+  end
+end

data/lib/rspec/contracts/interface_proxy.rb

@@ -1,11 +1,14 @@
+require "rspec/contracts/implementor"
 require "rspec/contracts/method_proxy"
 
 module RSpec
   module Contracts
     class InterfaceProxy
-      def initialize(interface_name, proxied_class)
+      def initialize(interface, proxied_class)
+        @implementor = Implementor.find_or_create proxied_class
+        @implementor.interface_names << interface.name
         proxied_class.instance_methods.select{|m| proxyable_method? m}.each do |method_name|
-          MethodProxy.create interface_name, proxied_class, method_name
+          MethodProxy.create @implementor, proxied_class, method_name
         end
       end
 

data/lib/rspec/contracts/message.rb

@@ -0,0 +1,30 @@
+module RSpec
+  module Contracts
+    class Message
+      attr_reader :method_name
+      attr_accessor :specifications
+
+      def initialize(method_name, specifications = {})
+        @method_name = method_name
+        @specifications = specifications
+      end
+
+      def fully_described_by?(message)
+        return false if message.method_name != method_name
+        @specifications.each do |name, specification|
+          unless specification.fully_described_by? message.specifications[name]
+            return false
+          end
+        end
+        true
+      end
+
+      def to_hash
+        {
+          :method_name => method_name,
+          :specifications => specifications.values.map(&:to_hash),
+        }
+      end
+    end
+  end
+end

data/lib/rspec/contracts/message_arguments.rb

@@ -0,0 +1,19 @@
+module RSpec
+  module Contracts
+    class MessageArguments
+      attr_reader :arguments
+
+      def initialize(arguments)
+        @arguments = arguments
+      end
+
+      def fully_described_by?(other)
+        other && (arguments == other.arguments)
+      end
+
+      def to_hash
+        {:arguments => arguments}
+      end
+    end
+  end
+end

data/lib/rspec/contracts/message_return.rb

@@ -0,0 +1,19 @@
+module RSpec
+  module Contracts
+    class MessageReturn
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def fully_described_by?(other)
+        other && (value == other.value)
+      end
+
+      def to_hash
+        {:value => value}
+      end
+    end
+  end
+end

data/lib/rspec/contracts/message_view.rb

@@ -0,0 +1,16 @@
+module RSpec
+  module Contracts
+    class MessageView
+      def initialize(interface_name, message)
+        @interface_name = interface_name
+        @message = message
+      end
+
+      def render
+        arg_string = @message.specifications[:arguments] ? "()" : ""
+        return_string = @message.specifications[:return_value] ? "and return #{@message.specifications[:return_value].value.inspect}" : ""
+        "Interface '#{@interface_name}' must respond to '#{@message.method_name}#{arg_string}' #{return_string}"
+      end
+    end
+  end
+end

data/lib/rspec/contracts/method_proxy.rb

@@ -1,3 +1,6 @@
+require "rspec/contracts/message"
+require "rspec/contracts/message_arguments"
+
 module RSpec
   module Contracts
     class MethodProxy
@@ -5,10 +8,16 @@ module RSpec
         new(*args)
       end
 
+      def add_message(options)
+        message = Message.new(@method_name, options)
+        @implementor.add_message message
+        message
+      end
+
       private
 
-      def initialize(interface_name, proxied_class, method_name)
-        @interface_name = interface_name
+      def initialize(implementor, proxied_class, method_name)
+        @implementor = implementor
         @proxied_class = proxied_class
         @method_name = method_name
         install
@@ -16,8 +25,12 @@ module RSpec
 
       def install
         original_method = @proxied_class.instance_method @method_name
+        method_proxy = self
         @proxied_class.send :define_method, @method_name do |*args|
-          original_method.bind(self).call(*args)
+          message = method_proxy.add_message :arguments => MessageArguments.new(args)
+          return_value = original_method.bind(self).call(*args)
+          message.specifications[:return_value] = MessageReturn.new(return_value)
+          return_value
         end
       end
     end

data/lib/rspec/contracts/mock_proxy.rb

@@ -0,0 +1,51 @@
+require "rspec/mocks"
+require "rspec/contracts/message"
+require "rspec/contracts/message_return"
+
+module RSpec
+  module Contracts
+    class MockProxy < Mocks::Proxy
+      def initialize(object, order_group, interface)
+        super(object, order_group)
+        @method_doubles = Hash.new do |h, k|
+          h[k] = ContractMethodDouble.new(interface, object, k, self)
+        end
+      end
+    end
+
+    class ContractMethodDouble < Mocks::MethodDouble
+      attr_reader :message
+
+      def initialize(interface, object, method_name, proxy)
+        @message = Message.new method_name
+        interface.add_message @message
+        super(object, method_name, proxy)
+      end
+
+      def add_simple_stub(method_name, return_value)
+        @message.specifications[:return_value] = MessageReturn.new(return_value)
+        super
+      end
+
+      def message_expectation_class
+        ContractMessageExpectation
+      end
+    end
+
+    class ContractMessageExpectation < Mocks::MessageExpectation
+      def contract_message
+        @method_double.message
+      end
+
+      def with(*args)
+        contract_message.specifications[:arguments] = MessageArguments.new(args)
+        super
+      end
+
+      def and_return(*args)
+        contract_message.specifications[:return_value] = MessageReturn.new(args.first)
+        super
+      end
+    end
+  end
+end

data/lib/rspec/contracts/mocks_syntax.rb

@@ -1,3 +1,4 @@
+require "rspec/mocks"
 require "rspec/contracts/double"
 
 module RSpec

data/lib/rspec/contracts/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Contracts
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/rspec/contracts.rb

@@ -2,13 +2,15 @@ require "rspec/contracts/core_syntax"
 require "rspec/contracts/mocks_syntax"
 require "rspec/contracts/fulfillment"
 require "rspec/contracts/fulfillment_view"
-require "rspec/contracts/requirement"
+require "rspec/contracts/implementor"
+require "rspec/contracts/interface"
 require "rspec/core"
 
 RSpec.configure do |c|
   c.after(:suite) do
-    requirement_group = RSpec::Contracts::Requirement.group
-    fulfillment = RSpec::Contracts::Fulfillment.new requirement_group
+    interfaces = RSpec::Contracts::Interface.all
+    implementors = RSpec::Contracts::Implementor.all
+    fulfillment = RSpec::Contracts::Fulfillment.new interfaces, implementors
     print "\n" + RSpec::Contracts::FulfillmentView.new(fulfillment).render
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-contracts
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brian Auton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -28,28 +28,28 @@ dependencies:
   name: guard-rspec
   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'
 - !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: 
@@ -67,13 +67,18 @@ files:
 - lib/rspec/contracts/double.rb
 - lib/rspec/contracts/fulfillment.rb
 - lib/rspec/contracts/fulfillment_view.rb
+- lib/rspec/contracts/implementor.rb
+- lib/rspec/contracts/interface.rb
+- lib/rspec/contracts/interface_fulfillment.rb
+- lib/rspec/contracts/interface_group.rb
 - lib/rspec/contracts/interface_proxy.rb
+- lib/rspec/contracts/message.rb
+- lib/rspec/contracts/message_arguments.rb
+- lib/rspec/contracts/message_return.rb
+- lib/rspec/contracts/message_view.rb
 - lib/rspec/contracts/method_proxy.rb
+- lib/rspec/contracts/mock_proxy.rb
 - lib/rspec/contracts/mocks_syntax.rb
-- lib/rspec/contracts/proxy.rb
-- lib/rspec/contracts/requirement.rb
-- lib/rspec/contracts/requirement_group.rb
-- lib/rspec/contracts/requirement_view.rb
 - lib/rspec/contracts/version.rb
 homepage: http://github.com/brianauton/rspec-contracts
 licenses:

data/lib/rspec/contracts/proxy.rb

@@ -1,32 +0,0 @@
-require "rspec/mocks/proxy"
-require "rspec/contracts/requirement"
-
-module RSpec
-  module Contracts
-    class Proxy < Mocks::Proxy
-      def initialize(object, order_group, interface_name)
-        @interface_name = interface_name
-        super(object, order_group)
-      end
-
-      def add_stub(location, method_name, opts={}, &implementation)
-        create_requirement method_name
-        super
-      end
-
-      def add_simple_stub(method_name, *args)
-        create_requirement method_name, :return_value => args.first
-        super
-      end
-
-      def add_message_expectation(location, method_name, opts={}, &block)
-        create_requirement method_name
-        super
-      end
-
-      def create_requirement(method_name, options = {})
-        Requirement.create @interface_name, method_name, options
-      end
-    end
-  end
-end

data/lib/rspec/contracts/requirement.rb

@@ -1,31 +0,0 @@
-require "rspec/contracts/requirement_group"
-require "rspec/contracts/requirement_view"
-
-module RSpec
-  module Contracts
-    class Requirement
-      attr_reader :interface_name, :method_name, :arguments, :return_value
-
-      def initialize(interface_name, method_name, options = {})
-        @interface_name = interface_name
-        @method_name = method_name
-        @arguments = options[:arguments]
-        @return_value = options[:return_value]
-      end
-
-      def self.group
-        @group ||= RequirementGroup.new
-      end
-
-      def self.create(*args)
-        group.add new(*args)
-      end
-
-      def matches?(requirement)
-        [:interface_name, :method_name, :arguments, :return_value].select do |attribute|
-          requirement.send(attribute) != send(attribute)
-        end.empty?
-      end
-    end
-  end
-end

data/lib/rspec/contracts/requirement_group.rb

@@ -1,19 +0,0 @@
-module RSpec
-  module Contracts
-    class RequirementGroup
-      attr_accessor :requirements
-
-      def initialize
-        @requirements = []
-      end
-
-      def exists?(requirement)
-        @requirements.any?{|r| r.matches? requirement}
-      end
-
-      def add(requirement)
-        requirements << requirement unless exists? requirement
-      end
-    end
-  end
-end

data/lib/rspec/contracts/requirement_view.rb

@@ -1,15 +0,0 @@
-module RSpec
-  module Contracts
-    class RequirementView
-      def initialize(requirement)
-        @requirement = requirement
-      end
-
-      def render
-        arg_string = @requirement.arguments ? "()" : ""
-        return_string = @requirement.return_value ? "and return #{@requirement.return_value.inspect}" : ""
-        "Interface '#{@requirement.interface_name}' must respond to '#{@requirement.method_name}#{arg_string}' #{return_string}"
-      end
-    end
-  end
-end