agile_rails 0.0.0.1

data/app/controls/belongs_to_control.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.
+#+
+
+######################################################################
+# Controls for belongs_to AgileRails Form field.
+######################################################################
+module BelongsToControl
+
+######################################################################
+# Default filter for selecting related records
+######################################################################
+def default_filter
+  model = @tables.last[0]
+  return YAML.load(@record[params[:belongs_to]]) if model == 'ar_memory'
+
+  if model.column_names.include? 'parent_type'
+    model.where(parent_type: @tables.first[0].to_s, parent_id: params[:ids])
+  else
+    parent_table_index = @tables.size - 2
+    belongs_to_field = "#{(params[:belongs_to] || @tables[parent_table_index][1])}_id"
+    ids = params[:ids].split(';')
+    model.where(belongs_to_field => ids[parent_table_index])
+  end
+end
+
+######################################################################
+# Before save, set required fields
+######################################################################
+def before_save
+  if @record.respond_to?(:parent_type)
+    @record.parent_type = @tables.first[0].to_s
+    @record.parent_id   = params[:ids]
+  else
+    parent_table_index = @tables.size - 2
+    belongs_to_field = "#{params[:belongs_to] || @tables[parent_table_index][1]}_id="
+    ids = params[:ids].split(';')
+    @record.send(belongs_to_field, ids[parent_table_index])
+  end
+end
+
+end

data/app/controls/browse_models_control.rb

@@ -0,0 +1,98 @@
+#--
+# 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 BrowseModelsControl
+
+#########################################################################
+# Return array of all models found in application.
+#########################################################################
+def all_collections
+  collections = []
+  Agile.paths(:forms).each do |path|
+    models_dir = File.expand_path("../models", path)
+    Dir["#{models_dir}/*.rb"].each do |model_file|
+      model_file =~ /(.*)\/(.*).rb/
+      # check if model exists
+      collection = $2.camelize.constantize.new rescue nil
+      collections << collection.class.to_s.underscore if collection&.respond_to?(:_id)
+    end
+  end
+  collections.sort
+end
+
+######################################################################
+# List all collections
+######################################################################
+def collections
+  @records = []
+  all_collections.each do |collection|
+    next if params[:filter] && !collection.match(/#{params[:filter]}/i)
+
+    @records << ArMemory.new({'id' =>  collection, 'description' => t("helpers.label.#{collection}.table_title") })
+  end
+  @records
+end
+
+######################################################################
+# List field definition for single model
+######################################################################
+def all_fields
+  @records = []
+  model = params[:id].classify.constantize
+  document = model.new
+  document.attribute_names.each do |attribute_name|
+    options = model.fields[attribute_name].options
+    description = I18n.t("helpers.help.#{params[:id]}.#{attribute_name}")
+    description = I18n.t("helpers.label.#{params[:id]}.#{attribute_name}") if description.match('missing:')
+    description = attribute_name if description.match('missing:')
+
+    @records << ArMemory.new({id: attribute_name,
+                 'collection' =>  params[:id],
+                 'field' => attribute_name, 
+                 'type' => options[:type],
+                 'description' => description, 
+                 '_default' => options[:default]
+                })
+  end
+  # embedded documents
+  document.embedded_relations.each do |a_embedded|
+    embedded = a_embedded.last
+    description = I18n.t("helpers.help.#{params[:id]}.#{embedded.key}")
+    description = I18n.t("helpers.label.#{params[:id]}.#{embedded.key}") if description.match('missing:')
+    description = embedded.key if description.match('missing:')
+
+    @records << ArMemory.new({ id: embedded.key,
+                 'collection' =>  params[:id],
+                 'field' => embedded.key, 
+                 'type' => 'Embedded:' + embedded.class_name,
+                 'description' => description
+                })
+  end
+
+  @records
+end
+
+end 

data/app/controls/settings_form_control.rb

@@ -0,0 +1,137 @@
+#--
+# 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 editing settings saved in a document.
+#
+# Parameters to settings call:
+# :location - model_name where settings document is located. Typically ar_page or ar_site.
+# :field_name - name of the field where settings are saved
+# :element - element name as defined on design 
+# :id - document id
+######################################################################
+module SettingsFormControl
+
+######################################################################
+# Check if settings control document exists and return document and 
+# settings values as yaml string.
+# 
+# Return:
+#   [record, data] : record, yaml as String
+######################################################################
+def get_settings
+  # On save. Set required variables
+  if params[:record]
+    params[:location]   = params[:record][:ar_location]
+    params[:field_name] = params[:record][:ar_field_name]
+    params[:element]    = params[:record][:ar_element]
+    params[:id]         = params[:record][:ar_record_id]
+  end
+
+  # Check if table exists
+  begin
+    model = params[:location].classify.constantize
+  rescue 
+    flash[:error] = "Invalid or undefined model name! #{params[:location]}"
+    return false
+  end
+
+  # Check if field_name exists
+  begin
+    document = model.find(params[:id])
+    params[:field_name] ||= (params[:location] == 'ar_site' ? 'settings' : 'params')
+    # field not defined
+    raise unless document.respond_to?(params[:field_name])
+
+    yaml = document[params[:field_name]] || ''
+  rescue 
+    flash[:error] = 'Invalid or undefined field name!'
+    return false
+  end
+
+  # Check data
+  begin
+    data = YAML.load(yaml) || {}
+  rescue 
+    flash[:error] = 'Invalid configuration data found!'
+    return false
+  end
+  [document, data]
+end
+
+######################################################################
+# Called before edit.
+#
+# Load fields on form with values from settings document.
+######################################################################
+def new_record
+  document, data = get_settings
+  return false if document.instance_of?(FalseClass) && data.nil?
+
+  # fill values with settings values
+  if data['settings'] && data['settings'][ params[:element] ]
+    data['settings'][ params[:element] ].each { |key, value| @record.send("#{key}=", value) }
+  end
+  # add some fields required at post as hidden fields to form
+  form = @form['form']['tabs'] ? @form['form']['tabs'].to_a.last : @form['form']['fields']
+  form[9999] = { 'type' => 'hidden_field', 'name' => 'ar_location', 'html' => { 'value' => params[:location] } }
+  form[9998] = { 'type' => 'hidden_field', 'name' => 'ar_field_name' }
+  @record[:ar_field_name] = params[:field_name]
+  form[9997] = { 'type' => 'hidden_field', 'name' => 'ar_element' }
+  @record.ar_element = params[:element]
+  form[9996] = { 'type' => 'hidden_field', 'name' => 'ar_record_id', 'html' => { 'value' => params[:id] } }
+end
+
+######################################################################
+# Called before save. 
+#
+# Convert data from fields on form to yaml and save it to document settings field.
+######################################################################
+def before_save
+  document, data = get_settings
+  return false if document.instance_of?(FalseClass) && data.nil?
+
+  fields_on_form.each do |v|
+    session[:form_processing] = v['name'] # for debugging
+    next if v['type'].nil? || v['readonly']
+
+    # return value from form field definition
+    value = AgileFormFields.const_get(v['type'].camelize).get_data(params, v['name'])
+    value = value.map(&:to_s) if value.instance_of?(Array)
+    # set to nil if blank
+    value = nil if value.blank?
+    data['settings'] ||= {}
+    data['settings'][params[:element]] ||= {}
+    data['settings'][params[:element]][v['name']] = value
+  end
+  # remove nil elements
+  data['settings'][ params[:element] ].compact!
+  # save data to document field
+  document.send("#{params[:field_name]}=", data.to_yaml)
+  document.save
+  # to re-set form again
+  new_record
+  false # must be
+end
+
+end

data/app/forms/agile_help.yml

@@ -0,0 +1,112 @@
+## Form for creating help files
+---
+table: ar_temp
+title:  agile.ar_help.title
+control: ar_help
+
+index:
+  actions:
+
+    10:
+      type: field
+      name: select_project
+      field_type: select
+      caption: agile.ar_help.project
+      choices: eval ArHelpControl.choices_for_project
+      default:
+        eval: 'session[:help_project]'
+      position: left
+
+    20:
+      type: field
+      name: lang_1
+      caption:  agile.ar_help.lang
+      field_type: text_with_select
+      size: 5
+      choices: eval ArBigTable.choices_for('application_locales')
+      default:
+        eval: 'session[:help_lang]'
+      html:
+        placeholder:  agile.ar_help.lang
+      position: left
+
+    50:
+      type: ajax
+      caption:  agile.ar_help.project_refresh
+      title:  agile.ar_help.project_refresh_title
+      icon: refresh
+      action: run
+      method: post
+      control: ar_help.project_refresh
+
+    60: new
+
+  data_set:
+    filter: data_filter
+    actions:
+      1: edit
+    columns:
+      10:
+        name: form_name
+        caption:  agile.ar_help.form_name
+        width: 20%
+      20:
+        name: lang
+        caption:  agile.ar_help.lang
+        width: 10%
+      30:
+        name: updated_at
+        caption:  agile.ar_help.updated_at
+        width: 10%
+        format: T
+
+form:
+  actions:
+    1: back
+    2: save
+
+  title:
+    edit: agile.ar_help.edit_title
+    show: agile.ar_help.show_title
+
+  tabs:
+    1basic:
+      caption:  agile.ar_help.1basic
+      10:
+        name: project
+        type: readonly
+        size: 20
+      20:
+        name: form_name
+        caption:  agile.ar_help.form_name
+        type: text_with_select
+        choices: eval ArHelpControl.choices_for_form_name(@env.session)
+        size: 20
+        html:
+          minlength: 4
+      30:
+        name: lang
+        caption:  agile.ar_help.lang
+        type: text_field
+        size: 2
+        html:
+          minlength: 2
+          maxlength: 2
+
+    2index:
+      caption:  agile.ar_help.2index
+      10:
+        name: index
+        caption: false
+        line: top
+        type: html_field
+        options: "height: 600"
+
+    3form:
+      caption:  agile.ar_help.3form
+      10:
+        name: form
+        caption: false
+        line: top
+        type: html_field
+        options: "height: 600"

data/app/forms/agile_menu.yml

@@ -0,0 +1,140 @@
+#--
+# 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.
+#++
+
+menu:
+  10_system_menu:
+    caption: agile.cms_main
+    icon: support
+    
+    items:
+      10: 
+        caption: helpers.label.ar_site.table_title
+        controller: agile
+        icon: public
+        table: ar_site
+      20: 
+        caption: helpers.label.ar_design.table_title
+        controller: agile
+        icon: web
+        table: ar_design
+      30:
+        caption: helpers.label.ar_page.table_title
+        controller: agile
+        icon: description-o
+        table: ar_page
+      40:
+        caption: helpers.label.ar_image.table_title
+        controller: agile
+        icon: image-o
+        table: ar_image
+      60: 
+        caption: helpers.label.ar_link.table_title
+        controller: agile
+        icon: link
+        table: ar_link
+      70: 
+        caption: helpers.label.ar_menu.table_title
+        controller: agile
+        icon: menu
+        table: ar_menu
+      90:
+        caption: helpers.label.ar_category.table_title
+        controller: agile
+        icon: list
+        table: ar_category
+
+      100:
+        caption: helpers.label.ar_poll.table_title
+        controller: agile
+        icon: poll-o
+        table: ar_poll
+      110: 
+        caption: helpers.label.ar_poll_result.table_title
+        controller: agile
+        icon: leaderboard
+        table: ar_poll_result
+
+  11_system_menu:
+    caption: agile.cms_advanced
+    icon: star
+    items:
+      10: 
+        caption: helpers.label.ar_user.table_title
+        controller: agile
+        icon: account_circle-o
+        table: ar_user
+      20: 
+        caption: helpers.label.ar_role.table_title
+        controller: agile
+        icon: manage_accounts
+        table: ar_role
+      30: 
+        caption: helpers.label.ar_permission.table_title
+        controller: agile
+        icon: security
+        table: ar_permission
+      40: 
+        caption: helpers.label.ar_folder_permission.table_title
+        controller: agile
+        icon: shield-o
+        table: ar_folder_permission
+      60: 
+        caption: helpers.label.ar_big_table.table_title
+        controller: agile
+        icon: topic-o
+        table: ar_big_table
+      70: 
+        caption: helpers.label.ar_key_value_store.table_title
+        controller: agile
+        icon: view_list
+        table: ar_key_value_store
+      90:
+        caption: helpers.label.ar_removed_url.table_title
+        controller: agile
+        icon: link_off
+        table: ar_removed_url
+      400:
+        caption: agile.ar_help.title
+        controller: agile
+        icon: help-o
+        table: ar_temp
+        form_name: agile_help
+      500: 
+        caption: helpers.label.ar_journal.table_title
+        controller: agile
+        icon: history
+        table: ar_journal
+
+      510:
+        caption: helpers.label.ar_setup.table_title
+        controller: agile
+        icon: cog-o
+        table: ar_setup
+        form_name: ar_setup
+
+#      600:
+#        caption: agile.browse_collections
+#        controller: agile
+#        icon: list_alt
+#        table: ar_memory
+#        form_name: ar_browse_models

data/app/forms/agile_report_defaults.yml

@@ -0,0 +1,39 @@
+
+form:
+  actions:
+    10:
+      type: ajax
+      caption: agile.refresh
+      icon: cog
+      table: ar_temp
+      form_name: &report
+      action: run
+      control: &report.collect_data
+      method: post
+
+    20:
+      type: ajax
+      caption: agile.print
+      icon: print
+      table: ar_temp
+      form_name: &report
+      action: run
+      control: &report.print
+      method: post
+
+    30:
+      type: ajax
+      caption: agile.export
+      icon: file-excel-o
+      table: ar_temp
+      form_name: &report
+      action: run
+      control: &report.export
+
+  fields:
+    1000:
+      name: ar_temp
+      type: belongs_to
+      caption: false
+      table: ar_temp
+      form_name: &report