agile_rails 0.0.0.1

data/app/models/ar_permission.rb

@@ -0,0 +1,180 @@
+#--
+# 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_permission : Table permissions
+#
+#  id                 Integer           id
+#  created_at           Time          created_at
+#  updated_at           Time          updated_at
+#  table_name           String        Permission is valid for table
+#  is_default           Boolean       This is default permission for all tables in database
+#  active               Boolean       Permission is active
+#  ar_policy_rules      Embedded:     ArPolicyRule Defined policy rules
+# 
+# ar_permissions table define permissions for accessing single table when in edit mode.
+# They define table and user role that can view, edit or delete documents in a table.
+# Document marked as default is the top level document and defines general permissions valid for
+# all tables. It usually states that admiin can delete all documents and guest has no access.
+#
+# Rules can also be namespaced. If you have an isolated application which is using its own set
+# of tables, you can start table names with same (3 letter) prefix and add a permission rule like ar_*.
+#########################################################################
+class ArPermission < ApplicationRecord
+#- Available permissions settings
+
+# User has no access 
+NO_ACCESS = 0
+# User can view documents
+CAN_VIEW  = 1
+# User can create new documents  
+CAN_CREATE = 2
+# User can edit his own documents
+CAN_EDIT = 4
+# User can edit all documents in table
+CAN_EDIT_ALL = 8
+# User can delete his own documents
+CAN_DELETE = 16
+# User can delete all documents in table
+CAN_DELETE_ALL = 32
+# User can admin table (same as can_delete_all, but can see documents which do not belong to current site)
+CAN_ADMIN = 64
+# User is superadmin. Basicly same as admin.
+SUPERADMIN = 128
+
+has_many :ar_permission_rules
+
+validates :table_name, presence: true
+validates :table_name, uniqueness: true
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_permission)
+end
+
+########################################################################
+# Will return choices for permissions prepared for usega in select input field.
+# This will return english only comments so it is not used.
+########################################################################
+def self.table_permissions #:nodoc:
+  [['NO_ACCESS', 0],  ['CAN_VIEW', 1], ['CAN_CREATE', 2], ['CAN_EDIT', 4], ['CAN_EDIT_ALL', 8],
+   ['CAN_DELETE', 16], ['CAN_DELETE_ALL', 32], ['CAN_ADMIN', 64], ['SUPERADMIN', 128]]
+end
+
+########################################################################
+# Will return choices for permissions prepared for usega in select input field.
+# This will return english only comments so it is not used.
+########################################################################
+def self.site_permissions #:nodoc:
+  [['NO_ACCESS', 0], ['CAN_VIEW', 1], ['CAN_EDIT', 2]]
+end
+
+#############################################################################
+# Will return permissions for table
+############################################################################
+def self.permissions_for_table(table_name)
+  result = permissions_for('*')
+  result = permissions_for("#{table_name[0,3]}*", result)
+  permissions_for(table_name, result)
+end
+
+#############################################################################
+# 
+############################################################################
+def self.permissions_for(table_name, result = {}) #:nodoc:
+  permissions = if table_name == '*'
+                  find_by(is_default: true)
+                else
+                  find_by(table_name: table_name, active: true)
+                end
+  if permissions
+    permissions.ar_permission_rules.each { |rule| result[rule.ar_role_id] = rule.permission }
+  end
+  result
+end
+
+#########################################################################
+# Returns values for permissions ready to be used in select field.
+#
+# Example (as used in AgileRails form):
+#    20:
+#      name: permission
+#      type: select
+#      eval: ArPermission.values_for_permissions
+#########################################################################
+def self.choices_for_permissions
+  values_for_permissions_for_key 'helpers.label.ar_policy_rule.choices_for_permission'
+end
+
+#########################################################################
+# Returns values for site_permissions ready to be used in select field.
+#
+# Example (as used in AgileRails form):
+#    20:
+#      name: permission
+#      type: select
+#      eval: ArPermission.values_for_site_permissions
+#########################################################################
+def self.choices_for_site_permissions
+  values_for_permissions_for_key 'helpers.label.ar_policy_rule.choices_for_sites_permission'
+end
+
+#########################################################################
+def self.values_for_permissions_for_key(key)
+  c = I18n.t(key)
+  c = I18n.t(key, locale: 'en') if c.class == Hash || c.match(/translation missing/i)
+  c.split(',').map { |e| (ar = e.split(':'); [ar.first, ar.last.to_i]) }
+end
+
+#########################################################################
+# Will return translated permission name for value.
+#
+# Parameters:
+# [value] Integer. Permission value
+#
+# Example (as used in AgileRails form):
+#    data_set:
+#      columns:
+#        2:
+#          name: permission
+#          eval: ArPermission.permission_name_for_value
+#
+# Returns:
+# String. Name (description) for value
+#########################################################################
+def self.permission_name_for_value(value)
+  choices_for_permissions.reduce('error') { |r, v| break v.first if v.last.to_i == value.to_i }
+end
+
+def self.site_permission_name_for_value(value)
+  choices_for_site_permissions.reduce('error') { |r, v| break v.first if v.last.to_i == value.to_i }
+end
+
+end

data/app/models/ar_permission_rule.rb

@@ -0,0 +1,65 @@
+#--
+# 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_permission_rule : Table access permisssion rules
+#
+#  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
+#
+# ar_permission_rules records define rules for accessing single database table.
+# They define user roles and their permissions to view, create, edit or delete data.
+#
+#########################################################################
+class ArPermissionRule < ApplicationRecord
+
+belongs_to :ar_permission
+has_many   :ar_roles
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+validate :validations
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_permission)
+end
+
+####################################################################
+# Additional validations.
+####################################################################
+def validations
+  if new_record? && ArPermissionRule.find_by(ar_permission_id: ar_permission_id, ar_role_id: ar_role_id).present?
+    errors.add('ar_role_id', I18n.t('agile.already_defined'))
+  end
+end
+
+end

data/app/models/ar_policy.rb

@@ -0,0 +1,78 @@
+#--
+# 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_policy : Access policy declarations
+#
+#  id                 Integer           id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Unique policy name
+#  description          String               Description for this policy
+#  is_default           Boolean     This is default policy for the site
+#  active               Boolean     Policy is active
+#  updated_by           Integer       updated_by
+#  message              String               Error message when blocked by this policy
+#  rules                String               Policy rules
+# 
+# ArPolicy documents define policies for accessing data on web site. Policies define which
+# user roles (defined in ar_policy_roles table) has no access, can view or edit data (sees CMS menu) on
+# current active web page. Policies can then be applied to individual documents or parts of the site.
+# 
+# Document defined as default, holds top level policy which is inherited by all
+# other policies. Default policy is also used when document has no access policy assigned.
+#########################################################################
+class ArPolicy < ApplicationRecord
+belongs_to :ar_site
+has_many   :ar_policy_rules
+
+validates :name, length: { minimum: 4 }
+validates :message, length: { minimum: 5 }
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+validate :is_the_only_default_policy
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_permission)
+  Agile.cache_clear(:ar_site)
+end
+
+####################################################################
+# There should be only one default policy.
+####################################################################
+def is_the_only_default_policy
+  existing_policy_id = ArPolicy.find_by(ar_site_id: ar_site_id, is_default: true)&.id
+
+  if is_default && existing_policy_id && existing_policy_id != id
+    errors.add('is_default', I18n.t('agile.already_defined'))
+  end
+end
+
+end

data/app/models/ar_policy_rule.rb

@@ -0,0 +1,65 @@
+#--
+# 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_policy_rule : Access policy rules
+#
+#  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
+#
+# ArPolicyRule records define rules for the policy. They define user roles and their
+# permission to view or edit data on site.
+#
+#########################################################################
+class ArPolicyRule < ApplicationRecord
+
+belongs_to :ar_policy
+has_many   :ar_roles
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+validate :validations
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_site)
+end
+
+####################################################################
+# Additional validations.
+####################################################################
+def validations
+  if new_record? && ArPolicyRule.find_by(ar_policy_id: ar_policy_id, ar_role_id: ar_role_id).present?
+    errors.add('ar_role_id', I18n.t('agile.already_defined'))
+  end
+end
+
+end

data/app/models/ar_poll.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_poll : Polls
+#
+#  id                 Integer           id
+#  created_at           Time          created_at
+#  updated_at           Time          updated_at
+#  name                 String        Unique poll name
+#  title                String        Title for the poll
+#  sub_text             String        Short description of the poll
+#  pre_display          String        pre_display
+#  operation            String        Operation performed on submit
+#  parameters           String        Aditional parameters for operation
+#  display              String        Select how fields are positioned on form
+#  css                  String        CSS specific to this poll
+#  form                 String        You can specified input items by providing form acording to rules of AgileRails form.
+#  valid_from           DateTime      Pole is valid from
+#  valid_to             DateTime      Pole is valid to
+#  captcha_type         String        Catpcha type name if captcha is used
+#  active               Boolean       active
+#  created_by           Integer       created_by
+#  updated_by           Integer       updated_by
+#
+# ArPoll documents are used for different questionaries and formulars which can
+# be accessed independent or connected with ArPage documents. Entry fields can be defined
+# in related ar_poll_items table or as AgileRails form YAML style entered into form field.
+########################################################################
+class ArPoll < ApplicationRecord
+  
+has_many :ar_poll_items
+
+########################################################################
+# Save poll results to ArPollResults table
+# 
+# Params:
+# data : Hash : Records hash (params[:record])
+########################################################################
+def save_results(data)
+  h = {}
+  items = form.blank? ? ArPollItem.where(ar_poll_id: id) : YAML.load(self.form.gsub('&nbsp;', ' '))
+  items.each do |item|
+    next if %w(hidden_field submit_tag link_to comment).include?(item.field_type) # ignore
+    next if item.try(:options).match('hidden') # also ignore
+
+    h[ item['name'] ] = data[ item['name'] ]
+  end
+  ArPollResult.create(ar_poll_id: id, data: h.to_yaml)
+end    
+    
+end

data/app/models/ar_poll_item.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_poll_item : Poll items define entry fields on poll questionary and formulars.
+#
+#  id                 Integer         id
+#  created_at           Time        created_at
+#  updated_at           Time        updated_at
+#  name                 String      Name (alias) of returned field name
+#  text                 String      Caption of item
+#  field_type           String      Input field type
+#  size                 String      size
+#  mandatory            Boolean     Item entry is mandatory
+#  separator            String      Separator between items
+#  options              String      Options for the item. Depends on item type.
+#  order                Integer     Order of item on poll
+#  active               Boolean     Item is active
+# 
+########################################################################
+class ArPollItem < ApplicationRecord
+  validates_length_of :name, minimum: 3
+
+  belongs_to :ar_poll
+end

data/app/models/ar_poll_result.rb

@@ -0,0 +1,38 @@
+#--
+# 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_poll_results : Pools results saved
+#
+#  id                 Integer           id
+#  ar_poll_id           Integer       poll id
+#  data                 String               Data saved as YAML
+#  confirmed            Boolean              Poll entry was confirmed
+#
+# Results of polls saved as YAML structure.
+########################################################################
+class ArPollResult < ApplicationRecord
+  belongs_to :ar_poll
+end

data/app/models/ar_removed_url.rb

@@ -0,0 +1,42 @@
+#--
+# 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_removed_url : List of URL-s removed from site
+#
+#  id                   Integer              id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  url                  String               URL that is no longer active
+#  ar_site_id           Integer              URL is valid only for the site
+# 
+#  List of URLs removed from site so web crawlers will also remove them from their 
+#  indexes. Use when creating sitemaps.
+##########################################################################
+class ArRemovedUrl < ApplicationRecord
+  belongs_to  :ar_site, optional: true
+  
+  validates :url, presence: true
+end

data/app/models/ar_role.rb

@@ -0,0 +1,84 @@
+#--
+# 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_role : User roles
+#
+#  id                 Integer           id
+#  created_at           Time                 created_at
+#  updated_at           Time                 updated_at
+#  name                 String               Role name
+#  system_name          String               System role name if required by application
+#  active               Boolean              Role is active
+# 
+# Documents in this model define all available user roles in the application. Roles 
+# are defined by unique name which is valid for current application or as alternative name (system_name) 
+# which can be persistent, when application is used as Rails plugin.
+#########################################################################
+class ArRole < ApplicationRecord
+
+validates :name, :length => { :minimum => 4 }
+validates :name, uniqueness: true
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_permission)
+  Agile.cache_clear(:ar_site)
+  Agile.cache_clear(:ar_role)
+end
+
+########################################################################
+# Return all defined roles as choices for use in select field.
+########################################################################
+def self.choices_for_roles
+  where(active: true).order(name: :asc).map { |role| [ role.name, role.id] }
+end
+
+########################################################################
+# Search for role when role parameter is String.
+########################################################################
+def self.get_role(name)
+  record = Agile.cache_read(['ar_role', name])
+  return record if record
+
+  record = find_by(name: name) || find_by(system_name: name)
+  Agile.cache_write(['ar_policy_role', name], record)
+end
+
+########################################################################
+# Search for role when role parameter is String.
+########################################################################
+def self.get_role(name)
+  Agile.cache_read(['ar_role', name]) do
+    record = find_by(name: name) || find_by(system_name: name)
+  end
+end
+
+end