administrate-field-active_storage 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36e2931ef3866e05ff79f6580d2e82d9255bf32a
+  data.tar.gz: e756ee6745311cfc2fda588a222ec4f4ce5656a1
+SHA512:
+  metadata.gz: ec287997ada87ecba73e4aba1f812be8005fe2340c6b37a2edf7b7177cb15a0dccdfc91a46b0b530548e83258754d88837ec18ec873b19fda999fd8f82c14b9f
+  data.tar.gz: 9b43814703a5281d9de9a0f2a7a16878e5b75c995c9f33cd93816ea70414ffb3b68757d55ef191ea5aa819f6c2f374921ac06460223cb3ff428b0fdec4d990ff

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# CHANGELOG
+
+## 1.1.0 (2017-03-24)
+
+* Don't crash if image is nil/blank ([#9][])
+* Remove Explicit Dependency on Rails ([#11][])
+* Adds this CHANGELOG ([#12][])
+
+[#9]: https://github.com/thoughtbot/administrate-field-image/pull/9
+[#11]: https://github.com/thoughtbot/administrate-field-image/pull/11
+[#12]: https://github.com/thoughtbot/administrate-field-image/pull/12
+
+## 1.0.0 (2017-01-16)
+
+* Extraction from [administrate][].
+* Rails 5 support.
+
+[administrate]: https://github.com/thoughtbot/administrate

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,53 @@
+# Administrate::Field::ActiveStorage
+![rails](https://img.shields.io/badge/rails-%3E%3D5.2.0-red.svg)
+## Things To Know:
+- currently the gem only works for `has_one_attached` support for `has_many_attached` will be added in a future release.
+- 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
+gem 'administrate-field-active_storage'
+```
+
+Install:
+
+```
+$ bundle install
+```
+
+Use:
+assuming your modelname 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`.
+currently adding `:attachment` `COLLECTION_ATTRIBUTES` will work but will probably look too big.
+
+## 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
+- [ ] preview office files as pictures
+- [ ] upload multiple files
+
+## 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
+---
+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/administrate-field-active_storage.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "administrate-field-active_storage"
+  gem.version = "0.0.2"
+  gem.authors = ["Hamad AlGhanim"]
+  gem.email = ["hamadyalghanim@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.0.rc1"
+  gem.add_dependency "rails", ">= 5.2"
+
+  gem.add_development_dependency "rspec", "~> 3.4"
+end

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

@@ -0,0 +1,23 @@
+<%#
+# 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">
+  <%= f.file_field field.attribute %>
+</div>

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

@@ -0,0 +1,31 @@
+<%#
+# 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
+%>
+<% if field.image? %>
+  <%= image_tag(field.url) %>
+<% elsif field.video? and field.previewable?%> <%# if ffmpeg is installed %> 
+  <%= video_tag(field.url, poster: field.preview(resize: "1920x1080>"), controls: true, autobuffer: true, style: "width: 100%; height: auto;") %>
+<% elsif field.video? %>
+  <%= video_tag(field.url, controls: true, autobuffer: true, style: "width: 100%; height: auto;") %>
+<% elsif field.audio? %>
+  <%= audio_tag(field.url, autoplay: true, controls: true) %>
+<% elsif field.previewable? %>
+  <%= image_tag(field.preview(resize: "595x842>")) %>
+  <br/>
+  Download: <%= link_to(field.filename, field.blob_url) %>
+<% else %>
+  <%= link_to(field.filename, field.blob_url) %>
+<% end %>

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

@@ -0,0 +1,30 @@
+<%#
+# 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.image? %>
+  <%= image_tag(field.url) %>
+<% elsif field.video? %>
+  <%= video_tag(field.url, poster: field.preview(resize: "1920x1080>"), controls: true, autobuffer: true, style: "width: 100%; height: auto;") %>
+<% elsif field.audio? %>
+  <%= audio_tag(field.url, autoplay: true, controls: true) %>
+<% elsif field.previewable? %>
+  <%= image_tag(field.preview(resize: "595x842>")) %>
+  <br/>
+  Download: <%= link_to(field.filename, field.blob_url) %>
+<% else %>
+  <%= link_to(field.filename, field.blob_url) %>
+<% end %>

data/lib/administrate/field/active_storage.rb

@@ -0,0 +1,37 @@
+require "administrate/field/base"
+require "rails"
+
+module Administrate
+  module Field
+    class ActiveStorage < Administrate::Field::Base
+      class Engine < ::Rails::Engine
+      end
+      # currently we are using Rails.application.routes.url_helpers 
+      # without including the namespace because it runs into an
+      # exception
+
+      def url
+        Rails.application.routes.url_helpers.rails_blob_path(data, only_path: true)
+      end
+
+      def blob_url
+        Rails.application.routes.url_helpers.rails_blob_path(data, disposition: :attachment, only_path: true)
+      end
+      
+      # work around since calling data.preview(options)
+      # returns "/images/<ActiveStorage::Preview>" which isnt the url
+
+      def preview(options)
+        Rails.application.routes.url_helpers.rails_representation_path(data.preview(options), only_path: true)
+      end
+      
+      delegate :filename, to: :data
+      delegate :previewable?, to: :data
+      delegate :image?, to: :data
+      delegate :video?, to: :data
+      delegate :audio?, to: :data
+      delegate :audio?, 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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-active_storage
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Hamad AlGhanim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-06 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.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.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:
+- hamadyalghanim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-active_storage.gemspec
+- app/views/fields/active_storage/_form.html.erb
+- app/views/fields/active_storage/_index.html.erb
+- app/views/fields/active_storage/_show.html.erb
+- contribute.md
+- lib/administrate/field/active_storage.rb
+- spec/lib/administrate/field/active_storage_spec.rb
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Administrate fields for active storage
+test_files:
+- spec/lib/administrate/field/active_storage_spec.rb