drg_cms 0.6.0.8 → 0.6.1.0

data/app/helpers/cms_helper.rb

@@ -46,7 +46,7 @@ end
 # Field definition will be used for input field on the form.
 ############################################################################
 def dc_get_field_form_definition(name) #:nodoc:
-  return nil if @form['form'].nil?
+  return if @form['form'].nil?
   
   @form['form']['tabs'].each do |tab|
 # Array with 2 elements. First is tabname, second is data      
@@ -67,26 +67,14 @@ end
 # Parameters:
 # options : Hash : Field definition
 # 
-# Returns: 
+# Returns: Array[3]
 #   field_html : String : HTML code for field definition
 #   label : String : Label text
 #   help : String : Help text
 ############################################################################
 def dc_field_label_help(options)
-  # no label or help in comments
-  unless %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
-    # 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']
-    help = t(help, ' ') if help.to_s.match(/helpers\./)
-  end
-  # create field object from type option and call its render method
+  label, help = dc_label_help(options)
+  # create field object from type and call its render method
   if options['type'].present?
     klass_string = options['type'].camelize
     field_html = if DrgcmsFormFields.const_defined?(klass_string) # when field type defined
@@ -101,10 +89,57 @@ def dc_field_label_help(options)
   else
     "Error: Field type missing!"
   end
-
   [field_html, label, help]
 end
 
+############################################################################
+# Return label and help text for a field defined on Form.
+#
+# Parameters:
+# options : Hash : Field definition
+#
+# Returns:
+#   label : String : Label text
+#   help : String : Help text
+############################################################################
+def dc_label_help(options)
+  # no label or help in comments
+  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
+  # 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']
+  help = t(help, ' ') if help.to_s.match(/helpers\./)
+  [label, help]
+end
+
+############################################################################
+# Return label and help for tab on Form.
+#
+# Parameters:
+# options : String : Tab name on form
+#
+# Returns:
+#   label : String : Label text
+#   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))
+
+  help = @form['form']['tabs'][tab_name]['help'] || "helpers.help.#{@form['table']}.#{tab_name}"
+  help = t(help, t_name(help, help))
+  help = nil if help.match('helpers.') # help not found in translation
+
+  [label, help]
+end
+
 ############################################################################
 # Creates code for including data entry field in index actions.
 ############################################################################
@@ -149,7 +184,8 @@ end
 ############################################################################
 def dc_link_ajax_window_submit_action(yaml, record=nil, action_active=true)
   parms = {}
-  caption = yaml['caption'] ? t("#{yaml['caption'].downcase}", yaml['caption']) : nil
+  caption = yaml['caption'] || yaml['text']
+  caption = caption ? t("#{caption.downcase}", caption) : nil
   icon    = yaml['icon'] ? "#{fa_icon(yaml['icon'])}" : ''
   # action is not active
   unless dc_is_action_active?(yaml)
@@ -158,14 +194,14 @@ def dc_link_ajax_window_submit_action(yaml, record=nil, action_active=true)
   # set data-confirm when confirm 
   yaml['html'] ||= {}
   confirm = yaml['html']['data-confirm'] || yaml['confirm']
-  yaml['html']['data-confirm'] = t(confirm) unless confirm.blank?
+  yaml['html']['data-confirm'] = t(confirm) if confirm.present?
   yaml['html']['title'] ||= yaml['title']
-  yaml['html']['title'] = t(yaml['title'])
+  yaml['html']['title'] = t(yaml['title']) if yaml['title'].present?
   yaml['html']['target'] ||= yaml['target']
   # direct url
   if yaml['url']
-    parms['controller'] = yaml['url'] 
-    parms['idr']        = dc_document_path(record) if record
+    parms['url'] = yaml['url']
+    parms['idr'] = dc_document_path(record) if record
   # make url from action controller
   else
     parms['controller'] = yaml['controller'] || 'cmsedit'
@@ -178,16 +214,18 @@ def dc_link_ajax_window_submit_action(yaml, record=nil, action_active=true)
   # add current id to parameters
   parms['id'] = dc_document_path(record) if record
   # overwrite with or add additional parameters from environment or record
-  yaml['params'].each { |k,v| parms[k] = dc_value_for_parameter(v) } if yaml['params']
+  yaml['params'].each { |k, v| parms[k] = dc_value_for_parameter(v, record) } if yaml['params']
+
   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>"
   else
-    yaml['caption'] ||= yaml['text']
+    #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"
@@ -204,7 +242,7 @@ def dc_link_ajax_window_submit_action(yaml, record=nil, action_active=true)
 
     elsif yaml['type'] == 'link'  # link button
       clas = "dc-link dc-animate"
-      link = dc_link_to(yaml['caption'], yaml['icon'], parms, html_data )
+      link = dc_link_to(caption, yaml['icon'], parms, yaml['html'] )
       %Q[<li class="#{clas}">#{action_active ? link : caption}</li>]
 
     elsif yaml['type'] == 'window'

data/app/helpers/cms_index_helper.rb

@@ -47,13 +47,13 @@ def dc_actions_for_index()
     actions['standard'] = nil
   end
   
-# start div with hidden spinner image 
-  html = <<EOT
+  # start div with hidden spinner image
+  html = %(
 <form id="dc-action-menu">
   <span class="dc-spinner">#{fa_icon('spinner lg spin')}</span>
-  <ul class="dc-action-menu">
-EOT
-# Remove actions settings and sort
+  <ul class="dc-action-menu">)
+
+  # Remove actions settings and sort
   only_actions = []
   actions.each { |key, value| only_actions << [key, value] if key.class == Integer }
   only_actions.sort_by!(&:first)
@@ -67,7 +67,7 @@ EOT
       dc_deprecate "action: url will be deprecated. Use action: link in index: actions! Form #{params['form_name']}"
       action = 'link' 
     end
-# if return_to is present link directly to URL 
+    # if return_to is present link directly to URL
     if action == 'link' and yaml['url']
       url = yaml['url']
     else
@@ -77,11 +77,12 @@ EOT
       url['form_name']  = yaml['form_name'] if yaml['form_name']
       url['control']    = yaml['control'] if yaml['control']
     end
-# html link options
+    # html link options
     yhtml = yaml['html'] || {}
     yhtml['title'] = yaml['title'] if yaml['title']
-    code = case 
-# sort
+
+    code = case
+    # sort
     when action == 'sort' then 
       choices = [['id','id']]
       if @form['index']['sort']
@@ -93,11 +94,12 @@ EOT
       fa_icon('sort-alpha-asc') + ' ' + t('drgcms.sort') + ' ' + 
               select('sort', 'sort', choices, { include_blank: true }, 
               { class: 'drgcms_sort', 'data-table' => @form['table'], 'data-form' => params['form_name']} )
-# filter
+
+    # filter
     when action == 'filter' then 
       caption = t('drgcms.filter')
       caption << '&nbsp;' + fa_icon('caret-down lg') + DcFilter.menu_filter(self)
-# add filter OFF link
+      # add filter OFF link
       sess = session[@form['table']]
       if sess and sess[:filter]
         caption << '&nbsp;&nbsp;' + dc_link_to(nil,'remove lg',
@@ -105,11 +107,13 @@ EOT
                    { title: DcFilter.title4_filter_off(sess[:filter]) })
       end
       caption
-# new
+
+    # new
     when action == 'new' then 
       caption = yaml['caption'] || 'drgcms.new'
       dc_link_to(caption,'plus', url, yhtml )
-# menu      
+
+    # menu
     when action == 'menu' then  
       caption = t(options['caption'], options['caption']) + '&nbsp;' + fa_icon('caret-down lg')
       caption + eval(options['eval'])      
@@ -126,13 +130,16 @@ EOT
     when action == 'script'
       html << dc_script_action(options)
       next
+
     when action == 'field'
       html << dc_field_action(yaml) 
       next 
+
     when %w(ajax link window submit).include?(action)
       html << dc_link_ajax_window_submit_action(options, nil)
       next
-    else 
+
+    else
       caption = yaml['caption'] || yaml['text']
       icon    = yaml['icon'] ? yaml['icon'] : action
       dc_link_to(caption, icon, url, yhtml)
@@ -140,22 +147,21 @@ EOT
     html << "<li class=\"dc-link dc-animate\">#{code}</li>"
     html << DcFilter.get_filter_field(self) if action == 'filter'
   end
-  html << '</ul>'
-  html << '</form>'
+  html << '</ul></form>'
   html.html_safe
 end
 
 ############################################################################
 # Creates filter div for cmsedit index/filter action.
 ############################################################################
-def dc_div_filter()
+def dc_div_filter
   choices = []
   filter = (@form['index'] and @form['index']['filter']) ? @form['index']['filter'] + ',' : ''
   filter << 'id as text_field' # filter id is added by default
   filter.split(',').each do |f| 
     f.strip!
     name = f.match(' as ') ? f.split(' ').first : f
-# like another field on the form
+    # like another field on the form
     if f.match(' like ')
       a    = f.split(' ')
       name = a.first
@@ -164,7 +170,7 @@ def dc_div_filter()
     choices << [ t("helpers.label.#{@form['table']}.#{name}", name), f ] 
   end
   choices4_operators = t('drgcms.choices4_filter_operators').chomp.split(',').inject([]) {|r,v| r << (v.match(':') ? v.split(':') : v )}
-# currently selected options
+  # currently selected options
   if session[@form['table']] and session[@form['table']][:filter]
     field_name, operators_value, dummy = session[@form['table']][:filter].split("\t")
   else
@@ -190,7 +196,7 @@ end
 ############################################################################
 # Creates popup div for setting filter on result set header.
 ############################################################################
-def dc_filter_popup()
+def dc_filter_popup
   html = %Q[<div class="filter-popup" style="display: none;">
   <div>#{t('drgcms.filter_set')}</div>
   <ul>]
@@ -204,20 +210,22 @@ def dc_filter_popup()
 end
 
 ############################################################################
-# Creates title div for cmsedit index result set records. Title div also includes paging 
-# options.
+# Will return title based on @form['title']
 ############################################################################
-def dc_table_title_for_result(result=nil)
-  title = if @form['title'] # form has title section
-    if @form['title'].class == Hash
-      dc_process_eval(@form['title']['eval'], [@form['title']['caption'] || @form['title']['text'], params])
-    else
-      t(@form['title'], @form['title'])
-    end
-  else # get name from translations
-    t("helpers.label.#{@form['table']}.tabletitle", @form['table'])
-  end
-  dc_table_title(title, result)
+def dc_form_title
+  return t("helpers.label.#{@form['table']}.tabletitle", @form['table'])  if @form['title'].nil?
+  return t(@form['title'], @form['title']) if @form['title'].class == String
+
+  # Hash
+  dc_process_eval(@form['title']['eval'], [@form['title']['caption'] || @form['title']['text'], params])
+end
+
+############################################################################
+# Creates title div for index action. Title div also includes paging options
+# and help link
+############################################################################
+def dc_title_for_index(result = nil)
+  dc_table_title(dc_form_title(), result)
 end
 
 ############################################################################
@@ -225,15 +233,16 @@ end
 ############################################################################
 def dc_actions_column
   actions = @form['result_set']['actions']
-  return [{}, 0] if actions.nil? or dc_dont?(actions)
-# standard actions  
+  return [{}, 0] if actions.nil? || dc_dont?(actions)
+
+  # standard actions
   actions = {'standard' => true} if actions.class == String && actions == 'standard'
   std_actions = { 2 => 'edit', 5 => 'delete' }
   if actions['standard']
     actions.merge!(std_actions) 
     actions.delete('standard')
   end
-#  
+
   width = @form['result_set']['actions_width'] || 18*actions.size
   [actions, width]
 end
@@ -263,7 +272,7 @@ def dc_actions_for_result(document)
     # if single definition simulate type parameter
     yaml = v.class == String ? { 'type' => v } : v
     # code already includes li tag
-    if %w(ajax link window submit).include?(yaml['type']) then
+    if %w(ajax link window submit).include?(yaml['type'])
       @record = document # otherwise document fields can't be used as parameters
       html << dc_link_ajax_window_submit_action(yaml, document)
     else
@@ -325,7 +334,7 @@ def dc_header_for_result()
       th = %Q[<div class="th" style="width:#{v['width'] || '15%'};text-align:#{v['align'] || 'left'};" data-name="#{v['name']}"]
       label = v['caption'] || v['label']
       label = (v['name'] ? "helpers.label.#{@form['table']}.#{v['name']}" : '') if label.nil?
-      label = t(label) if label.match(/helpers\./)
+      label = t(label) if label.match(/\./)
       # no sorting when embedded documents or custom filter is active 
       sort_ok = @form['result_set'].nil? || (@form['result_set'] && @form['result_set']['filter'].nil?)
       sort_ok = sort_ok || (@form['index'] && @form['index']['sort'])
@@ -364,9 +373,9 @@ def dc_clicks_for_result(document)
     html << ' data-dblclick=' + url_for(opts) 
   else
      html << (' data-dblclick=' +
-       url_for(action: 'show', controller: 'cmsedit', id: document.id, 
-       readonly: (params[:readonly] ? 2 : 1), table: params[:table],
-       form_name: params[:form_name], ids: params[:ids])  ) if @form['form'] 
+                url_for(action: 'show', controller: 'cmsedit', id: document.id, ids: params[:ids],
+                        readonly: (params[:readonly] ? 2 : 1), table: params[:table],
+                        form_name: params[:form_name]) ) if @form['form']
   end
   html
 end
@@ -466,8 +475,8 @@ def dc_process_eval(evaluate, parameters)
 end
 
 ############################################################################
-# Break eval expression to array by parameters.
-# Will break dc_name4_value(one ,"two") => ['dc_name4_value', 'one', 'two']
+# Split eval expression to array by parameters.
+# Will split dc_name4_value(one ,"two") => ['dc_name4_value', 'one', 'two']
 ############################################################################
 def dc_eval_to_array(expression)
   expression.split(/\ |\,|\(|\)/).delete_if {|e| e.blank? }.map {|e| e.gsub(/\'|\"/,'').strip }
@@ -479,44 +488,46 @@ end
 ############################################################################
 def dc_process_column_eval(yaml, document)
   # dc_name_for_id
-  if yaml['eval'].match('dc_name4_id') || yaml['eval'].match('dc_name_for_id')
-    prms = dc_eval_to_array(yaml['eval'])
-    if prms.size == 3
-      dc_name_for_id(prms[1], prms[2], nil, document[ yaml['name'] ])
+  if yaml['eval'].match(/dc_name4_id|dc_name_for_id/)
+    parms = dc_eval_to_array(yaml['eval'])
+    if parms.size == 3
+      dc_name_for_id(parms[1], parms[2], nil, document[ yaml['name'] ])
+    else
+      dc_name_for_id(parms[1], parms[2], parms[3], document[ yaml['name'] ])
+    end
+
+  # dc_name_for_value from locale definition
+  elsif yaml['eval'].match(/dc_name4_value|dc_name_for_value/)
+    parms = dc_eval_to_array(yaml['eval'])
+    if parms.size == 1
+      dc_name_for_value( @form['table'], yaml['name'], document[ yaml['name'] ] )
     else
-      dc_name_for_id(prms[1], prms[2], prms[3], document[ yaml['name'] ])
+      dc_name_for_value( parms[1], parms[2], document[ yaml['name'] ] )
     end
-  # dc_name_for_value from this model
-  elsif yaml['eval'] == 'dc_name4_value' || yaml['eval'] == 'dc_name_for_value'
-    dc_name_for_value( @form['table'], yaml['name'], document[ yaml['name'] ] )
-  # dc_name_for_value from other model  
-  elsif yaml['eval'].match('dc_name4_value') || yaml['eval'].match('dc_name_for_value')
-    prms = dc_eval_to_array(yaml['eval'])
-    dc_name_for_value( prms[1], prms[2], document[ yaml['name'] ] )
-  # for example dc_icon_for_boolean
+
+  # defined in helpers. For example dc_icon_for_boolean
   elsif respond_to?(yaml['eval'])
-    send(yaml['eval'], document[ yaml['name'] ])
-  # defined in document
+    send(yaml['eval'], document[yaml['name']])
+
+  # defined in model
   elsif document.respond_to?(yaml['eval'])
     document.send(yaml['eval'])
+
   # special eval  
   elsif yaml['eval'].match('eval ')
   # TO DO evaluate with specified parameters
+
+  # eval with params
   else
-    parameters = if yaml['params']
-      # pass document as parameter
-      if yaml['params'] == 'document' or yaml['params'] == 'record'     
-        document
-      else
-        yaml['params'].chomp.split(',').inject([]) do |result,e| 
-          result << document[e.strip]
-        end        
-      end        
+    parms = {}
+    if yaml['params'].class == String
+      parms = dc_value_for_parameter(yaml['params'], document)
+    elsif yaml['params'].class == Hash
+      yaml['params'].each { |k, v| parms[k] = dc_value_for_parameter(v) }
     else
-      document[ yaml['name'] ]
+      parms = document[ yaml['name'] ]
     end
-    # evaluate by calling send method 
-    dc_process_eval(yaml['eval'], parameters)
+    dc_process_eval(yaml['eval'], parms)
   end
 end
 
@@ -525,7 +536,8 @@ end
 ############################################################################
 def dc_style_or_class(selector, yaml, value, record)
   return '' if yaml.nil?
-# alias record and value so both names can be used in eval
+
+  # alias record and value so both names can be used in eval
   field, document = value, record
   html = selector ? "#{selector}=\"" : ''
   html << if yaml.class == String
@@ -534,7 +546,7 @@ def dc_style_or_class(selector, yaml, value, record)
   elsif yaml['eval']
     eval(yaml['eval']) rescue 'background-color:red;'
   elsif yaml['method']
-    dc_process_eval(yaml['method'],record)
+    dc_process_eval(yaml['method'], record)
   end
   html << '"' if selector 
   html