Class: Effective::FormInputs::FileField

Inherits:
Effective::FormInput show all
Defined in:
app/models/effective/form_inputs/file_field.rb

Constant Summary

Constants inherited from Effective::FormInput

Effective::FormInput::BLANK, Effective::FormInput::DEFAULT_FEEDBACK_OPTIONS, Effective::FormInput::DEFAULT_INPUT_GROUP_OPTIONS, Effective::FormInput::EMPTY_HASH, Effective::FormInput::EXCLUSIVE_CLASS_PREFIXES, Effective::FormInput::EXCLUSIVE_CLASS_SUFFIXES, Effective::FormInput::HORIZONTAL_LABEL_OPTIONS, Effective::FormInput::HORIZONTAL_WRAPPER_OPTIONS, Effective::FormInput::INLINE_LABEL_OPTIONS, Effective::FormInput::VERTICAL_WRAPPER_OPTIONS

Instance Attribute Summary

Attributes inherited from Effective::FormInput

#name, #options

Instance Method Summary collapse

Methods inherited from Effective::FormInput

#feedback_options, #hint_options, #initialize, #input_group_options, #input_js_options, #label_options, #to_html, #wrapper_options

Constructor Details

This class inherits a constructor from Effective::FormInput

Instance Method Details

#attachments_blank?Boolean

Returns:

  • (Boolean)


43
44
45
# File 'app/models/effective/form_inputs/file_field.rb', line 43

def attachments_blank?
  Array(object.public_send(name)).length == 0
end

#attachments_present?Boolean

Returns:

  • (Boolean)


39
40
41
# File 'app/models/effective/form_inputs/file_field.rb', line 39

def attachments_present?
  Array(object.public_send(name)).length > 0
end

#attachments_styleObject



189
190
191
# File 'app/models/effective/form_inputs/file_field.rb', line 189

def attachments_style
  @attachments_style ||= (options[:input].delete(:attachments_style) || options[:input].delete(:attachment_style) || :card)
end

#build_attachment_remove(attachment, footer: false) ⇒ Object



161
162
163
164
165
166
167
168
169
170
171
172
# File 'app/models/effective/form_inputs/file_field.rb', line 161

def build_attachment_remove(attachment, footer: false)
  return ''.html_safe if disabled? || !purge?

  hidden = @template.hidden_field_tag("#{@builder.object_name}[_purge][]", attachment.signed_id, disabled: true, class: 'effective-file-remove-input', id: nil)
  button = @template.(:button, 'Remove', type: 'button', class: 'btn btn-sm btn-outline-danger effective-file-remove')

  if footer
    (:div, hidden + button, class: 'card-footer bg-transparent text-right')
  else
    hidden + button
  end
end

#build_attachmentsObject



60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'app/models/effective/form_inputs/file_field.rb', line 60

def build_attachments
  return ''.html_safe unless object.respond_to?(name) && object.send(name).respond_to?(:attached?) && object.send(name).attached?

  attachments = object.send(name).respond_to?(:length) ? object.send(name) : [object.send(name)]

  case attachments_style
  when :card
    build_card_attachments(attachments)
  when :table, :ck_assets
    build_table_attachments(attachments)
  else
    raise('unsupported attachments_style, try :card or :table')
  end
end

#build_card_attachment(attachment) ⇒ Object



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'app/models/effective/form_inputs/file_field.rb', line 120

def build_card_attachment(attachment)
  url = (@template.url_for(attachment) rescue false)
  url ||= (Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true) rescue false)

  return unless url

  (:div, class: 'col-lg-4 effective-file-attachment', data: { signed_id: attachment.signed_id }) do
    (:div, class: 'card mb-3') do
      body = if attachment.image?
        (:div, class: 'card-body text-center') do
          (:div, image_tag(url, alt: attachment.filename.to_s, class: 'img-fluid mb-2')) +
          (:div, link_to(attachment.filename, url, class: 'card-link'))
        end
      else
        (:div, class: 'card-body') do
          (:p, class: 'card-text') do
            link_to(attachment.filename, url, class: 'card-link') + '<br>'.html_safe + @template.number_to_human_size(attachment.byte_size)
          end
        end
      end

      body + build_attachment_remove(attachment, footer: true)
    end
  end
end

#build_card_attachments(attachments) ⇒ Object



116
117
118
# File 'app/models/effective/form_inputs/file_field.rb', line 116

def build_card_attachments(attachments)
  (:div, attachments.map { |attachment| build_card_attachment(attachment) }.join.html_safe, class: 'effective_file_attachments row')
end

#build_existing_attachmentsObject

This has the affect of appending files to the has_many. Which usually isnt what we want



48
49
50
51
52
53
54
55
56
57
58
# File 'app/models/effective/form_inputs/file_field.rb', line 48

def build_existing_attachments
  attachments = Array(object.send(name))

  attachments.map.with_index do |attachment, index|
    if multiple?
      @builder.hidden_field(name, multiple: true, id: (tag_id + "_#{index}"), value: attachment.signed_id)
    else
      @builder.hidden_field(name, id: tag_id, value: attachment.signed_id)
    end
  end.join.html_safe
end

#build_input(&block) ⇒ Object



7
8
9
10
11
12
13
14
15
16
# File 'app/models/effective/form_inputs/file_field.rb', line 7

def build_input(&block)
  case attachments_style
  when :card
    build_existing_attachments + build_attachments + build_uploads_and_purge(super)
  when :table, :ck_assets
    build_existing_attachments + build_uploads_and_purge(super) + build_attachments
  else
    raise('unsupported attachments_style, try :card or :table')
  end
end

#build_table_attachment(attachment) ⇒ Object



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'app/models/effective/form_inputs/file_field.rb', line 93

def build_table_attachment(attachment)
  url = (@template.url_for(attachment) rescue false)
  url ||= (Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true) rescue false)

  return unless url

  image_tag = (:img, '', class: '', src: url, alt: attachment.filename.to_s) if attachment.image?
  link_tag = link_to(attachment.filename, url)
  size_tag = @template.number_to_human_size(attachment.byte_size)

  (:td, image_tag) +
  (:td, link_tag) +
  (:td, size_tag) +

  (:td) do
    if attachments_style == :ck_assets
      link_to('Attach', url, class: 'btn btn-primary', 'data-insert-ck-asset': true, alt: attachment.filename.to_s)
    else
      build_attachment_remove(attachment)
    end
  end
end

#build_table_attachments(attachments) ⇒ Object



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'app/models/effective/form_inputs/file_field.rb', line 75

def build_table_attachments(attachments)
  (:table, class: 'table table-hover effective_file_attachments mt-2') do
    (:thead) do
      (:tr) do
        (:th, '') +
        (:th, 'Title') +
        (:th, 'Size') +
        (:th, '')
      end
    end +
    (:tbody) do
      attachments.map do |attachment|
        (:tr, build_table_attachment(attachment), class: 'effective-file-attachment', data: { signed_id: attachment.signed_id })
      end.join.html_safe
    end
  end
end

#build_uploadsObject



150
151
152
# File 'app/models/effective/form_inputs/file_field.rb', line 150

def build_uploads
  (:div, '', class: 'uploads')
end

#build_uploads_and_purge(super_file_field) ⇒ Object



146
147
148
# File 'app/models/effective/form_inputs/file_field.rb', line 146

def build_uploads_and_purge(super_file_field)
  build_uploads + (:div, super_file_field, class: 'effective-file-drop-zone')
end

#click_submit?Boolean

Returns:

  • (Boolean)


184
185
186
187
# File 'app/models/effective/form_inputs/file_field.rb', line 184

def click_submit?
  return @click_submit unless @click_submit.nil?
  @click_submit ||= (options.delete(:click_submit) || false)
end

#input_html_optionsObject



18
19
20
21
22
23
24
25
26
27
28
# File 'app/models/effective/form_inputs/file_field.rb', line 18

def input_html_options
  {
    id: tag_id,
    class: 'form-control form-control-file',
    multiple: multiple?,
    direct_upload: true,
    'data-direct-upload-url': (@template.main_app.rails_direct_uploads_url unless options[:direct_upload] == false),
    'data-progress-template': progress_template,
    'data-click-submit': (true if click_submit?),
  }.compact
end

#multiple?Boolean

Returns:

  • (Boolean)


30
31
32
33
# File 'app/models/effective/form_inputs/file_field.rb', line 30

def multiple?
  return @multiple unless @multiple.nil?
  @multiple = options.key?(:multiple) ? options.delete(:multiple) : (name.to_s.pluralize == name.to_s)
end

#progress_templateObject



154
155
156
157
158
159
# File 'app/models/effective/form_inputs/file_field.rb', line 154

def progress_template
  (:div, class: 'direct-upload direct-upload--pending', 'data-direct-upload-id': '$ID$') do
    (:div, '', class: 'direct-upload__progress', style: 'width: 0%') +
    (:span, '$FILENAME$', class: 'direct-upload__filename')
  end
end

#purgable?Boolean

Returns:

  • (Boolean)


179
180
181
182
# File 'app/models/effective/form_inputs/file_field.rb', line 179

def purgable?
  return false unless object.class.try(:has_many_purgable?)
  object.has_many_purgable_names.include?(name.to_sym)
end

#purge?Boolean

Returns:

  • (Boolean)


174
175
176
177
# File 'app/models/effective/form_inputs/file_field.rb', line 174

def purge?
  return @purge unless @purge.nil?
  @purge = options[:input].key?(:purge) ? (options[:input].delete(:purge) && purgable?) : purgable?
end

#required_presence?(obj, name) ⇒ Boolean

Returns:

  • (Boolean)


35
36
37
# File 'app/models/effective/form_inputs/file_field.rb', line 35

def required_presence?(obj, name)
  super(obj, name) && attachments_blank?
end