delayed_paperclip 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5ac9bcd09517a634af35fb347bdc11cf538bb20
-  data.tar.gz: f11ca1ba331c50817bd6a9bcd3b6197948a4ae23
+  metadata.gz: 87f666e3339caae1a67262dc9d7a2e0a4735a4cb
+  data.tar.gz: 17312387a6ca724e835abee1b1aac059c28e24b2
 SHA512:
-  metadata.gz: 3d297de920ba09991941b8a0d3c172c0a36cdc3a89542797eb9341ef757da42cf11a7f2176e985f74d13d93ae8aa2ce8b38ce3749833d789a8784e7c5a64a30f
-  data.tar.gz: f8eb0f2c138883e8a948b6523d29ed18fb7c045b9d0e81020fc004e5e6b9c9b7fb4958e925abfd672c210a1fbd9a7309a49239856165657e25e311e88363255b
+  metadata.gz: cd54dd5bf121d9d9b1bec0feeb669d8afed6dbf0edecc4088f14c84578d976e2cab2e55e5959f03a3b6aba0ca6a75870285870938f6b156ee8bf8d1e0c0402d2
+  data.tar.gz: 5731d670649b7b293b587192d7f569912caf43c717c100b384e24bbc2377b297f30346edf69c88a7c5320621ee1d5a1c9221abedeb59ee8f40e2c81b9ef83558

data/.travis.yml

@@ -9,19 +9,19 @@ rvm:
   - 2.0
 
 gemfile:
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
 
-# Rails 5.0 requires Ruby >= 2.2
+# Rails 5.0 requires Ruby >= 2.2.2
 matrix:
   exclude:
     - rvm: 2.1.10
       gemfile: gemfiles/5.0.gemfile
     - rvm: 2.0
       gemfile: gemfiles/5.0.gemfile
+    # Paperclip >= 5.0 requires Ruby 2.1
+    - rvm: 2.0
+      gemfile: gemfiles/4.2.gemfile
 
 script: "bundle exec rake clean spec"
 

data/Appraisals

@@ -1,19 +1,7 @@
-appraise "3.2" do
-  gem "rails", "~> 3.2.15"
-end
-
-appraise "4.0" do
-  gem "rails", "~> 4.0.0"
-end
-
-appraise "4.1" do
-  gem "rails", "~> 4.1.0"
-end
-
 appraise "4.2" do
   gem "rails", "~> 4.2.0"
 end
 
 appraise "5.0" do
-  gem "rails", "~> 5.0.0.beta3"
+  gem "rails", "~> 5.0.0"
 end

data/README.md

@@ -3,10 +3,7 @@ Delayed::Paperclip [![Build Status](https://travis-ci.org/jrgifford/delayed_pape
 
 
 DelayedPaperclip lets you process your [Paperclip](http://github.com/thoughtbot/paperclip)
-attachments in a background task with
-[ActiveJob](https://github.com/rails/rails/tree/master/activejob),
-[DelayedJob](https://github.com/collectiveidea/delayed_job),
-[Resque](https://github.com/resque/resque) or [Sidekiq](https://github.com/mperham/sidekiq).
+attachments in a background task with [ActiveJob](https://github.com/rails/rails/tree/master/activejob)
 
 Why?
 ----
@@ -14,8 +11,7 @@ Why?
 The most common use case for Paperclip is to easily attach image files
 to ActiveRecord models. Most of the time these image files will have
 multiple styles and will need to be resized when they are created. This
-is usually a pretty [slow operation](http://www.jstorimer.com/ruby/2010/01/05/speep-up-your-paperclip-tests.html) and should be handled in a
-background task.
+is usually a pretty slow operation and should be handled in a background task.
 
 I’m sure that everyone knows this, this gem just makes it easy to do.
 
@@ -24,28 +20,23 @@ Installation
 
 Install the gem:
 
-````
+```
 gem install delayed_paperclip
-````
+```
 
 Or even better, add it to your Gemfile.
 
-````
+```
 source "https://rubygems.org"
-gem 'delayed_paperclip'
-````
-
-Dependencies:
-
--   Paperclip
--   DJ, Resque or Sidekiq
+gem "delayed_paperclip"
+```
 
 Usage
 -----
 
 In your model:
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: {
                                        medium: "300x300>",
@@ -54,57 +45,10 @@ class User < ActiveRecord::Base
 
   process_in_background :avatar
 end
-````
+```
 
 Use your Paperclip attachment just like always in controllers and views.
 
-To select between using Resque or Delayed::Job, just install and
-configure your choice properly within your application, and
-delayed_paperclip will do the rest. It will detect which library is
-loaded and make a decision about which sort of job to enqueue at that
-time.
-
-### Active Job
-
-[Active Job](https://github.com/rails/rails/tree/master/activejob) will take
-precedence over any other installed library. Since it is installed as a
-dependency with Rails 4.2.1 this might cause some confusion, so make sure that
-Active Job is configured to use the correct queue adapter:
-
-````ruby
-module YourApp
-  class Application < Rails::Application
-    # Other code...
-
-    config.active_job.queue_adapter = :resque  # Or :delayed_job or :sidekiq
-  end
-end
-````
-
-### Resque
-
-Resque adapter is deprecated. Please use ActiveJob one.
-
-Make sure that you have [Resque](https://github.com/resque/resque) up and running. The jobs will be
-dispatched to the <code>:paperclip</code> queue, so you can correctly
-dispatch your worker. Configure resque and your workers exactly as you
-would otherwise.
-
-### DJ
-
-DelayedJob adapter is deprecated. Please use ActiveJob one.
-
-Just make sure that you have DJ up and running.
-
-### Sidekiq
-
-Sidekiq adapter is deprecated. Please use ActiveJob one.
-
-Make sure that [Sidekiq](http://github.com/mperham/sidekiq) is running and listening to the
-`paperclip` queue, either by adding it to your
-`sidekiq.yml` config file under `- queues:` or by
-passing the command line argument `-q paperclip` to Sidekiq.
-
 ### Displaying images during processing
 
 In the default setup, when you upload an image for the first time and
@@ -117,7 +61,7 @@ To have the missing image url be outputted by paperclip while the image is being
 `#{attachment_name}_processing` column to the specific model you want
 to enable this feature for. This feature gracefully degrades and will not affect models which do not have the column added to them.
 
-````ruby
+```ruby
 class AddAvatarProcessingToUser < ActiveRecord::Migration
   def self.up
     add_column :users, :avatar_processing, :boolean
@@ -131,18 +75,19 @@ end
 @user = User.new(avatar: File.new(...))
 @user.save
 @user.avatar.url #=> "/images/original/missing.png"
-Delayed::Worker.new.work_off
+
+# Process job
 
 @user.reload
 @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
-````
+```
 
 #### Custom image for processing
 
 This is useful if you have a difference between missing images and
 images currently being processed.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar
 
@@ -152,17 +97,17 @@ end
 @user = User.new(avatar: File.new(...))
 @user.save
 @user.avatar.url #=> "/images/original/processing.png"
-Delayed::Worker.new.work_off
+
+# Process job
 
 @user.reload
 @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
-````
+```
 
 You can also define a custom logic for `processing_image_url`, for
-example to display the original\
-picture while specific formats are being processed.
+example to display the original picture while specific formats are being processed.
 
-````ruby
+```ruby
 class Item < ActiveRecord::Base
   has_attached_file :photo
 
@@ -173,7 +118,7 @@ class Item < ActiveRecord::Base
     options[:interpolator].interpolate(options[:url], photo, :original)
   end
 end
-````
+```
 
 #### Have processing? status available, but construct image URLs as if delayed_paperclip wasn’t present
 
@@ -183,7 +128,7 @@ If you define the `#{attachment_name}_processing` column, but set the
 Note especially the method #processing? which passes through the value
 of the boolean created via migration.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar
 
@@ -194,36 +139,37 @@ end
 @user.save
 @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
 @user.avatar.processing? #=> true
-Delayed::Worker.new.work_off
+
+# Process job
 
 @user.reload
 @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
 @user.avatar.processing? #=> false
-````
+```
 
 #### Only process certain styles
 
 This is useful if you don’t want the background job to reprocess all
 styles.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: { small: "25x25#", medium: "50x50#" }
 
   process_in_background :avatar, only_process: [:small]
 end
-````
+```
 
 Like paperclip, you could also supply a lambda function to define
 `only_process` dynamically.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: { small: "25x25#", medium: "50x50#" }
 
   process_in_background :avatar, only_process: lambda { |a| a.instance.small_supported? ? [:small, :large] : [:large] }
 end
-````
+```
 
 #### Split processing
 
@@ -231,21 +177,21 @@ You can process some styles in the foreground and some in the background
 by setting `only_process` on both `has_attached_file` and
 `process_in_background`.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: { small: "25x25#", medium: "50x50#" }, only_process: [:small]
 
   process_in_background :avatar, only_process: [:medium]
 end
-````
+```
 
 #### Reprocess Without Delay
 
 This is useful if you don’t want the background job. It accepts
-individual styles to. Take note, normal `reprocess!` does not accept styles as arguments anymore. It will delegate to DelayedPaperclip and
+individual styles too. Take note, normal `reprocess!` does not accept styles as arguments anymore. It will delegate to DelayedPaperclip and
 reprocess all styles.
 
-````ruby
+```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: { small: "25x25#", medium: "50x50#" }
 
@@ -254,7 +200,7 @@ end
 
 @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
 @user.avatar.reprocess_without_delay!(:medium)
-````
+```
 
 #### Set queue name
 
@@ -278,7 +224,7 @@ defined by changing the DelayedPaperclip.options Hash, this can be useful for se
 If you’re using Rails you can define a Hash with default options in
 config/application.rb or in any of the config/environments/\*.rb files on `config.delayed_paperclip_defaults`, these will get merged into DelayedPaperclip.options as your Rails app boots. An example:
 
-````ruby
+```ruby
 module YourApp
   class Application < Rails::Application
     # Other code...
@@ -289,7 +235,7 @@ module YourApp
     }
   end
 end
-````
+```
 
 What if I’m not using images?
 -----------------------------
@@ -301,7 +247,7 @@ Paperclip Post-processors are not working
 -----------------------------------------
 
 If you are using custom [post-processing processors](https://github.com/thoughtbot/paperclip#post-processing)
-like this: 
+like this:
 
 ```ruby
 # ...
@@ -311,14 +257,14 @@ process_in_background :avatar
 
 def rotate!
   # ...
-  avatar.reprocess! 
+  avatar.reprocess!
   # ...
 end
 
 # ...
 ```
 
-...you may encounter an issue where your post-processors are ignored 
+...you may encounter an issue where your post-processors are ignored
 ([more info](https://github.com/jrgifford/delayed_paperclip/issues/171)).
 In order to avoid this use `reprocess_without_delay!`
 
@@ -327,7 +273,7 @@ In order to avoid this use `reprocess_without_delay!`
 
 def rotate!
   # ...
-  avatar.reprocess_without_delay! 
+  avatar.reprocess_without_delay!
   # ...
 end
 
@@ -344,7 +290,7 @@ Contributing
 
 Checkout out [CONTRIBUTING](https://github.com/jrgifford/delayed_paperclip/blob/master/CONTRIBUTING). Run specs with:
 
-````
+```
 # Rspec on all versions
 bundle exec appraisal install
 bundle exec appraisal rake
@@ -354,4 +300,4 @@ bundle exec rake
 
 # Rspec on specific rails version
 bundle exec appraisal 5.0 rake
-````
+```

data/delayed_paperclip.gemspec

@@ -6,25 +6,24 @@ Gem::Specification.new do |s|
   s.version     = DelayedPaperclip::VERSION
 
   s.authors     = ["Jesse Storimer", "Bert Goethals", "James Gifford", "Scott Carleton"]
-  s.summary     = %q{Process your Paperclip attachments in the background.}
-  s.description = %q{Process your Paperclip attachments in the background with DelayedJob, Resque, Sidekiq or your own processor.}
+  s.summary     = %q{Process your Paperclip attachments in the background}
+  s.description = %q{Process your Paperclip attachments in the background with ActiveJob}
   s.email       = %w{james@jamesrgifford.com scott@artsicle.com}
-  s.homepage    = %q{http://github.com/jrgifford/delayed_paperclip}
+  s.homepage    = %q{https://github.com/jrgifford/delayed_paperclip}
+
+  s.required_ruby_version = ">= 2.0.0"
 
   s.add_dependency 'paperclip', [">= 3.3"]
+  s.add_dependency 'activejob', ">= 4.2"
 
   s.add_development_dependency 'mocha'
   s.add_development_dependency "rspec", '< 3.0'
   s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'delayed_job'
-  s.add_development_dependency 'delayed_job_active_record'
-  s.add_development_dependency 'resque'
-  s.add_development_dependency 'sidekiq', '>= 4.0'
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake', '~> 10.5.0'
   s.add_development_dependency 'bundler'
+  s.add_development_dependency 'activerecord'
   s.add_development_dependency 'railties'
-  s.add_development_dependency 'fakeredis'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/gemfiles/5.0.gemfile

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 5.0.0.beta3"
+gem "rails", "~> 5.0.0"
 
 gemspec :path => "../"

data/lib/delayed_paperclip.rb

@@ -1,28 +1,19 @@
-require 'delayed_paperclip/jobs'
+require 'delayed_paperclip/process_job'
 require 'delayed_paperclip/attachment'
 require 'delayed_paperclip/url_generator'
-require 'delayed_paperclip/railtie'
+require 'delayed_paperclip/railtie' if defined?(Rails)
 
 module DelayedPaperclip
-
   class << self
-
     def options
       @options ||= {
-        :background_job_class => detect_background_task,
+        :background_job_class => DelayedPaperclip::ProcessJob,
         :url_with_processing  => true,
         :processing_image_url => nil,
         :queue => "paperclip"
       }
     end
 
-    def detect_background_task
-      return DelayedPaperclip::Jobs::ActiveJob  if defined? ::ActiveJob::Base
-      return DelayedPaperclip::Jobs::DelayedJob if defined? ::Delayed::Job
-      return DelayedPaperclip::Jobs::Resque     if defined? ::Resque
-      return DelayedPaperclip::Jobs::Sidekiq    if defined? ::Sidekiq
-    end
-
     def processor
       options[:background_job_class]
     end
@@ -120,6 +111,5 @@ module DelayedPaperclip
       @_enqued_for_processing ||= []
       @_enqued_for_processing << name
     end
-
   end
 end