agile_rails 0.0.0.1 → 0.0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08739e1d1287c45f07d7b2482c2fb79e59d9e80353634dfa9ef6656274407839'
-  data.tar.gz: 5a903cfee39845a30cd8255265fdabb98d5d34c2fc901efe1735d3a484e05111
+  metadata.gz: 18dcbd28e6f1f0d840016fadd4a0ffc75da43233dac60f772b67d36de0a9f534
+  data.tar.gz: 19c2c9e047772cf7e26ad2073093803f9dd090cde50090931041ba94dfcd5a54
 SHA512:
-  metadata.gz: ffb1a266a35777275e6d81702e7a0d53ca31491e3a6bfe63e6fa2a803714922d4d2060ed5eed674ed45abae70e1e87837ee475fe85f9f0bffc33cc38148bd700
-  data.tar.gz: 6d6951e3be9ce0d1b1b98f02fbb964ef6ef50b449318f1f4cf1ac796b000f1754de4a1ffcf22fa6e4a0b7e5bd9ff29004e7ddd92991734c29fa261a86543ec1c
+  metadata.gz: 3db8f8adb6b0e7c495cc43c2fe08e6f699ac69efda6371ff24cf9afe769b890637f4f962b3352501ab2d5fcdcaba147e6400411c27865af480df3582abb26a8c
+  data.tar.gz: 7824f2db93018f2f72f8247e76af3b3c83172be2a9a0b2ff9985199cc7ae219746af44cee0425261f263ae05dc3f4e5f8bc0ddc0e85a7795ed982c7e5a72d29e

data/CHANGELOG.md

@@ -1,5 +1,4 @@
-See [GitHub Releases](https://github.com/damjan-rems/agile-rails/releases) for all future releases
 
 ## Changes
 
-## [0.7.1.0] - Initial release
+### [0.0.0.1] - Initial release

data/README.md

@@ -3,23 +3,27 @@
 [![Gem Version](http://img.shields.io/gem/v/agile_rails.svg)](https://rubygems.org/gems/agile_rails)
 [![Gem Downloads](https://img.shields.io/gem/dt/agile_rails.svg)](https://rubygems.org/gems/agile_rails)
 
-You can find introduction videos on YouTube: https://www.youtube.com/playlist?list=PLM66pztpUC0DVAqZvIAqH3Khb_RzJdD3W
+Watch introduction videos on YouTube: https://www.youtube.com/playlist?list=PLM66pztpUC0DVAqZvIAqH3Khb_RzJdD3W
 
-Agile Rails simplifies the programming of business Intranet applications. 
+## What is AgileRails
+
+AgileRails simplifies the programming of business Intranet applications with Ruby on Rails. 
 Minimal database experience and only basic programming skills are needed 
 to create a data entry program. You can do it in 6 simple steps.
 
 Step 1: Know your data and create Rails migration and model<br>
-Step 2: Generate Agile Rails form<br>
+Step 2: Generate AgileRails form<br>
 Step 3: Edit form to your requirements<br>
 Step 4: Define Labels and Help Text<br>
 Step 5: Create additional logic in Controls File (if required)<br>
 Step 6: Include in application menu<br>
 
-Most of the time, you will end up with just 3 source files.
+Most of the time, you will end up with 3 source files.
+
+#### 1. Migration file
 
-<b>1. Migration file:</b> Rails uses migrations to make changes to the database 
-schema, such as creating tables or altering columns. 
+Rails uses migrations to make changes to the database 
+schema, such as creating tables or altering table attributes. 
 
 An example of migration file.
 ```ruby
@@ -42,7 +46,10 @@ class Diary < ActiveRecord::Migration[7.0]
 end
 ```
 
-<b>2 Model file:</b> Model's primary purposes is to represent the data and logic 
+
+#### 2. Model file
+
+Model's primary purposes is to represent the data and logic 
 of the application. It contains business logic, relations between data, validations
 
 An example of a typical model file:
@@ -73,7 +80,10 @@ end
 end
 ```
 
-<b>3. Form file:</b> AgileRails Form's purpose is to define data entry fields and actions which can be taken on data.
+
+#### 3. Form file 
+
+AgileRails Form's purpose is to define data entry fields and actions which can be taken on data.
 It contains two main sections.
 
 <b>index:</b> Defines view on table data (data_set) and actions that can be performed on 
@@ -229,31 +239,28 @@ On the first level administrator defines roles and roles rights as web site poli
 if user can view content or not or if user can edit content. Roles are then assigned to users 
 and policies are assigned to documents (web content), parts of content, menus ...
 <br>
-Second level defines roles which can access database data. Each database table can have defined which 
-user roles can read, edit, create or delete records in a table.
+Second level defines roles to access database tables. Each table can have defined which 
+user roles can read, edit, create or delete records.
 <br><br>
 Integrates journal with options to undo single field
 <br><br>
 Integrates CK Editor as HTML editor and ElFinder file manager with with drag & drop support through 
 agile_rails_html_editor gem.
 
-## Installation
-
-Go and [jumpstart](https://github.com/agile-rails/agile-rails-jumpstart)
-internal portal application with AgileRails in just few minutes.
+Installation
+------------
+Go and [jumpstart](https://github.com/agile-rails/startup/README.md)
+Intranet portal application with AgileRails in just few minutes.
 
 Compatibility
 -------------
-
 Technology behind AgileRails is being actively developed since 2012 and has been live tested in production 
-since early days. It runs against latest technology Ruby (3.3), Rails (7.1) 
+since early days. It runs against latest technology Ruby (>= 3.2), Rails (>= 7.2) 
 and had so far little or no problems advancing to latest versions of Ruby or Ruby on Rails.
 
 Documentation
 -------------
-
-Please see the agile-rails.com website for more information:
-[agilerails.zop.si](http://agilerails.zop.si)
+Visit the [agile-rails.com](https://agile-rails.com) website for more information:
 
 License (MIT LICENCE)
 ---------------------

data/agile_rails.gemspec

@@ -12,15 +12,15 @@ Gem::Specification.new do |s|
   s.authors     = ['Damjan Rems']
   s.email       = ['damjan.rems@gmail.com']
   s.homepage    = 'https://agile-rails.com'
-  s.summary     = 'Agile Rails: Agile application development tool and CMS for Ruby on Rails'
-  s.description = 'Agile Rails, development tool for agile development of in-house (Intranet, business, private cloud) applications as well as CMS for creating complex, data-entry intensive web sites.'
+  s.summary     = 'AgileRails: Agile business application development tool and CMS for Ruby on Rails'
+  s.description = 'AgileRails, development tool for agile development of in-house (Intranet, business, private cloud) applications as well as CMS for creating complex, data-entry intensive web sites.'
   s.license     = 'MIT'
   s.files       = Dir['{app,config,db,lib}/**/*'] + %w[MIT-LICENSE Rakefile README.md CHANGELOG.md agile_rails.gemspec]
   #s.test_files  = Dir['test/**/*']
 
   s.metadata['homepage_uri'] = s.homepage
-  s.metadata['source_code_uri'] = 'https://github.com/agile-rails'
-  s.metadata['changelog_uri'] = 'https://github.com/agile-rails/changelog'
+  s.metadata['source_code_uri'] = 'https://github.com/agile-rails/agile-rails'
+  s.metadata['changelog_uri'] = 'https://github.com/agile-rails/agile-rails/CHANGELOG.md'
 
   s.required_ruby_version = '> 3.1'
 

data/app/renderers/ar_common_renderer.rb

@@ -24,19 +24,19 @@
 ########################################################################
 # Renderer methods which may be useful on any site.
 ########################################################################
-class AgileCommonRenderer <  AgileRenderer
+class ArCommonRenderer < 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, 
+#
+# 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 
+#  Defines renderer's class
 # method::
 #  Defines renderer's class method
 ########################################################################
@@ -55,16 +55,16 @@ 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. You may also disable sending 
-# 
-# 
+# Are passed through @opts hash and can therefore be set on site
+# or page document parameters field as ga_acc key. You may also disable sending
+#
+#
 # If eu_cookies_allowed function is defined in javascript libraries it will be
-# called and if false is returned GA code will not be executed. This is in 
+# called and if false is returned GA code will not be executed. This is in
 # order with European cookie law.
-# 
+#
 # Example:
 #    agile_render(:agile_common_renderer, method: 'google_analytics', code4: 'UA-12345678-9')
 ########################################################################

data/lib/agile/version.rb

@@ -23,5 +23,5 @@
 
 # Agile gem version
 module Agile # :nodoc:
-  VERSION = '0.0.0.1'.freeze
+  VERSION = '0.0.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agile_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1
+  version: 0.0.0.2
 platform: ruby
 authors:
 - Damjan Rems
@@ -121,7 +121,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Agile Rails, development tool for agile development of in-house (Intranet,
+description: AgileRails, development tool for agile development of in-house (Intranet,
   business, private cloud) applications as well as CMS for creating complex, data-entry
   intensive web sites.
 email:
@@ -274,7 +274,6 @@ files:
 - app/models/ar_image.rb
 - app/models/ar_internals.rb
 - app/models/ar_journal.rb
-- app/models/ar_json_ld.rb
 - app/models/ar_key_value_store.rb
 - app/models/ar_link.rb
 - app/models/ar_memory.rb
@@ -300,9 +299,6 @@ files:
 - app/models/ar_visit.rb
 - app/models/concerns/ar_page_concern.rb
 - app/models/concerns/ar_part_concern.rb
-- app/models/concerns/ar_piece_concern.rb
-- app/models/concerns/ar_policy_rule_concern.rb
-- app/models/concerns/ar_seo_concern.rb
 - app/models/concerns/ar_site_concern.rb
 - app/models/concerns/ar_user_concern.rb
 - app/renderers/agile_common_renderer.rb
@@ -392,8 +388,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://agile-rails.com
-  source_code_uri: https://github.com/agile-rails
-  changelog_uri: https://github.com/agile-rails/changelog
+  source_code_uri: https://github.com/agile-rails/agile-rails
+  changelog_uri: https://github.com/agile-rails/agile-rails/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -410,5 +406,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: 'Agile Rails: Agile application development tool and CMS for Ruby on Rails'
+summary: 'AgileRails: Agile business application development tool and CMS for Ruby
+  on Rails'
 test_files: []

data/app/models/ar_json_ld.rb

@@ -1,131 +0,0 @@
-#--
-# 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/concerns/ar_piece_concern.rb

@@ -1,48 +0,0 @@
-#--
-# 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

@@ -1,87 +0,0 @@
-#--
-# 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

@@ -1,66 +0,0 @@
-#--
-# 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