drg_cms 0.6.1.5 → 0.6.1.11

data/app/helpers/cms_helper.rb

@@ -34,11 +34,17 @@ module CmsHelper
 # Creates code for script action type.
 ############################################################################
 def dc_script_action(yaml)
-#  data = {'request' => 'script', 'script' => yaml['js'] || yaml['script'] }
-#  %Q[<li class="dc-link-ajax with-link dc-animate">#{ dc_link_to(yaml['caption'], yaml['icon'], '#', data: data ) }</li>]
   icon = dc_icon_for_link yaml['icon']
-  data = %(data-request="script" data-script="#{yaml['js'] || yaml['script']}" data-url="script")
-  %Q[<li class="dc-link-ajax dc-animate" #{data}>#{icon} #{ t(yaml['caption'],yaml['caption']) }</li>]
+  yaml['html'] ||= {}
+  yaml['html']['data-url'] = 'script'
+  yaml['html']['data-request'] = 'script'
+  yaml['html']['data-script'] = "#{yaml['js'] || yaml['script']}"
+  yaml['html']['class'] ||= 'dc-link-ajax'
+  attributes = yaml['html'].inject('') { |r, e| r << "#{e.first}=\"#{e.last}\"" }
+
+  #  data = %(data-request="script" data-script="#{yaml['js'] || yaml['script']}" data-url="script")
+  #%(<li><div class="dc-link-ajax" #{data}>#{icon} #{ t(yaml['caption'], yaml['caption']) }</div></li>)
+  %(<li><div #{attributes}>#{icon} #{ t(yaml['caption'], yaml['caption']) }</div></li>)
 end
 
 ############################################################################
@@ -49,11 +55,11 @@ def dc_get_field_form_definition(name) #:nodoc:
   return if @form['form'].nil?
   
   @form['form']['tabs'].each do |tab|
-# Array with 2 elements. First is tabname, second is data      
+    # Array with 2 elements. First is tab name, second is data
     my_fields = tab.last
-    my_fields.each {|k,v| return v if (k.class == Integer and v['name'] == name) }
+    my_fields.each { |k, v| return v if (k.class == Integer && v['name'] == name) }
   end if @form['form']['tabs'] #  I know. But nice. 
-#
+
   @form['form']['fields'].each do |field|
     next unless field.first.class == Integer # options
     return field.last if field.last['name'] == name
@@ -107,11 +113,13 @@ def dc_label_help(options)
   return [nil, nil] if %w(comment action).include?(options['type'])
 
   label = options['caption'] || options['text'] || options['label']
-  label = if label.blank?
-            t_name(options['name'], options['name'].capitalize.gsub('_',' ') )
-          elsif options['name']
-            t(label, label)
-          end
+  if options['name']
+    label = if label.blank?
+              t_label_for_field(options['name'], options['name'].capitalize.gsub('_',' ') )
+            elsif options['name']
+              t(label, label)
+            end
+  end
   # help text can be defined in form or in translations starting with helpers. or as helpers.help.collection.field
   help = options['help']
   help ||= "helpers.help.#{@form['table']}.#{options['name']}" if options['name']
@@ -130,11 +138,11 @@ end
 #   help : String : Help text
 ############################################################################
 def dc_tab_label_help(tab_name)
-  label = @form['form']['tabs'][tab_name]['caption'] || tab_name
-  label = t(label, t_name(label, label))
+  label = @form.dig('form', 'tabs', tab_name, 'caption') || tab_name
+  label = t(label, t_label_for_field(label, label))
 
-  help = @form['form']['tabs'][tab_name]['help'] || "helpers.help.#{@form['table']}.#{tab_name}"
-  help = t(help, t_name(help, help))
+  help = @form.dig('form', 'tabs', tab_name, 'help') || "helpers.help.#{@form['table']}.#{tab_name}"
+  help = t(help, t_label_for_field(help, help))
   help = nil if help.match('helpers.') # help not found in translation
 
   [label, help]
@@ -160,7 +168,7 @@ def dc_field_action(yaml)
   end
   # input field will have label as placeholder
   field = field.sub('input',"input placeholder=\"#{label}\"")
-  %Q[<li class="no-background">#{field}</li>]
+  %(<li class="no-background">#{field}</li>)
 end
 
 ############################################################################
@@ -168,9 +176,17 @@ end
 ############################################################################
 def dc_html_data(yaml)
   return '' if yaml.blank?
-  yaml.inject(' ') {|result, e| result = e.last.nil? ? result : result << "#{e.first}=\"#{e.last}\" "}
+
+  yaml.inject(' ') { |result, e| result = e.last.nil? ? result : result << "#{e.first}=\"#{e.last}\" " }
 end
 
+############################################################################
+# There are several options for defining caption (caption,label, text). This method
+# will ensure that caption is returned anyhow provided.
+############################################################################
+def dc_get_caption(yaml)
+  yaml['caption'] || yaml['text'] || yaml['label']
+end
 ############################################################################
 # Creates code for link, ajax or windows action for index or form actions.
 # 
@@ -184,19 +200,21 @@ end
 ############################################################################
 def dc_link_ajax_window_submit_action(yaml, record = nil, action_active = true)
   parms = {}
-  caption = yaml['caption'] || yaml['text']
+  caption = dc_get_caption(yaml)
   caption = caption ? t("#{caption.downcase}", caption) : nil
   icon    = yaml['icon'] ? "#{fa_icon(yaml['icon'])}" : ''
   # action is not active
   unless dc_is_action_active?(yaml)
-    return "<li class=\"dc-link-no\">#{icon} #{caption}</li>" 
+    return %(<li><div class="dc-link-no">#{icon} #{caption}</div></li>)
   end
-  # set data-confirm when confirm 
+  # set data-confirm when confirm shortcut present
   yaml['html'] ||= {}
-  confirm = yaml['html']['data-confirm'] || yaml['confirm']
-  yaml['html']['data-confirm'] = t(confirm) if confirm.present?
-  yaml['html']['title'] ||= yaml['title']
-  yaml['html']['title'] = t(yaml['title']) if yaml['title'].present?
+  text = yaml['html']['data-confirm'] || yaml['confirm']
+  yaml['html']['data-confirm'] = t(text) if text.present?
+
+  text = yaml['html']['title'] || yaml['title']
+  yaml['html']['title'] = t(text) if text.present?
+
   yaml['html']['target'] ||= yaml['target']
   # direct url
   if yaml['url']
@@ -218,41 +236,57 @@ def dc_link_ajax_window_submit_action(yaml, record = nil, action_active = true)
 
   parms['table'] = parms['table'].underscore if parms['table'] # might be CamelCase
   # error if controller parameter is missing
-  if parms['controller'].nil? && parms['url'].nil?
-    "<li>#{'Controller not defined'}</li>"
+  return "<li>#{'Controller not defined'}</li>" if parms['controller'].nil? && parms['url'].nil?
+
+  html_data = dc_html_data(yaml['html'])
+  url = url_for(parms) rescue 'URL error'
+  url = nil if parms['url'] == '#'
+  request = yaml['request'] || yaml['method'] || 'get'
+
+  code = case yaml['type']
+  when 'ajax' # ajax button
+    clas = 'dc-link-ajax'
+    %(<div class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}
+       data-request="#{request}" title="#{yaml['title']}">#{icon}#{caption}</div>)
+
+  when 'submit'  # submit button
+    # It's dirty hack, but will prevent not authorized message and render index action correctly
+    parms[:filter] = 'on'
+    url  = url_for(parms) rescue 'URL error'
+    clas = 'dc-action-submit'
+    %(<div class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}
+       data-request="#{request}" title="#{yaml['title']}">#{icon}#{caption}</div>)
+
+  when 'link'  # link button
+    yaml['html'] = dc_yaml_add_option(yaml['html'], class: 'dc-link')
+    link = dc_link_to(caption, yaml['icon'], parms, yaml['html'] )
+    %(#{action_active ? link : caption})
+
+  when 'window' # open window
+    clas = 'dc-link dc-window-open'
+    %(<div class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}>#{icon}#{caption}</div>)
+
+  when 'popup' # popup dialog
+    clas = 'dc-link dc-popup-open'
+    %(<div class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}>#{icon}#{caption}</div>)
+
   else
-    #yaml['caption'] ||= yaml['text']
-    html_data = dc_html_data(yaml['html'])
-    url = url_for(parms) rescue 'URL error'
-    url = nil if parms['url'] == '#'
-
-    request = yaml['request'] || yaml['method'] || 'get'
-    if yaml['type'] == 'ajax' # ajax button
-      clas = "dc-link-ajax dc-animate"
-      %Q[<li class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}
-         data-request="#{request}" title="#{yaml['title']}">#{icon}#{caption}</li>]
-
-    elsif yaml['type'] == 'submit'  # submit button
-      # It's dirty hack, but will prevent not authorized message and render index action correctly
-      parms[:filter] = 'on' 
-      url  = url_for(parms) rescue 'URL error'
-      clas = "dc-action-submit"
-      %Q[<li class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}
-         data-request="#{request}" title="#{yaml['title']}">#{icon}#{caption}</li>]
-
-    elsif yaml['type'] == 'link'  # link button
-      clas = "dc-link plus-link dc-animate"
-      link = dc_link_to(caption, yaml['icon'], parms, yaml['html'] )
-      %Q[<li class="#{clas}">#{action_active ? link : caption}</li>]
-
-    elsif yaml['type'] == 'window'
-      clas = "dc-link dc-animate dc-window-open"
-      %Q[<li class="#{clas}" data-url="#{action_active ? url : ''}" #{html_data}>#{icon}#{caption}</li>]
+    'Type error!'
+  end
+  "<li>#{code}</li>"
+end
 
-    else
-      '<li>Action Type error</li>'
-    end
+############################################################################
+# Add new option to yaml. Subroutine of dc_link_ajax_window_submit_action.
+############################################################################
+def dc_yaml_add_option(source, options) #nodoc
+  options.each do |k, v|
+    key = k.to_s
+    source[key] ||= ''
+    # only if not already present
+    source[key] << " #{v}" unless source[key].match(v.to_s)
   end
+  source
 end
 
 ############################################################################
@@ -260,9 +294,68 @@ end
 ############################################################################
 def dc_log_exception(exception, where = '')
   log = exception ? "\n*** Error:#{where + ':'} #{exception.message}\n#{exception.backtrace.first.inspect}\n" : ''
-  log << "DRG Form processing line: #{session[:form_processing]}\n"
+  log << "DRG Form: #{CmsHelper.form_param(params)}, line: #{session[:form_processing]}\n"
   
   logger.error log
 end
-  
+
+############################################################################
+# Will return form id, to be used on each form for simpler css selecting.
+############################################################################
+def dc_form_id
+  %( id=#{CmsHelper.form_param(params) || CmsHelper.table_param(params)} )
+end
+
+############################################################################
+# Will return form_name from parameter regardless if set as form_name or just f.
+############################################################################
+def self.form_param(params)
+  params[:form_name] || params[:f]
+end
+
+############################################################################
+# Will return table name from parameter regardless if set as table or just t.
+############################################################################
+def self.table_param(params)
+  params[:table] || params[:t]
+end
+
+########################################################################
+# Searches forms path for file_name and returns full file name or nil if not found.
+#
+# @param [String] Form file name. File name can be passed as gem_name.filename. This can
+# be useful when you are extending form but want to retain same name as original form
+# For example. You are extending dc_user form from drg_cms gem and want to
+# retain same dc_user name. This can be done by setting drg_cms.dc_user as extend option.
+#
+# @return [String] Form file name including path or nil if not found.
+########################################################################
+def self.form_file_find(form_file)
+  form_path = nil
+  form_path, form_file = form_file.split(/\.|\//) if form_file.match(/\.|\//)
+
+  DrgCms.paths(:forms).reverse.each do |path|
+    f = "#{path}/#{form_file}.yml"
+    return f if File.exist?(f) && (form_path.nil? || path.to_s.match(/\/#{form_path}(-|\/)/i))
+  end
+  raise "Exception: Form file '#{form_file}' not found!"
+end
+
+########################################################################
+# Merges two forms when current form extends other form. Subroutine of dc_form_read.
+# With a little help of https://www.ruby-forum.com/topic/142809
+########################################################################
+def self.forms_merge(hash1, hash2)
+  target = hash1.dup
+  hash2.keys.each do |key|
+    if hash2[key].is_a?(Hash) && hash1[key].is_a?(Hash)
+      target[key] = CmsHelper.forms_merge(hash1[key], hash2[key])
+      next
+    end
+    target[key] = hash2[key] == '/' ? nil :  hash2[key]
+  end
+  # delete keys with nil value
+  target.delete_if { |k, v| v.nil? }
+end
+
 end