dry-behaviour 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9950cb0ec4cecfed71f7cae1cd777a0693ed8b5
-  data.tar.gz: a77cc845e72319b08e222e3ab7c820f87359e6a2
+  metadata.gz: b2b0ca314a414ad6f7d6a03ab29a2fc0b1979e48
+  data.tar.gz: 2367933ab2b964b9bbfaadf22be72017d2f79a03
 SHA512:
-  metadata.gz: d7f410dc7fb586256831916469d2d7bdcd74361235a74c891ac90ea8609bc69e343d9585d211a8b91abd9f88b443a60509bb9418df4201917fc01e170815346a
-  data.tar.gz: f4d1c1116169906a8efc11ea289c45d150cd920a3dcc2cbbc2c0f73870f449b2f102478e3a5aa54d6fb5a8c9e1d87031532f57a147d322d9d41d6ba885be75cc
+  metadata.gz: da6989a23ce8f768967a5627e5f276114edfa94a9eb1d5b29286ec0617bf9bde29b5011748230d7717e1912c731365a94798a70d57943e57d3be867baf8c10da
+  data.tar.gz: 1580b12c2f74a616218f3789a9425f3f737483eccae31be53366a0ab9835f66d51c373839ce5c9ec725b9767b0397d15c7d66123661127e214345ba7415ef3e7

data/README.md

@@ -100,6 +100,11 @@ end
 
 ## Changelog
 
+### `0.9.0` :: Warning On Wrong Arity
+
+- many error reporting improvements,
+- warning on wrong arity (declaration, arity 0 / implementation, wrong arity)
+
 ### `0.8.0` :: Implicit Inheritance
 
 - deprecate implicit delegation to the target instance; error message saying “it’ll be removed in 1.0”

data/lib/dry/behaviour/black_tie.rb

@@ -62,35 +62,21 @@ module Dry
     end
 
     def defmethod(name, *params)
-      BlackTie.protocols[self][name] = params
-    end
-
-    DELEGATE_METHOD = lambda do |klazz, (source, target)|
-      klazz.class_eval do
-        define_method(source, &Dry::DEFINE_METHOD.curry[target])
+      if params.size.zero? || params.first.is_a?(Array) && params.first.last != :req
+        BlackTie.Logger.warn(IMPLICIT_RECEIVER_DECLARATION % [Dry::BlackTie.proto_caller, self.inspect, name])
+        params.unshift(:this)
       end
-    end
-
-    POSTPONE_EXTEND = lambda do |target, protocol|
-      TracePoint.new(:end) do |tp|
-        if tp.self == protocol
-          target.extend protocol
-          tp.disable
+      params =
+        params.map do |p, type|
+          if type && !PARAM_TYPES.include?(type)
+            BlackTie.Logger.warn(UNKNOWN_TYPE_DECLARATION % [Dry::BlackTie.proto_caller, type, self.inspect, name])
+            type = nil
+          end
+          [type || PARAM_TYPES.include?(p) ? p : :req, p]
         end
-      end.enable
-    end
-
-    NORMALIZE_KEYS = lambda do |protocol|
-      BlackTie.protocols[protocol].keys.reject { |k| k.to_s =~ /\A__.*__\z/ }
+      BlackTie.protocols[self][name] = params
     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?
 
@@ -106,13 +92,13 @@ module Dry
           (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, &λ)
+                define_method m do |this, *♿_args, &♿_λ|
+                  super(this, *♿_args, &♿_λ)
                 end
               end
             else
               BlackTie.Logger.warn(
-                IMPLICIT_DELEGATE_DEPRECATION % [protocol.inspect, m, target]
+                IMPLICIT_DELEGATE_DEPRECATION % [Dry::BlackTie.proto_caller, protocol.inspect, m, target]
               )
               DELEGATE_METHOD.(mod.singleton_class, [m] * 2)
             end
@@ -121,6 +107,17 @@ module Dry
         end.each do |m|
           target = [target] unless target.is_a?(Array)
           target.each do |tgt|
+            ok =
+              [
+                BlackTie.protocols[protocol][m],
+                mod.method(m).parameters.reject { |_, v| v.to_s[/\A♿_/] }
+              ].map(&:first).reduce(:==)
+
+            # TODO[1.0] raise NotImplemented(:arity)
+            BlackTie.Logger.warn(
+              WRONG_PARAMETER_DECLARATION % [Dry::BlackTie.proto_caller, protocol.inspect, m, target, BlackTie.protocols[protocol][m].map(&:first)]
+            ) unless ok
+
             BlackTie.implementations[protocol][tgt][m] = mod.method(m).to_proc
           end
         end
@@ -128,6 +125,60 @@ module Dry
     end
     module_function :defimpl
 
+    PARAM_TYPES = %i[req opt rest keyrest block]
+
+    DELEGATE_METHOD = lambda do |klazz, (source, target)|
+      klazz.class_eval do
+        define_method(source, &Dry::DEFINE_METHOD.curry[target])
+      end
+    end
+
+    POSTPONE_EXTEND = lambda do |target, protocol|
+      TracePoint.new(:end) do |tp|
+        if tp.self == protocol
+          target.extend protocol
+          tp.disable
+        end
+      end.enable
+    end
+
+    NORMALIZE_KEYS = lambda do |protocol|
+      BlackTie.protocols[protocol].keys.reject { |k| k.to_s =~ /\A__.*__\z/ }
+    end
+
+    def self.proto_caller
+      caller.drop_while do |line|
+        line =~ %r[dry-behaviour/lib/dry/behaviour]
+      end.first
+    end
+
+    IMPLICIT_DELEGATE_DEPRECATION =
+      "\n🚨️  DEPRECATED →  %s\n" \
+      "  ⮩  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
+
+    IMPLICIT_RECEIVER_DECLARATION =
+      "\n⚠️  TOO IMPLICIT →  %s\n" \
+      "  ⮩  Implicit declaration of `this' parameter in `defmethod'.\n" \
+      "  ⮩   Whilst it’s allowed, we strongly encourage to explicitly declare it\n" \
+      "  ⮩   in call to %s#defmethod(%s).".freeze
+
+    UNKNOWN_TYPE_DECLARATION =
+      "\n⚠️  UNKNOWN TYPE →  %s\n" \
+      "  ⮩  Unknown parameter type [%s] in call to %s#defmethod(%s).\n" \
+      "  ⮩   Is it a typo? Omit the type for `:req' or pass one of allowed types:\n" \
+      "  ⮩   #{PARAM_TYPES.inspect}".freeze
+
+    WRONG_PARAMETER_DECLARATION =
+      "\n🚨️  DEPRECATED →  %s\n" \
+      "  ⮩  Wrong parameters declaration will be removed in 1.0\n" \
+      "  ⮩   %s#%s was implemented for %s with unexpected parameters.\n" \
+      "  ⮩  Consider implementing interfaces exactly as they were declared.\n" \
+      "  ⮩   Expected: %s".freeze
+
     def self.Logger
       @logger ||= if Kernel.const_defined?('::Rails')
                     Rails.logger

data/lib/dry/behaviour/version.rb

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

data/lib/dry/errors/not_implemented.rb

@@ -18,6 +18,14 @@ module Dry
             " ⮩  Caused by “#{cause.class}” with a message\n" \
             " ⮩    “#{cause.message}”\n" \
             " ⮩  Rescue this exception and inspect `NotImplemented#cause' for details."
+          when :arity
+            "Attempt to implement “#{@proto}#@details[:method]}”\n" \
+            " ⮩    with a wrong arity for “#{@details[:target]}”.\n" \
+            " ⮩  Expected parameters types:\n" \
+            " ⮩    “#{@details[:expected]}”\n" \
+            " ⮩  Provided parameters types:\n" \
+            " ⮩    “#{@details[:provided]}”\n" \
+            " ⮩  Please consider providing a proper implementation."
           else
             "Protocol “#{proto}” is invalid."
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-behaviour
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler