sitepress-rails 4.0.9 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5834bc1a71d0bcbf71d663532e8f08217cbb8281e8ba3afa0f0611229172a3b
-  data.tar.gz: 7e12a1d5048024de09ca161cfb02940163e7eba950e3e2451f8adf03fdb4f359
+  metadata.gz: de65ed0cb60dae87a90fb914dd4dfd5183d4eccd6286e071d556533d1501e184
+  data.tar.gz: 4b0d4add465aea7037216b26dffbebf7ea000624740e8b5ab893acd97fa7cd65
 SHA512:
-  metadata.gz: 198e16ce93c8c76d7d9b2a6452102a422905c9dca98bc45026aa5a0c370a5bfdc69f9d8c5cacfe3028dd195e4efbc4c8e337ec3066a9c650ae01f052ca03aacc
-  data.tar.gz: b7588d454afb4d032594502ba2f946015edbd569c0772f9c427b1840a2b8d1fe7538a1eca4342332c8a22663c9eecc46ce8c66db1de0d6a18bbd79d002c2b3e5
+  metadata.gz: 3895c25f0bba45c456c28e6204650d8d15034609b1f8b5c14e7f86126aa9f7b12acab20c9baacc93f667aa406fae24bdfbbc60c90b30224a9f5f843f19cf5491
+  data.tar.gz: 5769f5831e3039e05835e5fd1a308df25621d3ac947b36d1ae3b39b13a3c7dcd892d594d745070d6fdb4246e406b92b5249777bbcea5f415660634a89e132f41

data/lib/sitepress/engine.rb

@@ -13,7 +13,7 @@ module Sitepress
     ]
 
     # Load the `config/site.rb` file so users can configure Sitepress.
-    initializer :load_sitepress_file, before: :set_sitepress_paths do
+    initializer "sitepress.load_site_file", before: "sitepress.set_paths" do
       site_file = paths["config/site.rb"].existent.first
       load site_file if site_file
     end
@@ -24,49 +24,76 @@ module Sitepress
       "app/markdown"                      # When Sitepress is launched embedded in Rails project.
     ], autoload: true
 
-    # Load paths from `Sitepress#site` into rails so it can render views, helpers, etc. properly.
-    initializer :set_sitepress_paths, before: :set_autoload_paths do |app|
-      app.paths["app/helpers"].push site.helpers_path.expand_path
+    # Load paths from `Sitepress#site` into Rails.
+    #
+    # We configure two separate systems:
+    #
+    # 1. app.paths["app/*"] - Rails component path registry
+    #    Tells ActionView where to find templates, ActionController where to find helpers, etc.
+    #
+    # 2. config.autoload_paths - Zeitwerk autoloader configuration
+    #    Tells Zeitwerk what to autoload. Rails automatically includes these in
+    #    config.eager_load_paths for production environments.
+    #
+    initializer "sitepress.set_paths", before: :set_autoload_paths do |app|
+      site = Sitepress.configuration.site
+
+      # Helpers: autoloadable and available to controllers
+      # Collapsed so app/content/helpers/sample_helper.rb defines SampleHelper (not Helpers::SampleHelper)
+      site.helpers_path.expand_path.tap do |path|
+        app.paths["app/helpers"].push path
+        app.config.autoload_paths << path
+        app.config.eager_load_paths << path
+        Rails.autoloaders.main.collapse(path)
+      end
+
+      # Models: autoloadable
+      # Collapsed so models don't require namespace prefixes
+      site.models_path.expand_path.tap do |path|
+        app.paths["app/models"].push path
+        app.config.autoload_paths << path
+        app.config.eager_load_paths << path
+        Rails.autoloaders.main.collapse(path)
+      end
+
+      # Assets: available to Sprockets (no autoloading needed)
       app.paths["app/assets"].push site.assets_path.expand_path
+
+      # Views: available to ActionView (no autoloading needed - these are templates)
       app.paths["app/views"].push site.root_path.expand_path
       app.paths["app/views"].push site.pages_path.expand_path
-      app.paths["app/models"].push site.models_path.expand_path
 
-      # Set for view_components to load at ./components
+      # Components: autoloadable for view_components
       app.config.autoload_paths << File.expand_path("./components")
     end
 
     # Configure sprockets paths for the site.
-    initializer :set_manifest_file_path, before: :append_assets_path do |app|
-      manifest_file = sitepress_configuration.manifest_file_path.expand_path
+    initializer "sitepress.set_manifest_file_path", before: :append_assets_path do |app|
+      manifest_file = Sitepress.configuration.manifest_file_path.expand_path
       app.config.assets.precompile << manifest_file.to_s if manifest_file.exist?
     end
 
     # Configure Sitepress with Rails settings.
-    initializer :configure_sitepress do |app|
-      sitepress_configuration.parent_engine = app
+    initializer "sitepress.configure" do |app|
+      Sitepress.configuration.parent_engine = app
       # Reloads entire site between requests for development environments.
-      sitepress_configuration.cache_resources = if app.config.respond_to? :enable_reloading?
+      Sitepress.configuration.cache_resources = if app.config.respond_to? :enable_reloading?
         # Rails 7.1 changed the name of this setting to enable_reloading, so check if that exist and use it.
         app.config.enable_reloading?
       else
         # Rails 7.0.x and lower all use this method to check if reloading is enabled.
         app.config.cache_classes
       end
-
-      config.to_prepare do
-        Sitepress::Path.handler_extensions = ActionView::Template::Handlers.extensions
-      end
-    end
-
-    private
-
-    def sitepress_configuration
-      Sitepress.configuration
     end
 
-    def site
-      sitepress_configuration.site
+    # Set handler extensions once, after ActionView and all template engines are loaded.
+    initializer "sitepress.set_handler_extensions" do
+      ActiveSupport.on_load(:action_view) do
+        ActiveSupport.on_load(:after_initialize) do
+          Sitepress::Path.handler_extensions =
+            ActionView::Template::Handlers.extensions
+        end
+      end
     end
   end
 end

data/lib/sitepress/model.rb

@@ -29,15 +29,23 @@ module Sitepress
       # Defines a class method that may be called later to return a
       # collection of objects. The default glob, for example, is named `:all`,
       # which defines `MyModel.all` on the class.
-      def collection(name = Models::Collection::DEFAULT_NAME, glob:, **kwargs)
-        define_singleton_method name do
-          self.glob glob, **kwargs
+      def collection(name = :all, glob: nil, **, &)
+        if block_given?
+          build_collection(&)
+        else
+          ActiveSupport::Deprecation.new.warn(
+            "The `collection :#{name}, glob: ...` macro is deprecated. " \
+            "Use `def self.#{name} = glob('#{glob}')` instead."
+          )
+          define_singleton_method name do
+            self.glob glob, **
+          end
         end
       end
 
       # Adhoc querying of models via `Model.glob("foo/bar").all`
-      def glob(glob, **kwargs)
-        Models::Collection.new model: self, site: site, glob: glob, **kwargs
+      def glob(glob, **)
+        build_collection(model: self, **){ site.glob(glob) }
       end
 
       # Wraps a page in a class if given a string that represents the path or
@@ -67,6 +75,12 @@ module Sitepress
       def site
         Sitepress.site
       end
+
+      private
+
+      def build_collection(*, model: self, **, &)
+        Models::Collection.new(*, model:, **, &)
+      end
     end
   end
 end

data/lib/sitepress/models/collection.rb

@@ -5,28 +5,23 @@ module Sitepress
     class Collection
       include Enumerable
 
-      # Page models will have `PageModel.all` method defined by default.
-      DEFAULT_NAME = :all
+      attr_reader :model
 
-      # Iterate over all resources in the site by default.
-      DEFAULT_GLOB = "**/*.*".freeze
-
-      attr_reader :model, :glob, :site
-
-      def initialize(model:, site:, glob: DEFAULT_GLOB)
+      def initialize(model:, &resources)
         @model = model
-        @glob = glob
-        @site = site
+        @resources = resources
       end
 
       def resources
-        site.glob glob
+        @resources.call
       end
 
       # Wraps each resource in a model object.
-      def each
+      def each(&block)
+        return to_enum(:each) unless block_given?
+
         resources.each do |resource|
-          yield model.new resource
+          yield model.new(resource)
         end
       end
     end

data/rails/app/controllers/concerns/sitepress/site_pages.rb

@@ -16,7 +16,6 @@ module Sitepress
 
     included do
       rescue_from Sitepress::ResourceNotFound, with: :resource_not_found
-      helper Sitepress::Engine.helpers
       helper_method :current_page, :site
       around_action :ensure_site_reload
     end
@@ -125,10 +124,10 @@ module Sitepress
     # For whatever reason, Rails can't stablize this API so we need to check
     # the version of Rails to make the right call and stablize it.
     def find_layout(formats:)
-      case Rails::VERSION::MAJOR
-      when 8
+      case method(:_layout).arity
+      when 3
         _layout(lookup_context, formats, lookup_context.prefixes)
-      else
+      when 2
         _layout(lookup_context, formats)
       end
     end

data/rails/lib/generators/sitepress/install/install_generator.rb

@@ -2,6 +2,8 @@ module Sitepress
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("templates", __dir__)
 
+    class_option :skip_markdown, type: :boolean, default: false, desc: "Skip adding markdown-rails gem"
+
     def copy_files
       directory ".", "app/content"
     end
@@ -12,9 +14,22 @@ module Sitepress
     end
 
     def append_sitepress_path_to_tailwind_config
+      # Tailwind v3
       if File.exist? 'config/tailwind.config.js'
-        inject_into_file 'config/tailwind.config.js', ",\n    './app/content/**/*.{erb,haml,html,slim,rb}'",
+        inject_into_file 'config/tailwind.config.js', ",\n    './app/content/**/*.*'",
           after: "    './app/views/**/*.{erb,haml,html,slim}'"
+      # Tailwind v4
+      elsif File.exist? 'app/assets/tailwind/application.css'
+        inject_into_file 'app/assets/tailwind/application.css', "\n@source \"../../content/**/*.*\";",
+          after: "@import \"tailwindcss\";"
+      end
+    end
+
+    def add_markdown_rails_gem
+      unless options[:skip_markdown]
+        gem "markdown-rails"
+        say "Added markdown-rails gem to Gemfile", :green
+        say "Run 'bundle install' to install the gem", :yellow
       end
     end
   end

data/rails/lib/generators/sitepress/install/templates/pages/index.html.erb

@@ -45,7 +45,7 @@ title: Getting started with Sitepress in Rails
   <p>This was generated by the <code>rails generate sitepress:install</code> command.</p>
 
   <h2>Content</h2>
-  <p>Sitepress content files are in <code><%= site.root_path.expand_path %></code>. There you can edit site content, including this file at <code><%= current_page.asset.path %></code>.
+  <p>Sitepress content files are in <code><%= site.root_path.expand_path %></code>. There you can edit site content, including this file at <code><%= current_page.asset.path %></code>.</p>
 
   <h2>Routes</h2>
   <p>Sitepress defined a root route in <code><%= Rails.root.join("config/routes.rb") %></code>. If that conflicts with your routes configuration, you'll want to open it and edit accordingly.</p>