administrate-field-active_storage 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90caaf4c6fe823ec5996eec5848f27dd93fc0025
-  data.tar.gz: cdfdf97f2bbf930878c2e9317634bc7b72a01e1b
+  metadata.gz: 9e3e3647b9b229f49a3072af6f62b72bc9d55976
+  data.tar.gz: 5d6b454861f7e2e03e1cd0f7d8a99bab189c8748
 SHA512:
-  metadata.gz: 32a5196ddcb39b7b740a30d1a17cd5313c168554b42fbfa75e4239b815f1cc4d9008db95c807020ab041c0aeac5568e05b3ea2b5ed74cfa8671ea93a3cfdabac
-  data.tar.gz: 8f269a049d8bbaa83a993bd7d2a5d7ccdcaf8ccf3b72b8c6049c7aebfb4c5098ea03c8f8c49d8a62fcc69e7edd5eefa530b417a6e65ff5f1641eab62a9230432
+  metadata.gz: dfc0eb316fb73d319b0d92b918472e98fa1e66625bb1e36bccbf02c1d1b61eda74a61cddb0d67e429473e7f8ce9729d965957cd3f9788e662f46cbc2073a478f
+  data.tar.gz: c6f7543548f1039e099c65706f9b0bf70786d8fe531cd32ef6aeb6c593279c8aae0ab35c50758fdf5954700ff26bd53ec47c04c369489b3e11a8a94bf5606d7f

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.DS_Store

data/README.md

@@ -1,11 +1,11 @@
 # Administrate::Field::ActiveStorage
 ![rails](https://img.shields.io/badge/rails-%3E%3D5.2.0-red.svg)
+
 ## Things To Know:
-- to preview pdf files you need to install `mupdf` or `Poppler`.
-- to preview video files you need to install `ffmpeg`.
+- To preview pdf files you need to install `mupdf` or `Poppler`.
+- To preview video files you need to install `ffmpeg`.
 
 ## How To Use:
-
 Add `administrate-field-active_storage` to your Gemfile:
 
 ```ruby
@@ -19,7 +19,7 @@ $ bundle install
 ```
 
 ### `has_one_attached`:
-assuming your modelname is `Model` and field name is `attachment`
+Assuming your model name is `Model` and field name is `attachment`
 ```ruby
 class ModelDashboard < Administrate::BaseDashboard
   ATTRIBUTE_TYPES = {
@@ -28,11 +28,10 @@ class ModelDashboard < Administrate::BaseDashboard
 # ...
 ```
 Then add `:attachment` to `FORM_ATTRIBUTES` and `SHOW_PAGE_ATTRIBUTES`.
-currently adding `:attachment` `COLLECTION_ATTRIBUTES` will work but will probably look too big.
+Adding `:attachment` `COLLECTION_ATTRIBUTES` will work but will probably look too big.
 
 ### `has_many_attached`:
-assuming your modelname is `Model` and field name is `attachments`
-the processs is identical the only issue is that the form field isn't being permitted, in order to permit it we apply the following method to the dashboard:
+Assuming your model name is `Model` and field name is `attachments` the process is identical the only issue is that the form field isn't being permitted, in order to permit it we apply the following method to the dashboard:
 
 ```ruby
 class ModelDashboard < Administrate::BaseDashboard
@@ -51,10 +50,33 @@ class ModelDashboard < Administrate::BaseDashboard
     super + [:attachments => []]
   end
 ```
-i know it is not ideal, if you have a workaround please submit a PR
+I know it is not ideal, if you have a workaround please submit a PR.
+
+### 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}),
+  }
+# ...
+```
+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: "/")
+  end
+```
 
 ### url_only
-only the following needs to change in order for the field to be url_only
+Only the following needs to change in order for the field to be url_only
 ```ruby
 class ModelDashboard < Administrate::BaseDashboard
   ATTRIBUTE_TYPES = {
@@ -64,8 +86,8 @@ class ModelDashboard < Administrate::BaseDashboard
   # ...
 end
 ```
-## Things To Do:
 
+## Things To Do:
 - [x] upload single file
 - [x] adding image support through url_for to support 3rd party cloud storage
 - [x] use html 5 video element for video files
@@ -74,15 +96,15 @@ end
 - [x] preview videos
 - [x] preview pdfs
 - [x] upload multiple files
-- [ ] find a way to delete attachments
+- [x] find a way to delete attachments
 - [ ] preview office files as pictures
 
-## Contribution guide:
+## Contribution Guide:
 1. contributers are welcome (code, suggestions, and bugs).
 2. please document your code.
 3. add your name to the `contribute.md`.
 
-    please note that this is my first gem :) i might have gotten some stuff wrong PR's are always welcome
+Please note that this is my first gem :) i might have gotten some stuff wrong PR's are always welcome.
+
 ---
 Based on the [Administrate::Field::Image](https://github.com/thoughtbot/administrate-field-image) template, and inspired by [Administrate::Field::Paperclip](https://github.com/picandocodigo/administrate-field-paperclip).
-

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.1.3"
+  gem.version = "0.1.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

@@ -18,6 +18,13 @@ By default, the input is a text field for the image's URL.
 <div class="field-unit__label">
   <%= f.label field.attribute %>
 </div>
+
 <div class="field-unit__field">
+  <% if field.attached? %>
+    <%= render partial: 'fields/active_storage/items', locals: { field: field, removable: field.destroyable? } %>
+    <br />
+    Add:
+  <% end %>
+
   <%= f.file_field field.attribute, multiple: field.many? %>
 </div>

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

@@ -1,6 +1,34 @@
+<%#
+# Item Partial
+
+This partial renders attached items.
+
+Attachments of type image, video and audio are emedded.  For all other types
+we try use it's preview.  If all else fails we simply link to the attached file.
+
+This partial will optionally show a `remove` link next to each attachment which is
+controlled via a boolean local variable.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Image].
+  A wrapper around the image url pulled from the database.
+- `attachment`:
+  Reference to the file
+- `removable`:
+  A boolean used to control the display of a `Remove` link which
+  is used to destroy a single attachment.  Defaults to `false`
+%>
+
+<%
+  # By default we don't allow attachment removal
+  removable = local_assigns.fetch(:removable, false)
+%>
+
 <% if attachment.image? and !field.url_only? %>
   <%= image_tag(field.url(attachment)) %>
-<% elsif attachment.video? and attachment.previewable? and !field.url_only? %> <%# if ffmpeg is installed %> 
+<% elsif attachment.video? and attachment.previewable? and !field.url_only? %> <%# if ffmpeg is installed %>
   <%= video_tag(field.url(attachment), poster: field.preview(attachment, resize: "1920x1080>"), controls: true, autobuffer: true, style: "width: 100%; height: auto;") %>
 <% elsif attachment.video? and !field.url_only? %>
   <%= video_tag(field.url(attachment), controls: true, autobuffer: true, style: "width: 100%; height: auto;") %>
@@ -13,3 +41,8 @@
 <% else %>
   <%= link_to(attachment.filename, field.blob_url(attachment)) %>
 <% end %>
+
+<% if removable %>
+  <%= link_to 'Remove', field.destroy_path(field, attachment), method: :delete, class: 'remove-attachment-link' %>
+  <hr>
+<% end %>

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

@@ -0,0 +1,25 @@
+<%#
+# Items Partial
+
+This partial renders one or more attachments
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Image].
+  A wrapper around the image url pulled from the database.
+- `removable`:
+  A boolean used to control the display of a `Remove` link which 
+  is used to destroy a single attachment.  Defaults to `false`
+%>
+
+<% 
+  attachments = Array(field.many? ? field.attachments : field.data)
+  removable = local_assigns.fetch(:removable, false)
+%>
+
+<% attachments.each do |attachment| %>
+  <div class="attachments-listing">
+    <%= render partial: 'fields/active_storage/item', locals: { field: field, attachment: attachment, removable: removable } %>
+  </div>
+<% end %>

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

@@ -14,13 +14,7 @@ By default, the attribute is rendered as an image tag.
 
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Image
 %>
+
 <% if field.attached? %>
-  <% if field.many? %>
-    <% field.attachments.each do |attachment| %>
-      <%= render :partial => 'fields/active_storage/item', locals: { field: field, attachment: attachment } %>
-      <br/>
-    <% end %>
-  <% else %>
-    <%= render :partial => 'fields/active_storage/item', locals: { field: field, attachment: field.data } %>
-  <% end %>
+  <%= render partial: 'fields/active_storage/items', locals: { field: field } %>
 <% end %>

data/contribute.md

@@ -1 +1,5 @@
-Patrick Gleeson [@patrick-gleeson](https://github.com/patrick-gleeson)
+# Contributors
+
+- Patrick Gleeson [@patrick-gleeson](https://github.com/patrick-gleeson)
+- Mario Zigliotto [@mariozig](https://github.com/mariozig)
+- Leif Gensert [@leifg](https://github.com/leifg)

data/example-project/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+
+/node_modules
+/yarn-error.log
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/example-project/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/example-project/Gemfile

@@ -0,0 +1,66 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.4.1'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.0'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.11'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'mini_racer', platforms: :ruby
+
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.2'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use ActiveStorage variant
+# gem 'mini_magick', '~> 4.8'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.1.0', require: false
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 2.15', '< 4.0'
+  gem 'selenium-webdriver'
+  # Easy installation and use of chromedriver to run system tests with Chrome
+  gem 'chromedriver-helper'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+
+gem "administrate"
+gem 'administrate-field-active_storage', :path => "../"

data/example-project/Gemfile.lock

@@ -0,0 +1,263 @@
+PATH
+  remote: ..
+  specs:
+    administrate-field-active_storage (0.1.5)
+      administrate (>= 0.2.0.rc1)
+      rails (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.2)
+      actionpack (= 5.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.2)
+      activesupport (= 5.2.2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activestorage (5.2.2)
+      actionpack (= 5.2.2)
+      activerecord (= 5.2.2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    administrate (0.11.0)
+      actionpack (>= 4.2, < 6.0)
+      actionview (>= 4.2, < 6.0)
+      activerecord (>= 4.2, < 6.0)
+      autoprefixer-rails (>= 6.0)
+      datetime_picker_rails (~> 0.0.7)
+      jquery-rails (>= 4.0)
+      kaminari (>= 1.0)
+      momentjs-rails (~> 2.8)
+      sass-rails (~> 5.0)
+      selectize-rails (~> 0.6)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
+    arel (9.0.0)
+    autoprefixer-rails (9.4.3)
+      execjs
+    bindex (0.5.0)
+    bootsnap (1.3.2)
+      msgpack (~> 1.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    capybara (3.12.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.2)
+      xpath (~> 3.2)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (2.1.0)
+      archive-zip (~> 0.10)
+      nokogiri (~> 1.8)
+    coffee-rails (4.2.2)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    datetime_picker_rails (0.0.7)
+      momentjs-rails (>= 2.8.1)
+    erubi (1.8.0)
+    execjs (2.7.0)
+    ffi (1.9.25)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    io-like (0.3.0)
+    jbuilder (2.8.0)
+      activesupport (>= 4.2.0)
+      multi_json (>= 1.2)
+    jquery-rails (4.3.3)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    kaminari (1.1.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.1.1)
+      kaminari-activerecord (= 1.1.1)
+      kaminari-core (= 1.1.1)
+    kaminari-actionview (1.1.1)
+      actionview
+      kaminari-core (= 1.1.1)
+    kaminari-activerecord (1.1.1)
+      activerecord
+      kaminari-core (= 1.1.1)
+    kaminari-core (1.1.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    momentjs-rails (2.20.1)
+      railties (>= 3.1)
+    msgpack (1.2.4)
+    multi_json (1.13.1)
+    nio4r (2.3.1)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (3.0.3)
+    puma (3.12.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.2)
+      actioncable (= 5.2.2)
+      actionmailer (= 5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      activemodel (= 5.2.2)
+      activerecord (= 5.2.2)
+      activestorage (= 5.2.2)
+      activesupport (= 5.2.2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    regexp_parser (1.3.0)
+    ruby_dep (1.5.0)
+    rubyzip (1.2.2)
+    sass (3.7.2)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.0.7)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    selectize-rails (0.12.6)
+    selenium-webdriver (3.141.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2, >= 1.2.2)
+    spring (2.0.2)
+      activesupport (>= 4.2)
+    spring-watcher-listen (2.0.1)
+      listen (>= 2.7, < 4.0)
+      spring (>= 1.2, < 3.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.9)
+    turbolinks (5.2.0)
+      turbolinks-source (~> 5.2)
+    turbolinks-source (5.2.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uglifier (4.1.20)
+      execjs (>= 0.3.0, < 3)
+    web-console (3.7.0)
+      actionview (>= 5.0)
+      activemodel (>= 5.0)
+      bindex (>= 0.4.0)
+      railties (>= 5.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  administrate
+  administrate-field-active_storage!
+  bootsnap (>= 1.1.0)
+  byebug
+  capybara (>= 2.15, < 4.0)
+  chromedriver-helper
+  coffee-rails (~> 4.2)
+  jbuilder (~> 2.5)
+  listen (>= 3.0.5, < 3.2)
+  puma (~> 3.11)
+  rails (~> 5.2.0)
+  sass-rails (~> 5.0)
+  selenium-webdriver
+  spring
+  spring-watcher-listen (~> 2.0.0)
+  sqlite3
+  turbolinks (~> 5)
+  tzinfo-data
+  uglifier (>= 1.3.0)
+  web-console (>= 3.3.0)
+
+RUBY VERSION
+   ruby 2.4.1p111
+
+BUNDLED WITH
+   1.16.0