duckface-interfaces 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30396b46a38049271ab9ed210b927668e994da99
-  data.tar.gz: 56d6a155fde25658a4e7cb1a735b0d74a6efbce2
+  metadata.gz: 00d6fb73ecee350b171fbcee1cc119d9dd9323cb
+  data.tar.gz: a17598b3ebbc212ca731e8d30f57e4caa9a10ebc
 SHA512:
-  metadata.gz: 296f5f84390d8f29802e599678e7cd094e68dd0dd405deb91e0e081d526082ce0fa1be9b250530bdfb21d581056ab6455d1206d1686200f30982d7064a2102cd
-  data.tar.gz: 87bcbc634568b6dd6d4764be504f55752541fb6432d29d0aa6886a1540eac79fa30973954d10b979d7a6a71e2029122a89fafb519c68040c2acb8cdaeab99946
+  metadata.gz: 1e9b94fe6673a539bfa4d487133e67b9c2bfe7eaaf2382f300b9a2d2791f7b10716503f785662cb79b6986495b1acfa2b6cdf62adbd601c0a55dce8df7b0c1fe
+  data.tar.gz: c554f1d3674e99bee366f1dd476d6434eb7801f6ac3a1a5fb3f51ed2ed03fff488605382f3115527ae012ecef9cc59cae036305b89b34b195a83f824052deebe

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.0.3
+
+  * `Class.check_it_implements` now returns a `CheckSession`.
+  * RSpec shared example takes advantage of `CheckSession` to be able to present a list of reasons why your implementation sucks.
+
 0.0.2
 
   * Add `Class.says_it_implements?` for quickly checking whether a class says it is implementing a given interface. This doesn't perform the full method/params checking that happens on `.check_it_implements`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    duckface-interfaces (0.0.1)
+    duckface-interfaces (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -166,4 +166,4 @@ DEPENDENCIES
   spring-watcher-listen
 
 BUNDLED WITH
-   1.16.1
+   1.16.4

data/README.md

@@ -75,3 +75,14 @@ describe MyImplementation
   it_behaves_like 'it implements', MyInterface
 end
 ```
+
+If it fails you'll get messages pointing out where you've gone wrong:
+```ruby
+Failures:
+
+  1) MyImplementation behaves like it implements MyInterface correctly  
+     Failure/Error: expect(check_session.successful?).to be(true), formatted_message(check_session)
+
+       expected to correctly implement MyInterface:
+        - say_my_name is not present
+```

data/lib/duckface/check_session.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Duckface
+  class CheckSession
+    def initialize
+      @methods_not_implemented = []
+      @methods_with_incorrect_signatures = []
+    end
+
+    attr_reader :methods_not_implemented,
+                :methods_with_incorrect_signatures
+
+    def notice_not_implemented_method(method_name)
+      @methods_not_implemented << method_name
+    end
+
+    def notice_method_with_incorrect_signature(method_name)
+      @methods_with_incorrect_signatures << method_name
+    end
+
+    def successful?
+      @methods_not_implemented.empty? && @methods_with_incorrect_signatures.empty?
+    end
+
+    def null?
+      false
+    end
+
+    alias correctly successful?
+  end
+end

data/lib/duckface/null_check_session.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Duckface
+  class NullCheckSession
+    def methods_not_implemented
+      []
+    end
+
+    def methods_with_incorrect_signatures
+      []
+    end
+
+    def successful?
+      false
+    end
+
+    def null?
+      true
+    end
+
+    alias correctly successful?
+  end
+end

data/lib/duckface/object_sugar.rb

@@ -2,12 +2,13 @@
 
 require 'duckface/services/check_class_implements_interface'
 require 'duckface/implementation_methods'
+require 'duckface/null_check_session'
 
 module Duckface
   # Provides methods on any class to indicate usage of interfaces
   module ObjectSugar
     def check_it_implements(_interface_class)
-      false
+      NullCheckSession.new
     end
 
     def says_it_implements?(_interface_class)

data/lib/duckface/rspec.rb

@@ -1,9 +1,56 @@
 # frozen_string_literal: true
 
+module Duckface
+  module RSpec
+    class CheckSessionFailureFormatter
+      def initialize(check_session)
+        @check_session = check_session
+      end
+
+      def message
+        return ' but it does not implement any interfaces' if @check_session.null?
+
+        ":\n#{formatted_lines}"
+      end
+
+      private
+
+      def formatted_lines
+        lines.map do |line|
+          " - #{line}"
+        end.join("\n")
+      end
+
+      def lines
+        [not_implemented_lines, incorrect_signature_lines].flatten
+      end
+
+      def not_implemented_lines
+        @check_session.methods_not_implemented.map do |method_name|
+          "#{method_name} is not present"
+        end
+      end
+
+      def incorrect_signature_lines
+        @check_session.methods_with_incorrect_signatures.map do |method_name|
+          "#{method_name} has an incorrect method signature"
+        end
+      end
+    end
+  end
+end
+
 RSpec.shared_examples 'it implements' do |interface_class|
-  describe "implements interface #{interface_class.name}" do
-    subject(:check_it_implements) { described_class.check_it_implements(interface_class) }
+  subject(:check_session) { described_class.check_it_implements(interface_class) }
+
+  def formatted_message(check_session)
+    formatted_check_session = Duckface::RSpec::CheckSessionFailureFormatter.new(check_session)
+    "expected to correctly implement #{described_class.name}#{formatted_check_session.message}"
+  end
 
-    it { is_expected.to be true }
+  describe "#{interface_class} correctly" do
+    specify ' ' do
+      expect(check_session.successful?).to be(true), formatted_message(check_session)
+    end
   end
 end

data/lib/duckface/services/check_class_implements_interface.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require 'duckface/errors'
 require 'duckface/method_implementation'
+require 'duckface/check_session'
 
 module Duckface
   module Services
     class CheckClassImplementsInterface
+      extend Forwardable
+
       def initialize(implementation_class, interface_class)
         @implementation_class = implementation_class
         @interface_class = interface_class
+        @check_session = CheckSession.new
       end
 
       def perform
@@ -16,20 +19,25 @@ module Duckface
           check_method_is_implemented(method_name)
           check_method_has_correct_signature(method_name)
         end
-        true
+        @check_session
       end
 
       private
 
       def check_method_is_implemented(method_name)
         return if method_implemented?(method_name)
-        raise Errors::InterfaceMethodNotImplementedError, "##{method_name} is not implemented"
+
+        notice_not_implemented_method(method_name)
       end
 
+      def_delegators :@check_session,
+                     :notice_not_implemented_method,
+                     :notice_method_with_incorrect_signature
+
       def check_method_has_correct_signature(method_name)
         return if method_has_correct_signature?(method_name)
-        raise Errors::ImplementationSignatureIncorrectError,
-              "##{method_name} does not have the correct signature"
+
+        notice_method_with_incorrect_signature(method_name)
       end
 
       def methods_that_should_be_implemented

data/lib/duckface/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Duckface
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duckface-interfaces
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bellroy Tech Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,16 +76,18 @@ files:
 - duckface-interfaces.gemspec
 - lib/duckface.rb
 - lib/duckface/acts_as_interface.rb
+- lib/duckface/check_session.rb
 - lib/duckface/constants.rb
-- lib/duckface/errors.rb
 - lib/duckface/implementation_methods.rb
 - lib/duckface/method_implementation.rb
+- lib/duckface/null_check_session.rb
 - lib/duckface/object_sugar.rb
 - lib/duckface/parameter_pair.rb
 - lib/duckface/parameter_pairs.rb
 - lib/duckface/rspec.rb
 - lib/duckface/services.rb
 - lib/duckface/services/check_class_implements_interface.rb
+- lib/duckface/types.rb
 - lib/duckface/version.rb
 homepage: https://github.com/samuelgiles/duckface
 licenses: []

data/lib/duckface/errors.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Duckface
-  module Errors
-    # Raised when a class does not implement a method
-    class InterfaceMethodNotImplementedError < NotImplementedError; end
-    # Raised when an implementation method does not have the same signature
-    # as the interface
-    class ImplementationSignatureIncorrectError < NotImplementedError; end
-  end
-end