Merge pull request #3710 from AlchemyCMS/refactor/rename-relatable-resource-associations

Rename RelatableResource associations to related_elements and related_pages

Author: tvdeyen

app/models/alchemy/attachment.rb

@@ -114,7 +114,7 @@ def slug
 
     # Checks if the attachment is restricted, because it is attached on restricted pages only
     def restricted?
-      pages.any? && pages.not_restricted.blank?
+      related_pages.any? && related_pages.not_restricted.blank?
     end
 
     # File name

app/models/alchemy/picture.rb

@@ -236,7 +236,7 @@ def has_convertible_format?
     # even if it is also assigned on a restricted page.
     #
     def restricted?
-      pages.any? && pages.not_restricted.blank?
+      related_pages.any? && related_pages.not_restricted.blank?
     end
 
     def image_file_name

app/models/concerns/alchemy/relatable_resource.rb

@@ -15,8 +15,8 @@ module RelatableResource
         foreign_key: "related_object_id",
         as: :related_object
 
-      has_many :elements, through: :related_ingredients
-      has_many :pages, through: :elements
+      has_many :related_elements, through: :related_ingredients, source: :element
+      has_many :related_pages, through: :related_elements, source: :page
     end
 
     # Returns true if object is not assigned to any ingredient.

app/models/concerns/alchemy/touch_elements.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  # If the model has a +elements+ association,
+  # If the model has a +related_elements+ association,
   # it updates all their timestamps after save.
   #
   # Should only be used on bottom to top relations,
@@ -16,9 +16,9 @@ def self.included(base)
     private
 
     def touch_elements
-      return unless respond_to?(:elements)
+      return unless respond_to?(:related_elements)
 
-      elements.touch_all
+      related_elements.touch_all
     end
   end
 end

lib/alchemy/test_support/relatable_resource_examples.rb

@@ -1,7 +1,7 @@
 RSpec.shared_examples_for "a relatable resource" do |args|
   it { is_expected.to have_many(:related_ingredients) }
-  it { is_expected.to have_many(:elements).through(:related_ingredients) }
-  it { is_expected.to have_many(:pages).through(:elements) }
+  it { is_expected.to have_many(:related_elements).through(:related_ingredients) }
+  it { is_expected.to have_many(:related_pages).through(:related_elements) }
 
   describe ".deletable" do
     subject { described_class.deletable }

spec/models/alchemy/attachment_spec.rb

@@ -82,7 +82,7 @@ module Alchemy
         end
 
         it "touches elements" do
-          expect { attachment.update(name: "image with spaces") }.to change { attachment.elements.reload.first.updated_at }
+          expect { attachment.update(name: "image with spaces") }.to change { attachment.related_elements.reload.first.updated_at }
         end
       end
     end
@@ -382,7 +382,7 @@ module Alchemy
         before do
           pages = double(any?: true)
           expect(pages).to receive(:not_restricted).and_return([])
-          expect(attachment).to receive(:pages).twice.and_return(pages)
+          expect(attachment).to receive(:related_pages).twice.and_return(pages)
         end
 
         it { is_expected.to be_truthy }
@@ -394,7 +394,7 @@ module Alchemy
         before do
           pages = double(any?: true)
           expect(pages).to receive(:not_restricted).and_return([page])
-          expect(attachment).to receive(:pages).twice.and_return(pages)
+          expect(attachment).to receive(:related_pages).twice.and_return(pages)
         end
 
         it { is_expected.to be_falsey }

spec/models/alchemy/picture_spec.rb

@@ -330,7 +330,7 @@ module Alchemy
       context "is assigned on pages" do
         context "that are all restricted" do
           before do
-            expect(picture).to receive(:pages).at_least(:once) do
+            expect(picture).to receive(:related_pages).at_least(:once) do
               double(
                 not_restricted: double(blank?: true),
                 any?: true
@@ -343,7 +343,7 @@ module Alchemy
 
         context "that are not all restricted" do
           before do
-            expect(picture).to receive(:pages).at_least(:once) do
+            expect(picture).to receive(:related_pages).at_least(:once) do
               double(
                 not_restricted: double(blank?: false),
                 any?: true
@@ -357,7 +357,7 @@ module Alchemy
 
       context "is not assigned on any page" do
         before do
-          expect(picture).to receive(:pages).and_return double(any?: false)
+          expect(picture).to receive(:related_pages).and_return double(any?: false)
         end
 
         it { is_expected.to be_falsey }
@@ -510,7 +510,7 @@ module Alchemy
         end
 
         it "touches elements" do
-          expect { picture.save }.to change { picture.elements.reload.first.updated_at }
+          expect { picture.save }.to change { picture.related_elements.reload.first.updated_at }
         end
       end
     end