plum-cms 0.2.1 → 0.2.2

data/lib/plum/static_cache.rb

@@ -0,0 +1,103 @@
+require "rack/mime"
+
+module Plum
+  # Full-page static cache. Rendered public pages are written to disk keyed by
+  # host + path; subsequent requests are served from the file without touching
+  # the database or Liquid. A web server can serve the same files directly
+  # (nginx try_files) for the "full measure" where Rails never sees the hit.
+  #
+  # Cache entries are invalidated by deletion (see StaticCacheInvalidation) —
+  # the next request re-renders and re-stores the page. Over-flushing is cheap,
+  # so anything ambiguous flushes the whole site.
+  module StaticCache
+    MARKER_HEADER = "X-Plum-Static-Cache".freeze
+
+    class << self
+      # Explicit opt-in only — see docs/static-caching.md. There is
+      # deliberately no "auto-on in production" mode: this cache is only
+      # correct on a single-server deployment, and defaulting it on would
+      # silently corrupt pages the moment an app scales to 2+ nodes.
+      def enabled?
+        !!Plum.configuration.static_cache_enabled
+      end
+
+      def cache_root
+        Pathname(Plum.configuration.static_cache_path || Rails.root.join("storage", "plum_static_cache"))
+      end
+
+      # Pages are stored as {host}/{path}/index.html so a web server can map
+      # URLs to files directly. Paths with a file extension (theme assets) are
+      # stored verbatim.
+      def file_path(host, path)
+        key = normalized_path(path)
+        return nil unless key
+
+        base = cache_root.join(sanitized_host(host))
+        full = File.extname(key).present? ? base.join(key) : base.join(key, "index.html")
+        full = Pathname(File.expand_path(full))
+        return nil unless full.to_s.start_with?(cache_root.to_s + File::SEPARATOR)
+
+        full
+      end
+
+      def read(host, path)
+        file = file_path(host, path)
+        file if file&.file?
+      end
+
+      def store(host, path, body)
+        file = file_path(host, path)
+        return unless file
+
+        file.dirname.mkpath
+        tmp = file.sub_ext(".tmp-#{Process.pid}-#{Thread.current.object_id}")
+        tmp.binwrite(body)
+        File.rename(tmp, file)
+        file
+      rescue SystemCallError => e
+        Rails.logger.error("[Plum] static cache write failed for #{path}: #{e.message}")
+        nil
+      end
+
+      def flush_site!(site)
+        return flush_all! if site.nil? || site.domain.blank?
+
+        [ site.domain, "www.#{site.domain}" ].each do |host|
+          dir = cache_root.join(sanitized_host(host))
+          FileUtils.rm_rf(dir) if dir.to_s.start_with?(cache_root.to_s) && dir.exist?
+        end
+      end
+
+      def flush_all!
+        return unless cache_root.exist?
+
+        cache_root.children.each { |child| FileUtils.rm_rf(child) }
+      end
+
+      def content_type_for(file)
+        Rack::Mime.mime_type(File.extname(file.to_s), "text/html")
+      end
+
+      private
+
+      def sanitized_host(host)
+        cleaned = host.to_s.downcase.gsub(/[^a-z0-9.\-]/, "")
+        cleaned.presence || "_default"
+      end
+
+      # Rejects anything that could escape the cache directory and normalizes
+      # "/" and "/about/" style paths to a shared key.
+      def normalized_path(path)
+        decoded = begin
+          URI.decode_www_form_component(path.to_s)
+        rescue ArgumentError
+          return nil
+        end
+        return nil if decoded.include?("..") || decoded.include?("\0")
+
+        trimmed = decoded.delete_prefix("/").chomp("/")
+        trimmed.presence || "_root"
+      end
+    end
+  end
+end

data/lib/plum/version.rb

@@ -1,6 +1,6 @@
 module Plum
   module Version
-    STRING = "0.2.1"
+    STRING = "0.2.2"
   end
 
   VERSION = Version::STRING

data/lib/tasks/plum_config.rake

@@ -0,0 +1,48 @@
+# This repo is both the engine and an app, so Rails loads lib/tasks twice
+# (engine railtie + application). Rake appends actions on re-definition, which
+# would run every task body twice — guard against the second load.
+unless Rake::Task.task_defined?("plum:config:export")
+  namespace :plum do
+    namespace :config do
+      def plum_config_site
+        site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
+        abort "No Plum site exists" unless site
+        site
+      end
+
+      def plum_config_dir
+        ENV["DIR"].presence || Plum.configuration.config_path || Rails.root.join("plum")
+      end
+
+      desc "Write the content model (content types, fieldsets) to YAML files (SITE_ID optional; DIR defaults to plum/)"
+      task export: :environment do
+        files = Plum::ConfigSync.export(site: plum_config_site, dir: plum_config_dir)
+        puts "Exported #{files.length} config files to #{plum_config_dir}"
+      end
+
+      desc "Apply YAML config files to the database (SITE_ID optional; PRUNE=1 deletes types absent from files; FORCE=1 allows deleting types with entries)"
+      task sync: :environment do
+        result = Plum::ConfigSync.apply(
+          site: plum_config_site,
+          dir: plum_config_dir,
+          prune: ENV["PRUNE"].present?,
+          force: ENV["FORCE"].present?
+        )
+        puts "Config sync: #{result.summary}"
+      rescue Plum::ConfigSync::UnsafePruneError => e
+        abort e.message
+      end
+
+      desc "Fail if the database content model has drifted from the YAML files (for CI)"
+      task check: :environment do
+        drift = Plum::ConfigSync.check(site: plum_config_site, dir: plum_config_dir)
+        if drift.any?
+          drift.each { |line| puts "DRIFT #{line}" }
+          abort "Content model has drifted from config files (#{drift.length} differences)"
+        else
+          puts "Content model matches config files"
+        end
+      end
+    end
+  end
+end

data/lib/tasks/plum_portability.rake

@@ -1,37 +1,62 @@
-namespace :plum do
-  namespace :site do
-    desc "Export a complete Plum site archive (SITE_ID or first site; ARCHIVE required)"
-    task export: :environment do
-      path = ENV.fetch("ARCHIVE") { abort "ARCHIVE is required" }
-      site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
-      abort "No Plum site exists" unless site
-
-      archive = Plum::SiteArchive.dump(site: site, path: path)
-      puts "Exported #{site.name} to #{archive}"
-    end
+# This repo is both the engine and an app, so Rails loads lib/tasks twice
+# (engine railtie + application). Rake appends actions on re-definition, which
+# would run every task body twice — guard against the second load.
+unless Rake::Task.task_defined?("plum:site:export")
+  namespace :plum do
+    namespace :site do
+      desc "Export a complete Plum site archive (SITE_ID or first site; ARCHIVE required)"
+      task export: :environment do
+        path = ENV.fetch("ARCHIVE") { abort "ARCHIVE is required" }
+        site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
+        abort "No Plum site exists" unless site
+
+        archive = Plum::SiteArchive.dump(site: site, path: path)
+        puts "Exported #{site.name} to #{archive}"
+      end
 
-    desc "Import a Plum site archive as a new site (ARCHIVE required; NAME and DOMAIN optional)"
-    task import: :environment do
-      path = ENV.fetch("ARCHIVE") { abort "ARCHIVE is required" }
-      site = Plum::SiteArchive.load(path: path, name: ENV["NAME"], domain: ENV["DOMAIN"])
-      puts "Imported #{site.name} as site #{site.id}"
+      desc "Import a Plum site archive as a new site (ARCHIVE required; NAME and DOMAIN optional)"
+      task import: :environment do
+        path = ENV.fetch("ARCHIVE") { abort "ARCHIVE is required" }
+        site = Plum::SiteArchive.load(path: path, name: ENV["NAME"], domain: ENV["DOMAIN"])
+        puts "Imported #{site.name} as site #{site.id}"
+      end
     end
-  end
 
-  namespace :backup do
-    desc "Create a timestamped Plum site backup (SITE_ID optional; DIRECTORY defaults to backups/plum)"
-    task create: :environment do
-      site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
-      abort "No Plum site exists" unless site
-      directory = Rails.root.join(ENV.fetch("DIRECTORY", "backups/plum"))
-      filename = "plum-site-#{site.id}-#{Time.current.utc.strftime('%Y%m%d%H%M%S')}.plum.zip"
-      archive = Plum::SiteArchive.dump(site: site, path: directory.join(filename))
-      puts "Backed up #{site.name} to #{archive}"
+    namespace :site do
+      desc "Replace the local site with an archive — the 'pull' refresh (ARCHIVE required; SITE_ID optional; FORCE=1 required in production)"
+      task replace: :environment do
+        path = ENV.fetch("ARCHIVE") { abort "ARCHIVE is required" }
+        if Rails.env.production? && ENV["FORCE"].blank?
+          abort "Refusing to replace a site in production (set FORCE=1 to override)"
+        end
+
+        old_site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
+        old_name = old_site&.name
+
+        site = ActiveRecord::Base.transaction do
+          old_site&.destroy!
+          Plum::SiteArchive.load(path: path, name: ENV["NAME"], domain: ENV["DOMAIN"])
+        end
+
+        puts old_name ? "Replaced #{old_name} with #{site.name} (site #{site.id})" : "Imported #{site.name} as site #{site.id}"
+      end
     end
 
-    desc "Restore a Plum backup as a new site (ARCHIVE required; NAME and DOMAIN optional)"
-    task restore: :environment do
-      Rake::Task["plum:site:import"].invoke
+    namespace :backup do
+      desc "Create a timestamped Plum site backup (SITE_ID optional; DIRECTORY defaults to backups/plum)"
+      task create: :environment do
+        site = ENV["SITE_ID"].present? ? Plum::Site.find(ENV["SITE_ID"]) : Plum::Site.first
+        abort "No Plum site exists" unless site
+        directory = Rails.root.join(ENV.fetch("DIRECTORY", "backups/plum"))
+        filename = "plum-site-#{site.id}-#{Time.current.utc.strftime('%Y%m%d%H%M%S')}.plum.zip"
+        archive = Plum::SiteArchive.dump(site: site, path: directory.join(filename))
+        puts "Backed up #{site.name} to #{archive}"
+      end
+
+      desc "Restore a Plum backup as a new site (ARCHIVE required; NAME and DOMAIN optional)"
+      task restore: :environment do
+        Rake::Task["plum:site:import"].invoke
+      end
     end
   end
 end

data/lib/tasks/plum_styles.rake

@@ -1,12 +1,17 @@
-require "fileutils"
+# This repo is both the engine and an app, so Rails loads lib/tasks twice
+# (engine railtie + application). Rake appends actions on re-definition, which
+# would run every task body twice — guard against the second load.
+unless Rake::Task.task_defined?("plum:build_styles")
+  require "fileutils"
 
-namespace :plum do
-  desc "Build Tailwind and copy the result into Plum's packaged stylesheet"
-  task build_styles: :environment do
-    system(Rails.root.join("bin/rails").to_s, "tailwindcss:build", exception: true)
-    source = Rails.root.join("app/assets/builds/tailwind.css")
-    destination = Rails.root.join("app/assets/stylesheets/plum/control_panel.css")
-    FileUtils.cp(source, destination)
-    puts "Packaged #{destination.relative_path_from(Rails.root)}"
+  namespace :plum do
+    desc "Build Tailwind and copy the result into Plum's packaged stylesheet"
+    task build_styles: :environment do
+      system(Rails.root.join("bin/rails").to_s, "tailwindcss:build", exception: true)
+      source = Rails.root.join("app/assets/builds/tailwind.css")
+      destination = Rails.root.join("app/assets/stylesheets/plum/control_panel.css")
+      FileUtils.cp(source, destination)
+      puts "Packaged #{destination.relative_path_from(Rails.root)}"
+    end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plum-cms
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ben Simmons
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -222,6 +223,7 @@ files:
 - app/controllers/plum/cp/nav_items_controller.rb
 - app/controllers/plum/cp/nav_menus_controller.rb
 - app/controllers/plum/cp/site_settings_controller.rb
+- app/controllers/plum/cp/static_cache_controller.rb
 - app/controllers/plum/cp/taxonomies_controller.rb
 - app/controllers/plum/cp/terms_controller.rb
 - app/controllers/plum/cp/theme_previews_controller.rb
@@ -246,6 +248,7 @@ files:
 - app/javascript/controllers/plum/image_picker_controller.js
 - app/javascript/controllers/plum/structured_field_controller.js
 - app/javascript/controllers/plum/theme_settings_controller.js
+- app/javascript/controllers/plum/write_controller.js
 - app/models/plum/application_record.rb
 - app/models/plum/asset.rb
 - app/models/plum/content_type.rb
@@ -261,6 +264,7 @@ files:
 - app/models/plum/site.rb
 - app/models/plum/site_scoped.rb
 - app/models/plum/site_setting.rb
+- app/models/plum/static_cache_invalidation.rb
 - app/models/plum/taxonomy.rb
 - app/models/plum/term.rb
 - app/models/plum/user.rb
@@ -268,6 +272,8 @@ files:
 - app/services/plum/block_editor_config.rb
 - app/services/plum/block_library.rb
 - app/services/plum/builder_renderer.rb
+- app/services/plum/config_sync.rb
+- app/services/plum/draft_diff.rb
 - app/services/plum/entry_serializer.rb
 - app/services/plum/field_expander.rb
 - app/services/plum/field_options.rb
@@ -320,6 +326,7 @@ files:
 - app/themes/default/theme.yml
 - app/views/layouts/plum/cp.html.erb
 - app/views/layouts/plum/session.html.erb
+- app/views/layouts/plum/write.html.erb
 - app/views/plum/cp/assets/_form.html.erb
 - app/views/plum/cp/assets/edit.html.erb
 - app/views/plum/cp/assets/index.html.erb
@@ -332,9 +339,11 @@ files:
 - app/views/plum/cp/custom_fields/_input.html.erb
 - app/views/plum/cp/dashboard/show.html.erb
 - app/views/plum/cp/entries/_form.html.erb
+- app/views/plum/cp/entries/diff.html.erb
 - app/views/plum/cp/entries/edit.html.erb
 - app/views/plum/cp/entries/index.html.erb
 - app/views/plum/cp/entries/new.html.erb
+- app/views/plum/cp/entries/write.html.erb
 - app/views/plum/cp/entry_revisions/index.html.erb
 - app/views/plum/cp/fieldsets/index.html.erb
 - app/views/plum/cp/form_definitions/_form.html.erb
@@ -382,14 +391,18 @@ files:
 - db/engine_migrate/20260807140000_create_plum_fieldsets.rb
 - db/engine_migrate/20260807150000_add_focal_point_to_plum_assets.rb
 - db/engine_migrate/20260807160000_add_localization_to_plum_entries.rb
+- db/engine_migrate/20260811090000_add_draft_data_to_plum_entries.rb
 - docs/blueprint-fields.md
+- docs/config-as-code.md
 - docs/extensions.md
+- docs/plum-cli.md
 - docs/portability.md
 - docs/product-principles.md
 - docs/roadmap.md
 - docs/site/homepage.md
 - docs/site/information-architecture.md
 - docs/statamic-parity.md
+- docs/static-caching.md
 - docs/vision.md
 - lib/generators/plum/install/install_generator.rb
 - lib/generators/plum/install/templates/plum_initializer.rb
@@ -400,7 +413,10 @@ files:
 - lib/plum/content_source_registry.rb
 - lib/plum/engine.rb
 - lib/plum/liquid_tags/form_tag.rb
+- lib/plum/static_cache.rb
+- lib/plum/static_cache/middleware.rb
 - lib/plum/version.rb
+- lib/tasks/plum_config.rake
 - lib/tasks/plum_portability.rake
 - lib/tasks/plum_styles.rake
 - vendor/javascript/lexxy.js
@@ -412,6 +428,7 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/tableneeds/plum
   bug_tracker_uri: https://github.com/tableneeds/plum/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -427,7 +444,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: A Rails-native CMS engine.
 test_files: []