trusty-cms 7.0.6 → 7.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1200948dac13c1012f25a55e977598239c22b70b3391008962b378c235fa6cb7
-  data.tar.gz: 6bdd05cafa5ff067e6a409bece0b952eed391e767260a0e069fbda25f46f68af
+  metadata.gz: 21602eb92fa965a61823801ab54c65663f5c91e13a5c379b0e6653868934285e
+  data.tar.gz: d479f8e082e2efc68e9feb96b461e3ebd66cf681ec6bb2a0c5e6f7cead81fb59
 SHA512:
-  metadata.gz: 92bba35d94a6c81c165d6e3aac5d54f3de2f5b51025a0c09d6187ab32aa14703c0bb8e6b9fe5a1f7d1a419fa540ce6d6db4bd06e6c3ef64be09c622b52f34184
-  data.tar.gz: 8b574e8d01b855debfb6b91859f589d79d111bcb9fe3b80eceb77d26a2ac65852cd3ab3693f727aa8a793a1f9a56ac05bb541af40f2cdae769583c07c1ba73e9
+  metadata.gz: 0a73dba1d21d9ad6998e71cb82aa8e704a63a173e66512d9aa029f26ce835e610356b58f321c5daad20e1cde525c1724fd222b3c571c2ea8ea062927f1f7f8a9
+  data.tar.gz: d12a09d633c3b63817c9fa725bd4b30d74d590cf69859d2d580348ba8bebf26ccc6c72bbda4aeae4d7f599a1cc69a2cb2c453d4ce85b68ce19af78f2e8255d31

data/Gemfile

@@ -7,6 +7,9 @@ source 'https://rubygems.org'
 # requires trusty and therefore pulls in every
 # dependency mentioned in trusty.gemspec.
 
+gem 'paper_trail'
+gem 'paper_trail-association_tracking'
+gem 'psych', '5.2.2'
 gem 'trustygems', '~> 0.2.0'
 
 gemspec
@@ -21,7 +24,6 @@ group :development, :test do
   gem 'mysql2'
   gem 'poltergeist', '~> 1.18.1'
   gem 'pry-byebug'
-  gem 'psych', '5.2.2'
   gem 'rails-observers'
   gem 'ransack'
   gem 'rspec-rails'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trusty-cms (7.0.6)
+    trusty-cms (7.0.7)
       RedCloth (= 4.3.3)
       activestorage-validator
       acts_as_list (>= 0.9.5, < 1.3.0)
@@ -165,7 +165,16 @@ GEM
     factory_bot_rails (6.4.4)
       factory_bot (~> 6.5)
       railties (>= 5.0.0)
-    ffi (1.17.0)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
     file_validators (3.0.0)
       activemodel (>= 3.2)
       mime-types (>= 1.0)
@@ -256,6 +265,11 @@ GEM
     nokogiri (1.17.2-x86_64-linux)
       racc (~> 1.4)
     orm_adapter (0.5.0)
+    paper_trail (16.0.0)
+      activerecord (>= 6.1)
+      request_store (~> 1.4)
+    paper_trail-association_tracking (2.2.1)
+      paper_trail (>= 12.0)
     poltergeist (1.18.1)
       capybara (>= 2.1, < 4)
       cliver (~> 0.3.1)
@@ -317,6 +331,8 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.11)
       io-console (~> 0.5)
+    request_store (1.7.0)
+      rack (>= 1.4)
     responders (3.1.1)
       actionpack (>= 5.2)
       railties (>= 5.2)
@@ -413,6 +429,8 @@ DEPENDENCIES
   file_validators
   launchy (~> 3.0.1)
   mysql2
+  paper_trail
+  paper_trail-association_tracking
   poltergeist (~> 1.18.1)
   pry-byebug
   psych (= 5.2.2)

data/app/controllers/admin/pages_controller.rb

@@ -1,6 +1,7 @@
 class Admin::PagesController < Admin::ResourceController
   before_action :initialize_meta_rows_and_buttons, only: %i[new edit create update]
   before_action :count_deleted_pages, only: [:destroy]
+  before_action :set_page, only: %i[edit restore]
   rescue_from ActiveRecord::RecordInvalid, with: :validation_error
 
   class PreviewStop < ActiveRecord::Rollback
@@ -38,9 +39,16 @@ class Admin::PagesController < Admin::ResourceController
     assets = Asset.order('created_at DESC')
     @term = assets.ransack(params[:search] || '')
     @term.result(distinct: true)
+    @versions = format_versions(@page.versions)
     response_for :edit
   end
 
+  def restore
+    index = params[:version_index].to_i
+    restore_page_version(@page, index)
+    redirect_to edit_admin_page_path(@page)
+  end
+
   def preview
     render_preview
   rescue PreviewStop => e
@@ -55,6 +63,10 @@ class Admin::PagesController < Admin::ResourceController
 
   private
 
+  def set_page
+    @page = Page.find(params[:id])
+  end
+
   def validation_error(e)
     flash[:error] = e.message
     render :new
@@ -67,6 +79,28 @@ class Admin::PagesController < Admin::ResourceController
     model.parent_id = params[:page_id]
   end
 
+  def format_versions(versions)
+    return nil unless versions.any?
+
+    versions
+      .sort_by(&:created_at).reverse
+      .map do |version|
+        {
+          index: version&.index,
+          update_date: version&.created_at&.strftime('%B %d, %Y'),
+          update_time: version&.created_at&.strftime('%I:%M %p'),
+          updated_by: User.unscoped.find_by(id: version&.whodunnit)&.name || 'Unknown User',
+        }
+      end
+  end
+
+  def restore_page_version(page, index)
+    lock_version = page.lock_version
+    restored_page = page.versions[index].reify(has_many: true)
+    restored_page.lock_version = lock_version
+    restored_page.save!
+  end
+
   def model_class
     if Page.descendants.any? { |d| d.to_s == params[:page_class] }
       verify_page_class(params[:page_class])

data/app/controllers/application_controller.rb

@@ -12,6 +12,7 @@ class ApplicationController < ActionController::Base
   before_action :force_utf8_params if RUBY_VERSION =~ /1\.9/
   before_action :set_standard_body_style, only: %i[new edit update create]
   before_action :set_mailer
+  before_action :set_paper_trail_whodunnit
 
   attr_accessor :trusty_config, :cache
   attr_reader :pagination_parameters

data/app/models/page.rb

@@ -1,6 +1,8 @@
 require 'trusty_cms/taggable'
 
 class Page < ActiveRecord::Base
+  has_paper_trail
+
   class MissingRootPageError < StandardError
     def initialize(message = 'Database missing root page')
       ; super
@@ -12,9 +14,9 @@ class Page < ActiveRecord::Base
 
   # Associations
   acts_as_tree order: 'position ASC'
-  has_many :parts, -> { order(:id) }, class_name: 'PagePart', dependent: :destroy
+  has_many :parts, -> { order(:id) }, class_name: 'PagePart', foreign_key: :page_id, autosave: true, dependent: :destroy
   accepts_nested_attributes_for :parts, allow_destroy: true
-  has_many :fields, -> { order(:id) }, class_name: 'PageField', dependent: :destroy
+  has_many :fields, -> { order(:id) }, class_name: 'PageField', foreign_key: :page_id, autosave: true, dependent: :destroy
   accepts_nested_attributes_for :fields, allow_destroy: true
   belongs_to :layout
   belongs_to :created_by, class_name: 'User'

data/app/models/page_field.rb

@@ -1,3 +1,4 @@
 class PageField < ActiveRecord::Base
+  has_paper_trail
   validates_presence_of :name
 end

data/app/models/page_part.rb

@@ -1,4 +1,6 @@
 class PagePart < ActiveRecord::Base
+  has_paper_trail
+
   # Default Order
   default_scope { order('name') }
 

data/config/initializers/paper_trail.rb

@@ -0,0 +1,2 @@
+PaperTrail.config.track_associations = true
+PaperTrail.config.version_limit = 5

data/config/routes.rb

@@ -13,6 +13,7 @@ TrustyCms::Application.routes.draw do
     resources :pages do
       resources :children, controller: 'pages'
       get 'remove', on: :member
+      put 'restore/:version_index', on: :member, to: 'pages#restore', as: :restore_version
     end
     resources :layouts do
       get 'remove', on: :member

data/db/migrate/20250102212417_create_versions.rb

@@ -0,0 +1,41 @@
+# This migration creates the `versions` table, the only schema PT requires.
+# All other migrations PT provides are optional.
+class CreateVersions < ActiveRecord::Migration[7.0]
+
+  # The largest text column available in all supported RDBMS is
+  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
+  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
+  # when serializing very large objects, `text` might not be big enough.
+  TEXT_BYTES = 1_073_741_823
+
+  def change
+    create_table :versions, options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" do |t|
+      # Consider using bigint type for performance if you are going to store only numeric ids.
+      # t.bigint   :whodunnit
+      t.string   :whodunnit
+
+      # Known issue in MySQL: fractional second precision
+      # -------------------------------------------------
+      #
+      # MySQL timestamp columns do not support fractional seconds unless
+      # defined with "fractional seconds precision". MySQL users should manually
+      # add fractional seconds precision to this migration, specifically, to
+      # the `created_at` column.
+      # (https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html)
+      #
+      # MySQL users should also upgrade to at least rails 4.2, which is the first
+      # version of ActiveRecord with support for fractional seconds in MySQL.
+      # (https://github.com/rails/rails/pull/14359)
+      #
+      # MySQL users should use the following line for `created_at`
+      # t.datetime :created_at, limit: 6
+      t.datetime :created_at
+
+      t.bigint   :item_id,   null: false
+      t.string   :item_type, null: false, limit: 191
+      t.string   :event,     null: false
+      t.text     :object, limit: TEXT_BYTES
+    end
+    add_index :versions, %i[item_type item_id]
+  end
+end

data/db/migrate/20250103191133_create_version_associations.rb

@@ -0,0 +1,23 @@
+# This migration and AddTransactionIdColumnToVersions provide the necessary
+# schema for tracking associations.
+class CreateVersionAssociations < ActiveRecord::Migration[7.0]
+  def self.up
+    create_table :version_associations do |t|
+      t.integer  :version_id
+      t.string   :foreign_key_name, null: false
+      t.integer  :foreign_key_id
+      t.string   :foreign_type
+    end
+    add_index :version_associations, [:version_id]
+    add_index :version_associations,
+      %i(foreign_key_name foreign_key_id foreign_type),
+      name: "index_version_associations_on_foreign_key"
+  end
+
+  def self.down
+    remove_index :version_associations, [:version_id]
+    remove_index :version_associations,
+      name: "index_version_associations_on_foreign_key"
+    drop_table :version_associations
+  end
+end

data/db/migrate/20250103191134_add_transaction_id_column_to_versions.rb

@@ -0,0 +1,13 @@
+# This migration and CreateVersionAssociations provide the necessary
+# schema for tracking associations.
+class AddTransactionIdColumnToVersions < ActiveRecord::Migration[7.0]
+  def self.up
+    add_column :versions, :transaction_id, :integer
+    add_index :versions, [:transaction_id]
+  end
+
+  def self.down
+    remove_index :versions, [:transaction_id]
+    remove_column :versions, :transaction_id
+  end
+end

data/lib/trusty_cms/version.rb

@@ -1,4 +1,4 @@
 module TrustyCms
-  VERSION = '7.0.6'.freeze
+  VERSION = '7.0.7'.freeze
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trusty-cms
 version: !ruby/object:Gem::Version
-  version: 7.0.6
+  version: 7.0.7
 platform: ruby
 authors:
 - TrustyCms CMS dev team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage-validator
@@ -854,6 +854,7 @@ files:
 - config/initializers/assets.rb
 - config/initializers/devise.rb
 - config/initializers/kraken.rb
+- config/initializers/paper_trail.rb
 - config/initializers/ransack.rb
 - config/initializers/response_cache_timeout.rb
 - config/initializers/secret_token.rb
@@ -912,6 +913,9 @@ files:
 - db/migrate/20200117141251_create_admin_users.rb
 - db/migrate/20210331134718_create_active_storage_tables.active_storage.rb
 - db/migrate/20241108172942_create_site_users.rb
+- db/migrate/20250102212417_create_versions.rb
+- db/migrate/20250103191133_create_version_associations.rb
+- db/migrate/20250103191134_add_transaction_id_column_to_versions.rb
 - db/schema.rb
 - lib/active_record_extensions/active_record_extensions.rb
 - lib/annotatable.rb