agile_rails 0.0.0.1

data/app/renderers/agile_renderer.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright (c) 2024+ 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.
+#+
+
+########################################################################
+# This is default AgileRails renderer class definition which can be reused by other
+# renderers.
+########################################################################
+class AgileRenderer
+
+########################################################################
+# Object initialization.
+########################################################################
+def initialize( env, opts = {} )
+  @env  = env
+  @page = env.page
+  @opts = opts
+  @css  = ''
+  self
+end
+
+########################################################################
+# Renderer dispatcher. Method returns HTML part of code.
+########################################################################
+def render_html
+  can_view, msg = @env.agile_user_can_view(@env, @env.page)
+  return msg unless can_view
+
+  method = @opts[:method] || 'default'
+  respond_to?(method) ? send(method) : "Error #{self.class}: Method (#{method}) not defined!"
+end
+
+########################################################################
+# Return CSS part of code.
+########################################################################
+def render_css
+  @css
+end
+
+end

data/app/renderers/ar_ad_renderer.rb

@@ -0,0 +1,219 @@
+#--
+# Copyright (c) 2024+ 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 BUTe 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.
+#+
+
+########################################################################
+# Ads renderer. Typically ads renderer is defined in design like this.
+#    <div id="ads-on-top">
+#       <%= agile_render(:ar_ad, position: 'top') %>
+#    </div>
+# 
+# There can be more than one ad shown on the same position. Therefore Ads can be grouped by position 
+# they are displayed at. Position name can be any string. I suggest using top, right ... 
+# 
+# Ads may be prioritized. Higher priority means higher probability that ad will be selected for display. 
+# 
+# Clicks on picture and flash can be intercepted and are saved into ar_ad_stat table. 
+# It is also possible to limit number of times ad will be displayed or clicked. 
+########################################################################
+class ArAdRenderer
+  
+include AgileApplicationHelper
+
+########################################################################
+#
+########################################################################
+def initialize( env, opts={} ) #:nodoc:
+  @env = env
+  @opts   = opts
+  @css    = ''
+  self
+end
+
+########################################################################
+# Finds ads that will be rendered. Subroutine of multi method.
+########################################################################
+def find_ads_multi() #:nodoc:
+  ads = ArAd.where( position: @opts[:position], active: true).to_a#, :valid_to.gt => Time.now, :valid_from.lt => Time.now).to_a
+#p @opts, ads.size, '*-*-*-*'
+  ads.delete_if { |ad| (ad.valid_to and ad.valid_to < Time.now) or 
+                       (ad.valid_from and ad.valid_from > Time.now) or 
+                       (ad.displays > 0 and ad.displayed >= ad.displays) or
+                       (ad.clicks > 0 and ad.clicked >= ad.clicks) }
+                   
+  ads
+end
+
+########################################################################
+# This is an experiment of how to render multiple ads on same location simultaneously by
+# fade in and out div on which ad resides.
+########################################################################
+def multi
+  return '' if @env.session[:is_robot] # don't bother if robot
+  html = "<div id='ad-#{@opts[:position]}-div'>"
+  n = 0
+  find_ads_multi.each do |ad|
+    div = "ad-#{@opts[:position]}-#{n+=1}"
+    html += "<div id='#{div}' style='position: absolute; display: none;'>"
+    # all except first are hidden
+#    html += n == 1 ? '>' : 'style="display: none;">'
+    html += case ad.type
+    when 1 then # picture
+      picture_link ad
+    when 2 then # flash
+      flash_link ad
+    when 3 then # script
+      ad.script
+    else
+      'Error. Wrong ad type!'
+    end
+    html += '</div>'
+  end
+# 
+  html += '</div>'
+  if n > 0
+    js = <<EOJS
+  ar_ad_next_slide = function(div, index, max, timeout) {
+    index = index + 1;
+    div_show = div + index.toString();
+    index_h = index - 1;
+    if (index_h == 0) index_h = max;
+    div_hide = div + index_h.toString();
+    $('#' + div_show).fadeIn(1500);
+    $('#' + div_hide).fadeOut(1500);
+
+    if (index == max) index = 0; 
+    setTimeout( function () { ar_ad_next_slide(div, index, max, timeout); }, timeout);
+}
+
+  $(document).ready(function () {
+    ar_ad_next_slide("ad-#{@opts[:position]}-", 0, #{n}, 5000)
+  });       
+EOJS
+  html += @env.javascript_tag(js)
+  end
+  html
+end
+
+########################################################################
+# Determines which add will be displayed next. Subroutine of default method.
+########################################################################
+def find_ad_to_display()
+  ads = ArAd.where(ar_site_id: @env.site.id, position: @opts[:position], active: true).to_a#, :valid_to.gt => Time.now, :valid_from.lt => Time.now).to_a
+
+  ads.delete_if { |ad| (ad.valid_to and ad.valid_to < Time.now) or 
+                       (ad.valid_from and ad.valid_from > Time.now) or 
+                       (ad.displays > 0 and ad.displayed >= ad.displays) or
+                       (ad.clicks > 0 and ad.clicked >= ad.clicks) }
+  return nil if ads.size == 0
+  # Determine ad to display, based on priority. This is of course not totally accurate,
+  # but it will have to do.
+  sum = ads.sum(&:priority)
+  rnd = Random.rand(sum)
+  r = 0
+  ads.each do |e|
+    return e if rnd >= r && rnd < r + e.priority
+
+    r += e.priority
+  end
+  ads.last # we really shouldn't be here
+end
+
+########################################################################
+# Code for flash ad.
+########################################################################
+def flash_ad(ad)
+  click_tag = ad.link.to_s.size > 5 ? "flashvars=\"clickTag=#{ad.link}\"" : '' 
+<<EOT
+<div class="link_to_track" id="#{ad.id}">
+  <object>
+    <param name="wmode" value="transenv" />
+    <embed width="#{ad.width}" height="#{ad.height}" src="#{ad.file}" #{click_tag}
+           wmode=transenv allowfullscreen='true' allowscriptaccess='always' type="application/x-shockwave-flash"></embed>
+  </object>
+</div> 
+
+<script type='text/javascript'>
+$('##{ad.id}').mousedown(function (e){
+    $.post('/ar_common/ad_click', { id: this.id });
+    return true;
+});
+</script>     
+EOT
+end
+
+########################################################################
+# Code for picture ad.
+########################################################################
+def picture_ad(ad)
+  @env.link_to @env.image_tag(ad.file), ad.link, id: ad.id, class: 'link_to_track', target: ad.link_target 
+end
+
+########################################################################
+# Default method for rendering ads. 
+########################################################################
+def default
+  return '' if @env.session[:is_robot] # don't bother if robot
+  html = ''
+  if (ad = find_ad_to_display)
+# save to statistics, if not in cms
+    if @opts[:edit_mode] < 1
+      ArAdStat.create!(ar_ad_id: ad.id, ip: @env.request.ip, type: 1 )
+# save display counter  
+      ad.displayed += 1
+      ad.save
+    end
+    html += case ad.type
+    when 1 then # picture
+      picture_ad ad
+    when 2 then # flash
+      flash_ad ad
+    when 3 then # script
+      ad.script
+    else
+      'Error. Wrong ad type!'
+    end
+  end
+  html
+end
+
+########################################################################
+# Renderer dispatcher. Method returns HTML part of code.
+########################################################################
+def render_html
+  method = @opts[:method] || 'default'
+  html = if method and self.respond_to?(method)
+    send(method)
+  else
+    " ArAdRenderer: method #{method} not defined!"
+  end
+  html  
+end
+
+########################################################################
+# Render CSS. This method returns css part of code.
+########################################################################
+def render_css
+  @css
+end
+
+end

data/app/renderers/ar_captcha_renderer.rb

@@ -0,0 +1,113 @@
+#--
+# Copyright (c) 2024+ 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.
+#+
+
+########################################################################
+# 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 ArCaptchaRenderer  <  AgileRenderer
+  
+########################################################################
+# Check if result of captcha is OK.
+########################################################################
+def is_ok?
+  return false unless self.respond_to?(@opts[:type])
+
+  send(@opts[:type], true)
+end
+
+########################################################################
+# Very simple captcha type. This is Slovenian only version.
+########################################################################
+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','-']]
+
+  if check
+    # Prosimo sestejte dvanajst in sedem
+    ha1, hop,  ha2 = Hash[a1], Hash[op], Hash[a2]
+    n1, operacija, prvi, n2, drugi = @opts['vprasanje'].split(' ')
+    rezultat = eval("#{ha1[prvi]}#{hop[operacija]}#{ha2[drugi]}")
+    return rezultat == @opts['record']['rezultat'].to_i
+  else
+    txt = "Prosimo #{op[Random.rand(1)][0]} #{a1[Arndom.rand(4)][0]} in #{a2[Arndom.rand(4)][0]}"
+    y = {}
+    y['name'] = 'rezultat'
+    y['html'] = {}
+    y['html']['size'] = 5
+
+    <<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;#{@env.text_field('record','rezultat', size: 5)} #{@env.hidden_field_tag('vprasanje', txt )}
+   </div>
+eot
+  end
+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(' gile.ar_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;#{@env.text_field('record','captcha_result', size: 5)} #{@env.hidden_field_tag('question', txt )}
+   </div>
+eot
+  end
+end
+
+########################################################################
+# Return HTML part of code.
+########################################################################
+def render_html
+  captcha_type = @opts[:captcha_type] || @env.params[:captcha_type]
+  return ' ArCaptchaRenderer: Error captcha_type parameter not set!' unless captcha_type
+
+  html = if self.respond_to?(captcha_type)
+    send(captcha_type)
+  else
+    " ArCaptchaRenderer: Error method #{captcha_type} not defined!"
+  end
+
+  html
+end
+
+end

data/app/renderers/ar_common_renderer.rb

@@ -0,0 +1,90 @@
+#--
+# Copyright (c) 2024+ 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.
+#+
+
+########################################################################
+# Renderer methods which may be useful on any site.
+########################################################################
+class AgileCommonRenderer <  AgileRenderer
+
+include AgileApplicationHelper
+
+########################################################################
+# 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
+########################################################################
+def layout_4print
+  return '' if @env.params[:renderer].blank?
+
+  opts = @opts.dup
+  opts[:method] = @env.params[:method]
+  klass = (@env.params[:renderer] + '_renderer').classify
+  obj   = Kernel.const_get(klass, Class.new).new(@env, opts)
+
+  html = obj.render_html
+  @css += obj.render_css.to_s
+  html
+end
+
+########################################################################
+# Renderer for Google analytics code.
+# 
+# Parameters:
+# Are passed through @opts hash and can therefore be set on site  
+# or page document parameters field as ga_acc key. You may also disable sending 
+# 
+# 
+# If eu_cookies_allowed function is defined in javascript libraries it will be
+# called and if false is returned GA code will not be executed. This is in 
+# order with European cookie law.
+# 
+# Example:
+#    agile_render(:agile_common_renderer, method: 'google_analytics', code4: 'UA-12345678-9')
+########################################################################
+def google_analytics
+  html = ''
+  ga4_acc = @opts[:code4] || @opts[:ga4_acc]
+  if ga4_acc && ga4_acc != '/'
+    html += %(
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=#{ga4_acc}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '#{ga4_acc}');
+</script>)
+  end
+
+  html.html_safe
+end
+
+end

data/app/renderers/ar_gallery_renderer.rb

@@ -0,0 +1,107 @@
+#--
+# Copyright (c) 2024+ 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.
+#+
+
+########################################################################
+# ArGalleryRenderer renders data for displaying picture gallery on the web page.
+# 
+# Example:
+#    <div id="page">
+#      <%= agile_render(:ar_gallery) if document.gallery %>
+#    </div>
+#
+########################################################################
+class ArGalleryRenderer
+
+include AgileApplicationHelper
+include  AgileCommonHelper
+
+########################################################################
+# Object initialization.
+########################################################################
+def initialize( env, opts = {} ) #:nodoc:
+  @env  = env
+  @opts = opts
+  @css  = ''
+end
+
+#########################################################################
+# Default ArGallery render method. It will simply put thumbnail pictures side by side and
+# open big picture when clicked on thumbnail.
+#########################################################################
+def default
+  html = '<div class="picture-gallery"><ul>' + new_menu()
+  ArGallery.where(doc_id: @opts[:doc_id], doc_type: @opts[:doc_type], active: true).order(:order).each do |picture|
+    html += "<li>" + edit_menu(picture)
+    html += @env.link_to(@env.image_tag(picture.thumbnail, title: picture.title), picture.picture)
+    html += '</li>'
+  end
+  html += '</ul></div>'
+end
+
+#########################################################################
+# Renderer dispatcher. Method returns HTML part of code.
+########################################################################
+def render_html
+  method = @opts[:method] || 'default'
+  respond_to?(method) ? send(method) : "Error ArGalleryRenderer: Method #{method} doesn't exist!"
+end
+
+########################################################################
+# Return CSS part of code.
+########################################################################
+def render_css
+  @css
+end
+
+private
+
+########################################################################
+# 
+########################################################################
+def edit_menu(picture)
+  return '' if @opts[:edit_mode] < 2
+
+  opts = { action: :edit,
+           title: "#{t('agile.edit')}: #{picture.title}",
+           id: picture.id,
+           table: 'ar_gallery'
+  }
+  "<li>#{@env.agile_link_for_edit(opts)}</li>\n"
+end
+
+########################################################################
+#
+########################################################################
+def new_menu
+  return '' if @opts[:edit_mode] < 2
+
+  opts = { action: :new,
+           title: "#{t('agile.new')}: Picture",
+           p_doc_id: @opts[:doc_id],
+           p_doc_type: @opts[:doc_type],
+           table: 'ar_gallery'
+  }
+  "<li>#{@env.agile_link_for_create(opts)}</li>\n"
+end
+
+end