contracts 0.16.1 → 0.17.1

data/lib/contracts/builtin_contracts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "contracts/formatters"
 require "set"
 
@@ -30,35 +32,35 @@ module Contracts
     # Check that an argument is a positive number.
     class Pos
       def self.valid? val
-        val && val.is_a?(Numeric) && val > 0
+        val.is_a?(Numeric) && val.positive?
       end
     end
 
     # Check that an argument is a negative number.
     class Neg
       def self.valid? val
-        val && val.is_a?(Numeric) && val < 0
+        val.is_a?(Numeric) && val.negative?
       end
     end
 
     # Check that an argument is an +Integer+.
     class Int
       def self.valid? val
-        val && val.is_a?(Integer)
+        val.is_a?(Integer)
       end
     end
 
     # Check that an argument is a natural number (includes zero).
     class Nat
       def self.valid? val
-        val && val.is_a?(Integer) && val >= 0
+        val.is_a?(Integer) && val >= 0
       end
     end
 
     # Check that an argument is a positive natural number (excludes zero).
     class NatPos
       def self.valid? val
-        val && val.is_a?(Integer) && val > 0
+        val.is_a?(Integer) && val.positive?
       end
     end
 
@@ -93,9 +95,10 @@ module Contracts
 
     # Takes a variable number of contracts.
     # The contract passes if any of the contracts pass.
-    # Example: <tt>Or[Fixnum, Float]</tt>
+    # Example: <tt>Or[Integer, Float]</tt>
     class Or < CallableClass
       def initialize(*vals)
+        super()
         @vals = vals
       end
 
@@ -107,17 +110,20 @@ module Contracts
       end
 
       def to_s
+        # rubocop:disable Style/StringConcatenation
         @vals[0, @vals.size-1].map do |x|
           InspectWrapper.create(x)
         end.join(", ") + " or " + InspectWrapper.create(@vals[-1]).to_s
+        # rubocop:enable Style/StringConcatenation
       end
     end
 
     # Takes a variable number of contracts.
     # The contract passes if exactly one of those contracts pass.
-    # Example: <tt>Xor[Fixnum, Float]</tt>
+    # Example: <tt>Xor[Integer, Float]</tt>
     class Xor < CallableClass
       def initialize(*vals)
+        super()
         @vals = vals
       end
 
@@ -130,17 +136,20 @@ module Contracts
       end
 
       def to_s
+        # rubocop:disable Style/StringConcatenation
         @vals[0, @vals.size-1].map do |x|
           InspectWrapper.create(x)
         end.join(", ") + " xor " + InspectWrapper.create(@vals[-1]).to_s
+        # rubocop:enable Style/StringConcatenation
       end
     end
 
     # Takes a variable number of contracts.
     # The contract passes if all contracts pass.
-    # Example: <tt>And[Fixnum, Float]</tt>
+    # Example: <tt>And[Integer, Float]</tt>
     class And < CallableClass
       def initialize(*vals)
+        super()
         @vals = vals
       end
 
@@ -152,9 +161,11 @@ module Contracts
       end
 
       def to_s
+        # rubocop:disable Style/StringConcatenation
         @vals[0, @vals.size-1].map do |x|
           InspectWrapper.create(x)
         end.join(", ") + " and " + InspectWrapper.create(@vals[-1]).to_s
+        # rubocop:enable Style/StringConcatenation
       end
     end
 
@@ -164,6 +175,7 @@ module Contracts
     # Example: <tt>RespondTo[:password, :credit_card]</tt>
     class RespondTo < CallableClass
       def initialize(*meths)
+        super()
         @meths = meths
       end
 
@@ -185,6 +197,7 @@ module Contracts
     # Example: <tt>Send[:valid?]</tt>
     class Send < CallableClass
       def initialize(*meths)
+        super()
         @meths = meths
       end
 
@@ -204,11 +217,12 @@ module Contracts
     # Example: <tt>Exactly[Numeric]</tt>
     class Exactly < CallableClass
       def initialize(cls)
+        super()
         @cls = cls
       end
 
       def valid?(val)
-        val.class == @cls
+        val.instance_of?(@cls)
       end
 
       def to_s
@@ -222,6 +236,7 @@ module Contracts
     # Example: <tt>Enum[:a, :b, :c]</tt>?
     class Enum < CallableClass
       def initialize(*vals)
+        super()
         @vals = vals
       end
 
@@ -235,6 +250,7 @@ module Contracts
     # Example: <tt>Eq[Class]</tt>
     class Eq < CallableClass
       def initialize(value)
+        super()
         @value = value
       end
 
@@ -252,6 +268,7 @@ module Contracts
     # Example: <tt>Not[nil]</tt>
     class Not < CallableClass
       def initialize(*vals)
+        super()
         @vals = vals
       end
 
@@ -275,12 +292,14 @@ module Contracts
     # Example: <tt>CollectionOf[Array, Num]</tt>
     class CollectionOf < CallableClass
       def initialize(collection_class, contract)
+        super()
         @collection_class = collection_class
         @contract = contract
       end
 
       def valid?(vals)
         return false unless vals.is_a?(@collection_class)
+
         vals.all? do |val|
           res, _ = Contract.valid?(val, @contract)
           res
@@ -298,7 +317,7 @@ module Contracts
         end
 
         def new(contract)
-          @before_new && @before_new.call
+          @before_new&.call
           CollectionOf.new(@collection_class, contract)
         end
 
@@ -324,7 +343,9 @@ module Contracts
     # Example: <tt>Args[Or[String, Num]]</tt>
     class Args < CallableClass
       attr_reader :contract
+
       def initialize(contract)
+        super()
         @contract = contract
       end
 
@@ -343,6 +364,7 @@ module Contracts
     # Example: <tt>RangeOf[Nat]</tt>, <tt>RangeOf[Date]</tt>, ...
     class RangeOf < CallableClass
       def initialize(contract)
+        super()
         @contract = contract
       end
 
@@ -364,6 +386,7 @@ module Contracts
       INVALID_KEY_VALUE_PAIR = "You should provide only one key-value pair to HashOf contract"
 
       def initialize(key, value = nil)
+        super()
         if value
           @key   = key
           @value = value
@@ -376,6 +399,7 @@ module Contracts
 
       def valid?(hash)
         return false unless hash.is_a?(Hash)
+
         keys_match = hash.keys.map { |k| Contract.valid?(k, @key) }.all?
         vals_match = hash.values.map { |v| Contract.valid?(v, @value) }.all?
 
@@ -400,6 +424,7 @@ module Contracts
       attr_reader :contract_hash
 
       def initialize(contract_hash)
+        super()
         @contract_hash = contract_hash
       end
 
@@ -417,12 +442,14 @@ module Contracts
     # Example: <tt>KeywordArgs[ e: Range, f: Optional[Num] ]</tt>
     class KeywordArgs < CallableClass
       def initialize(options)
+        super()
         @options = options
       end
 
       def valid?(hash)
         return false unless hash.is_a?(Hash)
         return false unless hash.keys - options.keys == []
+
         options.all? do |key, contract|
           Optional._valid?(hash, key, contract)
         end
@@ -445,6 +472,7 @@ module Contracts
     # Example: <tt>DescendantOf[ e: Range, f: Optional[Num] ]</tt>
     class DescendantOf < CallableClass
       def initialize(parent_class)
+        super()
         @parent_class = parent_class
       end
 
@@ -473,11 +501,13 @@ module Contracts
 
       def self._valid?(hash, key, contract)
         return Contract.valid?(hash[key], contract) unless contract.is_a?(Optional)
+
         contract.within_opt_hash!
         !hash.key?(key) || Contract.valid?(hash[key], contract)
       end
 
       def initialize(contract)
+        super()
         @contract = contract
         @within_opt_hash = false
       end
@@ -506,6 +536,7 @@ module Contracts
 
       def ensure_within_opt_hash
         return if within_opt_hash
+
         fail ArgumentError, UNABLE_TO_USE_OUTSIDE_OF_OPT_HASH
       end
 
@@ -531,7 +562,9 @@ module Contracts
     # Example: <tt>Func[Num => Num] # the function should take a number and return a number</tt>
     class Func < CallableClass
       attr_reader :contracts
+
       def initialize(*contracts)
+        super()
         @contracts = contracts
       end
     end

data/lib/contracts/call_with.rb

@@ -1,17 +1,31 @@
+# frozen_string_literal: true
+
 module Contracts
   module CallWith
-    def call_with(this, *args, &blk)
-      call_with_inner(false, this, *args, &blk)
+    def call_with(this, *args, **kargs, &blk)
+      call_with_inner(false, this, *args, **kargs, &blk)
     end
 
-    def call_with_inner(returns, this, *args, &blk)
+    def call_with_inner(returns, this, *args, **kargs, &blk)
       args << blk if blk
 
       # Explicitly append blk=nil if nil != Proc contract violation anticipated
       nil_block_appended = maybe_append_block!(args, blk)
 
-      # Explicitly append options={} if Hash contract is present
-      maybe_append_options!(args, blk)
+      if @kargs_validator && !@kargs_validator[kargs]
+        data = {
+          arg:          kargs,
+          contract:     kargs_contract,
+          class:        klass,
+          method:       method,
+          contracts:    self,
+          arg_pos:      :keyword,
+          total_args:   args.size,
+          return_value: false,
+        }
+        return ParamContractError.new("as return value", data) if returns
+        return unless Contract.failure_callback(data)
+      end
 
       # Loop forward validating the arguments up to the splat (if there is one)
       (@args_contract_index || args.size).times do |i|
@@ -20,14 +34,16 @@ module Contracts
         validator = @args_validators[i]
 
         unless validator && validator[arg]
-          data = {:arg => arg,
-                  :contract => contract,
-                  :class => klass,
-                  :method => method,
-                  :contracts => self,
-                  :arg_pos => i+1,
-                  :total_args => args.size,
-                  :return_value => false}
+          data = {
+            arg:          arg,
+            contract:     contract,
+            class:        klass,
+            method:       method,
+            contracts:    self,
+            arg_pos:      i+1,
+            total_args:   args.size,
+            return_value: false,
+          }
           return ParamContractError.new("as return value", data) if returns
           return unless Contract.failure_callback(data)
         end
@@ -57,14 +73,18 @@ module Contracts
           validator = @args_validators[args_contracts.size - 1 - j]
 
           unless validator && validator[arg]
-            return unless Contract.failure_callback(:arg => arg,
-                                                    :contract => contract,
-                                                    :class => klass,
-                                                    :method => method,
-                                                    :contracts => self,
-                                                    :arg_pos => i-1,
-                                                    :total_args => args.size,
-                                                    :return_value => false)
+            # rubocop:disable Style/SoleNestedConditional
+            return unless Contract.failure_callback({
+              :arg => arg,
+              :contract => contract,
+              :class => klass,
+              :method => method,
+              :contracts => self,
+              :arg_pos => i - 1,
+              :total_args => args.size,
+              :return_value => false,
+            })
+            # rubocop:enable Style/SoleNestedConditional
           end
 
           if contract.is_a?(Contracts::Func)
@@ -78,22 +98,24 @@ module Contracts
       args.slice!(-1) if blk || nil_block_appended
       result = if method.respond_to?(:call)
                  # proc, block, lambda, etc
-                 method.call(*args, &blk)
+                 method.call(*args, **kargs, &blk)
                else
                  # original method name reference
                  # Don't reassign blk, else Travis CI shows "stack level too deep".
                  target_blk = blk
-                 target_blk = lambda { |*params| blk.call(*params) } if blk && blk.is_a?(Contract)
-                 method.send_to(this, *args, &target_blk)
+                 target_blk = lambda { |*params| blk.call(*params) } if blk.is_a?(Contract)
+                 method.send_to(this, *args, **kargs, &target_blk)
                end
 
       unless @ret_validator[result]
-        Contract.failure_callback(:arg => result,
-                                  :contract => ret_contract,
-                                  :class => klass,
-                                  :method => method,
-                                  :contracts => self,
-                                  :return_value => true)
+        Contract.failure_callback({
+          arg:          result,
+          contract:     ret_contract,
+          class:        klass,
+          method:       method,
+          contracts:    self,
+          return_value: true,
+        })
       end
 
       this.verify_invariants!(method) if this.respond_to?(:verify_invariants!)

data/lib/contracts/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Core
     def self.included(base)
@@ -25,7 +27,7 @@ module Contracts
       # NOTE: Workaround for `defined?(super)` bug in ruby 1.9.2
       # source: http://stackoverflow.com/a/11181685
       # bug: https://bugs.ruby-lang.org/issues/6644
-      base.class_eval <<-RUBY
+      base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         # TODO: deprecate
         # Required when contracts are included in global scope
         def Contract(*args)

data/lib/contracts/decorators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module MethodDecorators
     def self.extended(klass)
@@ -25,6 +27,7 @@ module Contracts
     class << self; attr_accessor :decorators; end
 
     def self.inherited(klass)
+      super
       name = klass.name.gsub(/^./) { |m| m.downcase }
 
       return if name =~ /^[^A-Za-z_]/ || name =~ /[^0-9A-Za-z_]/
@@ -33,11 +36,11 @@ module Contracts
       # make a new method that is the name of your decorator.
       # that method accepts random args and a block.
       # inside, `decorate` is called with those params.
-      MethodDecorators.module_eval <<-ruby_eval, __FILE__, __LINE__ + 1
+      MethodDecorators.module_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
         def #{klass}(*args, &blk)
           ::Contracts::Engine.fetch_from(self).decorate(#{klass}, *args, &blk)
         end
-      ruby_eval
+      RUBY_EVAL
     end
 
     def initialize(klass, method)

data/lib/contracts/engine/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Engine
     # Contracts engine
@@ -90,7 +92,7 @@ module Contracts
       def nearest_decorated_ancestor
         current = klass
         current_engine = self
-        ancestors = current.ancestors[1..-1]
+        ancestors = current.ancestors[1..]
 
         while current && current_engine && !current_engine.decorated_methods?
           current = ancestors.shift
@@ -109,8 +111,7 @@ module Contracts
       end
 
       # No-op because it is safe to add decorators to normal classes
-      def validate!
-      end
+      def validate!; end
 
       def pop_decorators
         decorators.tap { clear_decorators }

data/lib/contracts/engine/eigenclass.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Engine
     # Special case of contracts engine for eigenclasses
@@ -27,8 +29,7 @@ module Contracts
       end
 
       # No-op for eigenclasses
-      def set_eigenclass_owner
-      end
+      def set_eigenclass_owner; end
 
       # Fetches just eigenclasses decorators
       def all_decorators

data/lib/contracts/engine/target.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Engine
     # Represents class in question

data/lib/contracts/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "contracts/engine/base"
 require "contracts/engine/target"
 require "contracts/engine/eigenclass"

data/lib/contracts/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @private
 # Base class for Contract errors
 #
@@ -65,6 +67,7 @@ module Contracts
     alias_method :to_s, :message
 
     def initialize(message = DEFAULT_MESSAGE)
+      super
       @message = message
     end
   end

data/lib/contracts/formatters.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/RedundantRequireStatement
+# If removed, spec/module_spec fails
 require "pp"
+# rubocop:enable Lint/RedundantRequireStatement
 
 module Contracts
   # A namespace for classes related to formatting.
@@ -7,18 +12,19 @@ module Contracts
     class Expected
       # @param full [Boolean] if false only unique `to_s` values will be output,
       #   non unique values become empty string.
-      def initialize(contract, full = true)
+      def initialize(contract, full: true)
         @contract, @full = contract, full
       end
 
       # Formats any type of Contract.
       def contract(contract = @contract)
-        if contract.is_a?(Hash)
+        case contract
+        when Hash
           hash_contract(contract)
-        elsif contract.is_a?(Array)
+        when Array
           array_contract(contract)
         else
-          InspectWrapper.create(contract, @full)
+          InspectWrapper.create(contract, full: @full)
         end
       end
 
@@ -26,14 +32,14 @@ module Contracts
       def hash_contract(hash)
         @full = true # Complex values output completely, overriding @full
         hash.inject({}) do |repr, (k, v)|
-          repr.merge(k => InspectWrapper.create(contract(v), @full))
+          repr.merge(k => InspectWrapper.create(contract(v), full: @full))
         end
       end
 
       # Formats Array contracts.
       def array_contract(array)
         @full = true
-        array.map { |v| InspectWrapper.create(contract(v), @full) }
+        array.map { |v| InspectWrapper.create(contract(v), full: @full) }
       end
     end
 
@@ -42,8 +48,8 @@ module Contracts
     module InspectWrapper
       # InspectWrapper is a factory, will never be an instance
       # @return [ClassInspectWrapper, ObjectInspectWrapper]
-      def self.create(value, full = true)
-        if value.class == Class
+      def self.create(value, full: true)
+        if value.instance_of?(Class)
           ClassInspectWrapper
         else
           ObjectInspectWrapper
@@ -66,6 +72,7 @@ module Contracts
         return @value.inspect if empty_val?
         return @value.to_s if plain?
         return delim(@value.to_s) if useful_to_s?
+
         useful_inspect
       end
 
@@ -96,7 +103,7 @@ module Contracts
       end
 
       def useful_to_s?
-        # Useless to_s value or no custom to_s behavious defined
+        # Useless to_s value or no custom to_s behaviour defined
         !empty_to_s? && custom_to_s?
       end
 
@@ -125,7 +132,7 @@ module Contracts
       include InspectWrapper
 
       def custom_to_s?
-        !@value.to_s.match(/#\<\w+:.+\>/)
+        !@value.to_s.match(/#<\w+:.+>/)
       end
 
       def useful_inspect

data/lib/contracts/invariants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contracts
   module Invariants
     def self.included(base)
@@ -46,10 +48,12 @@ module Contracts
       def check_on(target, method)
         return if target.instance_eval(&@condition)
 
-        self.class.failure_callback(:expected => expected,
-                                    :actual => false,
-                                    :target => target,
-                                    :method => method)
+        self.class.failure_callback({
+          expected: expected,
+          actual:   false,
+          target:   target,
+          method:   method,
+        })
       end
 
       def self.failure_callback(data)