Class: Contracts::Builtin::Optional

Inherits:
CallableClass show all
Defined in:
lib/contracts/builtin_contracts.rb

Overview

Use this for specifying optional keyword argument Example: Optional[Num]

Constant Summary collapse

UNABLE_TO_USE_OUTSIDE_OF_OPT_HASH = 
"Unable to use Optional contract outside of KeywordArgs contract".freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CallableClass

[]

Constructor Details

#initialize(contract) ⇒ Optional

Returns a new instance of Optional.



486
487
488
489
 
# File 'lib/contracts/builtin_contracts.rb', line 486

def initialize(contract)
  @contract = contract
  @within_opt_hash = false
end

Class Method Details

._valid?(hash, key, contract) ⇒ Boolean

Returns:

  • (Boolean) 


480
481
482
483
484
 
# File 'lib/contracts/builtin_contracts.rb', line 480

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

Instance Method Details

#inspect ⇒ Object 



505
506
507
 
# File 'lib/contracts/builtin_contracts.rb', line 505

def inspect
  to_s
end

#to_s ⇒ Object 



501
502
503
 
# File 'lib/contracts/builtin_contracts.rb', line 501

def to_s
  "Optional[#{formatted_contract}]"
end

#valid?(value) ⇒ Boolean

Returns:

  • (Boolean) 


496
497
498
499
 
# File 'lib/contracts/builtin_contracts.rb', line 496

def valid?(value)
  ensure_within_opt_hash
  Contract.valid?(value, contract)
end

#within_opt_hash! ⇒ Object 



491
492
493
494
 
# File 'lib/contracts/builtin_contracts.rb', line 491

def within_opt_hash!
  @within_opt_hash = true
  self
end