alchemy_cms 5.2.0 → 6.0.0.b3

data/lib/alchemy/test_support/shared_ingredient_editor_examples.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for "an alchemy ingredient editor" do
+  let(:ingredient_editor) { Alchemy::IngredientEditor.new(ingredient) }
+
+  before do
+    view.class.send :include, Alchemy::Admin::BaseHelper
+    view.class.send :include, Alchemy::Admin::IngredientsHelper
+    allow(element_editor).to receive(:ingredients) { [ingredient_editor] }
+  end
+
+  subject do
+    render element_editor
+    rendered
+  end
+
+  it "renders a ingredient editor", :aggregate_failures do
+    is_expected.to have_css(".ingredient-editor.#{ingredient_editor.partial_name}")
+    is_expected.to have_css("[data-ingredient-role]")
+  end
+end

data/lib/alchemy/test_support/shared_ingredient_examples.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "shoulda-matchers"
+
+RSpec.shared_examples_for "an alchemy ingredient" do
+  let(:element) { build(:alchemy_element, name: "element_with_ingredients") }
+
+  subject(:ingredient) do
+    described_class.new(
+      element: element,
+      role: "headline",
+    )
+  end
+
+  it { is_expected.to belong_to(:element).touch(true).class_name("Alchemy::Element") }
+  it { is_expected.to belong_to(:related_object).optional }
+  it { is_expected.to validate_presence_of(:role) }
+  it { is_expected.to validate_presence_of(:type) }
+  it { expect(subject.data).to eq({}) }
+
+  describe "#settings" do
+    subject { ingredient.settings }
+
+    context "without element" do
+      let(:element) { nil }
+
+      it { is_expected.to eq({}) }
+    end
+
+    context "with element" do
+      before do
+        expect(element).to receive(:ingredient_definition_for) do
+          {
+            settings: {
+              linkable: true,
+            },
+          }.with_indifferent_access
+        end
+      end
+
+      it { is_expected.to eq({ linkable: true }.with_indifferent_access) }
+    end
+  end
+
+  describe "#definition" do
+    subject { ingredient.definition }
+
+    context "without element" do
+      let(:element) { nil }
+
+      it { is_expected.to eq({}) }
+    end
+
+    context "with element" do
+      let(:definition) do
+        {
+          role: "headline",
+          type: "Text",
+          default: "Hello World",
+          settings: {
+            linkable: true,
+          },
+        }.with_indifferent_access
+      end
+
+      before do
+        expect(element).to receive(:ingredient_definition_for) { definition }
+      end
+
+      it "returns ingredient definition" do
+        is_expected.to eq(definition)
+      end
+    end
+  end
+end

data/lib/alchemy/tinymce.rb

@@ -38,6 +38,10 @@ module Alchemy
         content_definitions_from_elements(page.descendent_element_definitions)
       end
 
+      def custom_config_ingredients(page)
+        ingredient_definitions_from_elements(page.descendent_element_definitions)
+      end
+
       private
 
       def content_definitions_from_elements(definitions)
@@ -52,6 +56,19 @@ module Alchemy
           contents.map { |c| c.merge("element" => el["name"]) }
         end.flatten.compact
       end
+
+      def ingredient_definitions_from_elements(definitions)
+        definitions.collect do |el|
+          next if el["ingredients"].blank?
+
+          ingredients = el["ingredients"].select do |c|
+            c["settings"] && c["settings"]["tinymce"].is_a?(Hash)
+          end
+          next if ingredients.blank?
+
+          ingredients.map { |c| c.merge("element" => el["name"]) }
+        end.flatten.compact
+      end
     end
   end
 end

data/lib/alchemy/upgrader/six_point_zero.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "tasks/add_page_versions"
+require_relative "tasks/ingredients_migrator"
+
+module Alchemy
+  class Upgrader::SixPointZero < Upgrader
+    class << self
+      def create_public_page_versions
+        desc "Create public page versions for pages"
+        Alchemy::Upgrader::Tasks::AddPageVersions.new.create_public_page_versions
+      end
+
+      def create_ingredients
+        desc "Create ingredients for elements with ingredients defined"
+        Alchemy::Upgrader::Tasks::IngredientsMigrator.new.create_ingredients
+        log "Done.", :success
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader/tasks/add_page_versions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "alchemy/upgrader"
+
+module Alchemy::Upgrader::Tasks
+  class AddPageVersions < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def create_public_page_versions
+        Alchemy::Deprecation.silence do
+          Alchemy::Page.where.not(legacy_public_on: nil).find_each do |page|
+            next if page.versions.published.any?
+
+            Alchemy::Page.transaction do
+              page.versions.create!(
+                public_on: page.legacy_public_on,
+                public_until: page.legacy_public_until
+              ).tap do |version|
+                # We must not use .find_each here to not mess up the order of elements
+                page.draft_version.elements.not_nested.available.each do |element|
+                  Alchemy::Element.copy(element, page_version_id: version.id)
+                end
+              end
+            end
+
+            print "."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader/tasks/ingredients_migrator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "alchemy/upgrader"
+
+module Alchemy::Upgrader::Tasks
+  class IngredientsMigrator < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def create_ingredients
+        Alchemy::Deprecation.silence do
+          elements_with_ingredients = Alchemy::ElementDefinition.all.select { |d| d.key?(:ingredients) }
+          if ENV["ONLY"]
+            elements_with_ingredients = elements_with_ingredients.select { |d| d[:name].in? ENV["ONLY"].split(",") }
+          end
+          # eager load all elements that have ingredients defined but no ingredient records yet.
+          all_elements = Alchemy::Element
+            .named(elements_with_ingredients.map { |d| d[:name] })
+            .includes(contents: { essence: :ingredient_association })
+            .left_outer_joins(:ingredients).where(alchemy_ingredients: { id: nil })
+            .to_a
+          elements_with_ingredients.map do |element_definition|
+            elements = all_elements.select { |e| e.name == element_definition[:name] }
+            if elements.any?
+              puts "-- Creating ingredients for #{elements.count} #{element_definition[:name]}(s)"
+              elements.each do |element|
+                Alchemy::Element.transaction do
+                  element_definition[:ingredients].each do |ingredient_definition|
+                    content = element.content_by_name(ingredient_definition[:role])
+                    next unless content
+
+                    essence = content.essence
+                    ingredient = element.ingredients.build(
+                      role: ingredient_definition[:role],
+                      type: Alchemy::Ingredient.normalize_type(ingredient_definition[:type]),
+                    )
+                    belongs_to_associations = essence.class.reflect_on_all_associations(:belongs_to)
+                    if belongs_to_associations.any?
+                      ingredient.related_object = essence.public_send(belongs_to_associations.first.name)
+                    else
+                      ingredient.value = content.ingredient
+                    end
+                    data = ingredient.class.stored_attributes.fetch(:data, []).each_with_object({}) do |attr, d|
+                      d[attr] = essence.public_send(attr)
+                    end
+                    ingredient.data = data
+                    print "."
+                    ingredient.save!
+                    content.destroy!
+                  end
+                end
+              end
+              puts "\n"
+            else
+              puts "-- No #{element_definition[:name]} elements found for migration."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "5.2.0"
+  VERSION = "6.0.0.b3"
 
   def self.version
     VERSION

data/lib/alchemy_cms.rb

@@ -54,6 +54,7 @@ require_relative "alchemy/permissions"
 require_relative "alchemy/resource"
 require_relative "alchemy/tinymce"
 require_relative "alchemy/taggable"
+require_relative "alchemy/version"
 
 # Require hacks
 require_relative "kaminari/scoped_pagination_url_helper"

data/lib/generators/alchemy/elements/elements_generator.rb

@@ -14,6 +14,7 @@ module Alchemy
         @elements.each do |element|
           @element = element
           @contents = element["contents"] || []
+          @ingredients = element["ingredients"] || []
           @element_name = element_name(element)
           conditional_template "view.html.#{template_engine}", "#{elements_dir}/_#{@element_name}.html.#{template_engine}"
         end

data/lib/generators/alchemy/elements/templates/view.html.erb

@@ -9,6 +9,15 @@
     <%%= el.render :<%= content["name"] %> %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    <div class="<%= ingredient["role"] %>">
+      <%%= el.render(:<%= ingredient["role"] %>) %>
+    </div>
+    <%- else -%>
+    <%%= el.render(:<%= ingredient["role"] %>) %>
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     <%%= render <%= @element_name %>.nested_elements.available %>
   <%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.haml

@@ -8,6 +8,15 @@
     = el.render :<%= content["name"] %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    .<%= ingredient["role"] %>
+      = el.render(:<%= ingredient["role"] %>)
+    </div>
+    <%- else -%>
+    = el.render(:<%= ingredient["role"] %>)
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.slim

@@ -8,6 +8,15 @@
     = el.render :<%= content["name"] %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    .<%= ingredient["role"] %>
+      = el.render(:<%= ingredient["role"] %>)
+    </div>
+    <%- else -%>
+    = el.render(:<%= ingredient["role"] %>)
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/generators/alchemy/ingredient/ingredient_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "rails"
+
+module Alchemy
+  module Generators
+    class IngredientGenerator < ::Rails::Generators::Base
+      desc "This generator generates an Alchemy ingredient class for you."
+      argument :class_name, banner: "ingredient_class_name"
+      source_root File.expand_path("templates", __dir__)
+
+      def init
+        @class_name = class_name.classify
+        @ingredients_view_path = "app/views/alchemy/ingredients"
+      end
+
+      def create_model
+        template "model.rb.tt", "app/models/alchemy/ingredients/#{file_name}.rb"
+      end
+
+      def copy_templates
+        @ingredient_editor_local = "#{file_name}_editor"
+        @ingredient_view_local = "#{file_name}_view"
+        template "view.html.erb", "#{@ingredients_view_path}/_#{file_name}_view.html.erb"
+        template "editor.html.erb", "#{@ingredients_view_path}/_#{file_name}_editor.html.erb"
+      end
+
+      def show_todo
+        say "\nPlease check the generated files and alter them to fit your needs."
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= @class_name.classify.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/generators/alchemy/ingredient/templates/editor.html.erb

@@ -0,0 +1,14 @@
+<%%#
+  Available locals:
+  * <%= @ingredient_editor_local %> - An Alchemy::IngredientEditor instance
+
+  Please consult Alchemy::IngredientEditor.rb docs for further methods on the ingredient object
+%>
+<%%= content_tag :div,
+  class: <%= @ingredient_editor_local %>.css_classes,
+  data: <%= @ingredient_editor_local %>.data_attributes do %>
+  <%%= element_form.fields_for(:ingredients, <%= @ingredient_editor_local %>.ingredient) do |f| %>
+    <%%= ingredient_label(<%= @ingredient_editor_local %>) %>
+    <%%= f.text_field :value %>
+  <%% end %>
+<%% end %>

data/lib/generators/alchemy/ingredient/templates/model.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    class <%= @class_name %> < Alchemy::Ingredient
+      # Set additional attributes that get stored in the `data` JSON column
+      # store_accessor :data, :some, :attribute
+
+      # Set a related_object alias for convenience
+      # related_object_alias :some_association_name, class_name: "Some::Klass"
+    end
+  end
+end

data/lib/generators/alchemy/ingredient/templates/view.html.erb

@@ -0,0 +1 @@
+<%%= <%= @ingredient_view_local %>.value %>

data/lib/generators/alchemy/install/templates/dragonfly.rb.tt

@@ -7,7 +7,7 @@
 # http://markevans.github.io/dragonfly/cache/
 #
 # A complete reference can be found at
-# http://markevans.github.io/dragonfly/configuration/
+# http://markevans.github.io/dragonfly/configuration
 #
 # Pictures
 #

data/lib/generators/alchemy/menus/templates/node.html.erb

@@ -1,4 +1,4 @@
-<%% cache node do %>
+<%% cache [node, @page, @preview_mode] do %>
   <%%= content_tag :li, class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do %>
     <%%= link_to_if node.url,
       node.name,

data/lib/generators/alchemy/menus/templates/node.html.haml

@@ -1,4 +1,4 @@
-- cache node do
+- cache [node, @page, @preview_mode] do
   = content_tag :li,
     class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do
     = link_to_if node.url,

data/lib/generators/alchemy/menus/templates/node.html.slim

@@ -1,4 +1,4 @@
-- cache node do
+- cache [node, @page, @preview_mode] do
   = content_tag :li,
     class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do
     = link_to_if node.url,

data/lib/generators/alchemy/menus/templates/wrapper.html.erb

@@ -1,4 +1,4 @@
-<%% cache menu do %>
+<%% cache [menu, @page, @preview_mode] do %>
   <ul class="nav">
     <%%= render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),

data/lib/generators/alchemy/menus/templates/wrapper.html.haml

@@ -1,4 +1,4 @@
-- cache menu do
+- cache [menu, @page, @preview_mode] do
   %ul.nav
     = render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),