Move hints into definition classes

Hints are static and read from the definition anyway.
This way we can display hints without having an record
to read this from.

Author: tvdeyen

app/models/alchemy/element_definition.rb

@@ -103,7 +103,6 @@ def read_definitions_file
     def attributes
       super.with_indifferent_access
     end
-    alias_method :definition, :attributes
 
     def ingredients
       super.map { IngredientDefinition.new(**_1) }

app/models/alchemy/page.rb

@@ -44,7 +44,6 @@
 
 module Alchemy
   class Page < BaseRecord
-    include Alchemy::Hints
     include Alchemy::Logger
     include Alchemy::Taggable
 
@@ -164,6 +163,7 @@ class Page < BaseRecord
 
     # site_name accessor
     delegate :name, to: :site, prefix: true, allow_nil: true
+    delegate :has_hint?, :hint, to: :definition
 
     # Class methods
     #

app/models/alchemy/page_definition.rb

@@ -4,6 +4,7 @@ module Alchemy
   class PageDefinition
     include ActiveModel::Model
     include ActiveModel::Attributes
+    include Alchemy::Hints
 
     extend ActiveModel::Translation
 
@@ -104,5 +105,11 @@ def human_name
     def attributes
       super.with_indifferent_access
     end
+
+    private
+
+    def hint_translation_scope
+      :page_hints
+    end
   end
 end

lib/alchemy/hints.rb

@@ -35,27 +35,23 @@ module Hints
     # @return String
     #
     def hint
-      hint = definition[:hint]
+      hint = attributes[:hint]
       if hint == true
         Alchemy.t(hint_translation_attribute, scope: hint_translation_scope)
       else
         hint
       end
     end
 
-    # Returns true if the element has a hint defined
+    # Returns true if the definition has a hint defined
     def has_hint?
-      !!definition[:hint]
+      !!attributes[:hint]
     end
 
     private
 
     def hint_translation_attribute
       name
     end
-
-    def hint_translation_scope
-      "#{self.class.model_name.to_s.demodulize.downcase}_hints"
-    end
   end
 end

spec/models/alchemy/element_definition_spec.rb

@@ -30,6 +30,15 @@ module Alchemy
       it { is_expected.to_not allow_value("Article Element").for(:name) }
     end
 
+    it_behaves_like "having a hint" do
+      let(:translation_key) { "article" }
+      let(:translation_scope) { :element_hints }
+
+      let(:subject) do
+        described_class.new(name: "article", **hint)
+      end
+    end
+
     describe "#blank?" do
       subject { definition.blank? }
 

spec/models/alchemy/element_spec.rb

@@ -760,11 +760,6 @@ module Alchemy
       end
     end
 
-    it_behaves_like "having a hint" do
-      let(:definition_class) { ElementDefinition }
-      let(:subject) { Element.new }
-    end
-
     describe "#nestable_elements" do
       let(:element) { Element.new }
 

spec/models/alchemy/ingredient_definition_spec.rb

@@ -32,6 +32,15 @@ module Alchemy
       it { is_expected.to_not allow_value("Spree::Product").for(:type) }
     end
 
+    it_behaves_like "having a hint" do
+      let(:translation_key) { "text" }
+      let(:translation_scope) { :ingredient_hints }
+
+      let(:subject) do
+        described_class.new(role: "text", **hint)
+      end
+    end
+
     describe "#deprecation_notice" do
       subject { definition.deprecation_notice(element_name: element&.name) }
 

spec/models/alchemy/ingredient_spec.rb

@@ -13,11 +13,6 @@
     build(:alchemy_element, name: "article", autogenerate_ingredients: false)
   end
 
-  it_behaves_like "having a hint" do
-    let(:definition_class) { Alchemy::IngredientDefinition }
-    let(:subject) { Alchemy::Ingredients::Text.new(role: "headline", element: element) }
-  end
-
   describe "scopes" do
     let(:element) do
       build(:alchemy_element, name: "all_you_can_eat", autogenerate_ingredients: false)

spec/models/alchemy/page_definition_spec.rb

@@ -38,6 +38,15 @@ module Alchemy
       end
     end
 
+    it_behaves_like "having a hint" do
+      let(:translation_key) { "standard" }
+      let(:translation_scope) { :page_hints }
+
+      let(:subject) do
+        described_class.new(name: "standard", **hint)
+      end
+    end
+
     describe "validations" do
       it { is_expected.to validate_presence_of(:name) }
       it { is_expected.to allow_value("standard").for(:name) }

spec/models/alchemy/page_spec.rb

@@ -1943,17 +1943,6 @@ module Alchemy
       end
     end
 
-    it_behaves_like "having a hint" do
-      let(:definition_class) { PageDefinition }
-      let(:subject) { Page.new }
-    end
-
-    it "keys hint translation by page_layout" do
-      page = Page.new(page_layout: :everything)
-      expect(page).to have_hint
-      expect(page.hint).to eq Alchemy.t("page_hints.everything")
-    end
-
     describe "#layout_partial_name" do
       let(:page) { Page.new(page_layout: "Standard Page") }