agile_rails 0.0.0.1

data/app/helpers/ar_image_helper.rb

@@ -0,0 +1,128 @@
+#--
+# 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.
+#++
+
+
+####################################################################
+# Helpers needed by some form fields on ar_image form
+####################################################################
+module ArImageHelper
+
+############################################################################
+# Will return code for previewing image on top of ar_image entry form
+############################################################################
+def ar_image_preview(document, *parms)
+  src = "/#{agile_get_site.params.dig('ar_image', 'location')}/#{document.first_available_image}"
+  %(<span class="ar-image-preview ar-image-preview-1"><img src="#{src}"></img></span>).html_safe
+end
+
+############################################################################
+# Will return code for previewing resized images on ar_image entry form
+############################################################################
+def ar_image_preview_resized(document, yaml, ignore)
+  size = yaml['name'].last
+  return '' if document["size_#{size}"].blank?
+
+  src = "/#{agile_get_site.params.dig('ar_image', 'location')}/#{document.id}-#{size}.#{document.img_type}?#{Time.now.to_i}"
+  %(<span class="ar-image-preview"><img src="#{src}"></img></span><div id="ar-image-preview"></div>).html_safe
+end
+
+############################################################################
+# Will return choices for preset image sizes
+############################################################################
+def ar_image_choices_for_image_size
+  sizes = agile_get_site.params.dig('ar_image', 'sizes')
+  return ['300x200'] if sizes.blank?
+
+  sizes.split(",").map(&:strip)
+end
+
+############################################################################
+# Will return code for invoking ar_image_search form to select image select on an AgileRails Form.
+#
+# @param [String] field_name : Field name to which selected image value will be saved.
+###########################################################################
+def ar_image_invoke(field_name)
+  return '' unless agile_get_site.params.dig('ar_image', 'location')
+
+  url = url_for(controller: :cmsedit, form_name: :ar_image_search, table: :ar_image, field_name: field_name)
+  %(<span class="ar-window-open" data-url="#{url}" title="#{t('agile.ar_image.invoke')}">#{mi_icon('image-o')}</span>).html_safe
+end
+
+############################################################################
+# Will return code for previewing image on top of ar_image entry form
+############################################################################
+def first_ar_image(document, *parms)
+  src = "/#{agile_get_site.params.dig('ar_image', 'location')}/#{document.first_available_image}"
+  %(<span class="ar-image-preview"><img src="#{src}"></img></span><span id="ar-image-preview">).html_safe
+end
+
+######################################################################
+# Will format qry result as html code for selecting image
+######################################################################
+def select_links_for_ar_image(doc, *parms)
+  %w[o s m l].map { |size| ar_image_link_for_select(doc, size) }.join.html_safe
+end
+
+######################################################################
+# Will return HTML code for selecting image
+######################################################################
+def ar_image_link_for_select(doc, what)
+  field = "size_#{what}"
+  value = doc.send(field)
+  return '' if value.blank?
+
+  value = value.split(/\+/).first
+  src = "/#{agile_get_site.params.dig('ar_image', 'location')}/#{doc.id}-#{what}.#{doc.img_type}"
+  %(
+<div class="img-link"><div>
+ #{value}<br>
+  <i class="mi-o mi-preview" onclick="ar_image_preview('#{src}');" title="#{t('agile.ar_image.preview')}"></i>
+  <i class="mi-o mi-check_circle" onclick="ar_image_select('#{src}');" title="#{t('agile.ar_image.select')}"></i>
+</div></div>)
+end
+
+######################################################################
+# Will return image file for requested size.
+#
+# @param [String] file_name : Image file name
+# @param [String] size : Preferred image size
+#
+# @return [String] : Image file name if requested size is found. Otherwise first available image.
+######################################################################
+def ar_image_get_by_size(file_name, size)
+  id = file_name[file_name.rindex('/') + 1, 24]
+  return 'error: ID not valid' unless BSON::ObjectId.legal?(id)
+
+  image = ArImage.find(id)
+  return 'error: ID not found' unless image
+
+  what = %w[o s m l].inject('l') do |r, e|
+    field_name = "size_#{e}".to_sym
+    break e if doc.send(field_name) == size
+
+    e
+  end
+  "/#{agile_get_site.params.dig('ar_image', 'location')}/#{doc.id}-#{what}.#{doc.img_type}"
+end
+
+end

data/app/models/agile_form_fields/action.rb

@@ -0,0 +1,61 @@
+#--
+# 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.
+#+
+module AgileFormFields
+
+###########################################################################
+# Implementation of action AgileRails form field. Actions can also be inserted on
+# the form like just like on action pane.
+# 
+# ===Form options:
+# * +type:+ action (required)
+# * +action_type:+ link, submit or ajax action (default link)
+# * +caption:+ Caption for action
+# * +icon:+ Action icon
+# * +url:+ direct url link
+# * +controller:+ controller name
+# * +action:+ action name 
+# * +html:+ html options which apply to link_to (optional)
+#      
+# Form example:
+#    30:
+#      type: action
+#      action_type: popup
+#      caption: Some action
+#      icon: cogs
+#      controller: my_controller
+#      action: my_action
+#      id: id # will be replaced by record.id
+###########################################################################
+class Action < AgileFormField
+  
+###########################################################################
+# Render link_to field html code
+###########################################################################
+def render
+  @yaml['type'] = @yaml['action_type'] || 'link'
+  @html += '<ul class="action">' + @env.agile_link_ajax_window_submit_action(@yaml, @record) + '</ul>'
+  self
+end
+
+end
+end

data/app/models/agile_form_fields/agile_form_field.rb

@@ -0,0 +1,322 @@
+#--
+# 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.
+#+
+
+###########################################################################
+# AgileFormFields module contains definitions of classes used for 
+# rendering data entry fields on AgileRails forms. 
+# 
+# Every data entry field type written in lowercase in form must have its class 
+# defined in CamelCase in AgileFormFields module. 
+# 
+# Each class must have at least render method implemented. All classes can
+# inherit from AgileFormField class which acts as abstract template class and implements 
+# most of surrounding code for creating custom AgileRails form field.
+# 
+# Render method must create html and javascript code which must be
+# saved to internal @html and @js variables. Field code is then retrived by accessing
+# these two internal variables.
+# 
+# Example. How the field code is generated in form renderer:
+#    klas_string = yaml['type'].camelize
+#    if AgileFormFields.const_defined?(klas_string) # check if field type class is defined
+#      klas = AgileFormFields.const_get(klas_string)
+#      field = klas.new(self, @record, options).render
+#      javascript += field.js
+#      html += field.html
+#    end
+# 
+# Example. How to mix AgileRails field code in Rails views:
+#    <div>User:
+#    <%= 
+#      opts = {'name' => 'user', 'choices' => "eval agile_choices_for('ar_user','name')", 'include_blank' => true }
+#      dt = AgileFormFields::Select.new(self, {}, opts).render
+#      (dt.html + javascript_tag(dt.js)).html_safe
+#     %></div> 
+###########################################################################
+module AgileFormFields
+
+###########################################################################
+# Template method for AgileRails form field definition. This is abstract class with
+# most of the common code for custom form field already implemented.
+###########################################################################
+class AgileFormField
+attr_reader :js
+attr_reader :css
+
+####################################################################
+# AgileFormField initialization code.
+# 
+# Parameters:
+# [env] Controller object. Controller object from where object is created. Usually self is send. 
+# [record] Document object. Document object which holds fields data.
+# [yaml] Hash. Hash object holding field definition data.
+# 
+# Returns: 
+# Self
+####################################################################
+def initialize( env, record, yaml )
+  @env    = env
+  @record = record
+  @yaml   = yaml
+  @form   = env.form
+  @yaml['html'] ||= {}
+  # set readonly field
+  #@readonly = (@yaml and @yaml['readonly']) || (@form and @form['readonly'])
+  @readonly = @yaml&.dig('readonly') || @form&.dig('readonly')
+  @yaml['html']['readonly'] = true if @readonly
+  # assign size to html element if not already there
+  @yaml['html']['size'] ||= @yaml['size'] if @yaml['size'] 
+    
+  @html   = ''  
+  @js     = ''
+  @css    = set_css_code @yaml['css']
+  self
+end
+
+####################################################################
+# Returns html code together with CSS code.
+####################################################################
+def html
+  @html
+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 = '')
+  c = I18n.t(key)
+  if c.match(/translation missing/i)
+    c = I18n.t(key, locale: 'en') 
+    # Still not found. Return default if set
+    c = default unless default.blank?
+  end
+  c
+end
+
+####################################################################
+# Standard code for returning readonly field.
+####################################################################
+def ro_standard(value = nil)
+  if value.nil?
+    value = if @yaml['html']['value']
+      @yaml['html']['value']
+    else
+      @record.respond_to?(@yaml['name']) ? @record.send(@yaml['name']) : nil
+    end
+  end
+  @html += %(<div id="#{@yaml['name']}" class="ar-readonly">#{value}</div>)
+  self
+end
+
+####################################################################
+# Set initial value of the field when initial value is set in url parameters..
+# 
+# Example: Form has field named picture. Field can be initialized by 
+# setting value of param p_picture.
+#    params['p_picture'] = '/path/to_picture'
+#    
+# When multiple initial values are assigned it is more convinient to assign them 
+# through flash object.
+#    flash[:record] = {}
+#    flash[:record]['picture'] = '/path/to_picture'
+####################################################################
+def set_initial_value(opt1 = 'html', opt2 = 'value')
+  @yaml['html'] ||= {}
+  value_send_as = 'p_' + @yaml['name']
+  if @env.params[value_send_as]
+    @yaml[opt1][opt2] = @env.params[value_send_as] 
+  elsif @env.flash[:record] and @env.flash[:record][@yaml['name']]
+    @yaml[opt1][opt2] = @env.flash[:record][@yaml['name']]
+  end
+  set_default_value(opt1, opt2) if @yaml['default']
+end
+
+####################################################################
+# Will set default value for field on a AgileRails form.
+####################################################################
+def set_default_value(opt1, opt2)
+  return if @yaml[opt1][opt2].present?
+  return if @record&.send(@yaml['name']).present?
+
+  @yaml[opt1][opt2] = if @yaml['default'].class.to_s == 'Hash'
+                        evaluate = @yaml['default']['eval']
+                        return if evaluate.blank?
+                        # add @env if it's a method call and @env is not present
+                        if evaluate[0] != evaluate[0].upcase && !evaluate.match('@env')
+                          evaluate.prepend('@env.')
+                        end
+                        eval(evaluate)
+                      else
+                        @yaml['default']
+                      end
+end
+
+####################################################################
+# Returns style html code for AgileRails Form object if style directive is present in field definition.
+# Otherwise returns empty string.
+# 
+# Style may be defined like:
+#    style:
+#      height: 400px
+#      width: 800px
+#      padding: 10px 20px
+#     
+#    or 
+#     
+#    style: "height:400px; width:800px; padding: 10px 20px;"
+#    
+#  Style directive may also be defined under html directive.
+#    html:
+#      style:
+#        height: 400px
+#        width: 800px
+#    
+# 
+####################################################################
+def set_style
+  style = @yaml['html']['style'] || @yaml['style']
+  case style.class
+    when String then "style=\"#{style}\""
+    when Hash then
+      value = style.to_a.map { "#{_1}: #{_2}" }.join(';')
+      "style=\"#{value}\"" 
+    else ''
+  end 
+end
+
+####################################################################
+# Sets css code for the field if specified. It replaces all occurences of '# ' 
+# with field name id, as defined on form.
+####################################################################
+def set_css_code(css)
+  return '' if css.blank?
+
+  css.gsub!('# ', "#td_record_#{@yaml['name']} ") if css.match('# ')
+  css
+end
+
+####################################################################
+# Will return ruby hash formated as javascript string which can be used
+# for passing parameters in javascript code.
+# 
+# Parameters:
+# [Hash] Hash. Ruby hash parameters.
+# 
+# Form example: As used in forms
+#    options:
+#      height: 400
+#      width: 800
+#      toolbar: "basic"
+#      
+#  => "height:400, width:800, toolbar: 'basic'"
+# 
+# Return: 
+# String: Options formated as javascript options.
+#      
+####################################################################
+def hash_to_options(options)
+  options.inject('') do |r, element|
+    key, option = element
+
+    r += "#{key} : "
+    r += case
+         when option.to_s.match(/function/i) then option
+         when option.class == String then "\"#{option}\""
+         else option.to_s
+         end
+    r += ",\n"
+  end
+end
+
+####################################################################
+# Options may be defined on form as hash or as string. This method will
+# ensure conversion of options into hash.
+#
+# Parameters:
+# [String or Hash] : Form options
+#
+# Form example: As used in forms
+#    options:
+#      height: 400
+#      width: 800
+#      toolbar: "'basic'"
+#  or
+#
+#  options: "height:400, width:800, toolbar:'basic'"
+#
+# Return:
+# Hash: Options as Hash
+####################################################################
+def options_to_hash(options)
+  return {} if options.blank?
+  return options unless options.class == String
+
+  options.chomp.split(',').inject({}) do |r, e|
+    key, value = e.chomp.split(':')
+    value.strip!
+    value = value[1..value.size - 2] if value[0] =~ /\'|\"/
+    r[key.strip] = value
+    r
+  end
+end
+
+####################################################################
+# Checks if field name exists in document and alters record parameters if necesary.
+# Method was added after fields that do not belong to current edited record
+# were added to forms. Valid form only field name must start with underscore (_) letter.
+# 
+# Return: 
+# String: 'record' or '_record' when valid nonexisting field is used
+####################################################################
+def record_text_for(name)
+  (!@record.respond_to?(name) && name[0] == '_') ? '_record' : 'record'
+end
+
+
+###########################################################################
+# Default get_data method for retrieving data from form. If data that will be written to
+# database must be recalculated, then AgileRails field class definition will define it's own get_data method.
+# 
+# Parameters:
+# [params] Controllers params object.
+# [name] Field name
+# 
+# Most of classes will use this default method which simply returns params['record'][name].
+###########################################################################
+def self.get_data(params, name)
+  params['record'][name]
+end
+
+end
+end

data/app/models/agile_form_fields/belongs_to.rb

@@ -0,0 +1,112 @@
+#--
+# 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.
+#+
+module AgileFormFields
+
+###########################################################################
+# Implementation of belongs_to AgileRails form field.
+# belongs_to form field is used to edit records that are related to currently edited record.
+#
+# Related records are edited inside iframe.
+#
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ belongs_to (required)
+# * +form_name:+ name of form which will be used for editing
+# * +load:+ when is embedded iframe loaded. default=on form load, delay=on tab select, always=every time tab is selected)
+# * +belongs_to:+ optionaly define name of model, to which edited table is related
+# * +html:+ html options (optional)
+#   * +height:+ height of embedded object in pixels (1000)
+#   * +width:+ width of embedded object in pixels (500)
+# 
+# Form example:
+#    10:
+#      name: ar_parts
+#      type: belongs_to
+#      form_name: ar_part
+#      refresh: delay
+#      belongs_to: ar_page
+#      html:
+#        height: 1000
+###########################################################################
+class BelongsTo < AgileFormField
+
+###########################################################################
+# Render belongs_to AgileRails form field code
+###########################################################################
+def render
+  # some HTML5 defaults
+  @yaml['html'] ||= {}
+  @yaml['html']['width'] ||= '99%'
+
+  @yaml['action'] ||= 'index'
+  # defaults both way 
+  @yaml['table']     ||= @yaml['form_name'] if @yaml['form_name']
+  @yaml['form_name'] ||= @yaml['table'] if @yaml['table']
+
+  if @yaml['name'] == @yaml['table'] || @yaml['table'] == 'ar_memory'
+    tables = @yaml['table']
+    ids    = @record.id
+  else
+    tables = @env.tables.inject('') { |r, v| r += "#{v[1]};" } + @yaml['table']
+    ids    = (@env.ids.present? ? @env.ids.join(';') + ';' : '') + @record.id.to_s
+  end
+  # message when new record
+  if @record.new_record? && tables != 'ar_temp'
+    @yaml['html']['srcdoc'] = %(
+<div style='font-family: helvetica; font-size: 1.7rem; font-weight: bold; color: #ddd; padding: 1rem'>
+  #{I18n.t('agile.iframe_save_to_view')}
+</div>)
+  end
+  html5 = @yaml['html'].map{ |k, v| %(#{k}="#{v}") }.join(' ')
+
+  # edit enabled belong_to form on a readonly form
+  readonly = AgileHelper.dont?(@yaml['readonly']) ? nil : @readonly
+  opts = { controller: :agile, action: @yaml['action'],
+           ids: ids, table: tables, form_name: @yaml['form_name'], 
+           field_name: @yaml['name'], iframe: "if_#{@yaml['name']}", readonly: readonly }
+  # additional parameters if specified
+  @yaml['params'].each { |k, v| opts[k] = @env.agile_value_for_parameter(v) } if @yaml['params']
+         
+  @html += "<iframe class='iframe_embedded' id='if_#{@yaml['name']}' name='if_#{@yaml['name']}' #{html5}></iframe>"
+  return self if @record.new_record? && tables != 'ar_temp'
+
+  url  = @env.url_for(opts)
+  attributes = case @yaml['load']
+               when nil?, 'default'
+                 "'src', '#{url}'"
+               when 'delay'
+                 "'data-src-#{@yaml['load']}', '#{url}'"
+               else
+                 "{'data-src-#{@yaml['load']}': '#{url}', src: '#{url}'}"
+               end
+  @js += %(
+$(document).ready( function() {
+  $('#if_#{@yaml['name']}').attr(#{attributes});
+});)
+
+  self
+end
+
+end
+
+end