delivered 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ab93c9434d5e06930f9fa814dfef95849cda9c6b76c611ed54b7c51d1e4856d
+  data.tar.gz: 868e6e469da0d2a07e752f7c35725414a99aa06ab898f13c8b177cf6c2d892f5
+SHA512:
+  metadata.gz: 1d94413829107f3b7cd6c60d4a28fc9c98abc5649b5dca0987ba88499729798d090563c882630a3be7495d22c99c32011a219c8d819d11429f7b23afb15c1db6
+  data.tar.gz: ac6388a9494a423891d5d9260c42ca7c9e4c90f0d85be89f36e54732aaa0cac0c0797c1947f8d983aa544e2967000e8187925ca60087d3062fe05d10d5fbf072

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'sus'
+end
+
+group :development, :test do
+  gem 'amazing_print'
+  gem 'debug', platforms: %i[mri mingw x64_mingw]
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    delivered (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amazing_print (1.6.0)
+    ast (2.4.2)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    io-console (0.7.2)
+    irb (1.12.0)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.5.0)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    sus (0.24.6)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+  ruby
+
+DEPENDENCIES
+  amazing_print
+  debug
+  delivered!
+  rubocop
+  sus
+
+BUNDLED WITH
+   2.5.4

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2024 Joel Moss <joel@developwithstyle.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# Delivered: Simple runtime type checking for Ruby method signatures
+
+Delivered gives you the ability to define method signatures in Ruby, and have them checked at
+runtime. This is useful for ensuring that your methods are being called with the correct arguments,
+and for providing better error messages when they are not.
+
+Simply define a method signature using the `sig` method directly before the method to be checked,
+and Delivered will check that the method is being called with the correct arguments and types. it
+can alos chreck the return value of the method.
+
+```ruby
+class User
+  sig String, age: Integer, returns: String
+  def create(name, age:)
+    "User #{name} created with age #{age}"
+  end
+end
+```

data/delivered.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# $:.unshift File.expand_path('lib', __dir__)
+require_relative 'lib/delivered/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'delivered'
+  s.version       = Delivered::VERSION
+  s.authors       = ['Joel Moss']
+  s.email         = ['joel@developwithstyle.com']
+  s.homepage      = 'https://github.com/joelmoss/delivered'
+  s.licenses      = ['MIT']
+  s.summary       = 'Simple runtime type checking for Ruby method signatures'
+  s.required_ruby_version = '>= 3.2'
+
+  s.files         = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/delivered/signature.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Delivered
+  module Signature
+    NULL = Object.new
+
+    def sig(*sig_args, returns: NULL, **sig_kwargs)
+      meta = class << self; self; end
+      meta.send :define_method, :method_added do |name|
+        meta.send :remove_method, :method_added
+
+        alias_method :"__#{name}", name
+        define_method name do |*args, **kwargs, &block|
+          sig_args.each.with_index do |arg, i|
+            args[i] => ^arg
+          end
+
+          kwargs.each do |key, value|
+            value => ^(sig_kwargs[key])
+          end
+
+          result = if block
+                     send(:"__#{name}", *args, **kwargs, &block)
+                   else
+                     send(:"__#{name}", *args, **kwargs)
+                   end
+
+          result => ^returns if returns != NULL
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/delivered/version.rb

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

data/lib/delivered.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Delivered
+  autoload :Signature, 'delivered/signature'
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: delivered
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- delivered.gemspec
+- lib/delivered.rb
+- lib/delivered/signature.rb
+- lib/delivered/version.rb
+homepage: https://github.com/joelmoss/delivered
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Simple runtime type checking for Ruby method signatures
+test_files: []