Module: Symphonia::ApplicationHelper

Includes:
FormHelper
Defined in:
app/helpers/symphonia/application_helper.rb

Defined Under Namespace

Classes: SymphoniaModalDialog

Instance Method Summary collapse

Methods included from FormHelper

#symphonia_form_for, #symphonia_form_tag

Instance Method Details

#bootstrap_flash_map ⇒ Object 



6
7
8
9
10
11
12
13
 
# File 'app/helpers/symphonia/application_helper.rb', line 6

def bootstrap_flash_map
  {
    "notice" => { class_name: "alert-success", icon: "check-circle" },
    "error" => { class_name: "alert-danger", icon: "circle-exclamation" },
    "warning" => { class_name: "alert-warning", icon: "circle-exclamation" },
    "info" => { class_name: "alert-info", icon: "info-circle" },
  }
end

#ckeditor_for(field_id, options = {}) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'app/helpers/symphonia/application_helper.rb', line 212

def ckeditor_for(field_id, options = {})
  return '' unless !!defined?(Ckeditor)

  inline = options.delete(:inline)
  opts = options.inject({}) do |mem, var|
    key = var[0].to_s.camelcase(:lower)
    key[0].downcase!
    mem[key] = var[1]

    mem
  end
  opts['toolbar'] ||= 'Basic'
  # opts['customConfig'] ||= 'Basic'
  js = if inline
         "CKEDITOR.inline('#{field_id}', {toolbar: 'Basic'});"
       else
         "
    var ta_editor = CKEDITOR.instances['#{field_id}'];
    if (ta_editor) {CKEDITOR.remove(ta_editor);}
    CKEDITOR.replace('#{field_id}', #{opts.to_json.html_safe});
  "
       end
  javascript_tag("$(document).ready(function() {#{js.html_safe}})".html_safe)
end

#content_for(name, content = nil, &block) ⇒ Object 



158
159
160
161
162
 
# File 'app/helpers/symphonia/application_helper.rb', line 158

def content_for(name, content = nil, &block)
  @has_content ||= {}
  @has_content[name] = true
  super(name, content, &block)
end

#fa_icon(fa, options = {}) ⇒ Object 



258
259
260
261
 
# File 'app/helpers/symphonia/application_helper.rb', line 258

def fa_icon(fa, options = {})
  ActiveSupport::Deprecation.warn "use `icon` instead"
  icon(fa, options.delete(:text), options)
end

#format_html(text) ⇒ Object 



175
176
177
 
# File 'app/helpers/symphonia/application_helper.rb', line 175

def format_html(text)
  tag.div((defined?(Ckeditor) ? text.html_safe : format_text(text)), class: 'formatted-text')
end

#format_price(value, options = {}) ⇒ Object 



179
180
181
 
# File 'app/helpers/symphonia/application_helper.rb', line 179

def format_price(value, options = {})
  number_to_currency(value, { precision: 1, strip_insignificant_zeros: true }.merge(options))
end

#format_text(text, _options = {}) ⇒ Object 



168
169
170
171
172
173
 
# File 'app/helpers/symphonia/application_helper.rb', line 168

def format_text(text, _options = {})
  return '' if text.nil?

  markdown = RDiscount.new(text, :smart, :filter_html)
  markdown.to_html.html_safe
end

#has_content?(name) ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'app/helpers/symphonia/application_helper.rb', line 164

def has_content?(name)
  !!(@has_content && @has_content[name])
end

#html_description(*args) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
 
# File 'app/helpers/symphonia/application_helper.rb', line 107

def html_description(*args)
  if args.empty?
    desc = @html_description
    desc ||= t(:meta_description)
    desc.to_s
  else
    @html_description ||= []
    @html_description += args
  end
end

#html_title(*args) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
 
# File 'app/helpers/symphonia/application_helper.rb', line 96

def html_title(*args)
  if args.empty?
    title = @html_title || []
    title << t(:meta_title)
    title.reject(&:blank?).join(' — ')
  else
    @html_title ||= []
    @html_title += args
  end
end

#icon(icon, text = nil, html_options = {}) ⇒ Object

prepend FontAwesome::Sass::Rails::ViewHelpers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'app/helpers/symphonia/application_helper.rb', line 238

def icon(icon, text = nil, html_options = {})
  if text.is_a?(Hash)
    html_options = text
    text = nil
  end

  text_content = if text
                   tag.span(text, class: 'd-none d-sm-inline')
                 elsif html_options[:text]
                   html_options.delete(:text)
                 end
  html_options[:title] ||= text
  html_options[:class] = "fa-solid fa-#{icon}"
  html_options['aria-hidden'] ||= true

  html = tag.i(nil, **html_options)
  html << ' ' << text_content.to_s if text_content.present?
  html
end

#link_to_back(url = nil) ⇒ Object 



187
188
189
 
# File 'app/helpers/symphonia/application_helper.rb', line 187

def link_to_back(url = nil)
  link_to(icon(:back, t(:button_back)), (params[:back_url] || url || :back), class: 'btn btn-link back')
end

#link_to_new_entity(options = {}) ⇒ Object 



191
192
193
194
195
196
197
198
 
# File 'app/helpers/symphonia/application_helper.rb', line 191

def link_to_new_entity(options = {})
  anchor = options.has_key?(:anchor) ? options.delete(:anchor) : 'page_header'
  label = options.delete(:label) || t("label_#{controller_name.singularize}_new")
  model = controller.try(:model) || controller_name.singularize
  url = options.delete(:url) || new_polymorphic_path(model, anchor: anchor)

  link_to(icon('square-plus', text: label), url, { class: 'btn btn-primary' }.merge(options))
end

#multiselect_toggler(id = nil) ⇒ Object 



183
184
185
 
# File 'app/helpers/symphonia/application_helper.rb', line 183

def multiselect_toggler(id = nil)
  link_to(icon('plus'), 'javascript:void(0);', onclick: "toggleMultiSelect(#{id || 'this'});return false", class: 'btn fa fa-border')
end

#render_flash_messages(flash_messages = nil) ⇒ Object

Renders flash messages



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'app/helpers/symphonia/application_helper.rb', line 16

def render_flash_messages(flash_messages = nil)
  s = ""
  Array(flash_messages || flash).each do |type, message|
    bootstrap_flash = bootstrap_flash_map[type]
    s << tag.div(class: "d-print-none alert #{bootstrap_flash[:class_name]} alert-dismissible fade show", role: "alert") do
      icon(bootstrap_flash[:icon], text: message) +
        tag.button("", class: "btn-close close", data: { "bs-dismiss" => "alert" }, "aria-label" => t(:button_close))
    end
  end

  s
end

#render_menu(menu, options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'app/helpers/symphonia/application_helper.rb', line 29

def render_menu(menu, options = {})
  s = ''
  Symphonia::MenuManager.menu(menu).each do |name, item|
    s << render_menu_node(name, item).to_s
  end
  options[:container_class] ||= 'mr-auto'

  tag.ul(s.html_safe, itemscope: '', itemtype: 'http://schema.org/BreadcrumbList', class: "navbar-nav #{options[:container_class]}", id: menu.to_s)
end

#render_menu_link(item, label, _options = {}) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/helpers/symphonia/application_helper.rb', line 72

def render_menu_link(item, label, _options = {})
  url = case item[:url].class.name
        when 'Symbol'
          if item[:url].to_s.include?('.')
            endpoint, path = item[:url].to_s.split('.')
            send(endpoint).send(path)
          else
            main_app.send item[:url]
          end
        when 'Proc'
          item[:url].call(self)
        else
          item[:url]
        end
  link_to(
    (tag.i('', class: "#{item[:icon]}") + "\n" + tag.span(label, itemprop: 'title')).html_safe,
    url,
    class: "nav-link #{item[:class]}",
    data: item[:data],
    method: item[:method],
    itemprop: 'url'
  )
end

#render_menu_node(menu, item, options = {}) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'app/helpers/symphonia/application_helper.rb', line 39

def render_menu_node(menu, item, options = {})
  condition = item[:if] ? item[:if].call : true
  return nil unless condition

  selected = @menu_item.to_sym == menu
  label = case item[:label].class.name
          when 'NilClass'
            '&nbsp;'.html_safe
          when 'String'
            item[:label]
          when 'Symbol'
            t(item[:label])
          when 'Proc'
            item[:label].call(controller)
          else
            raise "MenuManager error: Label is unknown type: #{item[:label].class}"
          end
  if item[:children].blank?
    tag.li(render_menu_link(item, label, options), class: "nav-item #{menu} #{'active' if selected} #{options[:class]}", id: item[:id])
  else
    children = ''
    item[:children].each do |child, subitem|
      children << render_menu_node(menu, subitem, class: 'dropdown-item').to_s
    end
    if children.present?
      tag.li(class: "nav-item dropdown #{menu}") do
        concat render_menu_link(item.merge({ class: 'dropdown-toggle', data: { toggle: 'dropdown' } }), label, { is_submenu: true })
        concat tag.ul(children.html_safe, class: 'dropdown-menu')
      end
    end
  end
end

#render_no_data(message = nil) ⇒ Object 



154
155
156
 
# File 'app/helpers/symphonia/application_helper.rb', line 154

def render_no_data(message = nil)
  tag.div(icon("circle-info", text: message || t(:text_no_data)), class: 'alert alert-info text-center nodata')
end

#render_super(template_name, engine: Symphonia::Engine, format: :html) ⇒ Object

Render original template from engine

Useful for override part of engine view

Examples:

render_super “login/new”

Parameters:

  • template_name (String)
  • engine (Class<Symphonia::Engine>) (defaults to: Symphonia::Engine)
  • format (String) (defaults to: :html) 


270
271
272
273
274
275
276
277
278
 
# File 'app/helpers/symphonia/application_helper.rb', line 270

def render_super(template_name, engine: Symphonia::Engine, format: :html)
  resolver = lookup_context.view_paths.paths.find do |resolver|
    resolver.path == engine.root.join("app", "views").to_s
  end
  template = resolver.find_all(template_name, engine.engine_name, false, { locale: ["."], formats: [format], variants: [], handlers: [:erb] }, nil, {}).first
  return "" unless template

  render template: template
end

#render_symphonia_dialog(*args, &block) ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'app/helpers/symphonia/application_helper.rb', line 280

def render_symphonia_dialog(*args, &block)
  ActiveSupport::Deprecation.warn "Use `render_modal` instead"
  options = args.extract_options!
  title = options[:title] || args.shift # first arg possible `title`
  body = args.shift
  options[:form_disabled] = true
  size = options.delete(:size)
  size ||= '90%' if options.delete(:large)
  if size.to_s.match(%r(^\d+$))
    size = size.to_s + '%'
  end
  @symphonia_modal_dialog = SymphoniaModalDialog.new(self, options)
  @symphonia_modal_dialog.size = size
  if block_given?
    yield @symphonia_modal_dialog
  else
    raise ArgumentError if body.nil?
  end
  @symphonia_modal_dialog.title ||= title
  if @symphonia_modal_dialog.body.blank?
    if body.is_a?(Hash)
      body.merge!(formats: [:html])
    else
      body = { partial: body, formats: [:html] }
    end
    @symphonia_modal_dialog.body = render(body)
  end
  html = @symphonia_modal_dialog.to_html
  if options[:render_only]
    html
  else
    js = %Q(
    $('##{@symphonia_modal_dialog.modal_id}').modal('hide').remove();
    $('body').append('#{j html}');
    showModal('##{@symphonia_modal_dialog.modal_id}');
    $("##{@symphonia_modal_dialog.modal_id} .modal-dialog input:text").first().focus();
    $("##{@symphonia_modal_dialog.modal_id} .modal-dialog .modal-body div.buttons").remove();
  )
    js.concat("$('##{@symphonia_modal_dialog.modal_id} .modal-dialog').css({width: '#{size}'});") if size.present?
    js.html_safe
  end
end

#title(*args, &block) ⇒ Object Also known as: page_header 



118
119
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
145
146
147
148
149
150
 
# File 'app/helpers/symphonia/application_helper.rb', line 118

def title(*args, &block)
  options = args.extract_options!
  header = args.shift
  small = args.shift || ''
  header_text = if header.is_a?(Symbol)
                  t(header, default: header.to_s.humanize)
                else
                  header.to_s.dup
                end
  if @symphonia_modal_dialog
    ActiveSupport::Deprecation.warn "@symphonia_modal_dialog is no used anymore !"
    @symphonia_modal_dialog.title ||= header_text
    ''
  else
    html_title(header_text.dup)
    header_text << ("\n" << tag.small(small, class: 'text-muted')) if small.present?
    s = ''
    if options[:back] && !request.xhr?
      back_url = options[:back] unless options[:back].is_a? TrueClass
      s << link_to_back(back_url)
    end
    s << capture(&block).to_s if block_given?
    header_class = (s.present? && "col-6") || nil
    header_tag = content_tag(((request.xhr? && :h5) || :h1), id: 'page_header', class: header_class) do
      header_text.html_safe
    end
    return header_tag if s.blank?

    tag.div(class: "row") do
      header_tag + tag.div(s.html_safe, class: "col-6 text-right")
    end
  end
end

#will_paginate(collection_or_options = nil, options = {}) ⇒ Object

change the default link renderer for will_paginate



201
202
203
204
205
206
207
208
209
210
 
# File 'app/helpers/symphonia/application_helper.rb', line 201

def will_paginate(collection_or_options = nil, options = {})
  if collection_or_options.is_a? Hash
    options, collection_or_options = collection_or_options, nil
  end
  unless options[:renderer]
    options = options.merge renderer: Symphonia::BootstrapLinkRender
  end
  options[:query] ||= @query if @query
  super *[collection_or_options, options].compact
end