panda_cms 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625476035c61b37e617fe74e22deca62b77522d70c4776663ee0429453bc6ea2
-  data.tar.gz: 0e5424b52179f8b3f6b0108763399ac65c7b2ed3fc12dc68c0f6721663526547
+  metadata.gz: a11f50a60d457d8a5b4eba37c270535516599a39d78c242f9711990d8f810799
+  data.tar.gz: 4f33c57dcb79a3b2eeaafbf58584221a1000e05b05e0058abd401a80eb530c6a
 SHA512:
-  metadata.gz: 852b417dc7bea4ebe4f5c96edfe3937ab435f2a549722349f019b70a147d853b728a2951acebc95a9e67a28fbd907e5625e3b0d84e2b5d6ada7d0a31a1415f47
-  data.tar.gz: 13c1b3692557a6f9768921029da41d93ba34f6664cb85a9967a2dc6e656cc0db1a56023f07bc28bd8ee23b15fd3a0efeeb2fdae32d3041fa9797e04d28558c28
+  metadata.gz: 4203b15127f62ef99db77ddd54f1f6c5b5c0c47d3754957be010474aeaa11918e3efbe9d293946dd35cdbbb0fa83515c5797c3e1286c900a1a46a1a5fc159cc3
+  data.tar.gz: efdccb2f2ab99172a1b30e73dfa85ca59bed4f616bb67d1fe613bb50f1fe8d63c4333029eb8834b126f2ed68c41436edef535451f99ee27d4cb00e2fa6d332c3

data/README.md

@@ -16,7 +16,9 @@ Better websites, on Rails.
 
 ## Usage
 
-To create a new Rails app[^1], run the command below, replacing `demo` with the name of the application you want to create:
+### New applications
+
+To create a new Rails app, run the command below, replacing `demo` with the name of the application you want to create:
 
 ```
 rails new demo $(curl -fsSL https://raw.githubusercontent.com/pandacms/generator/main/.railsrc) -m https://raw.githubusercontent.com/pandacms/generator/main/template.rb
@@ -26,6 +28,8 @@ rails new demo $(curl -fsSL https://raw.githubusercontent.com/pandacms/generator
 
 The easiest way for you to get started is to visit http://localhost:3000/admin and login with your GitHub credentials. As the first user, you'll automatically have an administrator account created.
 
+When you're ready to configure further, you can set your own configuration in `config/initializers/panda_cms.rb`. Make sure to turn off the default `github` account creation options!
+
 ### Existing applications
 
 Add the following to `Gemfile`:
@@ -45,7 +49,7 @@ rails db:seed
 
 You may want to check this does not re-run any of your existing seeds!
 
-If you don't want to use GitHub to login, you'll need to configure a user provider (in `config/initializers/panda_cms.rb`), and then set your user's `admin` attribute to `true` once you've first tried to login. (And yes, there should be a better first-time setup experience than this. We're working on it!)
+If you don't want to use GitHub to login (or are at a URL other than http://localhost:3000/), you'll need to configure a user provider (in `config/initializers/panda_cms.rb`), and then set your user's `admin` attribute to `true` once you've first tried to login.
 
 ## Gotchas
 
@@ -53,7 +57,6 @@ This is a non-exhuastive list (there will be many more):
 
 * To date, this has only been tested with Rails 7.1 and 7.2.
 * There may be conflicts if you're not using Tailwind CSS on the frontend. Please report this.
-* If you change your login path from `/admin` the GitHub application we supply won't work on first login, so probably don't do that until you're setup!
 
 ## Contributing
 
@@ -68,5 +71,3 @@ See [Credits](https://github.com/pandacms/panda_cms/blob/main/CREDITS.md) for th
 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, Panda Software Limited.
-
-[^1]: You can of course use an existing Rails app, but on your head be it – we haven't tested this at all yet!

data/app/lib/panda_cms/demo_site_generator.rb

@@ -11,7 +11,7 @@ module PandaCms
     #
     # Creates initial templates and empty blocks
     #
-    # @return [Hash] A hash containing the created templates
+    # @return void
     def create_templates
       # Templates
       initial_templates = [
@@ -20,26 +20,13 @@ module PandaCms
       ]
 
       initial_templates.each do |template|
-        @templates[template[:name].downcase.to_sym] = PandaCms::Template.find_or_create_by!(template)
+        key = template[:name].downcase.to_sym
+        @templates[key] = PandaCms::Template.find_or_create_by!(template)
       end
 
-      # Blocks
-      initial_blocks = [
-        {kind: "rich_text", name: "Introduction Text", key: "introduction_text", template: @templates[:homepage]},
-        {kind: "rich_text", name: "Main Content", key: "main_content", template: @templates[:homepage]},
-        {kind: "rich_text", name: "Main Content", key: "main_content", template: @templates[:page]}
-      ]
-
-      initial_blocks.each do |block_data|
-        PandaCms::Block.find_or_create_by!(block_data)
-      end
+      PandaCms::Template.generate_missing_blocks
 
-      # Empty block contents
-      PandaCms::Block.find_each do |block|
-        block.template.pages.each do |page|
-          PandaCms::BlockContent.find_or_create_by!(page: page, block: block, content: "")
-        end
-      end
+      @templates
     end
 
     #
@@ -50,21 +37,26 @@ module PandaCms
       @pages[:home] = PandaCms::Page.find_or_create_by!({path: "/", title: "Home", template: @templates[:homepage]})
       @pages[:about] = PandaCms::Page.find_or_create_by!({path: "/about", title: "About", template: @templates[:page], parent: @pages[:home]})
       @pages[:terms] = PandaCms::Page.find_or_create_by!({path: "/terms-and-conditions", title: "Terms & Conditions", template: @templates[:page], parent: @pages[:home]})
+
+      @pages
     end
 
     #
     # Creates initial menus
     #
     # @return [Hash] A hash containing the created menus
-    #
     def create_menus
       @menus = {}
       @menus[:main] = PandaCms::Menu.find_or_create_by!(name: "Main Menu")
       @menus[:footer] = PandaCms::Menu.find_or_create_by!(name: "Footer Menu")
 
       # Automatically create main menu from homepage
-      @menus[:main].update(kind: :auto, start_page: @pages[:home])
-      @menus[:main].generate_auto_menu_items
+      unless @pages[:home].nil?
+        @menus[:main].update(kind: :auto, start_page: @pages[:home])
+        @menus[:main].generate_auto_menu_items
+      end
+
+      @menus
     end
   end
 end

data/app/models/panda_cms/template.rb

@@ -27,38 +27,6 @@ module PandaCms
     scope :ordered, -> { order(:sort_order) }
     scope :available, -> { where("max_uses IS NULL OR (pages_count < max_uses)") }
 
-    private
-
-    # Custom validation method to check if the file_path is a valid layout file path
-    # NB: Currently only supports .html.erb templates, may want to expand in future?
-    # @return [void]
-    def validate_template_file_exists
-      # Remove any directory traversal attempts from the file_path
-      safe_file_path = file_path.to_s.gsub("../", "")
-      # Check if the file_path is an ERB template that exists in app/views
-      template_path = Rails.root.join("app", "views", "#{safe_file_path}.html.erb")
-      # NB: file? checks for files and excludes directories (unlike exist?)
-      errors.add(:file_path, "must be an existing layout file path") unless File.file?(template_path)
-    end
-
-    # Import templates from the filesystem into the database
-    # @return [void]
-    def self.load_from_filesystem
-      Rails.root.glob("app/views/layouts/**/*.html.erb").each do |file|
-        # Extract the file path from the Rails root
-        file_path = file.to_s.sub("#{Rails.root}/app/views/", "").sub(".html.erb", "")
-
-        next if file_path == "layouts/application" || file_path == "layouts/mailer"
-
-        # Find or create the template based on the file path
-        find_or_create_by(file_path: file_path) do |t|
-          t.name = file_path.sub("layouts/", "").titleize
-        end
-      end
-    end
-
-    private_class_method :load_from_filesystem
-
     # Generate missing blocks for all templates
     # @return [void]
     def self.generate_missing_blocks
@@ -71,7 +39,6 @@ module PandaCms
           # PandaCms::RichTextComponent.new(key: :value)
           # PandaCms::RichTextComponent.new key: :value, key: value
           line.match(/PandaCms::([a-zA-Z]+)Component\.new[ \(]+([^\)]+)[\)]*/) do |match|
-            puts "- #{match[0]}"
             # Extract the hash values
             template_path = file.gsub("app/views/", "").gsub(".html.erb", "")
             template_name = template_path.gsub("layouts/", "").titleize
@@ -81,6 +48,9 @@ module PandaCms
               template.name = template_name
             end
 
+            next if match[1] == "PageMenu" # Skip PageMenu blocks
+            next if match[1] == "Menu" # Skip Menu blocks
+
             # Previously used match[1].underscore but this supports more complex database
             # operations, and is more secure as it'll force the usage of a class
             block_kind = "PandaCms::#{match[1]}Component".constantize::KIND
@@ -112,6 +82,36 @@ module PandaCms
       end
     end
 
-    private_class_method :generate_missing_blocks
+    private
+
+    # Custom validation method to check if the file_path is a valid layout file path
+    # NB: Currently only supports .html.erb templates, may want to expand in future?
+    # @return [void]
+    def validate_template_file_exists
+      # Remove any directory traversal attempts from the file_path
+      safe_file_path = file_path.to_s.gsub("../", "")
+      # Check if the file_path is an ERB template that exists in app/views
+      template_path = Rails.root.join("app", "views", "#{safe_file_path}.html.erb")
+      # NB: file? checks for files and excludes directories (unlike exist?)
+      errors.add(:file_path, "must be an existing layout file path") unless File.file?(template_path)
+    end
+
+    # Import templates from the filesystem into the database
+    # @return [void]
+    def self.load_from_filesystem
+      Rails.root.glob("app/views/layouts/**/*.html.erb").each do |file|
+        # Extract the file path from the Rails root
+        file_path = file.to_s.sub("#{Rails.root}/app/views/", "").sub(".html.erb", "")
+
+        next if file_path == "layouts/application" || file_path == "layouts/mailer"
+
+        # Find or create the template based on the file path
+        find_or_create_by(file_path: file_path) do |t|
+          t.name = file_path.sub("layouts/", "").titleize
+        end
+      end
+    end
+
+    private_class_method :load_from_filesystem
   end
 end

data/config/initializers/panda_cms.rb

@@ -1,5 +1,3 @@
-# Base URL
-PandaCms.url = "http://localhost:3000"
 # The main title of your website
 # The default is "Demo Site"
 PandaCms.title = "Demo Site"
@@ -41,7 +39,11 @@ PandaCms.authentication = {
   github: {
     enabled: true,
     create_account_on_first_login: true,
-    create_admin_account_on_first_login: false,
+    create_admin_account_on_first_login: true,
+    # client_id: Rails.application.credentials.dig(:github, :client_id),
+    # client_secret: Rails.application.credentials.dig(:github, :client_secret),
+    client_id: "Ov23li9k0LpMXtq8FShb", # Will only work on localhost
+    client_secret: "07233b63472b7f287ac11854e627670ddc096a22", # Will only work on localhost
     redirect_uri: Rails.application.credentials.dig(:github, :redirect_uri)
   }
 }

data/lib/panda_cms/version.rb

@@ -1,3 +1,3 @@
 module PandaCms
-  VERSION = "0.5.1"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panda_cms
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Panda Software Limited
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage-office-previewer