drg_cms 0.6.1.9 → 0.7.0.2

data/app/helpers/cms_edit_helper.rb

@@ -137,13 +137,13 @@ def dc_actions_for_form(position)
   actions.delete('standard')
   actions = actions.to_a.sort { |x, y| x[0] <=> y[0] }
   # Add spinner to the beginning
-  html = %Q[<span class="dc-spinner">#{fa_icon('settings-o spin')}</span><ul class="dc-menu #{position}">]
+  html = %(<span class="dc-spinner">#{mi_icon('settings-o spin')}</span><ul class="dc-menu #{position}">)
 
   actions.each do |key, options|
     session[:form_processing] = "form:actions: #{key} #{options}"
     next if options.nil?  # yes it happens
 
-    parms = @parms.clone
+    parms = @form_params.clone
     if options.class == String
       next if @form['readonly'] and !options.match(/back|close/)
 
@@ -211,7 +211,7 @@ def dc_actions_for_form(position)
              dc_submit_tag(caption, icon, { data: parameters, title: options['title'] }) +
           '</li>'
         else
-          %(<li><div class="dc-link-no">#{fa_icon(icon)} #{caption}</div></li>)
+          %(<li><div class="dc-link-no">#{mi_icon(icon)} #{caption}</div></li>)
         end
       
       # delete with some sugar added
@@ -279,127 +279,26 @@ def dc_check_and_default(value, default, values=nil) #:nodoc:
 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
-  group_option, group_count = 0, 0
-  reset_cycle()
-  # Select form fields and sort them by key
-  form_fields  = fields_on_tab.select {|field| field.class == Integer }
-  form_fields.to_a.sort.each do |number, options|
-    session[:form_processing] = "form:fields: #{number}=#{options}"
-    # ignore if edit_only singe field is required
-    next if params[:edit_only] and params[:edit_only] != options['name'] 
-    # hidden_fields. Add them at the end
-    if options['type'] == 'hidden_field'
-      hidden_fields << DrgcmsFormFields::HiddenField.new(self, @record, options).render
-      next
-    end
-    # label
-    field_html,label,help = dc_field_label_help(options)
-    # Line separator
-    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')
-      group_count  = options['group'] || 1 
-      group_option = options['group'] || 1 
-    end
-
-    html << if labels_pos == 'top'
-%(
-<div class="dc-form-label-top dc-color-#{odd_even} dc-align-left" title="#{help}">
-  <label for="record_#{options['name']}">#{label} </label>
-  <div id="td_record_#{options['name']}">#{field_html}</div>
-</div> )
-    else
-      # no label
-      if dc_dont?(options['caption'])
-        label = ''
-        label_width = 0
-        data_width  = 100
-      elsif group_option > 1 
-        label_width = group_option != group_count ? 10 : 14        
-        data_width  = 21
-      else
-        label_width = 14
-        data_width  = 85      
-      end
-      help.gsub!('<br>',"\n") if help.present?
-%(
-<div class="dc-form-label dc-color-#{odd_even} dc-align-#{labels_pos} dc-width-#{label_width}" title="#{help}">
-  <label for="record_#{options['name']}">#{label} </label>
-</div>
-<div id="td_record_#{options['name']}" class="dc-form-field dc-color-#{odd_even} dc-width-#{data_width}">#{field_html}</div>
-)
-    end
-    # check if group end
-    if (group_count -= 1) == 0
-      html << '</div>'
-      # insert dummy div when only two fields in group
-      html << '<div></div>' if group_option == 2
-    end
-    
-    html << dc_top_bottom_line(:bottom, options)
-  end
-  html << '</div>' << hidden_fields
-end
-
-############################################################################
-# Creates edit form from fields or tabs options
+# Creates input fields defined in form options
 ############################################################################
 def dc_fields_for_form
-  html, tabs, tab_data = '',[], ''
+  html = "<div id='data_fields' " + (@form['form']['height'] ? "style=\"height: #{@form['form']['height']}px;\">" : '>')
   @js  ||= ''
   @css ||= ''
-  # Only fields defined
+  # fields
   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
-    first = true # first tab 
-    @form['form']['tabs'].keys.sort.each do |tab_name|
-      next if tab_name.match('actions')
-      # 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'] }
-        next unless is_on_tab
-      end
-      # 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, tab_title = dc_tab_label_help(tab_name)
-      tabs << [tab_name, tab_label, tab_title]
-      first = false      
-    end
-    # 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, 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>'
-    html << tab_data
+    html << dc_input_form_create(form_fields) + '</div>'
+  # tabs
+  elsif @form['form']['tabs']
+    html = dc_tabs_form_create()
   end
   # add last_updated_at hidden field so controller can check if record was updated in db during editing
   html << hidden_field(nil, :last_updated_at, value: @record.updated_at.to_i) if @record.respond_to?(:updated_at)
   # add form time stamp to prevent double form submit
   html << hidden_field(nil, :form_time_stamp, value: Time.now.to_i)
   # add javascript code if defined by form
-  @js << "\n#{@form['script']}"
-  @css << "\n#{@form['css']}" 
+  @js << "\n#{@form['script']} #{@form['js']}"
+  @css << "\n#{@form['css']}\n#{@form['form']['css']}"
   html.html_safe
 end
 
@@ -426,7 +325,7 @@ def dc_head_for_form
     label   = if caption.blank?
       ''
     elsif options['name'] == caption
-      t_name(options['name'], options['name'].capitalize.gsub('_',' ') )
+      t_label_for_field(options['name'], options['name'].capitalize.gsub('_',' ') )
     else
       t(caption, caption) 
     end
@@ -444,13 +343,13 @@ def dc_head_for_form
     #
     klass = dc_style_or_class(nil, options['class'], field, @record)
     style = dc_style_or_class(nil, options['style'], field, @record)
-    html << %Q[<div class="dc-column #{klass}" style="width:#{percent*span}%;#{style}">
+    html << %(<div class="dc-column #{klass}" style="width:#{percent*span}%;#{style}">
   #{label.blank? ? '' : "<span class=\"label\">#{label}</span>"}
   <span id="head-#{options['name']}" class="field">#{field}</span>
-</div>]
+</div>)
     current += span
     if current == split
-      html << %Q[</div>\n<div class="dc-row">]
+      html << %(</div>\n<div class="dc-row">)
       current = 0
     end
   end
@@ -488,18 +387,44 @@ def dc_document_statistics
   parms[:controller] = 'dc_common'
   parms[:action]     = 'copy_clipboard'
   url = url_for(parms.permit!)
+  html << '<div>'
   html << fa_icon('content_copy-o md-18', class: 'dc-link-img dc-link-ajax',
                   'data-url' => url, 'data-request' => 'get', title: t('drgcms.doc_copy_clipboard') )
 
-  url = url_for(controller: 'cmsedit', action: :index, table: 'dc_journal', filter: 'on',
+  url = url_for(controller: :cmsedit, action: :run, table: 'dc_journal', control: 'cmsedit.filter_on',
                 filter_oper: 'eq', filter_field: 'doc_id', filter_value: @record.id)
+
   html << fa_icon('history md-18', class: 'dc-link-img dc-window-open',
                   'data-url' => url, title: t('helpers.label.dc_journal.tabletitle') )
-  html << %(<span>ID: </span><span id="record-id" class="hover" onclick="dc_copy_to_clipboard('record-id');" title="Copy document ID to clipboard">#{@record.id}</span>)
+  html << %(<span>ID: </span>
+            <span id="record-id" class="hover" onclick="dc_copy_to_clipboard('record-id');" title="Copy document ID to clipboard">#{@record.id}
+            </span>)
+
+  (html << '</div></div>').html_safe
+end
+
+############################################################################
+# Updates form prior to processing form
+############################################################################
+def dc_form_update
+  # update form for steps options
+  if @form.dig('form', 'steps')
+    dc_form_update_steps
+  end
+end
+
+############################################################################
+# If form is divided into two parts, this method gathers html to be painted
+# on right side of the form pane.
+############################################################################
+def dc_form_left
+  yaml = @form.dig('form', 'form_left')
+  return '' unless yaml
 
-  #dc_copy_to_clipboard
+  html = ''
+  html << dc_process_eval(yaml['eval'], self) if yaml['eval']
 
-  (html << '</div>').html_safe
+  html.html_safe
 end
 
 private
@@ -520,4 +445,188 @@ def dc_top_bottom_line(location, options)
   end
 end
 
+############################################################################
+# Creates input fields for one tab. Subroutine of dc_fields_for_form.
+############################################################################
+def dc_input_form_create(fields_on_tab) #:nodoc:
+  html = '<div class="dc-form">'
+  labels_pos = dc_check_and_default(@form['form']['labels_pos'], 'right', %w[top left right])
+  hidden_fields, odd_even = '', nil
+  group_option, group_count = 0, 0
+  reset_cycle()
+  # Select form fields and sort them by key
+  form_fields  = fields_on_tab.select {|field| field.class == Integer }
+  form_fields.to_a.sort.each do |number, options|
+    session[:form_processing] = "form:fields: #{number}=#{options}"
+    # ignore if edit_only singe field is required
+    next if params[:edit_only] and params[:edit_only] != options['name']
+    next if options.nil?
+
+    # hidden_fields. Add them at the end
+    if options['type'] == 'hidden_field'
+      hidden_fields << DrgcmsFormFields::HiddenField.new(self, @record, options).render
+      next
+    end
+    # label
+    field_html,label,help = dc_field_label_help(options)
+    # Line separator
+    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')
+      group_count  = options['group'] || 1
+      group_option = options['group'] || 1
+    end
+
+    html << if labels_pos == 'top'
+              %(
+<div class="dc-form-label-top dc-color-#{odd_even} dc-align-left" title="#{help}">
+  <label for="record_#{options['name']}">#{label} </label>
+  <div id="td_record_#{options['name']}">#{field_html}</div>
+</div> )
+            else
+              # no label
+              if dc_dont?(options['caption'])
+                label = ''
+                label_width = 0
+                data_width  = 100
+              elsif group_option > 1
+                label_width = group_option != group_count ? 10 : 14
+                data_width  = 21
+              else
+                label_width = 14
+                data_width  = 85
+              end
+              help.gsub!('<br>',"\n") if help.present?
+              %(
+<div class="dc-form-label dc-color-#{odd_even} dc-align-#{labels_pos} dc-width-#{label_width}" title="#{help}">
+  <label for="record_#{options['name']}">#{label} </label>
+</div>
+<div id="td_record_#{options['name']}" class="dc-form-field dc-color-#{odd_even} dc-width-#{data_width}">#{field_html}</div>
+)
+            end
+    # check if group end
+    if (group_count -= 1) == 0
+      html << '</div>'
+      # insert dummy div when only two fields in group
+      html << '<div></div>' if group_option == 2
+    end
+
+    html << dc_top_bottom_line(:bottom, options)
+  end
+  html << '</div>' << hidden_fields
+end
+
+############################################################################
+# Will create html code required for input form with steps defined
+############################################################################
+def dc_steps_one_element(element, tab_name = nil)
+  def add_one_step(key, tab_name, key_number)
+    fields = tab_name ? @form['form']['tabs'][tab_name] :  @form['form']['fields']
+    { key_number => fields[key] }
+  end
+
+  key_number, fields = 0, {}
+  element.to_s.split(',').each do |particle|
+    if particle.match('-')
+      tabs_fields = tab_name ? @form['form']['tabs'][tab_name] : @form['form']['fields']
+      next if tabs_fields.nil?
+
+      start, to_end = particle.split('-').map(&:to_i)
+      tabs_fields.each { |key, data| fields.merge!(add_one_step(key, tab_name, key_number += 10)) if (start..to_end).include?(key) }
+    else
+      fields.merge!(add_one_step(particle.to_i, tab_name, key_number += 10))
+    end
+  end
+  fields
+end
+
+############################################################################
+# Will create html code required for input form with steps defined and update
+# actions.
+############################################################################
+def dc_form_update_steps
+  def add_step_to_form(index, step, next_step)
+    @form['form']['actions'][index]['params']['step'] = step
+    @form['form']['actions'][index]['params']['next_step'] = next_step
+  end
+
+  form = {}
+  step = params[:step].to_i
+  step_data = @form['form']['steps'].to_a[step - 1]
+
+  step_data.last.each do |element|
+    if element.first == 'fields'
+      form.merge!(dc_steps_one_element(element.second))
+    elsif element.first == 'tabs'
+      element.last.each do |tab_name, data|
+        form.merge!(dc_steps_one_element(data, tab_name))
+      end
+    end
+  end
+  # fraction updates of newly created form
+  form.deep_merge!(step_data.last['update']) if step_data.last['update']
+  # update steps data on form
+  add_step_to_form(10, step, step - 1)
+  add_step_to_form(20, step, step + 1)
+  add_step_to_form(100, step, step + 1)
+  # remove not needed steps
+  if step < 2
+    @form['form']['actions'].delete(10)
+  elsif step == @form['form']['steps'].size
+    @form['form']['actions'].delete(20)
+  end
+  @form['form']['actions'].delete(100) unless step == @form['form']['steps'].size
+  # update form_name and control name if defined
+  %w[1 10 20 100].each do |i|
+    next unless @form['form']['actions'][i.to_i]
+
+    @form['form']['actions'][i.to_i]['form_name'] = CmsHelper.form_param(params)
+    control = @form['control'] ? @form['control'] : @form['table']
+    @form['form']['actions'][i.to_i]['control'].sub!('x.', "#{control}.")
+  end
+
+  @form['form']['form_left'] ||= { 'eval' => 'dc_steps_menu_get'}
+  @form['form']['fields'] = form
+end
+
+############################################################################
+# Will create html code required for input form with tabs
+############################################################################
+def dc_tabs_form_create
+  html, tabs, tab_data = '', [], ''
+  # 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 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'] }
+      next unless is_on_tab
+    end
+    # 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_input_form_create(@form['form']['tabs'][tab_name])}</div>"
+
+    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
+  html << '<ul class="dc-form-ul" >'
+  first = true # first tab must be selected
+  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>'
+  html << tab_data
+end
+
 end

data/app/helpers/cms_helper.rb

@@ -35,8 +35,16 @@ module CmsHelper
 ############################################################################
 def dc_script_action(yaml)
   icon = dc_icon_for_link yaml['icon']
-  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>)
+  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
 
 ############################################################################
@@ -105,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']
@@ -128,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]
@@ -197,12 +207,14 @@ def dc_link_ajax_window_submit_action(yaml, record = nil, action_active = true)
   unless dc_is_action_active?(yaml)
     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']
@@ -282,11 +294,18 @@ 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.
 ############################################################################
@@ -301,4 +320,42 @@ 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