Extract common eager loading parameters into Class

This helps keep the duplication down.
AlchemyCMS · Apr 27, 2022 · 7e5268c · 7e5268c
1 parent 5b61e8b
commit 7e5268c
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 40 deletions.
diff --git a/app/controllers/alchemy/admin/pages_controller.rb b/app/controllers/alchemy/admin/pages_controller.rb
@@ -404,20 +404,7 @@ def set_preview_mode
       end
 
       def page_includes
-        {
-          :tags,
-          language: :site,
-          draft_version: {
-            elements: [
-              :page,
-              :touchable_pages,
-              {
-                ingredients: :related_object,
-                contents: :essence,
-              },
-            ],
-          },
-        }
+        Alchemy::EagerLoading.page_includes(version: :draft_version)
       end
     end
   end

diff --git a/app/controllers/alchemy/pages_controller.rb b/app/controllers/alchemy/pages_controller.rb
@@ -246,20 +246,7 @@ def page_not_found!
     end
 
     def page_includes
-      {
-        :tags,
-        language: :site,
-        public_version: {
-          elements: [
-            :page,
-            :touchable_pages,
-            {
-              ingredients: :related_object,
-              contents: :essence,
-            },
-          ],
-        },
-      }
+      Alchemy::EagerLoading.page_includes(version: :public_version)
     end
   end
 end
diff --git a/app/jobs/alchemy/publish_page_job.rb b/app/jobs/alchemy/publish_page_job.rb
@@ -6,18 +6,7 @@ class PublishPageJob < BaseJob
 
     def perform(page_id, public_on:)
       page = Alchemy::Page.includes(
-        :tags,
-        language: :site,
-        draft_version: {
-          elements: [
-            :page,
-            :touchable_pages,
-            {
-              ingredients: :related_object,
-              contents: :essence,
-            },
-          ],
-        },
+        Alchemy::EagerLoading.page_includes(version: :draft_version)
       ).find(page_id)
       Alchemy::Page::Publisher.new(page).publish!(public_on: public_on)
     end

diff --git a/app/models/alchemy/eager_loading.rb b/app/models/alchemy/eager_loading.rb
@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Eager loading parameters for loading pages
+  class EagerLoading
+    class << self
+      # Eager loading parameters for {ActiveRecord::Base.includes}
+      #
+      # Pass this to +includes+ whereever you load an {Alchemy::Page}
+      #
+      #     Alchemy::Page.includes(Alchemy::EagerLoading.page_includes).find_by(urlname: "my-page")
+      #
+      # @param version [Symbol] Type of page version to eager load
+      # @return [Array]
+      def page_includes(version: :public_version)
+        [
+          :tags,
+          {
+            language: :site,
+            version => {
+              elements: [
+                :page,
+                :touchable_pages,
+                {
+                  ingredients: :related_object,
+                  contents: :essence,
+                },
+              ],
+            },
+          },
+        ]
+      end
+    end
+  end
+end