agile_rails 0.0.0.1

data/app/models/concerns/ar_part_concern.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.
+#+
+
+#########################################################################
+# ActiveSupport::Concern definition for ArPart model.
+#########################################################################
+module ArPartConcern
+extend ActiveSupport::Concern
+included do
+
+validates :name, presence: true
+
+before_save do
+  self.link = name.strip.downcase.gsub(' ', '-') if link.blank?
+end
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear parent's record from cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(self.class.to_s.underscore)
+end
+
+end
+end

data/app/models/concerns/ar_piece_concern.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.
+#+
+
+#########################################################################
+# ActiveSupport::Concern definition for ArPart model.
+#########################################################################
+module ArPartConcern
+extend ActiveSupport::Concern
+included do
+
+validates :name, presence: true
+
+before_save do
+  self.link = name.strip.downcase.gsub(' ', '-') if link.blank?
+end
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear parent's record from cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(self.class.to_s.underscore)
+end
+
+end
+end

data/app/models/concerns/ar_policy_rule_concern.rb

@@ -0,0 +1,87 @@
+#--
+# 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.
+#+
+
+#########################################################################
+# ActiveSupport::Concern definition for ArPolicyRule class. 
+#########################################################################
+module ArPolicyRuleConcern
+extend ActiveSupport::Concern
+included do
+
+belongs_to :ar_policy_role
+
+field      :permission,    type: Integer, default: 0
+
+embedded_in :policy_rules, polymorphic: true
+
+#after_save :cache_clear
+#after_destroy :cache_clear
+
+#########################################################################
+# Returns values for permissions ready to be used in select field.
+#
+# Example (as used in AgileRails form): 
+#    20:
+#      name: permission
+#      type: select
+#      eval: ArPolicyRule.values_for_permissions
+#########################################################################
+def self.values_for_permissions
+  key = 'helpers.label.ar_policy_rule.choices_for_permission'
+  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: ArPolicyRule.permission_name_for_value
+# 
+# Returns:
+# String. Name (description) for value
+#########################################################################
+def self.permission_name_for_value(value)
+  values_for_permissions.reduce('error') { |r, v| break v.first if v.last.to_i == value.to_i }
+end
+
+private
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+#def cache_clear
+#  _parent.send(:cache_clear) if _parent.respond_to?(:cache_clear)
+#end
+
+end
+
+end

data/app/models/concerns/ar_seo_concern.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.
+#+
+
+##########################################################################
+#  ar_seo_concern, ads SEO optimization fields to any model.
+#
+# title                String               Browser title. Optimization for SEO.
+# meta_description     String               SEO optimised page description
+# meta_additional      String               Additional meta page data. Enter as meta_name=meta data
+#  ar_json_lds          Embedded: ArJsonLd    Page structure data
+# 
+# If you want to add SEO optimization data to your document add:
+# 
+# "include ArSeoConcern" to your model definition
+# 
+# and
+# 
+# "include:  ar_seo" option to top of AgileRails edit form for your document.
+##########################################################################
+module ArSeoConcern
+extend ActiveSupport::Concern
+
+included do  
+  field :title,            type: String
+  field :meta_description, type: String
+  field :canonical_link,   type: String
+  embeds_many :ar_json_lds # JSON-LD structure
+  
+  ######################################################################
+  # Will return JSON LD data if defined for the page
+  ######################################################################
+  def get_json_ld()
+    parent_data = {'datePublished' => self.created_at, 'dateModified' => self.updated_at}
+    data = []
+    if  ar_json_lds.size > 0
+       ar_json_lds.where(active: true).each do |element|
+        dta = element.get_json_ld(parent_data)
+        data << dta if dta.size > 0
+      end
+    end
+    data  
+  end
+end
+
+
+end

data/app/models/concerns/ar_site_concern.rb

@@ -0,0 +1,103 @@
+#--
+# 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.
+#+
+
+#########################################################################
+# ActiveSupport::Concern definition for ArSite class. 
+#########################################################################
+module ArSiteConcern
+extend ActiveSupport::Concern
+include ActiveModel::Validations
+
+included do
+
+has_many :ar_policies
+validates :name, presence: true
+
+after_save :cache_clear
+after_destroy :cache_clear
+
+####################################################################
+# Clear cache if cache is configured
+####################################################################
+def cache_clear
+  Agile.cache_clear(:ar_site)
+end
+
+########################################################################
+# Returns value of site setting. If no value is send as parameter it returns 
+# all settings hash object.
+########################################################################
+def params(what = nil)
+  @params ||= self.settings.to_s.size > 5 ? YAML.load(self.settings) : {}
+  what.nil? ? @params : @params[what.to_s]
+end
+alias :options :params
+
+########################################################################
+# Returns class object of page table
+########################################################################
+def page_klass
+  page_class.classify.constantize
+end
+
+########################################################################
+# Returns class object of site's menu table name
+########################################################################
+def menu_klass
+  (menu_class.blank? ? 'ArMenu' : menu_class).classify.constantize
+end
+
+########################################################################
+# Returns this site policies
+########################################################################
+def site_policies
+  ArPolicy.where(ar_site_id: id, active: true).order(name: :asc)
+end
+
+########################################################################
+# Return default site policy rules
+########################################################################
+def default_policy
+  ArPolicyRule.where('ar_policy.ar_site_id' => id, 'ar_policy.is_default' => true).joins(:ar_policy)
+end
+
+########################################################################
+# Return choices for select for site_id
+########################################################################
+def self.choices_for_sites
+  all.map { |site| [(site.active ? '' : I18n.t('agile.disabled') ) + site.name, site.id] }
+     .sort { |a, b| a[0] <=> b[0] }
+end
+
+########################################################################
+# Return choices for selecting policies for the site
+########################################################################
+def self.choices_for_menu(menu_class)
+  return [] if menu_class.blank?
+
+  menu = menu_class.classify.constantize
+  menu.where(active: true).map { [_1.description, _1.id] }
+end
+
+end  
+end

data/app/models/concerns/ar_user_concern.rb

@@ -0,0 +1,195 @@
+#--
+# 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.
+#+
+
+#########################################################################
+# ActiveSupport::Concern definition for ArUser class. 
+#########################################################################
+module ArUserConcern
+extend ActiveSupport::Concern
+#include ActiveModel::Validations
+included do
+@@countries = nil
+
+include ActiveModel::SecurePassword
+
+has_many :ar_user_roles
+has_many :ar_roles, through: :ar_user_roles
+
+has_secure_password
+
+validates_length_of :username, minimum: 4
+validates           :username, uniqueness: true
+validates           :email,    uniqueness: true
+validate :do_validate
+
+before_save :do_before_save
+before_validation :do_before_validation
+
+attr_reader :cached_roles
+
+##########################################################################
+# Checks if user has role 'role_id' defined in his roles.
+# 
+# Role may be passed as id or as String like role name.
+##########################################################################
+def has_role?(role_id)
+  return false if role_id.nil?
+
+  if role_id.class == String
+    role    = ArRole.get_role(role_id)
+    role_id = role.id if role
+  end
+  roles().include?(role_id)
+end
+
+##########################################################################
+# Returns all active roles for user
+#
+# @return [Array] : Array of user roles ids
+##########################################################################
+def roles
+  return @cached_roles if @cached_roles
+
+  user_and_groups = [id] + ArUserGroup.where(ar_user_id: id).map(&:group_id)
+  @cached_roles = ArUserRole.where(ar_user_id: user_and_groups, active: true).select(&:active?).map(&:ar_role_id).uniq
+end
+
+##########################################################################
+# Helper for updating group membership
+##########################################################################
+def member_a=(value)
+  return if id.nil?
+
+  old = member_a
+  new = (value.is_a?(String) ? [value] : value).map(&:to_i)
+  remove = old - new
+  create = new - old
+  ArUserGroup.where(ar_user_id: id, :group_id => remove).delete_all if remove.present?
+  create.each { |e| ArUserGroup.create(ar_user_id: id, group_id: e) }
+end
+
+##########################################################################
+# Helper for updating group membership
+##########################################################################
+def member_a
+  ArUserGroup.where(ar_user_id: id).map(&:group_id)
+end
+
+##########################################################################
+# Will return all possible values for country field ready for input in select field. 
+# Values are loaded from github when method is first called.
+##########################################################################
+def self.choices_for_country
+  countries.map(&:reverse)
+end
+
+##########################################################################
+# Will return @@countries class variable
+##########################################################################
+def self.countries
+  return @@countries if @@countries
+
+  uri  = URI.parse("https://raw.githubusercontent.com/umpirsky/country-list/master/data/en/country.json")
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+
+  request  = Net::HTTP::Get.new(uri.request_uri)
+  response = http.request(request)
+  @@countries = JSON.parse(response.body)
+end
+
+##########################################################################
+# Performs logically test on passed email parameter.
+# 
+# Parameters:
+# [email] String: e-mail address
+# 
+# Returns:
+# Boolean: True if parameter is logically valid email address.
+# 
+# Example:
+#    if ! ArUser.is_email?(params[:email])
+#      flash[:error] = 'e-Mail address is not valid!'
+#    end
+# 
+##########################################################################
+def self.is_email?(email)
+  email.to_s =~ /^[a-zA-Z0-9][\w\.-]*[a-zA-Z0-9]@[a-zA-Z0-9][\w\.-]*[a-zA-Z0-9]\.[a-zA-Z][a-zA-Z\.]*[a-zA-Z]$/
+end
+
+##########################################################################
+# Will return list of available groups
+##########################################################################
+def self.groups_for_select
+  where(group: true, active: true).order(name: :asc).map { [_1.name, _1.id] }
+end
+
+##########################################################################
+# Will return list of available users without groups
+##########################################################################
+def self.users_for_select
+  where(group: false, active: true).order(name: :asc).map { [_1.name, _1.id] }
+end
+
+private
+
+##########################################################################
+# before_save callback takes care of name field and ensures that e-mail is unique
+# when entry is left empty.
+##########################################################################
+def do_before_save
+  self.name  = "#{title} #{first_name} #{middle_name if middle_name.present?} #{last_name}".squish
+  # to ensure unique e-mail
+  self.email = "unknown@#{id}" if email.blank?
+end
+
+##########################################################################
+# Create random password for groups. Must be done before validation
+##########################################################################
+def do_before_validation
+  if new_record? && group
+    self.password = ArUser.random_password(30)
+    self.password_confirmation = password
+  end
+end
+
+##########################################################################
+# Perform some additional validations
+##########################################################################
+def do_validate
+  if group && ArUserGroup.where(ar_user_id: id).present?
+    errors.add('member', I18n.t('errors.messages.present'))
+  end
+end
+
+##########################################################################
+# Will create random password
+##########################################################################
+def self.random_password(number)
+  charset = Array('A'..'Z') + Array('0'..'9') + Array('a'..'z')
+  Array.new(number) { charset.sample }.join
+end
+
+end
+
+end

data/app/renderers/agile_common_renderer.rb

@@ -0,0 +1,93 @@
+#--
+# 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.
+#+
+
+########################################################################
+# Renderer methods which may be useful on any site.
+########################################################################
+class AgileCommonRenderer <  AgileRenderer
+
+include AgileApplicationHelper
+
+########################################################################
+# Renderer for printer friendly layout. Will call another renderer which
+# should provide html code for printer friendly output.
+# 
+# Parameters are passed through link. There are currently two parameters, 
+# which define renderer and method to be used for creating output.
+# 
+# renderer::
+#  Defines renderer's class 
+# method::
+#  Defines renderer's class method
+########################################################################
+def layout_4print
+  return '' if @env.params[:renderer].blank?
+
+  opts = @opts.dup
+  opts[:method] = @env.params[:method]
+  klass = (@env.params[:renderer] + '_renderer').classify
+  obj   = Kernel.const_get(klass, Class.new).new(@env, opts)
+
+  html = obj.render_html
+  @css += obj.render_css.to_s
+  html
+end
+
+########################################################################
+# Renderer for Google analytics code.
+# 
+# Parameters:
+# Are passed through @opts hash and can therefore be set on site  
+# or page document parameters field as ga_acc key.
+#
+# Example:
+#    agile_render(:agile_common, method: 'google_analytics', code4: 'UA-12345678-9')
+########################################################################
+def google_analytics
+  html = ''
+  ga4_acc = @opts[:code4] || @opts[:ga4_acc]
+  if ga4_acc && ga4_acc != '/'
+    html << %(
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=#{ga4_acc}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '#{ga4_acc}');
+</script>)
+  end
+
+  html.html_safe
+end
+
+########################################################################
+# Return HTML part of code.
+########################################################################
+def render_html
+  method = @opts[:method] || 'default'
+  respond_to?(method) ? send(method) : "Error ArCommonRenderer: Method #{method} doesn't exist!"
+end
+
+end