Class: Humidifier::Props::StringProp

Inherits:
Base
  • Object
show all
Defined in:
lib/humidifier/props/string_prop.rb

Overview

A string property

Constant Summary

Constants inherited from Base

Base::WHITELIST

Instance Attribute Summary

Attributes inherited from Base

#key, #name, #spec, #substructs

Instance Method Summary collapse

Methods inherited from Base

#documentation, #initialize, #required?, #to_cf, #update_type, #whitelisted_value?

Constructor Details

This class inherits a constructor from Humidifier::Props::Base

Instance Method Details

#convert(value) ⇒ Object

converts the value through #to_s unless it is valid



6
7
8
9
10
11
12
13
 
# File 'lib/humidifier/props/string_prop.rb', line 6

def convert(value)
  if valid?(value)
    value
  else
    puts "WARNING: Property #{name} should be a string"
    value.to_s
  end
end

#valid?(value) ⇒ Boolean

true if it is whitelisted or a String

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/humidifier/props/string_prop.rb', line 16

def valid?(value)
  whitelisted_value?(value) || value.is_a?(String)
end