Module: ClassComposer::Generator::ClassMethods

Defined in:
lib/class_composer/generator/class_methods.rb

Constant Summary collapse

COMPOSER_VALIDATE_METHOD_NAME = 
->(name) { :"__composer_#{name}_is_valid__?" }
COMPOSER_ASSIGNED_ATTR_NAME = 
->(name) { :"@__composer_#{name}_value_assigned__" }
COMPOSER_ASSIGNED_ARRAY_METHODS = 
->(name) { :"@__composer_#{name}_array_methods_set__" }
COMPOSER_ALLOWED_FROZEN_TYPE_ARGS = 
[:raise, :log]

Instance Method Summary collapse

Instance Method Details

#__add_to_composer_mapping__(name:, default:, allowed:, desc:, blocking_attributes:, default_shown: nil, dynamic_default: nil) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/class_composer/generator/class_methods.rb', line 89

def __add_to_composer_mapping__(name:, default:, allowed:, desc:, blocking_attributes:, default_shown: nil, dynamic_default: nil)
  children = Array(allowed).select { _1.include?(ClassComposer::Generator) }.map do |allowed_class|
    allowed_class.composer_mapping
  end

  composer_mapping[name] = {
    desc: desc,
    children: children.empty? ? nil : children,
    dynamic_default: dynamic_default,
    default_shown: default_shown,
    default: (default.to_s.start_with?("#<") ? default.class : default),
    blocking_attributes: blocking_attributes,
    allowed: allowed,
  }.compact
end

#__composer_array_proc__(name:, validator:, allowed:, params:) ⇒ Object 



115
116
117
118
119
 
# File 'lib/class_composer/generator/class_methods.rb', line 115

def __composer_array_proc__(name:, validator:, allowed:, params:)
  Proc.new do |value, _itself|
    _itself.send(:"#{name}=", value)
  end
end

#__composer_assignment__(name:, params:, allowed:, validator:, array_proc:, validation_error_klass:, error_klass:, &blk) ⇒ Object

create assignment method for the incoming name



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/class_composer/generator/class_methods.rb', line 122

def __composer_assignment__(name:, params:, allowed:, validator:, array_proc:, validation_error_klass:, error_klass:, &blk)
  define_method(:"#{name}=") do |value|
    case class_composer_frozen!(name)
    when false
      # false is returned when the instance is frozen AND we do not allow the operation to proceed
      return
    when true
      # true is returned when the instance is frozen AND we allow the operation to proceed
    when nil
      # nil is returned when the instance is not frozen
    end

    is_valid = self.class.__run_validation_item(name: name, validator: validator, allowed: allowed, value: value, params: params)

    if is_valid[:valid]
      instance_variable_set(COMPOSER_ASSIGNED_ATTR_NAME.(name), true)
      instance_variable_set(:"@#{name}", value)
    else
      raise validation_error_klass, is_valid[:message].compact.join(" ")
    end

    if value.is_a?(Array) && !value.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
      _itself = itself
      value.define_singleton_method(:<<) do |val|
        array_proc.(super(val), _itself)
      end
      value.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
    end

    if blk
      yield(name, value)
    end

    value
  end
end

#__composer_retrieval__(name:, default:, array_proc:, allowed:, params:, validator:, validation_error_klass:) ⇒ Object

retrieve the value for the name – Or return the default value



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/class_composer/generator/class_methods.rb', line 171

def __composer_retrieval__(name:, default:, array_proc:, allowed:, params:, validator:, validation_error_klass:)
  define_method(:"#{name}") do
    value = instance_variable_get(:"@#{name}")
    return value if instance_variable_get(COMPOSER_ASSIGNED_ATTR_NAME.(name))

    if dynamic_default = params[:dynamic_default]
      if Proc === dynamic_default
        value = dynamic_default.(self)
      else
        # We know the method exists because we already checked validity from within
        # `compose_mapping` on add_composer creation
        value = method(:"#{dynamic_default}").()
      end
      is_valid = self.class.__run_validation_item(name: name, validator: validator, allowed: allowed, value: value, params: params)

      if is_valid[:valid]
        instance_variable_set(COMPOSER_ASSIGNED_ATTR_NAME.(name), true)
        instance_variable_set(:"@#{name}", value)
      else
        raise validation_error_klass, is_valid[:message].compact.join(" ")
      end

      return value
    end

    if default.is_a?(Array) && !default.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
      _itself = itself
      default.define_singleton_method(:<<) do |value|
        array_proc.(super(value), _itself)
      end
      default.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
    end

    default == ClassComposer::DefaultObject ? ClassComposer::DefaultObject.value : default
  end
end

#__composer_validate_options__!(name:, validate_proc:, default:, params: {}, validation_error_klass:, error_klass:) ⇒ Object 



105
106
107
108
109
110
111
112
113
 
# File 'lib/class_composer/generator/class_methods.rb', line 105

def __composer_validate_options__!(name:, validate_proc:, default:, params: {}, validation_error_klass:, error_klass:)
  unless validate_proc.(default)
    raise validation_error_klass, "Default value [#{default}] for #{self.class}.#{name} is not valid"
  end

  if instance_methods.include?(name.to_sym)
    raise error_klass, "[#{name}] is already defined. Ensure composer names are all uniq and do not class with class instance methods"
  end
end

#__composer_validator_proc__(validator:, allowed:, name:, error_klass:) ⇒ Object

create validator method for incoming name



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/class_composer/generator/class_methods.rb', line 209

def __composer_validator_proc__(validator:, allowed:, name:, error_klass:)
  if validator && !validator.is_a?(Proc)
    raise error_klass, "Expected validator to be a Proc. Received [#{validator.class}]"
  end

  # Proc will validate the entire attribute -- Full assignment must occur before validate is called
  Proc.new do |value|
    begin
      allow =
        if allowed.is_a?(Array)
          allowed.include?(value.class)
        else
          allowed == value.class
        end
      # order is important -- Do not run validator if it is the default object
      # Default object will likely raise an error if there is a custom validator
      (allowed.include?(ClassComposer::DefaultObject) && value == ClassComposer::DefaultObject) || (allow && validator.(value))
    rescue StandardError => e
      raise error_klass, "#{e} occurred during validation for value [#{value}]. Check custom validator for #{name}"
    end
  end
end

#__run_validation_item(validator:, name:, value:, allowed:, params:) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/class_composer/generator/class_methods.rb', line 159

def __run_validation_item(validator:, name:, value:, allowed:, params:)
  if validator.(value)
    return { valid: true }
  end

  message = ["#{self.class}.#{name} failed validation. #{name} is expected to be #{allowed}. Received [#{value}](#{value.class})"]
  message << (params[:invalid_message].is_a?(Proc) ? params[:invalid_message].(value) : params[:invalid_message].to_s)

  { valid: false, message: message }
end

#add_composer(name, allowed:, desc: nil, validator: ->(_) { true }, validation_error_klass: ::ClassComposer::ValidatorError, error_klass: ::ClassComposer::Error, blocking_attributes: nil, default_shown: nil, **params, &blk) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/class_composer/generator/class_methods.rb', line 36

def add_composer(name, allowed:, desc: nil, validator: ->(_) { true }, validation_error_klass: ::ClassComposer::ValidatorError, error_klass: ::ClassComposer::Error, blocking_attributes: nil, default_shown: nil, **params, &blk)
  default =
    if params.has_key?(:default)
      params[:default]
    else
      ClassComposer::DefaultObject
    end

  if params[:default] && params[:dynamic_default]
    raise Error, "Composer :#{name} had both the `:default` and `:dynamic_default` assigned. Only one allowed"
  end

  if dynamic_default = params[:dynamic_default]
    if ![Proc, Symbol].include?(dynamic_default.class)
      raise Error, "Composer :#{name} defined `:dynamic_default: #{dynamic_default}`. Expected value to be a Symbol mapped to a composer element or a Proc"
    end

    if Symbol === dynamic_default && composer_mapping[dynamic_default].nil?
      raise Error, "Composer :#{name} defined `dynamic_default: #{dynamic_default}`. #{dynamic_default} is not defined. Please ensure that all dynamic_default's are defined before setting them"
    end
  end

  if allowed.is_a?(Array)
    allowed << ClassComposer::DefaultObject
  else
    allowed = [allowed, ClassComposer::DefaultObject]
  end

  if allowed.select { _1.include?(ClassComposer::Generator) }.count > 1
    raise Error, "Allowed arguments has multiple classes that include ClassComposer::Generator. Max 1 is allowed"
  end

  validate_proc = __composer_validator_proc__(validator: validator, allowed: allowed, name: name, error_klass: error_klass)
  __composer_validate_options__!(name: name, validate_proc: validate_proc, default: default, validation_error_klass: validation_error_klass, error_klass: error_klass)

  array_proc = __composer_array_proc__(name: name, validator: validator, allowed: allowed, params: params)
  __composer_assignment__(name: name, allowed: allowed, params: params, validator: validate_proc, array_proc: array_proc, validation_error_klass: validation_error_klass, error_klass: error_klass, &blk)
  __composer_retrieval__(name: name, allowed: allowed, default: default, array_proc: array_proc, params: params, validator: validate_proc, validation_error_klass: validation_error_klass)

  # Add to mapping
  __add_to_composer_mapping__(name: name, default: default, allowed: allowed, desc: desc, blocking_attributes: blocking_attributes, default_shown: default_shown, dynamic_default: params[:dynamic_default])
end

#add_composer_blocking(name, composer_class:, desc: nil, block_prepend: "with", enable_attr: nil) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/class_composer/generator/class_methods.rb', line 11

def add_composer_blocking(name, composer_class:, desc: nil, block_prepend: "with", enable_attr: nil)
  unless composer_class.include?(ClassComposer::Generator)
    raise ClassComposer::Error, ".add_composer_blocking passed `composer_class:` that does not include ClassComposer::Generator. Passed argument must include ClassComposer::Generator"
  end

  blocking_name = "#{block_prepend}_#{name}"
  blocking_attributes = { block_name: blocking_name, enable_attr: enable_attr }
  add_composer(name, allowed: composer_class, default: composer_class.new, desc: desc, blocking_attributes: blocking_attributes)

  define_method(blocking_name) do |&blk|
    instance = public_send(:"#{name}")
    instance.public_send(:"#{enable_attr}=", true) if enable_attr

    blk.(instance) if blk

    method(:"#{name}=").call(instance)
  end

  if enable_attr
    define_method("#{name}?") do
      public_send(:"#{name}").public_send(enable_attr)
    end
  end
end

#composer_generate_config(wrapping:, require_file: nil, space_count: 2) ⇒ Object 



83
84
85
86
87
 
# File 'lib/class_composer/generator/class_methods.rb', line 83

def composer_generate_config(wrapping:, require_file: nil, space_count: 2)
  @composer_generate_config ||= GenerateConfig.new(instance: self)

  @composer_generate_config.execute(wrapping:, require_file:, space_count:)
end

#composer_mapping ⇒ Object 



79
80
81
 
# File 'lib/class_composer/generator/class_methods.rb', line 79

def composer_mapping
  @composer_mapping ||= {}
end