interfaceable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd1c5e3e374f3cf828348678b04342a04e332598682e16e95cbb69bf60a84da2
-  data.tar.gz: 2dfc160484c025e9ec543849ec4b5c9d3e681493caa290b7bab5ae9d47754ef3
+  metadata.gz: 8e3a31246fb0aa84aec2f5d0be9e096931c53d55802f0a87d019f265a2258f59
+  data.tar.gz: 5c237f422ee9e564317302f0adb11b1d18b19a2e00b96e26c8bcc0c515dfd93e
 SHA512:
-  metadata.gz: 8987daa2e42f955ae1099b67e6787556f1c49e6d2b563f7571db6734d34fee5c1d6636f0bd5c9fc735d7400d4972fdbb3cc70b4ad3f51be04ce3799b7f4fa48a
-  data.tar.gz: 2ffcdadc6dfb51bb9cd1a0dc04cd316f2686ef53dcc98b0918fa4b48cf37a100a7161efd16b0751a5b75a50f5221766e9226ea60ab22058410a775985dd58e82
+  metadata.gz: 9170e1afde83592b35817e76d5e101cb609f62ae49030f6b98e39f085f4b44a10ceb408781a2c6b6317776e765c66e25372787012014d203b60ee03d92e92b99
+  data.tar.gz: e8f2a50b19dc800f19ce6b08f3e9ef0986f9f0f94afdb66f0726dd15cd3f5669f9750ee2a201be5eb8b481cd56ebbd59a73159763e5b6d5e0d659eaec2efbaf6

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    interfaceable (0.1.1)
+    interfaceable (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-# Interfaceable [![Build Status](https://travis-ci.org/featurist/interfaceable.svg?branch=master)](https://travis-ci.org/featurist/interfaceable) [![Gem Version](https://badge.fury.io/rb/interfaceable.svg)](https://badge.fury.io/rb/interfaceable)
+# Interfaceable [![Ruby](https://github.com/featurist/interfaceable/actions/workflows/ruby.yml/badge.svg)](https://github.com/featurist/interfaceable/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/interfaceable.svg)](https://badge.fury.io/rb/interfaceable)
 
 Impose interfaces on classes and let this gem automatically check that the interface constraints are met.
 
@@ -57,6 +57,24 @@ Will fail because of method signature mismatch:
         - expected arguments: (req, req)
         - actual arguments: (req, opt=)
 
+Classes may define additional optional or rest arguments.
+
+```ruby
+module Carrier
+  def call(number); end
+
+  def text(number, text); end
+end
+
+class Giffgaff
+  def call(number, *opts); end
+
+  def text(number, text, opt1 = nil, opt2 = nil); end
+end
+```
+
+This will not generate any errors since `Giffgaff` implements the required methods with correct arguments only adding new optional ones.
+
 ### Rails
 
 Mix in `Interfaceable` before any of the application code is loaded. For example, in the initializer. For extra peace of mind, you can noop interface checking in production:

data/lib/interfaceable/implementation_check.rb

@@ -73,6 +73,16 @@ module Interfaceable
       methods - Object.methods
     end
 
+    OPTIONAL_PARAMETERS = %w[opt rest keyrest]
+
+    def check_if_parameters_are_compatible(expected_parameters, actual_parameters)
+      return false if actual_parameters.length < expected_parameters.length
+      return false if actual_parameters.take(expected_parameters.length) != expected_parameters
+
+      additional_parameters = actual_parameters[expected_parameters.length..]
+      additional_parameters.all? { OPTIONAL_PARAMETERS.include?(_1) }
+    end
+
     # rubocop:disable Metrics/MethodLength
     def check_method_signature(expected_parameters, actual_parameters)
       expected_keyword_parameters, expected_positional_parameters = simplify_parameters(
@@ -85,6 +95,9 @@ module Interfaceable
       return if expected_positional_parameters == actual_positional_parameters &&
                 expected_keyword_parameters == actual_keyword_parameters
 
+      return if check_if_parameters_are_compatible(expected_positional_parameters, actual_positional_parameters) &&
+                check_if_parameters_are_compatible(expected_keyword_parameters, actual_keyword_parameters)
+
       {
         expected_positional_parameters: expected_positional_parameters,
         expected_keyword_parameters: expected_keyword_parameters,

data/lib/interfaceable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Interfaceable
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: interfaceable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - artemave
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - artemave@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -38,7 +38,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/featurist/interfaceable
   source_code_uri: https://github.com/artemave/interfaceable.git
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Strict interfaces in Ruby
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4
-install: bundle
-script:
-  - bundle exec rubocop
-  - COVERAGE=1 bundle exec rspec