rspec-contracts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce4b2a2faf48c3f9f368745eed2e0a33243fe872
+  data.tar.gz: 8f01e23a2eed146f5bbe6407cd44fbaa51700cb8
+SHA512:
+  metadata.gz: dbd6c1a8c64c9fcd1778ae4596abab1ed6f4d1e8d8015f376b6598ad6eb6ccf2670cb534e24c5149853886ca47620ac8f05964312f65f32e95fe5ed4d5dbf880
+  data.tar.gz: bad52385149dc5c04ca685fe0551ab9414ec17db7dbbb54faa42330e3d0ccdf9043fe32ebc4e5bc16227abe722874712178e2effbf85d4ec380c83c62e7cca8d

data/History.md

@@ -0,0 +1,4 @@
+### Version 0.0.1
+2014-3-4
+
+* Show summary of unverified contracts after specs run

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Brian Auton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+## Conjure
+
+Automatic contract checking for your RSpec suite
+
+### Requirements
+
+  * Rspec 3.0.0.beta2
+
+### Getting Started
+
+Install the rspec-contracts gem alongside rspec in your gemfile.
+
+    group :development, :test do
+      gem "rspec", "3.0.0.beta2"
+      gem "rspec-contracts"
+    end
+
+Then update your bundle.
+
+    $ bundle
+
+Define doubles using `contract_double`, providing the contract name as
+the first argument.
+
+    user = contract_double(:user, email: "me@example.com")
+
+Running the specs will then show a summary of unverified contracts.
+
+    $ rspec

data/lib/rspec/contracts/core_syntax.rb

@@ -0,0 +1,14 @@
+require "rspec/core/example_group"
+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
+        end
+      end
+    end
+  end
+end

data/lib/rspec/contracts/double.rb

@@ -0,0 +1,19 @@
+require "rspec/mocks/test_double"
+require "rspec/contracts/proxy"
+
+module RSpec
+  module Contracts
+    class Double
+      include Mocks::TestDouble
+
+      def initialize(interface_name, *args)
+        @interface_name = interface_name
+        __initialize_as_test_double interface_name, *args
+      end
+
+      def __build_mock_proxy(order_group)
+        Proxy.new self, order_group, @interface_name
+      end
+    end
+  end
+end

data/lib/rspec/contracts/fulfillment.rb

@@ -0,0 +1,24 @@
+require "rspec/contracts/requirement"
+require "rspec/contracts/requirement_view"
+
+module RSpec
+  module Contracts
+    class Fulfillment
+      def initialize(requirement_group)
+        @requirement_group = requirement_group
+      end
+
+      def complete?
+        false
+      end
+
+      def unfulfilled_requirements
+        @requirement_group.requirements
+      end
+
+      def requirements_count
+        @requirement_group.requirements.count
+      end
+    end
+  end
+end

data/lib/rspec/contracts/fulfillment_view.rb

@@ -0,0 +1,38 @@
+module RSpec
+  module Contracts
+    class FulfillmentView
+      def initialize(fulfillment)
+        @fulfillment = fulfillment
+      end
+
+      def render
+        @fulfillment.complete? ? render_complete : render_incomplete
+      end
+
+      def render_complete
+        "#{contracts_count} verified."
+      end
+
+      def render_incomplete
+        lines = unfulfilled_views
+        lines.unshift("WARNING: #{unfulfilled_views.count} of #{contracts_count} unverified.")
+        lines.join "\n"
+      end
+
+      def unfulfilled_views
+        @fulfillment.unfulfilled_requirements.map do |requirement|
+          RSpec::Contracts::RequirementView.new(requirement).render
+        end
+      end
+
+      def contracts_count
+        pluralize @fulfillment.requirements_count, "contract"
+      end
+
+      def pluralize(number, noun)
+        suffix = (number == 1) ? "" : "s"
+        "#{number} #{noun}#{suffix}"
+      end
+    end
+  end
+end

data/lib/rspec/contracts/interface_proxy.rb

@@ -0,0 +1,21 @@
+require "rspec/contracts/method_proxy"
+
+module RSpec
+  module Contracts
+    class InterfaceProxy
+      def initialize(interface_name, proxied_class)
+        proxied_class.instance_methods.select{|m| proxyable_method? m}.each do |method_name|
+          MethodProxy.create interface_name, proxied_class, method_name
+        end
+      end
+
+      def proxyable_method?(method_name)
+        true
+      end
+
+      def self.create(*args)
+        new(*args)
+      end
+    end
+  end
+end

data/lib/rspec/contracts/method_proxy.rb

@@ -0,0 +1,25 @@
+module RSpec
+  module Contracts
+    class MethodProxy
+      def self.create(*args)
+        new(*args)
+      end
+
+      private
+
+      def initialize(interface_name, proxied_class, method_name)
+        @interface_name = interface_name
+        @proxied_class = proxied_class
+        @method_name = method_name
+        install
+      end
+
+      def install
+        original_method = @proxied_class.instance_method @method_name
+        @proxied_class.send :define_method, @method_name do |*args|
+          original_method.bind(self).call(*args)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/contracts/mocks_syntax.rb

@@ -0,0 +1,11 @@
+require "rspec/contracts/double"
+
+module RSpec
+  module Mocks
+    module ExampleMethods
+      def contract_double(*args)
+        ExampleMethods.declare_double Contracts::Double, *args
+      end
+    end
+  end
+end

data/lib/rspec/contracts/proxy.rb

@@ -0,0 +1,32 @@
+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

@@ -0,0 +1,31 @@
+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

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,15 @@
+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

data/lib/rspec/contracts/version.rb

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

data/lib/rspec/contracts.rb

@@ -0,0 +1,14 @@
+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/core"
+
+RSpec.configure do |c|
+  c.after(:suite) do
+    requirement_group = RSpec::Contracts::Requirement.group
+    fulfillment = RSpec::Contracts::Fulfillment.new requirement_group
+    print "\n" + RSpec::Contracts::FulfillmentView.new(fulfillment).render
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rspec-contracts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Auton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  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: 
+email:
+- brianauton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- History.md
+- License.txt
+- README.md
+- lib/rspec/contracts.rb
+- lib/rspec/contracts/core_syntax.rb
+- lib/rspec/contracts/double.rb
+- lib/rspec/contracts/fulfillment.rb
+- lib/rspec/contracts/fulfillment_view.rb
+- lib/rspec/contracts/interface_proxy.rb
+- lib/rspec/contracts/method_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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Automatic contract checking for your RSpec suite
+test_files: []