agile_rails 0.0.0.1

data/db/migrate/20240120160022_ar_poll_item.rb

@@ -0,0 +1,23 @@
+class ArPollItem < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_poll_items do |t|
+      t.string  :name, default: ''
+      t.string  :text, default: ''
+      t.string  :field_type, default: ''
+      t.string  :size, default: '10'
+      t.boolean :mandatory, default: false
+      t.string  :separator, default: ''
+      t.string  :options, default: ''
+      t.integer :order, default: 0
+
+      t.integer :ar_poll_id
+      t.boolean :active, default: true
+
+      t.integer :created_by
+      t.integer :updated_by
+      t.timestamps
+
+      t.index :ar_poll_id
+    end
+  end
+end

data/db/migrate/20240120160023_ar_poll_result.rb

@@ -0,0 +1,14 @@
+class ArPollResult < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_poll_results do |t|
+      t.integer :ar_poll_id
+      t.string  :data
+      t.boolean :confirmed
+
+      t.timestamps
+
+      t.index :ar_poll_id
+    end
+
+  end
+end

data/db/migrate/20240120160024_ar_removed_url.rb

@@ -0,0 +1,16 @@
+class ArRemovedUrl < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_removed_urls do |t|
+      t.string :url
+      t.string :description
+      t.integer :created_by
+      t.integer :updated_by
+      t.integer :ar_site_id
+
+      t.timestamps
+
+      t.index :ar_site_id
+    end
+
+  end
+end

data/db/migrate/20240120160025_ar_role.rb

@@ -0,0 +1,17 @@
+class ArRole < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_roles do |t|
+      t.string  :name
+      t.string  :system_name
+      t.boolean :active, default: true
+
+      t.timestamps
+      t.integer :created_by
+      t.integer :updated_by
+
+      t.index :name, :unique=>true
+      t.index :system_name
+    end
+
+  end
+end

data/db/migrate/20240120160026_ar_site.rb

@@ -0,0 +1,37 @@
+class ArSite < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_sites do |t|
+      t.string :name
+      t.string :description
+      t.string :homepage_link
+      t.string :error_link
+      t.string :header
+      t.string :css
+      t.string :route_name
+      t.string :page_title
+      t.string :page_class, default: 'ArPage'
+      t.string :site_layout, default: 'content'
+      t.string :menu_class, default: 'ArMenu'
+      t.string :request_processor
+      t.string :files_directory
+      t.string :logo
+      t.string :favicon
+      t.string :menu_name
+      t.integer :menu_id
+      t.string :settings
+      t.string :alias_for
+      t.string :rails_view
+      t.string :design
+      t.integer :inherit_policy
+
+      t.boolean :active, default: true
+      t.timestamps
+      t.integer :created_by
+      t.integer :updated_by
+
+      t.index :name, unique: true
+      t.index :alias_for
+    end
+
+  end
+end

data/db/migrate/20240120160027_ar_temp.rb

@@ -0,0 +1,11 @@
+class ArTemp < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_temps do |t|
+      t.string  :key
+      t.boolean :active
+      t.string  :data
+      t.string  :order
+    end
+
+  end
+end

data/db/migrate/20240120160028_ar_user.rb

@@ -0,0 +1,42 @@
+class ArUser < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_users do |t|
+      t.string :username, default: ''
+      t.string :title, default: ''
+      t.string :first_name, default: ''
+      t.string :middle_name, default: ''
+      t.string :last_name, default: ''
+      t.string :name
+      t.string :company, default: ''
+      t.string :address
+      t.string :post
+      t.string :country
+      t.string :phone
+      t.string :email
+      t.string :www
+      t.string :picture
+      t.date   :birthdate
+      t.string :about
+      t.datetime :last_visit
+      t.boolean :active, default: true
+      t.date    :valid_from
+      t.date    :valid_to
+      t.boolean :group,  default: false
+      t.string  :signature
+      t.string  :interests
+      t.string  :job_occup
+      t.string  :description
+      t.date    :reg_date
+      t.string :password_digest
+
+      t.timestamps
+      t.integer :created_by
+      t.integer :updated_by
+
+      t.index :username, unique: true
+      t.index :email, unique: true
+      t.index :group
+    end
+
+  end
+end

data/db/migrate/20240120160029_ar_user_group.rb

@@ -0,0 +1,12 @@
+class ArUserGroup < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_user_groups do |t|
+      t.integer :ar_user_id
+      t.integer :group_id
+
+      t.index :ar_user_id
+      t.index :group_id
+    end
+
+  end
+end

data/db/migrate/20240120160030_ar_user_role.rb

@@ -0,0 +1,18 @@
+class ArUserRole < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_user_roles do |t|
+      t.integer :ar_role_id
+      t.integer :ar_user_id
+      t.date    :valid_from
+      t.date    :valid_to
+      t.boolean :active, default: true
+
+      t.integer :created_by
+      t.integer :updated_by
+      t.timestamps
+
+      t.index [:ar_user_id, :ar_role_id], name: 'index_ar_user_roles_1'
+      t.index [:ar_role_id, :ar_user_id], name: 'index_ar_user_roles_2'
+    end
+  end
+end

data/db/migrate/20240120160031_ar_visit.rb

@@ -0,0 +1,15 @@
+class ArVisit < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_visits do |t|
+      t.integer :page_id
+      t.integer :user_id
+      t.integer :site_id
+      t.string :session_id
+      t.string :ip
+      t.datetime :time
+
+      t.index :time
+    end
+
+  end
+end

data/db/migrate/20240703016001_ar_setup.rb

@@ -0,0 +1,16 @@
+class ArSetup < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_setups do |t|
+      t.string  :name
+      t.text    :data
+      t.text    :form
+      t.string  :edit_ids
+
+      t.integer :created_by
+      t.integer :updated_by
+      t.timestamps
+
+      t.index :name
+    end
+  end
+end

data/db/migrate/20240703016002_ar_folder_permission.rb

@@ -0,0 +1,15 @@
+class ArFolderPermission < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_folder_permissions do |t|
+      t.string  :folder_name
+      t.boolean :inherited, default: true
+      t.boolean :active,    default: true
+
+      t.integer :created_by
+      t.integer :updated_by
+      t.timestamps
+
+      t.index :folder_name, unique: true
+    end
+  end
+end

data/db/migrate/20240703016003_ar_folder_rule.rb

@@ -0,0 +1,14 @@
+class ArFolderRule < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_folder_rules do |t|
+      t.references :ar_folder_permission
+      t.belongs_to :ar_role
+      t.integer    :permission, default: 0
+      t.boolean    :active, default: true
+
+      t.integer :created_by
+      t.integer :updated_by
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250115000001_ar_image.rb

@@ -0,0 +1,25 @@
+class ArImage < ActiveRecord::Migration[7.0]
+  def change
+    create_table :ar_images do |t|
+      t.string  :name
+      t.string  :img_type
+      t.string  :text
+      t.string  :short
+      t.boolean :keep_original, default: false
+      t.string  :size_o
+      t.string  :size_l
+      t.string  :size_m
+      t.string  :size_s
+      t.integer :page_id
+      t.string  :keywords
+
+      t.integer :ar_site_id
+      t.integer :created_by
+      t.timestamps
+
+      t.index :ar_site_id
+      t.index :created_by
+    end
+
+  end
+end

data/lib/agile/configuration.rb

@@ -0,0 +1,43 @@
+#--
+# Copyright (c) 2023+ 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 Agile
+class Configuration
+
+def self.defaults
+  default = {}
+  # 1: new, 2: filter, 3: sort
+  default[:index_standard_actions]   = { 1 => 'new',  3 => 'filter' }
+  # 1: edit, 2: duplicate, 3: delete
+  default[:dataset_standard_actions] = { 1 => 'edit', 3 => 'delete' }
+  # 1: back, 2: save, 3: save&back, 4: refresh, 5: enable, 6:new
+  default[:form_standard_actions]    = { 1 => 'cancel', 3 => 'save&back' }
+  # top, bottom, both
+  default[:default_actions_position] = 'top'
+  # top, left
+  default[:default_labels_position]  = 'left'
+  default
+end
+
+end
+end

data/lib/agile/engine.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2023+ 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 Agile #:nodoc:
+
+class Engine < ::Rails::Engine #:nodoc:
+end
+
+end

data/lib/agile/version.rb

@@ -0,0 +1,27 @@
+#--
+# Copyright (c) 2023+ 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.
+#++
+
+# Agile gem version
+module Agile # :nodoc:
+  VERSION = '0.0.0.1'.freeze
+end

data/lib/agile.rb

@@ -0,0 +1,282 @@
+require 'agile/engine'
+require 'agile/version'
+require 'agile/configuration'
+
+################################################################################
+# AgileRails plugin module
+################################################################################
+module Agile
+@@paths = {}
+@@configuration = nil
+
+################################################################################
+# Returns source file name of required model. 
+#
+# Used wherever end user wants to extend basic Agile model. Model source definition 
+# file is tricky to require since it is included in Agile gem and thus a moving 
+# target. Whenever gem version changes file location changes with it. This way 
+# programmer doesn't have to care about actual source file location.
+#
+# Parameters:
+# [ model_name ] String. Must be passed in lower case, just like the file name is. 
+#
+# Example: 
+#    require Agile.model 'ar_page'
+#
+###############################################################################
+def self.model(model_name)
+  File.expand_path("../../app/models/#{model_name}.rb", __FILE__)  
+end
+
+###############################################################################
+# If new_value is nil method will return current value of application configuration. Otherwise
+# it will set new value to the configurations.
+#
+# @param [Object] what : Config name
+# @param [Object] new_value : new config value. Default = nil.
+###############################################################################
+def self.config(what, new_value = nil)
+  @@configuration ||= Agile::Configuration.defaults
+  if new_value
+    @@configuration[what.to_sym] = new_value
+  else
+    @@configuration[what.to_sym]
+  end
+end
+
+###############################################################################
+# When new plugin with its own AgileRails forms is added to application, path to
+# forms directory must be sent to Agile module. Paths are saved into @@paths hash variable.
+#
+# Adding path is best done in plugin module initialization code.
+#
+# Parameters:
+# [path] String. Path to forms directory
+#
+# Example:
+#    # As used in MyPlugin plugin.
+#    require "my_plugin/engine"
+#    module MyPlugin
+#    end
+#
+#    Agile.add_forms_path File.expand_path("../../app/forms", __FILE__)
+###############################################################################
+def self.add_forms_path(path) 
+  if @@paths[:forms].nil?
+    @@paths[:forms] = []
+    # Agile forms path
+    @@paths[:forms] << File.expand_path('../../app/forms', __FILE__)
+  end
+  @@paths[:forms] << path  
+end
+
+###############################################################################
+# Not used anymore!
+#
+# Patching is one of the rubies best strenghts and also its curse. Loading
+# patches in development has become real problem for developers. This is my
+# way of patch loading.
+#
+# Preferred location for patch files is lib/patches. But can be located anywhere in 
+# Rails application path. Add Agile.add_forms_path to initialization part and pass 
+# directory name where patching files are located as parameter.
+#
+# Method will also load patch file so loading in config/initializers is not required.
+#
+# Parameters:
+# [path] String. Path to patches directory
+#
+# Example:
+#    # As used in MyPlugin plugin.
+#    require "my_plugin/engine"
+#    module MyPlugin
+#    end
+#
+#    Agile.add_patches_path File.dirname(__FILE__) + '/patches'
+###############################################################################
+def self.add_patches_path(path)
+  self.add_path(:patches, path)
+#  Dir["#{path}/**/*.rb"].each { |path| p path; require_dependency path }
+#  Dir["#{path}/**/*.rb"].each { |file| p file; require file }
+end
+
+###############################################################################
+# General add path method. Paths are saved into @@paths hash variable. Paths can
+# then be reused in different parts of application.
+# 
+# Adding paths is best done in plugin mudule initialization code.
+# 
+# Parameters:
+# [type] Symbol. Defines type of data. Current used values are :forms, :patches
+# [path] String. Path or string which will be added to @@paths hash.
+# 
+# Example:
+#    Agile.add_path(File.expand_path('patches', __FILE__), :patches)
+###############################################################################
+def self.add_path(type, path) 
+  @@paths[type] ||= []
+  @@paths[type] << path  
+end
+
+###############################################################################
+# Will return value saved to internal @@paths hash.
+#
+# Parameters:
+# [key] String. Key
+#
+# forms_paths   = Agile.paths(:forms)
+# patches_paths = Agile.paths(:patches)
+###############################################################################
+def self.paths(key)
+  @@paths[key]
+end
+
+###############################################################################
+# Will return name of file relative to agile_rails gem root
+###############################################################################
+def self.from_root(file = nil)
+  File.expand_path("../../#{file}", __FILE__).to_s
+end
+
+####################################################################
+# Checks if any errors exist on document and writes error log. It can also
+# crash if requested. This is mostly usefull in development for debuging
+# model errors or when updating multiple collections and each save must be
+# checked if succesfull.
+#
+# @param [Document] Document object which will be checked
+# @param [Boolean] If true method should end in runtime error. Default = false.
+#
+# @return [String] Error messages or empty string if everything is OK.
+#
+# @Example Check for error when data is saved.
+#   model.save
+#   if (msg = Agile.model_check(model) ).size > 0
+#     p msg
+#     error process ......
+#   end
+#
+####################################################################
+def self.model_check(document, crash = false)
+  return unless document.errors.any?
+
+  msg = document.errors.inject('') { |r, error| r << "#{error.attribute}: #{error.message}\n" }
+  if crash && msg.size > 0
+    msg = "Validation errors in #{document.class}:\n" + msg
+    pp msg
+    Rails.logger.error(msg)
+    raise 'Validation error. See log for more information.'
+  end
+  msg
+end
+
+########################################################################
+# Determines if redis cache store is active
+#
+# @return [Boolean] : True if  redis cache store is active
+########################################################################
+def self.redis_cache_store?
+  (Rails.application.config.cache_store.first == :redis_cache_store) rescue false
+end
+
+####################################################################
+# Clear cache. If key is specified only this key will be deleted.
+#
+# @param [String] Optional key to be deleted
+####################################################################
+def self.cache_clear(key = nil)
+  return Rails.cache.clear if key.nil?
+
+  if redis_cache_store?
+    Rails.cache.redis.del(key)
+  else
+    Rails.cache.delete_matched("#{key}*")
+  end
+end
+
+####################################################################
+# Read from cache
+#
+# @keys [Array] Array of keys
+#
+# @return [Object] Data returned from cache
+####################################################################
+def self.cache_read(keys)
+  data = if redis_cache_store?
+           tmp_keys  = keys.dup
+           first_key = tmp_keys.shift
+           cached    = Rails.cache.redis.hget(first_key, tmp_keys.join(''))
+           cached ? Marshal.load(cached) : nil
+         else
+           Rails.cache.read(keys.join(''))
+         end
+  return data if data
+  return unless block_given?
+
+  cache_write(keys, yield)
+end
+
+####################################################################
+# Write data to cache
+#
+# @param [Array] keys : array of keys
+# @param [Object] data : Document object
+#
+# @return [Object] data so cache_write can be used as last statement in method.
+####################################################################
+def self.cache_write(keys, data)
+  if redis_cache_store?
+    tmp_keys  = keys.dup
+    first_key = tmp_keys.shift
+    Rails.cache.redis.hset(first_key, tmp_keys.join(''), Marshal.dump(data))
+  else
+    Rails.cache.write(keys.join(''), data)
+  end
+  data
+end
+
+########################################################################
+# Will dump exception to rails log and console.
+#
+# Parameters:
+# [exception] Object: Exception caught
+########################################################################
+def self.dump_exception(exception)
+  msg = [exception.message, *exception.backtrace].join($/)
+  pp msg
+  Rails.logger.error msg
+end
+
+###############################################################################
+# All Routes required by agile_rails.
+# 
+# Usage:
+# put Agile.routes line anywhere into your application routes file
+###############################################################################
+def self.routes
+  Rails.application.routes.draw do
+    controller :agile_common do
+      post 'agile/autocomplete'            => :autocomplete
+      post 'agile_common/ad_click'         => :ad_click
+      get 'agile/toggle_edit_mode'         => :toggle_edit_mode
+      match 'agile_common/process_login'   => :process_login, via: [:put, :post]
+      get 'agile_common/login'             => :login
+      get 'agile_common/logout'            => :logout
+      get 'agile_common/copy_clipboard'    => :copy_clipboard
+      match 'agile_common/paste_clipboard' => :paste_clipboard, via: [:get, :post]
+      put 'agile_common/restore_from_journal'  => :restore_from_journal
+      get 'agile_common/add_json_ld_schema'    => :add_json_ld_schema
+      get 'agile_common/help'                  => :help
+      put 'agile_common/poll_submit'           => :poll_submit
+    end
+
+    match 'elfinder'     => 'agile_elfinder#connector', via: [:get, :post]
+    get   'agile/login'  => 'agile#login'
+    get   'agile/logout' => 'agile#logout'
+    match 'agile/run'    => 'agile#run', via: [:get, :put, :post]
+
+    resources :agile
+  end
+end
+
+end

data/lib/agile_rails.rb

@@ -0,0 +1 @@
+require 'agile'