Class: Kadmin::Form

Inherits:
Object
  • Object
show all
Extended by:
ActiveModel::Translation
Includes:
ActiveModel::Validations, ActiveRecord::AttributeAssignment
Defined in:
lib/kadmin/form.rb

Overview

Parsing is done by using attribute setters. If you have an attribute called name, then add a reader/writer for it, name and name=, and perform the parsing in name=. If there is no parsing to be done, you can simply delegate the method to the underlying model.

If the attribute is a nested form, in the writer, simply instantiate that form, and pass the attributes on to it, then update the model's association (if any) to reflect the changes.

Validation is performed like on a normal model or ActiveRecord object. If you have no extra validation to perform than that of the model, simply delegate the validate and valid? methods to the model.

To use nested forms, you need to add a reader and a writer. For example, for a form called Person, with potentially X nested Person forms as children, you would have:

Examples:

class PersonForm < Form
  def children
    [@child1, @child2]
  end

  def children_attributes=(attributes)
    ...instantiate subforms and pass attributes...
  end
end

Instance Attribute Summary collapse

Attributes assignment/manipulation collapse

Persistence collapse

Instance Method Summary collapse

Constructor Details

#initialize(model) ⇒ Form

Returns a new instance of Form.



41
42
43
44
45
 
# File 'lib/kadmin/form.rb', line 41

def initialize(model)
  @errors = ActiveModel::Errors.new(self)
  @model = model
  @form_input = {}
end

Instance Attribute Details

#model ⇒ ActiveModel::Model (readonly)

Returns underlying model to populate.

Returns:

  • (ActiveModel::Model) —

    underlying model to populate



37
38
39
 
# File 'lib/kadmin/form.rb', line 37

def model
  @model
end

Class Method Details

.delegate_association(association, to:) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/kadmin/form.rb', line 92

def delegate_association(association, to:)
  self.associations[association] = to

  # add a reader attribute
  class_eval <<~METHOD, __FILE__, __LINE__ + 1
    def #{association}
      return self.associated_forms['#{association}']
    end
  METHOD
end

.delegate_attributes(*attributes) ⇒ Object

Delegates the list of attributes to the model, both readers and writers. If the attribute value passed is a hash and not a symbol, assumes it is a hash of one key, whose value is an array contained :reader, :writer, or both.

Examples:

delegate_attributes :first_name, { last_name: [:reader] }

Parameters:

  • attributes (Array<Symbol, Hash<Symbol, Array<Symbol>>>) —

    list of attributes to delegate to the model



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/kadmin/form.rb', line 71

def delegate_attributes(*attributes)
  delegates = attributes.each_with_object([]) do |attribute, acc|
    case attribute
    when Hash
      key, value = attribute.first
      acc << key if value.include?(:reader)
      acc << "#{key}=" if value.include?(:writer)
    when Symbol, String
      acc.push(attribute, "#{attribute}=")
    else
      raise(ArgumentError, 'Attribute must be one of: Hash, Symbol, String')
    end
  end

  delegate(*delegates, to: :model)
end

Instance Method Details

#associated_forms ⇒ Object 



104
105
106
107
108
109
110
111
 
# File 'lib/kadmin/form.rb', line 104

def associated_forms
  return @associated_forms ||= begin
    self.class.associations.map do |name, form_class_name|
      form_class = form_class_name.constantize
      form_class.new(@model.public_send(name))
    end
  end
end

#sanitize_for_mass_assignment(attributes) ⇒ Object

For now, we overload the method to accept all attributes. This is removed in Rails 5, so once we upgrade we can remove the overload.



60
61
62
 
# File 'lib/kadmin/form.rb', line 60

def sanitize_for_mass_assignment(attributes)
  return attributes
end

#save ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/kadmin/form.rb', line 142

def save
  saved = false
  @model.class.transaction do
    saved = @model.save
    self.associated_forms.each do |_name, form|
      saved &&= form.save
    end

    raise ActiveRecord::Rollback unless saved
  end

  return saved
end

#save! ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/kadmin/form.rb', line 156

def save!
  saved = false
  @model.class.transaction do
    saved = @model.save!
    self.associated_forms.each do |_name, form|
      saved &&= form.save! # no need to raise anything, save! will do so
    end
  end

  return saved
end

#to_model ⇒ Object 



47
48
49
 
# File 'lib/kadmin/form.rb', line 47

def to_model
  return @model
end