dry-behaviour 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e9909166c5283d9505f7be6f541334aea5d161
-  data.tar.gz: 2319fcbbb2da7b56aff3825e44788d44da99a688
+  metadata.gz: c9950cb0ec4cecfed71f7cae1cd777a0693ed8b5
+  data.tar.gz: a77cc845e72319b08e222e3ab7c820f87359e6a2
 SHA512:
-  metadata.gz: cd3f037341b4f6f2e28d9e4478d763fc6bd554d09e5be20be2ac08c2fad405be3a2ce8e45a273cdd0c6bbbf26efd8ee0abaf4edb6d48e4760c933ebaf54d1397
-  data.tar.gz: cea7c3a4b77dbc7cc4215e38b853c92d96670fe8677c771a2d1914b6e60293d163fc00d9bd3a60b97966849e5a7f025cb3b39c0b30afb933c62e25dfdafb4497
+  metadata.gz: d7f410dc7fb586256831916469d2d7bdcd74361235a74c891ac90ea8609bc69e343d9585d211a8b91abd9f88b443a60509bb9418df4201917fc01e170815346a
+  data.tar.gz: f4d1c1116169906a8efc11ea289c45d150cd920a3dcc2cbbc2c0f73870f449b2f102478e3a5aa54d6fb5a8c9e1d87031532f57a147d322d9d41d6ba885be75cc

data/README.md

@@ -100,9 +100,41 @@ end
 
 ## Changelog
 
+### `0.8.0` :: Implicit Inheritance
+
+- deprecate implicit delegation to the target instance; error message saying “it’ll be removed in 1.0”
+- `implicit_inheritance: true` flag in call to `defprotocol` makes the implementation implicitly inherit the behaviour declared in the core protocol module itself, without the necessity to explicitly call `super`:
+
+```diff
+ module ParentOKImplicit
+   include Dry::Protocol
+
+-  defprotocol do
++  defprotocol implicit_inheritance: true do
+     defmethod :foo
+
+     def foo(this)
+       :ok
+     end
+
+     defimpl target: String do
+-      def foo(this)
+-        super(this)
+-      end
+     end
+   end
+ end
+```
+
+### `0.7.0` :: Handling Errors
+
+- better error messages (very descriptive, with whys and howtos)
+- the whole stacktrace is carefully saved with `cause`
+- internal exceptions related to wrong implementation do now point to the proper lines in the client code (internal trace lines are removed)
+
 ### `0.6.0` :: Bugfix
 
-- Implementation for classes responding to **`to_a`** is handled properly
+- implementation for classes responding to **`to_a`** is handled properly
 
 ### `0.5.0` :: Guards
 

data/lib/dry/behaviour/black_tie.rb

@@ -15,12 +15,14 @@ module Dry
       end
     end
 
-    def defprotocol
-      raise if BlackTie.protocols.key?(self) # DUPLICATE DEF
-      raise unless block_given?
+    def defprotocol(implicit_inheritance: false, &λ)
+      raise ::Dry::Protocol::DuplicateDefinition.new(self) if BlackTie.protocols.key?(self)
+      raise ::Dry::Protocol::MalformedDefinition.new(self) unless block_given?
+
+      BlackTie.protocols[self][:__implicit_inheritance__] = !!implicit_inheritance
 
       ims = instance_methods(false)
-      class_eval(&Proc.new)
+      class_eval(&λ)
       (instance_methods(false) - ims).each { |m| class_eval { module_function m } }
 
       singleton_class.send :define_method, :method_missing do |method, *_args|
@@ -55,7 +57,7 @@ module Dry
       end
 
       singleton_class.send :define_method, :respond_to? do |method|
-        BlackTie.protocols[self].keys.include? method
+        NORMALIZE_KEYS.(self).include? method
       end
     end
 
@@ -78,21 +80,42 @@ module Dry
       end.enable
     end
 
-    def defimpl(protocol = nil, target: nil, delegate: [], map: {})
+    NORMALIZE_KEYS = lambda do |protocol|
+      BlackTie.protocols[protocol].keys.reject { |k| k.to_s =~ /\A__.*__\z/ }
+    end
+
+    IMPLICIT_DELEGATE_DEPRECATION =
+      "\n⚠️  DEPRECATED →  Implicit delegation to the target class will be removed in 1.0\n" \
+      "  ⮩   due to the lack of the explicit implementation of %s#%s for %s\n" \
+      "  ⮩   it will be delegated to the target class itself.\n" \
+      "  ⮩  Consider using explicit `delegate:' declaration in `defimpl' or\n" \
+      "  ⮩   use `implicit_inheritance: true' parameter in protocol definition.".freeze
+
+    def defimpl(protocol = nil, target: nil, delegate: [], map: {}, &λ)
       raise if target.nil? || !block_given? && delegate.empty? && map.empty?
 
       mds = normalize_map_delegates(delegate, map)
 
       Module.new do
         mds.each(&DELEGATE_METHOD.curry[singleton_class])
-        singleton_class.class_eval(&Proc.new) if block_given? # block takes precedence
+        singleton_class.class_eval(&λ) if block_given? # block takes precedence
       end.tap do |mod|
         protocol ? mod.extend(protocol) : POSTPONE_EXTEND.(mod, protocol = self)
 
         mod.methods(false).tap do |meths|
-          (BlackTie.protocols[protocol].keys - meths).each_with_object(meths) do |m, acc|
-            BlackTie.Logger.warn("Implicit delegate #{protocol.inspect}##{m} to #{target}")
-            DELEGATE_METHOD.(mod.singleton_class, [m] * 2)
+          (NORMALIZE_KEYS.(protocol) - meths).each_with_object(meths) do |m, acc|
+            if BlackTie.protocols[protocol][:__implicit_inheritance__]
+              mod.singleton_class.class_eval do
+                define_method m do |*args, &λ|
+                  super(*args, &λ)
+                end
+              end
+            else
+              BlackTie.Logger.warn(
+                IMPLICIT_DELEGATE_DEPRECATION % [protocol.inspect, m, target]
+              )
+              DELEGATE_METHOD.(mod.singleton_class, [m] * 2)
+            end
             acc << m
           end
         end.each do |m|

data/lib/dry/behaviour/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Behaviour
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

data/lib/dry/errors/duplicate_definition.rb

@@ -0,0 +1,9 @@
+module Dry
+  module Protocol
+    class DuplicateDefinition < StandardError
+      def initialize(suspect)
+        super "Duplicate definition of “#{suspect.inspect}” detected."
+      end
+    end
+  end
+end

data/lib/dry/errors/malformed_definition.rb

@@ -0,0 +1,9 @@
+module Dry
+  module Protocol
+    class MalformedDefinition < StandardError
+      def initialize(suspect)
+        super "Malformed definition of “#{suspect.inspect}”. Block required."
+      end
+    end
+  end
+end

data/lib/dry/errors/not_implemented.rb

@@ -13,10 +13,11 @@ module Dry
           when :method
             "Protocol “#{@proto}” does not declare method “#{@details[:method]}”."
           when :nested
-            "Protocol “#{@proto}” failed to invoke the implementation.\n" \
-            " ⮩  caused by “#{cause.class}” with a message\n" \
+            "Protocol “#{@proto}” failed to invoke the implementation for\n" \
+            " ⮩    “#{@details[:receiver].class}##{@details[:method]}”.\n" \
+            " ⮩  Caused by “#{cause.class}” with a message\n" \
             " ⮩    “#{cause.message}”\n" \
-            " ⮩  rescue this exception and inspect `NotImplemented#cause' for details."
+            " ⮩  Rescue this exception and inspect `NotImplemented#cause' for details."
           else
             "Protocol “#{proto}” is invalid."
           end

data/lib/dry/errors.rb

@@ -1,4 +1,7 @@
 require 'dry/errors/not_implemented'
 require 'dry/errors/not_protocol'
+require 'dry/errors/duplicate_definition'
+require 'dry/errors/malformed_definition'
+
 require 'dry/errors/not_guardable'
 require 'dry/errors/not_matched'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-behaviour
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
@@ -124,6 +124,8 @@ files:
 - lib/dry/behaviour/cerberus.rb
 - lib/dry/behaviour/version.rb
 - lib/dry/errors.rb
+- lib/dry/errors/duplicate_definition.rb
+- lib/dry/errors/malformed_definition.rb
 - lib/dry/errors/not_guardable.rb
 - lib/dry/errors/not_implemented.rb
 - lib/dry/errors/not_matched.rb