drg_cms 0.4.39 → 0.4.53

data/app/helpers/dc_big_menu_renderer.rb

@@ -23,55 +23,57 @@
 #++
 
 ########################################################################
-#
+# dc_big_menu is experimental menu system which can be used as alternative
+# to dc_menu when sub menu menu level is larger than two levels. Idea is to have top two levels 
+# of menu displayed on standard top of page position with other sub levels displayed vertically 
+# on left or right part of page. Renderer also provides path method, which can be used to show 
+# menu path of currently displayed page. 
 ########################################################################
 class DcBigMenuRenderer
 
 include DcApplicationHelper
 ########################################################################
-#
+# Object initialization.
 ########################################################################
-def initialize( parent, opts )
+def initialize( parent, opts ) #:nodoc:
   @parent = parent
-#  @menu = DcSimpleMenu.find_by(site_id: dc_get_site._id)
   @site = parent.dc_get_site
   @opts = opts
   self
 end
 
 ########################################################################
-# Return selected topmenu level
+# Find out which top level menu currently displayed page belongs to. Subroutine of default method.
 ########################################################################
-def find_selected
-  ret = DcMenu.find( @parent.page.menu_id ) if @parent.page.menu_id
+def find_selected #:nodoc:
+  ret = DcBigMenu.find( @parent.page.menu_id ) if @parent.page.menu_id
   while ret and ret.parent != nil
-    ret = DcMenu.find( ret.parent )
+    ret = DcBigMenu.find( ret.parent )
   end
 # return first if not found (something is wrong)
 #  p ret
-  ret ||= DcMenu.where(dc_site_id: @site._id, parent: nil, active: true).limit(1).first
+  ret ||= DcBigMenu.where(dc_site_id: @site._id, parent: nil, active: true).limit(1).first
 end
 
 ########################################################################
 # Creates edit link if in edit mode.
 ########################################################################
-def link_4edit
-  c = ''
-  if @opts[:edit_mode] > 1
-    @opts[:editparams].merge!( { table: 'dc_simple_menu', controller: 'cmsedit', action: 'edit' } )
-    title = "#{t('drgcms.edit')}: "
-    @opts[:editparams].merge!( { id: @menu.id, title: "#{title}#{@menu.name}" } ) if @menu
-    title << t('helpers.label.dc_simple_menu.tabletitle')
-    @opts[:editparams].merge!( { action: 'index', title: title }) if @menu.nil?
-    c << dc_link_for_edit( @opts[:editparams] )
-  end
-  c
+def link_4edit #:nodoc:
+  html = ''
+  return html unless @opts[:edit_mode] > 1
+  
+  @opts[:editparams].merge!( { table: 'dc_big_menu', controller: 'cmsedit', action: 'edit' } )
+  title = "#{t('drgcms.edit')}: "
+  @opts[:editparams].merge!( { id: @menu.id, title: "#{title}#{@menu.name}" } ) if @menu
+  title << t('helpers.label.dc_big_menu.tabletitle')
+  @opts[:editparams].merge!( { action: 'index', title: title }) if @menu.nil?
+  html << dc_link_for_edit( @opts[:editparams] )
 end
 
 ########################################################################
-# Renders menu as table. Thus menu is rendered evenly justified in the width defined by CSS.
+# Returns html code for single link on a menu. 
 ########################################################################
-def link_4menu(item)
+def link_4menu(item) #:nodoc:
   html = ''
   link = item.link
   link = "/#{@site.route_name}/#{item.page_id}" #if link.blank?
@@ -84,19 +86,18 @@ def link_4menu(item)
 end
 
 ########################################################################
-# Renders left menu 
+# Renderer for menu part displayed on left position of page.
 ########################################################################
 def left_menu
   html = ''
-  m = DcMenu.find( @parent.page.menu_id )
+  m = DcBigMenu.find( @parent.page.menu_id )
 # Show menu on same level if selected has no children
-  if DcMenu.where( parent: @parent.page.menu_id ).limit(1).to_a.size == 0
-    m = DcMenu.find( m.parent )
+  if DcBigMenu.where( parent: @parent.page.menu_id ).limit(1).to_a.size == 0
+    m = DcBigMenu.find( m.parent )
   end    
-    
+#     
   html << "<div class='menu-left-item-top'>#{m.caption}</div>"
-#  
-  DcMenu.where( parent: m._id ).sort(order: 1).each do |item|
+  DcBigMenu.where( parent: m._id ).sort(order: 1).each do |item|
     html << (item._id == @parent.page.menu_id ? '<div class="menu-left-item-selected">' : '<div class="menu-left-item">')
     html << link_4menu(item) 
     html << '</div>'
@@ -104,22 +105,22 @@ def left_menu
 #  
   html << "<div class='menu-left-item-bottom'>"
   if m.parent
-    p = DcMenu.find( m.parent )
+    p = DcBigMenu.find( m.parent )
     html << "&#9650; #{link_4menu(p)}"
   end
   html << '&nbsp;</div>' 
 end
 
 ########################################################################
-# Renders menu path for selected menu
+# Renders menu path for currently selected page.
 ########################################################################
 def path
   html = ''
   a = []
-  m = DcMenu.find( @parent.page.menu_id )
+  m = DcBigMenu.find( @parent.page.menu_id )
   a << m
   while m.parent 
-    m = DcMenu.find( m.parent )
+    m = DcBigMenu.find( m.parent )
     a << m
   end
 #  
@@ -134,14 +135,13 @@ def path
   html
 end
 
-
 ########################################################################
-#
+# Default methods renders top two levels of menu on top of page.
 ########################################################################
 def default
   html = '<div class="menu0-div"><ul>'
   @selected = find_selected
-  level_0 = DcMenu.where(dc_site_id: @site._id, parent: nil, active: true).sort(order: 1).to_a
+  level_0 = DcBigMenu.where(dc_site_id: @site._id, parent: nil, active: true).sort(order: 1).to_a
   level_0.each do |item|
 # menu can be hidden from user    
     can_view, msg = dc_user_can_view(@parent, item)
@@ -151,7 +151,7 @@ def default
   end
   html << "</ul></div>"
 # submenu
-  level_1 = DcMenu.where(dc_site_id: @site._id, parent: @selected.id, active: true).sort(order: 1).to_a
+  level_1 = DcBigMenu.where(dc_site_id: @site._id, parent: @selected.id, active: true).sort(order: 1).to_a
   html << "<div class='menu1-div'><ul>\n"
   level_1.each do |item1|
 # menu can be hidden from user    
@@ -163,15 +163,15 @@ def default
 end
 
 ########################################################################
-#
+# Renderer dispatcher. Method returns HTML part of code.
 ########################################################################
 def render_html
   method = @opts[:method] || 'default'
-  respond_to?(method) ? send(method) : "Error DcMenu: Method #{method} doesn't exist!"
+  respond_to?(method) ? send(method) : "Error DcBigMenu: Method #{method} doesn't exist!"
 end
 
 ########################################################################
-#
+# Return CSS part of code.
 ########################################################################
 def render_css
   @menu ? "#{@menu.css}\n #{@selected ? @selected.css : ''}\n" : ''

data/app/helpers/dc_captcha_renderer.rb

@@ -23,12 +23,13 @@
 #++
 
 ########################################################################
-#
+# This is renderer to return captcha code field when required on data entry. It currently
+# implements only very basic captcha logic and only in Slovenian language.
 ########################################################################
-class DcCaptchaRenderer
+class DcCaptchaRenderer  < DcRenderer
   
 ########################################################################
-# check if result of captcha os OK
+# Check if result of captcha is OK.
 ########################################################################
 def is_ok?()
   return false unless self.respond_to?(@opts[:type])
@@ -36,19 +37,9 @@ def is_ok?()
 end
 
 ########################################################################
-#
-########################################################################
-def initialize( parent, opts={} )
-  @parent   = parent
-  @opts     = opts
-  @part_css = ''
-  self
-end
-
-########################################################################
-#
+# Very simple captcha type. This is Slovenian only version.
 ########################################################################
-def simpl(check=false)
+def simpl(check=false) #:nodoc:
   a1 = [['enajst', 11], ['dvanajst',12],['petindvajset',25],['triintridest',33],['devetnajst',19]]
   a2 = [['šest', 6], ['sedem',7],['osem',8],['devet',9],['deset',10]]
   op = [['seštejte','+'],['odštejte','-']]
@@ -75,26 +66,48 @@ eot
 end
 
 ########################################################################
-#
+# Very simple captcha. Will ask for name of month in a year and check if entered value is valid when
+# asked to check.
+# 
+# Parameters:
+# [check] Boolean. Send true if you are checking if entered value is OK. Default is false.
+# Method will return HTML code required to render capcha field on form.
+# 
+# Returns:
+# HTML code for displaying captcha field on page. 
+# If parameters check is true then method checks if written data is correct and returns true/false.
+########################################################################
+def simple(check=false)
+  if check
+    number = @opts['question'].split(' ').last.chomp('?').to_i
+    month = I18n.t('date.month_names')[number].downcase
+    return month == @opts['record']['captcha_result'].to_i
+  else
+    number = Random.rand(11) + 1
+    txt = I18n.t('drgcms.dc_captcha.simple_message', number)
+
+    <<eot    
+   <div style="background-color: #fafafa; border: 1px solid #eee; padding: 6px; margin: 5px 5px 25px 5px; font-size: 1.2em; border-radius: 2px;">
+     #{txt}&nbsp;<span style="color: red;">*</span>&nbsp;#{@parent.text_field('record','captcha_result', size: 5)} #{@parent.hidden_field_tag('question', txt )}
+   </div>
+eot
+  end
+end
+
+########################################################################
+# Return HTML part of code.
 ########################################################################
 def render_html
   captcha_type = @opts[:captcha_type] || @parent.params[:captcha_type]
-  return 'Captcha parameter not set!' unless captcha_type
+  return 'DcCaptchaRenderer: Error captcha_type parameter not set!' unless captcha_type
 
   html = if self.respond_to?(captcha_type)
     send(captcha_type)
   else
-    'Captcha method not defined!'
+    "DcCaptchaRenderer: Error method #{captcha_type} not defined!"
   end
 
   html
 end
 
-########################################################################
-#
-########################################################################
-def render_css
-  @part_css
-end
-
 end

data/app/helpers/dc_common_renderer.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2012-2013 Damjan Rems
+# Copyright (c) 2012+ Damjan Rems
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,30 +22,23 @@
 #++
 
 ########################################################################
-#
+# Renderer methods which may be useful on any site.
 ########################################################################
-class DcCommonRenderer
+class DcCommonRenderer < DcRenderer
 
 include DcApplicationHelper
 
 ########################################################################
-#
-########################################################################
-def initialize( parent, opts={} )
-  @parent   = parent
-  @opts     = opts
-  @css = ''
-  self
-end
-
-########################################################################
-# Renderer for printer friendly layout.
+# Renderer for printer friendly layout. Will call another renderer which
+# should provide html code for printer friendly output.
 # 
 # Parameters are passed through link. There are currently two parameters, 
 # which define renderer and method to be used for creating output.
 # 
-# renderer : Defines renderer's class 
-# method   : Defines renderer's class method
+# renderer::
+#  Defines renderer's class 
+# method::
+#  Defines renderer's class method
 ########################################################################
 def layout_4print
   opts = @opts.dup
@@ -57,39 +50,20 @@ def layout_4print
   @css  << obj.render_css.to_s
   html
 end
-=begin
-# OLD code
-  html =<<EOT 
-  <!-- Google analytics. -->
-  <script type="text/javascript">
-    var _gaq = _gaq || [];
-    _gaq.push(['_setAccount', '#{ga_acc}']);
-    _gaq.push(['_trackPageview']);
-
-  (function() {
-    if (typeof(eu_cookies_allowed) === "function" && !eu_cookies_allowed() ) return;
-    var ga = document.createElement('script'); 
-    ga.type = 'text/javascript'; 
-    ga.async = true;
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-    var s = document.getElementsByTagName('script')[0];
-    s.parentNode.insertBefore(ga, s);
-  })();
-</script>
-EOT
-=end
 
 ########################################################################
 # Renderer for Google analytics code.
 # 
-# Parameters are passed through @opts hash and can therefore be set on site or design or page.
+# Parameters:
+# Are passed through @opts hash and can therefore be set on site or design 
+# or page document parameters field as ga_acc key.
 # 
 # If eu_cookies_allowed function is defined in javascript libraries it will be
-# called and if false is returend GA code will not be executed. This is in 
+# called and if false is returned GA code will not be executed. This is in 
 # order with European cookie law.
 # 
 # Example:
-# dc_render(:dc_common_renderer, method: 'google_analytics', code: 'UA-12345678-9')
+#    dc_render(:dc_common_renderer, method: 'google_analytics', code: 'UA-12345678-9')
 ########################################################################
 def google_analytics
   ga_acc = @opts[:code] || @opts[:ga_acc]
@@ -115,18 +89,11 @@ EOT
 end
 
 ########################################################################
-#
+# Return HTML part of code.
 ########################################################################
 def render_html
   method = @opts[:method] || 'default'
   respond_to?(method) ? send(method) : "Error DcCommonRenderer: Method #{method} doesn't exist!"
 end
 
-########################################################################
-#
-########################################################################
-def render_css
-  @css
-end
-
 end

data/app/helpers/dc_menu_renderer.rb

@@ -23,15 +23,22 @@
 #++
 
 ########################################################################
-#
+# Default menu renderer for dc_menus collection. Renderer produces output for 
+# rendering menu with (theoretically) infinite level of sub menus. In practice 
+# reasonable maximum level of 4 is advised.
+# 
+# Example (as used in design):
+#    dc_render(:dc_menu, name: 'my_menu')
+#    # when :name option is ommited it will use site document's menu_name field
+#    dc_render(:dc_menu)
 ########################################################################
 class DcMenuRenderer
 
 include DcApplicationHelper
 ########################################################################
-#
+# Object initialization. Will also prepare DcMenu document.
 ########################################################################
-def initialize( parent, opts )
+def initialize( parent, opts ) #:nodoc:
   @parent = parent
   opts[:name] ||= parent.site.menu_name # default in site
   @menu = DcMenu.find_by(name: opts[:name].to_s)
@@ -40,7 +47,7 @@ def initialize( parent, opts )
 end
 
 ########################################################################
-# Return selected topmenu level
+# Return selected topmenu level.
 ########################################################################
 def find_selected
   ret = @menu.dc_menu_items.find( @parent.page.menu_id ) if @parent.page.menu_id
@@ -51,33 +58,36 @@ end
 ########################################################################
 # Creates edit link if in edit mode.
 ########################################################################
-def link_4edit(opts)
+def link_4edit(opts) #:nodoc:
   html = ''
-  if @opts[:edit_mode] > 1
-    opts.merge!( { controller: 'cmsedit', action: 'edit' } )
-    title = "#{t('drgcms.edit')}: "
-    opts[:title] = "#{title} #{opts[:title]}"
-    html << '<li>'+dc_link_for_edit(opts)+'</li>'
-  end
-  html
+#  return html unless @opts[:edit_mode] > 1
+
+  opts.merge!( { controller: 'cmsedit', action: 'edit' } )
+  title = "#{t('drgcms.edit')}: "
+  opts[:title] = "#{title} #{opts[:title]}"
+  
+  html << '<li>'+dc_link_for_edit(opts)+'</li>'
 end
 
 ########################################################################
-# Returns html code required for link in a menu.
+# Returns html code required to create single link in a menu. Subroutine of do_menu_level.
 ########################################################################
 def link_4menu(item)
-# Error in early development. Throw out
+# link should start with '/'
   item.link = ((item.link[0] == '/' ? '' : '/') + item.link) unless item.link.match('http')
   target = item.target.blank? ? nil : item.target
-  # - in first place won't write caption text
+# - in first place won't write caption text
   caption   = item.caption[0] == '-' ? '' : item.caption.to_s
   img_title = item.caption.to_s.sub('-','')
-  (item.picture.blank? ? '' : @parent.link_to( @parent.image_tag(item.picture), item.link, {title: img_title, target: target} )) +
-  ( caption.blank? ? '' : @parent.link_to(caption, item.link, {target: target}) )
+# add picture if picture is not blank
+  (item.picture.blank? ? '' : 
+    @parent.link_to( @parent.image_tag(item.picture), item.link, {title: img_title, target: target} )) +
+  (caption.blank? ? '' : 
+    @parent.link_to(caption, item.link, {target: target}) )
 end
 
 ########################################################################
-# Creates html required for submenu on one level
+# Creates HTML code required for submenu on single level. Subroutine of default.
 ########################################################################
 def do_menu_level(menu, options={})
   html = '<ul>' 
@@ -126,7 +136,7 @@ def default
 end
 
 ########################################################################
-#
+# Renderer dispatcher. Method returns HTML part of code.
 ########################################################################
 def render_html
   method = @opts[:method] || 'default'
@@ -134,7 +144,7 @@ def render_html
 end
 
 ########################################################################
-#
+# Return CSS part of code.
 ########################################################################
 def render_css
   @menu.css if @menu