viniBaxter-field-active_storage 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1ff2205756df8663416ec7f31ea9683b5ccd891678bd69caa625ee86582aaaa
+  data.tar.gz: d299bb0e1dacb5ee7a51140d508758b76b8439b554402842e7cbdba30e9d84a3
+SHA512:
+  metadata.gz: 1ac5aeab30b570d71724ee54069b0522b6e4dd3a00d8fcd9e733789e54ff9328c10ee8a9b1e92fb1cbdcfe6778b81805329be145b8b20a609b2a43486086c278
+  data.tar.gz: 85c58922bca220c7c074f758bf30a5bdc2224cbec29cea7f9776cef978417ae081eb78351f6c3db21e15bb3bb93619bc716a32bb394d19d3ff1e362c8ae45b1a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008-2017 thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,166 @@
+# 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 Office files as pictures you need to install [activestorage-office-previewer](https://github.com/basecamp/activestorage-office-previewer) by basecamp
+
+## How To Use:
+Add `administrate-field-active_storage` and `mini_magick` to your Gemfile (rails 6):
+
+```ruby
+gem 'administrate-field-active_storage'
+gem 'mini_magick'
+```
+
+for rails 5.x use the following
+```ruby
+gem 'administrate-field-active_storage' -v 0.1.8
+```
+
+Install:
+
+```
+$ bundle install
+```
+
+### `has_one_attached`:
+Assuming your model name is `Model` and field name is `attachment`
+```ruby
+class ModelDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    attachment: Field::ActiveStorage,
+  }
+# ...
+```
+Then add `:attachment` to `FORM_ATTRIBUTES` and `SHOW_PAGE_ATTRIBUTES`.
+Adding `:attachment` `COLLECTION_ATTRIBUTES` will work but will probably look too big.
+
+### `has_many_attached`:
+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
+  ATTRIBUTE_TYPES = {
+    attachments: Field::ActiveStorage,
+  }
+
+  # ...
+  FORM_ATTRIBUTES = {
+    #...
+    :attachments
+  }
+
+  # permitted for has_many_attached
+  def permitted_attributes
+    super + [:attachments => []]
+  end
+```
+I know it is not ideal, if you have a workaround please submit a PR.
+
+### 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
+```ruby
+module Admin
+  class UsersController < Admin::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}),
+  }
+# ...
+```
+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
+```ruby
+class ModelDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    attachments: Field::ActiveStorage.with_options({url_only: true}),
+    # ...
+  }
+  # ...
+end
+```
+
+### show_in_index
+This will preview thumbnails in the index page and if you're using `has_many` it will show the first one as a thumbnail and a count of the total attached files
+```ruby
+class ModelDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    attachments: Field::ActiveStorage.with_options({show_in_index: true}),
+    # ...
+  }
+  # ...
+end
+```
+
+### show_preview_size
+Supply the size of the image preview inside the show page.  Check out the [mini_magic#resize_to_limit](https://github.com/janko/image_processing/blob/master/doc/minimagick.md#methods) documentation
+```ruby
+class ModelDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    attachments: Field::ActiveStorage.with_options({show_preview_size:  [150, 200]}),
+    # ...
+  }
+  # ...
+end
+```
+
+### direct_upload
+If you want to upload directly from the browser to the cloud you can use direct_upload
+```ruby
+class ModelDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    attachments: Field::ActiveStorage.with_options({direct_upload: true}),
+    # ...
+  }
+  # ...
+end
+```
+
+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.
+
+## 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
+- [x] use html audio element for audio files
+- [x] download link to other files
+- [x] preview videos
+- [x] preview pdfs
+- [x] upload multiple files
+- [x] find a way to delete attachments
+- [x] preview office files as pictures
+
+## Contribution Guide:
+1. contributers are welcome (code, suggestions, and bugs).
+2. please document your code.
+3. add your name to the `contribute.md`.
+
+---
+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/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "bundler/gem_tasks"
+
+##
+# Configure the test suite.
+##
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+##
+# By default, just run the tests.
+##
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

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

@@ -0,0 +1,30 @@
+<%#
+# Image Form Partial
+
+This partial renders an input element for image attributes.
+By default, the input is a text field for the image's URL.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Image][1].
+  A wrapper around the image url pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Image
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+
+<div class="field-unit__field">
+  <% if field.data.present? && 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?, direct_upload: field.direct? %>
+</div>

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

@@ -0,0 +1,32 @@
+<%#
+# Image Index Partial
+
+This partial renders an image attribute
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered as an image tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Image][1].
+  A wrapper around the image url pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Image
+%>
+<style> <%# figure out a way to remove this %>
+  td img {
+      max-height: unset !important;
+  }
+</style>
+<%
+  attachments = Array(field.many? ? field.attachments : field.data)
+%>
+<% if field.attached? %>
+  <% if field.show_in_index? %>
+    <%= render partial: 'fields/active_storage/item', locals: { field: field, attachment: attachments[0], image_size: [50, 50] } %>
+  <% end %>
+  <% pluralize(attachments.count, 'Attached file') %>
+<% else %>
+0 Attached files
+<% end %>

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

@@ -0,0 +1,57 @@
+<%#
+# 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)
+  image_size = local_assigns.fetch(:image_size, [1920, 1080])
+%>
+
+<% if attachment.image? and attachment.variable? and !field.url_only? %>
+  <%= link_to(field.blob_url(attachment), title: attachment.filename) do %>
+    <%= image_tag(field.variant(attachment, resize_to_limit: image_size)) %>
+  <% end %>
+<% elsif attachment.image? and !field.url_only? %>
+  <%= link_to(field.blob_url(attachment), title: attachment.filename) do %>
+    <%= image_tag(field.url(attachment)) %>
+  <% end %>
+<% elsif attachment.video? and attachment.previewable? and !field.url_only? %> <%# if ffmpeg is installed %>
+  <%= video_tag(field.url(attachment), poster: field.preview(attachment, resize_to_limit: image_size), 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;") %>
+<% elsif attachment.audio? and !field.url_only? %>
+  <%= audio_tag(field.url(attachment), autoplay: false, controls: true) %>
+<% else %>
+  <%= link_to(field.blob_url(attachment), title: attachment.filename) do %>
+    <% if attachment.previewable? and !field.url_only? %>
+      <%= image_tag(field.preview(attachment, resize_to_limit: [595, 842])) %>
+    <% else %>
+      <%= attachment.filename %>
+    <% end %>
+  <% end %>
+<% 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, image_size: field.show_preview_size } %>
+  </div>
+<% end %>

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

@@ -0,0 +1,20 @@
+<%#
+# Image Show Partial
+
+This partial renders an image attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as an image tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Image][1].
+  A wrapper around the image url pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Image
+%>
+
+<% if field.attached? %>
+  <%= render partial: 'fields/active_storage/items', locals: { field: field } %>
+<% end %>

data/contribute.md

@@ -0,0 +1,13 @@
+# Contributors
+
+- Patrick Gleeson [@patrick-gleeson](https://github.com/patrick-gleeson)
+- Mario Zigliotto [@mariozig](https://github.com/mariozig)
+- Leif Gensert [@leifg](https://github.com/leifg)
+- Kadu Diógenes [@cerdiogenes](https://github.com/cerdiogenes)
+- Peter Bhat Harkins [@pushcx](https://github.com/pushcx)
+- Delta Purna Widyangga [@deltapurna](https://github.com/deltapurna)
+- Joé Dupuis [@twistedjoe](https://github.com/twistedjoe)
+- Eugeny Khlopin [@evgeniy-khlopin](https://github.com/evgeniy-khlopin)
+- Daniel Tinoco [@0urobor0s](https://github.com/0urobor0s)
+- Matthew Hui [@mhui](https://github.com/mhui)
+- Sébastien Dubois [@sedubois](https://github.com/sedubois)

data/lib/viniBaxter/field/active_storage.rb

@@ -0,0 +1,72 @@
+require 'administrate/field/base'
+require 'rails'
+
+module Administrate
+  module Field
+    class ActiveStorage < Administrate::Field::Base
+      class Engine < ::Rails::Engine
+      end
+
+      def url_only?
+        options.fetch(:url_only, false)
+      end
+
+      def destroyable?
+        options.key?(:destroy_path)
+      end
+
+      def show_in_index?
+        options.fetch(:show_in_index, false)
+      end
+
+      def show_preview_size
+        options.fetch(:show_preview_size, [1080, 1920])
+      end
+
+      def many?
+        # find a way to use instance_of
+        data.class.name == 'ActiveStorage::Attached::Many'
+      end
+
+      def direct?
+        options.fetch(:direct_upload, false)
+      end
+
+      # def destroy_path?
+      #   options.fetch(:destroy_path, false).present?
+      # end
+
+      # currently we are using Rails.application.routes.url_helpers
+      # without including the namespace because it runs into an
+      # exception
+
+      # work around since calling data.preview(options)
+      # returns "/images/<ActiveStorage::Preview>" which isnt the url
+      def preview(attachment, options)
+        Rails.application.routes.url_helpers.rails_representation_path(attachment.preview(options), only_path: true)
+      end
+
+      def variant(attachment, options)
+        Rails.application.routes.url_helpers.rails_representation_path(attachment.variant(combine_options: options), only_path: true)
+      end
+
+      def url(attachment)
+        Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true)
+      end
+
+      def blob_url(attachment)
+        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
+
+      delegate :attached?, to: :data
+      delegate :attachments, to: :data
+    end
+  end
+end

data/spec/lib/administrate/field/active_storage_spec.rb

@@ -0,0 +1,14 @@
+require "administrate/field/active_storage"
+
+describe Administrate::Field::ActiveStorage do
+  describe "#to_partial_path" do
+    it "returns a partial based on the page being rendered" do
+      page = :show
+      field = Administrate::Field::ActiveStorage.new(:image, "/a.jpg", page)
+
+      path = field.to_partial_path
+
+      expect(path).to eq("/fields/active_storage/#{page}")
+    end
+  end
+end

data/viniBaxter-field-active_storage.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "viniBaxter-field-active_storage"
+  gem.version = "0.2.4"
+  gem.authors = ["viny baxter"]
+  gem.email = ["vincent.viricel@gmail.com"]
+  gem.homepage = "https://github.com/Dreamersoul/administrate-field-active_storage"
+  gem.summary = "Administrate fields for active storage"
+  gem.description = gem.summary
+  gem.license = "MIT"
+
+  gem.require_paths = ["lib"]
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_dependency "administrate", ">= 0.2.3"
+  gem.add_dependency "rails", ">= 6.0.2.2"
+
+  gem.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: viniBaxter-field-active_storage
+version: !ruby/object:Gem::Version
+  version: 0.2.4
+platform: ruby
+authors:
+- viny baxter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Administrate fields for active storage
+email:
+- vincent.viricel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- _config.yml
+- app/views/fields/active_storage/_form.html.erb
+- app/views/fields/active_storage/_index.html.erb
+- app/views/fields/active_storage/_item.html.erb
+- app/views/fields/active_storage/_items.html.erb
+- app/views/fields/active_storage/_show.html.erb
+- contribute.md
+- lib/viniBaxter/field/active_storage.rb
+- spec/lib/administrate/field/active_storage_spec.rb
+- viniBaxter-field-active_storage.gemspec
+homepage: https://github.com/Dreamersoul/administrate-field-active_storage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Administrate fields for active storage
+test_files:
+- spec/lib/administrate/field/active_storage_spec.rb