Class: ActiveDryForm::BaseForm

Inherits:
Object
  • Object
show all
Defined in:
lib/active_dry_form/base_form.rb

Direct Known Subclasses

Form

Defined Under Namespace

Classes: HashRecord

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(record: nil, params: nil) ⇒ BaseForm

Returns a new instance of BaseForm.



9
10
11
12
13
14
15
16
17
 
# File 'lib/active_dry_form/base_form.rb', line 9

def initialize(record: nil, params: nil)
  @attributes = {}

  self.params = params if params
  self.record = record if record

  @errors = {}
  @base_errors = []
end

Instance Attribute Details

#attributes ⇒ Object

Returns the value of attribute attributes.



7
8
9
 
# File 'lib/active_dry_form/base_form.rb', line 7

def attributes
  @attributes
end

#base_errors ⇒ Object

Returns the value of attribute base_errors.



6
7
8
 
# File 'lib/active_dry_form/base_form.rb', line 6

def base_errors
  @base_errors
end

#data ⇒ Object

Returns the value of attribute data.



6
7
8
 
# File 'lib/active_dry_form/base_form.rb', line 6

def data
  @data
end

#errors ⇒ Object

Returns the value of attribute errors.



6
7
8
 
# File 'lib/active_dry_form/base_form.rb', line 6

def errors
  @errors
end

#parent_form ⇒ Object

Returns the value of attribute parent_form.



6
7
8
 
# File 'lib/active_dry_form/base_form.rb', line 6

def parent_form
  @parent_form
end

#record ⇒ Object

Returns the value of attribute record.



7
8
9
 
# File 'lib/active_dry_form/base_form.rb', line 7

def record
  @record
end

#validator ⇒ Object (readonly)

Returns the value of attribute validator.



7
8
9
 
# File 'lib/active_dry_form/base_form.rb', line 7

def validator
  @validator
end

Class Method Details

.define_methods ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
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
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/active_dry_form/base_form.rb', line 148

def self.define_methods
  const_set :NESTED_FORM_KEYS, []
  const_set :NESTED_FORM_ARRAYS, Set.new

  self::FIELDS_INFO[:properties].each do |key, value|
    define_method :"#{key}=" do |v|
      attributes[key] = _deep_transform_values_in_params!(v)
    end

    sub_klass =
      if value[:properties] || value.dig(:items, :properties)
        Class.new(BaseForm).tap do |klass|
          klass.const_set :NAMESPACE, ActiveModel::Name.new(nil, nil, key.to_s)
          klass.const_set :FIELDS_INFO, value[:items] || value
          klass.define_methods
        end
      elsif const_defined?(:CURRENT_CONTRACT)
        dry_type = self::CURRENT_CONTRACT.schema.schema_dsl.types[key]
        dry_type = dry_type.member if dry_type.respond_to?(:member)
        dry_type.primitive if dry_type.respond_to?(:primitive)
      end

    if sub_klass && sub_klass < BaseForm
      self::NESTED_FORM_KEYS << {
        type:      sub_klass.const_defined?(:CURRENT_CONTRACT) ? :instance : :hash,
        namespace: key,
        is_array:  value[:type] == 'array',
      }
      if value[:type] == 'array'
        self::NESTED_FORM_ARRAYS << key.to_sym
      end
      nested_key = key
    end

    if nested_key && value[:type] == 'array'
      define_method nested_key do
        nested_records = record.try(nested_key) || []
        if attributes.key?(nested_key)
          attributes[nested_key].each_with_index do |nested_params, idx|
            attributes[nested_key][idx] = sub_klass.wrap(nested_params)
            attributes[nested_key][idx].record = nested_records[idx]
            attributes[nested_key][idx].parent_form = self
            attributes[nested_key][idx]
          end
        else
          attributes[nested_key] =
            nested_records.map do |nested_record|
              nested_form = sub_klass.new
              nested_form.record = nested_record
              nested_form.parent_form = self
              nested_form
            end
        end
        attributes[nested_key]
      end
    elsif nested_key
      define_method nested_key do
        attributes[nested_key] = sub_klass.wrap(attributes[nested_key])
        attributes[nested_key].record = record.try(nested_key)
        attributes[nested_key].parent_form = self
        attributes[nested_key]
      end
    else
      define_method key do
        (data || attributes).fetch(key) { record.try(key) }
      end
    end
  end
end

.human_attribute_name(field) ⇒ Object 



128
129
130
 
# File 'lib/active_dry_form/base_form.rb', line 128

def self.human_attribute_name(field)
  I18n.t(field, scope: :"activerecord.attributes.#{self::NAMESPACE.i18n_key}")
end

.wrap(object) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/active_dry_form/base_form.rb', line 132

def self.wrap(object)
  return object if object.is_a?(BaseForm)

  form = new
  form.attributes = object if object
  form
end

Instance Method Details

#[](key) ⇒ Object 



140
141
142
 
# File 'lib/active_dry_form/base_form.rb', line 140

def [](key)
  public_send(key)
end

#[]=(key, value) ⇒ Object 



144
145
146
 
# File 'lib/active_dry_form/base_form.rb', line 144

def []=(key, value)
  public_send(:"#{key}=", value)
end

#errors_full_messages ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/active_dry_form/base_form.rb', line 59

def errors_full_messages
  return if errors.blank?

  errors.flat_map do |field, errors|
    case errors
    when Array
      "#{t(model_name.i18n_key, field)}: #{errors.join(',')}"
    when Hash
      errors.map do |k, v|
        case k
        when Integer
          nested_key, nested_errors = v.to_a.first
          "#{t(field, nested_key)} (#{k + 1}): #{nested_errors.join(',')}"
        when Symbol
          "#{t(field, k)}: #{v.join(',')}"
        end
      end
    end
  end
end

#info(sub_key) ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/active_dry_form/base_form.rb', line 93

def info(sub_key)
  {
    type:     self.class::FIELDS_INFO.dig(:properties, sub_key, :format) || self.class::FIELDS_INFO.dig(:properties, sub_key, :type),
    required: self.class::FIELDS_INFO[:required].include?(sub_key.to_s),
  }
end

#model_name ⇒ Object 



89
90
91
 
# File 'lib/active_dry_form/base_form.rb', line 89

def model_name
  self.class::NAMESPACE
end

#params=(params) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/active_dry_form/base_form.rb', line 31

def params=(params)
  param_key = self.class::NAMESPACE.param_key
  form_params = params[param_key] || params[param_key.to_sym] || params

  if form_params.is_a?(::ActionController::Parameters)
    unless ActiveDryForm.config.allow_action_controller_params
      message = 'in `params` use `request.parameters` instead of `params` or set `allow_action_controller_params` to `true` in config'
      raise ParamsNotAllowedError, message
    end

    form_params = form_params.to_unsafe_h
  end

  self.attributes = form_params
end

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/active_dry_form/base_form.rb', line 85

def persisted?
  record&.persisted?
end

#t(*keys) ⇒ Object 



80
81
82
83
 
# File 'lib/active_dry_form/base_form.rb', line 80

def t(*keys)
  str_keys = keys.join('.')
  I18n.t("helpers.label.#{str_keys}", default: :"activerecord.attributes.#{str_keys}")
end

#to_model ⇒ Object

ActionView::Helpers::Tags::Translator#human_attribute_name



101
102
103
 
# File 'lib/active_dry_form/base_form.rb', line 101

def to_model
  self
end

#to_param ⇒ Object

используется при генерации URL, когда record.persisted?



108
109
110
111
 
# File 'lib/active_dry_form/base_form.rb', line 108

def to_param
  # подмодель может быть Hash, например сохраняется в json атрибут
  record.is_a?(Hash) ? '' : record.to_param
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/active_dry_form/base_form.rb', line 124

def valid?
  @is_valid
end

#validate ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/active_dry_form/base_form.rb', line 113

def validate
  @validator   = self.class::CURRENT_CONTRACT.call(attributes, { form: self, record: })
  @data        = @validator.values.data
  @errors      = @validator.errors.to_h
  @base_errors = @validator.errors.filter(:base?).map(&:to_s)

  @is_valid = @base_errors.empty? && @errors.empty?

  _deep_validate_nested
end