Merge pull request #2309 from mamhoff/deprecate-element-available

Deprecate Alchemy::Element.available

app/helpers/alchemy/elements_helper.rb

@@ -126,7 +126,7 @@ def render_elements(options = {}, &blk)
     #
     # == Usage
     #
-    #   <%= render_element(Alchemy::Element.available.named(:headline).first) %>
+    #   <%= render_element(Alchemy::Element.published.named(:headline).first) %>
     #
     # @param [Alchemy::Element] element
     #   The element you want to render the view for

app/models/alchemy/element.rb

@@ -70,7 +70,7 @@ class Element < BaseRecord
       dependent: :destroy
 
     has_many :nested_elements,
-      -> { order(:position).available },
+      -> { order(:position).published },
       class_name: "Alchemy::Element",
       foreign_key: :parent_element_id,
       dependent: :destroy,
@@ -178,6 +178,8 @@ def all_from_clipboard_for_parent_element(clipboard, parent_element)
 
         all_from_clipboard(clipboard).where(name: parent_element.definition["nestable_elements"])
       end
+
+      deprecate available: :published, deprecator: Alchemy::Deprecation
     end
 
     # Returns next public element from same page.

app/models/alchemy/ingredient_validator.rb

@@ -88,7 +88,7 @@ def validate_format(format)
 
     def duplicates
       ingredient.class
-        .joins(:element).merge(Alchemy::Element.available)
+        .joins(:element).merge(Alchemy::Element.published)
         .where(Alchemy::Element.table_name => { name: ingredient.element.name })
         .where(value: ingredient.value)
         .where.not(id: ingredient.id)

app/models/alchemy/page/page_elements.rb

@@ -15,8 +15,8 @@ module PageElements
           source: :elements,
         ) do
           has_many :all_elements
-          has_many :elements, -> { not_nested.unfixed.available }
-          has_many :fixed_elements, -> { fixed.available }
+          has_many :elements, -> { not_nested.unfixed.published }
+          has_many :fixed_elements, -> { fixed.published }
         end
 
         has_many :contents, through: :elements

lib/alchemy/essence.rb

@@ -41,7 +41,7 @@ def acts_as_essence(options = {})
           has_one :element, through: :content, class_name: "Alchemy::Element"
           has_one :page,    through: :element, class_name: "Alchemy::Page"
 
-          scope :available,    -> { joins(:element).merge(Alchemy::Element.available) }
+          scope :available,    -> { joins(:element).merge(Alchemy::Element.published) }
           scope :from_element, ->(name) { joins(:element).where(Element.table_name => { name: name }) }
 
           delegate :restricted?, to: :page,    allow_nil: true

lib/alchemy/permissions.rb

@@ -41,7 +41,7 @@ def alchemy_guest_user_rules
           c.public? && !c.restricted?
         end
 
-        can :read, Alchemy::Element, Alchemy::Element.available.not_restricted do |e|
+        can :read, Alchemy::Element, Alchemy::Element.published.not_restricted do |e|
           e.public? && !e.restricted?
         end
 
@@ -68,7 +68,7 @@ def alchemy_member_rules
           c.public?
         end
 
-        can :read, Alchemy::Element, Alchemy::Element.available do |e|
+        can :read, Alchemy::Element, Alchemy::Element.published do |e|
           e.public?
         end
 

spec/models/alchemy/element_spec.rb

@@ -1138,4 +1138,13 @@ module Alchemy
       element.reload.destroy!
     end
   end
+
+  describe ".available" do
+    subject { Alchemy::Element.available }
+
+    it "is deprecated" do
+      expect(Alchemy::Deprecation).to receive(:warn)
+      subject
+    end
+  end
 end