drg_cms 0.5.52.16 → 0.6.1.0

data/app/helpers/dc_application_helper.rb

@@ -58,6 +58,8 @@ attr_accessor :parts
 attr_accessor :record
 #
 attr_accessor :record_footer
+# json_ld
+attr_reader :json_ld
 
 ############################################################################
 # When @parent is present then helper methods are called from parent class otherwise 
@@ -96,6 +98,7 @@ def dc_render(renderer, opts={})
 # 
   opts[:edit_mode]  = session[:edit_mode] 
   opts[:editparams] = {}
+  
   opts = @options.merge(opts) # merge options with parameters passed on site, page, design ...
   opts.symbolize_keys!        # this makes lots of things easier
 # Create renderer object
@@ -240,8 +243,8 @@ end
 # Helper for adding additional css and javascript code added by documents
 # and renderers during page rendering.
 ########################################################################
-def dc_page_bottom()
-  %Q[<style type="text/css">#{@css}</style>#{javascript_tag @js}].html_safe
+def dc_page_bottom
+  %(<style type="text/css">#{@css}</style>#{javascript_tag @js}).html_safe
 end
 
 ############################################################################
@@ -255,10 +258,16 @@ end
 # Returns:
 # String. HTML code for title.
 ############################################################################
-def dc_table_title(text, result_set=nil)
-  c = %Q[<div class="dc-title">#{text}]
+def dc_table_title(text, result_set = nil)
+  c = %(<div class="dc-title">#{text})
+  # help button
+  type = result_set.nil? ? 'form' : 'index'
+  form_name = params[:form_name] || params[:table]
+  url = url_for(controller: :dc_common, action: :help, type: type, form_name: form_name)
+  c << %(<div class="dc-help dc-link-ajax" data-url=#{url}>#{fa_icon('question-circle')}</div>)
+
   if result_set and result_set.respond_to?(:current_page)
-    c << %Q[<div class="dc-paginate">#{paginate(result_set, :params => {:action => 'index'})}</div>]
+    c << %(<div class="dc-paginate">#{paginate(result_set, :params => {action: 'index', clear: 'no', filter: nil})}</div>)
   end
   c << '<div style="clear: both;"></div></div>'
   c.html_safe
@@ -270,7 +279,8 @@ end
 # Returns:
 # String. HTML code for title.
 ############################################################################
-def dc_edit_title()
+def dc_edit_title
+  session[:form_processing] = "form:title:"
   title = @form['form']['title']
 # defined as form:title:edit
   if title and title['edit'] and !@form['readonly']
@@ -297,6 +307,7 @@ end
 # String. HTML code for title.
 ############################################################################
 def dc_new_title()
+  session[:form_processing] = "form:title:"
   title = @form['form']['title']
 # defined as form:title:new
   if title and title['new']
@@ -347,8 +358,24 @@ def dc_submit_tag(caption, icon, parms, rest={})
     end
   end
   html = icon_image || ''
-  html << submit_tag(t(caption, caption), parms)
+  #html << submit_tag(t(caption, caption), parms)
+  %Q[<button type="submit" class="dc-submit" name="commit" value="#{t(caption, caption)}">#{icon_image} #{t(caption, caption)}</button>].html_safe
+end
+
+############################################################################
+# Returns icon code if icon is specified
+############################################################################
+def dc_icon_for_link(icon)
+  return nil unless icon
+  if icon.match(/\./)
+    _origin.image_tag(icon, class: 'dc-link-img dc-animate')
+  elsif icon.match('<i')
+    icon
+  else
+    _origin.fa_icon(icon)
+  end
 end
+  
 ############################################################################
 # Similar to rails link_to, but also takes care of link icon, translation, ...
 ############################################################################
@@ -357,22 +384,13 @@ def dc_link_to(caption, icon, parms, rest={})
   if parms.class == Hash
     parms.stringify_keys!
     rest.stringify_keys!
-    rest['class'] = rest['class'].to_s + ' dc-animate'
+    rest['class'] = rest['class'].to_s + ' dc-animate' unless rest['class'].to_s.match('dc-animate')
     rest['target'] ||=  parms.delete('target')
     parms['controller'] ||= 'cmsedit'
     icon_pos = parms.delete('icon_pos') || 'first'
   end
 #  
-  if icon
-    icon_image = if icon.match(/\./)
-      _origin.image_tag(icon, class: 'dc-link-img dc-animate')
-    elsif icon.match('<i')
-      icon
-    else
-      _origin.fa_icon(icon)
-    end
-  end
-#  
+  icon_image = dc_icon_for_link(icon)
   if caption
     caption = t(caption, caption)
     icon_image << ' ' if icon_image
@@ -389,23 +407,31 @@ end
 # String. HTML code formatted for display.
 ####################################################################
 def dc_flash_messages()
-  err  = _origin.flash[:error]
-  war  = _origin.flash[:warning]
-  inf  = _origin.flash[:info]
-  note = _origin.flash[:note]
+  err    = _origin.flash[:error]
+  war    = _origin.flash[:warning]
+  inf    = _origin.flash[:info]
+  note   = _origin.flash[:note]
+  html   = ''
   unless err.nil? and war.nil? and inf.nil? and note.nil?
-    c = ''
-    c << "<div class=\"dc-form-error\">#{err}</div>" if err
-    c << "<div class=\"dc-form-warning\">#{war}</div>" if war
-    c << "<div class=\"dc-form-info\">#{inf}</div>" if inf
-    c << note if note
+    html << "<div class=\"dc-form-error\">#{err}</div>" if err
+    html << "<div class=\"dc-form-warning\">#{war}</div>" if war
+    html << "<div class=\"dc-form-info\">#{inf}</div>" if inf
+    html << note if note
     _origin.flash[:error]   = nil
     _origin.flash[:warning] = nil
     _origin.flash[:info]    = nil
     _origin.flash[:note]    = nil
-
-    c.html_safe
   end
+# Update fields on the form
+  if _origin.flash[:update]
+    html << "<div class=\"dc-form-updates\">\n"
+    _origin.flash[:update].each do |field, value|
+      html << %Q[<div data-field="#{field}" data-value="#{value}"></div>\n]
+    end
+    html << '</div>'
+    _origin.flash[:update] = nil
+  end
+  html.html_safe
 end
 
 ########################################################################
@@ -575,7 +601,7 @@ def dc_page_edit_menu(opts=@opts)
   return '' if opts[:edit_mode] < 2
 # save some data to cookie. This can not go to session.
   page  = opts[:page] || @page
-  table = _origin.site.page_table
+  table = _origin.site.page_class.underscore
   kukis = { "#{table}.dc_design_id" => page.dc_design_id,
 #            "#{table}.menu_id"      => page.menu_id,
             "#{table}.kats"         => page.kats,
@@ -587,7 +613,7 @@ def dc_page_edit_menu(opts=@opts)
   opts[:editparams] ||= {}
   dc_link_menu_tag(title) do |html|
     opts[:editparams].merge!( controller: 'cmsedit', action: 'edit', 'icon' => 'edit' )
-    opts[:editparams].merge!( :id => page.id, :table => _origin.site.page_table, form_name: opts[:form_name], edit_only: 'body' )
+    opts[:editparams].merge!( :id => page.id, :table => _origin.site.page_class.underscore, form_name: opts[:form_name], edit_only: 'body' )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_content') )
     
 #    opts[:editparams][:edit_only] = nil
@@ -599,7 +625,7 @@ def dc_page_edit_menu(opts=@opts)
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_page') )
 
     opts[:editparams].merge!(ids: page.id, form_name: 'dc_part', 'icon' => 'plus-square-o', 
-                             table: "#{_origin.site.page_table};dc_part"  )
+                             table: "#{_origin.site.page_class.underscore};dc_part"  )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_part') )
   end.html_safe
 end
@@ -618,7 +644,7 @@ end
 ########################################################################
 def dc_page_class()
 #  dc_get_site.page_class.classify.constantize  
-  dc_get_site.page_table.classify.constantize
+  dc_get_site.page_klass
 end
 
 ########################################################################
@@ -636,225 +662,6 @@ def dc_menu_class()
   dc_get_site.menu_class.classify.constantize
 end
 
-
-####################################################################
-# Wrapper for i18 t method, with some spice added. If translation is not found English
-# translation value will be returned. And if still not found default value will be returned if passed.
-# 
-# Parameters:
-# [key] String. String to be translated into locale.
-# [default] String. Value returned if translation is not found.
-# 
-# Example:
-#    t('translate.this','Enter text for ....')
-# 
-# Returns: 
-# String. Translated text. 
-####################################################################
-def t(key, default=nil)
-  c = I18n.t(key)
-  if c.class == Hash or c.match( 'translation missing' )
-    c = I18n.t(key, locale: 'en') 
-# Still not found. Return default if set
-    if c.class == Hash or c.match( 'translation missing' )
-      c = default.nil? ? key : default
-    end
-  end
-  c
-end
-
-####################################################################
-# Returns table (collection) name translation for usage in dialog title. Tablename 
-# title is provided by helpers.label.table_name.tabletitle locale.
-# 
-# Parameters:
-# [tablename] String. Table (collection) name to be translated.
-# [default] String. Value returned if translation is not found.
-# 
-# Returns: 
-# String. Translated text. 
-####################################################################
-def t_tablename(tablename, default=nil)
-  t('helpers.label.' + tablename + '.tabletitle', default || tablename)
-end
-
-############################################################################
-# Returns label for field translated to current locale for usage on data entry form.
-# Translation is provided by lang.helpers.label.table_name.field_name locale. If
-# translation is not found method will capitalize field_name and replace '_' with ' '.
-############################################################################
-def t_name(field_name, default='')
-  c = t("helpers.label.#{@form['table']}.#{field_name}", default)
-  c = field_name.capitalize.gsub('_',' ') if c.match( 'translation missing' )
-  c
-end
-
-############################################################################
-# When select field is used on form options for select can be provided by 
-# helpers.label.table_name.choices4_name locale. This is how select
-# field options are translated. Method returns selected choice translated
-# to current locale. 
-# 
-# Parameters:
-# [model] String. Table (collection) model name (lowercase).
-# [field] String. Field name used.
-# [value] String. Value of field which translation will be returned.
-# 
-# Example:
-#    # usage in program. Choice values for state are 'Deactivated:0,Active:1,Waiting:2'
-#    dc_name4_value('dc_user', 'state', @record.active )
-#
-#    # usage in form
-#    columns:
-#      2: 
-#        name: state
-#        eval: dc_name4_value dc_user, state
-#        
-# Returns: 
-# String. Descriptive text (translated) for selected choice value.
-############################################################################
-def dc_name4_value(model, field, value)
-  return '' if value.nil?
-  c = t('helpers.label.' + model + '.choices4_' + field )
-  a = c.chomp.split(',').inject([]) {|r,v| r << v.split(':') }
-  a.each {|e| return e.first if e.last.to_s == value.to_s }
-  ''
-end
-
-############################################################################
-# Return choices for field in model if choices are defined in localization text.
-# 
-# Parameters:
-# [model] String. Table (collection) model name (lowercase).
-# [field] String. Field name used.
-# 
-# Example:
-#    dc_choices4_field('dc_user', 'state' )
-#        
-# Returns: 
-# Array. Choices for select input field
-############################################################################
-def dc_choices4_field(model, field)
-  c = t('helpers.label.' + model + '.choices4_' + field )
-  return ['error'] if c.match( 'translation missing' )
-  c.chomp.split(',').inject([]) {|r,v| r << v.split(':') }
-end
-
-############################################################################
-# Will return descriptive text for id key when field in one table (collection) has belongs_to 
-# relation to other table.
-# 
-# Parameters:
-# [model] String. Table (collection) model name (lowercase).
-# [field] String. Field name holding the value of descriptive text.
-# [field_name] String. ID field name. This is by default id, but can be any other 
-# (preferred unique) field.
-# [value] Value of id_field. Usually a BSON Key but can be any other data type.
-# 
-# Example:
-#    # usage in program.
-#    dc_name4_id('dc_user', 'name', nil, dc_page.created_by)
-#
-#    # usage in form
-#    columns:
-#      2: 
-#        name: site_id
-#        eval: dc_name4_id,site,name
-#    # username is saved to document instead of user.id field
-#      5: 
-#        name: user
-#        eval: dc_name4_id,dc_user,name,username
-# 
-# Returns: 
-# String. Name (descriptive value) for specified key in table.
-############################################################################
-def dc_name4_id(model, field, field_name, id=nil)
-  return '' if id.nil?
-  field_name ||= 'id'
-  model = model.strip.classify.constantize if model.class == String
-  rec = Mongoid::QueryCache.cache { model.find_by(field_name.strip.to_sym => id) }
-  rec.nil? ? '' : (rec.send(field) rescue 'not defined')
-end
-
-############################################################################
-# Return html code for icon presenting boolean value. Icon is a picture of checked or unchecked box.
-# 
-# Parameters:
-# [value] Boolean.  
-# 
-# Example:
-#    # usage from program
-#    dc_icon4_boolean(some_value)
-#
-#    # usage from form description
-#    columns:
-#      10: 
-#        name: active
-#        eval: dc_icon4_boolean
-############################################################################
-def dc_icon4_boolean(value)
-  dc_dont?(value, true) ? fa_icon('square-o lg') : fa_icon('check-square-o lg') 
-end
-
-############################################################################
-# Returns html code for displaying date/time formatted by strftime. Will return '' if value is nil.
-# 
-# Parameters:
-# [value] Date/DateTime/Time.  
-# [format] String. strftime format mask. Defaults to locale's default format.
-############################################################################
-def dc_format_date_time(value, format=nil)
-  return '' if value.nil?
-  format ||= value.class == Date ? t('date.formats.default') : t('time.formats.default')
-  value.strftime(format)
-end
-
-####################################################################
-#
-####################################################################
-def dc_date_time(value, format) #:nodoc:
-  dc_deprecate 'dc_date_time will be deprecated! Use dc_format_date_time instead.'
-  dc_format_date_time(value, format)
-end
-
-############################################################################
-# Returns html code for displaying formatted number.
-# 
-# Parameters:
-# [value] Numeric number.  
-# [decimals] Integer. Number of decimals
-# [separator] String. Decimals separator
-# [delimiter] String. Thousands delimiter.
-# [currency] String. Currency symbol if applied to result string.
-############################################################################
-def dc_format_number(value=0, decimals=nil, separator=nil, delimiter=nil, currency=nil)
-  decimals  ||=  I18n.t('number.currency.format.precision')
-  separator ||= I18n.t('number.currency.format.separator')
-  separator = '' if decimals == 0
-  delimiter ||= I18n.t('number.currency.format.delimiter')
-  whole,dec = value.to_s.split('.')
-  whole = '0' if whole.blank?
-# remove and remember sign  
-  sign = whole[0,1]
-  if sign == '-'
-    whole = whole[1,20]
-  else
-    sign = ''
-  end
-# format decimals
-  dec ||= '0'
-  dec = dec[0,decimals]
-  while dec.size < decimals do dec += '0' end
-# slice whole on chunks of 3
-  ar = []
-  while whole.size > 0 do 
-    n = whole.size >=3 ? 3 : whole.size 
-    ar << whole.slice!(n*-1,n)
-  end
-# put it all back and format
-  "#{sign}#{ar.reverse.join(delimiter)}#{separator}#{dec}" 
-end
-
 ####################################################################
 # Parse site name from url and return dc_site document. Site document will be cached in
 # @site variable.
@@ -1029,9 +836,6 @@ def dc_choices4(model, name, id='_id', options = {})
     qry   = qry.in(dc_site_id: sites) if sites
   end
   qry   = qry.and(active: true) if model.method_defined?(:active)
-#  qry   = qry.sort(name => 1) 
-#  choices = []
-#  qry.each {|v| choices << [ v[name], v[id] ] }
   choices = qry.inject([]) {|result,e| result << [ e[name], e[id] ]}
   choices.sort_alphabetical_by(&:first) # use UTF-8 sort
 end
@@ -1180,7 +984,8 @@ end
 ####################################################################
 def dc_dont?(what, default=false)
   return default if what.nil?
-  %w(0 no - false none).include?(what.to_s.downcase.strip)
+
+  %w(0 n - no none false).include?(what.to_s.downcase.strip)
 end
 
 ############################################################################
@@ -1284,40 +1089,50 @@ def dc_iframe_edit(table, opts={})
 end
 
 ########################################################################
-# Will return value from internal DRG variables.
-# This objects can be params, session, ...
+# Will return value from Rails and DRG internal objects.
+# This objects can be params, session, record, site, page
 # 
 # Parameters:
-# [object] String: Internal object holding variable. Current values can be session, params, site, page
+# [object] String: Internal object holding variable. Possible values are session, params, record, site, page, class
 # [var_name] String[symbol]: Variable name (:user_name, 'user_id', ...)
+# [current_document] Object: If passed and object is 'record' then it will be used for retrieving data.
 # 
 # Example:
 #    # called when constructing iframe for display
-#    dc_internal_var(session, :user_id)
-#    dc_internal_var(params, :some_external_parameter)
-#    dc_internal_var(site, :name)
+#    dc_internal_var('session', :user_id)
+#    dc_internal_var('params', :some_external_parameter)
+#    dc_internal_var('site', :name)
+#    # or even
+#    dc_internal_var('class', 'ClassName.class_method_name')
+#    
 # 
 # Returns:
-# Value of variable or nil when not found
+# Value of variable or error when not found
 ########################################################################
-def dc_internal_var(object, var_name)
+def dc_internal_var(object, var_name, current_document = nil)
   begin
     case
-      when object == 'session' then _origin.session[var_name]
-      when object == 'params'  then _origin.params[var_name]
-      when object == 'site'    then _origin.dc_get_site.send(var_name)
-      when object == 'page'    then _origin.page.send(var_name)
-      when object == 'record'  then _origin.record.send(var_name)
+    when object == 'session' then _origin.session[var_name]
+    when object == 'params'  then _origin.params[var_name]
+    when object == 'site'    then _origin.dc_get_site.send(var_name)
+    when object == 'page'    then _origin.page.send(var_name)
+    when object == 'record'  then
+      current_document ? current_document.send(var_name) : _origin.record.send(var_name)
+    when object == 'class'   then
+      clas, method_name = var_name.split('.')
+      klas = clas.classify.constantize
+      # call method. Error will be caught below.
+      klas.send(method_name)
     else
       'VARIABLE: UNKNOWN OBJECT'
     end
   rescue Exception => e
-    Rails.logger.error "Method dc_internal var. Runtime error. #{e.message}"
+    Rails.logger.debug "\ndc_internal_var. Runtime error. #{e.message}\n"
+    Rails.logger.debug(e.backtrace.join($/)) if Rails.env.development?
     'VARIABLE: ERROR'
   end
 end
 
-
 ########################################################################
 # Will return whole path to document if document is embedded in another document.
 # 
@@ -1336,4 +1151,101 @@ def dc_document_path(document)
   path.reverse.join(';')
 end
 
+########################################################################
+# Will return formated code for embedding json+ld data into page
+# 
+# Returns:
+# HTML data to be embedded into page header
+#######################################################################
+def dc_get_json_ld()
+  return '' if @json_ld.nil? or @json_ld.size == 0
+
+  %Q[
+<script type="application/ld+json">
+#{JSON.pretty_generate({'@context' => 'http://schema.org', '@graph' => @json_ld})}
+</script>
+].html_safe
+end
+
+########################################################################
+# Will add new element to json_ld structure
+# 
+# Parameters:
+# [element] Hash or Array of hashes: json+ld element
+#######################################################################
+def dc_add_json_ld(element)
+  @json_ld ||= []
+  if element.class == Array
+    @json_ld += element
+  else
+    @json_ld << element
+  end
+end
+
+########################################################################
+# Will return meta data for SEO optimizations
+# 
+# Returns:
+# HTML data to be embedded into page header
+#######################################################################
+def dc_get_seo_meta_tags()
+  html = ''
+  html << "<link rel=\"canonical\" href=\"#{@page.canonical_link}\">\n  " unless @page&.canonical_link.blank?
+
+  html << @meta_tags.inject('') do |r, hash|
+    r << "<meta #{hash.first} content=\"#{hash.last}\">\n  "
+  end if @meta_tags
+  html.html_safe
+end
+
+########################################################################
+# Will add a meta tag to internal hash structure. If meta tag already exists it
+# will be overwritten.
+# 
+# Parameters:
+# [name] String: meta name
+# [content] String: meta content
+########################################################################
+def dc_add_meta_tag(type, name, content)
+  return if content.blank?
+  @meta_tags ||= {}
+  key = "#{type}=\"#{name}\""
+  @meta_tags[key] = content
+end
+
+#######################################################################
+# Will return alt image option when text is provided. When text is blank
+# it will extract alt name from picture file_name. This method returns
+# together with alt="image-tag" tag.
+# 
+# Parameters:
+# [file_name] String: Filename of a picture
+# [text] String: Alt text name
+# 
+# Returns:
+# [String] alt="image-tag"
+#######################################################################
+def dc_img_alt_tag(file_name, text=nil)
+  " alt=\"#{dc_img_alt(file_name, text)}\" ".html_safe
+end
+
+#######################################################################
+# Will return alt image option when text is provided. When text is blank
+# it will extract alt name from picture file_name. This method returns just 
+# alt name.
+# 
+# Parameters:
+# [file_name] String: Filename of a picture
+# [text] String: Alt text name
+#
+# Returns:
+# [String] alt_image_name
+#######################################################################
+def dc_img_alt(file_name, text=nil)
+  return text unless text.blank?
+  name = File.basename(file_name.to_s)
+  name[0,name.index('.')].downcase rescue name
+end
+
+
 end