active_storage_drag_and_drop 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 854832dbb9db5f8d21586731c225733150c301319d21ac4e491ce3438e3f68a8
-  data.tar.gz: 72a105146a33a493a63002cfdd5cd0ffe6c7e59750c06198f2a761adee31a29c
+  metadata.gz: 7ba690ed77fde42914d34c270c5fda5cf7746486223b6755093e533366dc0b45
+  data.tar.gz: 8975e08690e83f5ef6d414c02a06b24c775f3895b68e56b7c154c245f56e6461
 SHA512:
-  metadata.gz: 63c0fae314d322c815ecd49c55b5d283132db860b9bafadc5ce70fbe9624a529f2342cd9c3101c35fee1036e1f94181bd2bdc7be9583f01de3f40a852fd0e713
-  data.tar.gz: 892db1eb18be0289bb65d94e6fa7705938ca22b055c11f03868746344c73582519acd41b7d69f96474a9564d80aadc7292d403476bd80968ac7e88debd0150b0
+  metadata.gz: c9d8bdd77b497ca484f0cf5406776d661003acb83f1a8184b9eb729f2d1182f6de603b17562b9bca57801a69c3f4e2456f67f0601d3fb70f6ea797dd928416f7
+  data.tar.gz: '090aed49947b5fc99af2618e4c4e4d0daaeca3393e42322b4354124a109494432c26f9a690105755fa3082f4c931eb96b2a998447a97e345e2cfa456b5ebaa00'

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+plugins:
+  rubocop:
+    enabled: true
+  eslint:
+    enabled: true

data/.eslintignore

@@ -0,0 +1,5 @@
+/doc
+/app/assets/javascripts/active_storage_drag_and_drop.js
+/test/dummy
+/vendor
+/coverage

data/.eslintrc.yml

@@ -0,0 +1 @@
+extends: standard

data/.gitignore

@@ -1,3 +1,5 @@
+.idea
+.idea/workspace.xml
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -8,3 +10,21 @@
 /node_modules/
 /tmp/
 active_storage_drag_and_drop-*.gem
+
+/test/dummy/.bundle
+
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-journal
+
+/test/dummy/log/*
+!/test/dummy/log/.keep
+
+/test/dummy/tmp/*
+!/test/dummy/tmp/.keep
+
+/test/dummy/storage/*
+!/test/dummy/storage/.keep
+
+/test/dummy/.byebug_history
+
+/test/dummy/db/migrate/*.active_storage.rb

data/.rubocop.yml

@@ -1,17 +1,15 @@
 AllCops:
+  TargetRubyVersion: 2.5.0
   Exclude:
-    - 'app/assets/havascripts/active_storage_drag_and_drop.js'
     - 'lib/active_storage_drag_and_drop/version.rb'
+    - 'test/dummy/db/migrate/*'
+    - 'test/dummy/bin/*'
+    - 'test/dummy/config/**/*'
+    - 'vendor/**/*'
 
 Rails:
   Enabled: true
 
-Rails/OutputSafety:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
 Style/ClassAndModuleChildren:
   Enabled: false
 
@@ -20,3 +18,7 @@ Style/BracesAroundHashParameters:
 
 Metrics/LineLength:
   Max: 99
+
+Metrics/BlockLength:
+  Exclude:
+    - 'active_storage_drag_and_drop.gemspec'

data/.travis.yml

@@ -1,5 +1,21 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.5.0
-before_install: gem install bundler -v 1.16.1
+
+addons:
+  firefox: latest
+
+env:
+  global:
+    CC_TEST_REPORTER_ID=93b20ad2a94eb5d9feb97dca94b2d1df4243fa3d715d5d6c1c61bc9c6199f105
+
+before_install:
+  - gem install bundler -v 1.16.1
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardopts

@@ -0,0 +1,3 @@
+--markup-provider=redcarpet
+--markup=markdown
+--private

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -49,15 +49,49 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    archive-zip (0.11.0)
+      io-like (~> 0.3.0)
     arel (9.0.0)
+    ast (2.4.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)
+    coderay (1.1.2)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
+    docile (1.3.1)
     erubi (1.7.1)
+    ffi (1.9.25)
+    geckodriver-helper (0.23.0)
+      archive-zip (~> 0.7)
+    github-markup (3.0.2)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    haml (5.0.4)
+      temple (>= 0.8.0)
+      tilt
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
+    io-like (0.3.0)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    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)
@@ -70,9 +104,22 @@ GEM
     mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    msgpack (1.2.4)
     nio4r (2.3.1)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    puma (3.12.0)
     rack (2.0.6)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -100,7 +147,32 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    redcarpet (3.4.0)
+    regexp_parser (1.3.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    rubyzip (1.2.2)
+    selenium-webdriver (3.141.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2, >= 1.2.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -108,22 +180,43 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    temple (0.8.0)
     thor (0.20.3)
     thread_safe (0.3.6)
+    tilt (2.0.9)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
     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
   active_storage_drag_and_drop!
+  bootsnap
   bundler (~> 1.16)
+  capybara
+  geckodriver-helper
+  github-markup
+  haml
+  listen
   minitest (~> 5.0)
+  nokogiri
+  pry
+  pry-byebug
+  puma
   rake (~> 10.0)
+  redcarpet
+  rubocop
+  selenium-webdriver
+  simplecov
+  sqlite3
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,6 +1,14 @@
 # Active Storage Drag and Drop
 
-Provides a form helper to make it easy to make drag and drop file upload fields that work with Rails' Active Storage.
+[![Gem Version](https://badge.fury.io/rb/active_storage_drag_and_drop.svg)](https://badge.fury.io/rb/active_storage_drag_and_drop)
+[![Build Status](https://travis-ci.org/marinosoftware/active_storage_drag_and_drop.svg?branch=master)](https://travis-ci.org/marinosoftware/active_storage_drag_and_drop)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/13860b97c99c3a989176/test_coverage)](https://codeclimate.com/github/marinosoftware/active_storage_drag_and_drop/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/13860b97c99c3a989176/maintainability)](https://codeclimate.com/github/marinosoftware/active_storage_drag_and_drop/maintainability)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/active_storage_drag_and_drop)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+Provides a form helper to make it easy to make drag and drop file upload fields that work with
+Rails' [ActiveStorage](https://github.com/rails/rails/tree/master/activestorage).
 
 ## Installation
 
@@ -35,58 +43,145 @@ You may also optionally include some basic styles in your application css:
 
 Add an ActiveStorage attachment to your model:
 ```ruby
+class Message < ApplicationRecord
+  has_one_attached :image
+end
+```
+or add multiple ActiveStorage attachments to your model:
+```ruby
 class Message < ApplicationRecord
   has_many_attached :images
 end
 ```
+
 Call the method `drag_and_drop_file_field` on your model's form:
 ```haml
 = form_with model: @message, local: true do |form|
   = form.drag_and_drop_file_field :images
   = form.submit
 ```
-The first parameter is a symbol representing the method of the ActiveStorage attachment and an optional second parameter sets the the text on the drag and drop zone.
+The first parameter is a symbol representing the method of the ActiveStorage attachment and an
+optional second parameter sets the the text on the drag and drop zone.
 ```ruby
 form.drag_and_drop_file_field :images, 'Drag and drop images here!'
 ```
 The content of the dropzone can also be passed as a block of ERB or HAML:
 ```haml
-= form.drag_and_drop_file_field :images do
+= form.drag_and_drop_file_field :images, disabled: false do
   %i.far.fa-images
   Drag images here!
 ```
-Options for the nested file field can be passed as key value pairs:
+
+
+
+### Strong Parameters
+
+In your controller you can permit the params like so:
+```ruby
+# single file upload
+params.permit(:message).require(:image)
+# multiple upload
+params.permit(:message).require(images: [])
+```
+
+### Options
+Options for the nested file field can be passed as key value pairs. The helper accepts the same
+options as the rails file_field form helper
+[ActionView::Helpers::FormHelper#file_field](https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-file_field)
 ```ruby
-form.drag_and_drop_file_field :images, accept: 'image/png, image/jpeg, image/gif, image/tiff'
+form.drag_and_drop_file_field :images, nil, disabled: true
 ```
-An additional `size_limit` option can be passed which provides validation on the maximum acceptable filesize in bytes:
+
+### Validation
+
+Like with the
+[ActionView::Helpers::FormHelper#file_field](https://edgeapi.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-file_field)
+you can pass a list of acceptable mime-types for client-side validation:
 ```ruby
-form.drag_and_drop_file_field :images, size_limit: 5_000_000 # 5MB upper limit on file size
+form.drag_and_drop_file_field :images, nil, accept: 'image/png, image/jpeg, image/gif, image/tiff'
 ```
-In your controller you can permit the params like so:
+An additional `size_limit` option can be passed which provides validation on the maximum acceptable
+filesize in bytes:
 ```ruby
-params.permit(:message).require(images: [])
+form.drag_and_drop_file_field :images, nil, size_limit: 5_000_000 # 5MB upper limit on file size
+```
+When one of these errors occurs by default a JavaScript `'dnd-upload:error'` event is dispatched
+and an alert detailing the validation error appears. To override this default behaviour listen
+for the event and call `preventDefault()` on the event.
+
+### JavaScript Events
+
+| Event name | Event target | Event data (`event.detail`) | Description |
+| --- | --- | --- | --- |
+| `dnd-uploads:start` | `<form>` | None | A form containing files for direct upload fields was submitted. |
+| `dnd-upload:initialize` | `<input>` | `{id, file, iconContainer}` | Dispatched for every file after form submission. |
+| `dnd-upload:start` | `<input>` | `{id, file, iconContainer}` | A direct upload is starting. |
+| `dnd-upload:before-blob-request` | `<input>` | `{id, file, iconContainer, xhr}` | Before making a request to your application for direct upload metadata. |
+| `dnd-upload:before-storage-request` | `<input>` | `{id, file, iconContainer, xhr}` | Before making a request to store a file. |
+| `dnd-upload:progress` | `<input>` | `{id, file, iconContainer, progress}` | As requests to store files progress. |
+| `dnd-upload:error` | `<input>` | `{id, file, iconContainer, error}` | An error occurred. An `alert` will display unless this event is canceled. |
+| `dnd-upload:end` | `<input>` | `{id, file, iconContainer}` | A direct upload has ended. |
+| `dnd-uploads:end` | `<form>` | None | All direct uploads have ended. |
+
+To override the default behaviour of any of these events catch them with an event listener and call
+`preventDefault()` on the event:
+```javascript
+document.addEventListener('dnd-upload:error', function (event) {
+  # do something...
+  event.preventDefault()
+})
+```
+
+To asynchronously trigger uploading without form submission dispatch a
+`dnd-uploads:process-upload-queue` event:
+```javascript
+var callback = function(error) {
+  if (error) {
+    // ...handle error...
+  } else {
+    // ...do your stuff
+  }
+}
+
+const uploadEvent = document.createEvent('Event')
+uploadEvent.initEvent('dnd-uploads:process-upload-queue', true, true)
+uploadEvent.detail = { callback }
+form.dispatchEvent(uploadEvent)
 ```
 
 ## Development
 
-Install yarn to manage js dependencies.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Install yarn to manage js dependencies. After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-After making a change to the javascript in `app/javascript` compile it to `app/assets/javascripts/active_storage_drag_and_drop.js` by running `node_modules/webpack-command/lib/cli.js`.
+After making a change to the javascript in `app/javascript` compile it to
+`app/assets/javascripts/active_storage_drag_and_drop.js` by running
+`yarn webpack`.
 
-Use `node_modules/webpack-command/lib/cli.js --mode=development --watch` to build files automatically on change.  Use with `gem 'active_storage_drag_and_drop', path: [local-gem-repo]` to develop and debug the gem in place in a rails app.
+Use `yarn webpack --mode=development --watch` to build files
+automatically on change.  Use with `gem 'active_storage_drag_and_drop', path: [local-gem-repo]` to
+develop and debug the gem in place in a rails app.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marinosoftware/active_storage_drag_and_drop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/marinosoftware/active_storage_drag_and_drop. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the ActiveStorageDragAndDrop project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marinosoftware/active_storage_drag_and_drop/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ActiveStorageDragAndDrop project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/marinosoftware/active_storage_drag_and_drop/blob/master/CODE_OF_CONDUCT.md).