Class: Playbook::Props::Base

Inherits:
Object
  • Object
show all
Defined in:
app/pb_kits/playbook/props/base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default: nil, required: false) ⇒ Base

Returns a new instance of Base.



10
11
12
13
 
# File 'app/pb_kits/playbook/props/base.rb', line 10

def initialize(default: nil, required: false)
  @default = default
  @required = required
end

Instance Attribute Details

#default ⇒ Object (readonly)

Returns the value of attribute default.



8
9
10
 
# File 'app/pb_kits/playbook/props/base.rb', line 8

def default
  @default
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



8
9
10
 
# File 'app/pb_kits/playbook/props/base.rb', line 8

def required
  @required
end

Instance Method Details

#validate(_value) ⇒ Object 



26
27
28
 
# File 'app/pb_kits/playbook/props/base.rb', line 26

def validate(_value)
  true
end

#validate!(input_value) ⇒ Object

Raises:



19
20
21
22
23
24
 
# File 'app/pb_kits/playbook/props/base.rb', line 19

def validate!(input_value)
  raise(Playbook::Props::Error, "#{inspect} is a required prop and needs to be provided a value") if required && input_value.nil?

  validate(value(input_value)) ||
    raise(Playbook::Props::Error, "Invalid value (#{input_value.inspect}) for prop (#{inspect})")
end

#value(value) ⇒ Object 



15
16
17
 
# File 'app/pb_kits/playbook/props/base.rb', line 15

def value(value)
  value.nil? ? @default : value
end