Module: EasyType::Parameter::ClassMethods

Defined in:
lib/easy_type/parameter.rb

Instance Method Summary collapse

Instance Method Details

#called_before(method_name) ⇒ Object 



48
49
50
 
# File 'lib/easy_type/parameter.rb', line 48

def called_before(method_name)
  self.method_defined? method_name
end

#fail_if_competing_method_defined ⇒ Object 



42
43
44
45
46
 
# File 'lib/easy_type/parameter.rb', line 42

def fail_if_competing_method_defined
  ['on_create','on_modify', 'on_destroy'].each do | method_name |
    fail "method #{method_name} can not coexist with on_apply. Use one or the other" if called_before(method_name)
  end
end

#on_apply(&block) ⇒ Object

retuns the string needed to modify this specific property of a defined type

Examples:


newproperty(:password) do
  on_apply do
    "identified by #{resource[:password]}"
  end
end

Parameters:

  • block (Method) —

    The code to be run on creating or modifying a resource. Although the code customary returns just a string that is appended to the command, it can do anything that is deemed nesceccary.

See Also:



36
37
38
39
 
# File 'lib/easy_type/parameter.rb', line 36

def on_apply(&block)
  fail_if_competing_method_defined
  define_method(:on_apply, &block) if block
end

#on_create(&block) ⇒ Object

retuns the string needed to create this specific property of a defined type. This method is ONLY called when the resource is created. It is not allowed to have both an ‘on_apply` and a `on_create` definition on the type.

Examples:


newproperty(:password) do
  on_create do
    "identified by #{resource[:password]}"
  end
end

Parameters:

  • block (Method) —

    The code to be run on creating a resource. Although the code customary returns just a string that is appended to the command, it can do anything that is deemed nesceccary.

See Also:



71
72
73
 
# File 'lib/easy_type/parameter.rb', line 71

def on_create(&block)
  define_method(:on_create, &block) if block
end

#on_modify(&block) ⇒ Object

retuns the string needed to modify this specific property of a defined type. This method is ONLY called when the resource is modified. It is not allowed to have both an ‘on_apply` and a `on_destroy` definition on the type.

Examples:


newproperty(:password) do
  on_modify do
    "identified by #{resource[:password]}"
  end
end

Parameters:

  • block (Method) —

    The code to be run modifying a resource. Although the code customary returns just a string that is appended to the command, it can do anything that is deemed nesceccary.

See Also:



94
95
96
 
# File 'lib/easy_type/parameter.rb', line 94

def on_modify(&block)
  define_method(:on_modify, &block) if block
end

#to_translate_to_resource(&block) ⇒ Object

maps a raw resource to retuns the string needed to modify this specific property of a type

Examples:


newproperty(:password) do
  map do
   "identified by #{resource[:password]}"
  end
end

Parameters:

  • block (Method) —

    The code to be run to pick a part of the raw_hash and use it as the value of this parameter or property.



112
113
114
115
 
# File 'lib/easy_type/parameter.rb', line 112

def to_translate_to_resource(&block)
  eigenclass = class << self; self; end
  eigenclass.send(:define_method, :translate_to_resource, &block)
end