alchemy_cms 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7244fdbb3c06cd1c7375f6006d94e5b5b16a860d62fb9268fedc79a42d52e7fd
-  data.tar.gz: 1b46460a9e387144126d5d4d17a905697e6a80dc8d480743dcbd5a0c8c99d3ca
+  metadata.gz: 80ac30c5b218ae66fdfc00afbaf2185829f52e94b32b76c4b6af8a19c5ec2ac8
+  data.tar.gz: 3da61ba5c95787cd3524ffad4e36f774b238fcf0456732a0cf69dac24dcbf0e7
 SHA512:
-  metadata.gz: e4c138b229e5653765b5ae2ade3a34acdc644a489891ae4664e878e6c7c8ecb32080d76403a167a0d2b05d5349be0903628a6c747cfeae1bec927571d1094928
-  data.tar.gz: '08fde58900a7e4359888c5409d59f8492f94025b14f131d69526acef5b0cd4378c39af534624e35edc47b2fa2d55a738db366ae9c349056db3a22ae00277ed6a'
+  metadata.gz: 690da4b19ddbc96671c403bb616da433c37b35eeb0eee142de4f1ebe957f4f7ad9cd0da1e8e8e9e37cb773fbe1aec858166089673921b1ff463bc1dd0028bf91
+  data.tar.gz: 9f937fdb379c6df8c64976ec52ae4aef56bf597533e1d3ece0c987ef4604d91dfdb75eb246ce9aa68338d1a1814941f53d982093b378ab8089b3026f8997582b

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   RSpec:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
     strategy:
       fail-fast: false
       matrix:
@@ -14,6 +14,7 @@ jobs:
         ruby:
           - '2.5.x'
           - '2.6.x'
+          - '2.7.x'
         database:
           - mysql
           - postgresql

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+## 5.2.0 (2021-05-06)
+
+- Backport #2049 to 5.2 [#2086](https://github.com/AlchemyCMS/alchemy_cms/pull/2086) ([rickythefox](https://github.com/rickythefox))
+- hotfix and deprecate page_active? helper [#2073](https://github.com/AlchemyCMS/alchemy_cms/pull/2073) ([robinboening](https://github.com/robinboening))
+
+## 5.2.0.rc1 (2021-02-17)
+
+### Changes
+
+- Change Factory loading mechanism to FactoryBots supported mechanism [#2030](https://github.com/AlchemyCMS/alchemy_cms/pull/2030) ([mamhoff](https://github.com/mamhoff))
+
+## 5.2.0.b1 (2021-02-11)
+
+### Features
+
+- Allow Element and Content deprecation notices [#1988](https://github.com/AlchemyCMS/alchemy_cms/pull/1988) ([tvdeyen](https://github.com/tvdeyen))
+- Add element definition api (based on PageLayout definitions) [#1986](https://github.com/AlchemyCMS/alchemy_cms/pull/1986) ([stockime](https://github.com/stockime))
+
+### Changes
+
+- Fix jpeg quality option for jpeg files [#2016](https://github.com/AlchemyCMS/alchemy_cms/pull/2016) ([kulturbande](https://github.com/kulturbande))
+- Pin Ransack to below 2.4.2 [#2012](https://github.com/AlchemyCMS/alchemy_cms/pull/2012) ([tvdeyen](https://github.com/tvdeyen))
+- Fix setting current_user in integration helper [#2006](https://github.com/AlchemyCMS/alchemy_cms/pull/2006) ([tvdeyen](https://github.com/tvdeyen))
+- Update mime type icons and translations [#2002](https://github.com/AlchemyCMS/alchemy_cms/pull/2002) ([tvdeyen](https://github.com/tvdeyen))
+- Deprecate page layout change [#1993](https://github.com/AlchemyCMS/alchemy_cms/pull/1993) ([tvdeyen](https://github.com/tvdeyen))
+- Fix Ruby 2.7 deprecations [#1989](https://github.com/AlchemyCMS/alchemy_cms/pull/1989) ([tvdeyen](https://github.com/tvdeyen))
+- Deprecate trash [#1985](https://github.com/AlchemyCMS/alchemy_cms/pull/1985) ([tvdeyen](https://github.com/tvdeyen))
+- Deprecate elements fallbacks [#1982](https://github.com/AlchemyCMS/alchemy_cms/pull/1982) ([tvdeyen](https://github.com/tvdeyen))
+
+### Misc
+
+- Use Ubuntu 18.04 on GH actions [#2018](https://github.com/AlchemyCMS/alchemy_cms/pull/2018) ([tvdeyen](https://github.com/tvdeyen))
+- [ruby - main] Upgrade rubocop to version 1.9.0 [#2011](https://github.com/AlchemyCMS/alchemy_cms/pull/2011) ([depfu](https://github.com/apps/depfu))
+- [ruby - main] Upgrade rubocop to version 1.8.1 [#1999](https://github.com/AlchemyCMS/alchemy_cms/pull/1999) ([depfu](https://github.com/apps/depfu))
+- Update brakeman ignores [#1992](https://github.com/AlchemyCMS/alchemy_cms/pull/1992) ([tvdeyen](https://github.com/tvdeyen))
+- [ruby - main] Upgrade rubocop to version 1.6.1 [#1978](https://github.com/AlchemyCMS/alchemy_cms/pull/1978) ([depfu](https://github.com/apps/depfu))
+- [ruby - main] Upgrade simplecov to version 0.20.0 [#1971](https://github.com/AlchemyCMS/alchemy_cms/pull/1971) ([depfu](https://github.com/apps/depfu))
+
+## 5.1.2 (2021-01-26)
+
+- Allow to safe hidden elements [#2007](https://github.com/AlchemyCMS/alchemy_cms/pull/2007) ([tvdeyen](https://github.com/tvdeyen))
+
+
+## 5.1.1 (2021-01-12)
+
+- Fix copy element feature [#1996](https://github.com/AlchemyCMS/alchemy_cms/pull/1996) ([tvdeyen](https://github.com/tvdeyen))
+
 ## 5.1.0 (2020-12-18)
 
 ### Features
@@ -58,6 +105,10 @@
 - [ruby] Upgrade rubocop to version 0.88.0 [#1892](https://github.com/AlchemyCMS/alchemy_cms/pull/1892) ([depfu](https://github.com/apps/depfu))
 - [ruby] Upgrade rubocop to version 0.87.1 [#1889](https://github.com/AlchemyCMS/alchemy_cms/pull/1889) ([depfu](https://github.com/apps/depfu))
 
+## 5.0.3 (2021-01-12)
+
+- Fix copy element feature [#1996](https://github.com/AlchemyCMS/alchemy_cms/pull/1996) ([tvdeyen](https://github.com/tvdeyen))
+
 ## 5.0.2 (2020-12-18)
 
 - Fix page sorting [#1984](https://github.com/AlchemyCMS/alchemy_cms/pull/1984) ([tvdeyen](https://github.com/tvdeyen))

data/Gemfile

@@ -22,7 +22,7 @@ group :development, :test do
     gem "yard"
     gem "redcarpet"
     gem "pry-byebug"
-    gem "rubocop", "~> 1.1.0", require: false
+    gem "rubocop", "~> 1.9.0", require: false
     gem "listen"
     gem "localeapp", "~> 3.0", require: false
     gem "dotenv", "~> 2.2"
@@ -30,5 +30,6 @@ group :development, :test do
     gem "active_record_query_trace", require: false
     gem "rack-mini-profiler", require: false
     gem "rufo", require: false
+    gem "brakeman", require: false
   end
 end

data/alchemy_cms.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'originator',                       ['~> 3.1']
   gem.add_runtime_dependency 'non-stupid-digest-assets',         ['~> 1.0.8']
   gem.add_runtime_dependency 'rails',                            ['>= 5.2.0', '< 6.1']
-  gem.add_runtime_dependency 'ransack',                          ['>= 1.8', '< 3.0']
+  gem.add_runtime_dependency 'ransack',                          ['>= 1.8', '< 2.4.2'] # 2.4.2 dropped Ruby 2.5 support in a patch level release
   gem.add_runtime_dependency 'request_store',                    ['~> 1.2']
   gem.add_runtime_dependency 'responders',                       ['>= 2.0', '< 4.0']
   gem.add_runtime_dependency 'sassc-rails',                      ['~> 2.1']
@@ -49,7 +49,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rails-controller-testing',     ['~> 1.0']
   gem.add_development_dependency 'rspec-activemodel-mocks',      ['~> 1.0']
   gem.add_development_dependency 'rspec-rails',                  ['>= 4.0.0.beta2']
-  gem.add_development_dependency 'simplecov',                    ['~> 0.17.1']
+  gem.add_development_dependency 'simplecov',                    ['~> 0.20']
   gem.add_development_dependency 'webdrivers',                   ['~> 4.0']
   gem.add_development_dependency 'webmock',                      ['~> 3.3']
   gem.add_development_dependency 'shoulda-matchers',             ['~> 4.0']

data/app/assets/stylesheets/alchemy/_variables.scss

@@ -145,6 +145,8 @@ $elements-window-min-width: 400px !default;
 $element-header-bg-color: $medium-gray !default;
 $element-header-active-bg-color: $dark-blue !default;
 $element-header-active-color: $white !default;
+$element-header-deprecated-bg-color: rgba(253, 213, 175, 0.25) !default;
+$element-deprecated-border-color: rgb(253, 213, 175) !default;
 $top-menu-height: 75px !default;
 
 $tabs-height: 31px !default;

data/app/assets/stylesheets/alchemy/elements.scss

@@ -170,13 +170,32 @@
     }
   }
 
+  &.deprecated {
+    border-color: $element-deprecated-border-color;
+
+    > .element-header {
+      background-color: $element-header-deprecated-bg-color;
+      background-image: linear-gradient(
+        45deg,
+        $element-header-deprecated-bg-color 25%,
+        $element-header-bg-color 25%,
+        $element-header-bg-color 50%,
+        $element-header-deprecated-bg-color 50%,
+        $element-header-deprecated-bg-color 75%,
+        $element-header-bg-color 75%,
+        $element-header-bg-color 100%
+      );
+      background-size: 28.28px 28.28px;
+    }
+  }
+
   &.selected:not(.is-fixed), &:hover {
     &:not(.hidden) {
       box-shadow: 0 2px 8px rgba(#9b9b9b, 0.75);
     }
   }
 
-  &.selected:not(.is-fixed):not(.folded):not(.dirty):not(.hidden) {
+  &.selected:not(.is-fixed):not(.folded):not(.dirty):not(.hidden):not(.deprecated) {
     > .element-header {
       background-color: $element-header-active-bg-color;
       color: $element-header-active-color;
@@ -670,6 +689,24 @@ select.long {
     }
   }
 
+  &.deprecated {
+    border-radius: $default-border-radius;
+    background-color: $element-header-deprecated-bg-color;
+    background-image: linear-gradient(
+      45deg,
+      $element-header-deprecated-bg-color 25%,
+      $element-header-bg-color 25%,
+      $element-header-bg-color 50%,
+      $element-header-deprecated-bg-color 50%,
+      $element-header-deprecated-bg-color 75%,
+      $element-header-bg-color 75%,
+      $element-header-bg-color 100%
+    );
+    background-size: 28.28px 28.28px;
+    padding-left: 2px;
+    padding-right: 2px;
+  }
+
   label {
     display: block;
     margin: $default-margin 0;
@@ -802,10 +839,6 @@ textarea.has_tinymce {
   }
 }
 
-.element-handle .hint-with-icon {
-  top: -1px;
-}
-
 .is-fixed {
   &.with-contents {
     >.element-footer {

data/app/controllers/alchemy/admin/base_controller.rb

@@ -72,6 +72,7 @@ module Alchemy
       def trash_empty?(category)
         "alchemy/#{category.singularize}".classify.constantize.trashed.blank?
       end
+      deprecate :trash_empty?, deprecator: Alchemy::Deprecation
 
       def set_stamper
         if Alchemy.user_class < ActiveRecord::Base

data/app/controllers/alchemy/admin/trash_controller.rb

@@ -12,12 +12,14 @@ module Alchemy
         @page = Page.find(params[:page_id])
         @allowed_elements = @page.available_element_definitions
       end
+      deprecate :index, deprecator: Alchemy::Deprecation
 
       def clear
         @page = Page.find(params[:page_id])
         @elements = Element.trashed
         @elements.map(&:destroy)
       end
+      deprecate :clear, deprecator: Alchemy::Deprecation
 
       private
 

data/app/decorators/alchemy/content_editor.rb

@@ -12,6 +12,7 @@ module Alchemy
       [
         "content_editor",
         essence_partial_name,
+        deprecated? ? "deprecated" : nil,
       ].compact
     end
 
@@ -51,5 +52,68 @@ module Alchemy
 
       super
     end
+
+    def has_warnings?
+      definition.blank? || deprecated?
+    end
+
+    def warnings
+      return unless has_warnings?
+
+      if definition.blank?
+        Logger.warn("Content #{name} is missing its definition", caller(1..1))
+        Alchemy.t(:content_definition_missing)
+      else
+        deprecation_notice
+      end
+    end
+
+    # Returns a deprecation notice for contents marked deprecated
+    #
+    # You can either use localizations or pass a String as notice
+    # in the content definition.
+    #
+    # == Custom deprecation notices
+    #
+    # Use general content deprecation notice
+    #
+    #     - name: element_name
+    #       contents:
+    #         - name: old_content
+    #           type: EssenceText
+    #           deprecated: true
+    #
+    # Add a translation to your locale file for a per content notice.
+    #
+    #     en:
+    #       alchemy:
+    #         content_deprecation_notices:
+    #           element_name:
+    #             old_content: Foo baz widget is deprecated
+    #
+    # or use the global translation that apply to all deprecated contents.
+    #
+    #     en:
+    #       alchemy:
+    #         content_deprecation_notice: Foo baz widget is deprecated
+    #
+    # or pass string as deprecation notice.
+    #
+    #     - name: element_name
+    #       contents:
+    #         - name: old_content
+    #           type: EssenceText
+    #           deprecated: This content will be removed soon.
+    #
+    def deprecation_notice
+      case definition["deprecated"]
+      when String
+        definition["deprecated"]
+      when TrueClass
+        Alchemy.t(name,
+                  scope: [:content_deprecation_notices, element.name],
+                  default: Alchemy.t(:content_deprecated))
+      end
+    end
   end
 end

data/app/decorators/alchemy/element_editor.rb

@@ -8,6 +8,17 @@ module Alchemy
       "alchemy/admin/elements/element"
     end
 
+    # Returns content editor instances for defined contents
+    #
+    # Creates contents on demand if the content is not yet present on the element
+    #
+    # @return Array<Alchemy::ContentEditor>
+    def contents
+      element.definition.fetch(:contents, []).map do |content|
+        Alchemy::ContentEditor.new(find_or_create_content(content[:name]))
+      end
+    end
+
     # CSS classes for the element editor partial.
     def css_classes
       [
@@ -17,6 +28,7 @@ module Alchemy
         taggable? ? "taggable" : "not-taggable",
         folded ? "folded" : "expanded",
         compact? ? "compact" : nil,
+        deprecated? ? "deprecated" : nil,
         fixed? ? "is-fixed" : "not-fixed",
         public? ? "visible" : "hidden",
       ].join(" ")
@@ -36,5 +48,60 @@ module Alchemy
 
       super
     end
+
+    # Returns a deprecation notice for elements marked deprecated
+    #
+    # You can either use localizations or pass a String as notice
+    # in the element definition.
+    #
+    # == Custom deprecation notices
+    #
+    # Use general element deprecation notice
+    #
+    #     - name: old_element
+    #       deprecated: true
+    #
+    # Add a translation to your locale file for a per element notice.
+    #
+    #     en:
+    #       alchemy:
+    #         element_deprecation_notices:
+    #           old_element: Foo baz widget is deprecated
+    #
+    # or use the global translation that apply to all deprecated elements.
+    #
+    #     en:
+    #       alchemy:
+    #         element_deprecation_notice: Foo baz widget is deprecated
+    #
+    # or pass string as deprecation notice.
+    #
+    #     - name: old_element
+    #       deprecated: This element will be removed soon.
+    #
+    def deprecation_notice
+      case definition["deprecated"]
+      when String
+        definition["deprecated"]
+      when TrueClass
+        Alchemy.t(name,
+                  scope: :element_deprecation_notices,
+                  default: Alchemy.t(:element_deprecated))
+      end
+    end
+
+    private
+
+    def find_or_create_content(name)
+      find_content(name) || create_content(name)
+    end
+
+    def find_content(name)
+      element.contents.find { |content| content.name == name }
+    end
+
+    def create_content(name)
+      Alchemy::Content.create(element: element, name: name)
+    end
   end
 end

data/app/helpers/alchemy/admin/contents_helper.rb

@@ -19,13 +19,8 @@ module Alchemy
 
         content_name = content.name_for_label
 
-        if content.definition.blank?
-          warning("Content #{content.name} is missing its definition")
-
-          icon = hint_with_tooltip(
-            Alchemy.t(:content_definition_missing),
-          )
-
+        if content.has_warnings?
+          icon = hint_with_tooltip(content.warnings)
           content_name = "#{icon} #{content_name}".html_safe
         end
 
@@ -39,7 +34,7 @@ module Alchemy
       # Renders the label and a remove link for a content.
       def content_label(content)
         content_tag :label, for: content.form_field_id do
-          [render_hint_for(content), render_content_name(content)].compact.join(" ").html_safe
+          [render_content_name(content), render_hint_for(content)].compact.join(" ").html_safe
         end
       end
     end

data/app/helpers/alchemy/elements_helper.rb

@@ -28,22 +28,6 @@ module Alchemy
     #     <%= render_elements from_page: 'footer' %>
     #   </footer>
     #
-    # === Fallback to elements from global page:
-    #
-    # You can use the fallback option as an override for elements that are stored on another page.
-    # So you can take elements from a global page and only if the user adds an element on current page the
-    # local one gets rendered.
-    #
-    # 1. You have to pass the the name of the element the fallback is for as <tt>for</tt> key.
-    # 2. You have to pass a <tt>page_layout</tt> name or {Alchemy::Page} from where the fallback elements is taken from as <tt>from</tt> key.
-    # 3. You can pass the name of element to fallback with as <tt>with</tt> key. This is optional (the element name from the <tt>for</tt> key is taken as default).
-    #
-    #   <%= render_elements(fallback: {
-    #     for: 'contact_teaser',
-    #     from: 'sidebar',
-    #     with: 'contact_teaser'
-    #   }) %>
-    #
     # === Custom elements finder:
     #
     # Having a custom element finder class:
@@ -76,8 +60,6 @@ module Alchemy
     #   The amount of elements to be rendered (begins with first element found)
     # @option options [Number] :offset
     #   The offset to begin loading elements from
-    # @option options [Hash] :fallback
-    #   Define elements that are rendered from another page.
     # @option options [Boolean] :random (false)
     #   Randomize the output of elements
     # @option options [Boolean] :reverse (false)