drg_cms 0.6.0.1 → 0.6.0.3

data/app/helpers/cmsedit_helper.rb

@@ -206,9 +206,9 @@ end
 ############################################################################
 def dc_table_title_for_result(result=nil)
   title = if @form['title'] # form has title section
-    t(@form['title'],@form['title'])
+    t(@form['title'], @form['title'])
   else # get name from translations
-    t('helpers.label.' + @form['table'] + '.tabletitle', @form['table'])
+    t("helpers.label.#{@form['table']}.tabletitle", @form['table'])
   end
   dc_table_title(title, result)
 end
@@ -281,6 +281,7 @@ def dc_actions_for_result(document)
     when yaml['type'] == 'delete' then
       parms['action'] = 'destroy'
       parms['id']     = document.id
+      parms['return_to'] = request.url
       dc_link_to( nil, 'remove lg', parms, data: { confirm: t('drgcms.confirm_delete') }, method: :delete )
 # undocumented so far
     when yaml['type'] == 'edit_embedded'
@@ -552,7 +553,6 @@ def dc_actions_for_form()
     session[:form_processing] = "form:actions: #{element}"
     v = element[1]
     next if v.nil?  # yes it happends
-    p "Using text option in actions_for form is replaced with caption. Table #{@form['table']}" if v['text']
 # on_save_ok should't go inside td tags
     if (element[0] == 'on_save_ok') then
       c << hidden_field_tag(:on_save_ok, v)
@@ -639,9 +639,10 @@ def dc_actions_for_form()
         end
         # add current id to parameters
         parms['id'] = dc_document_path(@record)
-        # additional parameters          
+        # overwrite with or add additional parameters when params defined
         v['params'].each { |k,v| parms[k] = dc_value_for_parameter(v) } if v['params']
-        # Error if controller parameter is missing
+        parms['table'] = parms['table'].underscore if parms['table'] # might be CamelCase
+        # error if controller parameter is missing
         if parms['controller'].nil?
           "<li>#{t('drgcms.error')}</li>"
         else
@@ -718,7 +719,7 @@ end
 ############################################################################
 # Creates top or bottom horizontal line on form. 
 ############################################################################
-def top_bottom_line(yaml, columns=2)
+def top_bottom_line(options)
   '<div class="dc-separator"></div>'
 end    
 
@@ -749,8 +750,9 @@ def dc_fields_for_tab(fields_on_tab) #:nodoc:
       next
     end
 # label
-    text = if options['text']
-      t(options['text'], options['text'])
+    caption = options['caption'] || options['text']
+    label = if !caption.blank?    
+      t(caption, caption)
     elsif options['name']
       t_name(options['name'], options['name'].capitalize.gsub('_',' ') )
     end
@@ -782,7 +784,7 @@ def dc_fields_for_tab(fields_on_tab) #:nodoc:
     html << if labels_pos == 'top'
 %Q[
 <div class="dc-form-label-top dc-color-#{odd_even} dc-align-left" title="#{help}">
-  <label for="record_#{options['name']}">#{text} </label>
+  <label for="record_#{options['name']}">#{label} </label>
   <div id="td_record_#{options['name']}">#{field_html}</div>
 </div> ]
     else
@@ -792,7 +794,7 @@ def dc_fields_for_tab(fields_on_tab) #:nodoc:
       data_width  = (94 - 10*group_option)/group_option
 %Q[
 <div class="dc-form-label dc-color-#{odd_even} dc-align-#{labels_pos}" style="width:#{label_width}%;" title="#{help}">
-  <label for="record_#{options['name']}">#{text} </label>
+  <label for="record_#{options['name']}">#{label} </label>
 </div>
 <div id="td_record_#{options['name']}" class="dc-form-field dc-color-#{odd_even}" style="width:#{data_width}%;">#{field_html}</div>
 ]
@@ -809,7 +811,7 @@ end
 # Creates edit form div. 
 ############################################################################
 def dc_fields_for_form()
-  html, tabs, tdata = '',[], ''
+  html, tabs, tab_data = '',[], ''
 # Only fields defined  
   if (form_fields = @form['form']['fields'])
     html << "<div id='data_fields' " + (@form['form']['height'] ? "style=\"height: #{@form['form']['height']}px;\">" : '>')  
@@ -817,33 +819,36 @@ def dc_fields_for_form()
   else
 # there are multiple tabs on form 
     first = true # first tab 
-    @form['form']['tabs'].keys.sort.each do |tabname|
-      next if tabname.match('actions')
+    @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
       if params[:edit_only]
         is_on_tab = false
-        @form['form']['tabs'][tabname].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 other are hidden      
-      tdata << "<div id='data_#{tabname.delete("\s\n")}'"
-      tdata << ' class="div-hidden"' unless first
-      tdata << " style=\"height: #{@form['form']['height']}px;\"" if @form['form']['height']
-      tdata << ">#{dc_fields_for_tab(@form['form']['tabs'][tabname])}</div>"
-      tabs << tabname
+# 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]
       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| 
-      html << "<li id='li_#{tab}' data-div='#{tab.delete("\s\n")}' class='dc-form-li #{'dc-form-li-selected' if first }'>#{t_name(tab, tab)}</li>" 
+    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))}</li>" 
       first = false
     end
     html << '</ul>'
-    html << tdata
+    html << tab_data
   end
-  # add last_updated_at hidden field so controller can check if record was updated in during editing
+  # 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)

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 
@@ -575,7 +577,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 +589,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 +601,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 +620,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
 
 ########################################################################
@@ -1335,4 +1337,103 @@ 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)
+  if text.blank?
+    name = File.basename(file_name.to_s)
+    text = name[0,name.index('.')].downcase rescue name
+  end
+  text
+end
+
+
 end

data/app/models/concerns/dc_page_concern.rb

@@ -33,7 +33,6 @@ include Mongoid::Document
 include Mongoid::Timestamps
 
 field :subject,      type: String,  default: ''
-field :title,        type: String
 field :subject_link, type: String,  default: ''
 field :alt_link,     type: String,  default: ''
 field :sub_subject,  type: String,  default: ''
@@ -56,16 +55,19 @@ field :active,       type: Boolean, default: true
 field :created_by,   type: BSON::ObjectId
 field :updated_by,   type: BSON::ObjectId
 field :kats,         type: Array         # Categories
-
+# IFRAME
 field :if_url,       type: String
 field :if_border,    type: Integer, default: 0
 field :if_width,     type: Integer
 field :if_height,    type: Integer
 field :if_scroll,    type: String
 field :if_id,        type: String
-field :if_class,        type: String
+field :if_class,     type: String
 field :if_params,    type: String
 
+# SEO
+include DcSeoConcern
+
 field :policy_id,    type: BSON::ObjectId
 
 embeds_many :dc_parts
@@ -80,6 +82,7 @@ index  alt_link:  1
 before_save :do_before_save
 
 validates :publish_date, presence: true
+validate  :validate_images_alt_present
   
 ######################################################################
 # Will return subject_link. Field name link should be common for all documents
@@ -88,7 +91,15 @@ validates :publish_date, presence: true
 def link
   subject_link
 end
-    
+   
+######################################################################
+# Will return validation error if all images in body field do not have 
+# alt attribute pressent.
+######################################################################
+def validate_images_alt_present
+  errors.add('body', I18n.t('drgcms.img_alt_not_present')) unless DcPage.images_alt_present?(self.body)
+end
+
 protected
 
 ######################################################################
@@ -109,7 +120,7 @@ end
 # than link size is not larger than 100 chars.
 ######################################################################
 def self.clear_link(link)
-  link.gsub!(/\.|\?|\!\&|»|«|\,|\"|\'|\:/,'')
+  link.gsub!(/\.|\?|\!\&|\||»|«|\,|\"|\'|\:/,'')
   link.gsub!('<br>','')
   link.gsub!('–','-')
   link.gsub!(' ','-')
@@ -144,6 +155,20 @@ def self.dc_filters
    'field' => 'dc_site_id', 'value' => '@current_site'}
 end
 
+######################################################################
+# Clears subject link of chars that shouldn't be there and also takes care 
+# than link size is not larger than 100 chars.
+######################################################################
+def self.images_alt_present?(text)
+  return true if text.blank?
+#  
+  document = Nokogiri::HTML.parse(text)
+  document.xpath('//img').each do |image|
+    return false if !image.attributes['alt'] or image.attributes['alt'].text.blank?
+  end
+  true
+end
+
 end
 
 end

data/app/models/concerns/dc_seo_concern.rb

@@ -0,0 +1,66 @@
+#--
+# Copyright (c) 2019+ Damjan Rems
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+##########################################################################
+# dc_seo_concern, ads SEO optimization fields to any model.
+#
+# title                String               Browser title. Optimization for SEO.
+# meta_description     String               SEO optimised page description
+# meta_additional      String               Additional meta page data. Enter as meta_name=meta data
+# dc_json_lds          Embedded:DcJsonLd    Page structure data
+# 
+# If you want to add SEO optimization data to your document add:
+# 
+# "include DcSeoConcern" to your model definition
+# 
+# and
+# 
+# "include: dc_seo" option to top of DRGCMS edit form for your document.
+##########################################################################
+module DcSeoConcern
+extend ActiveSupport::Concern
+
+included do  
+  field :title,            type: String
+  field :meta_description, type: String
+  field :canonical_link,   type: String
+  embeds_many :dc_json_lds # JSON-LD structure
+  
+  ######################################################################
+  # Will return JSON LD data if defined for the page
+  ######################################################################
+  def get_json_ld()
+    parent_data = {'datePublished' => self.created_at, 'dateModified' => self.updated_at}
+    data = []
+    if dc_json_lds.size > 0
+      dc_json_lds.where(active: true).each do |element|
+        dta = element.get_json_ld(parent_data)
+        data << dta if dta.size > 0
+      end
+    end
+    data  
+  end
+end
+
+
+end

data/app/models/dc_design.rb

@@ -31,6 +31,7 @@
 #  updated_at           Time                 updated_at
 #  description          String               Short description of design
 #  body                 String               Body of design which will be rendered like any Rails view
+#  params               String               Parameters used by design
 #  css                  String               CSS for design
 #  rails_view           String               Rails view (file) name which will be used to render design
 #  author               String               Creater if design
@@ -94,6 +95,7 @@ class DcDesign
   field   :css,         type: String,  default: ''
   field   :rails_view,  type: String,  default: ''
   field   :control,     type: String,  default: ''
+  field   :params,      type: String,  default: ''
   field   :control_method,  type: String,  default: ''
   field   :author,      type: String
   field   :active,      type: Boolean, default: true 

data/app/models/dc_json_ld.rb

@@ -0,0 +1,152 @@
+#--
+# Copyright (c) 2019+ Damjan Rems
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+########################################################################
+# == Schema information
+#
+# Collection name: dc_json_ld : JSON_LD data for site optimization
+#
+#  _id                  BSON::ObjectId       _id
+#  type                 String               Type of structure
+#  data                 String               Structure data in YAML
+#  dc_json_lds          Object               Can embed substructure
+#  created_at           Time                 created_at
+#  updated_at           Time                 Last updated at
+#  created_by           BSON::ObjectId       created_by
+#  updated_by           BSON::ObjectId       Last updated by
+# 
+########################################################################
+class DcJsonLd 
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :name,        type: String
+  field :type,        type: String
+  field :data,        type: String
+  field :active,      type: Boolean,      default: true
+
+  embeds_many :dc_json_lds, :cyclic => true
+
+  field :created_by,  type: BSON::ObjectId
+  field :updated_by,  type: BSON::ObjectId
+  
+  validates :name, presence: true
+  validates :type, presence: true
+  
+##########################################################################
+# Returns JSON LD data as YAML
+##########################################################################
+def get_json_ld(parent_data)
+  yaml = (YAML.load(self.data) rescue nil) || {}
+  yaml['@type'] = self.type if yaml.size > 0
+  if dc_json_lds.size > 0
+    dc_json_lds.where(active: true).each do |element|
+      yml = element.get_json_ld(parent_data)
+      if yml.size > 0
+        yaml[element.name] ||= []
+        yaml[element.name] << yml 
+      end
+    end
+  end
+  yaml
+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 to extend option. 
+# 
+# @return [String] Form file name including path or nil if not found.
+########################################################################
+def self.dc_find_form_file(form_file)
+  form_path=nil
+  if form_file.match(/\.|\//)
+    form_path,form_file=form_file.split(/\.|\//)
+  end
+  DrgCms.paths(:forms).reverse.each do |path|
+    f = "#{path}/#{form_file}.yml"
+    return f if File.exist?(f) and (form_path.nil? or path.to_s.match(/\/#{form_path}\//i))
+  end
+  p "Form file #{form_file} not found!"
+  nil
+end
+
+########################################################################
+# Find document by ids when document are embedded into main d even if embedded
+# 
+# @param [tables] Tables parameter as send in url. Tables are separated by ;
+# @param [ids] ids as send in url. ids are separated by ;
+# 
+# @return [Document] 
+########################################################################
+def self.find_document_by_ids(tables, ids)
+  collection = tables.split(';').first.classify.constantize
+  ar_ids = ids.split(';')
+# Find top document  
+  document = collection.find(ar_ids.shift)
+# Search for embedded document
+  ar_ids.each {|id| document = document.dc_json_lds.find(id) }
+  document
+end
+
+#########################################################################
+# Returns possible options for type select field on form.
+#########################################################################
+def self.choices4_type()
+  yaml = YAML.load_file( dc_find_form_file('json_ld_schema') )
+  
+  yaml.inject([]) {|result, schema_name| result << schema_name.first }
+end
+
+#########################################################################
+# Create menu to add schema element. Called from DRGCMS Form action.
+#########################################################################
+def self.add_schema_menu(parent)
+  yaml = YAML.load_file( dc_find_form_file('json_ld_schema') )
+  if (level = parent.params['ids'].split(';').size) == 1
+    # select only top level elements
+    yaml.delete_if { |schema_name, schema_data| schema_data['level'].nil? }
+  else
+    # select only elemets which are subelements of type
+    parent_type = self.find_document_by_ids(parent.params['table'],parent.params['ids']).type
+    _yaml = []
+    yaml[parent_type].each do |name, data|
+      next unless data.class == Hash
+      _yaml << [data['type'], yaml[data['type']] ] if data['type'] and yaml[data['type']]
+    end
+    yaml = _yaml
+  end
+# create menu code
+  html = '<ul>'
+  yaml.each do |schema_name, schema_data|
+    next if level == 1 and schema_data['level'].nil?
+    url = "/dc_common/add_json_ld_schema?table=#{parent.params['table']}&ids=#{parent.params['ids']}&schema=#{schema_name}&url=#{parent.request.url}"
+    html << %Q[<li class="dc-link-ajax dc-animate" data-url="#{url}">#{schema_name}</li>]    
+  end
+  html << '</ul>' 
+end
+  
+end