delivered 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2cc2a244302acba122bf449caa221233453955568ca1a7c42f9a4c66e75093a
-  data.tar.gz: 2c6033b4adee7756b8fb7bbb9ff0cac83bbe7f42e35220eb9a24857c17e2aa7e
+  metadata.gz: b22fc67aefea021f5a096de509e51e3ab69eb3b256388eebd764d194c23ed72d
+  data.tar.gz: 9fe11a083f14b7dba924435d66fce6aff92d93819b7e7ef5a5c1b0c41fb38c9c
 SHA512:
-  metadata.gz: 3adf4d4bb048a39a00e331e598814998fffe28673702d08bba181cd574f521b3f2d164725c5fe61d349c85c960c32a59d98bb8855ff0f26db6ad5bd74123ae4e
-  data.tar.gz: 735bde97671a2e2d69238b5363de35971ecb1a7ab4003e2352c560231bd461b712a3e652bd01c9b02cf067d5d8b2a856baf6b8709621c5f8e34b0eb94c692e9f
+  metadata.gz: a07fe7c33a96cccc120ec61e999e45704c771c15c170f6b90e263e831bd0f80a93e76d75ff07277447eac18cd9d5defa14d7ea816f6767ecacc7f794eea393ca
+  data.tar.gz: 0fcf19ef982ddb7eae98cedac03723d4a66eda8b88411840e4435137bccf467141db2e4b180ed1876e660caaca7d9746e380c55afa79553d559b925840ccb409

data/Gemfile

@@ -13,6 +13,5 @@ group :test do
 end
 
 group :development, :test do
-  gem 'amazing_print'
   gem 'debug', platforms: %i[mri mingw x64_mingw]
 end

data/Gemfile.lock

@@ -1,62 +1,66 @@
 PATH
   remote: .
   specs:
-    delivered (0.3.0)
+    delivered (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amazing_print (1.6.0)
     ast (2.4.2)
-    debug (1.9.2)
+    date (3.4.1)
+    debug (1.10.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    io-console (0.7.2)
-    irb (1.13.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    psych (5.1.2)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rdoc (6.6.3.1)
+    rdoc (6.12.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    reline (0.5.7)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
       io-console (~> 0.5)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
-    rubocop (1.63.5)
+    rubocop (1.72.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    stringio (3.1.0)
-    strscan (3.1.0)
-    sus (0.25.0)
-    unicode-display_width (2.5.0)
+    stringio (3.1.5)
+    sus (0.32.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   arm64-darwin-22
   ruby
 
 DEPENDENCIES
-  amazing_print
   debug
   delivered!
   rubocop

data/README.md

@@ -26,6 +26,23 @@ 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.
 
+Delivered also provides a handy `verify!` method to verify the type of any value.
+
+```ruby
+Delivered.verify! 1, Integer
+Delivered.verify! :yes, T.Any(:yes, :no)
+```
+
+### 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
@@ -82,6 +99,38 @@ sig name: T.RespondTo(:to_s)
 def create(name:); end
 ```
 
+#### `RangeOf`
+
+Value **MUST** be a Range of the given type
+
+```ruby
+sig name: T.RangeOf(Integer)
+def create(name: 1...2); end
+```
+
+#### `ArrayOf`
+
+Value **MUST** be an Array of the given type
+
+```ruby
+sig names: T.ArrayOf(String)
+def create(names: ['Joel', 'Ash']); end
+```
+
+#### `Enumerable`
+
+Value **MUST** be an Enumerable of the optional given type
+
+```ruby
+sig users: T.Enumerable
+def create(users: [1, 2]); end
+```
+
+```ruby
+sig users: T.Enumerable(User)
+def create(users: User.all); 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,26 @@ module Delivered
         sig_kwargs = sig_args.pop if sig_args.last.is_a?(Hash)
       end
 
-      # ap [sig_args, sig_kwargs, returns]
-
       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
+        cname = class_method ? "#{klass.name}.#{name}" : "#{klass.class.name}##{name}"
 
         sig_args.each.with_index do |arg, i|
           args[i] => ^arg
-        rescue NoMatchingPatternError => e
+        rescue NoMatchingPatternError
           raise Delivered::ArgumentError,
-                "`#{cname}` expected #{arg.inspect} as argument #{i}, but received " \
-                "`#{args[i].inspect}`",
-                caller, cause: e
+                "#{cname} expected #{arg.inspect} as argument #{i}, but received " \
+                "`#{args[i].inspect}`"
         end
 
-        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
+        unless sig_kwargs.empty?
+          kwargs.each do |key, value|
+            value => ^(sig_kwargs[key])
+          rescue NoMatchingPatternError
+            raise Delivered::ArgumentError,
+                  "#{cname} expected #{sig_kwargs[key].inspect} as keyword argument :#{key}, " \
+                  "but received `#{value.inspect}`"
+          end
         end
 
         result = if block
@@ -56,16 +48,16 @@ module Delivered
 
         begin
           result => ^returns unless returns.nil?
-        rescue NoMatchingPatternError => e
+        rescue NoMatchingPatternError
           raise Delivered::ArgumentError,
                 "`#{cname}` expected to return #{returns.inspect}, " \
-                "but returned `#{result.inspect}`",
-                caller, cause: e
+                "but returned `#{result.inspect}`"
         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
@@ -76,6 +68,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

@@ -13,6 +13,57 @@ module Delivered
     end
   end
 
+  class EnumerableType
+    def initialize(type)
+      @type = type
+    end
+
+    def inspect = "Enumerable(#{@type.inspect})"
+
+    if Delivered::EXPENSIVE_TYPE_CHECKS
+      def ===(value)
+        Enumerable === value && value.all? { |item| @type === item }
+      end
+    else
+      def ===(value)
+        Enumerable === value && (value.empty? || @type === value.first)
+      end
+    end
+  end
+
+  class ArrayOfType
+    def initialize(type)
+      @type = type
+    end
+
+    def inspect = "ArrayOf(#{@type.inspect})"
+
+    if Delivered::EXPENSIVE_TYPE_CHECKS
+      def ===(value)
+        Array === value && value.all? { |item| @type === item }
+      end
+    else
+      def ===(value)
+        Array === value && (value.empty? || @type === value[0])
+      end
+    end
+  end
+
+  class RangeOfType
+    def initialize(type)
+      @type = type
+    end
+
+    def inspect = "Range(#{@type&.inspect})"
+
+    def ===(value)
+      Range === value && (
+        (@type === value.begin && (nil === value.end || @type === value.end)) ||
+        (@type === value.end && nil === value.begin)
+      )
+    end
+  end
+
   class RespondToType
     def initialize(*methods)
       @methods = methods
@@ -53,6 +104,9 @@ module Delivered
     module_function
 
     def Nilable(type = nil) = NilableType.new(type)
+    def Enumerable(type = nil) = EnumerableType.new(type)
+    def ArrayOf(type) = ArrayOfType.new(type)
+    def RangeOf(type) = RangeOfType.new(type)
     def RespondTo(*methods) = RespondToType.new(*methods)
     def Any(*types) = AnyType.new(*types)
     def Boolean = BooleanType.new

data/lib/delivered/version.rb

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

data/lib/delivered.rb

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
 
 module Delivered
-  class ArgumentError < ArgumentError
-  end
+  EXPENSIVE_TYPE_CHECKS = ENV['DELIVERED_EXPENSIVE_TYPE_CHECKS'] != 'false'
+
+  class ArgumentError < ArgumentError; end
+  class VerifyError < StandardError; end
 
   autoload :Signature, 'delivered/signature'
   autoload :Types, 'delivered/types'
+
+  module_function
+
+  def verify!(value, type)
+    value => ^type
+  rescue NoMatchingPatternError => e
+    raise Delivered::VerifyError, "Expected `#{value.inspect}` to be #{type.inspect}", cause: e
+  end
 end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivered
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Moss
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - joel@developwithstyle.com
 executables: []
@@ -34,7 +32,6 @@ metadata:
   source_code_uri: https://github.com/joelmoss/delivered
   changelog_uri: https://github.com/joelmoss/delivered/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Simple runtime type checking for Ruby method signatures
 test_files: []