agile_rails 0.0.0.1

data/app/models/ar_category.rb

@@ -0,0 +1,109 @@
+#--
+# 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.
+#+
+
+#####################################################################
+# == Schema information
+#
+# Table name: ar_category : Categories
+#
+#  id                   Integer           id
+#  created_at           Time                 created_at
+#  updated_at           Time                 Last update
+#  name                 String               Category name
+#  description          String               Additional description of category
+#  ctype                Integer              Category type. Could be used for grouping categories.
+#  parent               Integer       Parent category. Leave blank if this is top level category.
+#  active               Boolean     Category is active.
+#  order                Integer              Additional order, which can be used for sorting.
+#  created_by           Integer       created_by
+#  updated_by           Integer       updated_by
+#   
+# Categories are used on ArPage documents for grouping documents. Categorization
+# is most useful for grouping news, blog entries ...
+#####################################################################
+class ArCategory < ApplicationRecord
+
+validates :name, presence: true
+
+before_destroy :can_destroy?
+
+private
+
+#########################################################################
+# Can't delete if category document has children documents
+#########################################################################
+def can_destroy?
+  if ArCategory.where(parent: id).count > 0
+    errors.add(:base, I18n.t('agile.category_has_subs'))
+    throw :abort
+  end
+end
+
+#########################################################################
+# Returns all values for use as parent select field.
+#########################################################################
+def self.values_for_parent(site_id = nil) #:nodoc:
+  qry = where(active: true)
+  qry = qry.and(ar_site_id: site_id.id) if site_id
+  parents = {} # cache parent names to minimize database usage
+  qry.inject([]) do |r, v|
+    if parents[v.parent].nil?
+      name   = ''
+      parent = v.parent
+      until parent.nil?
+        doc    = find(parent)
+        name   = "#{doc.name} / #{name}"
+        parent = doc.parent
+      end
+      parents[v.parent] = name
+    end
+    name = v.parent ? parents[v.parent] + v.name : v.name
+    r << [name, v.id]
+  end.sort { |a, b| a.first <=> b.first }
+end
+
+#########################################################################
+# Returns values for category type. Values should be defined in BigTable 
+# on the site level all overall.
+#########################################################################
+# @param [Integer] site_id : Return only values for specified site
+#########################################################################
+def self.choices_for_ctype(site_id = nil)
+  site_id = site_id.id if site_id&.class != Integer
+  ArBigTable.choices_for('ar_category_type', site_id)
+end
+
+#########################################################################
+# Returns choices for all categories, prepared for tree_select input field
+#########################################################################
+def self.choices_for_categories(site_id = nil)
+  qry = where(active: true)
+  ar = [nil]
+  if site_id
+    ar << (site_id.instance_of?(Integer) ? site_id : site_id.id)
+  end
+  qry = qry.in(ar_site_id: ar)
+  qry.map { |category| [category.name, category.id, category.parent, category.order] }
+end
+
+end

data/app/models/ar_design.rb

@@ -0,0 +1,116 @@
+#--
+# 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.
+#+
+
+########################################################################
+# == Schema information
+#
+# Table name: ar_design : Designs
+#
+#  id                  Integer     id
+#  created_at           Time        created_at
+#  updated_at           Time        updated_at
+#  description          String      Short description of design
+#  body                 String      Body of design which will be rendered like any Rails view
+#  params               String      Parameters used by design
+#  css                  String      CSS for design
+#  rails_view           String      Rails view (file) name which will be used to render design
+#  code                 String      Ruby code evaluated when processing page
+#  author               String      Creater if design
+#  active               Boolean     Is the design active
+#  created_by           Integer     created_by
+#  updated_by           Integer     Last updated by
+#  site_id              Integer     Select site name if this design belongs to singe site
+#
+# Designs are essential parts of AgileRails. Every ArPage document must have its design document defined.
+# If ArPage documents are anchors for url addresses, ArDesign documents define how
+# will page data be rendered in browser. 
+# 
+# ArDesign documents define what would normally be written into Rails view file. The code
+# is saved in the body field of ArDesign document. If you prefere Rails way, enter view
+# file name into rails_view field and put your code into file into views directory 
+# (ex. designs/home_page for ../views/designs/home_page.html.erb file). 
+# 
+# If you choose to save code to Rails view file you must add one top and bottom line to every source file.
+# Top line will provide CMS edit menu, bottom line will provide additional CSS and javascript code
+# scooped when renderers are called.
+# 
+# Example (as written in body of ar_design):
+#    <div id="site">
+#      <div id="site-top-bg">
+#        <div id="site-top"><div id="logo"><%= agile_render(:ar_piece, name: 'site-top') %></div>
+#          <div id="login"><%= agile_render(:common, method: 'login') %></div>
+#       </div>
+#        <%= agile_render(:ar_menu, name: 'test-menu') %>
+#      </div>
+#
+#      <div id="page"><%= agile_render(:ar_page) %></div>
+#    </div>
+#    <div id="site-bottom"><%= agile_render(:ar_piece, name: 'site-bottom') %></div>
+#    
+# Example (as written in Rails view file):
+# 
+#    <!-- Pay attention on lines added at the top and bottom of file -->
+#    <%= render partial: 'ra/edit_stuff' if session[:edit_mode] > 0 %>
+#    
+#    <div id="site">
+#      <div id="site-top-bg">
+#        <div id="site-top"><div id="logo"><%= agile_render(:ar_piece, name: 'site-top') %></div>
+#          <div id="login"><%= agile_render(:common, method: 'login') %></div>
+#       </div>
+#        <%= agile_render(:ar_menu, name: 'test-menu') %>
+#      </div>
+#
+#      <div id="page"><%= agile_render(:ar_page) %></div>
+#    </div>
+#    <div id="site-bottom"><%= agile_render(:ar_piece, name: 'site-bottom') %></div>
+#    
+#    <style type="text/css"><%= @css.html_safe %></style><%= javascript_tag @js %>
+########################################################################
+class ArDesign < ApplicationRecord
+
+validates_length_of :description, minimum: 5
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_design)
+end
+  
+########################################################################
+# Return choices for select for design_id. 
+# 
+# If site is passed as parameter, only designs which belong to site or do not
+# have site assigned will be selected. Too much designs to select often confuses
+# end user.
+########################################################################
+def self.choices_for_designs(site = nil)
+  site.nil? ? where(active: true) : where(site_id: [nil, site.id], active: true)
+    .sort { |w1, w2| w1.description.casecmp(w2.description) }
+    .map  { |design| [design.description, design.id] }
+end
+  
+end

data/app/models/ar_filter.rb

@@ -0,0 +1,200 @@
+#--
+# 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.
+#+
+
+##########################################################################
+# Model and collection for filtering and sorting data.
+# For now it is just an idea. Not yet implemented although data filtering implementation
+# code is here, but should probably be moved into some helper.
+##########################################################################
+class ArFilter < ApplicationRecord
+
+  #  field :ar_user_id,  type: Integer
+  #  field :table,       type: String
+  #  field :description, type: String
+  #  field 'filter',      type: String,       default: ''
+  #  field :public,      type: Boolean
+  #  field :active,      type: Boolean,      default: true
+
+validates :description, presence: true
+before_save :do_before_save
+
+######################################################################
+# Implementation of before_save callback.
+######################################################################
+def do_before_save
+  self.ar_user_id = nil if self.public
+end
+
+######################################################################
+# Will return model with filter query set
+######################################################################
+def self.get_filter(table_filter)
+  return if table_filter.nil?
+
+  filter = table_filter[:filter]
+  return if filter.nil? || filter[:table].nil?
+
+  model = filter[:table].classify.constantize
+  field = filter[:field]
+  # evaluate
+  if filter[:operation] == 'eval'
+    return eval(filter[:value]) if filter.dig(:value).to_s != '#NIL' # evaluated as string
+    return model.send(field) if model.respond_to?(field) # defined as scope or method in the model
+  end
+  # empty
+  return model.where(field => [nil, '']) if filter[:operation] == 'empty'
+
+  value = case filter[:value].to_s
+          when '#NIL' then return   # #NIL. Filter is not active
+          when 'true' then true     # boolean true
+          when 'false' then false   # boolean false
+          else                      # is it a date or time. This can be improved
+            if filter[:value].to_s.split(/[\.|\/|\-]/).size < 3
+              filter[:value]
+            else
+              (Date.parse(filter[:value]) rescue nil) || filter[:value]
+            end
+          end
+
+  case filter[:operation]
+  when 'like'
+    #TODO get_like_clause(field, value)
+    value = sanitize_sql(value)
+    model.where("lower(#{field}) like ?", "%#{value.downcase}%")
+  when 'gt'
+    model.where("#{field} > ?", value)
+  when 'lt'
+    model.where("#{field} < ?", value)
+  when 'eq'
+    model.where("#{field} = ?", value)
+  end
+end
+
+############################################################################
+# Return filter input field for entering filter data on index action
+############################################################################
+def self.get_filter_input_field(env)
+  form   = env.form
+  filter = env.session.dig(:filters, form['table'], :filter)
+  return '' if filter.nil? || filter[:operation] == 'eval'
+
+  field = AgileHelper.get_field_form_definition(filter[:field], form)
+  return '' if field.nil? && filter[:input].nil?
+
+  saved_readonly = form['readonly']
+  form['readonly'] = false # must be
+  field ||= {}
+  # If field has choices available in labels, use them. This is most likely select input field.
+  if field['name']
+    choices = env.t('helpers.label.' + form['table'] + '.choices_for_' + field['name'] )
+    unless choices.match(/translation missing/i) || choices.match('helpers.label')
+      field['choices'] = choices
+    end
+  end
+  # field redefined with input keyword. Name must start with _
+  field['name']  = '_filter_field'
+  field['type']  = filter[:input] if filter[:input].to_s.size > 5
+  field['type'] ||= 'text_field'
+  field['readonly'] = false   # must be
+  # let text fields size be no more then 20
+  field['size']  = 20 if field['type'].match('text') && field['size'].to_i > 20
+  field['html'] ||= {}
+  # Start with last entered value
+  field['html']['value']    = filter[:value] unless filter[:value] == '#NIL'
+  field['html']['selected'] = field['html']['value'] # for select field
+  # url for filter ON action
+  field['html']['data-url'] = env.url_for(controller: :agile, action: :run, control: 'agile.filter_on',
+                                          t: AgileHelper.table_param(env.params), f: AgileHelper.form_param(env.params))
+  url = field['html']['data-url']
+  # remove if present
+  field['with_new'] = nil if field['with_new']
+  # create input field
+  html = ''
+  klass_string = field['type'].camelize
+  klass = AgileFormFields::const_get(klass_string) rescue nil
+  if klass
+    if (agile_field = klass.new(env, nil, field).render rescue nil)
+      js = agile_field.js.blank? ? '' : env.javascript_tag(agile_field.js)
+      html = %(<li class="no-background">
+<span class="filter_field" data-url="#{url}">#{agile_field.html}
+#{env.mi_icon('search', class: 'record_filter_field_icon')}
+#{js}</span></li>)
+    else
+      # Error. Forget filter
+      env.session[:filters][form['table']][:filter] = nil
+    end
+  end
+  form['readonly'] = saved_readonly
+  html.html_safe
+end
+
+######################################################################
+# Create popup menu for filter options.
+######################################################################
+def self.filter_menu(env)
+  html = '<div><ul class="menu-filter">'
+  table = env.form['table']
+  documents = self.where(table: table, active: true).to_a
+  documents.each do |document|
+    description = document.description.match('.') ? I18n.t(document.description) : document.description
+    html += "<li data-filter=\"#{document.id}\">#{description}</li>"
+  end
+
+  # add filters defined in model
+  model   = table.classify.constantize
+  filters = model.agile_filters if model.respond_to?(:agile_filters)
+  if filters
+    # only single defined. Convert to array.
+    filters = [filters] if filters.class == Hash
+    filters.each do |filter|
+      url = env.url_for(controller: :agile, action: :run, t: table, f:  AgileHelper.form_param(env.params),
+                        control: 'agile.filter_on',
+                        filter_field: filter[:field],
+                        filter_oper:  filter[:operation],
+                        filter_value: filter[:value])
+      html += %(<li class="ar-link-ajax in-menu" data-url="#{url}">#{filter[:title]}</li>)
+    end
+  end
+  # divide standard and custom filter options
+  html += '<hr>' if html.size > 30 #
+  html += %(<li class="ar-link in-menu" id="open_ar_filter">#{I18n.t('agile.filter_set')}</li></ul></div>)
+  html.html_safe
+end
+
+######################################################################
+# Creates title for turn filter off, which consists of displaying curently
+# active filter and text to turn it off.
+######################################################################
+def self.title_for_filter_off(filter_data)
+  filter = filter_data&.dig(:filter)
+  return '' if filter.nil?
+  return I18n.t('agile.filter_off') if filter[:operation] == 'eval'
+
+  operations = I18n.t('agile.choices_for_filter_operators').split(',').map { _1.split(':') }
+  operation  = operations.find { _1.last == filter[:operation] }.first
+
+  '[ ' + I18n.t("helpers.label.#{filter[:table]}.#{filter[:field]}") +
+    " ] #{operation} [ #{filter[:value]} ] : #{I18n.t('agile.filter_off')}"
+end
+
+end

data/app/models/ar_folder_permission.rb

@@ -0,0 +1,50 @@
+#--
+# 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.
+#+
+
+#########################################################################
+# == Schema information
+#
+# Table name: ar_folder_permissions : Folder permissions
+#
+#  id                 Integer         id
+#  created_at           Time        created_at
+#  updated_at           Time        updated_at
+#  name                 String      Folder name
+#  inherited            Boolean     Inherit permissions from parent
+#  active               Boolean     Permission is valid
+#  ar_policy_rules      Embedded:   ArPolicyRule Policy rules
+# 
+# Similar to ArPermission ArDirPermission model defines documents
+# for accessing file system. Permissions defined on a parent folder automatically
+# apply to all folders below unless folder on lower level has its own permission document.
+# 
+# At least one document must exist for file manager to work.
+#########################################################################
+class ArFolderPermission < ApplicationRecord
+
+has_many :ar_folder_rules
+
+validates :folder_name, presence: true
+validates :folder_name, uniqueness: true
+
+end

data/app/models/ar_folder_rule.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.
+#+
+
+#########################################################################
+# == Schema information
+#
+# Table name: ar_Folder_rules : Access policy rules for file system folders
+#
+#  id                   Integer              id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  ar_role_id           Object               User role access defined by this rule
+#  permission           Integer              Access permission
+#
+# ArFolderRule records define rules for accessing folders in the file system.
+#########################################################################
+class ArFolderRule < ApplicationRecord
+
+belongs_to :ar_folder_permission
+
+validate do
+  if new_record? && ArFolderRule.find_by(ar_folder_permission: ar_folder_permission, ar_role_id: ar_role_id).present?
+    errors.add('ar_role_id', I18n.t('agile.already_defined'))
+  end
+end
+
+end

data/app/models/ar_gallery.rb

@@ -0,0 +1,53 @@
+#--
+# 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.
+#+
+
+#########################################################################
+# ArGallery model holds data for picture galleries for various types of documents.
+# Picture Gallery can be added to any document, provided that it has two parameters:
+# doc_id and doc_type.
+#########################################################################
+# == Schema information
+#
+# Table name: ar_gallery : Pictures gallery
+#
+#  id                   Integer       id
+#  doc_id               Integer       Parent document id where this gallery lies
+#  doc_type             String        Parent document table name
+#  title                String        Title name for picture
+#  description          String        Short description
+#  picture              String        Picture filename
+#  thumbnail            String        Picture thumbnail
+#  order                Integer       Order of picture in a gallery
+#
+#  active               Boolean       Picture is active
+#  created_by           Integer       created_by
+#  updated_by           Integer       updated_by
+#  created_at           Time          created_at
+#  updated_at           Time          updated_at
+# 
+#########################################################################
+class ArGallery < ApplicationRecord
+  validates :picture,  presence: true
+  validates :doc_id,   presence: true
+  validates :doc_type, presence: true
+end