alchemy_cms 5.1.0 → 5.2.0

data/config/locales/alchemy.en.yml

@@ -130,31 +130,45 @@ en:
     # == Mime Types translations
     # These are human readable mime types used for the document-type row in archive files.
     mime_types:
-      audio/mp4: 'MP4-Audio'
-      application/msword: 'Word-Document'
-      application/rtf: 'RTF-Document'
-      audio/mpeg: 'MP3-Audio'
-      text/plain: 'Text-Document'
-      video/mp4: 'MP4-Video'
-      video/mpeg: 'MPEG-Video'
-      application/pdf: 'PDF-Document'
-      application/x-flash-video: 'Flash-Video'
-      video/x-flv: 'Flash-Video'
-      application/x-shockwave-flash: 'Flash-Movie'
-      application/zip: 'ZIP-Archive'
-      application/x-rar: 'RAR-Archive'
+      application/msexcel: Excel Spreadsheet
+      application/mspowerpoint: PowerPoint Presentation
+      application/msword: Word Document
+      application/pdf: PDF Document
+      application/rtf: RTF Document
+      application/vcard: vCard
       application/vnd:
-        ms-excel: 'Excel-Document'
-      video/quicktime: 'Quicktime-Video'
-      image/x-psd: 'Photoshop-File'
-      image/gif: 'GIF-Image'
-      image/png: 'PNG-Image'
-      image/jpeg: 'JPG-Image'
-      video/x-msvideo: 'AVI-Video'
-      video/x-ms-wmv: 'Windows Media Video'
-      image/tiff: 'TIFF-Image'
-      'text/x-vcard': 'vCard'
-      application/vcard: 'vCard'
+        ms-excel: Excel Spreadsheet
+        ms-powerpoint: PowerPoint Presentation
+        ms-word: Word Document
+        openxmlformats-officedocument:
+          presentationml:
+            presentation: PowerPoint 2007 Presentation
+          spreadsheetml:
+            sheet: Excel 2007 Spreadsheet
+          wordprocessingml:
+            document: Word 2007 Document
+      application/x-flash-video: Flash Video
+      application/x-rar: RAR Archive
+      application/x-shockwave-flash: Flash Movie
+      application/zip: ZIP Archive
+      audio/mp4: MPEG-4 Audio
+      audio/mpeg: MP3 Audio
+      audio/wav: WAV Audio
+      audio/x-wav: WAV Audio
+      image/gif: GIF Image
+      image/jpeg: JPG Image
+      image/png: PNG Image
+      image/tiff: TIFF Image
+      image/x-psd: Photoshop File
+      image/svg+xml: SVG Image
+      text/plain: Plain Text Document
+      text/x-vcard: vCard
+      video/mp4: MPEG-4 Video
+      video/mpeg: MPEG Video
+      video/quicktime: Quicktime Video
+      video/x-flv: Flash Video
+      video/x-ms-wmv: Windows Media Video
+      video/x-msvideo: AVI Video
 
     link_target_options:
       default: Same Window
@@ -295,7 +309,9 @@ en:
     "Visit page": "Visit page"
     "Warning!": "Warning!"
     content_definition_missing: "Warning: Content is missing its definition. Please check the elements.yml"
+    content_deprecated: "WARNING! This content is deprecated and will be removed soon. Please do not use it anymore."
     element_definition_missing: "WARNING! Missing element definition. Please check your elements.yml file."
+    element_deprecated: "WARNING! This element is deprecated and will be removed soon. Please do not use it anymore."
     page_definition_missing: "WARNING! Missing page layout definition. Please check your page_layouts.yml file."
     "Welcome to Alchemy": "Welcome to Alchemy"
     "Who else is online": "Who else is online"

data/lib/alchemy/deprecation.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Alchemy
-  Deprecation = ActiveSupport::Deprecation.new("5.1", "Alchemy")
+  Deprecation = ActiveSupport::Deprecation.new("6.0", "Alchemy")
 end

data/lib/alchemy/element_definition.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class ElementDefinition
+    class << self
+      # Returns the definitions from elements.yml file.
+      #
+      # Place a +elements.yml+ file inside your apps +config/alchemy+ folder to define
+      # your own set of elements
+      #
+      def all
+        @definitions ||= read_definitions_file.map(&:with_indifferent_access)
+      end
+
+      # Add additional page definitions to collection.
+      #
+      # Useful for extending the elements from an Alchemy module.
+      #
+      # === Usage Example
+      #
+      #   Call +Alchemy::ElementDefinition.add(your_definition)+ in your engine.rb file.
+      #
+      # @param [Array || Hash]
+      #   You can pass a single element definition as Hash, or a collection of elements as Array.
+      #
+      def add(element)
+        all
+        if element.is_a?(Array)
+          @definitions += element
+        elsif element.is_a?(Hash)
+          @definitions << element
+        else
+          raise TypeError
+        end
+      end
+
+      # Returns one element definition by given name.
+      #
+      def get(name)
+        return {} if name.blank?
+
+        all.detect { |a| a["name"] == name }
+      end
+
+      private
+
+      # Reads the element definitions from +config/alchemy/elements.yml+.
+      #
+      def read_definitions_file
+        if File.exist?(definitions_file_path)
+          YAML.safe_load(
+            ERB.new(File.read(definitions_file_path)).result,
+            YAML_WHITELIST_CLASSES,
+            [],
+            true
+          ) || []
+        else
+          raise LoadError,
+                "Could not find elements.yml file! Please run `rails generate alchemy:install`"
+        end
+      end
+
+      # Returns the elements.yml file path
+      #
+      def definitions_file_path
+        Rails.root.join "config/alchemy/elements.yml"
+      end
+    end
+  end
+end

data/lib/alchemy/elements_finder.rb

@@ -26,8 +26,6 @@ module Alchemy
     #   Randomize the output of elements
     # @option options [Boolean] :reverse (false)
     #   Reverse the load order
-    # @option options [Hash] :fallback
-    #   Define elements that are loaded from another page if no element was found on given page.
     def initialize(options = {})
       @options = options
     end
@@ -83,6 +81,9 @@ module Alchemy
       when Alchemy::Page
         page_or_layout
       when String
+        Alchemy::Deprecation.warn "Passing a String as `from_page` option to " \
+          "`render_elements` is deprecated and will be removed with Alchemy 6.0. " \
+          "Please load the page beforehand and pass it as an object instead."
         Alchemy::Page.find_by(
           language: Alchemy::Language.current,
           page_layout: page_or_layout,
@@ -92,6 +93,9 @@ module Alchemy
     end
 
     def fallback_required?(elements)
+      if options[:fallback]
+        Alchemy::Deprecation.warn "Passing `fallback` options to `render_elements` is deprecated an will be removed with Alchemy 6.0."
+      end
       options[:fallback] && elements
         .where(Alchemy::Element.table_name => {name: options[:fallback][:for]})
         .none?

data/lib/alchemy/essence.rb

@@ -83,7 +83,7 @@ module Alchemy #:nodoc:
 
         if configuration[:belongs_to]
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            belongs_to :ingredient_association, #{configuration[:belongs_to]}
+            belongs_to :ingredient_association, **#{configuration[:belongs_to]}
 
             alias_method :#{configuration[:ingredient_column]}, :ingredient_association
             alias_method :#{configuration[:ingredient_column]}=, :ingredient_association=
@@ -108,9 +108,9 @@ module Alchemy #:nodoc:
       # Register the current class as has_many association on +Alchemy::Page+ and +Alchemy::Element+ models
       def register_as_essence_association!
         klass_name = model_name.to_s
-        arguments = [:has_many, klass_name.demodulize.tableize.to_sym, through: :contents,
-                                                                       source: :essence, source_type: klass_name]
-        %w(Page Element).each { |k| "Alchemy::#{k}".constantize.send(*arguments) }
+        arguments = [:has_many, klass_name.demodulize.tableize.to_sym]
+        kwargs = { through: :contents, source: :essence, source_type: klass_name }
+        %w(Page Element).each { |k| "Alchemy::#{k}".constantize.send(*arguments, **kwargs) }
       end
     end
 

data/lib/alchemy/filetypes.rb

@@ -40,7 +40,20 @@ module Alchemy
     EXCEL_FILE_TYPES = [
       "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
       "application/vnd.ms-excel",
+      "application/msexcel",
       "text/csv",
     ]
+
+    WORD_FILE_TYPES = [
+      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+      "application/vnd.ms-word",
+      "application/msword",
+    ]
+
+    POWERPOINT_FILE_TYPES = [
+      "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+      "application/vnd.ms-powerpoint",
+      "application/mspowerpoint",
+    ]
   end
 end

data/lib/alchemy/forms/builder.rb

@@ -11,7 +11,7 @@ module Alchemy
         if object.respond_to?(:attribute_fixed?) && object.attribute_fixed?(attribute_name)
           options[:disabled] = true
           options[:input_html] = options.fetch(:input_html, {}).merge(
-            "data-alchemy-tooltip" => Alchemy.t(:attribute_fixed, attribute_name),
+            "data-alchemy-tooltip" => Alchemy.t(:attribute_fixed, attribute: attribute_name),
           )
         end
 

data/lib/alchemy/i18n.rb

@@ -12,8 +12,8 @@ module Alchemy
     #
     #     Alchemy.t(:hello)
     #
-    def t(msg, *args)
-      Alchemy::I18n.translate(msg, *args)
+    def t(msg, **kwargs)
+      Alchemy::I18n.translate(msg, **kwargs)
     end
   end
 
@@ -47,11 +47,10 @@ module Alchemy
       #       world:
       #         hello: Hallo
       #
-      def translate(msg, *args)
-        options = args.extract_options!
+      def translate(msg, **options)
         humanize_default_string!(msg, options)
         scope = alchemy_scoped_scope(options)
-        ::I18n.t(msg, options.merge(scope: scope))
+        ::I18n.t(msg, **options.merge(scope: scope))
       end
 
       def available_locales

data/lib/alchemy/page_layout.rb

@@ -74,6 +74,7 @@ module Alchemy
         end
         mapped_layouts_for_select(layouts)
       end
+      deprecate :layouts_with_own_for_select, deprecator: Alchemy::Deprecation
 
       # Returns all layouts that can be used for creating a new page.
       #

data/lib/alchemy/resource.rb

@@ -132,7 +132,9 @@ module Alchemy
     end
 
     def namespaced_resource_name
-      @_namespaced_resource_name ||= namespaced_resources_name.singularize
+      @_namespaced_resource_name ||= begin
+        namespaced_resources_name.to_s.singularize
+      end.to_sym # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     def namespaced_resources_name
@@ -140,13 +142,13 @@ module Alchemy
         resource_name_array = resource_array.dup
         resource_name_array.delete(engine_name) if in_engine?
         resource_name_array.join("_")
-      end
+      end.to_sym # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     def namespace_for_scope
       namespace_array = namespace_diff
       namespace_array.delete(engine_name) if in_engine?
-      namespace_array
+      namespace_array.map(&:to_sym) # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     # Returns an array of underscored association names

data/lib/alchemy/test_support.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module TestSupport
+    class << self
+      def factory_paths
+        Dir[
+          ::Alchemy::Engine.root.join("lib", "alchemy", "test_support", "factories", "*_factory.rb")
+        ].map { |path| path.sub(/.rb\z/, "") }
+      end
+      deprecate factory_paths: :factories_path, deprecator: Alchemy::Deprecation
+
+      def factories_path
+        ::Alchemy::Engine.root.join("lib", "alchemy", "test_support", "factories")
+      end
+    end
+  end
+end

data/lib/alchemy/test_support/essence_shared_examples.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require "shoulda-matchers"
-require "alchemy/test_support/factories/page_factory"
-require "alchemy/test_support/factories/element_factory"
-require "alchemy/test_support/factories/content_factory"
 
 RSpec.shared_examples_for "an essence" do
   let(:element) { Alchemy::Element.new }

data/lib/alchemy/test_support/factories.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 
+Alchemy::Deprecation.warn <<~MSG
+  Please require factories using FactoryBots preferred approach:
+
+      # spec/rails_helper.rb
+
+      require 'alchemy/test_support'
+
+      FactoryBot.definition_file_paths.append(Alchemy::TestSupport.factories_path)
+      FactoryBot.find_definitions
+MSG
+
 Dir["#{File.dirname(__FILE__)}/factories/*.rb"].sort.each do |file|
   require file
 end

data/lib/alchemy/test_support/factories/attachment_factory.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-
 FactoryBot.define do
   factory :alchemy_attachment, class: "Alchemy::Attachment" do
     file do

data/lib/alchemy/test_support/factories/content_factory.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/element_factory"
-require "alchemy/test_support/factories/essence_file_factory"
-require "alchemy/test_support/factories/essence_picture_factory"
-require "alchemy/test_support/factories/essence_text_factory"
-
 FactoryBot.define do
   factory :alchemy_content, class: "Alchemy::Content" do
     name { "text" }

data/lib/alchemy/test_support/factories/dummy_user_factory.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-
 FactoryBot.define do
   factory :alchemy_dummy_user, class: "DummyUser" do
     sequence(:email) { |n| "john.#{n}@doe.com" }

data/lib/alchemy/test_support/factories/element_factory.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/page_factory"
-
 FactoryBot.define do
   factory :alchemy_element, class: "Alchemy::Element" do
     name { "article" }

data/lib/alchemy/test_support/factories/essence_file_factory.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/attachment_factory"
-
 FactoryBot.define do
   factory :alchemy_essence_file, class: "Alchemy::EssenceFile" do
     attachment factory: :alchemy_attachment

data/lib/alchemy/test_support/factories/essence_page_factory.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/page_factory"
-
 FactoryBot.define do
   factory :alchemy_essence_page, class: "Alchemy::EssencePage" do
     page factory: :alchemy_page

data/lib/alchemy/test_support/factories/essence_picture_factory.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/content_factory"
-require "alchemy/test_support/factories/picture_factory"
-
 FactoryBot.define do
   factory :alchemy_essence_picture, class: "Alchemy::EssencePicture" do
     picture factory: :alchemy_picture

data/lib/alchemy/test_support/factories/essence_text_factory.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-
 FactoryBot.define do
   factory :alchemy_essence_text, class: "Alchemy::EssenceText" do
     body { "This is a headline" }

data/lib/alchemy/test_support/factories/language_factory.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "factory_bot"
-require "alchemy/test_support/factories/site_factory"
-
 FactoryBot.define do
   factory :alchemy_language, class: "Alchemy::Language" do
     name { "Your Language" }