[WIP] Replace Comfortable Mexican Sofa with Comfortable Media Surfer Gem; address #737 by jefferya · Pull Request #885 · ualbertalib/library-cms

jefferya · 2025-11-06T23:59:52Z

Address #737

Depends on PR #884, Rails 8.1 PR to be merged first.

⚠️ Requires DB migration and should be tested with a production DB dump
⚠️ May require changes to the RPM build pipeline: new Gem requires an installation of npm which is used by bundle exec rails comfy:compile_assets. comfy:compile_assets installs NPM modules and bundles JS/CSS for the CMS Engine Gem.

Comfortable Mexican Sofa is no longer being supported. Comfortable Media Surfer Gem is a fork that is being actively updated. This PR is the replacement.

How to test in staging and prod; these pass in dev:

public pages visible and align with production (need to update seed data in GitHub and staging site)
login to the admin interface, if application log errors regarding missing JavaScript/CSS then check if comfy:compile_assets was successful
check pages with cms:snippet like "ask-us" work; if errors like markdown not found then the DB migration might be missing

Todo:

Add a how to test section? Highlight need to test pages with cms:snippet like "ask-us" due to errors like markdown not found (see DB migration for the reason). There might be more.
Update seeds with production data Update Seeds #803
Update staging with production data
what does comfy_bootrap_form do? is it required? - YES
dump schema: Rails 8.1 will sort column names in the schema - is this a problem? No but test
GitHub Action tests fail but tests pass locally. Local test passed due to preexisting javascript/CSS bundles (./tmp/sprockets and ./tmp/cache). Resting local generates similar errors as GitHub action. The error:

Error:
CmsAdminTest#test_admin_site_pages_index:
ActionView::Template::Error: Error: File to import not found or unreadable: codemirror/lib/codemirror.
        on line 3:1 of vendor/bundle/ruby/3.3.0/gems/comfortable_media_surfer-3.1.4/app/assets/stylesheets/comfy/admin/cms/application.sass
>> @import "codemirror/lib/codemirror";
   ^
    test/integration/cms_admin_test.rb:27:in `block in <class:CmsAdminTest>'
bin/rails test test/integration/cms_admin_test.rb:26

Resolution:

Assets not built in the new CMS Gem / rails engine triggering the "not found error"
The new CMS Gem / Rails Engine doesn't compile assets whereas the previous Gem included the vendored assets in the Gem within the directory app/assets/javascript/comfy/vendor and assets:precompile used the path in lib/comfortable_mexican_sofa/engine.rb to obtain the assets.
Resolution option (1): hook lib/tasks/comfy.rake CMS task onto the assets:precompile task Rake::Task["assets:precompile"].enhance(["comfy:compile_assets"])
The order of operations when sprocket-rails controls the assets:precompile means that adding the .enhance(["comfy:compile_assets"]) to Rake::Task["assets:precompile"] yields missing assets or a esbulid version collision because the CMS Gem includes a JS version lock file (not best practice).
Solution: for now, run comfy:compile_assets as a separate task after codebase is available but before assets:precompile

…urfer@46b673f

* Markdown not found error when cms:snippet interpreted in "ask-us" and "" page tests and when accessing web UI Process: * bin/rails railties:install:migrations (to get migration) * bin/rails db:migrate:status * bin/rails db:migrate

jefferya · 2025-11-07T16:18:12Z

config/application.rb

-
-    ###
-    # Disable automatic column serialization into YAML.
-    # To keep the historic behavior, you can set it to `YAML`, however it is
-    # recommended to explicitly define the serialization method for each column
-    # rather than to rely on a global default.
-    ###
-    # Rails.application.config.active_record.default_column_serializer = nil
-    # comfortable_mexican_sofa v3.5 https://github.com/restarone/comfortable-mexican-sofa.git
-    # not updated for Rails 7.1 to specify serialization method for the
-    # Comfy::Cms::Fragment and Comfy::Cms::Revision models
-    Rails.application.config.active_record.default_column_serializer = YAML


the change to Comfortable Media Surfer means this workaround is no longer required.

jefferya · 2025-12-04T16:55:39Z

.github/workflows/ci.yml

+      - name: Compile CMS Engine assets
+        run: bundle exec rails comfy:compile_assets
+        env:
+          RAILS_ENV: test
+


Required to install and build the CMS Engine's javascript and CSS. The new Gem doesn't include the vendor javascript libraries and bundles.

jefferya · 2025-12-04T16:56:14Z

.github/workflows/ci.yml

+      - name: Test - precompile Rails assets
+        run: bundle exec rails assets:precompile
+        env:
+          RAILS_ENV: test
+


Add a test to see if assets:precompile works.

jefferya · 2025-12-04T16:58:52Z

db/migrate/20251106234626_add_markdown_to_snippets.comfortable_media_surfer_engine.rb

+# frozen_string_literal: true
+
+# This migration comes from comfortable_media_surfer_engine (originally 2)
+# null: false added by rubocop, not in original migration
+class AddMarkdownToSnippets < ActiveRecord::Migration[7.1]
+  def change
+    add_column :comfy_cms_snippets, :markdown, :boolean, default: false, null: false
+  end
+end


DB migration for the new CSM Gem. PR includes a warning to highlight the need.

jefferya added 6 commits November 4, 2025 15:10

Update from Rails 7.2.x to 8.0.x; address #880

af9a23a

Bump rails from 8.0 to 8.1; address #880

ca7555f

Update comfortable-mexican-sofa to ComfortableMediaSurfer; addresss #737

6744daf

Remove default colume serializer due to shakacode/comfortable-media-s…

31d6a5d

…urfer@46b673f

Readme updates.

29b0556

jefferya force-pushed the jefferya/737_comfy_gem branch from 964b1d1 to 1b68816 Compare November 7, 2025 15:57

jefferya commented Nov 7, 2025

View reviewed changes

jefferya mentioned this pull request Nov 7, 2025

comfy gem maintenance #737

Open

Include DB schema change required by robocop.

aecfd4b

jefferya force-pushed the jefferya/737_comfy_gem branch 3 times, most recently from e5d5484 to aecfd4b Compare December 4, 2025 00:05

Infrastructure to compile CMS Rails Engine assets.

12d6542

jefferya force-pushed the jefferya/737_comfy_gem branch from 50f005b to 12d6542 Compare December 4, 2025 00:39

Update bin/setup to include comfy:compile_assets

1074f10

jefferya commented Dec 4, 2025

View reviewed changes

This was referenced Jan 20, 2026

Update to ruby 3.3.10 #910

Merged

Epic: 2025 Deferred Maintenance #898

Open

Rake comfy:cms_seeds:import fails to import pages with the same slug but different parents #913

Open

Update comfortable_media_surf 3.1.4 to 3.1.5 and Rails 8.1.1 to 8.1.2

5321ac9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Replace Comfortable Mexican Sofa with Comfortable Media Surfer Gem; address #737#885

[WIP] Replace Comfortable Mexican Sofa with Comfortable Media Surfer Gem; address #737#885
jefferya wants to merge 10 commits intomainfrom
jefferya/737_comfy_gem

jefferya commented Nov 6, 2025 •

edited

Loading

Uh oh!

jefferya Nov 7, 2025

Uh oh!

jefferya Dec 4, 2025

Uh oh!

jefferya Dec 4, 2025

Uh oh!

jefferya Dec 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

jefferya commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jefferya Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

jefferya Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

jefferya Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

jefferya Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jefferya commented Nov 6, 2025 •

edited

Loading