alchemy_cms 6.0.0.b1 → 6.0.0.pre.b5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f491f19d3f42a56aa03e0a82724e1473413c926f9bb9a823f909726415bb844
-  data.tar.gz: 42c4841d037f5d351305b4e2c97fdc9298a4b886d51b666436c712f1c9c7ce80
+  metadata.gz: c960938b7e577abd1031dc1ff066eea2bc9636f2a94d61cab753ae42e1058768
+  data.tar.gz: d3dff1ab8a69b2dcfc2374aa78ecbbaad3c76d97fe66c23ede57d33e8f019f49
 SHA512:
-  metadata.gz: fbb3af41e4d5a9715507f87d38d87f0dea4ceb9c62750721587ce14a7e7aa32f89b7e044fac5b14ab68781539f80b16297cce668b0bef76eb96b099c157b751c
-  data.tar.gz: fdd0443e75620528d6434eeb13fb675db04f3a91911b92f66122df83c963a737509a99d968ddd48189195340ea00e06310919d3ba201906291088c66ee5ec455
+  metadata.gz: 73e65f16a6c35dd438645b36f359745db42d657ca6d7de7082714f879105c97ac296861790dc15f6c3411f25970519f2d01dc5c3b2525e88e8fc25a2fca38b80
+  data.tar.gz: 78dedcd0ca764496af5abc4a8800675205ef6f78deb511bf8cf2f4bb5025f4e6cfe7315dc9a4d54d114a33efbb6d5ad2b53fc4de881686c8df158c7d7dfa83dd

data/CHANGELOG.md

@@ -1,3 +1,49 @@
+## 6.0.0-b5 (2021-08-27)
+
+- Remove spec that tests default data store value [#2184](https://github.com/AlchemyCMS/alchemy_cms/pull/2184) ([tvdeyen](https://github.com/tvdeyen))
+- Remove data store accessor from ingredient base class [#2183](https://github.com/AlchemyCMS/alchemy_cms/pull/2183) ([tvdeyen](https://github.com/tvdeyen))
+
+## 6.0.0-b4 (2021-08-27)
+
+- Load custom Tinymce config for ingredients [#2182](https://github.com/AlchemyCMS/alchemy_cms/pull/2182) ([tvdeyen](https://github.com/tvdeyen))
+- Fix ingredient editor selector in element update callback [#2181](https://github.com/AlchemyCMS/alchemy_cms/pull/2181) ([tvdeyen](https://github.com/tvdeyen))
+- Ingredient by role block level helper [#2180](https://github.com/AlchemyCMS/alchemy_cms/pull/2180) ([tvdeyen](https://github.com/tvdeyen))
+- Fixes caching [#2179](https://github.com/AlchemyCMS/alchemy_cms/pull/2179) ([tvdeyen](https://github.com/tvdeyen))
+- make images non-executable [#2176](https://github.com/AlchemyCMS/alchemy_cms/pull/2176) ([mensfeld](https://github.com/mensfeld))
+- Release task [#2173](https://github.com/AlchemyCMS/alchemy_cms/pull/2173) ([tvdeyen](https://github.com/tvdeyen))
+
+## 6.0.0.b3 (2021-08-12)
+
+### Fixes
+
+- Simplify ingredient creation [#2171](https://github.com/AlchemyCMS/alchemy_cms/pull/2171) ([tvdeyen](https://github.com/tvdeyen))
+- Return ingredients value if element asked for ingredient [#2170](https://github.com/AlchemyCMS/alchemy_cms/pull/2170) ([tvdeyen](https://github.com/tvdeyen))
+- Fix ingredient form field DOM ids [#2167](https://github.com/AlchemyCMS/alchemy_cms/pull/2167) ([tvdeyen](https://github.com/tvdeyen))
+- Ensure resource table ends before the filter/tag sidebar [#2166](https://github.com/AlchemyCMS/alchemy_cms/pull/2166) ([robinboening](https://github.com/robinboening))
+- Return fully namespaced ingredient constant [#2164](https://github.com/AlchemyCMS/alchemy_cms/pull/2164) ([tvdeyen](https://github.com/tvdeyen))
+- (Re)-init Tinymce for elements with ingredients [#2163](https://github.com/AlchemyCMS/alchemy_cms/pull/2163) ([tvdeyen](https://github.com/tvdeyen))
+
+## 6.0.0.b2 (2021-08-05)
+
+### Features
+
+- Add datepicker simple form input [#2162](https://github.com/AlchemyCMS/alchemy_cms/pull/2162) ([tvdeyen](https://github.com/tvdeyen))
+- Feature flexible resource filters [#2091](https://github.com/AlchemyCMS/alchemy_cms/pull/2091) ([robinboening](https://github.com/robinboening))
+
+### Changes
+
+- Require alchemy/version [#2159](https://github.com/AlchemyCMS/alchemy_cms/pull/2159) ([tvdeyen](https://github.com/tvdeyen))
+- Make ingredient examples usable without elements.yml [#2158](https://github.com/AlchemyCMS/alchemy_cms/pull/2158) ([tvdeyen](https://github.com/tvdeyen))
+- Fix ingredient migrator (again) [#2155](https://github.com/AlchemyCMS/alchemy_cms/pull/2155) ([tvdeyen](https://github.com/tvdeyen))
+- Respect additional essence attributes during ingredients migration [#2154](https://github.com/AlchemyCMS/alchemy_cms/pull/2154) ([tvdeyen](https://github.com/tvdeyen))
+- Improve cache key defaults for menus [#2153](https://github.com/AlchemyCMS/alchemy_cms/pull/2153) ([oneiros](https://github.com/oneiros))
+- Make element preview text work with ingredients [#2152](https://github.com/AlchemyCMS/alchemy_cms/pull/2152) ([tvdeyen](https://github.com/tvdeyen))
+- Do not leak all records for guest users in API controllers [#2145](https://github.com/AlchemyCMS/alchemy_cms/pull/2145) ([tvdeyen](https://github.com/tvdeyen))
+
+### Misc
+
+- [ruby - main] Upgrade shoulda-matchers to version 5.0.0 [#2161](https://github.com/AlchemyCMS/alchemy_cms/pull/2161) ([depfu](https://github.com/apps/depfu))
+
 ## 6.0.0.b1 (2021-07-05)
 
 ### Features

data/README.md

@@ -339,6 +339,10 @@ $ bin/rails s
 
 ## 📦 Releasing
 
+### Bump version
+
+Bump the version number in both `lib/alchemy/version.rb` and `./package.json`. Make sure both are exactly the same and follow [SemVer format](https://semver.org/#semantic-versioning-specification-semver).
+
 ### Update the changelog
 
 ```bash
@@ -346,12 +350,20 @@ $ export GITHUB_ACCESS_TOKEN=...
 $ PREVIOUS_VERSION=4.1.0 bundle exec rake alchemy:changelog:update
 ```
 
-### Release a new version
+### Commit version bump
 
 ```bash
-$ bundle exec rake release
+$ git commit -am "Bump version to vX.Y.Z"
 ```
 
+### Release a new version
+
+This task will publish both the ruby gem and the npm package.
+It also tags the latest commit.
+
+```bash
+$ bundle exec rake alchemy:release
+```
 
 ## ❓Getting Help
 

data/Rakefile

@@ -1,37 +1,37 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
-desc 'Generate documentation for Alchemy CMS.'
+desc "Generate documentation for Alchemy CMS."
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Alchemy CMS'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('config/alchemy/*.yml')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Alchemy CMS"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("config/alchemy/*.yml")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.rdoc_files.include("app/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: ['alchemy:spec:prepare', :spec]
+task default: ["alchemy:spec:prepare", :spec]
 
 Bundler::GemHelper.install_tasks
 
@@ -56,11 +56,11 @@ namespace :alchemy do
   namespace :changelog do
     desc "Update CHANGELOG from GitHub (Set GITHUB_ACCESS_TOKEN and PREVIOUS_VERSION to a version you want to write changelog changes for)"
     task :update do
-      original_file = './CHANGELOG.md'
-      new_file = original_file + '.new'
-      backup = original_file + '.old'
-      changes = `git rev-list v#{ENV['PREVIOUS_VERSION']}..HEAD | bundle exec github_fast_changelog AlchemyCMS/alchemy_cms`
-      File.open(new_file, 'w') do |fo|
+      original_file = "./CHANGELOG.md"
+      new_file = original_file + ".new"
+      backup = original_file + ".old"
+      changes = `git rev-list v#{ENV["PREVIOUS_VERSION"]}..HEAD | bundle exec github_fast_changelog AlchemyCMS/alchemy_cms`
+      File.open(new_file, "w") do |fo|
         fo.puts changes
         File.foreach(original_file) do |li|
           fo.puts li
@@ -72,4 +72,18 @@ namespace :alchemy do
       File.delete(backup)
     end
   end
+
+  desc "Release a new Ruby gem and npm package in one command"
+  task :release do
+    require "json"
+    require_relative "lib/alchemy/version"
+    package = File.read("package.json")
+    unless JSON.parse(package)["version"] == Alchemy.version
+      abort "Ruby gem and npm package versions are out of sync! Please fix."
+    end
+    # Release the Ruby gem with bundler
+    Rake::Task["release"].invoke
+    # Publish npm package via CLI
+    system "npm publish"
+  end
 end

data/alchemy_cms.gemspec

@@ -65,7 +65,7 @@ Gem::Specification.new do |gem|
   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"]
+  gem.add_development_dependency "shoulda-matchers", ["~> 5.0"]
   gem.add_development_dependency "timecop", ["~> 0.9"]
 
   gem.post_install_message = <<~MSG

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

@@ -31,15 +31,28 @@
   line-height: $form-field-line-height;
   transition: $transition-duration;
 
-  &:focus {
+  &:focus:not(.readonly) {
     @include default-focus-style($box-shadow: 0 0 0 1px $focus-color);
   }
 
-  &[disabled], .disabled {
+  &[disabled],
+  &.disabled,
+  &[readonly],
+  &.readonly {
     color: $form-field-disabled-text-color;
     background-color: $form-field-disabled-bg-color;
+    cursor: default;
+  }
+
+  &[disabled],
+  &.disabled {
     cursor: not-allowed;
   }
+
+  &[readonly],
+  &.readonly {
+    pointer-events: none;
+  }
 }
 
 %gradiated-toolbar {

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

@@ -2,11 +2,26 @@
   padding: 2 * $default-padding;
 }
 
+.applied-filter {
+  display: inline-block;
+  padding: 2px 6px;
+  border-radius: $default-border-radius;
+  border: 1px solid $default-border-color;
+  white-space: nowrap;
+  font-weight: normal;
+
+  .dismiss-filter {
+    position: relative;
+    top: -1px;
+  }
+}
+
 .resources-table-wrapper {
   padding-bottom: 60px;
 
   &.with_tag_filter {
-    padding-right: 242px;
+    width: calc(100% - 235px);
+    overflow-x: auto;
   }
 }
 

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

@@ -21,8 +21,8 @@ module Alchemy
           @attachments = @attachments.tagged_with(search_filter_params[:tagged_with])
         end
 
-        if search_filter_params[:file_type].present?
-          @attachments = @attachments.with_file_type(search_filter_params[:file_type])
+        if search_filter_params[:filter].present?
+          @attachments = apply_filters(@attachments)
         end
 
         @attachments = @attachments
@@ -77,8 +77,8 @@ module Alchemy
       def search_filter_params
         @_search_filter_params ||= params.except(*COMMON_SEARCH_FILTER_EXCLUDES + [:attachment]).permit(
           *common_search_filter_includes + [
-            :file_type,
             :form_field_id,
+            :content_id,
           ]
         )
       end

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

@@ -65,6 +65,7 @@ module Alchemy
       end
 
       def destroy
+        @richtext_ids = @element.richtext_contents_ids + @element.richtext_ingredients_ids
         @element.destroy
         @notice = Alchemy.t("Successfully deleted element") % { element: @element.display_name }
       end

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

@@ -47,11 +47,7 @@ module Alchemy
           end
 
           if search_filter_params[:filter].present?
-            items = items.public_send(sanitized_filter_params)
-          end
-
-          if search_filter_params[:page_layout].present?
-            items = items.where(page_layout: search_filter_params[:page_layout])
+            items = apply_filters(items)
           end
 
           items = items.page(params[:page] || 1).per(items_per_page)
@@ -244,10 +240,6 @@ module Alchemy
         @_resource_handler ||= Alchemy::Resource.new(controller_path, alchemy_module, Alchemy::Page)
       end
 
-      def common_search_filter_includes
-        super.push(:page_layout, :view)
-      end
-
       def set_view
         @view = params[:view] || session[:alchemy_pages_view] || "tree"
         session[:alchemy_pages_view] = @view

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

@@ -21,12 +21,7 @@ module Alchemy
 
       def index
         @query = Picture.ransack(search_filter_params[:q])
-        @pictures = Picture.search_by(
-          search_filter_params,
-          @query,
-          items_per_page,
-        )
-        @pictures = @pictures.includes(:thumbs)
+        @pictures = filtered_pictures.includes(:thumbs)
 
         if in_overlay?
           archive_overlay
@@ -34,9 +29,11 @@ module Alchemy
       end
 
       def show
-        @previous = @picture.previous(params)
-        @next = @picture.next(params)
+        @query = Picture.ransack(params[:q])
+        @previous = filtered_pictures.where("name < ?", @picture.name).last
+        @next = filtered_pictures.where("name > ?", @picture.name).first
         @assignments = @picture.essence_pictures.joins(content: { element: :page })
+
         render action: "show"
       end
 
@@ -130,6 +127,22 @@ module Alchemy
         redirect_to_index
       end
 
+      def filtered_pictures
+        pictures = @query.result
+
+        if params[:tagged_with].present?
+          pictures = pictures.tagged_with(params[:tagged_with])
+        end
+
+        if search_filter_params[:filter].present?
+          pictures = apply_filters(pictures)
+        end
+
+        pictures = pictures.page(params[:page] || 1).per(items_per_page)
+
+        pictures.order(:name)
+      end
+
       def items_per_page
         if in_overlay?
           case @size

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

@@ -3,6 +3,7 @@
 require "csv"
 require "alchemy/resource"
 require "alchemy/resources_helper"
+require "alchemy/resource_filter"
 
 module Alchemy
   module Admin
@@ -13,7 +14,8 @@ module Alchemy
 
       helper Alchemy::ResourcesHelper, TagsHelper
       helper_method :resource_handler, :search_filter_params,
-        :items_per_page, :items_per_page_options
+        :items_per_page, :items_per_page_options, :resource_has_filters,
+        :resource_filters_for_select
 
       before_action :load_resource,
         only: [:show, :edit, :update, :destroy]
@@ -34,7 +36,7 @@ module Alchemy
         end
 
         if search_filter_params[:filter].present?
-          items = items.public_send(sanitized_filter_params)
+          items = apply_filters(items)
         end
 
         respond_to do |format|
@@ -90,8 +92,79 @@ module Alchemy
         @_resource_handler ||= Alchemy::Resource.new(controller_path, alchemy_module)
       end
 
+      def resource_has_filters
+        resource_model.respond_to?(:alchemy_resource_filters)
+      end
+
+      def resource_has_deprecated_filters
+        resource_model.alchemy_resource_filters.any? { |f| !f.is_a?(Hash) }
+      end
+
+      def resource_filters
+        return unless resource_has_filters
+
+        @_resource_filters ||= deprecated_resource_filters || resource_model.alchemy_resource_filters
+      end
+
+      def resource_filters_for_select
+        resource_filters.map do |filter|
+          ResourceFilter.new(filter, resource_handler.resource_name)
+        end
+      end
+
       protected
 
+      def deprecated_resource_filters
+        if resource_has_deprecated_filters
+          Alchemy::Deprecation.warn(
+            "#{resource_model}.alchemy_resource_filters is using a legacy data structure. " \
+            "Please use an Array of Hashes instead. i.e. [{ name: 'foo', values: ['bar', 'baz'] }, ...] " \
+            "where values are scopes. With Alchemy 6.1 only the new structure will be supported."
+          )
+
+          @_resource_filters ||= [
+            {
+              name: :misc,
+              values: resource_model.alchemy_resource_filters,
+            },
+          ]
+        end
+      end
+
+      def apply_filters(items)
+        sanitize_filter_params!
+
+        search_filter_params[:filter].each do |filter|
+          if argument_scope_filter?(filter)
+            items = items.public_send(filter[0], filter[1])
+          elsif simple_scope_filter?(filter)
+            items = items.public_send(filter[1])
+          else
+            raise "Can't apply filter #{filter[0]}. Either the name or the values must be defined as class methods / scopes on the model."
+          end
+        end
+
+        items
+      end
+
+      def simple_scope_filter?(filter)
+        resource_model.respond_to?(filter[1])
+      end
+
+      def argument_scope_filter?(filter)
+        resource_model.respond_to?(filter[0])
+      end
+
+      def sanitize_filter_params!
+        search_filter_params[:filter].reject! do |_, v|
+          eligible_resource_filter_values.exclude?(v)
+        end
+      end
+
+      def eligible_resource_filter_values
+        resource_filters.map(&:values).flatten
+      end
+
       # Returns a translated +flash[:notice]+.
       # The key should look like "Modelname successfully created|updated|destroyed."
       def flash_notice_for_resource_action(action = params[:action])
@@ -136,27 +209,28 @@ module Alchemy
         params.require(resource_handler.namespaced_resource_name).permit!
       end
 
-      def sanitized_filter_params
-        resource_model.alchemy_resource_filters.detect do |filter|
-          filter == search_filter_params[:filter]
-        end || :all
-      end
-
       def search_filter_params
         @_search_filter_params ||= params.except(*COMMON_SEARCH_FILTER_EXCLUDES).permit(*common_search_filter_includes).to_h
       end
 
       def common_search_filter_includes
-        [
+        search_filters = [
           { q: [
             resource_handler.search_field_name,
             :s,
           ] },
           :tagged_with,
-          :filter,
           :page,
           :per_page,
         ]
+
+        if resource_has_filters
+          search_filters << {
+            filter: resource_filters.map { |f| f[:name] },
+          }
+        end
+
+        search_filters
       end
 
       def items_per_page