agile_rails 0.0.0.1

data/app/controls/ar_help_control.rb

@@ -0,0 +1,139 @@
+#--
+# 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.
+#+
+
+######################################################################
+# Controls for creating help files
+######################################################################
+module ArHelpControl
+
+######################################################################
+# Will fill ar_temp with help documents found in a defined project directory.
+######################################################################
+def project_refresh
+  ArTemp.clear(temp_key)
+
+  if params[:record][:select_project].present?
+    # far less complicated if saved to session
+    session[:help_project] = params[:record][:select_project]
+    session[:help_lang] = params[:record][:lang_1]
+    help_dir_name = "#{session[:help_project]}/help/"
+    # create help directory if not yet exists
+    FileUtils.mkdir(help_dir_name) unless File.exist?(help_dir_name)
+    Dir["#{help_dir_name}*"].each do |file_name|
+      lang = File.extname(file_name).sub('.', '')
+      next unless lang == session[:help_lang]
+
+      ArTemp.new(key: temp_key,
+                 project: session[:help_project],
+                 form_name: File.basename(file_name, '.*'),
+                 lang: lang,
+                 updated_at: File.mtime(file_name)).save
+    end
+  end
+  render json: { url: url_for(controller: :agile, table: :ar_temp, form_name: :agile_help) }
+end
+
+######################################################################
+# Will populate fields with default values
+######################################################################
+def new_record
+  @record.project = session[:help_project]
+  @record.lang = session[:help_lang]
+end
+
+######################################################################
+# Will read data from help file
+######################################################################
+def before_edit
+  file_name = "#{session[:help_project]}/help/#{@record.form_name}.#{session[:help_lang]}"
+  data = YAML.load_file(file_name)
+  @record.index = data['index']
+  @record.form  = data['form']
+  flash[:warning] = "Use only in development!" unless Rails.env.development?
+end
+
+######################################################################
+# Will save data to help file
+######################################################################
+def before_save
+  rec = params[:record]
+  file_name = "#{session[:help_project]}/help/#{@record.form_name}.#{@record.lang}"
+  data = { 'index' => @record.index, 'form' => @record.form }
+  File.write(file_name, data.to_yaml)
+end
+
+######################################################################
+# Will return query to report data
+######################################################################
+def data_filter
+  ArTemp.where(key: temp_key).order(:order)
+end
+
+private
+
+######################################################################
+# Will return choices for select project input field on a form
+######################################################################
+def self.choices_for_project
+  r = Agile.paths(:forms).map do |path|
+    path = path.to_s
+    a = path.split('/')
+    project = a[a.size - 3]
+    project = if project == 'app'
+                a[a.size - 4] + ' : ' + a.last(2).join('/')
+              else
+                project + ' : ' + a.last
+              end
+    [project, path]
+  end
+  [[I18n.t('agile.ar_help.project'), nil]] + r.sort
+end
+
+######################################################################
+# Will return choices for selecting help file name, based on forms already
+# present in forms directory.
+######################################################################
+def self.choices_for_form_name(session)
+  Dir["#{session[:help_project]}/*.yml"].map { |file_name| File.basename(file_name,'.*') }.sort
+end
+
+######################################################################
+# Will return choices for language select on form. Choices can be either set by ar_locales document in ar_big_table
+# or can be acquired from Rails default locale
+######################################################################
+def self.choices_for_locales
+  choices = ArBigTable.choices_for('ar_locales')
+  return choices unless choices[0, 0] == I18n.t('agile.error')
+
+  choices = [I18n.default_locale] + I18n.fallbacks.map(&:first)
+  choices.map(&:to_s).uniq
+end
+
+######################################################################
+# Will return temp key for data saved in ar_temp file
+######################################################################
+def temp_key
+  "ar-help-#{session[:user_id]}"
+end
+
+end 

data/app/controls/ar_image_control.rb

@@ -0,0 +1,180 @@
+#--
+# 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.
+#++
+
+######################################################################
+# Controls for ArImage image management module
+######################################################################
+module ArImageControl
+
+######################################################################
+#
+######################################################################
+def search_filter
+  flash[:record] ||= {}
+
+  created_by = flash[:record][:created_by]
+  qry = created_by.present? ? ArImage.where(created_by: created_by) : ArImage.all
+
+  short_name = flash[:record][:short]
+  qry = qry.where("short LIKE ?", "#{ArImage.sanitize_sql_like(short_name)}%") if short_name.present?
+
+  keyword = flash[:record][:keyword]
+  qry = qry.where("keywords LIKE ?", "%#{ArImage.sanitize_sql_like(keyword)}%") if keyword.present?
+  qry.limit(30).order(created_at: 'desc')
+end
+
+######################################################################
+# Invoke images search. Just forward parameters and reload form. Filter parameters will
+# be taken into account on reload.
+######################################################################
+def images_search
+  flash[:record] = {}
+  flash[:record][:short] = params[:record][:short]
+  flash[:record][:created_by] = params[:record][:created_by]
+  flash[:record][:keyword]    = params[:record][:keyword]
+
+  url = url_for(controller: :agile, table: :ar_image, form_name: :ar_image_search, field_name: params[:field_name])
+  render json: { url: url }
+end
+
+######################################################################
+# Set some default values when new record
+######################################################################
+def new_record
+  default_sizes = agile_get_site.params.dig('ar_image', 'sizes').to_s.split(',')
+  @record.size_ls = default_sizes.shift
+  @record.size_ms = default_sizes.shift
+  @record.size_ss = default_sizes.shift
+end
+
+######################################################################
+# Save uploaded file if selected and extract properties data
+######################################################################
+def before_save
+  return if @record.size_o.present? || !params[:upload_file]
+
+  input_file_name = params[:upload_file].original_filename
+  type = File.extname(input_file_name).to_s.downcase.gsub('.', '').strip
+  unless %w[jpg jpeg png gif svg webp].include?(type)
+    flash[:error] = t 'agile.ar_image.wrong_type'
+    return false
+  end
+  name = File.basename(input_file_name)
+  path = File.dirname(params[:upload_file].tempfile)
+
+  @record.img_type = agile_get_site.params.dig('ar_image', 'img_type') || type
+  @record.short = File.basename(input_file_name, '.*') if @record.short.blank?
+  @record.name  = File.join(path, name)
+  FileUtils.mv(params[:upload_file].tempfile, @record.name, force: nil)
+end
+
+######################################################################
+# Prepare additional images
+######################################################################
+def after_save
+  %w[l m s o].each { |size| image_convert(size) }
+end
+
+private
+
+######################################################################
+#
+######################################################################
+def image_convert(which)
+  new_file_name = "#{@record.id}-#{which}.#{@record.img_type}"
+  new_file_name = Rails.root.join('public', images_location, new_file_name)
+  new_size = @record["size_#{which}"]
+  # remove file if not needed
+  if new_size.blank?
+    FileUtils.rm(new_file_name) if File.exist?(new_file_name)
+    return
+  end
+
+  original_file_name = Rails.root.join('public', images_location, "#{@record.id}-o.#{@record.img_type}")
+  @record.name = original_file_name unless @record.name.present? && File.exist?(@record.name)
+  unless File.exist?(@record.name)
+    flash[:warning] = t 'agile.ar_image.no_file'
+    return
+  end
+
+  image_magick_do(new_size, new_file_name)
+end
+
+######################################################################
+# Crop and resize image
+#
+# @new_size [String] new_size widthxheight+offsetx+offsety 300x200+1000+0
+# @file_name [String] Image file name
+######################################################################
+def image_magick_do(new_size, file_name)
+  image = MiniMagick::Image.open(@record.name)
+
+  a = new_size.split(/x|\+/).map(&:to_i)
+  a += [0, 0] if a.size < 4
+  image_offset(image, a[2, 2]) if a[2, 2] != [0, 0]
+
+  img_w, img_h = image.width, image.height
+  new_w, new_h = a[0, 2]
+  img_ratio = img_w.to_f / img_h
+  new_ratio = new_w.to_f / new_h
+  formula = if new_ratio > img_ratio
+              "#{img_w}x#{img_w/new_ratio}+0+0"
+            else
+              "#{img_h*new_ratio}x#{img_h}+0+0"
+            end
+  image.crop(formula)
+
+  image.resize("#{new_w}x#{new_h}")
+  image.write(file_name)
+  image_reduce(file_name)
+end
+
+######################################################################
+# Reduce image quality of image
+######################################################################
+def image_reduce(file_name)
+  if (quality = agile_get_site.params.dig('ar_image', 'quality').to_i) > 0
+    convert = MiniMagick::Tool::Convert.new
+    convert << file_name
+    convert.quality(quality)
+    convert << file_name
+    convert.call
+  end
+end
+
+######################################################################
+# Offset image if requested
+######################################################################
+def image_offset(image, offset)
+  img_w, img_h = image.width - offset[0], image.height - offset[1]
+  image.crop("#{img_w}x#{img_h}+#{offset[0]}+#{offset[1]}")
+end
+
+######################################################################
+# Returns location of images files relative to public directory
+######################################################################
+def images_location
+  agile_get_site.params.dig('ar_image', 'location') || 'images'
+end
+
+end

data/app/controls/ar_journal_control.rb

@@ -0,0 +1,47 @@
+#--
+# 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.
+#+
+
+######################################################################
+# Controls for displaying journal table.
+######################################################################
+module ArJournalControl
+
+######################################################################
+# Default filter for journal.
+# If filter value is delimited with ; then filter is called from info
+######################################################################
+def default_filter
+  order = agile_sort_options(ArJournal) || { id: :desc }
+  filter = session.dig(:filters, 'ar_journal', :filter)
+  if filter
+    if filter[:value].match(';')
+      table, id = filter[:value].split(';')
+      return ArJournal.where(tables: table, record_id: id.to_i)
+    else
+      return agile_filter_options(ArJournal).order(order)
+    end
+  end
+  ArJournal.all.order(order)
+end
+
+end

data/app/controls/ar_menu_item_control.rb

@@ -0,0 +1,55 @@
+#--
+# 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.
+#+
+
+######################################################################
+# Controls for ArMenuItem Form field.
+######################################################################
+module ArMenuItemControl
+
+######################################################################
+# Default filter for selecting menu items records
+######################################################################
+def default_filter
+  ArMenuItem.where(ar_menu_id: ids().first, parent_id: ids().last).order(:order)
+end
+
+######################################################################
+# Called when new empty record is created
+######################################################################
+def new_record
+  @record.ar_menu_id = ids().first
+  @record.parent_id  = ids().last
+end
+
+private
+
+######################################################################
+# Split ids parameter into array
+######################################################################
+def ids
+  ids = params[:ids].split(';')
+  ids << 0 if ids.size == 1
+  ids
+end
+
+end

data/app/controls/ar_page_control.rb

@@ -0,0 +1,64 @@
+#--
+# 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.
+#+
+
+######################################################################
+# AgileRails controls for ArPage model.
+######################################################################
+module ArPageControl
+
+######################################################################
+# Called when new empty record is created
+######################################################################
+def new_record
+  # Called from menu. Fill in values, that could be obtained from menu
+  if params[:from_menu]
+    menu_item_klass = (agile_get_site.menu_klass.to_s + 'Item').classify.constantize
+    menu = menu_item_klass.find(params[:id])
+    # Fill values for form
+    @record.subject = menu.caption
+    @record.ar_site_id = agile_get_site.id
+    @record.menu_id = params[:id]
+    # set update_menu on save parameter
+    params['p__update_menu'] = '1'
+  else
+    @record.design_id = params[:design_id] if params[:design_id]
+    return unless params[:page_id]
+    # inherit some values from currently active page
+    if page = ArPage.find(params[:page_id])
+      @record.design_id  = page.design_id
+      @record.menu       = page.menu
+      @record.ar_site_id = page.ar_site_id
+    end
+  end
+end
+
+######################################################################
+# Called just after record is saved to DB.
+######################################################################
+def after_save
+  if params.dig(:_record,:_update_menu).to_s == '1'
+    agile_get_site.menu_klass.menu_item_link_update(@record)
+  end
+end
+
+end 

data/app/controls/ar_poll_result_control.rb

@@ -0,0 +1,84 @@
+#--
+# 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.
+#+
+
+######################################################################
+# AgileRails controls for ArPollResult model.
+######################################################################
+module ArPollResultControl
+
+######################################################################
+# Default data_set filter
+######################################################################
+def default_filter
+  get_query
+end
+
+######################################################################
+# Filter action called. Update url to reflect filter conditions and reload form.
+######################################################################
+def set_filter
+  url = url_for(controller: :agile, action: :index, table: :ar_poll_result,
+                'record[poll_id]' => params[:record][:poll_id],
+                'record[start_date]' => params[:record][:start_date],
+                'record[end_date]' => params[:record][:end_date])
+  render json: { url: url }
+end
+
+######################################################################
+# Export data to CSV file.
+######################################################################
+def do_export
+  c, keys = '', []
+  get_query.to_a.each do |doc|
+    # ensure, that fields are always in same order
+    data = YAML.load(doc.data)
+    if c.blank?
+      data.each { |k, v| keys << k }
+      c += "#{I18n.t('helpers.label.ar_poll_result.created_at')}\t"
+      c += "#{keys.join("\t")}\n"
+    end
+    c += "#{doc.created_at.strftime(I18n.t('date.formats.default'))}\t"
+    keys.each { |k| c += "#{data[k]}\t" }
+    c += "\n"
+  end
+  File.write(Rails.root.join('public','export.csv'), c)
+  render json: { window: 'export.csv' } # will download file
+end
+
+private
+######################################################################
+# Creates query for Poll results
+######################################################################
+def get_query
+  return ArPollResult.all if params[:record].blank? # initial call
+
+  start_date = (AgileFormFields::DatePicker.get_data(params,'start_date') || Time.now).beginning_of_day
+  end_date   = (AgileFormFields::DatePicker.get_data(params,'end_date') || start_date).end_of_day
+  poll_id    = params.dig(:record, :poll_id)
+  qry = ArPollResult.where('created_at >= ? and created_at <= ?', start_date, end_date)
+  return qry if poll_id.nil?
+
+  qry.where(ar_poll_id: poll_id)
+end
+
+end

data/app/controls/ar_setup_control.rb

@@ -0,0 +1,62 @@
+#--
+# 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.
+#++
+
+################################################################################
+# Controls for ar_setup edit form.
+################################################################################
+module ArSetupControl
+
+################################################################################
+# Update edit form. Admin sees everything while user sees only setup fields.
+################################################################################
+def update_form
+  if params[:application_name]
+    if params[:application_name] == '*'
+      save_filter_value(nil, 'ar_setup', :filter)
+    else
+      filter = { field: 'name', operation: 'eq', value: params[:application_name], table: 'ar_setup', no_off: true }
+      save_filter_value(filter, 'ar_setup', :filter)
+    end
+  end
+
+  return unless params[:id]
+
+  record = if params[:id].to_i.to_s == params[:id]
+             ArSetup.find(params[:id])
+           else
+             ArSetup.find_by(name: params[:id])
+           end
+
+  unless agile_user_has_role?('admin')
+    @form['form'].delete('tabs')
+    @form['readonly'] = true unless record.editors.include?(session[:user_id])
+  end
+
+  form = YAML.load(record.form) #rescue nil
+  if form.present?
+    @form['form']['tabs'] ||= {}
+    @form['form']['tabs'].merge!(form)
+  end
+end
+
+end