Class: DynamicScaffold::Form::Item::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/dynamic_scaffold/form/item/base.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

ITEM_TYPES = 
{
  check_box: Form::Item::SingleOption,
  radio_button: Form::Item::SingleOption,
  text_area: Form::Item::SingleOption,
  text_field: Form::Item::SingleOption,
  password_field: Form::Item::SingleOption,
  hidden_field: Form::Item::SingleOption,
  file_field: Form::Item::SingleOption,
  color_field: Form::Item::SingleOption,
  number_field: Form::Item::SingleOption,
  telephone_field: Form::Item::SingleOption,

  time_select: Form::Item::TwoOptions,
  date_select: Form::Item::TwoOptions,
  datetime_select: Form::Item::TwoOptions,
  collection_select: Form::Item::TwoOptions,
  grouped_collection_select: Form::Item::TwoOptions,

  collection_check_boxes: Form::Item::TwoOptionsWithBlock,
  collection_radio_buttons: Form::Item::TwoOptionsWithBlock,

  block: Form::Item::Block,

  carrierwave_image: Form::Item::CarrierWaveImage,

  globalize_fields: Form::Item::GlobalizeFields,

  cocoon: Form::Item::Cocoon
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, type, name, html_attributes = {}) ⇒ Base

Returns a new instance of Base.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 49

def initialize(config, type, name, html_attributes = {})
  @config = config
  @name = name
  @type = type
  @html_attributes = html_attributes
  classnames = @html_attributes.delete(:class)
  @classnames_list = []
  @classnames_list.push(classnames) if classnames
  @notes = []
  @multiple = type == :collection_check_boxes || html_attributes[:multiple]
  @inserts = { before: [], after: [] }
  @label_attributes = {}
  @label_block = nil
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



48
49
50
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 48

def name
  @name
end

Class Method Details

.create(config, type, *args, &block) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 36

def create(config, type, *args, &block)
  if ITEM_TYPES[type].nil?
    raise(
      DynamicScaffold::Error::InvalidParameter,
      "Unknown form item type #{type}. supported: #{ITEM_TYPES.keys.join(', ')}"
    )
  end

  ITEM_TYPES[type].new(config, type, *args, &block)
end

Instance Method Details

#default(value = nil, &block) ⇒ Object 



160
161
162
163
164
165
166
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 160

def default(value = nil, &block)
  if block_given?
    @default = block
  else
    @default = value
  end
end

#default_value(view) ⇒ Object 



168
169
170
171
172
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 168

def default_value(view)
  return view.instance_exec(&@default) if @default.is_a? Proc

  @default
end

#errors(form) ⇒ Object 



183
184
185
186
187
188
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 183

def errors(form)
  msg = form.object.errors.full_messages_for(proxy_field.name)
  rel = @config.model.reflect_on_all_associations.find {|r| r.foreign_key.to_s == name.to_s }
  msg.concat(form.object.errors.full_messages_for(rel.name)) if rel.present?
  msg
end

#extract_parameters(permitting) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 122

def extract_parameters(permitting)
  if @multiple
    permitting << { @name => [] }
  else
    permitting << @name
  end
end

#if(&block) ⇒ Object 



130
131
132
133
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 130

def if(&block)
  @if_block = block
  self
end

#insert(position, &block) ⇒ Object 



174
175
176
177
178
179
180
181
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 174

def insert(position, &block)
  if block_given?
    @inserts[position] << block
    self
  else
    @inserts[position]
  end
end

#label(*args, &block) ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 88

def label(*args, &block)
  return @label || @config.model.human_attribute_name(@name) if args.empty? && block.nil?

  @label_attributes = args.extract_options!
  @label = args.first unless args.empty?
  @label_block = block if block_given?

  self
end

#label? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 84

def label?
  !@label.nil?
end

#needs_rendering?(view) ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
143
144
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 140

def needs_rendering?(view)
  return true unless @if_block || @unless_block
  return view.instance_exec(view.controller.params, &@if_block) if @if_block
  return !view.instance_exec(view.controller.params, &@unless_block) if @unless_block
end

#note(&block) ⇒ Object 



68
69
70
71
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 68

def note(&block)
  @notes << block if block_given?
  self
end

#notes? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 64

def notes?
  !@notes.empty?
end

#proxy(attribute_name) ⇒ Object 



146
147
148
149
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 146

def proxy(attribute_name)
  @proxy = attribute_name
  self
end

#proxy_field ⇒ Object

Raises:



151
152
153
154
155
156
157
158
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 151

def proxy_field
  return self unless @proxy

  proxy_target = @config.form.items.select {|f| f.name == @proxy }
  raise DynamicScaffold::Error::InvalidParameter, "Missing proxy target element: #{@proxy}" if proxy_target.empty?

  proxy_target.first
end

#render_label(view, depth) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 98

def render_label(view, depth)
  if @label_block.present?
    label = view.instance_exec(
      proxy_field.label,
      depth,
      @label_attributes,
      &@label_block
    )
    return label unless label.nil?
  end

  # if DynamicScaffold.config.form.label.present?
  #   label = view.instance_exec(
  #     proxy_field.label,
  #     depth,
  #     @label_attributes,
  #     &DynamicScaffold.config.form.label
  #   )
  #   return label unless label.nil?
  # end

  view.tag.label(proxy_field.label, @label_attributes)
end

#render_notes(record, view) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 73

def render_notes(record, view)
  htmls = @notes.map do |note|
    view.instance_exec(record, &note)
  end
  view.safe_join(htmls)
end

#type?(type) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 80

def type?(type)
  @type == type
end

#unless(&block) ⇒ Object 



135
136
137
138
 
# File 'lib/dynamic_scaffold/form/item/base.rb', line 135

def unless(&block)
  @unless_block = block
  self
end