panda-cms 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d84fd0b6bd17f5e5f253a570bae55270227bec0196037960aa3358d09903bd
-  data.tar.gz: c6bc6d0173f89d965a23132bc016bfd3a44e6bd0b2533960cca495fa28e645e3
+  metadata.gz: 9a439141e4b2fd9c4167ea0bd872096a648fe1a9fcfc237e6a1c20e16d2a2562
+  data.tar.gz: fa28c3d1d698b9725140618603505a0120c0e58430ff4c923ccd986f3e27daa5
 SHA512:
-  metadata.gz: 63b30314a40563ab4cb8f99d516cd30edc3aed7ffe8d1841d4b8760ea6c80c8b253a983ca7cadd473caba240a7b18132cda903b23ed35da845833aef4880b2d4
-  data.tar.gz: 820e1b606f088e8bacd7e03d997812f5a2255941e399e8fe863076a0a1196935c66c6a2aca34d50f9dd69563280cda9d795692ccba6df5af565aefd2b38439e2
+  metadata.gz: 1923aea63bd5a266487a4a25e852df4cc96e0cba408fd9cb9351a5a302a20ad7e07ef22254dbe01ef7751ca3b35d0a9cdfb941a821e56730455fc73f0223083b
+  data.tar.gz: 54291d3de7b95047412a2c6c9e50b94f187457803bfd1609f0f9a947348de612c2ca6480f33e8e5df5f0305c131d638e025f1d6e04cc30c2997ce4ccb2a9c56e

data/README.md

@@ -12,7 +12,7 @@ Better websites, on Rails.
 🐼 is grown from our work at [Otaina](https://www.otaina.co.uk), a small group of freelancers. We needed something that could handle websites large and small – but where we could expand it too. We sent our first websites live in March 2024.
 
 ![Gem Version](https://img.shields.io/gem/v/panda-cms) ![Build Status](https://img.shields.io/github/actions/workflow/status/tastybamboo/panda-cms/ci.yml)
-![GitHub Last Commit](https://img.shields.io/github/last-commit/tasty-bamboo/panda-cms) [![Ruby Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+![GitHub Last Commit](https://img.shields.io/github/last-commit/tastybamboo/panda-cms) [![Ruby Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
 
 ## Usage
 
@@ -66,8 +66,43 @@ We welcome contributions.
 
 See our [Contributing Guidelines](https://docs.pandacms.io/developers/contributing/)
 
+### Testing
+
+Panda CMS uses RSpec for testing.
+
+#### Using Fixtures
+
+We encourage using fixtures for tests instead of factories for consistent test data:
+
+1. Create fixture files in `spec/fixtures` named after the model's table (e.g., `panda_cms_pages.yml`)
+2. Define records with unique names and their attributes
+3. Use helper methods to create test templates with mocked file validation
+
+Example fixture format:
+
+```yaml
+# spec/fixtures/panda_cms_pages.yml
+home_page:
+  title: "Home"
+  path: "/"
+  panda_cms_template_id: <%= ActiveRecord::FixtureSet.identify(:page_template) %>
+  status: "active"
+  created_at: <%= Time.current %>
+  updated_at: <%= Time.current %>
+```
+
+Example test using fixtures:
+
+```ruby
+# Access fixture using table name and record name
+page = panda_cms_pages(:home_page)
+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.
+
 ## License
 
 The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/bsd-3-clause).
 
-Copyright © 2024 - 2025, Panda Software Limited.
+Copyright © 2024 - 2025, Otaina Limited.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)

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

@@ -4,8 +4,7 @@ module Panda
   module CMS
     module Admin
       class StatisticsComponent < ViewComponent::Base
-        attr_reader :metric
-        attr_reader :value
+        attr_reader :metric, :value
 
         def initialize(metric:, value:)
           @metric = metric

data/app/components/panda/cms/admin/user_activity_component.html.erb

@@ -1,5 +1,7 @@
-<% if user.is_a?(Panda::CMS::User) %>
+<% if user.is_a?(Panda::Core::User) && time %>
   <%= render Panda::CMS::Admin::UserDisplayComponent.new(user: user, metadata: "#{time_ago_in_words(time)} ago") %>
+<% elsif user.is_a?(Panda::Core::User) %>
+  <%= render Panda::CMS::Admin::UserDisplayComponent.new(user: user, metadata: "Not published") %>
 <% elsif time %>
   <div class="text-black/60"><%= time_ago_in_words(time) %> ago</div>
 <% end %>

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

@@ -4,16 +4,14 @@ module Panda
   module CMS
     module Admin
       class UserActivityComponent < ViewComponent::Base
-        attr_accessor :model
-        attr_accessor :time
-        attr_accessor :user
+        attr_accessor :model, :time, :user
 
         # @param model [ActiveRecord::Base] Model instance to which the user activity is related
         # @param at [ActiveSupport::TimeWithZone] Time of the activity
-        # @param user [Panda::CMS::User] User who performed the activity
+        # @param user [Panda::Core::User] User who performed the activity
         def initialize(model: nil, at: nil, user: nil)
           @model = model
-          @user = user if user.is_a?(::Panda::CMS::User)
+          @user = user if user.is_a?(::Panda::Core::User)
           @time = at if at.is_a?(::ActiveSupport::TimeWithZone)
         end
       end

data/app/components/panda/cms/admin/user_display_component.html.erb

@@ -10,7 +10,7 @@
     </div>
     <% end %>
     <div class="ml-3">
-      <p class="text-sm text-black"><%= user.firstname %> <%= user.lastname %></p>
+      <p class="text-sm text-black"><%= user.name %></p>
       <% if metadata %><p class="text-sm text-black/60"><%= metadata %></p><% end %>
     </div>
   </div>

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

@@ -7,8 +7,8 @@ module Panda
         attr_accessor :user_id, :user, :metadata
 
         def initialize(user_id: nil, user: nil, metadata: "")
-          @user = if user.nil? && user_id.present? && Panda::CMS::User.find(user_id)
-            Panda::CMS::User.find(user_id)
+          @user = if user.nil? && user_id.present? && Panda::Core::User.find(user_id)
+            Panda::Core::User.find(user_id)
           else
             user
           end

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

@@ -17,15 +17,19 @@ module Panda
         @options[:id] ||= "code-#{key.to_s.dasherize}"
         @editable = editable
 
-        raise BlockError.new("Key 'code' is not allowed for CodeComponent") if key == :code
+        raise BlockError, "Key 'code' is not allowed for CodeComponent" if key == :code
       end
 
       def call
         # TODO: For the non-editable version, grab this from a cache or similar?
-        block = Panda::CMS::Block.find_by(kind: KIND, key: @key, panda_cms_template_id: Current.page.panda_cms_template_id)
+        block = Panda::CMS::Block.find_by(kind: KIND, key: @key,
+          panda_cms_template_id: Current.page.panda_cms_template_id)
 
         if block.nil?
-          raise Panda::CMS::MissingBlockError.new("Block with key #{@key} not found for page #{Current.page.title}") unless Rails.env.production?
+          unless Rails.env.production?
+            raise Panda::CMS::MissingBlockError, "Block with key #{@key} not found for page #{Current.page.title}"
+          end
+
           return false
         end
 
@@ -58,7 +62,7 @@ module Panda
 
       def is_embedded?
         # TODO: Check security on this - embed_id should match something?
-        request.params.dig(:embed_id).present?
+        request.params[:embed_id].present?
       end
     end
   end

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

@@ -23,24 +23,25 @@ module Panda
 
         @menu_items = @menu_items.order(:lft).map do |menu_item|
           if is_active?(menu_item)
-            menu_item.define_singleton_method(:css_classes) { styles[:default] + " " + styles[:active] }
+            menu_item.define_singleton_method(:css_classes) { "#{styles[:default]} #{styles[:active]}" }
           else
-            menu_item.define_singleton_method(:css_classes) { styles[:default] + " " + styles[:inactive] }
+            menu_item.define_singleton_method(:css_classes) { "#{styles[:default]} #{styles[:inactive]}" }
           end
 
           menu_item
         end
 
         # TODO: Surely don't need this but Current.page isn't working in the component
-        if @render_page_menu
-          @current_page = Panda::CMS::Page.find_by(path: @current_path)
-          @page_menu_styles = page_menu_styles
-        end
+        return unless @render_page_menu
+
+        @current_page = Panda::CMS::Page.find_by(path: @current_path)
+        @page_menu_styles = page_menu_styles
       end
 
       def is_active?(menu_item)
         return true if @current_path == "/" && active_link?(menu_item.page.path, match: :exact)
         return true if menu_item.page.path != "/" && active_link?(menu_item.page.path, match: :starts_with)
+
         false
       end
 

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

@@ -3,31 +3,29 @@
 module Panda
   module CMS
     class PageMenuComponent < ViewComponent::Base
-      attr_accessor :page
-      attr_accessor :menu_item
-      attr_accessor :styles
+      attr_accessor :page, :menu_item, :styles
 
       def initialize(page:, start_depth:, styles: {}, show_heading: true)
         @page = page
 
-        unless @page.nil?
-          start_page = if @page.depth == start_depth
-            @page
-          else
-            @page.ancestors.find { |anc| anc.depth == start_depth }
-          end
+        return if @page.nil?
 
-          menu = start_page&.page_menu
-          return if menu.nil?
+        start_page = if @page.depth == start_depth
+          @page
+        else
+          @page.ancestors.find { |anc| anc.depth == start_depth }
+        end
 
-          @menu_item = menu.menu_items.order(:lft)&.first
+        menu = start_page&.page_menu
+        return if menu.nil?
 
-          @show_heading = show_heading
+        @menu_item = menu.menu_items.order(:lft)&.first
 
-          # Set some default styles for sanity
-          @styles = styles
-          @styles[:indent_with] ||= "pl-2"
-        end
+        @show_heading = show_heading
+
+        # Set some default styles for sanity
+        @styles = styles
+        @styles[:indent_with] ||= "pl-2"
       end
 
       def render?

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

@@ -12,9 +12,7 @@ module Panda
 
       KIND = "rich_text"
 
-      attr_accessor :editable
-      attr_accessor :content
-      attr_accessor :options
+      attr_accessor :editable, :content, :options
 
       def initialize(key: :text_component, text: "Lorem ipsum...", editable: true, **options)
         @key = key
@@ -27,7 +25,8 @@ module Panda
       def before_render
         @editable &&= params[:embed_id].present? && params[:embed_id] == Current.page.id && Current.user.admin?
 
-        block = Panda::CMS::Block.find_by(kind: "rich_text", key: @key, panda_cms_template_id: Current.page.panda_cms_template_id)
+        block = Panda::CMS::Block.find_by(kind: "rich_text", key: @key,
+          panda_cms_template_id: Current.page.panda_cms_template_id)
         raise ComponentError, "Block not found for key: #{@key}" unless block
 
         block_content = block.block_contents.find_by(panda_cms_page_id: Current.page.id)
@@ -65,7 +64,7 @@ module Panda
                     # Ensure the content is properly structured
                     {
                       "time" => parsed["time"] || Time.current.to_i * 1000,
-                      "blocks" => parsed["blocks"].map { |block|
+                      "blocks" => parsed["blocks"].map do |block|
                         {
                           "type" => block["type"],
                           "data" => block["data"].merge(
@@ -73,19 +72,19 @@ module Panda
                           ),
                           "tunes" => block["tunes"]
                         }.compact
-                      },
+                      end,
                       "version" => parsed["version"] || "2.28.2"
                     }
                   else
                     # If not valid EditorJS, try to convert from HTML
                     begin
-                      editor_content = Panda::CMS::HtmlToEditorJsConverter.convert(@content)
+                      editor_content = Panda::Editor::HtmlToEditorJsConverter.convert(@content)
                       if valid_editor_js_content?(editor_content)
                         editor_content
                       else
                         empty_editor_js_content
                       end
-                    rescue Panda::CMS::HtmlToEditorJsConverter::ConversionError => e
+                    rescue Panda::Editor::HtmlToEditorJsConverter::ConversionError => e
                       Rails.logger.error("HTML conversion error: #{e.message}")
                       empty_editor_js_content
                     end
@@ -94,13 +93,13 @@ module Panda
                   Rails.logger.error("JSON parse error: #{e.message}")
                   # Try to convert from HTML
                   begin
-                    editor_content = Panda::CMS::HtmlToEditorJsConverter.convert(@content)
+                    editor_content = Panda::Editor::HtmlToEditorJsConverter.convert(@content)
                     if valid_editor_js_content?(editor_content)
                       editor_content
                     else
                       empty_editor_js_content
                     end
-                  rescue Panda::CMS::HtmlToEditorJsConverter::ConversionError => e
+                  rescue Panda::Editor::HtmlToEditorJsConverter::ConversionError => e
                     Rails.logger.error("HTML conversion error: #{e.message}")
                     empty_editor_js_content
                   end
@@ -130,7 +129,7 @@ module Panda
                       parsed_content["blocks"][0]["data"]["text"].blank?
                     "<p></p>".html_safe
                   else
-                    renderer = Panda::CMS::EditorJs::Renderer.new(parsed_content)
+                    renderer = Panda::Editor::Renderer.new(parsed_content)
                     rendered = renderer.render
                     rendered.presence&.html_safe || "<p></p>".html_safe
                   end

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

@@ -25,10 +25,10 @@ module Panda
         content_tag(:span, @content, @options, false) # Don't escape the content
       rescue
         if !Rails.env.production? || is_defined?(Sentry)
-          raise Panda::CMS::MissingBlockError.new("Block with key #{@key} not found for page #{Current.page.title}")
-        else
-          false
+          raise Panda::CMS::MissingBlockError, "Block with key #{@key} not found for page #{Current.page.title}"
         end
+
+        false
       end
 
       #
@@ -45,11 +45,10 @@ module Panda
       def before_render
         @editable &&= params[:embed_id].present? && params[:embed_id] == Current.page.id
 
-        block = Panda::CMS::Block.find_by(kind: KIND, key: @key, panda_cms_template_id: Current.page.panda_cms_template_id)
+        block = Panda::CMS::Block.find_by(kind: KIND, key: @key,
+          panda_cms_template_id: Current.page.panda_cms_template_id)
 
-        if block.nil?
-          return false
-        end
+        return false if block.nil?
 
         block_content = block.block_contents.find_by(panda_cms_page_id: Current.page.id)
         plain_text = block_content&.content.to_s

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Panda
+  module CMS
+    module Admin
+      # Base controller for all CMS admin controllers
+      # Inherits from Core AdminController for authentication
+      # Adds CMS-specific helpers and functionality
+      class BaseController < ::Panda::Core::AdminController
+        # Include CMS helpers so views have access to panda_cms_form_with, etc.
+        helper Panda::CMS::ApplicationHelper
+
+        # Include the helper methods in the controller as well
+        include Panda::CMS::ApplicationHelper
+      end
+    end
+  end
+end

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

@@ -3,10 +3,9 @@
 module Panda
   module CMS
     module Admin
-      class BlockContentsController < ApplicationController
+      class BlockContentsController < ::Panda::CMS::Admin::BaseController
         before_action :set_page, only: %i[update]
         before_action :set_block_content, only: %i[update]
-        before_action :authenticate_admin_user!
 
         # @type PATCH/PUT
         # @return

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

@@ -1,19 +1,24 @@
+# frozen_string_literal: true
+
 require "groupdate"
 
 module Panda
   module CMS
-    class Admin::DashboardController < ApplicationController
-      before_action :set_initial_breadcrumb, only: %i[show]
-      before_action :authenticate_admin_user!
+    module Admin
+      class DashboardController < ::Panda::Core::Admin::DashboardController
+        before_action :set_initial_breadcrumb, only: %i[show]
 
-      # GET /admin
-      def show
-      end
+        # Override the panda-core dashboard with CMS-specific dashboard
+        def show
+          # Render the CMS dashboard view
+          render "panda/cms/admin/dashboard/show"
+        end
 
-      private
+        private
 
-      def set_initial_breadcrumb
-        add_breadcrumb "Dashboard", Panda::CMS.route_namespace
+        def set_initial_breadcrumb
+          add_breadcrumb "Dashboard", admin_cms_dashboard_path
+        end
       end
     end
   end

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

@@ -3,9 +3,7 @@
 module Panda
   module CMS
     module Admin
-      class FilesController < ApplicationController
-        before_action :authenticate_admin_user!
-
+      class FilesController < ::Panda::CMS::Admin::BaseController
         def create
           file = params[:image]
           return render json: {success: 0} unless file

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

@@ -3,9 +3,8 @@
 module Panda
   module CMS
     module Admin
-      class FormsController < ApplicationController
+      class FormsController < ::Panda::CMS::Admin::BaseController
         before_action :set_initial_breadcrumb, only: %i[index show]
-        before_action :authenticate_admin_user!
 
         # Lists all forms
         # @type GET
@@ -18,7 +17,7 @@ module Panda
         def show
           form = Panda::CMS::Form.find(params[:id])
 
-          add_breadcrumb form.name, admin_form_path(form)
+          add_breadcrumb form.name, admin_cms_form_path(form)
           submissions = form.form_submissions.order(created_at: :desc)
           # TODO: Set a whitelist of fields we allow to be submitted for the form, shown in this view
           # and a formatting array of how to display them... eventually?
@@ -35,11 +34,9 @@ module Panda
         private
 
         def set_initial_breadcrumb
-          add_breadcrumb "Forms", admin_forms_path
+          add_breadcrumb "Forms", admin_cms_forms_path
         end
 
-        private
-
         # Only allow a list of trusted parameters through
         # @type private
         # @return ActionController::StrongParameters

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

@@ -3,9 +3,8 @@
 module Panda
   module CMS
     module Admin
-      class MenusController < ApplicationController
+      class MenusController < ::Panda::CMS::Admin::BaseController
         before_action :set_initial_breadcrumb, only: %i[index]
-        before_action :authenticate_admin_user!
 
         # Lists all menus which can be managed by the administrator
         # @type GET
@@ -22,7 +21,7 @@ module Panda
         end
 
         def set_initial_breadcrumb
-          add_breadcrumb "Menus", admin_menus_path
+          add_breadcrumb "Menus", admin_cms_menus_path
         end
       end
     end

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

@@ -3,9 +3,9 @@
 module Panda
   module CMS
     module Admin
-      class PagesController < ApplicationController
+      class PagesController < ::Panda::CMS::Admin::BaseController
         before_action :set_initial_breadcrumb, only: %i[index edit new create update]
-        before_action :authenticate_admin_user!
+        # Authentication is automatically enforced by AdminController
 
         # Lists all pages which can be managed by the administrator
         # @type GET
@@ -25,7 +25,7 @@ module Panda
         # Loads the page editor
         # @type GET
         def edit
-          add_breadcrumb page.title, edit_admin_page_path(page)
+          add_breadcrumb page.title, edit_admin_cms_page_path(page)
 
           render :edit, locals: {page: page, template: page.template}
         end
@@ -38,12 +38,13 @@ module Panda
           page.path = nil if page.path.blank?
 
           # Set the full path before validation if we have a parent
-          if page.parent && page.parent.path != "/" && page.path.present?
+          if page.parent && page.parent.path != "/" && page.path.present? && !page.path.start_with?(page.parent.path)
+            # Only prepend parent path if it's not already included
             page.path = page.parent.path + page.path
           end
 
           if page.save
-            redirect_to edit_admin_page_path(page), notice: "The page was successfully created."
+            redirect_to edit_admin_cms_page_path(page), notice: "The page was successfully created."
           else
             flash.now[:error] = page.errors.full_messages.to_sentence
             locals = setup_new_page_form(page: page)
@@ -55,7 +56,7 @@ module Panda
         # @return
         def update
           if page.update(page_params)
-            redirect_to edit_admin_page_path(page),
+            redirect_to edit_admin_cms_page_path(page),
               status: :see_other,
               flash: {success: "This page was successfully updated!"}
           else
@@ -78,11 +79,11 @@ module Panda
         end
 
         def set_initial_breadcrumb
-          add_breadcrumb "Pages", admin_pages_path
+          add_breadcrumb "Pages", admin_cms_pages_path
         end
 
         def setup_new_page_form(page:)
-          add_breadcrumb "Add Page", new_admin_page_path
+          add_breadcrumb "Add Page", new_admin_cms_page_path
           {
             page: page,
             available_templates: Panda::CMS::Template.available

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

@@ -5,9 +5,8 @@ require "json"
 module Panda
   module CMS
     module Admin
-      class PostsController < ApplicationController
+      class PostsController < ::Panda::CMS::Admin::BaseController
         before_action :set_initial_breadcrumb, only: %i[index edit new create update]
-        before_action :authenticate_admin_user!
 
         # Get all posts
         # @type GET
@@ -27,7 +26,7 @@ module Panda
         # Loads the post editor
         # @type GET
         def edit
-          add_breadcrumb post.title, edit_admin_post_path(post.admin_param)
+          add_breadcrumb post.title, edit_admin_cms_post_path(post.admin_param)
           render :edit, locals: {post: post}
         end
 
@@ -39,8 +38,7 @@ module Panda
 
           if @post.save
             Rails.logger.debug "Post saved successfully"
-            flash[:success] = "The post was successfully created!"
-            redirect_to edit_admin_post_path(@post.admin_param), status: :see_other
+            redirect_to edit_admin_cms_post_path(@post.admin_param), notice: "The post was successfully created!"
           else
             Rails.logger.debug "Post save failed: #{@post.errors.full_messages.inspect}"
             flash.now[:error] = @post.errors.full_messages.join(", ")
@@ -61,13 +59,13 @@ module Panda
           update_params[:user_id] = current_user.id
           if post.update(update_params)
             Rails.logger.debug "Post updated successfully"
-            add_breadcrumb post.title, edit_admin_post_path(post.admin_param)
+            add_breadcrumb post.title, edit_admin_cms_post_path(post.admin_param)
             flash[:success] = "The post was successfully updated"
-            redirect_to edit_admin_post_path(post.admin_param), status: :see_other
+            redirect_to edit_admin_cms_post_path(post.admin_param), status: :see_other
           else
             Rails.logger.debug "Post update failed: #{post.errors.full_messages.inspect}"
             Rails.logger.debug "Preserving content: #{post_params[:content].inspect}"
-            add_breadcrumb post.title.presence || "Edit Post", edit_admin_post_path(post.admin_param)
+            add_breadcrumb post.title.presence || "Edit Post", edit_admin_cms_post_path(post.admin_param)
             flash.now[:error] = post.errors.full_messages.join(", ")
             render :edit, locals: {
               post: post,
@@ -93,11 +91,11 @@ module Panda
         end
 
         def set_initial_breadcrumb
-          add_breadcrumb "Posts", admin_posts_path
+          add_breadcrumb "Posts", admin_cms_posts_path
         end
 
         def setup_new_post_form(post: nil, preserved_content: nil)
-          add_breadcrumb "Add Post", new_admin_post_path
+          add_breadcrumb "Add Post", new_admin_cms_post_path
 
           post ||= Panda::CMS::Post.new(
             status: "active",
@@ -106,7 +104,7 @@ module Panda
 
           {
             post: post,
-            url: admin_posts_path,
+            url: admin_cms_posts_path,
             preserved_content: preserved_content
           }
         end