occams 1.0.7.2 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9fce10bdb602179a806185f8069a8121d8405e4e9e04839e433096572207342
-  data.tar.gz: 96efa1be357c97aa6659ff74cd865a9c4e7732880c0817469e6cee0da1bcb745
+  metadata.gz: fcc8760162308f5d0ad46ac82f46fa92be816f9e8c6ee291759709ddc472513e
+  data.tar.gz: f67e7efd920a103c3027e0201e824ee95bea38853893688ca7cbd9b0961d9a6d
 SHA512:
-  metadata.gz: d681988915ae056de2c763f86927cdd2c51cc2ca121f0b291e59c8a4fe2fa069a5b21cb9e7f5f3719605475da2425165497f2b702242ba9b71043c5dff99b8b5
-  data.tar.gz: 4bc6d9ac47bd585a3f966e5308d066a423c1eb57e80535f5d2df0eda335273324d5ebf13066d32dd7ea12c027bdaa347b9fc02aea7363229f8849f4efd6c9973
+  metadata.gz: aa7e678609d40af0dcd82a99a135f398006120c6b867a51a5814a7295f2540ec9771a21a0e972d64299e552b989b267748d35f8fe0c242b4fb2cc731e0086275
+  data.tar.gz: aaab1c6865ad43badee1f359c76fa3e45157f85ecb16f742c309c2ebd5de5430426745155f97fb619568d1d3280b2bdc21b33a9ba48f7e6eed763dcaa47a0ec9

data/.github/workflows/coveralls.yml

@@ -13,7 +13,7 @@ jobs:
           - "3.2"
         rails-version:
           - "7.0"
-        continue-on-error: [false]
+        continue-on-error: [true]
     name: ${{ format('Coverage (Ruby {0}, Rails {1})', matrix.ruby-version, matrix.rails-version) }}
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.continue-on-error }}
@@ -23,16 +23,18 @@ jobs:
       COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout source
+        uses: actions/checkout@v2
 
-      - name: Install Ruby
+      - name: Install Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-
-      - name: Set up Test DB
-        run: bin/rails db:migrate RAILS_ENV=test
-      - name: Run tests
-        run: bin/rake test
 
+      - name: Run tests, report coverage
+        run: |
+          bin/bundle install --retry 3 --quiet
+          bin/bundle exec rails db:drop
+          bin/bundle exec rails db:create
+          bin/bundle exec rails db:migrate
+          bin/bundle exec rails test:db

data/.github/workflows/rubyonrails.yml

@@ -6,17 +6,18 @@ on:
   pull_request:
 
 jobs:
-  test_lint_audit:
+  build_test_lint_audit:
     strategy:
       matrix:
         ruby-version:
           - "2.7"
           - "3.1"
           - "3.2"
+          - "3.3"
         rails-version:
           - "6.1"
           - "7.0"
-        continue-on-error: [false]
+        continue-on-error: [true]
     name: ${{ format('Tests (Ruby {0}, Rails {1})', matrix.ruby-version, matrix.rails-version) }}
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.continue-on-error }}
@@ -24,26 +25,27 @@ jobs:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.rails-version }}.gemfile
       RAILS_ENV: test
       SKIP_COV: true
-
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout source
+        uses: actions/checkout@v2
 
-      - name: Install Ruby
+      - name: Install Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
 
-      - name: Set up Test DB
-        run: bin/rails db:migrate RAILS_ENV=test
       - name: Run tests
-        run: bin/rake test
+        run: |
+          bin/bundle install --retry 3 --quiet
+          bin/bundle exec rails db:drop
+          bin/bundle exec rails db:create
+          bin/bundle exec rails db:migrate
+          bin/bundle exec rails test:db
 
-      - name: Ruby Lint
+      - name: Lint the code
         run: bin/bundle exec rubocop --parallel
 
-      - name: Security audit application code
-        run: bin/bundle exec brakeman -q -w3
-
-      - name: Security audit dependencies
-        run: bin/bundle exec bundler-audit --update --gemfile-lock gemfiles/${{ matrix.rails-version }}.gemfile.lock
+      - name: Audit for security
+        run: |
+          bin/bundle exec brakeman -q -w3
+          bin/bundle exec bundler-audit --update --gemfile-lock gemfiles/${{ matrix.rails-version }}.gemfile.lock

data/.gitignore

@@ -1,22 +1,24 @@
 .bundle
-db/*.sqlite3
-log/*.log
-tmp/**/*
 .DS_Store
-db/schema.rb
-db/development_structure.sql
-db/test.sqlite3-journal
-pkg
-rdoc
-/tmp
-public/system/
-Gemfile.lock
-gemfiles/*.gemfile.lock
-.rvmrc
-.ruby-version
+.idea
 .ruby-gemset
+.ruby-version
+.rvmrc
+.vscode
 /.sass-cache
-coverage/
 /storage
+/tmp
+coverage/
+db/*.sqlite3
 db/cms_fixtures/test-site/
-.idea
+db/development_structure.sql
+db/schema.rb
+db/test.sqlite3*
+Gemfile.lock
+gemfiles/*.gemfile.lock
+log/
+pkg
+public/system/
+rdoc
+tmp/**/*
+vendor/bundle/

data/CHANGELOG.md

@@ -1,13 +1,29 @@
 # Changelog
 
-## v1.0.7.2 - 9/27/2023
+## v1.0.8 - 29 December 2023
+
+- Updated configs, et al. in pursuit of Rails 7.1 compatibility
+- Added explicit coder for serialize commands
+- Added ActiveRecord Adapter (database) info to admin footer
+- Added commented defaults for MySQL and Postgres to database.yml
+- Updated documentation
+- Refactored lib files for better test coverage awareness
+
+## v1.0.7.3 - 7 October 2023
+
+- Fixed edge case with siblings tag when current page is excluded
+- Git ignore all sqlite* files for testing
+- Small testing refinements
+- Prep for Rails 7.1 compatibility
+
+## v1.0.7.2 - 27 September 2023
 
 - Pulled will_paginate option out in favor of Kaminari
 - Switched CI from Buildkite to [Github actions](https://github.com/avonderluft/occams/actions/workflows/rubyonrails.yml)
 - Improved test coverage to 99+
 - Removed backward compatibility to Rails prior to 6.x
 
-## v1.0.7.1 - 9/22/2023
+## v1.0.7.1 - 22 September 2023
 
 - Addressed deprecations for file type 'image/jpg'
 - Added github workflow for tests, lints and audits
@@ -15,7 +31,7 @@
 - Bumped rubocop version to latest
 - Updated some testing parameters
 
-## v1.0.7 - 9/12/2023
+## v1.0.7 - 12 September 2023
 
 - Updated coveralls Coverage reporting
 - Added minitest-reporters for test output
@@ -24,33 +40,33 @@
 - Lints and 1 typo
 - Added Build Status and Coveralls Coverage Status to README
 
-## v1.0.6.1 - 9/5/2023
+## v1.0.6.1 - 5 September 2023
 
 - Fixed siblings and children nav tags which as written had problems creating child pages in the admin panel
 
-## v1.0.6 - 9/5/2023
+## v1.0.6 - 5 September 2023
 
 - Fixed [cms:siblings Nav tag](https://github.com/avonderluft/occams/wiki/Content-Tags#siblings) to handle edge case when page(s) are excluded by the `exclude` parameter
 - Added [cms:children Nav tag](https://github.com/avonderluft/occams/wiki/Content-Tags#children) to render unordered list of links for children of current page
 
-## v1.0.5 - 8/31/2023
+## v1.0.5 - 31 August 2023
 
 - All tests now green on Rails 6.1 and 7.0, each tested with rubies 2.7.8, 3.1.4 and 3.2.2.
 - Tests added for new tags
 - TODO: set up CI pipeline
 
-## v1.0.4 - 8/26/2023
+## v1.0.4 - 26 August 2023
 
 - Added [cms:breadcrumbs Nav tag](https://github.com/avonderluft/occams/wiki/Content-Tags#breadcrumbs)
 - Added [cms:siblings Nav tag](https://github.com/avonderluft/occams/wiki/Content-Tags#siblings)
 - Updated [wiki documentation](https://github.com/avonderluft/occams/wiki)
 
-## v1.0.3 - 8/15/2023
+## v1.0.3 - 15 August 2023
 
 - Added a [cms:audio tag](https://github.com/avonderluft/occams/wiki/Content-Tags#audio) for an embedded audio player
 - Some formatting of admin menu footer
 
-## v1.0.2 - 8/14/2023
+## v1.0.2 - 14 August 2023
 
 - Fixed image rendering which rubocop broke in v1.0.1
 - Show unpublished pages in Rails development mode
@@ -58,14 +74,14 @@
 - Updated documentation at [Occams Wiki](https://github.com/avonderluft/occams/wiki) 
 - Comprehensive rubocop linting
 
-## v1.0.1 - 8/7/2023
+## v1.0.1 - 7 August 2023
 
 - Fixed image thumbnail hover for Rails 7
 - Added display of Rails and Ruby versions along with Occams version at foot of Admin menu
 - Refined gemspec dependencies
 - Tweaked with a bunch of rubocop linting
 
-## v1.0.0 - 8/5/2023
+## v1.0.0 - 5 August 2023
 
 - Copied the original [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa)
 - Added the changes from [Restarone's fork](https://github.com/restarone/comfortable-mexican-sofa) (23 commits)

data/CONTRIBUTING.md

@@ -24,12 +24,11 @@ Fork the project. Optionally, create a branch you want to work on.
 - Tests please, but nothing complicated. UnitTest / Fixtures all the way. Make sure all tests pass.
 - Run `bundle exec rubocop` and fix any issues raised.
 
-### 4. Make a pull request
+### 4. Create a pull request
 
 - If you never done it before read this: https://help.github.com/articles/using-pull-requests
-- When PR is submitted check if TravisCI ran all tests successfully and Rubocop didn't raise any issues
+- When PR is submitted check if [Github Actions](https://github.com/avonderluft/occams/actions) ran all tests successfully and Rubocop didn't raise any issues
 
 ### 5. Done!
 
-If everything is good your changes will be merged into master branch. Eventually
-a new version of gem will be published.
+If everything looks good, we will review your changes to be merged into the main branch, and publish a new version of the gem.

data/Gemfile

@@ -5,16 +5,15 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem 'rails', '~> 7.0'
+gem 'rails', '~> 7.0.0'
 
 group :development, :test do
   gem 'autoprefixer-rails', '~> 8.1.0'
   gem 'byebug',             '~> 10.0.0', platforms: %i[mri mingw x64_mingw]
-  gem 'capybara',           '~> 3.39.0'
   gem 'image_processing',   '>= 1.2'
-  gem 'kaminari',           '~> 1.2', '>= 1.2.2'
-  gem 'selenium-webdriver', '~> 4.9.0'
-  gem 'sqlite3',            '~> 1.4.2'
+  gem 'sqlite3',            '~> 1.6.7'
+  # gem 'mysql2',             '~> 0.5'
+  # gem 'pg',                 '~> 1.5.4'
 end
 
 group :development do
@@ -25,12 +24,15 @@ end
 group :test do
   gem 'brakeman',                 '~> 5.4.1'
   gem 'bundler-audit',            '~> 0.9.1'
+  gem 'capybara',                 '~> 3.39.0'
   gem 'coveralls_reborn',         '~> 0.28.0', require: false
+  gem 'cuprite',                  '~> 0.14.3'
   gem 'diffy',                    '~> 3.4.2'
   gem 'equivalent-xml',           '~> 0.6.0'
   gem 'minitest',                 '~> 5.20.0'
   gem 'minitest-reporters',       '~> 1.6.1'
   gem 'mocha',                    '~> 2.1.0', require: false
+  gem 'puma',                     '~> 6.4.0'
   gem 'rails-controller-testing', '~> 1.0.5'
   gem 'rubocop',                  '~> 1.56.0', require: false
   gem 'simplecov',                '~> 0.22.0', require: false

data/README.md

@@ -4,7 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/avonderluft/occams/badge.svg?branch=main)](https://coveralls.io/github/avonderluft/occams?branch=main)
 [![Gem Version](https://img.shields.io/gem/v/occams.svg?style=flat)](http://rubygems.org/gems/occams)
 [![Gem Downloads](https://img.shields.io/gem/dt/occams.svg?style=flat)](http://rubygems.org/gems/occams)
-[![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/avonderluft/occams)](https://github.com/avonderluft/occams/releases)
+[![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/avonderluft/occams?label=last%20release&color=seagreen)](https://github.com/avonderluft/occams/releases)
 
 ***Prefer Simplicity.***
 
@@ -47,8 +47,9 @@ ocCaM'S, pronounced "AH-kums" is a nod to [Occam's Razor](https://en.wikipedia.o
 
 ## Compatibility
 
-- [Test suite](https://github.com/avonderluft/occams/actions/workflows/rubyonrails.yml) on Ruby 2.7, 3.1 and 3.2 with Rails 6.1 and 7.0+
-- On Ruby 3.2, Rails 7+ is recommended, since performance is noticably better than 6
+- [Test suite](https://github.com/avonderluft/occams/actions/workflows/rubyonrails.yml) on Ruby >= 2.7 with Rails >= 6.1
+- On Ruby 3.2, Rails 7.x + is recommended, since performance is noticably better than on 6.x
+- Sites do run on Rails 7.1, e.g. [GKNT](https://gknt.org/), but some tests fail in [Github Actions](https://github.com/avonderluft/occams/actions). Your mileage may vary.
 
 ## Installation
 

data/app/models/concerns/occams/cms/with_fragments.rb

@@ -77,7 +77,7 @@ module Occams::Cms::WithFragments
   # duplicate tags on the layout. That's wierd (but still works).
   def fragment_nodes
     nodes
-      .select { |n| n.is_a?(Occams::Content::Tag::Fragment) }
+      .select { |n| n.is_a?(Occams::Content::Tags::Fragment) }
       .uniq(&:identifier)
   end
 

data/app/models/occams/cms/fragment.rb

@@ -5,7 +5,7 @@ class Occams::Cms::Fragment < ActiveRecord::Base
 
   has_many_attached :attachments
 
-  serialize :content
+  serialize :content, coder: Psych
 
   attr_reader :files
 

data/app/models/occams/cms/layout.rb

@@ -3,6 +3,8 @@
 class Occams::Cms::Layout < ActiveRecord::Base
   self.table_name = 'occams_cms_layouts'
 
+  require_relative '../../../../lib/occams/extensions/acts_as_tree'
+
   cms_acts_as_tree
   cms_has_revisions_for :content, :css, :js
 
@@ -67,7 +69,7 @@ class Occams::Cms::Layout < ActiveRecord::Base
     tokens    = renderer.tokenize(content)
 
     if parent
-      fragment_tags = Occams::Content::Tag::Fragment.subclasses.map do |c|
+      fragment_tags = Occams::Content::Tags::Fragment.subclasses.map do |c|
         Occams::Content::Renderer.tags.key(c)
       end
 

data/app/models/occams/cms/revision.rb

@@ -3,7 +3,7 @@
 class Occams::Cms::Revision < ActiveRecord::Base
   self.table_name = 'occams_cms_revisions'
 
-  serialize :data
+  serialize :data, coder: Psych
 
   # -- Relationships --------------------------------------------------------
   belongs_to :record, polymorphic: true

data/app/views/layouts/occams/admin/cms/_left.html.haml

@@ -42,5 +42,5 @@
   = link_to 'Ruby', 'https://www.ruby-lang.org', target: '_blank'
   %span.version= RUBY_VERSION
   %br
-  = Rails.env.upcase
+  = Rails.env.upcase + ' - ' + ActiveRecord::Base.connection.adapter_name
 

data/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../config/application', __dir__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/bin/setup

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
-require 'fileutils'
+require "fileutils"
 
 # path to your application root.
-APP_ROOT = File.expand_path('..', __dir__)
+APP_ROOT = File.expand_path("..", __dir__)
 
 def system!(*args)
-  system(*args) || abort("\n== Command #{args} failed ==")
+  system(*args, exception: true)
 end
 
 FileUtils.chdir APP_ROOT do
@@ -13,21 +13,21 @@ FileUtils.chdir APP_ROOT do
   # This script is idempotent, so that you can run it at any time and get an expectable outcome.
   # Add necessary setup steps to this file.
 
-  puts '== Installing dependencies =='
-  system! 'gem install bundler --conservative'
-  system('bundle check') || system!('bundle install')
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
 
   # puts "\n== Copying sample files =="
-  # unless File.exist?('config/database.yml')
-  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # unless File.exist?("config/database.yml")
+  #   FileUtils.cp "config/database.yml.sample", "config/database.yml"
   # end
 
   puts "\n== Preparing database =="
-  system! 'bin/rails db:setup'
+  system! "bin/rails db:prepare"
 
   puts "\n== Removing old logs and tempfiles =="
-  system! 'bin/rails log:clear tmp:clear'
+  system! "bin/rails log:clear tmp:clear"
 
   puts "\n== Restarting application server =="
-  system! 'bin/rails restart'
+  system! "bin/rails restart"
 end

data/config/application.rb

@@ -10,10 +10,31 @@ Bundler.require(*Rails.groups)
 
 module Occams
   class Application < Rails::Application
-    require_relative '../lib/occams'
+    # Load defaults based on Rails major/minor version
+    config.load_defaults Rails.version.scan(%r{^\d+\.\d+}).first.to_f
+
+    # Rails 7.1 compatibility - See config/initializers/new_framework_defaults_7_1.rb
+    config.add_autoload_paths_to_load_path = true
+
+    if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0')
+      config.active_record.default_column_serializer = YAML
+      config.active_record.before_committed_on_all_records = false
+      config.active_record.commit_transaction_on_non_local_return = false
+      config.active_record.run_after_transaction_callbacks_in_order_defined = false
+      config.active_support.message_serializer = :json
+      config.active_record.run_commit_callbacks_on_first_saved_instances_in_transaction = true
+      # config.active_record.allow_deprecated_singular_associations_name = true
+      # config.active_support.raise_on_invalid_cache_expiration_time = false
+      # config.active_record.sqlite3_adapter_strict_strings_by_default = false
+      # config.active_support.cache_format_version = 7.0
+      # Please, add to the `ignore` list any other `lib` subdirectories that do
+      # not contain `.rb` files, or that should not be reloaded or eager loaded.
+      # Common ones are `templates`, `generators`, or `middleware`, for example.
+      config.autoload_lib(ignore: %w[generators])
+    end
 
-    # Initialize configuration defaults for originally generated Rails version.
-    config.load_defaults 6.1
+    # Making sure we don't load our dev routes as part of the engine
+    config.paths['config/routes.rb'] << 'config/cms_routes.rb'
 
     # Configuration for the application, engines, and railties goes here.
     #
@@ -25,11 +46,15 @@ module Occams
     # Ensuring that all ActiveStorage routes are loaded before out globbing route.
     config.railties_order = [ActiveStorage::Engine, :main_app, :all]
 
-    # Making sure we don't load our dev routes as part of the engine
-    config.paths['config/routes.rb'] << 'config/cms_routes.rb'
-
     config.i18n.enforce_available_locales = true
 
-    config.active_record.yaml_column_permitted_classes = [Symbol, Date, Time, ActiveSupport::TimeWithZone, ActiveSupport::TimeZone]
+    config.active_record.yaml_column_permitted_classes = [
+      Symbol,
+      Date,
+      Time,
+      ActiveSupport::TimeWithZone,
+      ActiveSupport::TimeZone,
+      ActiveSupport::SafeBuffer
+    ]
   end
 end

data/config/boot.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-
-File.exist? ENV.fetch('BUNDLE_GEMFILE')
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/config/database.yml

@@ -8,4 +8,33 @@ test:
   adapter: sqlite3
   database: db/test.sqlite3
   pool: 5
-  timeout: 10000
+  timeout: 10000
+
+# default: &default
+#   adapter: mysql2
+#   encoding: utf8mb4
+#   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+#   username: root
+#   password:
+#   socket: /tmp/mysql.sock
+#
+# development:
+#   <<: *default
+#   database: occams_dev
+#
+# test:
+#   <<: *default
+#   database: occams_test
+
+# default: &default
+#   adapter: postgresql
+#   encoding: unicode
+#   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+#
+# development:
+#   <<: *default
+#   database: occams_dev
+#
+# test:
+#   <<: *default
+#   database: occams_test

data/config/environments/development.rb

@@ -8,7 +8,7 @@ defined?(Occams::Application) && Occams::Application.configure do
   # In the development environment your application's code is reloaded any time
   # it changes. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
+  config.enable_reloading = true
 
   # Do not eager load code on boot.
   config.eager_load = false
@@ -55,22 +55,15 @@ defined?(Occams::Application) && Occams::Application.configure do
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
-
   # Highlight code that triggered database queries in logs.
   config.active_record.verbose_query_logs = true
 
+  # Highlight code that enqueued background job in logs.
+  config.active_job.verbose_enqueue_logs = true
+
   # Suppress logger output for asset requests.
   config.assets.quiet = true
 
-  # Use an evented file watcher to asynchronously detect changes in source code,
-  # routes, locales, etc. This feature depends on the listen gem.
-  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
-
-  config.active_job.queue_adapter = :inline
   # Raises error for missing translations.
   # config.i18n.raise_on_missing_translations = true
 
@@ -79,4 +72,9 @@ defined?(Occams::Application) && Occams::Application.configure do
 
   # Uncomment if you wish to allow Action Cable access from any origin.
   # config.action_cable.disable_request_forgery_protection = true
+
+  if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0')
+    # Raise error when a before_action's only/except options reference missing actions
+    config.action_controller.raise_on_missing_callback_actions = true
+  end
 end