Module: Spree::Admin::BaseHelper

Defined in:
app/helpers/spree/admin/base_helper.rb

Constant Summary collapse

SELECT2_SUPPORTED_LOCALES = 
%w[
  af ar az bg bn bs ca cs da de dsb el en eo es et eu fa fi fr gl he
  hi hr hsb hu hy id is it ja ka km ko lt lv mk ms nb ne nl pa pl ps
  pt pt-BR ro ru sk sl sq sr sr-Cyrl sv th tk tr uk vi zh-CN zh-TW
].freeze
FLATPICKR_SUPPORTED_LOCALES = 
%w[
  ar at az be bg bn bs cs cy da de eo es et fa fi fo fr ga gr he
  hi hr hu id is it ja ka km ko kz lv mk mn ms my nl no pa pl pt ro ru
  si sk sl sq sr sv th tr uk uz vn zh
].freeze
I18N_PLURAL_MANY_COUNT = 
2.1

Instance Method Summary collapse

Instance Method Details



248
249
250
251
252
253
254
 
# File 'app/helpers/spree/admin/base_helper.rb', line 248

def admin_logout_link
  if defined?(admin_logout_path)
    admin_logout_path
  elsif defined?(spree_logout_path)
    spree_logout_path
  end
end

#datepicker_field_value(date) ⇒ Object 



94
95
96
97
98
 
# File 'app/helpers/spree/admin/base_helper.rb', line 94

def datepicker_field_value(date)
  unless date.blank?
    l(date, format: '%Y/%m/%d')
  end
end

#error_message_on(object, method, _options = {}) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'app/helpers/spree/admin/base_helper.rb', line 73

def error_message_on(object, method, _options = {})
  object = convert_to_model(object)
  obj = object.respond_to?(:errors) ? object : instance_variable_get("@#{object}")

  if obj && obj.errors[method].present?
    errors = safe_join(obj.errors[method], '<br />'.html_safe)
    content_tag(:span, errors, class: 'formError')
  else
    ''
  end
end

#external_page_preview_link(resource, options = {}) ⇒ Object 



238
239
240
241
242
243
244
245
246
 
# File 'app/helpers/spree/admin/base_helper.rb', line 238

def external_page_preview_link(resource, options = {})
  resource_name = options[:name] || resource.class.name.demodulize

  button_link_to(
    Spree.t('admin.utilities.preview', name: resource_name),
    spree_storefront_resource_url(resource),
    class: 'btn-light', icon: 'view.svg', id: "adminPreview#{resource_name}", target: :blank, data: { turbo: false }
  )
end

#field_container(model, method, options = {}, &block) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'app/helpers/spree/admin/base_helper.rb', line 24

def field_container(model, method, options = {}, &block)
  css_classes = options[:class].to_a
  css_classes << 'form-group'
  css_classes << 'withError' if error_message_on(model, method).present?
  content_tag(
    :div, capture(&block),
    options.merge(class: css_classes.join(' '), id: "#{model}_#{method}_field")
  )
end

#flash_alert(flash) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'app/helpers/spree/admin/base_helper.rb', line 16

def flash_alert(flash)
  if flash.present?
    type = flash.first[0]
    message = flash.first[1]
    content_tag(:span, message, class: 'd-none', data: { alert_type: type })
  end
end

#flatpickr_local_fallback ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'app/helpers/spree/admin/base_helper.rb', line 268

def flatpickr_local_fallback
  stripped_locale = I18n.locale.to_s.split('-').first

  if I18n.locale.to_s == 'zh-TW'
    # Taiwanese is a popular language in Spree,
    # it has been well translated.
    'zh-tw'
  elsif FLATPICKR_SUPPORTED_LOCALES.include? stripped_locale
    stripped_locale
  else
    'default'
  end
end

#link_to_icon_remove_fields(form) ⇒ Object

renders hidden field and link to remove record using nested_attributes



207
208
209
210
211
212
213
214
215
216
217
 
# File 'app/helpers/spree/admin/base_helper.rb', line 207

def link_to_icon_remove_fields(form)
  url = form.object.persisted? ? [:admin, form.object] : '#'
  link_to_with_icon('delete.svg', '', url,
                    class: 'spree_remove_fields btn btn-sm btn-danger',
                    data: {
                      action: 'remove'
                    },
                    title: Spree.t(:remove),
                    no_text: true
                   ) + form.hidden_field(:_destroy)
end

#order_time(time) ⇒ Object 



228
229
230
231
232
 
# File 'app/helpers/spree/admin/base_helper.rb', line 228

def order_time(time)
  return '' if time.blank?

  [I18n.l(time.to_date), time.strftime('%l:%M %p %Z').strip].join(' ')
end

#plural_resource_name(resource_class) ⇒ Object 



224
225
226
 
# File 'app/helpers/spree/admin/base_helper.rb', line 224

def plural_resource_name(resource_class)
  resource_class.model_name.human(count: I18N_PLURAL_MANY_COUNT)
end

#preference_field_for(form, field, options) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'app/helpers/spree/admin/base_helper.rb', line 124

def preference_field_for(form, field, options)
  case options[:type]
  when :integer
    form.text_field(field, preference_field_options(options))
  when :boolean
    form.check_box(field, preference_field_options(options))
  when :string
    form.text_field(field, preference_field_options(options))
  when :password
    form.password_field(field, preference_field_options(options))
  when :text
    form.text_area(field, preference_field_options(options))
  else
    form.text_field(field, preference_field_options(options))
  end
end

#preference_field_options(options) ⇒ Object 



141
142
143
144
145
146
147
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
 
# File 'app/helpers/spree/admin/base_helper.rb', line 141

def preference_field_options(options)
  field_options = case options[:type]
                  when :integer
                    {
                      size: 10,
                      class: 'input_integer form-control'
                    }
                  when :boolean
                    {
                      class: 'form-check-input'
                    }
                  when :string
                    {
                      size: 10,
                      class: 'input_string form-control'
                    }
                  when :password
                    {
                      size: 10,
                      class: 'password_string form-control'
                    }
                  when :text
                    {
                      rows: 15,
                      cols: 85,
                      class: 'form-control'
                    }
                  else
                    {
                      size: 10,
                      class: 'input_string form-control'
                    }
                  end

  field_options.merge!(readonly: options[:readonly],
                       disabled: options[:disabled],
                       size: options[:size])
end

#preference_field_tag(name, value, options) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'app/helpers/spree/admin/base_helper.rb', line 100

def preference_field_tag(name, value, options)
  if options[:key] == :currency
    return select_tag(name,
                      options_from_collection_for_select(supported_currencies_for_all_stores, :iso_code, :iso_code, value),
                      class: 'select2')
  end

  case options[:type]
  when :integer
    text_field_tag(name, value, preference_field_options(options))
  when :boolean
    hidden_field_tag(name, 0, id: "#{name}_hidden") +
      check_box_tag(name, 1, value, preference_field_options(options))
  when :string
    text_field_tag(name, value, preference_field_options(options))
  when :password
    password_field_tag(name, value, preference_field_options(options))
  when :text
    text_area_tag(name, value, preference_field_options(options))
  else
    text_field_tag(name, value, preference_field_options(options))
  end
end

#preference_fields(object, form) ⇒ Object 



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
 
# File 'app/helpers/spree/admin/base_helper.rb', line 180

def preference_fields(object, form)
  return unless object.respond_to?(:preferences)

  fields = object.preferences.keys.map do |key|
    if object.has_preference?(key)
      case key
      when :currency
        content_tag(:div, form.label("preferred_#{key}", Spree.t(key)) +
          (form.select "preferred_#{key}", currency_options(object.preferences[key]), {}, { class: 'form-control select2' }),
                    class: 'form-group', id: [object.class.to_s.parameterize, 'preference', key].join('-'))
      else
        if object.preference_type(key).to_sym == :boolean
          content_tag(:div, preference_field_for(form, "preferred_#{key}", type: object.preference_type(key)) +
            form.label("preferred_#{key}", Spree.t(key), class: 'form-check-label'),
                      class: 'form-group form-check', id: [object.class.to_s.parameterize, 'preference', key].join('-'))
        else
          content_tag(:div, form.label("preferred_#{key}", Spree.t(key)) +
            preference_field_for(form, "preferred_#{key}", type: object.preference_type(key)),
                      class: 'form-group', id: [object.class.to_s.parameterize, 'preference', key].join('-'))
        end
      end
    end
  end
  safe_join(fields)
end

#product_wysiwyg_editor_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


282
283
284
 
# File 'app/helpers/spree/admin/base_helper.rb', line 282

def product_wysiwyg_editor_enabled?
  Spree::Backend::Config[:product_wysiwyg_editor_enabled]
end

#required_span_tag ⇒ Object 



234
235
236
 
# File 'app/helpers/spree/admin/base_helper.rb', line 234

def required_span_tag
  content_tag(:span, ' *', class: 'required font-weight-bold text-danger')
end

#select2_local_fallback ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
 
# File 'app/helpers/spree/admin/base_helper.rb', line 256

def select2_local_fallback
  stripped_locale = I18n.locale.to_s.split('-').first

  if ['zh-CN', 'zh-TW', 'sr-Cyrl', 'pt-BR'].include?(I18n.locale.to_s)
    I18n.locale
  elsif SELECT2_SUPPORTED_LOCALES.include? stripped_locale
    stripped_locale
  else
    'en'
  end
end

#spree_admin_show_version? ⇒ Boolean

Returns:

  • (Boolean) 


290
291
292
 
# File 'app/helpers/spree/admin/base_helper.rb', line 290

def spree_admin_show_version?
  can?(:admin, current_store) && Spree::Backend::RuntimeConfig[:admin_show_version]
end

#spree_dom_id(record) ⇒ Object 



219
220
221
 
# File 'app/helpers/spree/admin/base_helper.rb', line 219

def spree_dom_id(record)
  dom_id(record, 'spree')
end

#spree_humanize_dropdown_values(model_name, options = {}) ⇒ Object

Returns Humanized Dropdown Values From a Constant In the Model Pass the model name as a string and then a hash containing the constant name and the option to paramatize the return value.

Example:

spree_humanize_dropdown_values('Spree::CmsPage', { const: 'TYPES' })
spree_humanize_dropdown_values('Spree::Menu', { const: 'MENU_TYPES', paramterize_values: true })


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'app/helpers/spree/admin/base_helper.rb', line 43

def spree_humanize_dropdown_values(model_name, options = {})
  formatted_option_values = []

  const = options[:const] || nil
  paramterize_values = options[:paramterize_values] || false

  return unless const.present?

  model_name.constantize.const_get(const).map do |type|
    return_value = if paramterize_values
                     type.parameterize(separator: '_')
                   else
                     type
                   end

    formatted_option_values << [spree_humanize_type(type), return_value]
  end

  formatted_option_values
end

#spree_humanize_type(obj) ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'app/helpers/spree/admin/base_helper.rb', line 64

def spree_humanize_type(obj)
  last_word = obj.split('::', 10).last
  if last_word.starts_with?('Cms')
    last_word.slice(3, 100).gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
  else
    last_word.gsub(/(?<=[a-z])(?=[A-Z])/, ' ')
  end
end

#spree_update_available? ⇒ Boolean

Returns:

  • (Boolean) 


294
295
296
 
# File 'app/helpers/spree/admin/base_helper.rb', line 294

def spree_update_available?
  @spree_update_available ||= !Rails.env.test? && Spree::Admin::Updater.update_available?
end

#svg_icon(name:, classes: '', width:, height:) ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'app/helpers/spree/admin/base_helper.rb', line 85

def svg_icon(name:, classes: '', width:, height:)
  if name.ends_with?('.svg')
    icon_name = File.basename(name, File.extname(name))
    inline_svg_tag "backend-#{icon_name}.svg", class: "icon-#{icon_name} #{classes}", size: "#{width}px*#{height}px"
  else
    inline_svg_tag "backend-#{name}.svg", class: "icon-#{name} #{classes}", size: "#{width}px*#{height}px"
  end
end

#taxon_wysiwyg_editor_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


286
287
288
 
# File 'app/helpers/spree/admin/base_helper.rb', line 286

def taxon_wysiwyg_editor_enabled?
  Spree::Backend::Config[:taxon_wysiwyg_editor_enabled]
end