contracts 0.16.1 → 0.17.1

data/lib/contracts/method_handler.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Contracts
   # Handles class and instance methods addition
   # Represents single such method
   class MethodHandler
     METHOD_REFERENCE_FACTORY = {
       :class_methods => SingletonMethodReference,
-      :instance_methods => MethodReference
+      :instance_methods => MethodReference,
     }
 
     RAW_METHOD_STRATEGY = {
       :class_methods => lambda { |target, name| target.method(name) },
-      :instance_methods => lambda { |target, name| target.instance_method(name) }
+      :instance_methods => lambda { |target, name| target.instance_method(name) },
     }
 
     # Creates new instance of MethodHandler
@@ -78,11 +80,13 @@ module Contracts
 
     def pattern_matching?
       return @_pattern_matching if defined?(@_pattern_matching)
+
       @_pattern_matching = decorated_methods.any? { |x| x.method != method_reference }
     end
 
     def mark_pattern_matching_decorators
       return unless pattern_matching?
+
       decorated_methods.each(&:pattern_match!)
     end
 
@@ -107,13 +111,13 @@ module Contracts
       current_engine = engine
 
       # We are gonna redefine original method here
-      method_reference.make_definition(target) do |*args, &blk|
+      method_reference.make_definition(target) do |*args, **kargs, &blk|
         engine = current_engine.nearest_decorated_ancestor
 
         # If we weren't able to find any ancestor that has decorated methods
         # FIXME : this looks like untested code (commenting it out doesn't make specs red)
         unless engine
-          fail "Couldn't find decorator for method " + self.class.name + ":#{name}.\nDoes this method look correct to you? If you are using contracts from rspec, rspec wraps classes in it's own class.\nLook at the specs for contracts.ruby as an example of how to write contracts in this case."
+          fail "Couldn't find decorator for method #{self.class.name}:#{name}.\nDoes this method look correct to you? If you are using contracts from rspec, rspec wraps classes in it's own class.\nLook at the specs for contracts.ruby as an example of how to write contracts in this case."
         end
 
         # Fetch decorated methods out of the contracts engine
@@ -130,17 +134,20 @@ module Contracts
         last_error = nil
 
         decorated_methods.each do |decorated_method|
-          result = decorated_method.call_with_inner(true, self, *args, &blk)
+          result = decorated_method.call_with_inner(true, self, *args, **kargs, &blk)
           return result unless result.is_a?(ParamContractError)
+
           last_error = result
         end
 
         begin
-          if ::Contract.failure_callback(last_error.data, false)
-            decorated_methods.last.call_with_inner(false, self, *args, &blk)
+          if ::Contract.failure_callback(last_error&.data, use_pattern_matching: false)
+            decorated_methods.last.call_with_inner(false, self, *args, **kargs, &blk)
           end
+          # rubocop:disable Naming/RescuedExceptionsVariableName
         rescue expected_error => final_error
           raise final_error.to_contract_error
+          # rubocop:enable Naming/RescuedExceptionsVariableName
         end
       end
     end
@@ -173,7 +180,8 @@ https://github.com/egonSchiele/contracts.ruby/issues
 
       return if matched.empty?
 
-      fail ContractError.new(%{
+      fail ContractError.new(
+        %{
 It looks like you are trying to use pattern-matching, but
 multiple definitions for function '#{method_name}' have the same
 contract for input parameters:
@@ -181,7 +189,9 @@ contract for input parameters:
 #{(matched + [decorator]).map(&:to_s).join("\n")}
 
 Each definition needs to have a different contract for the parameters.
-      }, {})
+        },
+        {},
+      )
     end
   end
 end

data/lib/contracts/method_reference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   # MethodReference represents original method reference that was
   # decorated by contracts.ruby. Used for instance methods.
@@ -39,8 +41,8 @@ module Contracts
 
     # Calls original method on specified `this` argument with
     # specified arguments `args` and block `&blk`.
-    def send_to(this, *args, &blk)
-      this.send(aliased_name, *args, &blk)
+    def send_to(this, *args, **kargs, &blk)
+      this.send(aliased_name, *args, **kargs, &blk)
     end
 
     private

data/lib/contracts/support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Support
     class << self
@@ -8,7 +10,7 @@ module Contracts
         if file.nil? || line.nil?
           ""
         else
-          file + ":" + line.to_s
+          "#{file}:#{line}"
         end
       end
 
@@ -45,7 +47,7 @@ module Contracts
       def indent_string(string, amount)
         string.gsub(
           /^(?!$)/,
-          (string[/^[ \t]/] || " ") * amount
+          (string[/^[ \t]/] || " ") * amount,
         )
       end
 

data/lib/contracts/validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Validators
     DEFAULT_VALIDATOR_STRATEGIES = {
@@ -9,6 +11,7 @@ module Contracts
       Array => lambda do |contract|
         lambda do |arg|
           return false unless arg.is_a?(Array) && arg.length == contract.length
+
           arg.zip(contract).all? do |_arg, _contract|
             Contract.valid?(_arg, _contract)
           end
@@ -19,6 +22,7 @@ module Contracts
       Hash => lambda do |contract|
         lambda do |arg|
           return false unless arg.is_a?(Hash)
+
           contract.keys.all? do |k|
             Contract.valid?(arg[k], contract[k])
           end
@@ -59,7 +63,7 @@ module Contracts
 
       :default => lambda do |contract|
         lambda { |arg| contract == arg }
-      end
+      end,
     }.freeze
 
     # Allows to override validator with custom one.
@@ -90,7 +94,7 @@ module Contracts
             else
               if contract.respond_to? :valid?
                 :valid
-              elsif klass == Class || klass == Module
+              elsif [Class, Module].include?(klass)
                 :class
               else
                 :default

data/lib/contracts/version.rb

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

data/lib/contracts.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require "contracts/version"
 require "contracts/attrs"
 require "contracts/builtin_contracts"
 require "contracts/decorators"
@@ -50,8 +53,10 @@ class Contract < Contracts::Decorator
     end
   end
 
-  attr_reader :args_contracts, :ret_contract, :klass, :method
+  attr_reader :args_contracts, :kargs_contract, :ret_contract, :klass, :method
+
   def initialize(klass, method, *contracts)
+    super(klass, method)
     unless contracts.last.is_a?(Hash)
       unless contracts.one?
         fail %{
@@ -65,6 +70,9 @@ class Contract < Contracts::Decorator
 
     # internally we just convert that return value syntax back to an array
     @args_contracts = contracts[0, contracts.size - 1] + contracts[-1].keys
+    # Extract contract for keyword arguments
+    @kargs_contract = args_contracts.find { |c| c.is_a?(Contracts::Builtin::KeywordArgs) }
+    args_contracts.delete(kargs_contract) if kargs_contract
 
     @ret_contract = contracts[-1].values[0]
 
@@ -72,6 +80,8 @@ class Contract < Contracts::Decorator
       Contract.make_validator(contract)
     end
 
+    @kargs_validator = kargs_contract ? Contract.make_validator(kargs_contract) : nil
+
     @args_contract_index = args_contracts.index do |contract|
       contract.is_a? Contracts::Args
     end
@@ -89,21 +99,11 @@ class Contract < Contracts::Decorator
 
     # ====
 
-    # == @has_options_contract
-    last_contract = args_contracts.last
-    penultimate_contract = args_contracts[-2]
-    @has_options_contract = if @has_proc_contract
-                              penultimate_contract.is_a?(Hash) || penultimate_contract.is_a?(Contracts::Builtin::KeywordArgs)
-                            else
-                              last_contract.is_a?(Hash) || last_contract.is_a?(Contracts::Builtin::KeywordArgs)
-                            end
-    # ===
-
     @klass, @method = klass, method
   end
 
-  def pretty_contract c
-    c.is_a?(Class) ? c.name : c.class.name
+  def pretty_contract contract
+    contract.is_a?(Class) ? contract.name : contract.class.name
   end
 
   def to_s
@@ -130,15 +130,15 @@ class Contract < Contracts::Decorator
     expected_prefix = "Expected: "
     expected_value = Contracts::Support.indent_string(
       Contracts::Formatters::Expected.new(data[:contract]).contract.pretty_inspect,
-      expected_prefix.length
+      expected_prefix.length,
     ).strip
-    expected_line = expected_prefix + expected_value + ","
+    expected_line = "#{expected_prefix}#{expected_value},"
 
     # Actual
     actual_prefix = "Actual: "
     actual_value = Contracts::Support.indent_string(
       data[:arg].pretty_inspect,
-      actual_prefix.length
+      actual_prefix.length,
     ).strip
     actual_line = actual_prefix + actual_value
 
@@ -157,16 +157,19 @@ class Contract < Contracts::Decorator
     position_value = Contracts::Support.method_position(data[:method])
     position_line = position_prefix + position_value
 
-    header +
-      "\n" +
+    [
+      header,
       Contracts::Support.indent_string(
-        [expected_line,
-         actual_line,
-         value_line,
-         contract_line,
-         position_line].join("\n"),
-        indent_amount
-      )
+        [
+          expected_line,
+          actual_line,
+          value_line,
+          contract_line,
+          position_line,
+        ].join("\n"),
+        indent_amount,
+      ),
+    ].join("\n")
   end
 
   # Callback for when a contract fails. By default it raises
@@ -182,7 +185,7 @@ class Contract < Contracts::Decorator
   #     puts failure_msg(data)
   #     exit
   #   end
-  def self.failure_callback(data, use_pattern_matching = true)
+  def self.failure_callback(data, use_pattern_matching: true)
     if data[:contracts].pattern_match? && use_pattern_matching
       return DEFAULT_FAILURE_CALLBACK.call(data)
     end
@@ -242,20 +245,9 @@ class Contract < Contracts::Decorator
   # returns true if it appended nil
   def maybe_append_block! args, blk
     return false unless @has_proc_contract && !blk &&
-        (@args_contract_index || args.size < args_contracts.size)
-    args << nil
-    true
-  end
+      (@args_contract_index || args.size < args_contracts.size)
 
-  # Same thing for when we have named params but didn't pass any in.
-  # returns true if it appended nil
-  def maybe_append_options! args, blk
-    return false unless @has_options_contract
-    if @has_proc_contract && (args_contracts[-2].is_a?(Hash) || args_contracts[-2].is_a?(Contracts::Builtin::KeywordArgs)) && !args[-2].is_a?(Hash)
-      args.insert(-2, {})
-    elsif (args_contracts[-1].is_a?(Hash) || args_contracts[-1].is_a?(Contracts::Builtin::KeywordArgs)) && !args[-1].is_a?(Hash)
-      args << {}
-    end
+    args << nil
     true
   end
 

data/spec/builtin_contracts_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe "Contracts:" do
   end
 
   describe "Num:" do
-    it "should pass for Fixnums" do
+    it "should pass for Integers" do
       passes { @o.double(2) }
     end
 
@@ -376,10 +376,6 @@ RSpec.describe "Contracts:" do
       fails { @o.hash_keywordargs(:hash => nil) }
       fails { @o.hash_keywordargs(:hash => 1) }
     end
-
-    it "should pass if a method is overloaded with non-KeywordArgs" do
-      passes { @o.person_keywordargs("name", 10) }
-    end
   end
 
   describe "Optional:" do
@@ -405,15 +401,15 @@ RSpec.describe "Contracts:" do
     end
 
     context "given a fulfilled contract" do
-      it { expect(@o.gives_max_value(:panda => 1, :bamboo => 2)).to eq(2) }
-      it { expect(@o.pretty_gives_max_value(:panda => 1, :bamboo => 2)).to eq(2) }
+      it { expect(@o.gives_max_value({ :panda => 1, :bamboo => 2 })).to eq(2) }
+      it { expect(@o.pretty_gives_max_value({ :panda => 1, :bamboo => 2 })).to eq(2) }
     end
 
     context "given an unfulfilled contract" do
-      it { fails { @o.gives_max_value(:panda => "1", :bamboo => "2") }  }
+      it { fails { @o.gives_max_value({ :panda => "1", :bamboo => "2" }) }  }
       it { fails { @o.gives_max_value(nil) } }
       it { fails { @o.gives_max_value(1) } }
-      it { fails { @o.pretty_gives_max_value(:panda => "1", :bamboo => "2") } }
+      it { fails { @o.pretty_gives_max_value({ :panda => "1", :bamboo => "2" }) } }
     end
 
     describe "#to_s" do
@@ -430,25 +426,25 @@ RSpec.describe "Contracts:" do
   describe "StrictHash:" do
     context "when given an exact correct input" do
       it "does not raise an error" do
-        passes { @o.strict_person(:name => "calvin", :age => 10) }
+        passes { @o.strict_person({ :name => "calvin", :age => 10 }) }
       end
     end
 
     context "when given an input with correct keys but wrong types" do
       it "raises an error" do
-        fails { @o.strict_person(:name => "calvin", :age => "10") }
+        fails { @o.strict_person({ :name => "calvin", :age => "10" }) }
       end
     end
 
     context "when given an input with missing keys" do
       it "raises an error" do
-        fails { @o.strict_person(:name => "calvin") }
+        fails { @o.strict_person({ :name => "calvin" }) }
       end
     end
 
     context "when given an input with extra keys" do
       it "raises an error" do
-        fails { @o.strict_person(:name => "calvin", :age => 10, :soft => true) }
+        fails { @o.strict_person({ :name => "calvin", :age => 10, :soft => true }) }
       end
     end
 

data/spec/contracts_spec.rb

@@ -349,19 +349,19 @@ RSpec.describe "Contracts:" do
 
   describe "Hashes" do
     it "should pass for exact correct input" do
-      expect { @o.person(:name => "calvin", :age => 10) }.to_not raise_error
+      expect { @o.person({ :name => "calvin", :age => 10 }) }.to_not raise_error
     end
 
     it "should pass even if some keys don't have contracts" do
-      expect { @o.person(:name => "calvin", :age => 10, :foo => "bar") }.to_not raise_error
+      expect { @o.person({ :name => "calvin", :age => 10, :foo => "bar" }) }.to_not raise_error
     end
 
     it "should fail if a key with a contract on it isn't provided" do
-      expect { @o.person(:name => "calvin") }.to raise_error(ContractError)
+      expect { @o.person({ :name => "calvin" }) }.to raise_error(ContractError)
     end
 
     it "should fail for incorrect input" do
-      expect { @o.person(:name => 50, :age => 10) }.to raise_error(ContractError)
+      expect { @o.person({ :name => 50, :age => 10 }) }.to raise_error(ContractError)
     end
   end
 
@@ -612,16 +612,19 @@ RSpec.describe "Contracts:" do
 
     it "should contain to_s representation within a Hash contract" do
       expect do
-        @o.hash_complex_contracts(:rigged => "bad")
+        @o.hash_complex_contracts({ :rigged => "bad" })
       end.to raise_error(ContractError, not_s(delim "TrueClass or FalseClass"))
     end
 
     it "should contain to_s representation within a nested Hash contract" do
       expect do
-        @o.nested_hash_complex_contracts(:rigged => true,
-                                         :contents => {
-                                           :kind => 0,
-                                           :total => 42 })
+        @o.nested_hash_complex_contracts({
+          :rigged => true,
+          :contents => {
+            :kind => 0,
+            :total => 42,
+          },
+        })
       end.to raise_error(ContractError, not_s(delim "String or Symbol"))
     end
 

data/spec/fixtures/fixtures.rb

@@ -100,11 +100,11 @@ class GenericExample
     end
   end
 
-  Contract ({ :name => String, :age => Fixnum }) => nil
+  Contract ({ :name => String, :age => Integer }) => nil
   def person(data)
   end
 
-  Contract C::StrictHash[{ :name => String, :age => Fixnum }] => nil
+  Contract C::StrictHash[{ :name => String, :age => Integer }] => nil
   def strict_person(data)
   end
 
@@ -119,17 +119,12 @@ class GenericExample
   def nested_hash_complex_contracts(data)
   end
 
-  Contract C::KeywordArgs[:name => String, :age => Fixnum] => nil
-  def person_keywordargs(data)
-  end
-
-  # Testing overloaded method
-  Contract String, Fixnum => nil
-  def person_keywordargs(name, age)
+  Contract C::KeywordArgs[:name => String, :age => Integer] => nil
+  def person_keywordargs(name: "name", age: 10)
   end
 
   Contract C::KeywordArgs[:hash => C::HashOf[Symbol, C::Num]] => nil
-  def hash_keywordargs(data)
+  def hash_keywordargs(hash:)
   end
 
   Contract (/foo/) => nil
@@ -534,30 +529,30 @@ class MyBirthday
     @month = month
   end
 
-  Contract C::None => Fixnum
+  Contract C::None => Integer
   def silly_next_day!
     self.day += 1
   end
 
-  Contract C::None => Fixnum
+  Contract C::None => Integer
   def silly_next_month!
     self.month += 1
   end
 
-  Contract C::None => Fixnum
+  Contract C::None => Integer
   def clever_next_day!
     return clever_next_month! if day == 31
     self.day += 1
   end
 
-  Contract C::None => Fixnum
+  Contract C::None => Integer
   def clever_next_month!
     return next_year! if month == 12
     self.month += 1
     self.day = 1
   end
 
-  Contract C::None => Fixnum
+  Contract C::None => Integer
   def next_year!
     self.month = 1
     self.day = 1
@@ -615,7 +610,7 @@ with_enabled_no_contracts do
       body + "!"
     end
 
-    Contract Fixnum, String => String
+    Contract Integer, String => String
     def on_response(status, body)
       "error #{status}: #{body}"
     end

data/spec/override_validators_spec.rb

@@ -30,15 +30,15 @@ RSpec.describe Contract do
       obj = klass.new
 
       expect do
-        obj.something(:a => 35, :b => "hello")
+        obj.something({ :a => 35, :b => "hello" })
       end.to raise_error(ContractError)
 
       expect do
-        obj.something(
+        obj.something({
           :a => 35,
           :b => "hello",
           :it_is_a_hash => true
-        )
+        })
       end.not_to raise_error
     end
 

data/spec/ruby_version_specific/contracts_spec_2.0.rb

@@ -1,10 +1,10 @@
 class GenericExample
-  Contract C::Args[String], { repeat: C::Maybe[C::Num] } => C::ArrayOf[String]
+  Contract C::Args[String], C::KeywordArgs[ repeat: C::Maybe[C::Num] ] => C::ArrayOf[String]
   def splat_then_optional_named(*vals, repeat: 2)
     vals.map { |v| v * repeat }
   end
 
-  Contract ({foo: C::Nat}) => nil
+  Contract C::KeywordArgs[ foo: C::Nat ] => nil
   def nat_test_with_kwarg(foo: 10)
   end
 

data/spec/validators_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe "Contract validators" do
 
     describe "within a hash" do
       it "should pass for a matching string" do
-        expect { o.hash_containing_foo(:host => "foo.example.org") }.to_not raise_error
+        expect { o.hash_containing_foo({ :host => "foo.example.org" }) }.to_not raise_error
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.1
 platform: ruby
 authors:
 - Aditya Bhargava
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2024-10-05 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
@@ -56,6 +56,7 @@ files:
 - features/builtin_contracts/hash_of.feature
 - features/builtin_contracts/int.feature
 - features/builtin_contracts/keyword_args.feature
+- features/builtin_contracts/keyword_args_with_optional_positional_args.feature
 - features/builtin_contracts/maybe.feature
 - features/builtin_contracts/nat.feature
 - features/builtin_contracts/nat_pos.feature
@@ -111,9 +112,7 @@ homepage: https://github.com/egonSchiele/contracts.ruby
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: "\n    0.16.x will be the supporting Ruby 2.x and be feature
-  frozen (only fixes will be released)\n    For Ruby 3.x use 0.17.x or later (might
-  not be released yet)\n  "
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,15 +120,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Contracts for Ruby.
 test_files: []