dry-behaviour 0.11.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 232921c25386484f9538bbe49039c133c1de8e2d2cd85b9545a4de3736344385
-  data.tar.gz: 38625102473e08efc17d5162db60e1fc9a90633f81695ecb60f26f395237f976
+SHA1:
+  metadata.gz: e6de5e26b1d3d57039660055f9248c1a3df5431d
+  data.tar.gz: 17404270b966673dd7d7c56d6966d1a93cf58cfd
 SHA512:
-  metadata.gz: 4c4c5d71d32fcfe4bef6fb13e21ddcd8a32afc63cdbf3bda1dc97428d56332f99e02fd15cb15db9b3ecafb719812e6889587794598dd666335d02e67780b6ae9
-  data.tar.gz: 3d556f70828ded92ad615fd01ab27b1d7b4c70843bf2d16fa10de1a9102da08ea6f3284883aa2c37a2b0c830776c36ea5ed989cb50ef711e29c5dbb2cfa53531
+  metadata.gz: bb1ddcc3af289266d79dfd8c38b33fd47f4db8f3d2533e4aec395ff353490876bbf2554e241b23c5e56b45b81bec623f79baa97eede969071ab07c7ab7e24eba
+  data.tar.gz: 02e81fe058128b1ebdbb4fe34ed5811c9bd6da01ab91742235bb57f87b29adfc3824d33885e507137e724fffac7d793d3a33da7882b4dc766de8601a7df43c0e

data/.github/workflows/ci.yml

@@ -3,18 +3,22 @@ name: Ruby
 on: [push]
 
 jobs:
-  build:
+  test:
 
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['head', '3.1', '3.0', '2.7']
+
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/gempush.yml

@@ -15,10 +15,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 2.3.8
+      uses: ruby/setup-ruby@v1
       with:
-        version: 2.6.x
+        version: 2.3.8
 
     - name: Publish to GPR
       run: |

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.3.8

data/README.md

@@ -60,6 +60,45 @@ expect(Protocols::Adder.add(nil, 10)).to eq(10)
 expect(Protocols::Adder.add_default(1)).to eq(6)
 ```
 
+### Arguments types
+
+Normally, one would use a simple notation to declare a method. It includes `:this` receiver
+in te very first position and some optional required arguments afterward.
+
+```ruby
+  defmethod :add, :this, :addend
+  ...
+  defimpl ... do
+    def add(this, addend); this + addend; end
+  end
+```
+
+If the argument is not generic (optional, or splatted, or keyword,) its type must be explicitly
+specified in the protocol definition as shown below.
+
+```ruby
+  defprotocol implicit_inheritance: true do
+    defmethod :with_def_argument, :this, [:foo_opt, :opt]
+    defmethod :with_def_keyword_argument, :this, [:foo_key, :key]
+    defmethod :with_req_keyword_argument, :this, [:foo_key, :keyreq]
+
+    def with_def_argument(this, foo_opt = :super); foo_opt; end
+    def with_def_keyword_argument(this, foo_key: :super); foo_key; end
+    def with_req_keyword_argument(this, foo_key:); foo_key; end
+  ...
+```
+
+That said, `:addend` argument declaration is a syntactic sugar for `[:addend, :req]`.
+Possible values for the type are:
+
+```ruby
+PARAM_TYPES = %i[req opt rest key keyrest keyreq block]
+```
+
+Please note, that the signature of the method and its implementation must exactly match.
+One cannot declare a method to have a `keyreq` argument and then make it defaulted in the
+implementation. That is done by design.
+
 ## Guards
 
 Starting with `v0.5.0` we support multiple function clauses and guards.

data/lib/dry/behaviour/black_tie.rb

@@ -8,7 +8,7 @@ module Dry
     class << self
       def proto_caller
         caller.drop_while do |line|
-          line =~ %r[dry-behaviour/lib/dry/behaviour]
+          line =~ %r{dry-behaviour/lib/dry/behaviour}
         end.first
       end
 
@@ -20,7 +20,7 @@ module Dry
             require 'logger'
             Logger.new($stdout)
           end
-        @logger ? @logger : Class.new { def warn(*); end }.new
+        @logger || Class.new { def warn(*); end }.new
       end
 
       def protocols
@@ -33,8 +33,8 @@ module Dry
     end
 
     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?
+      raise ::Dry::Protocol::DuplicateDefinition, self if BlackTie.protocols.key?(self)
+      raise ::Dry::Protocol::MalformedDefinition, self unless block_given?
 
       BlackTie.protocols[self][:__implicit_inheritance__] = !!implicit_inheritance
 
@@ -54,21 +54,38 @@ module Dry
         end.reject(&:nil?).first
       end
 
-      BlackTie.protocols[self].each do |method, *_| # FIXME: CHECK ARITY HERE
-        singleton_class.send :define_method, method do |receiver = nil, *args|
+      BlackTie.protocols[self].each do |method, *_m_args, **_m_kwargs| # FIXME: CHECK ARITY HERE
+        # singleton_class.send :define_method, method do |receiver, *args, **kwargs|
+        singleton_class.send :define_method, method do |*args, **kwargs|
+          if args == []
+            receiver = kwargs
+            kwargs = {}
+          else
+            receiver, *args = args
+          end
+
           impl = implementation_for(receiver)
-          raise Dry::Protocol::NotImplemented.new(
-            :protocol, inspect,
-            method: method, receiver: receiver, args: args, self: self
-          ) unless impl
+
+          unless impl
+            raise Dry::Protocol::NotImplemented.new(
+              :protocol, inspect,
+              method: method, receiver: receiver, args: args, self: self
+            )
+          end
+
           begin
-            impl[method].(*args.unshift(receiver))
-          rescue => e
+            # [AM] [v1] [FIXME] for modern rubies `if` is redundant
+            if kwargs.empty?
+              impl[method].(*args.unshift(receiver))
+            else
+              impl[method].(*args.unshift(receiver), **kwargs)
+            end
+          rescue StandardError => e
             raise Dry::Protocol::NotImplemented.new(
-                :nested, inspect,
-                cause: e,
-                method: method, receiver: receiver, args: args, impl: impl, self: self
-              )
+              :nested, inspect,
+              cause: e,
+              method: method, receiver: receiver, args: args, impl: impl, self: self
+            )
           end
         end
       end
@@ -80,16 +97,16 @@ module Dry
 
     def defmethod(name, *params)
       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])
+        BlackTie.Logger.warn(format(IMPLICIT_RECEIVER_DECLARATION, Dry::BlackTie.proto_caller, inspect, name))
         params.unshift(:this)
       end
       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])
+            BlackTie.Logger.warn(format(UNKNOWN_TYPE_DECLARATION, Dry::BlackTie.proto_caller, type, inspect, name))
             type = nil
           end
-          [type || PARAM_TYPES.include?(p) ? p : :req, p]
+          [type || (PARAM_TYPES.include?(p) ? p : :req), p]
         end
       BlackTie.protocols[self][name] = params
     end
@@ -109,13 +126,18 @@ 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 |this, *♿_args, &♿_λ|
-                  super(this, *♿_args, &♿_λ)
+                define_method m do |this, *♿_args, **♿_kwargs, &♿_λ|
+                  # [AM] [v1] [FIXME] for modern rubies `if` is redundant
+                  if ♿_kwargs.empty?
+                    super(this, *♿_args, &♿_λ)
+                  else
+                    super(this, *♿_args, **♿_kwargs, &♿_λ)
+                  end
                 end
               end
             else
               BlackTie.Logger.warn(
-                IMPLICIT_DELEGATE_DEPRECATION % [Dry::BlackTie.proto_caller, protocol.inspect, m, target]
+                format(IMPLICIT_DELEGATE_DEPRECATION, Dry::BlackTie.proto_caller, protocol.inspect, m, target)
               )
               DELEGATE_METHOD.(mod.singleton_class, [m] * 2)
             end
@@ -128,13 +150,17 @@ module Dry
             proto = BlackTie.protocols[protocol]
             ok =
               mds.map(&:first).include?(m) ||
-              ((proto[m] == {} || proto[:__implicit_inheritance__]) && [[:req], [:rest]].include?(params.map(&:first))) ||
+              ((proto[m] == {} || proto[:__implicit_inheritance__]) && [[:req],
+                                                                        [:rest]].include?(params.map(&:first))) ||
               [proto[m], params].map { |args| args.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
+            unless ok
+              BlackTie.Logger.warn(
+                format(WRONG_PARAMETER_DECLARATION, Dry::BlackTie.proto_caller, protocol.inspect, m, target,
+                       BlackTie.protocols[protocol][m].map(&:first))
+              )
+            end
 
             BlackTie.implementations[protocol][tgt][m] = mod.method(m).to_proc
           end
@@ -143,7 +169,7 @@ module Dry
     end
     module_function :defimpl
 
-    PARAM_TYPES = %i[req opt rest keyrest block]
+    PARAM_TYPES = %i[req opt rest key keyrest keyreq block]
 
     DELEGATE_METHOD = lambda do |klazz, (source, target)|
       klazz.class_eval do
@@ -176,7 +202,7 @@ module Dry
       "\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
+      '  ⮩   in call to %s#defmethod(%s).'.freeze
 
     UNKNOWN_TYPE_DECLARATION =
       "\n⚠️  UNKNOWN TYPE →  %s\n" \
@@ -189,7 +215,7 @@ module Dry
       "  ⮩  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
+      '  ⮩   Expected: %s'.freeze
 
     private
 

data/lib/dry/behaviour/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Behaviour
-    VERSION = '0.11.2'.freeze
+    VERSION = '0.12.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-behaviour
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
 platform: ruby
 authors:
 - Aleksei Matiushkin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -149,7 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Tiny library inspired by Elixir protocol pattern.

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.1
-  - 2.1.10
-  - 2.2.2
-  - 2.5.1
-before_install: gem install bundler -v 1.14.6