delivered 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b613f6dd8b19b06d0ca874c1a4f7408708f18b88e05d53b683693b27a20a04
-  data.tar.gz: 1380e56b87e1fa5b534b5bd6645dc1d965dec1c81021e042c4fc7f031aafdae2
+  metadata.gz: bd1eeeeaa704a08c1b4c834b24ba5623409da015b9697df7653cd60502edd8c3
+  data.tar.gz: 7fbce031535260897742c0f38100b23b0e62431f85dcd0f40c5b5a062a1f982a
 SHA512:
-  metadata.gz: ef984b3f51256ace952efaac631986a500c121408a42f544f6f9c4c296d2d88e2cc909452232bbdb498b4177ead3b910139205105c4137180c56dfcca2297f28
-  data.tar.gz: 17d2eaeb8cc23bfe69dd3f76b7b33d09d967f0f87d81221209c4b09c6cbd3777ed8ea45d4fd62ad119155a7bd1cd1aba8476677d022a6b24afb23032ff9dd423
+  metadata.gz: 3cca910f20d4d8cc948912346ff1f2c20add1e0fb7b7ba3bdaa42e81702195290b84670220579e6e6359a619e2f94f4bf4460fd0a2c9ad7227d39b2f84c42896
+  data.tar.gz: 23ad19572356a722b933db7253810b212120f1d9d47242a4fe56b5c6009d51164d6035ede779ee9d37758e9c6d3b235d18c75f553a5b8e09bf80318c59caac64

data/Gemfile.lock

@@ -1,37 +1,38 @@
 PATH
   remote: .
   specs:
-    delivered (0.2.0)
+    delivered (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     amazing_print (1.6.0)
     ast (2.4.2)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
     io-console (0.7.2)
-    irb (1.12.0)
-      rdoc
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rdoc (6.6.3.1)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.0)
-    reline (0.5.0)
+    regexp_parser (2.9.2)
+    reline (0.5.8)
       io-console (~> 0.5)
-    rexml (3.2.6)
-    rubocop (1.62.1)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rubocop (1.64.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -42,11 +43,12 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     stringio (3.1.0)
-    sus (0.24.6)
+    strscan (3.1.0)
+    sus (0.25.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS

data/README.md

@@ -26,6 +26,16 @@ end
 If an invalid argument is given to `User#create`, for example, if `age` is a `String` instead of
 the required `Integer`, a `Delivered::ArgumentError` exception will be raised.
 
+### Single and Double Splat Arguments
+
+You can use single and double splats in your method signatures, and Delivered will pass them through
+without checking, while still checking the other named positional and keyword arguments.
+
+```ruby
+sig String
+def create(name, *args, foo:, **kwargs); end
+```
+
 ### Return Types
 
 You can also check the return value of the method by passing a Hash with an Array as the key, and
@@ -73,6 +83,15 @@ sig validate: T.Boolean
 def create(validate:); end
 ```
 
+#### `RespondTo`
+
+Value **MUST** be respond to the given method(s).
+
+```ruby
+sig name: T.RespondTo(:to_s)
+def create(name:); end
+```
+
 #### `Any`
 
 Value **MUST** be any of the given list of values, that is, the value must be one of the given list.

data/lib/delivered/signature.rb

@@ -3,8 +3,6 @@
 module Delivered
   module Signature
     def sig(*sig_args, **sig_kwargs, &return_blk)
-      # ap [sig_args, sig_kwargs, return_blk]
-
       # Block return
       returns = return_blk&.call
 
@@ -20,32 +18,32 @@ module Delivered
         sig_kwargs = sig_args.pop if sig_args.last.is_a?(Hash)
       end
 
-      # ap [sig_args, sig_kwargs, returns]
+      # ap(sig_args:, sig_kwargs:)
 
       meta = class << self; self; end
       sig_check = lambda do |klass, class_method, name, *args, **kwargs, &block| # rubocop:disable Metrics/BlockLength
-        cname = if class_method
-                  "#{klass.name}.#{name}"
-                else
-                  "#{klass.class.name}##{name}"
-                end
+        # ap(args:, kwargs:, params: klass.method(:"__#{name}").parameters)
+
+        cname = class_method ? "#{klass.name}.#{name}" : "#{klass.class.name}##{name}"
 
         sig_args.each.with_index do |arg, i|
           args[i] => ^arg
         rescue NoMatchingPatternError => e
           raise Delivered::ArgumentError,
-                "`#{cname}` expected `#{arg}` as positional arg #{i}, but received " \
+                "`#{cname}` expected #{arg.inspect} as argument #{i}, but received " \
                 "`#{args[i].inspect}`",
                 caller, cause: e
         end
 
-        kwargs.each do |key, value|
-          value => ^(sig_kwargs[key])
-        rescue NoMatchingPatternError => e
-          raise Delivered::ArgumentError,
-                "`#{cname}` expected `#{sig_kwargs[key]}` as keyword arg :#{key}, but received " \
-                "`#{value.inspect}`",
-                caller, cause: e
+        unless sig_kwargs.empty?
+          kwargs.each do |key, value|
+            value => ^(sig_kwargs[key])
+          rescue NoMatchingPatternError => e
+            raise Delivered::ArgumentError,
+                  "`#{cname}` expected #{sig_kwargs[key].inspect} as keyword argument :#{key}, " \
+                  "but received `#{value.inspect}`",
+                  caller, cause: e
+          end
         end
 
         result = if block
@@ -58,13 +56,15 @@ module Delivered
           result => ^returns unless returns.nil?
         rescue NoMatchingPatternError => e
           raise Delivered::ArgumentError,
-                "`#{cname}` expected to return `#{returns}`, but returned `#{result.inspect}`",
+                "`#{cname}` expected to return #{returns.inspect}, " \
+                "but returned `#{result.inspect}`",
                 caller, cause: e
         end
 
         result
       end
 
+      # Instance method redefinition
       meta.send :define_method, :method_added do |name|
         meta.send :remove_method, :method_added
         meta.send :remove_method, :singleton_method_added
@@ -75,6 +75,7 @@ module Delivered
         end
       end
 
+      # Class method redefinition
       meta.send :define_method, :singleton_method_added do |name|
         next if name == :singleton_method_added
 

data/lib/delivered/types.rb

@@ -6,16 +6,32 @@ module Delivered
       @types = types
     end
 
+    def inspect = "Any(#{@types.map(&:inspect).join(', ')})"
+
     def ===(value)
       @types.empty? ? true : @types.any? { |type| type === value }
     end
   end
 
+  class RespondToType
+    def initialize(*methods)
+      @methods = methods
+    end
+
+    def inspect = "RespondTo(#{@methods.map(&:inspect).join(', ')})"
+
+    def ===(value)
+      @methods.all? { |m| value.respond_to?(m) }
+    end
+  end
+
   class NilableType
     def initialize(type = nil)
       @type = type
     end
 
+    def inspect = "Nilable(#{@type&.inspect || 'Any'})"
+
     def ===(value)
       (@type.nil? ? true : nil === value) || @type === value
     end
@@ -26,6 +42,8 @@ module Delivered
       freeze
     end
 
+    def inspect = 'Boolean'
+
     def ===(value)
       [true, false].include?(value)
     end
@@ -35,6 +53,7 @@ module Delivered
     module_function
 
     def Nilable(type = nil) = NilableType.new(type)
+    def RespondTo(*methods) = RespondToType.new(*methods)
     def Any(*types) = AnyType.new(*types)
     def Boolean = BooleanType.new
   end

data/lib/delivered/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Delivered
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivered
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Simple runtime type checking for Ruby method signatures