contracts 0.17.1 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a151d83a8b03910e5dd1171c384e0ea8a01ff9437d81140f995358d888ac0fa
-  data.tar.gz: b92d01b9dd8702b866e004c41834781885d8178b1ceacb1e5166982243a13a49
+  metadata.gz: 6d5a8e7593b70e99ae8c0f56e6bf4484b884ecfbb740a418f27a78321ca856c9
+  data.tar.gz: c62fb8724ebfe3aea0dc2ff4ae8f9af119192d84d57244076ae83d60a5d26c03
 SHA512:
-  metadata.gz: 94df8b86d22522b7c573f9cd7b3ee425568b024d7d3a88701759a2b47cdce691bd9ce7ec45710e7e8dafb993c7aa1cb93d6d9a0110d3c4effeece4b24fda29a9
-  data.tar.gz: dbbddaf090e48b52cde302f6a6b5b89fc84045e9c392ef1d34ddcfb2e149f65c3da825b8140ebd4b3d36672ed933b841e1c59b9e684098bb3144762bcd7b4b50
+  metadata.gz: ea0815ee43b56200ab8465c112f5144989a0ac12c1a9e463ec7bc61ab14b1eeae5ef226ffed7961770b59d57fcfac3527445620cafaa55675337d289beedac4b
+  data.tar.gz: 1895e5c8786d024696e05be452c749f1f830e538b348d30fc9deb165f92a3f87697659b5fef784a65e4eda5f4306ed3c38a7d8622ef72fd76bd5cd38e41f3b1f

data/.github/workflows/code_style_checks.yaml

@@ -6,11 +6,13 @@ on:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.markdown'
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.markdown'
 
 jobs:
   rubocop:

data/.github/workflows/tests.yaml

@@ -6,11 +6,13 @@ on:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.markdown'
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.markdown'
 
 jobs:
   unit_tests:

data/CHANGELOG.markdown

@@ -1,4 +1,18 @@
 
+## [v0.17.1] - 2024-10-06
+
+[v0.17.1]: https://github.com/egonSchiele/contracts.ruby/compare/v0.17...v0.17.1
+
+- Bugfix: Fix keyword arguments contract when used with optional positional arguments - [PikachuEXE](https://github.com/PikachuEXE) [#305](https://github.com/egonSchiele/contracts.ruby/pull/305)
+- Enhancement: Always load version.rb, suppress legacy deprecation warning - [Vlad Pisanov](https://github.com/vlad-pisanov) [#301](https://github.com/egonSchiele/contracts.ruby/pull/306)
+- Enhancement: Update doc & spec about deprecated `Fixnum` to `Integer` - [PikachuEXE](https://github.com/PikachuEXE) [#301](https://github.com/egonSchiele/contracts.ruby/pull/301)
+
+## [v0.17] - 2021-09-28
+
+[v0.17]: https://github.com/egonSchiele/contracts.ruby/compare/v0.16.1...v0.17
+
+- Update implementation & spec to be 3.0 compatible **Support for Ruby 2 has been discontinued** - [PikachuEXE](https://github.com/PikachuEXE) [#295](https://github.com/egonSchiele/contracts.ruby/pull/295)
+
 ## [v0.16.1] - 2021-04-17
 
 [v0.16.1]: https://github.com/egonSchiele/contracts.ruby/compare/v0.16.0...v0.16.1
@@ -20,7 +34,7 @@
 [v0.15.0]: https://github.com/egonSchiele/contracts.ruby/compare/v0.14.0...v0.15.0
 
 - Bugfix: Func contract's return value isn't enforced with blocks - [Piotr Szmielew](https://github.com/esse) [#251](https://github.com/egonSchiele/contracts.ruby/pull/251)
-- Bugfx: Fix contracts used in AR-models - [Gert Goet](https://github.com/eval) [#237](https://github.com/egonSchiele/contracts.ruby/pull/237)
+- Bugfix: Fix contracts used in AR-models - [Gert Goet](https://github.com/eval) [#237](https://github.com/egonSchiele/contracts.ruby/pull/237)
 
 ## [v0.14.0] - 2016-04-26
 

data/features/advanced/pattern_matching.feature

@@ -0,0 +1,133 @@
+Feature: Method Overloading
+
+  You can use contracts for method overloading! This is commonly called "pattern matching" in functional programming languages.
+
+  ```ruby
+  Contract 1 => 1
+  def fact x
+    x
+  end
+
+  Contract C::Num => C::Num
+  def fact x
+    x * fact(x - 1)
+  end
+  ```
+
+  Background:
+    Given a file named "method_overloading_with_positional_args_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract 1 => 1
+      def fact(x)
+        x
+      end
+
+      Contract C::Num => C::Num
+      def fact(x)
+        x * fact(x - 1)
+      end
+    end
+    """
+
+    Given a file named "method_overloading_with_keyword_args_usage.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::KeywordArgs[age: Integer, size: Symbol] => String
+      def speak(age:, size:)
+        "age: #{age} size: #{size}"
+      end
+
+      Contract C::KeywordArgs[sound: String] => String
+      def speak(sound:)
+        "sound: #{sound}"
+      end
+    end
+    """
+
+  Scenario: Positional Args Method 1
+    Given a file named "positional_args_method_1.rb" with:
+    """ruby
+    require "./method_overloading_with_positional_args_usage"
+    puts Example.new.fact(1)
+    """
+    When I run `ruby positional_args_method_1.rb`
+    Then the output should contain:
+    """
+    1
+    """
+
+  Scenario: Positional Args Method 2
+    Given a file named "positional_args_method_2.rb" with:
+    """ruby
+    require "./method_overloading_with_positional_args_usage"
+    puts Example.new.fact(4)
+    """
+    When I run `ruby positional_args_method_2.rb`
+    Then the output should contain:
+    """
+    24
+    """
+
+  Scenario: Keyword Args Method 1
+    Given a file named "keyword_args_method_1.rb" with:
+    """ruby
+    require "./method_overloading_with_keyword_args_usage"
+    puts Example.new.speak(age: 5, size: :large)
+    """
+    When I run `ruby keyword_args_method_1.rb`
+    Then the output should contain:
+    """
+    age: 5 size: large
+    """
+
+  Scenario: Keyword Args Method 2
+    Given a file named "keyword_args_method_2.rb" with:
+    """ruby
+    require "./method_overloading_with_keyword_args_usage"
+    puts Example.new.speak(sound: "woof")
+    """
+    When I run `ruby keyword_args_method_2.rb`
+    Then the output should contain:
+    """
+    sound: woof
+    """
+
+  Scenario: Incorrect Positional Args Method
+    Given a file named "incorrect_positional_args_method.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      # Notice that this method's contract is wider than the one below
+      # This would cause this method to be called every time but never the one below
+      Contract C::Num => C::Num
+      def fact(x)
+        x * fact(x - 1)
+      end
+
+      Contract 1 => 1
+      def fact(x)
+        x
+      end
+    end
+    puts Example.new.fact(4)
+    """
+    When I run `ruby incorrect_positional_args_method.rb`
+    Then the output should contain:
+    """
+    stack level too deep (SystemStackError)
+    """

data/lib/contracts/method_handler.rb

@@ -174,8 +174,10 @@ https://github.com/egonSchiele/contracts.ruby/issues
 
     def validate_pattern_matching!
       new_args_contract = decorator.args_contracts
+      new_kargs_contract = decorator.kargs_contract
       matched = decorated_methods.select do |contract|
-        contract.args_contracts == new_args_contract
+        contract.args_contracts == new_args_contract &&
+          contract.kargs_contract == new_kargs_contract
       end
 
       return if matched.empty?

data/lib/contracts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Contracts
-  VERSION = "0.17.1"
+  VERSION = "0.17.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.2
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-05 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies: []
 description: This library provides contracts for Ruby. Contracts let you clearly express
   how your code behaves, and free you from writing tons of boilerplate, defensive
@@ -40,6 +40,7 @@ files:
 - cucumber.yml
 - dependabot.yml
 - features/README.md
+- features/advanced/pattern_matching.feature
 - features/basics/functype.feature
 - features/basics/pretty-print.feature
 - features/basics/simple_example.feature