panda-cms 0.10.0 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5d7ab51a41583d6af2b9c03249894b81eb3301e8a88068bf512fea5ba10891a
-  data.tar.gz: 9cbbd69b5b6e6ce229fef244135e7abb1e12580be401524b054e94ff227280cc
+  metadata.gz: 680bef797106fd65c694455aac3c55bc7799bfdfba990997a96bec44f325f780
+  data.tar.gz: a8485d6a4da3f5623531eb14ae6188226204ab8b2bce3381baa3f1c6e3b7caf4
 SHA512:
-  metadata.gz: 84f46d5e374a05e046047e7e7751371f4b90d2e86a137df179c02e6e89c08169048e64c18ef38b0b78ab5137c22f55d0777451ab49bb32ab3aa3c67745b6aaed
-  data.tar.gz: 0b6ad4481db935ed61ca57d087582e8b370fe2ecb6b0e15dadeaa53042a834dbecaf9cd7d0122830788e10b071cce66290d0abd6a0b4649adf23465140854069
+  metadata.gz: 3cba49016e04bc8ec5a2f1011897687eeb2478c451c0a9d38feef27605e4ddfe674c9d8543ee92e33b76049d3ecb08bac0bab1e6b790576c5f043683dbca606e
+  data.tar.gz: bb6c39903cdf5412c99dae06721a3d908dc0ed6d2e2c6a5c443eb96c6e6e43965029530a2206bce40bf2a8c06ddfd8fafbdf97d341c6f9739269f64693240479

data/README.md

@@ -32,16 +32,6 @@ The easiest way for you to get started is to visit http://localhost:3000/admin a
 
 When you're ready to configure further, you can set your own configuration in `config/initializers/panda.rb`. Make sure to configure your authentication providers and update the domain restriction!
 
-## Panda CMS Pro
-
-Commercial features such as structured **Collections** live in the `panda-cms-pro` gem. Once the pro gem is installed you can:
-
-- Model repeatable content with collections and items.
-- Loop over entries inside layouts using helpers like `panda_cms_collection_items("trustees")`.
-- Keep the feature hidden in open-source installs thanks to `Panda::CMS::Features`.
-
-See `docs/collections.md` for the editor workflow and template examples, and `docs/private-gem-server.md` for hosting the private gem server.
-
 ### Existing applications
 
 Add the following to `Gemfile`:
@@ -124,6 +114,7 @@ The CMS automatically loads Core's compiled stylesheet:
 ```
 
 Core's Rack middleware serves this file from the gem, so:
+
 - ✅ No CSS copying or compilation needed
 - ✅ Styles update automatically when Core updates
 - ✅ Consistent design across all Panda gems
@@ -136,7 +127,7 @@ For CSS compilation (when contributing to styling), see [Panda Core Asset Compil
 
 This is a non-exhuastive list (there will be many more):
 
-* To date, this has only been tested with Rails 7.1, 7.2 and 8.0
+* To date, this has only been tested with Rails 7.1, 7.2 and 8
 * There may be conflicts if you're not using Tailwind CSS on the frontend. Please report this.
 
 ## Contributing
@@ -180,6 +171,83 @@ expect(page.title).to eq("Home")
 
 When testing models with file validations or complex callbacks, use the helper methods in `spec/models/panda/cms/page_spec.rb` as a reference.
 
+## 🚀 Running CI Locally
+
+This project uses a **deterministic CI environment**, based on a single Docker
+image (`panda-cms-test`). This ensures:
+
+- identical Ruby/Node/Chrome versions everywhere
+- no drift between local / Docker / GitHub Actions / act
+- fast, stable, reproducible tests
+
+There are **three** supported ways to run the full CI suite locally.
+
+---
+
+### 1. Run full CI via Docker Compose
+
+```sh
+bin/ci build      # build the local test image
+bin/ci local      # run full CI stack locally
+```
+
+This uses `docker-compose.ci.yml` and reproduces the entire GitHub Actions environment.
+
+---
+
+### 2. Run single RSpec execution in the CI container
+
+```sh
+bin/ci test
+```
+
+This mounts your project into the container and executes RSpec exactly as CI does.
+
+---
+
+### 3. Run GitHub Actions locally using act
+
+Install act:
+
+```sh
+brew install act
+```
+
+Use the project’s `.actrc`:
+
+```
+-P ubuntu-latest=ghcr.io/tastybamboo/panda-cms-test:local
+--container-options "--shm-size=2gb"
+```
+
+Then run:
+
+```sh
+bin/ci act
+```
+
+This executes **the real GitHub Actions workflow** on your machine.
+
+---
+
+### 4. Continuous Integration on GitHub
+
+GitHub Actions uses the same deterministic container image.
+See:
+
+```
+.github/workflows/ci.yml
+```
+
+---
+
+### 5. Code Coverage
+
+Coverage is produced per-suite (models, requests, libs, system) and merged
+into a unified `coverage/` directory via SimpleCov.
+
+Artifacts are uploaded automatically on CI.
+
 ## License
 
 The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/bsd-3-clause).

data/app/assets/tailwind/panda/cms/_application.css

@@ -0,0 +1 @@
+/* Panda CMS specific styles go here */

data/app/components/panda/cms/admin/popular_pages_component.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Panda
+  module CMS
+    module Admin
+      class PopularPagesComponent < Panda::Core::Base
+        def initialize(popular_pages:, period_name: "All Time")
+          @popular_pages = popular_pages
+          @period_name = period_name
+        end
+
+        def view_template
+          render Panda::Core::Admin::PanelComponent.new do |panel|
+            panel.heading(text: "Popular Pages (#{@period_name})", level: :panel)
+
+            panel.body do
+              if @popular_pages.any?
+                div(class: "overflow-y-auto max-h-96") do
+                  table(class: "min-w-full divide-y divide-gray-300") do
+                    thead(class: "sticky top-0 bg-white z-10") do
+                      tr do
+                        th(class: "py-3.5 pl-4 pr-3 text-left text-sm font-semibold text-gray-900 sm:pl-0") { "Page" }
+                        th(class: "px-3 py-3.5 text-left text-sm font-semibold text-gray-900") { "Path" }
+                        th(class: "px-3 py-3.5 text-right text-sm font-semibold text-gray-900") { "Views" }
+                      end
+                    end
+                    tbody(class: "divide-y divide-gray-200") do
+                      index = 0
+                      @popular_pages.each do |page_data|
+                        tr(class: index.even? ? "bg-indigo-50" : "bg-white") do
+                          td(class: "whitespace-nowrap py-4 pl-4 pr-3 text-sm font-medium text-gray-900 sm:pl-0") do
+                            a(
+                              href: view_context.admin_cms_page_path(page_data.id),
+                              class: "text-indigo-600 hover:text-indigo-900"
+                            ) { page_data.title }
+                          end
+                          td(class: "whitespace-nowrap px-3 py-4 text-sm text-gray-500") do
+                            a(
+                              href: page_data.path,
+                              class: "text-gray-600 hover:text-gray-900",
+                              target: "_blank"
+                            ) { page_data.path }
+                          end
+                          td(class: "whitespace-nowrap px-3 py-4 text-sm text-gray-500 text-right font-semibold") do
+                            page_data.visit_count.to_s
+                          end
+                        end
+                        index += 1
+                      end
+                    end
+                  end
+                end
+              else
+                p(class: "text-sm text-gray-500") { "No page visits recorded yet." }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/components/panda/cms/code_component.rb

@@ -14,10 +14,12 @@ module Panda
       prop :editable, _Boolean, default: true
 
       def view_template
-        if @editable_state
-          render_editable_view
+        # Russian doll caching: Cache component output at block_content level
+        # Only cache in non-editable mode (public-facing pages)
+        if should_cache?
+          raw cache_component_output.to_s.html_safe
         else
-          raw(@code_content.to_s.html_safe)
+          render_content
         end
       rescue => e
         handle_error(e)
@@ -36,9 +38,9 @@ module Panda
         block = find_block
         return false if block.nil?
 
-        block_content = find_block_content(block)
-        @code_content = block_content&.content.to_s
-        @block_content_id = block_content&.id
+        @block_content_obj = find_block_content(block)
+        @code_content = @block_content_obj&.content.to_s
+        @block_content_id = @block_content_obj&.id
       end
 
       def find_block
@@ -82,7 +84,7 @@ module Panda
               data: {inline_code_editor_target: "codeInput"},
               class: "w-full h-64 p-3 font-mono text-sm border border-gray-300 rounded focus:ring-primary focus:border-primary",
               placeholder: "Enter your HTML/embed code here..."
-            ) { raw(@code_content.to_s) }
+            ) { plain @code_content.to_s }
 
             div(class: "mt-3 flex justify-end space-x-2") do
               button(type: "button",
@@ -123,8 +125,11 @@ module Panda
       end
 
       def is_embedded?
-        # TODO: Check security on this - embed_id should match something?
-        view_context.request.params[:embed_id].present?
+        # Security: Verify embed_id matches the current page being edited
+        # This prevents unauthorized editing by ensuring the embed_id in the URL
+        # matches the actual page ID from Current.page
+        view_context.params[:embed_id].present? &&
+          Current.page&.id.to_s == view_context.params[:embed_id].to_s
       end
 
       def handle_error(error)
@@ -141,6 +146,38 @@ module Panda
         end
       end
 
+      def render_content
+        if @editable_state
+          render_editable_view
+        else
+          raw(@code_content.to_s.html_safe)
+        end
+      end
+
+      def should_cache?
+        !@editable_state &&
+          Panda::CMS.config.performance.dig(:fragment_caching, :enabled) != false &&
+          @block_content_obj.present?
+      end
+
+      def cache_component_output
+        cache_key = cache_key_for_component
+        expires_in = Panda::CMS.config.performance.dig(:fragment_caching, :expires_in) || 1.hour
+
+        Rails.cache.fetch(cache_key, expires_in: expires_in) do
+          render_content_to_string
+        end.html_safe
+      end
+
+      def cache_key_for_component
+        "panda_cms/code_component/#{@block_content_obj.cache_key_with_version}/#{@key}"
+      end
+
+      def render_content_to_string
+        # For code component, we just return the raw HTML content
+        @code_content.to_s
+      end
+
       class BlockError < StandardError; end
     end
   end

data/app/components/panda/cms/menu_component.rb

@@ -6,7 +6,7 @@ module Panda
     # @param name [String] The name of the menu to render
     # @param current_path [String] The current request path for highlighting active items
     # @param styles [Hash] CSS classes for menu items (default, active, inactive)
-    # @param overrides [Hash] Menu item overrides (currently unused)
+    # @param overrides [Hash] Menu item overrides - supports :hidden_items array to hide specific menu items by text
     # @param render_page_menu [Boolean] Whether to render sub-page menus
     # @param page_menu_styles [Hash] Styles for the page menu component
     class MenuComponent < Panda::Core::Base
@@ -44,11 +44,24 @@ module Panda
         @menu = Panda::CMS::Menu.find_by(name: @name)
         return unless @menu
 
-        menu_items = @menu.menu_items
-        menu_items = menu_items.where("depth <= ?", @menu.depth) if @menu.depth
-        menu_items = menu_items.order(:lft)
+        # Fragment caching: Cache menu_items query results
+        # Cache key includes menu's updated_at to auto-invalidate on changes
+        cache_key = "panda_cms_menu/#{@menu.name}/#{@menu.id}/#{@menu.updated_at.to_i}/items"
 
-        @processed_menu_items = menu_items.map do |menu_item|
+        menu_items = Rails.cache.fetch(cache_key, expires_in: 1.hour) do
+          items = @menu.menu_items
+          items = items.where("depth <= ?", @menu.depth) if @menu.depth
+          items.order(:lft).to_a  # Convert to array for caching
+        end
+
+        # Filter menu items based on overrides
+        filtered_menu_items = if @overrides[:hidden_items].present?
+          menu_items.reject { |item| @overrides[:hidden_items].include?(item.text) }
+        else
+          menu_items
+        end
+
+        @processed_menu_items = filtered_menu_items.map do |menu_item|
           add_css_classes_to_item(menu_item)
           menu_item
         end

data/app/components/panda/cms/page_menu_component.rb

@@ -36,7 +36,15 @@ module Panda
         menu = @start_page&.page_menu
         return if menu.nil?
 
-        @menu_item = menu.menu_items.order(:lft)&.first
+        # Fragment caching: Cache menu items for this page menu
+        # Cache key includes menu's updated_at to auto-invalidate on changes
+        cache_key = "panda_cms_page_menu/#{menu.id}/#{menu.updated_at.to_i}/items"
+
+        cached_items = Rails.cache.fetch(cache_key, expires_in: 1.hour) do
+          menu.menu_items.order(:lft).to_a
+        end
+
+        @menu_item = cached_items.first
 
         # Set default styles if not already set
         @styles[:indent_with] ||= "pl-2" if @styles

data/app/components/panda/cms/rich_text_component.rb

@@ -18,6 +18,16 @@ module Panda
       attr_accessor :content, :block_content_id
 
       def view_template
+        # Russian doll caching: Cache component output at block_content level
+        # Only cache in non-editable mode (public-facing pages)
+        if should_cache?
+          raw cache_component_output
+        else
+          render_content
+        end
+      end
+
+      def render_content
         div(class: "panda-cms-content", **element_attrs) do
           if @editable_state
             # Empty div for EditorJS to initialize into
@@ -199,23 +209,21 @@ module Panda
         attrs = {class: "panda-cms-content"}
 
         if @editable_state
-          attrs.merge!(
-            id: "editor-#{@block_content_id}",
-            data: {
-              "editable-previous-data": @encoded_data,
-              "editable-content": @encoded_data,
-              "editable-initialized": "false",
-              "editable-version": "2.28.2",
-              "editable-autosave": "false",
-              "editable-tools": '{"paragraph":true,"header":true,"list":true,"quote":true,"table":true}',
-              "editable-kind": "rich_text",
-              "editable-block-content-id": @block_content_id,
-              "editable-page-id": Current.page.id,
-              controller: "editor-js",
-              "editor-js-initialized-value": "false",
-              "editor-js-content-value": @encoded_data
-            }
-          )
+          attrs[:id] = "editor-#{@block_content_id}"
+          attrs[:data] = {
+            "editable-previous-data": @encoded_data,
+            "editable-content": @encoded_data,
+            "editable-initialized": "false",
+            "editable-version": "2.28.2",
+            "editable-autosave": "false",
+            "editable-tools": '{"paragraph":true,"header":true,"list":true,"quote":true,"table":true}',
+            "editable-kind": "rich_text",
+            "editable-block-content-id": @block_content_id,
+            "editable-page-id": Current.page.id,
+            controller: "editor-js",
+            "editor-js-initialized-value": "false",
+            "editor-js-content-value": @encoded_data
+          }
         end
 
         attrs
@@ -247,6 +255,30 @@ module Panda
 
         nil
       end
+
+      def should_cache?
+        !@editable_state &&
+          Panda::CMS.config.performance.dig(:fragment_caching, :enabled) != false &&
+          @block_content.present?
+      end
+
+      def cache_component_output
+        cache_key = cache_key_for_component
+        expires_in = Panda::CMS.config.performance.dig(:fragment_caching, :expires_in) || 1.hour
+
+        Rails.cache.fetch(cache_key, expires_in: expires_in) do
+          render_content_to_string
+        end.html_safe
+      end
+
+      def cache_key_for_component
+        "panda_cms/rich_text_component/#{@block_content.cache_key_with_version}/#{@key}"
+      end
+
+      def render_content_to_string
+        # Render the component HTML to a string for caching
+        view_context.content_tag(:div, @rendered_content.html_safe, class: "panda-cms-content", **element_attrs)
+      end
     end
   end
 end

data/app/components/panda/cms/text_component.rb

@@ -18,7 +18,13 @@ module Panda
       def view_template
         return unless @content
 
-        span(**element_attrs) { raw(@content.html_safe) }
+        # Russian doll caching: Cache component output at block_content level
+        # Only cache in non-editable mode (public-facing pages)
+        if should_cache?
+          raw cache_component_output
+        else
+          render_content
+        end
       rescue => e
         handle_error(e)
       end
@@ -35,11 +41,11 @@ module Panda
         block = find_block
         return false if block.nil?
 
-        block_content = find_block_content(block)
-        @plain_text = block_content&.content.to_s
+        find_block_content(block)
+        @plain_text = @block_content_obj&.content.to_s
 
         if @editable_state
-          setup_editable_content(block_content)
+          setup_editable_content(@block_content_obj)
         else
           @content = prepare_content_for_display(@plain_text)
         end
@@ -54,7 +60,7 @@ module Panda
       end
 
       def find_block_content(block)
-        block.block_contents.find_by(panda_cms_page_id: Current.page.id)
+        @block_content_obj = block.block_contents.find_by(panda_cms_page_id: Current.page.id)
       end
 
       def setup_editable_content(block_content)
@@ -66,14 +72,12 @@ module Panda
         attrs = @attrs.merge(id: element_id)
 
         if @editable_state
-          attrs.merge!(
-            contenteditable: "plaintext-only",
-            data: {
-              "editable-kind": "plain_text",
-              "editable-page-id": Current.page.id,
-              "editable-block-content-id": @block_content_id
-            }
-          )
+          attrs[:contenteditable] = "plaintext-only"
+          attrs[:data] = {
+            "editable-kind": "plain_text",
+            "editable-page-id": Current.page.id,
+            "editable-block-content-id": @block_content_id
+          }
         end
 
         attrs
@@ -92,13 +96,41 @@ module Panda
         view_context.params[:embed_id].present? && view_context.params[:embed_id] == Current.page.id
       end
 
-      def handle_error(error)
+      def handle_error(_error)
         if !Rails.env.production? || defined?(Sentry)
           raise Panda::CMS::MissingBlockError, "Block with key #{@key} not found for page #{Current.page.title}"
         end
 
         false
       end
+
+      def should_cache?
+        !@editable_state &&
+          Panda::CMS.config.performance.dig(:fragment_caching, :enabled) != false &&
+          @block_content_obj.present?
+      end
+
+      def cache_component_output
+        cache_key = cache_key_for_component
+        expires_in = Panda::CMS.config.performance.dig(:fragment_caching, :expires_in) || 1.hour
+
+        Rails.cache.fetch(cache_key, expires_in: expires_in) do
+          render_content_to_string
+        end.html_safe
+      end
+
+      def cache_key_for_component
+        "panda_cms/text_component/#{@block_content_obj.cache_key_with_version}/#{@key}"
+      end
+
+      def render_content
+        span(**element_attrs) { raw(@content.html_safe) }
+      end
+
+      def render_content_to_string
+        # Phlex doesn't have a direct way to capture output, so we render directly
+        view_context.content_tag(:span, @content.html_safe, **element_attrs)
+      end
     end
   end
 end

data/app/controllers/panda/cms/admin/menus_controller.rb

@@ -36,7 +36,7 @@ module Panda
         # @type GET
         def edit
           add_breadcrumb @menu.name, edit_admin_cms_menu_path(@menu)
-          render :edit, locals: {menu: @menu}
+          render :edit
         end
 
         # @type PATCH/PUT
@@ -44,7 +44,7 @@ module Panda
           if @menu.update(menu_params)
             redirect_to admin_cms_menus_path, notice: "Menu was successfully updated."
           else
-            render :edit, locals: {menu: @menu}, status: :unprocessable_entity
+            render :edit, status: :unprocessable_entity
           end
         end
 

data/app/controllers/panda/cms/admin/pages_controller.rb

@@ -66,7 +66,7 @@ module Panda
               flash: {success: "This page was successfully updated!"}
           else
             flash[:error] = "There was an error updating the page."
-            render :edit, status: :unprocessable_entity
+            render :edit, locals: {page: page, template: page.template}, status: :unprocessable_entity
           end
         end
 
@@ -99,7 +99,11 @@ module Panda
         # @type private
         # @return ActionController::StrongParameters
         def page_params
-          params.require(:page).permit(:title, :path, :panda_cms_template_id, :parent_id, :status, :page_type)
+          params.require(:page).permit(
+            :title, :path, :panda_cms_template_id, :parent_id, :status, :page_type,
+            :seo_title, :seo_description, :seo_keywords, :seo_index_mode, :canonical_url,
+            :og_title, :og_description, :og_type, :og_image, :inherit_seo
+          )
         end
       end
     end

data/app/controllers/panda/cms/admin/posts_controller.rb

@@ -119,7 +119,9 @@ module Panda
             :status,
             :published_at,
             :author_id,
-            :content
+            :content,
+            :seo_title, :seo_description, :seo_keywords, :seo_index_mode, :canonical_url,
+            :og_title, :og_description, :og_type, :og_image
           )
         end