agile_rails 0.0.0.1

data/app/models/ar_memory.rb

@@ -0,0 +1,172 @@
+#--
+# 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_memory : Collection name used when form does not belong to database model.
+# 
+# Which is not collection at all. ArMemory model is used for entering data on forms
+# where data will not be saved to database but will instead be saved only to memory as 
+# temporary variable and processed by custom made methods. 
+# For example, define start and end date when making a timeline report.
+# 
+# Example (as used in forms):
+# 
+#    table: ar_memory
+#    title: Enter time period
+#
+#      form:
+#        actions:
+#          1:
+#            type: ajax
+#            method: post
+#            controller: reports
+#            action: do_some_report
+#            caption: Run report
+#
+#        fields:
+#          10:
+#            name: date_start
+#            type: date_picker
+#            caption: Start date
+#          20:
+#            name: date_end
+#            type: date_picker
+#            caption: End date
+#            
+# And suppose your report saved data to file named public/report.pdf. 
+# Put this line at the end of do_some_report method:
+# 
+#    render inline: { :window_report => '/report.pdf' }.to_json, formats: 'js'
+#    
+# As result report.pdf file will be opened in new browser window.
+########################################################################
+class ArMemory < ApplicationRecord
+
+########################################################################
+# Initilize object
+########################################################################
+def initialize(parms = {})
+  @internals = {}
+  parms.each { |key, value| @internals[key.to_s] = value } if parms
+  super
+end
+=begin
+########################################################################
+# Return id field
+########################################################################
+def id
+  @internals['id']
+end
+
+########################################################################
+# Respond_to should always return true.
+########################################################################
+def id=(value)
+  @internals['id'] = value
+end
+=end
+
+
+########################################################################
+# Converts data field to @internals hash
+########################################################################
+def read_yaml
+  @internals = YAML.load(data) || {}
+end
+
+########################################################################
+# Convert @internals hash to data field
+########################################################################
+def save_yaml
+  self.data = @internals.to_yaml
+end
+
+########################################################################
+# Respond_to should always return true.
+########################################################################
+def respond_to?(m)
+  true
+end
+
+########################################################################
+# Redefine send method. Send is used to assign or access value by agile controller.
+########################################################################
+def send(field, value = nil)
+  field = field.to_s
+  if field.match('=')
+    field.chomp!('=')
+    @internals ||= {}
+    @internals[field] = value
+  else
+    @internals[field]
+  end
+end
+
+########################################################################
+# Redefine [] method to act similar as send method
+########################################################################
+def [](field)
+  return nil unless @internals
+  @internals[field.to_s]
+end
+
+########################################################################
+# Redefine [] method to act similar as send method
+########################################################################
+def []=(field, value)
+  @internals ||= {}
+  @internals[field.to_s] = value
+end
+
+########################################################################
+# For debugging purposes
+########################################################################
+def to_s
+  " ArMemory: @internals=#{@internals.size} #{@internals}"
+end
+
+########################################################################
+# Dummy errors so far.
+########################################################################
+#def errors
+##  []
+#end
+  
+########################################################################
+# Method missing will return value if value defined by m parameter is saved to
+# @internals array or will save field value to @internals hash if m matches '='.
+########################################################################
+def method_missing(m, *args, &block) #:nodoc:
+  @internals ||= {}
+  m = m.to_s
+  if m.match('=')
+    m = m.chomp('=')
+    @internals[m] = args.first
+  else
+    @internals[m]
+  end   
+end
+#=end
+end

data/app/models/ar_menu.rb

@@ -0,0 +1,144 @@
+#--
+# 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: ArMenu : AgileRail menu system
+#
+# Default menu system for AgileRails. Model recursively embeds ArMenuItem documents
+# which (theoretically) results in infinite level of sub menus. In practice 
+# reasonable maximum level of 4 is advised.
+#########################################################################
+class ArMenu < ApplicationRecord
+
+belongs_to :ar_site
+has_many   :ar_menu_items
+
+validates  :name, :length => { :minimum => 4 }
+validates  :name, uniqueness: true
+validates_length_of :description, minimum: 10
+
+after_save :cache_delete
+after_destroy :cache_delete
+  
+######################################################################
+# Clear menu cache
+######################################################################
+def cache_delete
+  Agile.cache_clear(name)
+end
+
+#######################################################################
+# Will return list of menu items of specified menu. Used in ArPage document for
+# selecting top level selected menu.
+# 
+# Called from AgileApplicationHelper :agile_choices_for_menu: method.
+# 
+# Parameters: 
+# [Site] ArSite document. Site for which menu belongs to. If site is not specified
+# all current menus in ar_menus collection will be returned.
+# 
+# Returns:
+# Array. Of choices prepared for select input field.
+#######################################################################
+def self.choices_for_menu(site)
+  rez = []
+  menus = (site.menu_name.blank? ? all : where(name: site.menu_name)).to_a
+  menus.each do |menu|
+    rez << [menu.name, nil]
+    menu.ozs_menu_items.where(active: true).order(:order).each do |menu_item|
+      rez << ['-- ' + menu_item.caption, menu_item._id]
+    end
+  end
+  rez
+end
+  
+#######################################################################
+# Subroutine of choices_for_menu_as_tree
+#######################################################################
+def self.do_sub_menu(menus, parent, ids) #:nodoc:
+  result = []
+  menus.each do |item|
+    long_id = "#{ids};#{item.id}"
+    result << [item.caption, long_id, parent, item.order]
+    sub_menus = ArMenuItem.where(parent_id: item.id).order(:order).to_a
+    result += do_sub_menu(sub_menus, long_id, long_id) if sub_menus.size > 0
+  end
+  result
+end
+
+#######################################################################
+# Will return menu structure for menus belonging to the site.
+# 
+# Parameters: 
+# [Site] ArSite document. Site for which menu belongs to. If site is not specified
+# all current menus in collection will be returned.
+# 
+# Returns:
+# Array. Of choices prepared for tree:select input field.
+#######################################################################
+def self.choices_for_menu_as_tree(site_id = nil)
+  return [] if site_id == nil
+
+  id = site_id.class == Integer ? site_id : site_id.id
+  where(ar_site_id: [nil, id], active: true).order(:name).inject([]) do |r, menu|
+    r << [menu.name, menu.id, nil, 0]
+    sub_menus = ArMenuItem.where(ar_menu_id: menu.id, parent_id: 0).order(:order).to_a
+    r += do_sub_menu(sub_menus, menu.id, menu.id.to_s) if sub_menus.size > 0
+    r
+  end
+end
+
+#######################################################################
+# Will update link value of selected menu_item
+# 
+# Parameters: 
+# [record] Array. Data of saved document.
+#######################################################################
+def self.menu_item_link_update(record)
+  return if record.try(:menu_id).blank?    # not set
+
+  ar = record.menu_id.split(';')
+  menu = ArMenuItem.find(ar.last.to_i)
+  menu.page_id = record.id
+  menu.save  
+end
+
+######################################################################
+# Return all pages belonging to site ready for select input field. Used
+# by ar_menu* forms, for selecting page which will be linked by menu option.
+# 
+# Parameters:
+# [site] Site document.
+######################################################################
+def self.all_pages_for_site(parms)
+  menu_id = parms[:ids].split(';').first    # get menu id from params[:ids]
+  site_id = ArMenu.only(:site_id).find(menu_id).ar_site_id
+  site  = ArSite.only(:page_class, :id).find(site_id)  # find site
+  pages = site.page_class.constantize       # pages collection name
+  pages.only(:subject, :id).where(ar_site_id: site.id, active: true).order(:subject)
+       .map { |page| [ page.subject, page.id] }
+end
+
+end

data/app/models/ar_menu_item.rb

@@ -0,0 +1,106 @@
+#--
+# 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_menu_item : Menu items
+#
+#  id                   Integer         id
+#  created_at           Time            created_at
+#  updated_at           Time            updated_at
+#  caption              String          Caption of menu item
+#  picture              String          Picture for the menu
+#  link                 String          Link called when menu is chosen
+#  link_prepend         String          Link field usually holds direct link to document. Prepand field holds data, that has to be prepanded to the link.
+#  target               String          Target window for the link. Leave empty when same window.
+#  page_id              Integer         Page link
+#  order                Integer         Order on which menu item is shown. Lower number means prior position.
+#  hidden               Boolean         Is hidden
+#  active               Boolean         Is active
+#  policy_id            Integer         Menu item will be diplayed according to this policy
+#  parent_id            Integer         Parent menu item. 0 if top level
+#  created_by           Integer         created_by
+#  updated_by           Integer         updated_by
+#
+# ArMenuItems model is used to save items of a menu.
+#########################################################################
+class ArMenuItem < ApplicationRecord
+
+belongs_to :ar_menu
+
+validates :order, presence: true
+
+before_save :do_before_save
+after_save :cache_delete
+after_destroy :cache_delete
+  
+#######################################################################
+# Will return menu path for the item as array of id-s. Method can be used
+# to determine all parents of current item.
+# 
+# Returns:
+# Array. Of parent items ids.
+#######################################################################
+def menu_path
+  path, parent = [], self
+  while parent
+    path << parent.id
+    parent = parent._parent
+  end 
+  path.reverse
+end
+
+#######################################################################
+# Will return top menu item id. Used for detecting which top-level menu 
+# was last selected.
+# 
+# Returns:
+#   Integer: Top menu level id
+#######################################################################
+def top_menu_id
+  menu_path[1]
+end
+
+######################################################################
+# Implementation of before_save callback.
+######################################################################
+def do_before_save
+  self.link = ArPage.clear_link(caption.downcase.strip) if link.blank?
+end  
+
+######################################################################
+# Clear parent record from cache
+######################################################################
+def cache_delete
+  ArMenu.find(ar_menu_id).cache_delete
+end
+
+######################################################################
+# Dummy method
+######################################################################
+def top_menu_id
+  menu_path[1]
+end
+  
+end

data/app/models/ar_page.rb

@@ -0,0 +1,74 @@
+#--
+# 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_page : Pages
+#
+#  id                 Integer           id
+#  created_at           Time          created_at
+#  updated_at           Time          Updated
+#  subject              String        Articles subject
+#  link                 String        Friendly link defined
+#  alt_link             String        Alternative link, by which page could be found
+#  sub_subject          String        Sub subject, short description of text
+#  picture              String        Picture used in conjunction with page
+#  gallery              Boolean       Picture gallery defined on page. Picture data is saved to document parts with id gallery.
+#  body                 String        Content of this page
+#  css                  String        CSS only for this menu page
+#  script               String        Javascript only for this page
+#  params               String        Special parameters which may come handy when displaying page
+#  menu_id              Integer       Top menu under where this page is displayed
+#  author_id            Integer       Author of the article
+#  ar_poll_id           Integer       Select poll, if poll is to be used with page
+#  author_name          String        Author of the article
+#  publish_date         DateTime      Publish date
+#  user_name            String        user_name
+#  valid_from           DateTime      Article is valid from date
+#  valid_to             DateTime      Article is valid to date
+#  comments             Integer       Comments on this article are allowed
+#  active               Boolean       Page is active
+#  created_by           Integer       created_by
+#  updated_by           Integer       updated_by
+#  kats                 Array         Categories for this article
+#  policy_id            Integer       Access policy for the page
+#  ar_site_id           Object        ar_site_id
+#  ar_design_id         Object        Design used for rendering page
+#
+# ArPage documents are anchors for urls. Default ArApplicationController.ar_process_default_request()
+# method searches for ArPage document by link, id or alt_link. When found it loads
+# design document defined by design_id and renders view code defined by design. 
+# 
+# Site owner has all control of how ArPage data is rendered by providing its own page renderer methods.
+# 
+# Every ArPage document may embed many ArPart documents. ArPart documents mostly contain fields
+# with same names and functionality as ArPage fields. And may therefore represent whole subpage data
+# system within single document. Clever programmer may provide data for whole web site in just 
+# one ArSite, one ArMenu, one ArDesign and one ArPage document (with some embedded documents). And since
+# AgileRails runs multiple sites on single Rails instance by default it may run hundreds of small sites
+# on single Ruby on Rails instance.
+#########################################################################
+class ArPage < ApplicationRecord
+  include ArPageConcern
+end

data/app/models/ar_part.rb

@@ -0,0 +1,66 @@
+#--
+# 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_part : Parts of page
+#
+#  id                 Integer           id
+#  created_at           Time                 created_at
+#  updated_at           Time                 Last updated at
+#  name                 String               Parts can be searched by name or by id
+#  description          String               Short description of part
+#  picture              String               Picture contents of part
+#  thumbnail            String               Small version of picture if available
+#  body                 String               Content of this part
+#  css                  String               CSS
+#  script               String               Script, if script is included in part
+#  script_type          String               Script type
+#  params               String               params
+#  piece_id             Integer       Piece name if part is connected to piece
+#  div_id               String               Div id (position name) where this part is displayed as defined on design
+#  site_id              Integer       site_id
+#  order                Integer              Order between parts
+#  active               Boolean     Part is active
+#  valid_from           DateTime             Part is valid from
+#  valid_to             DateTime             Part is valid to
+#  created_by           Integer       created_by
+#  updated_by           Integer       Last updated by
+#  _type                String               _type
+#  policy_id            Integer       Access policy for the part
+#  link                 String               Link when part can be accessed with pretty link
+# 
+# ArPart model is used for embedding parts of final document into other models. It declares fields
+# which may be used in various scenarios. For example:
+# - part of page which is visible to all users and part only to registered users
+# - list of pictures or attachments which belong to document 
+# -
+# 
+# ArPart model inherits its definition from ArPiece model, but adds policy_id
+# field to definition. Policy_id field may be used where site policy must be 
+# taken into account when rendering part.
+########################################################################
+class ArPart < ApplicationRecord
+  include ArPartConcern
+end