Fix filtering Attachments by only or except param

This has been broken for a long time now.

Signed-off-by: Thomas von Deyen <vondeyen@blish.cloud>

Author: tvdeyen

app/controllers/alchemy/admin/attachments_controller.rb

@@ -72,11 +72,22 @@ def default_sort_order
       end
 
       def search_filter_params
-        @_search_filter_params ||= params.except(*COMMON_SEARCH_FILTER_EXCLUDES + [:attachment]).permit(
-          *common_search_filter_includes + [
-            :form_field_id
-          ]
-        )
+        @_search_filter_params ||= begin
+          params[:q] ||= ActionController::Parameters.new
+          params.except(*COMMON_SEARCH_FILTER_EXCLUDES + [:attachment]).permit(
+            *common_search_filter_includes + [
+              :form_field_id
+            ]
+          )
+        end
+      end
+
+      def permitted_ransack_search_fields
+        super + [
+          {by_file_type: []},
+          :not_file_type,
+          {not_file_type: []}
+        ]
       end
 
       def handle_uploader_response(status:)

app/models/alchemy/attachment.rb

@@ -29,10 +29,14 @@ class Attachment < BaseRecord
 
     stampable stamper_class_name: Alchemy.user_class_name
 
-    scope :by_file_type, ->(file_type) do
+    scope :by_file_type, ->(*file_type) do
       Alchemy.storage_adapter.by_file_type_scope(file_type)
     end
 
+    scope :not_file_type, ->(*file_type) do
+      Alchemy.storage_adapter.not_file_type_scope(file_type)
+    end
+
     scope :recent, -> { where("#{table_name}.created_at > ?", Time.current - 24.hours).order(:created_at) }
     scope :without_tag, -> { left_outer_joins(:taggings).where(gutentag_taggings: {id: nil}) }
 
@@ -79,7 +83,7 @@ def allowed_filetypes
       end
 
       def ransackable_scopes(_auth_object = nil)
-        %i[by_file_type recent last_upload without_tag deletable]
+        %i[by_file_type not_file_type recent last_upload without_tag deletable]
       end
     end
 

app/models/alchemy/storage_adapter.rb

@@ -8,6 +8,7 @@ class UnknownAdapterError < StandardError; end
       :attachment_url_class,
       :by_file_format_scope,
       :by_file_type_scope,
+      :not_file_type_scope,
       :file_extension,
       :file_formats,
       :file_mime_type,

app/models/alchemy/storage_adapter/active_storage.rb

@@ -80,18 +80,24 @@ def rescuable_errors
         ::ActiveStorage::Error
       end
 
-      # @param [String]
+      # @param [String, Array<String>]
       # @return [Alchemy::Picture::ActiveRecord_Relation]
       def by_file_format_scope(file_format)
         Picture.with_attached_image_file.joins(:image_file_blob).where(active_storage_blobs: {content_type: file_format})
       end
 
-      # @param [String]
+      # @param [String, Array<String>]
       # @return [Alchemy::Atachment::ActiveRecord_Relation]
       def by_file_type_scope(file_type)
         Attachment.with_attached_file.joins(:file_blob).where(active_storage_blobs: {content_type: file_type})
       end
 
+      # @param [String, Array<String>]
+      # @return [Alchemy::Atachment::ActiveRecord_Relation]
+      def not_file_type_scope(file_type)
+        Attachment.with_attached_file.joins(:file_blob).where.not(active_storage_blobs: {content_type: file_type})
+      end
+
       # @param [Alchemy::Attachment]
       # @return [String]
       def file_name(attachment)

app/models/alchemy/storage_adapter/dragonfly.rb

@@ -103,18 +103,24 @@ def rescuable_errors
         ::Dragonfly::Job::Fetch::NotFound
       end
 
-      # @param [String]
+      # @param [String, Array<String>]
       # @return [Alchemy::Picture::ActiveRecord_Relation]
       def by_file_format_scope(file_format)
         Picture.where(image_file_format: file_format)
       end
 
-      # @param [String]
+      # @param [String, Array<String>]
       # @return [Alchemy::Attachment::ActiveRecord_Relation]
       def by_file_type_scope(file_type)
         Attachment.where(file_mime_type: file_type)
       end
 
+      # @param [String, Array<String>]
+      # @return [Alchemy::Attachment::ActiveRecord_Relation]
+      def not_file_type_scope(file_type)
+        Attachment.where.not(file_mime_type: file_type)
+      end
+
       # @param [Alchemy::Attachment]
       # @return [String]
       def file_name(attachment)

app/views/alchemy/admin/attachments/_overlay_file_list.html.erb

@@ -1,6 +1,6 @@
 <% if @attachments.empty? %>
   <%= render_message do %>
-    <% if search_filter_params[:q].present? %>
+    <% if search_filter_params.present? %>
       <%= Alchemy.t(:no_search_results) %>
     <% else %>
       <%= Alchemy.t(:no_files_in_archive) %>

app/views/alchemy/ingredients/_file_editor.html.erb

@@ -1,8 +1,18 @@
 <% dialog_link = link_to_dialog render_icon("file-add"),
   alchemy.admin_attachments_path(
     form_field_id: file_editor.form_field_id(:attachment_id),
-    only: file_editor.settings[:only],
-    except: file_editor.settings[:except]
+    q: {
+      by_file_type: Array.wrap(file_editor.settings[:only]).map { |ext|
+        Marcel::MimeType.for(
+          extension: ext
+        )
+      },
+      not_file_type: Array.wrap(file_editor.settings[:except]).map { |ext|
+        Marcel::MimeType.for(
+          extension: ext
+        )
+      }
+    }
   ),
   {
     title: Alchemy.t(:assign_file),

spec/controllers/alchemy/admin/attachments_controller_spec.rb

@@ -46,6 +46,81 @@ module Alchemy
         get :index
       end
 
+      context "when params[:only] is set" do
+        let(:pdf_file) { fixture_file_upload("file.pdf") }
+
+        let!(:pdf_attachment) { create(:alchemy_attachment, name: "PDF", file: pdf_file) }
+
+        context "to single extension" do
+          it "should filter attachments by file type from extension" do
+            attachment
+            get :index, params: {only: "pdf"}
+            expect(assigns(:attachments)).to contain_exactly(pdf_attachment)
+          end
+        end
+
+        context "to multiple extensions" do
+          let(:gif_file) { fixture_file_upload("animated.gif") }
+
+          let!(:gif_attachment) { create(:alchemy_attachment, name: "GIF", file: gif_file) }
+
+          it "should filter attachments by file type from extension" do
+            attachment
+            get :index, params: {only: ["pdf", "gif"]}
+            expect(assigns(:attachments)).to contain_exactly(pdf_attachment, gif_attachment)
+          end
+        end
+      end
+
+      context "when params[:except] is set" do
+        let(:pdf_file) { fixture_file_upload("file.pdf") }
+
+        let!(:pdf_attachment) { create(:alchemy_attachment, name: "PDF", file: pdf_file) }
+
+        context "to single extension" do
+          it "should filter attachments by file type from extension" do
+            get :index, params: {except: "pdf"}
+            expect(assigns(:attachments)).to contain_exactly(attachment)
+          end
+        end
+
+        context "to multiple extensions" do
+          let(:gif_file) { fixture_file_upload("animated.gif") }
+
+          let!(:gif_attachment) { create(:alchemy_attachment, name: "GIF", file: gif_file) }
+
+          it "should filter attachments by file type from extension" do
+            get :index, params: {except: ["pdf", "gif"]}
+            expect(assigns(:attachments)).to contain_exactly(attachment)
+          end
+        end
+      end
+
+      context "when params[:except] and params[:only] are set" do
+        let(:pdf_file) { fixture_file_upload("file.pdf") }
+
+        let!(:pdf_attachment) { create(:alchemy_attachment, name: "PDF", file: pdf_file) }
+
+        context "to single extension" do
+          it "should filter records by file type from extension" do
+            attachment
+            get :index, params: {except: "png", only: "pdf"}
+            expect(assigns(:attachments)).to contain_exactly(pdf_attachment)
+          end
+        end
+
+        context "to multiple extensions" do
+          let(:gif_file) { fixture_file_upload("animated.gif") }
+
+          let!(:gif_attachment) { create(:alchemy_attachment, name: "GIF", file: gif_file) }
+
+          it "should filter records by file type from extension" do
+            get :index, params: {except: ["pdf", "gif"]}
+            expect(assigns(:attachments)).to contain_exactly(attachment)
+          end
+        end
+      end
+
       context "when params[:tagged_with] is set" do
         it "should filter the records by tags" do
           expect(Attachment).to receive(:tagged_with).and_return(Attachment.all)

spec/dummy/config/alchemy/elements.yml

@@ -61,6 +61,8 @@
   ingredients:
     - role: file
       type: File
+      settings:
+        except: mp3
 
 - name: bild
   ingredients:
@@ -171,9 +173,13 @@
     - role: audio
       type: Audio
       hint: true
+      settings:
+        only: [mp3, wav]
     - role: video
       type: Video
       hint: true
+      settings:
+        only: webm
     - role: page
       type: Page
       hint: true