agile_rails 0.0.0.1

data/app/models/ar_image.rb

@@ -0,0 +1,198 @@
+#--
+# 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
+#
+# Collection name: ar_images : Images
+#
+#  _id                  BSON::ObjectId     _id
+#  created_at           Time               created_at
+#  updated_at           Time               updated_at
+#  ar_site_id           BSON::ObjectId     Site id
+#  ar_user_id           BSON::ObjectId     User's id
+#  name                 String             ip
+#  short                String             short name
+#  text                 String             text
+#  size_o               String             Original image size
+#  size_l               String             Large image size
+#  size_m               String             Medium image size
+#  size_s               String             Small image size
+#
+# AgileRails module for saving and manipulating images. Images can be saved to local
+# directory only. Settings for output images must be set in settings in site record.
+# Example:
+#   ar_image:
+#     sizes: 900x600,500x400,300x200
+#     location: images
+#     quality: '80'
+#     img_type: webp
+#
+# To use this module imagemagick tools and mini_magick ruby gem must be installed.
+##########################################################################
+class ArImage < ApplicationRecord
+
+before_validation :set_original
+validate :validate_image_values
+
+#########################################################################
+# checks that image size values are in correct format. Must be hsize[x]vsize (ex. 300x200)
+#########################################################################
+def set_original
+  if keep_original
+    if size_o.blank?
+      image = MiniMagick::Image.open(name)
+      self.size_o = "#{image.width}x#{image.height}"
+    end
+  else
+    self.size_o = ''
+  end
+end
+
+#########################################################################
+# checks that image size values are in correct format. Must be hsize[x]vsize (ex. 300x200)
+#########################################################################
+def validate_image_values
+  %w[l m s o].each do |size|
+    field = "size_#{size}"
+    value = send(field)
+    next if value.blank?
+
+    a = value.strip.split(/x|\+/)
+    a[0, 2].each { |e| errors.add(field, I18n.t('agile.not_valid')) unless e.to_i > 0 }
+  end
+end
+
+#########################################################################
+# Will return first available image starting from small up
+#########################################################################
+def first_available_image
+  image = %w[o s m l].each do |size|
+    field = "size_#{size}"
+    value = send(field)
+    return "#{id}-#{size}.#{img_type}" if value.present?
+  end
+end
+
+#########################################################################
+# Will return size for large image
+#########################################################################
+def size_ls
+  size_l.blank? ? '' : size_l.split(/x|\+/)[0, 2].join('x')
+end
+
+#########################################################################
+# Will set new size for large image
+#########################################################################
+def size_ls=(value)
+  self.size_l = value.blank? ? '' : value
+end
+
+#########################################################################
+# Will return x offset for cropping large image
+#########################################################################
+def offset_lx
+  size_l.blank? ? '' : size_l.split(/x|\+/)[2].to_i
+end
+
+#########################################################################
+# Will set x offset for cropping large image
+#########################################################################
+def offset_lx=(value)
+  self.size_l += (size_l.blank? ? '' : "+#{value}")
+end
+
+#########################################################################
+# Will return y offset for cropping large image
+#########################################################################
+def offset_ly
+  size_l.blank? ? '' : size_l.split(/x|\+/)[3].to_i
+end
+
+#########################################################################
+# Will set y offset for cropping large image
+#########################################################################
+def offset_ly=(value)
+  self.size_l += (size_l.blank? ? '' : "+#{value}")
+end
+
+def size_ms
+  size_m.blank? ? '' : size_m.split(/x|\+/)[0, 2].join('x')
+end
+
+def size_ms=(value)
+  self.size_m = value.blank? ? '' : value
+end
+
+def offset_mx
+  size_m.blank? ? '' : size_m.split(/x|\+/)[2].to_i
+end
+
+def offset_mx=(value)
+  self.size_m += (size_m.blank? ? '' : "+#{value}")
+end
+
+def offset_my
+  size_m.blank? ? '' : size_m.split(/x|\+/)[3].to_i
+end
+
+def offset_my=(value)
+  self.size_m += (size_m.blank? ? '' : "+#{value}")
+end
+
+def size_ss
+  size_s.blank? ? '' : size_s.split(/x|\+/)[0, 2].join('x')
+end
+
+def size_ss=(value)
+  self.size_s = value.blank? ? '' : value
+end
+
+def offset_sx
+  size_s.blank? ? '' : size_s.split(/x|\+/)[2].to_i
+end
+
+def offset_sx=(value)
+  self.size_s += (size_s.blank? ? '' : "+#{value}")
+end
+
+def offset_sy
+  size_s.blank? ? '' : size_s.split(/x|\+/)[3].to_i
+end
+
+def offset_sy=(value)
+  self.size_s += (size_s.blank? ? '' : "+#{value}")
+end
+
+#########################################################################
+# Return all users that have contributed images
+#########################################################################
+def self.all_users
+  ArUser.where(:id.in => distinct(:created_by)).order(name: 'asc').map { [_1.name, _1.id] }
+end
+
+def self.html_code
+  'code'
+end
+
+end

data/app/models/ar_internals.rb

@@ -0,0 +1,60 @@
+#--
+# 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.
+#+
+
+##########################################################################
+# Internals model returns some Rails environment variables like session, params, record ...
+# with more user friendly names. These names can be used for interacting with
+# users and hide complexity behind the scene.
+#
+# eg: ArInternals.get('current_user_name') will return session[:user_name]
+#
+# Predefined internal values are:
+#  current_user
+#  current_user_name
+#  current_site
+##########################################################################
+module ArInternals
+INTERNALS = {
+  'current_user'      => 'session[:user_id]',
+  'current_user_name' => 'session[:user_name]',
+  'current_site'      => 'agile_get_site.id'
+}
+@additions = {}
+  
+##########################################################################
+# Add additional internal. This method allows application specific internals 
+# to be added to structure and be used together with predefined values.
+##########################################################################
+def self.add(hash)
+  hash.each { |key, value| @additions[key] = value }
+end
+
+##########################################################################
+#
+##########################################################################
+def self.get(key)
+  key.delete_prefix!('@')
+  INTERNALS[key] || @additions[key]
+end
+
+end

data/app/models/ar_journal.rb

@@ -0,0 +1,46 @@
+#--
+# 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_journal : Update journal
+#
+#  id                 Integer           id
+#  user_id              Integer       User
+#  site_id              Integer       Site
+#  doc_id               Integer       doc_id
+#  operation            String               Operation
+#  tables               String               Table name
+#  ids                  String               Parent ids
+#  ip                   String               ip address from where operation was performed
+#  time                 DateTime             Time of operation
+#  diff                 String               Differences
+# 
+# ar_journals collections saves all data that has been updated through agile controller.
+# It saves old and new values of changed fields and can be used for
+# instant restore of single document field or tracking who and when updated 
+# particular document.
+#########################################################################
+class ArJournal < ApplicationRecord
+end

data/app/models/ar_json_ld.rb

@@ -0,0 +1,131 @@
+#--
+# 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
+#
+# name: ar_json_ld : JSON_LD data for site optimization
+#
+#  id                   Integer       id
+#  type                 String        Type of structure
+#  data                 String        Structure data in YAML
+#  ar_json_lds          Object        Can embed substructure
+#  created_at           Time          created_at
+#  updated_at           Time          Last updated at
+#  created_by           Integer       created_by
+#  updated_by           Integer       Last updated by
+#
+########################################################################
+
+# Not implemented yet
+class ArJsonLd
+
+field :name,        type: String
+field :type,        type: String
+field :data,        type: String
+field :active,      type: Boolean, default: true
+
+embeds_many :ar_json_lds, cyclic: true
+
+field :created_by,  type: Integer
+field :updated_by,  type: Integer
+
+validates :name, presence: true
+validates :type, presence: true
+
+##########################################################################
+# Returns JSON LD data as YAML
+##########################################################################
+def get_json_ld(env_data)
+  yaml = (YAML.load(self.data) rescue nil) || {}
+  yaml['@type'] = self.type if yaml.size > 0
+  if ar_json_lds.size > 0
+    ar_json_lds.where(active: true).each do |element|
+      yml = element.get_json_ld(env_data)
+      if yml.size > 0
+        yaml[element.name] ||= []
+        yaml[element.name] << yml
+      end
+    end
+  end
+  yaml
+end
+
+########################################################################
+# Find document by ids when document are embedded into main d even if embedded
+# 
+# @param [tables] Tables parameter as send in url. Tables are separated by ;
+# @param [ids] ids as send in url. ids are separated by ;
+# 
+# @return [Document] 
+########################################################################
+def self.find_document_by_ids(tables, ids)
+  collection = tables.split(';').first.classify.constantize
+  ar_ids = ids.split(';')
+  # Find top document
+  document = collection.find(ar_ids.shift)
+  # Search for embedded document
+  ar_ids.each { |id| document = document.ar_json_lds.find(id) }
+  document
+end
+
+#########################################################################
+# Returns possible options for type select field on form.
+#########################################################################
+def self.choices_for_type
+  yaml = YAML.load_file(AgileHelper.form_file_find('json_ld_schema'))
+
+  yaml.map(&:first)
+end
+
+#########################################################################
+# Create menu to add schema element. Called from Agile Form action.
+#########################################################################
+def self.add_schema_menu(env)
+  yaml = YAML.load_file(AgileHelper.form_file_find('json_ld_schema'))
+  if (level = env.params['ids'].split(';').size) == 1
+    # select only top level elements
+    yaml.delete_if { |schema_name, schema_data| schema_data['level'].nil? }
+  else
+    # select only elemets which are subelements of type
+    env_type = self.find_document_by_ids(env.params['table'],env.params['ids']).type
+    _yaml = []
+    yaml[env_type].each_value do |data|
+      next unless data.class == Hash
+
+      _yaml << [data['type'], yaml[data['type']]] if data['type'] && yaml[data['type']]
+    end
+    yaml = _yaml
+  end
+  # create menu code
+  html = '<ul>'
+  yaml.each do |schema_name, schema_data|
+    next if level == 1 && schema_data['level'].nil?
+
+    url = "/agile_common/add_json_ld_schema?table=#{env.params['table']}&ids=#{env.params['ids']}&schema=#{schema_name}&url=#{env.request.url}"
+    html += %(<li class="ar-link-ajax in-menu" data-url="#{url}">#{schema_name}</li>)
+  end
+  "#{html}</ul>"
+end
+
+end

data/app/models/ar_key_value_store.rb

@@ -0,0 +1,128 @@
+#--
+# Copyright (c) 2024+ Damjan Rems
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#+
+
+#########################################################################
+# == Schema information
+#
+# Table name: ar_key_value_store : Table used for storing all kind of values
+#
+#  id                 Integer           id
+#  key                  String               Identification key
+#  value                String               Stored value
+# 
+# This model represents key/value store. Typical usage is for saving last
+# used document number on internal document numbering schema.
+# 
+# Example: 
+#    invoice_number = ArKeyValueStore.get_next_value('invoices', invoice.year)
+#########################################################################
+class ArKeyValueStore < ApplicationRecord
+
+###########################################################################
+# Will return value incremented by 1 and update document with new value.
+# 
+# Parameters: 
+# [keys] Array. Any number of parameters from which key will be generated.
+# 
+# Returns:
+# String. Last saved value incremented by 1.
+###########################################################################
+def self.get_next_value(*keys)
+  doc   = find_by(key: keys.join('-'))
+  value = (doc ? doc.value : '0').next
+  if doc
+    doc.value = value
+    doc.save!
+  else
+    create(key:  keys.join('-'), value: value)
+  end
+  value
+end
+
+###########################################################################
+# Will try to restore to previous value if value matches current value.
+# 
+# Parameters: 
+# [value] String. Last value obtained by get_next_value method.
+# [keys] Array. Any number of parameters from which key will be generated.
+###########################################################################
+def self.restore_value(value, *keys)
+  doc = find_by(key: keys.join('-'))
+  if value == doc.value
+    value = value.prev
+    doc.value = value
+    doc.save!
+    return value
+  end
+  nil
+end
+
+###########################################################################
+# Will return value incremented by 1 but will not update document with new value.
+# Used for presenting user with most possible document number. Real document number must
+# of course be obtained by get_next_value before document is saved to collection.
+# 
+# Parameters: 
+# [keys] Array. Any number of parameters from which key will be generated.
+# 
+# Returns:
+# String. Last saved value incremented by 1.
+###########################################################################
+def self.peep_next_value(*keys)
+  doc = find_by(key: keys.join('-'))
+  (doc ? doc.value : '0').next  
+end
+
+###########################################################################
+# Will return current value for the key.
+# 
+# Parameters: 
+# [keys] Array. Any number of parameters from which key will be generated.
+# 
+# Returns:
+# String. Current value for specified key or nil if key is not found.
+###########################################################################
+def self.get_value(*keys)
+  doc = find_by(key: keys.join('-'))
+  doc ? doc.value : nil
+end
+
+###########################################################################
+# Will set value for the key. If document is not found new document will be created.
+# 
+# Parameters: 
+# [value] String. New value to be set.
+# [keys] Array. Any number of parameters from which key will be generated.
+###########################################################################
+def self.set_value(value, *keys)
+  doc = find_by(key: keys.join('-'))
+  if doc
+    doc.value = value
+    doc.save!
+  else
+    create(key:  keys.join('-'), value: value.to_s)
+  end
+  value
+end
+
+end

data/app/models/ar_link.rb

@@ -0,0 +1,48 @@
+#--
+# 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_link : Alternative links
+#
+#  id                   Integer             id
+#  created_at           Time                created_at
+#  updated_at           Time                updated_at
+#  name                 String              Link name ex. homepage
+#  params               String              Aditional parameters passed to document renderer
+#  active               Boolean             Link is active
+#  page_id              Integer             Page redirected to by this shortcut link
+#  redirect             String              Link to redirect to
+#  created_by           Integer             created_by
+#  updated_by           Integer             updated_by
+#  ar_site_id           Object              Link is valid for site
+# 
+# ArLink documents is used for creating alternative url links or redirections. page_id field must
+# point to valid ArPage document which will be used for further processing.
+#########################################################################
+class ArLink < ApplicationRecord
+  belongs_to  :ar_site, optional: true
+
+  validates :link, presence: true
+end