administrate-field-active_storage 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5923a984b8ef1046ab8657f3de54cbd68c5c50bc90b9f0aba62d36ed0c0a1b
-  data.tar.gz: d383f74c54bfd179912f66d612d4ad19c0b4f4da5baf1facd14c1df10d2c2c9f
+  metadata.gz: 1ea48021b9c4480f394cc61655e5e0a51c8ee6f9723f97902902642668a9ea88
+  data.tar.gz: b9691a2f4b65e00a559dbd5ec52e73b1bac589e98403a6f135fdcd0f09953bff
 SHA512:
-  metadata.gz: a7686831282ed9ffaf94c01cdab6e3f029a7ba93736896982d8255db70bc28f93402f2a9a0f17b820b17258eadbf2f9a294e2e07cc8fd5164dd5d979eb6ad9cb
-  data.tar.gz: e479ad715183dd81c20b58aec5796f9a06949537729a25e320ea8f0a83b9a056d05cc36b7186da561468fce878284e33dcb8314af33cc38149a18ce34dd22bcd
+  metadata.gz: c5409c4400e684e023b287144b7415f51a77d6800df33c17eeb6f805de5381900e1d4947413e3d64939e85fd2009c8ff6ebeecbcde864017fc2c99f11c668650
+  data.tar.gz: cf96c0b3b886a87fbe4774c2b2e3658d56c64375b34eebcb1d2ff3240dafb9ccf0a96debab40b3ce675b7869b6dd5cc6d0cc114f11368bcea27da35f5e8e3c23

data/README.md

@@ -63,38 +63,70 @@ I know it is not ideal, if you have a workaround please submit a PR.
 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
 ```ruby
 module Admin
-  class UsersController < Admin::ApplicationController
+  class UsersController < ApplicationController
     def scoped_resource
       resource_class.with_attached_avatars
     end
   end
 end
-
 ```
 
 ### Removing/Deleting an Attachment
-In order to allow the user to delete an attachment using the admin dashboard you need to do the following:
-1. create a controller action with a `delete` route
-2. point the `Field::ActiveStorage` field to that route
 
-here is an example (send the route name as a symbol):
-```ruby
-class ModelDashboard < Administrate::BaseDashboard
-  ATTRIBUTE_TYPES = {
-    attachment: Field::ActiveStorage.with_options({destroy_path: :custom_active_storage_destroy_path}),
-  }
-# ...
+`Administrate::Field::ActiveStorage` expects the presence of a route
+DELETE `/<namespace>/<resource>/:id/:attachment_name`, which will receive an optional parameter
+`attachment_id` in the case of an `ActiveStorage::Attached::Many`. For instance:
+
+```rb
+# routes.rb
+...
+namespace :admin do
+  ...
+  resources :users do
+    delete :avatars, on: :member, action: :destroy_avatar
+  end
+end
+
+# app/controllers/admin/users_controller.rb
+module Admin
+  class UsersController < ApplicationController
+
+    # For illustrative purposes only.
+    #
+    # **SECURITY NOTICE**: first verify whether current user is authorized to perform the action.
+    def destroy_avatar
+      avatar = requested_resource.avatars.find(params[:attachment_id])
+      avatar.purge
+      redirect_back(fallback_location: requested_resource)
+    end
+  end
+end
 ```
-Your `routes.rb` file must point to a controller action with method `delete` which should contain the following piece of code (you can modify to your own liking).
-**FOR SECURITY REASONS** please check if the current user is allowed to remove such file
-```ruby
-  def remove_attachment
-    attachment = ActiveStorage::Attachment.find(params[:attachment_id])
-    attachment.purge
-    redirect_back(fallback_location: "/")
+
+This route can be customized with `destroy_url`. The option expects a `proc` receiving 3 arguments:
+the Administrate `namespace`, the `resource`, and the `attachment`. The proc can return anything
+accepted by `link_to`:
+
+```rb
+# routes.rb
+delete :custom_user_avatar_destroy, to: 'users#destroy_avatar'
+
+# user_dashboard.rb
+class UserDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    avatars: Field::ActiveStorage.with_options(
+      destroy_url: proc do |namespace, resource, attachment|
+        [:custom_user_avatar_destroy, { attachment_id: attachment.id }]
+      end
+    ),
+    # ...
   end
+  # ...
+end
 ```
 
+To disable this feature, set `destroy_url` to `nil`.
+
 ## Options
 
 Various options can be passed to `Administrate::Field::ActiveStorage#with_options`

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 = "0.3.0"
+  gem.version = "0.3.1"
   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

@@ -21,7 +21,7 @@ By default, the input is a text field for the image's URL.
 
 <div class="field-unit__field">
   <% if field.attached? %>
-    <%= render partial: 'fields/active_storage/items', locals: { field: field, removable: field.destroyable? } %>
+    <%= render partial: 'fields/active_storage/items', locals: { field: field } %>
   <% end %>
 
   <div>

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

@@ -24,11 +24,6 @@ controlled via a boolean local variable.
   Maximum size of the ActiveStorage preview.
 %>
 
-<%
-  # By default we don't allow attachment removal
-  removable = local_assigns.fetch(:removable, false)
-%>
-
 <div>
   <%= render partial: 'fields/active_storage/preview', locals: local_assigns %>
 </div>
@@ -37,7 +32,10 @@ controlled via a boolean local variable.
   <%= link_to 'Download', field.blob_url(attachment), title: attachment.filename %>
 </div>
 
-<% if removable %>
-  <%= link_to 'Remove', field.destroy_path(field, attachment), method: :delete, class: 'remove-attachment-link' %>
+<% if field.destroy_url.present? %>
+  <% destroy_url = field.destroy_url.call(namespace, field.data.record, attachment) %>
+  <div>
+    <%= link_to 'Remove', destroy_url, method: :delete, class: 'remove-attachment-link' %>
+  </div>
   <hr>
 <% end %>

data/example-project/app/controllers/admin/users_controller.rb

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

data/example-project/app/controllers/users_controller.rb

@@ -1,7 +1,7 @@
 class UsersController < ApplicationController
-    def remove_attachment
-        attachment = ActiveStorage::Attachment.find(params[:attachment_id])
-        attachment.purge
-        redirect_back(fallback_location: "/")
+    def destroy_avatar
+        avatar = requested_resource.avatars.find(params[:attachment_id])
+        avatar.purge
+        redirect_back(fallback_location: requested_resource)
     end
 end

data/example-project/app/dashboards/user_dashboard.rb

@@ -10,7 +10,9 @@ class UserDashboard < Administrate::BaseDashboard
   ATTRIBUTE_TYPES = {
     id: Field::Number,
     name: Field::String,
-    avatars: Field::ActiveStorage.with_options({:destroy_path => :custom_active_record_remove_path, :show_in_index => true}),
+    avatars: Field::ActiveStorage.with_options(
+      show_in_index: true
+    ),
     created_at: Field::DateTime,
     updated_at: Field::DateTime
   }.freeze

data/example-project/config/routes.rb

@@ -1,9 +1,10 @@
 Rails.application.routes.draw do
   namespace :admin do
-    resources :users
+    resources :users do
+      delete :avatar, on: :member, action: :destroy_avatar
+    end
 
     root to: "users#index"
   end
-  delete "custom_active_record_remove", to: 'users#remove_avatar'
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 end

data/lib/administrate/field/active_storage.rb

@@ -7,10 +7,6 @@ module Administrate
       class Engine < ::Rails::Engine
       end
 
-      def destroyable?
-        options.key?(:destroy_path)
-      end
-
       def index_display_preview?
         options.fetch(:index_display_preview, true)
       end
@@ -20,7 +16,7 @@ module Administrate
       end
 
       def index_display_count?
-        options.fetch(:index_display_count) { attachments.count != 1 }
+        options.fetch(:index_display_count) { attachments.present? && attachments.count != 1 }
       end
 
       def show_display_preview?
@@ -32,17 +28,22 @@ module Administrate
       end
 
       def many?
-        # find a way to use instance_of
-        data.class.name == 'ActiveStorage::Attached::Many'
+        data.is_a? ::ActiveStorage::Attached::Many
       end
 
       def direct?
         options.fetch(:direct_upload, false)
       end
 
-      # def destroy_path?
-      #   options.fetch(:destroy_path, false).present?
-      # end
+      def destroy_url
+        options.fetch(:destroy_url) do
+          proc do |namespace, record, attachment|
+            options = [attachment.name, namespace, record]
+            options << { attachment_id: attachment.id } if many?
+            options
+          end
+        end
+      end
 
       # currently we are using Rails.application.routes.url_helpers
       # without including the namespace because it runs into an
@@ -66,22 +67,17 @@ module Administrate
         Rails.application.routes.url_helpers.rails_blob_path(attachment, disposition: :attachment, only_path: true)
       end
 
-      def destroy_path(field, attachment)
-        destroy_path_helper = options.fetch(:destroy_path)
-        record_id = field.data.record.id
-        attachment_id = attachment.id
-        Rails.application.routes.url_helpers.send(destroy_path_helper, {:record_id => record_id, :attachment_id => attachment_id})
-      end
-
       def can_add_attachment?
-        many? || attachments.empty?
+        many? || attachments.blank?
       end
 
       def attached?
         data.present? && data.attached?
       end
 
-      delegate :attachments, to: :data
+      def attachments
+        data.attachments if attached?
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-active_storage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Hamad AlGhanim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: administrate