shrine 2.19.4 → 3.0.0.alpha

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.19.4
+  version: 3.0.0.alpha
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: content_disposition
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
-- !ruby/object:Gem::Dependency
-  name: minitest-hooks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: shrine-memory
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -388,6 +368,7 @@ files:
 - doc/attacher.md
 - doc/carrierwave.md
 - doc/changing_location.md
+- doc/creating_persistence_plugins.md
 - doc/creating_plugins.md
 - doc/creating_storages.md
 - doc/design.md
@@ -398,34 +379,27 @@ files:
 - doc/paperclip.md
 - doc/plugins/activerecord.md
 - doc/plugins/add_metadata.md
+- doc/plugins/atomic_helpers.md
 - doc/plugins/backgrounding.md
-- doc/plugins/backup.md
 - doc/plugins/cached_attachment_data.md
-- doc/plugins/copy.md
+- doc/plugins/column.md
 - doc/plugins/data_uri.md
 - doc/plugins/default_storage.md
 - doc/plugins/default_url.md
-- doc/plugins/default_url_options.md
-- doc/plugins/delete_promoted.md
 - doc/plugins/delete_raw.md
 - doc/plugins/derivation_endpoint.md
+- doc/plugins/derivatives.md
 - doc/plugins/determine_mime_type.md
-- doc/plugins/direct_upload.md
 - doc/plugins/download_endpoint.md
 - doc/plugins/dynamic_storage.md
-- doc/plugins/hooks.md
+- doc/plugins/entity.md
 - doc/plugins/included.md
 - doc/plugins/infer_extension.md
 - doc/plugins/instrumentation.md
 - doc/plugins/keep_files.md
-- doc/plugins/logging.md
 - doc/plugins/metadata_attributes.md
-- doc/plugins/migration_helpers.md
+- doc/plugins/model.md
 - doc/plugins/module_include.md
-- doc/plugins/moving.md
-- doc/plugins/multi_delete.md
-- doc/plugins/parallelize.md
-- doc/plugins/parsed_json.md
 - doc/plugins/presign_endpoint.md
 - doc/plugins/pretty_location.md
 - doc/plugins/processing.md
@@ -443,6 +417,7 @@ files:
 - doc/plugins/tempfile.md
 - doc/plugins/upload_endpoint.md
 - doc/plugins/upload_options.md
+- doc/plugins/url_options.md
 - doc/plugins/validation_helpers.md
 - doc/plugins/versions.md
 - doc/processing.md
@@ -494,35 +469,30 @@ files:
 - lib/shrine/plugins/_urlsafe_serialization.rb
 - lib/shrine/plugins/activerecord.rb
 - lib/shrine/plugins/add_metadata.rb
-- lib/shrine/plugins/background_helpers.rb
+- lib/shrine/plugins/atomic_helpers.rb
+- lib/shrine/plugins/attacher_options.rb
 - lib/shrine/plugins/backgrounding.rb
-- lib/shrine/plugins/backup.rb
 - lib/shrine/plugins/cached_attachment_data.rb
-- lib/shrine/plugins/copy.rb
+- lib/shrine/plugins/column.rb
 - lib/shrine/plugins/data_uri.rb
 - lib/shrine/plugins/default_storage.rb
 - lib/shrine/plugins/default_url.rb
 - lib/shrine/plugins/default_url_options.rb
-- lib/shrine/plugins/delete_promoted.rb
 - lib/shrine/plugins/delete_raw.rb
 - lib/shrine/plugins/derivation_endpoint.rb
+- lib/shrine/plugins/derivatives.rb
 - lib/shrine/plugins/determine_mime_type.rb
-- lib/shrine/plugins/direct_upload.rb
 - lib/shrine/plugins/download_endpoint.rb
 - lib/shrine/plugins/dynamic_storage.rb
-- lib/shrine/plugins/hooks.rb
+- lib/shrine/plugins/entity.rb
+- lib/shrine/plugins/form_assign.rb
 - lib/shrine/plugins/included.rb
 - lib/shrine/plugins/infer_extension.rb
 - lib/shrine/plugins/instrumentation.rb
 - lib/shrine/plugins/keep_files.rb
-- lib/shrine/plugins/logging.rb
 - lib/shrine/plugins/metadata_attributes.rb
-- lib/shrine/plugins/migration_helpers.rb
+- lib/shrine/plugins/model.rb
 - lib/shrine/plugins/module_include.rb
-- lib/shrine/plugins/moving.rb
-- lib/shrine/plugins/multi_delete.rb
-- lib/shrine/plugins/parallelize.rb
-- lib/shrine/plugins/parsed_json.rb
 - lib/shrine/plugins/presign_endpoint.rb
 - lib/shrine/plugins/pretty_location.rb
 - lib/shrine/plugins/processing.rb
@@ -540,10 +510,13 @@ files:
 - lib/shrine/plugins/tempfile.rb
 - lib/shrine/plugins/upload_endpoint.rb
 - lib/shrine/plugins/upload_options.rb
+- lib/shrine/plugins/url_options.rb
+- lib/shrine/plugins/validation.rb
 - lib/shrine/plugins/validation_helpers.rb
 - lib/shrine/plugins/versions.rb
 - lib/shrine/storage/file_system.rb
 - lib/shrine/storage/linter.rb
+- lib/shrine/storage/memory.rb
 - lib/shrine/storage/s3.rb
 - lib/shrine/uploaded_file.rb
 - lib/shrine/version.rb
@@ -568,11 +541,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications

data/doc/plugins/backup.md

@@ -1,31 +0,0 @@
-# Backup
-
-The [`backup`][backup] plugin allows you to automatically back up stored files
-to an additional storage.
-
-```rb
-storages[:backup_store] = Shrine::Storage::S3.new(options)
-plugin :backup, storage: :backup_store
-```
-
-After a file is stored, it will be reuploaded from store to the provided backup
-storage.
-
-```rb
-user.update(avatar: file) # uploaded both to :store and :backup_store
-```
-
-By default whenever stored files are deleted backed up files are deleted as
-well, but you can keep files on the "backup" storage by passing `delete:
-false`:
-
-```rb
-plugin :backup, storage: :backup_store, delete: false
-```
-
-Note that when adding this plugin with already existing stored files, Shrine
-won't know whether a stored file is backed up or not, so attempting to delete
-the backup could result in an error. To avoid that you can set `delete: false`
-until you manually back up the existing stored files.
-
-[backup]: /lib/shrine/plugins/backup.rb

data/doc/plugins/copy.md

@@ -1,24 +0,0 @@
-# Copy
-
-The [`copy`][copy] plugin allows copying attachment from one record to another.
-
-```rb
-plugin :copy
-```
-
-It adds a `Attacher#copy` method, which accepts another attacher, and copies
-the attachment from it:
-
-```rb
-photo.image_attacher.copy(other_photo.image_attacher)
-```
-
-This method will automatically be called when the record is duplicated:
-
-```rb
-duplicated_photo = photo.dup
-duplicated_photo.image #=> #<Shrine::UploadedFile>
-duplicated_photo.image != photo.image
-```
-
-[copy]: /lib/shrine/plugins/copy.rb

data/doc/plugins/delete_promoted.md

@@ -1,12 +0,0 @@
-# Delete Promoted
-
-The [`delete_promoted`][delete_promoted] plugin deletes files that have been
-promoted, after the record is saved. This means that cached files handled by
-the attacher will automatically get deleted once they're uploaded to store.
-This also applies to any other uploaded file passed to `Attacher#promote`.
-
-```rb
-plugin :delete_promoted
-```
-
-[delete_promoted]: /lib/shrine/plugins/delete_promoted.rb

data/doc/plugins/direct_upload.md

@@ -1,172 +0,0 @@
-# Direct Upload
-
-*[OBSOLETE] This plugin is obsolete, you should use `upload_endpoint` or
-`presign_endpoint` plugins instead.*
-
-The [`direct_upload`][direct_upload] plugin provides a Rack endpoint which can
-be used for uploading individual files asynchronously. It requires the [Roda]
-gem.
-
-```rb
-plugin :direct_upload
-```
-
-The Roda endpoint provides two routes:
-
-* `POST /:storage/upload`
-* `GET /:storage/presign`
-
-This first route is for doing direct uploads to your app, the received file
-will be uploaded the underlying storage. The second route is for doing direct
-uploads to a 3rd-party service, it will return the URL where the file can be
-uploaded to, along with the necessary request parameters.
-
-This is how you can mount the endpoint in a Rails application:
-
-```rb
-Rails.application.routes.draw do
-  mount ImageUploader::UploadEndpoint => "/images"
-end
-```
-
-Now your application will get `POST /images/cache/upload` and `GET
-/images/cache/presign` routes. On the client side it is recommended to use
-[Uppy] for uploading files to the app or directly to the 3rd-party service.
-
-## Uploads
-
-The upload route accepts a "file" query parameter, and returns the uploaded
-file in JSON format:
-
-```rb
-# POST /images/cache/upload
-{
-  "id": "43kewit94.jpg",
-  "storage": "cache",
-  "metadata": {
-    "size": 384393,
-    "filename": "nature.jpg",
-    "mime_type": "image/jpeg"
-  }
-}
-```
-
-Once you've uploaded the file, you can assign the result to the hidden
-attachment field in the form, or immediately send it to the server.
-
-Note that the endpoint uploads the file standalone, without any knowledge of
-the record, so `context[:record]` and `context[:name]` will be nil.
-
-### Limiting filesize
-
-It's good idea to limit the maximum filesize of uploaded files, if you set the
-`:max_size` option, files which are too big will get automatically deleted and
-413 status will be returned:
-
-```rb
-plugin :direct_upload, max_size: 5*1024*1024 # 5 MB
-```
-
-Note that this option doesn't affect presigned uploads, there you can apply
-filesize limit when generating a presign. The filesize constraint here is for
-security purposes, you should still perform file validations on attaching.
-
-## Presigns
-
-The presign route returns the URL to the 3rd-party service to which you can
-upload the file, along with the necessary query parameters.
-
-```rb
-# GET /images/cache/presign
-{
-  "url" => "https://my-bucket.s3-eu-west-1.amazonaws.com",
-  "fields" => {
-    "key" => "b7d575850ba61b44c8a9ff889dfdb14d88cdc25f8dd121004c8",
-    "policy" => "eyJleHBpcmF0aW9uIjoiMjAxNS0QwMToxMToyOVoiLCJjb2...",
-    "x-amz-credential" => "AKIAIJF55TMZYT6Q/20151024/eu-west-1/s3/aws4_request",
-    "x-amz-algorithm" => "AWS4-HMAC-SHA256",
-    "x-amz-date" => "20151024T001129Z",
-    "x-amz-signature" => "c1eb634f83f96b69bd675f535b3ff15ae184b102fcba51e4db5f4959b4ae26f4"
-  }
-}
-```
-
-If you want that the generated location includes a file extension, you can
-specify the `extension` query parameter: `GET
-/:storage/presign?extension=.png`.
-
-You can also completely change how the key is generated, with
-`:presign_location`:
-
-```rb
-plugin :direct_upload, presign_location: -> (request) { "${filename}" }
-```
-
-This presign route internally calls `#presign` on the storage, and many
-storages accept additional service-specific options. You can generate these
-additional options per-request through `:presign_options`:
-
-```rb
-plugin :direct_upload, presign_options: { acl: "public-read" }
-
-plugin :direct_upload, presign_options: ->(request) do
-  filename = request.params["filename"]
-  content_type = Rack::Mime.mime_type(File.extname(filename))
-
-  {
-    content_length_range: 0..(10*1024*1024),                     # limit filesize to 10MB
-    content_disposition: "attachment; filename=\"#{filename}\"", # download with original filename
-    content_type:        content_type,                           # set correct content type
-  }
-end
-```
-
-Both `:presign_location` and `:presign_options` in their block versions are
-yielded an instance of [Roda request], which is a subclass of `Rack::Request`.
-
-See the [Direct Uploads to S3] guide for further instructions on how to hook
-the presigned uploads to a form.
-
-## Allowed storages
-
-By default only uploads to `:cache` are allowed, to prevent the possibility of
-having orphan files in your main storage. But you can allow more storages:
-
-```rb
-plugin :direct_upload, allowed_storages: [:cache, :store]
-```
-
-## Customizing endpoint
-
-Since the endpoint is a [Roda] app, it is very customizable. For example, you
-can add a Rack middleware to change the response status and headers:
-
-```rb
-class ShrineUploadMiddleware
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    result = @app.call(env)
-
-    if result[0] == 200 && env["PATH_INFO"].end_with?("upload")
-      result[0] = 201
-      result[1]["Location"] = Shrine.uploaded_file(result[2].first).url
-    end
-
-    result
-  end
-end
-
-Shrine::UploadEndpoint.use ShrineUploadMiddleware
-```
-
-Upon subclassing uploader the upload endpoint is also subclassed. You can also
-call the plugin again in an uploader subclass to change its configuration.
-
-[direct_upload]: /lib/shrine/plugins/direct_upload.rb
-[Roda]: https://github.com/jeremyevans/roda
-[Uppy]: https://uppy.io
-[Roda request]: http://roda.jeremyevans.net/rdoc/classes/Roda/RodaPlugins/Base/RequestMethods.html
-[Direct Uploads to S3]: /doc/direct_s3.md#readme