administrate-field-active_storage 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 679096f1bc559346a74c8a88c6ae7df7a540f0660b8ccf729332047f4908b2b7
-  data.tar.gz: 1de086adcc1ef686c0e28b8d012e5291a56928b2c35503a9915be4720b71391c
+  metadata.gz: 8c328387cb1fe2e92dfc18952fc3b91d88a711afa5f962adf9899f58cda1aa8a
+  data.tar.gz: 12bb047a9cf65ea4540e19737c0d9907f8e9f042a75548fc79de0871cbad9232
 SHA512:
-  metadata.gz: 20b177e400de627190c436537ee31c05cd5bc7407c1c37913f9eec62c14e92bd4393c86bd0d8eec5ab5fb6afec98d237c92b1a1f4a2f9974bde1e7607dfa0129
-  data.tar.gz: ee7c23703ce310ee931f46dfb3df279296bef5614a0ca99507d275d28fe6b547339f54ff6c262318461dc4096da0e06cb390826749de7b5230fb7096f0c74418
+  metadata.gz: 05e3e458a12c3abac03e1869cffbe00adafc015adef2e07bc7606adfd5afdf1e592efdceb399c92d42167f14e20164fab2b35098cb719253ccf0bb1b04ca125b
+  data.tar.gz: 5f16cda52260f09e57c7974de9671985501bf0457fce31d0589d9941adebcd6444ed56b201a52be6d4ed78de47754396157d8e9d0d209718925b0222dbb21827

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    administrate-field-active_storage (1.0.1)
+    administrate-field-active_storage (1.0.3)
       administrate (>= 0.2.2)
       rails (>= 7.0)
 
@@ -121,23 +121,25 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.2)
+    marcel (1.0.4)
     method_source (1.0.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.5)
     minitest (5.15.0)
-    net-imap (0.4.10)
+    net-imap (0.4.11)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0.1)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.0)
-    nokogiri (1.13.3)
-      mini_portile2 (~> 2.8.0)
+    nio4r (2.7.3)
+    nokogiri (1.13.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-linux)
       racc (~> 1.4)
     parser (3.0.3.2)
       ast (~> 2.4.1)
@@ -192,7 +194,9 @@ GEM
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.1.0)

data/README.md

@@ -54,7 +54,7 @@ class ModelDashboard < Administrate::BaseDashboard
   }
 
   # permitted for has_many_attached
-  def permitted_attributes
+  def permitted_attributes(_action = nil)
     super + [:attachments => []]
   end
 ```
@@ -63,6 +63,43 @@ I know it is not ideal, if you have a workaround please submit a PR.
 Note: Rails 6 introduced a new config to determine the behavior on updates to `has_many_attached`.  Setting `Rails.application.config.active_storage.replace_on_assign_to_many` to `true` will overwrite any existing values (purging the old ones), and setting it to `false` will append the new values. Please note that this configuation was [deprecated with Rails 7.1](https://github.com/rails/rails/blob/v7.0.2.3/activestorage/lib/active_storage/attached/model.rb#L150)
 >config.active_storage.replace_on_assign_to_many is deprecated and will be removed in Rails 7.1. Make sure that your code works well with config.active_storage.replace_on_assign_to_many set to true before upgrading. To append new attachables to the Active Storage association, prefer using attach. Using association setter would result in purging the existing attached attachments and replacing them with new ones.
 
+This means that in Rails 7 for `has_many_attached`, whenever a form is submitted, all associations to existing attachments are being removed without the ActiveStorage objects being deleted. This is undesired behaviour because you have to re attach every time you update an object and it will result in orphaned ActiveStorage objects. To fix this and to add the ability to add more attachments to an existing set of attachments, follow this [workaround](https://stackoverflow.com/a/74207496). In short, you can create a concern:
+
+```ruby
+# app/models/concerns/append_to_has_many_attached.rb
+module AppendToHasManyAttached
+  def self.[](fields)
+    Module.new do
+      extend ActiveSupport::Concern
+
+      fields = Array(fields).compact_blank # will always return an array ( worst case is an empty array)
+
+      fields.each do |field|
+        field = field.to_s # We need the string version
+        define_method :"#{field}=" do |attachables|
+          attachables = Array(attachables).compact_blank
+
+          if attachables.any?
+            attachment_changes[field] =
+              ActiveStorage::Attached::Changes::CreateMany.new(field, self, public_send(field).public_send(:blobs) + attachables)
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+And then load this concern in your model:
+```ruby
+class Model < ApplicationModel
+  include AppendToHasManyAttached['files'] # you can include it before or after, order does not matter, explanation below
+
+  has_many_attached :files
+end
+```
+
+Please note, it does not matter if you prepend or include the module, see [original post](https://stackoverflow.com/a/74207496) for details.
 
 ### Prevent N+1 queries
 In order to prevent N+1 queries from active storage you have to modify your admin model controller, below an example for a model called `User` and with attached avatars
@@ -217,11 +254,17 @@ Displays the number of attachments in the `index` action.
 
 Defaults to `true` if number of attachments is not 1.
 
-### direct_upload
+### file_field_options
+
+Configure any options to give to `file_field`.
+
+`multiple` is set by default based on `::ActiveStorage::Attached::Many`, but can be overridden.
+
+#### direct
 
 Enables direct upload from the browser to the cloud.
 
-Defaults to `false`.
+Defaults to `false`. Configure with `file_field_options: { direct: true }`.
 
 Don't forget to include [ActiveStorage JavaScript](https://edgeguides.rubyonrails.org/active_storage_overview.html#direct-uploads). You can use `rails generate administrate:assets:javascripts` to be able to customize Administrate JavaScripts in your application.
 

data/administrate-field-active_storage.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name = "administrate-field-active_storage"
-  gem.version = "1.0.2"
+  gem.version = "1.0.4"
   gem.authors = ["Hamad AlGhanim"]
   gem.email = ["hamadyalghanim@gmail.com"]
   gem.homepage = "https://github.com/Dreamersoul/administrate-field-active_storage"

data/app/views/fields/active_storage/_form.html.erb

@@ -29,6 +29,6 @@ By default, the input is a text field for the image's URL.
           I18n.t("administrate.fields.active_storage.add", default: 'Add') :
           I18n.t("administrate.fields.active_storage.replace", default: 'Replace')
     %>
-    <%= f.file_field field.attribute, multiple: field.many?, direct_upload: field.direct? %>
+    <%= f.file_field field.attribute, field.file_field_options %>
   </div>
 </div>

data/app/views/fields/active_storage/_index.html.erb

@@ -16,27 +16,14 @@ By default, the attribute is rendered as an image tag.
 %>
 
 <% if field.attached? %>
-  <% if field.index_display_preview? %>
-    <% if field.many? %>
-      <%= render partial: 'fields/active_storage/items',
-                 locals: {
-                     field: field,
-                     variant: field.index_preview_variant,
-                     size: field.index_preview_size,
-                     preview_only: field.index_preview_only?
-                 } %>
-    <% else %>
-      <%= render partial: 'fields/active_storage/item',
-                 locals: {
-                     field: field,
-                     attachment: field.data,
-                     variant: field.index_preview_variant,
-                     size: field.index_preview_size,
-                     preview_only: field.index_preview_only?
-                 } %>
-    <% end %>
-  <% end %>
-
+  <%= render partial: "fields/active_storage/items",
+              locals: {
+                  field: field,
+                  variant: field.index_preview_variant,
+                  size: field.index_preview_size,
+                  display_preview: field.index_display_preview?,
+                  preview_only: field.index_preview_only?
+              } %>
   <% if field.index_display_count? %>
     <div class="attachments-count">
       <%= pluralize(field.attachments.count,

data/app/views/fields/active_storage/_item.html.erb

@@ -22,8 +22,9 @@ controlled via a boolean local variable.
 - `preview_only`:
   If true, show only the previous and not the name or destroy link
 %>
-<% preview_only = local_assigns.fetch(:preview_only, false) %>
-<% if field.show_display_preview? && attachment.persisted? %>
+<% preview_only = local_assigns.fetch(:preview_only, false)
+   display_preview = local_assigns.fetch(:display_preview, field.show_display_preview?) %>
+<% if display_preview && attachment.persisted? %>
   <div>
     <%= render partial: 'fields/active_storage/preview', locals: local_assigns %>
   </div>

data/app/views/fields/active_storage/_items.html.erb

@@ -17,6 +17,7 @@ This partial renders one or more attachments
 <%
   variant = local_assigns.fetch(:variant, field.show_preview_variant)
   size = local_assigns.fetch(:size, field.show_preview_size)
+  display_preview = local_assigns.fetch(:display_preview, field.show_display_preview?)
   preview_only = local_assigns.fetch(:preview_only, false)
 %>
 
@@ -28,6 +29,7 @@ This partial renders one or more attachments
                    attachment: attachment,
                    variant: variant,
                    size: size,
+                   display_preview: display_preview,
                    preview_only: preview_only
                } %>
   </div>

data/lib/administrate/field/active_storage.rb

@@ -40,6 +40,13 @@ module Administrate
         options.fetch(:show_preview_variant, nil)
       end
 
+      def file_field_options
+        {
+          direct_upload: field.direct?,
+          multiple: field.many?,
+        }.merge options.fetch(:file_field_options, {})
+      end
+
       def many?
         data.is_a? ::ActiveStorage::Attached::Many
       end

data/test_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    administrate-field-active_storage (0.4.1)
+    administrate-field-active_storage (1.0.2)
       administrate (>= 0.2.2)
       rails (>= 7.0)
 
@@ -84,18 +84,16 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    administrate (0.16.0)
-      actionpack (>= 5.0)
-      actionview (>= 5.0)
-      activerecord (>= 5.0)
-      datetime_picker_rails (~> 0.0.7)
-      jquery-rails (>= 4.0)
-      kaminari (>= 1.0)
-      momentjs-rails (~> 2.8)
+    administrate (0.20.1)
+      actionpack (>= 6.0, < 8.0)
+      actionview (>= 6.0, < 8.0)
+      activerecord (>= 6.0, < 8.0)
+      jquery-rails (~> 4.6.0)
+      kaminari (~> 1.2.2)
       sassc-rails (~> 2.1)
       selectize-rails (~> 0.6)
     base64 (0.2.0)
-    bigdecimal (3.1.4)
+    bigdecimal (3.1.8)
     bindex (0.8.1)
     builder (3.2.4)
     byebug (11.1.3)
@@ -109,28 +107,25 @@ GEM
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     childprocess (4.1.0)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
-    datetime_picker_rails (0.0.7)
-      momentjs-rails (>= 2.8.1)
-    drb (2.2.0)
-      ruby2_keywords
+    drb (2.2.1)
     erubi (1.12.0)
-    ffi (1.15.4)
+    ffi (1.16.3)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     image_processing (1.12.2)
       mini_magick (>= 4.9.5, < 5)
       ruby-vips (>= 2.0.17, < 3)
-    io-console (0.6.0)
-    irb (1.9.0)
-      rdoc
-      reline (>= 0.3.8)
-    jquery-rails (4.4.0)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jquery-rails (4.6.0)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
@@ -158,9 +153,7 @@ GEM
     matrix (0.4.2)
     mini_magick (4.12.0)
     mini_mime (1.1.5)
-    minitest (5.20.0)
-    momentjs-rails (2.29.1)
-      railties (>= 3.1)
+    minitest (5.23.0)
     mutex_m (0.2.0)
     net-imap (0.4.5)
       date
@@ -172,28 +165,28 @@ GEM
     net-smtp (0.4.0)
       net-protocol
     nio4r (2.6.0)
-    nokogiri (1.15.5-arm64-darwin)
+    nokogiri (1.16.5-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-darwin)
+    nokogiri (1.16.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-linux)
+    nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
-    psych (5.1.1.1)
+    psych (5.1.2)
       stringio
     public_suffix (4.0.6)
     puma (5.6.4)
       nio4r (~> 2.0)
     racc (1.7.3)
-    rack (2.2.8)
+    rack (3.0.11)
     rack-mini-profiler (2.3.3)
       rack (>= 1.2.0)
-    rack-session (1.0.1)
-      rack (< 3)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rackup (1.0.0)
-      rack (< 3)
-      webrick
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
     rails (7.1.2)
       actioncable (= 7.1.2)
       actionmailbox (= 7.1.2)
@@ -223,16 +216,15 @@ GEM
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
-    rake (13.1.0)
-    rdoc (6.6.0)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
     regexp_parser (2.2.0)
-    reline (0.4.0)
+    reline (0.5.7)
       io-console (~> 0.5)
     rexml (3.2.5)
     ruby-vips (2.2.0)
       ffi (~> 1.12)
-    ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     sass-rails (6.0.0)
       sassc-rails (~> 2.1, >= 2.1.1)
@@ -249,17 +241,19 @@ GEM
       childprocess (>= 0.5, < 5.0)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2)
-    sprockets (4.0.2)
+    sprockets (4.2.1)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
+      rack (>= 2.2.4, < 4)
     sprockets-rails (3.4.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
-    stringio (3.0.9)
-    thor (1.3.0)
-    tilt (2.0.10)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    stringio (3.1.0)
+    thor (1.3.1)
+    tilt (2.3.0)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -274,7 +268,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.14)
 
 PLATFORMS
   arm64-darwin-23

data/test_app/app/controllers/admin/posts_controller.rb

@@ -42,5 +42,11 @@ module Admin
 
     # See https://administrate-prototype.herokuapp.com/customizing_controller_actions
     # for more information
+
+    def destroy_other_image
+      other_image = requested_resource.other_images.find(params[:attachment_id])
+      other_image.purge
+      redirect_back(fallback_location: requested_resource)
+    end
   end
 end

data/test_app/app/dashboards/post_dashboard.rb

@@ -10,6 +10,11 @@ class PostDashboard < Administrate::BaseDashboard
   ATTRIBUTE_TYPES = {
     id: Field::Number,
     cover_image: Field::ActiveStorage,
+    other_images: Field::ActiveStorage.with_options(
+      destroy_url: proc do |namespace, resource, attachment|
+        [:other_image_admin_post, { id: resource.id, attachment_id: attachment.id }]
+      end
+    ),
     title: Field::String,
     created_at: Field::DateTime,
     updated_at: Field::DateTime,
@@ -24,6 +29,7 @@ class PostDashboard < Administrate::BaseDashboard
   id
   title
   cover_image
+  other_images
   created_at
   ].freeze
 
@@ -33,6 +39,7 @@ class PostDashboard < Administrate::BaseDashboard
   id
   title
   cover_image
+  other_images
   created_at
   updated_at
   ].freeze
@@ -43,6 +50,7 @@ class PostDashboard < Administrate::BaseDashboard
   FORM_ATTRIBUTES = %i[
   title
   cover_image
+  other_images
   ].freeze
 
   # COLLECTION_FILTERS
@@ -63,4 +71,8 @@ class PostDashboard < Administrate::BaseDashboard
   # def display_resource(post)
   #   "Post ##{post.id}"
   # end
+
+  def permitted_attributes(action = nil)
+    super + [:other_images => []]
+  end
 end

data/test_app/app/models/post.rb

@@ -1,5 +1,6 @@
 class Post < ApplicationRecord
   has_one_attached :cover_image
+  has_many_attached :other_images
 
   validates :title, presence: true
 end

data/test_app/config/routes.rb

@@ -2,7 +2,9 @@ Rails.application.routes.draw do
   # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
 
   namespace :admin do
-    resources :posts
+    resources :posts do
+      delete :other_image, on: :member, action: :destroy_other_image
+    end
 
     root to: "posts#index"
   end

data/test_app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2023_11_17_224946) do
+ActiveRecord::Schema[7.1].define(version: 2023_11_17_224946) do
   create_table "active_storage_attachments", force: :cascade do |t|
     t.string "name", null: false
     t.string "record_type", null: false
@@ -40,9 +40,9 @@ ActiveRecord::Schema.define(version: 2023_11_17_224946) do
   end
 
   create_table "posts", force: :cascade do |t|
-    t.string "title"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.string "title"
   end
 
   add_foreign_key "active_storage_attachments", "active_storage_blobs", column: "blob_id"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-active_storage
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Hamad AlGhanim
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate