drg_cms 0.6.0.6 → 0.6.1.4

data/app/helpers/{cmsedit_edit_helper.rb → cms_edit_helper.rb}

@@ -27,17 +27,19 @@
 # data found in 3 major sections of DRG CMS form: index, result_set and form sections. 
 #
 ###########################################################################
-module CmseditEditHelper
+module CmsEditHelper
 
 ############################################################################
 # Will return value when internal or additional parameters are defined in action
 # Subroutine of dc_actions_for_form.
 ############################################################################
-def dc_value_for_parameter(param)#:nodoc:
+def dc_value_for_parameter(param, current_document = nil)#:nodoc:
   if param.class == Hash
-    dc_internal_var(param['object'] || 'record', param['method'])
+    dc_internal_var(param['object'] ||= 'record', param['method'], current_document)
+  elsif param.to_s.match(/record|document/)
+    current_document ? current_document : @record
   else
-    param    
+    param
   end
 end
 
@@ -51,9 +53,10 @@ end
 def dc_is_action_active?(options)
   if options['when_new']
     dc_deprecate("when_option will be deprecated and replaced by active: not_new_record! Form #{params[:form_name]}") 
-    return !(dc_dont?(options['when_new']) and @record.new_record?)
+    return !(dc_dont?(options['when_new']) && @record.new_record?)
   end
   return true unless options['active']
+
   # alias record and document so both can be used in eval
   record = document = @record
   option = options['active']
@@ -61,14 +64,20 @@ def dc_is_action_active?(options)
   # usually only for test
   when option.class  == TrueClass || option['eval'].class == TrueClass then true    
   when option.class == String then
-    (@record.new_record? && option == 'new_record') || (!@record.new_record? && option == 'not_new_record')
+    if option.match(/new_record/i)
+      (@record.new_record? && option == 'new_record') || (!@record.new_record? && option == 'not_new_record')
+    elsif option.match(/\./)
+      # shortcut for method and eval option
+      dc_process_eval(option, self)
+    else
+      eval(option['eval'])
+    end
   # direct evaluate expression
   when option['eval'] then
     eval(option['eval'])
   when option['method'] then
-    # if record present send record otherwise send params as parameter
-    parms = @record ? @record : params
-    dc_process_eval(option['method'],parms)
+    # if record present send record otherwise send self as parameter
+    dc_process_eval(option['method'], self)
   else
     false
   end  
@@ -82,31 +91,40 @@ end
 # normal link.
 ############################################################################
 def dc_actions_for_form(position)
-# create standard actions  
+  # create standard actions
   std_actions = {1 => 'back', 2 => {'type' => 'submit', 'caption' => 'drgcms.save'},
                  3 => {'type' => 'submit', 'caption' => 'drgcms.save&back'} }
-# when edit only  
+  # when edit only
   unless @record.try(:id).nil?
     std_actions.merge!({6 => 'new'} )
     std_actions.merge!(@record.active ? {5 => 'disable'} : {5 => 'enable'} ) if @record.respond_to?('active')
     std_actions.merge!({7 => 'refresh'} )
   end
+  # readonly
+  std_actions = { 1 => 'back' } if @form['readonly']
+
   actions = @form['form']['actions']
-# shortcut for actions: standard 
+  # shortcut for actions: standard
   actions = nil if actions.class == String && actions == 'standard'
-# standard actions
   actions = std_actions if actions.nil?
-# readonly 
-  actions = {1 => 'back'} if @form['readonly']
-# Actions are strictly forbidden 
-  if @form['form']['actions'] and dc_dont?(@form['form']['actions'])
+
+  # Actions are strictly forbidden
+  if @form['form']['actions'] && dc_dont?(@form['form']['actions'])
     actions = []
   elsif actions['standard']
     actions.merge!(std_actions)
     actions['standard'] = nil
   end
-# Update save and save&back
-  actions.each do |k,v| 
+  # request for close window button present
+  if actions.class == Hash
+    case params[:window_close]
+    when '0' then actions[1] = 'close'; actions[3] = nil
+    when '1' then actions = { 1 => 'close' }
+    when '2' then actions = { 1 => 'close' }
+    end
+  end
+  # Update save and save&back
+  actions.each do |k, v|
     if v.class == String 
       if v.match(/save\&back/i)
         actions[k] = {'type' => 'submit', 'caption' => 'drgcms.save&back'}
@@ -115,10 +133,10 @@ def dc_actions_for_form(position)
       end
     end
   end
-# remove standard option and sort so that standard actions come first
+  # remove standard option and sort so that standard actions come first
   actions.delete('standard')
-  actions = actions.to_a.sort {|x,y| x[0] <=> y[0]} 
-# Add spinner to the beginning
+  actions = actions.to_a.sort { |x, y| x[0] <=> y[0] }
+  # Add spinner to the beginning
   html = %Q[<span class="dc-spinner">#{fa_icon('spinner lg spin')}</span><ul class="dc-menu #{position}">]
   
   actions.each do |key, options|
@@ -126,12 +144,12 @@ def dc_actions_for_form(position)
     next if options.nil?  # yes it happends
     parms = @parms.clone
     if options.class == String
-      next if params[:readonly] and !(options == 'back')
+      next if @form['readonly'] and !options.match(/back|close/)
       
       html << '<li class="dc-link dc-animate">'
       html << case 
         when (options == 'back' or options == 'cancle') then
-# If return_to is present link directly to URL        
+          # If return_to is present link directly to URL
           if parms['xreturn_to'] # disabled for now
             dc_link_to( 'drgcms.back','arrow-left', parms['return_to'] )
           else
@@ -162,12 +180,23 @@ def dc_actions_for_form(position)
           
         when options == 'refresh' then
           "<div onclick='window.location.href=window.location.href;'>#{fa_icon('refresh')} #{t('drgcms.refresh')}</div></li>"
+          
+        when options == 'close' then
+          close = params[:window_close].to_i
+          if close < 2
+            "<div onclick='window.close();'>#{fa_icon('close')} #{t('drgcms.close')}</div></li>"
+          else
+            "<div onclick='history.back();'>#{fa_icon('close')} #{t('drgcms.close')}</div></li>"
+          end
       else 
         "err1 #{key}=>#{options}"
       end
       html << '</td>'
     # non standard actions      
     else
+      # action will be displayed when show: always or readonly option is declared and form is readonly
+      next if @form['readonly'] && !%w[readonly always].include?(options['show'].to_s)
+
       options['title'] = t("#{options['title'].downcase}", options['title']) if options['title']
       html << case 
       # submit button
@@ -216,7 +245,7 @@ def dc_background_for_result(start)
   if start == :start
     html = '<div class="dc-result-div" ' 
     html << (@form['result_set']['table_style'] ? 'style="overflow-x: scroll;" >' : '>')
-  #
+
     html << "\n<div class=\"dc-result #{@form['result_set']['table_class']}\" "
     html << (@form['result_set']['table_style'] ? "style=\"#{@form['result_set']['table_style']}\" >" : '>')
   else
@@ -247,21 +276,13 @@ def dc_check_and_default(value, default, values=nil) #:nodoc:
   value
 end
 
-############################################################################
-# Creates top or bottom horizontal line on form. 
-############################################################################
-def dc_top_bottom_line(options)
-  '<div class="dc-separator"></div>'
-end    
-
 ############################################################################
 # Creates input fields for one tab. Subroutine of dc_fields_for_form.
 ############################################################################
 def dc_fields_for_tab(fields_on_tab) #:nodoc:
-  html   = '<div class="dc-form">'
-  labels_pos = dc_check_and_default(@form['form']['labels_pos'], 'right', ['top','left','right'])
-  hidden_fields  = ''
-  odd_even       = nil
+  html = '<div class="dc-form">'
+  labels_pos = dc_check_and_default(@form['form']['labels_pos'], 'right', ['top', 'left', 'right'])
+  hidden_fields, odd_even = '', nil
   group_option, group_count = 0, 0
   reset_cycle()
   # Select form fields and sort them by key
@@ -278,8 +299,8 @@ def dc_fields_for_tab(fields_on_tab) #:nodoc:
     # label
     field_html,label,help = dc_field_label_help(options)
     # Line separator
-    html << dc_top_bottom_line(options['top-line']) if options['top-line']
-    # Begining of new row
+    html << dc_top_bottom_line(:top, options)
+    # Beginning of new row
     if group_count == 0
       html << '<div class="row-div">' 
       odd_even = cycle('odd','even')
@@ -320,49 +341,50 @@ def dc_fields_for_tab(fields_on_tab) #:nodoc:
       html << '<div></div>' if group_option == 2
     end
     
-    html << dc_top_bottom_line(options['bottom-line']) if options['bottom-line']
+    html << dc_top_bottom_line(:bottom, options)
   end
   html << '</div>' << hidden_fields
 end
 
 ############################################################################
-# Creates edit form div. 
+# Creates edit form from fields or tabs options
 ############################################################################
-def dc_fields_for_form()
+def dc_fields_for_form
   html, tabs, tab_data = '',[], ''
   @js  ||= ''
   @css ||= ''
-# Only fields defined  
+  # Only fields defined
   if (form_fields = @form['form']['fields'])
     html << "<div id='data_fields' " + (@form['form']['height'] ? "style=\"height: #{@form['form']['height']}px;\">" : '>')  
     html << dc_fields_for_tab(form_fields) + '</div>'
   else
-# there are multiple tabs on form 
+    # there are multiple tabs on form
     first = true # first tab 
     @form['form']['tabs'].keys.sort.each do |tab_name|
       next if tab_name.match('actions')
-# Tricky. If field name is not on the tab skip to next tab
+      # Tricky when editing single field. If field is not present on the tab skip to next tab
       if params[:edit_only]
         is_on_tab = false
-        @form['form']['tabs'][tab_name].each {|k,v| is_on_tab = true if params[:edit_only] == v['name'] }
+        @form['form']['tabs'][tab_name].each { |k, v| is_on_tab = true if params[:edit_only] == v['name'] }
         next unless is_on_tab
       end
-# first div is displayed, all others are hidden      
+      # first div is displayed, all others are hidden
       tab_data << "<div id=\"data_#{tab_name.delete("\s\n")}\""
       tab_data << ' class="div-hidden"' unless first
       tab_data << " style=\"height: #{@form['form']['height']}px;\"" if @form['form']['height']
       tab_data << ">#{dc_fields_for_tab(@form['form']['tabs'][tab_name])}</div>"
-      tab_label = @form['form']['tabs'][tab_name]['caption'] || tab_name 
-      tabs << [tab_name, tab_label]
+
+      tab_label, tab_title = dc_tab_label_help(tab_name)
+      tabs << [tab_name, tab_label, tab_title]
       first = false      
     end
-# make it all work together
+    # make it all work together
     html << '<ul class="dc-form-ul" >'
     first = true # first tab must be selected
-    tabs.each do |tab_name, tab_label| 
-      html << "<li id=\"li_#{tab_name}\" data-div=\"#{tab_name.delete("\s\n")}\" class=\"dc-form-li"
-      html << ' dc-form-li-selected' if first 
-      html << "\">#{t(tab_label, t_name(tab_label,tab_label))}</li>" 
+    tabs.each do |tab_name, tab_label, tab_title|
+      html << %(<li id="li_#{tab_name}" data-div="#{tab_name.delete("\s\n")}" title="#{tab_title}" class="dc-form-li)
+      html << ' dc-form-li-selected' if first
+      html << "\">#{tab_label}</li>"
       first = false
     end
     html << '</ul>'
@@ -378,16 +400,15 @@ def dc_fields_for_form()
   html.html_safe
 end
 
-
 ############################################################################
-# Creates head form div. Head form div is used to display header datausefull
+# Creates head form div. Head form div is used to display header data usefull
 # to be seen even when tabs are switched.
 ############################################################################
-def dc_head_for_form()
+def dc_head_for_form
   @css ||= ''
   head = @form['form']['head']
   return '' if head.nil?
-  html    = %Q[<div class="dc-head #{head['class']}">\n<div class="dc-row">]
+  html    = %(<div class="dc-head #{head['class']}">\n<div class="dc-row">)
   split   = head['split'] || 4
   percent = 100/split
   current = 0
@@ -413,7 +434,7 @@ def dc_head_for_form()
         @record.send(options['name'])
       end
     rescue Exception => e
-      dc_log_exception(e)
+      dc_log_exception(e, 'dc_head_for_form')
       field = '!!!Error'
     end
     #
@@ -421,7 +442,7 @@ def dc_head_for_form()
     style = dc_style_or_class(nil, options['style'], field, @record)
     html << %Q[<div class="dc-column #{klass}" style="width:#{percent*span}%;#{style}">
   #{label.blank? ? '' : "<span class=\"label\">#{label}</span>"}
-  <span class="field">#{field}</span>
+  <span id="head-#{options['name']}" class="field">#{field}</span>
 </div>]
     current += span
     if current == split
@@ -437,11 +458,10 @@ end
 # Returns username for id. Subroutine of dc_document_statistics
 ###########################################################################
 def dc_document_user_for(field_name) #:nodoc:
-  if @record[field_name]
-    u = DcUser.find(@record[field_name])
-    return u ? u.name : @record[field_name]
-  end
-#  nil
+  return if @record[field_name].nil?
+
+  user = DcUser.find(@record[field_name])
+  user ? user.name : @record[field_name]
 end
 
 ############################################################################
@@ -463,9 +483,33 @@ def dc_document_statistics
   parms[:controller] = 'dc_common'
   parms[:action]     = 'copy_clipboard'
   url = url_for(parms.permit!)
-  html << fa_icon('copy 2x', class: 'dc-link-img dc-link-ajax dc-animate', 
+  html << fa_icon('copy lg', class: 'dc-link-img dc-link-ajax dc-animate',
                   'data-url' => url, 'data-request' => 'get', title: t('drgcms.doc_copy_clipboard') )
+
+  url = url_for(controller: :cmsedit, action: :index, table: 'dc_journal', filter: 'on',
+                filter_oper: 'eq', filter_field: 'doc_id', filter_value: @record.id)
+  html << fa_icon('history lg', class: 'dc-link-img dc-animate dc-window-open',
+                  'data-url' => url, title: t('helpers.label.dc_journal.tabletitle') )
+
   (html << '</div></div>').html_safe
 end
 
+private
+
+############################################################################
+# Creates top or bottom horizontal line on form.
+#
+# @param [String] location (top or bottom)
+# @param [Object] options yaml field definition
+#
+# @return [String] html code for drawing a line
+############################################################################
+def dc_top_bottom_line(location, options)
+  if options["#{location}-line"] || options['line'].to_s == location.to_s
+    '<div class="dc-separator"></div>'
+  else
+    ''
+  end
+end
+
 end

data/app/helpers/{cmsedit_helper.rb → cms_helper.rb}

@@ -26,7 +26,7 @@
 # CmseditHelper module defines common methods used for DRGCMS forms.
 #
 ###########################################################################
-module CmseditHelper
+module CmsHelper
   # javascript part created by form helpers
   attr_reader :js 
   
@@ -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,40 +67,79 @@ 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'])
-    caption = options['caption'] || options['text']
-    label = if caption.blank?    
-      t_name(options['name'], options['name'].capitalize.gsub('_',' ') )
-    elsif options['name']
-      t(caption, caption) 
-    end
-    # help text can be defined in form or in translations starting with helpers. or as helpers.help.collection.field
-    help = if options['help'] 
-      options['help'].match('helpers.') ? t(options['help']) : options['help']
+  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
+      klass = DrgcmsFormFields.const_get(klass_string)
+      field = klass.new(self, @record, options).render
+      @js  << field.js
+      @css << field.css
+      field.html
+    else
+      "Error: Field type #{options['type']} not defined!"
     end
-    help ||= t('helpers.help.' + @form['table'] + '.' + options['name'],' ') if options['name'] 
-  end
-  # create field object from class and call its render method
-  klass_string = options['type'].camelize
-  field_html = if DrgcmsFormFields.const_defined?(klass_string) # when field type defined
-    klass = DrgcmsFormFields.const_get(klass_string)
-    field = klass.new(self, @record, options).render
-    @js  << field.js
-    @css << field.css
-    field.html 
-  else # litle error string
-    "Error: Field type #{options['type']} not defined!"
+  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.
 ############################################################################
@@ -110,25 +149,26 @@ def dc_field_action(yaml)
     value = params['record'][yaml['name']]
     params["p_#{yaml['name']}"] = value
   end
-  #
+  # find field definition on form
   if ( field_definition = dc_get_field_form_definition(yaml['name']) )
-     field, label, help = dc_field_label_help(field_definition)
+    # some options may be redefined
+    field_definition['size'] = yaml['size'] if yaml['size']
+    field, label, help = dc_field_label_help(field_definition)
   else
     yaml['type'] = yaml['field_type']
     field, label, help = dc_field_label_help(yaml)
   end
-   # input field will have label as placeholder
-   field = field.sub('input',"input placeholder=\"#{label}\"")
-   %Q[<li class="no-background">#{field}</li>]
-  
+  # input field will have label as placeholder
+  field = field.sub('input',"input placeholder=\"#{label}\"")
+  %Q[<li class="no-background">#{field}</li>]
 end
 
 ############################################################################
-#
+# Create ex. class="my-class" html code from html options for action
 ############################################################################
 def dc_html_data(yaml)
   return '' if yaml.blank?
-  yaml.inject(' ') {|result, e| result << "#{e.first}=\"#{e.last}\" "}
+  yaml.inject(' ') {|result, e| result = e.last.nil? ? result : result << "#{e.first}=\"#{e.last}\" "}
 end
 
 ############################################################################
@@ -144,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)
@@ -153,16 +194,19 @@ 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']) 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'
     parms['action']     = yaml['action'] 
-    parms['table']      = yaml['table'] 
+    parms['table']      = yaml['table'] || @form['table']
     parms['form_name']  = yaml['form_name']
     parms['control']    = yaml['control'] if yaml['control']
     parms['id']         = record.id if record
@@ -170,21 +214,22 @@ 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"
-      %Q[<li class="#{clas}" data-url="#{action_active ? url : ''}"  #{html_data}
+      %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
@@ -197,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, {target: yaml['target'], html: yaml['html']} )
+      link = dc_link_to(caption, yaml['icon'], parms, yaml['html'] )
       %Q[<li class="#{clas}">#{action_active ? link : caption}</li>]
 
     elsif yaml['type'] == 'window'
@@ -211,10 +256,10 @@ def dc_link_ajax_window_submit_action(yaml, record=nil, action_active=true)
 end
 
 ############################################################################
-#
+# Log exception to rails log. Usefull for debugging eval errors.
 ############################################################################
-def dc_log_exception(exception)
-  log = exception ? "\n!!!Error: #{exception.message}\n#{exception.backtrace.first.inspect}\n" : ''
+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"
   
   logger.error log