delayed_paperclip 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3da45f87f8ee8a55f4b3c7c6ba763f6a2680f651
-  data.tar.gz: 56d4c5b2724facc8e70682b93a3c2196911e673f
+  metadata.gz: 9010ad7ec352347ca5ced4c58ad626abdd107884
+  data.tar.gz: d1cf800afb079df8745c01b64195dc49cbf8d723
 SHA512:
-  metadata.gz: 9408a28957b8007e2503a93927ad61995bf39c61a40d3e384f774e19494b035633d716f2849c3dd9eab281da2d05565cf300ad877005be16623c53c24b82ee7e
-  data.tar.gz: 5c4ba36bca41329090a6e0ffbc92888c36243768d7a30ced5e5062534e478502bf1cccb40859e7b649e8ad3987c7ed8df1551c9fd5d26a444f5f86016c35122b
+  metadata.gz: c766c2943099e7002d32750efff2d7e89563b01cb0d79d564323bc33768ff8e2a052c70b22e777a926d346a3943495a4421cc6ce6f5679eb9e4ab5d526ded1ee
+  data.tar.gz: c05abd61fc10c51a0fe5299dfa9b1d0bf5b7b697cbf24e6284923bd18e5a328c9274d71aaeef7548f72e2c0391b44deff848940dcd2ecc7685ccf9a29011b470

data/.gitignore

@@ -5,3 +5,5 @@ public/
 Gemfile.lock
 *.gem
 ./gemfiles/rails*.lock
+.ruby-gemset
+.ruby-version

data/README.textile

@@ -102,6 +102,35 @@ being processed.
 
 </code></pre>
 
+h4. Have processing? status available, but construct image URLs as if delayed_paperclip wasn't present
+
+If you define the #{attachment_name}_processing column, but set the url_with_processing option to false,
+this opens up other options (other than modifying the url that paperclip returns) for giving feedback to
+the user while the image is processing.  This is useful for advanced situations, for example when dealing
+with caching systems.
+
+Note especially the method .processing? which passes through the value of the boolean created via migration.
+
+<pre><code>
+
+  class User < ActiveRecord::Base
+    has_attached_file :avatar
+
+    process_in_background :avatar, :url_with_processing => false
+  end
+
+  @user = User.new(:avatar => File.new(...))
+  @user.save
+  @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
+  @user.avatar.processing? #=> true
+  Delayed::Worker.new.work_off
+
+  @user.reload
+  @user.avatar.url #=> "/system/images/3/original/IMG_2772.JPG?1267562148"
+  @user.avatar.processing? #=> false
+
+</code></pre>
+
 h4. Only process certain styles
 
 This is useful if you don't want the background job to reprocess all styles.
@@ -114,6 +143,16 @@ This is useful if you don't want the background job to reprocess all styles.
   end
 </code></pre>
 
+Like paperclip, you could also supply a lambda function to define only_process dynamically.
+
+<pre><code>
+  class User < ActiveRecord::Base
+    has_attached_file :avatar, :styles => { :small => "25x25#", :medium => "50x50x" }
+
+    process_in_background :avatar, :only_process => lambda { |a| a.instance.small_supported? ? [:small, :large] : [:large] }
+  end
+</code></pre>
+
 h4. Split processing
 
 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.
@@ -142,6 +181,28 @@ styles as arguments anymore.  It will delegate to DelayedPaperclip and reprocess
   @user.avatar.reprocess_without_delay!(:medium)
 </code></pre>
 
+h2. Defaults
+
+Global defaults for all delayed_paperclip instances in your app can be defined by changing the
+DelayedPaperclip.options Hash, this can be useful for setting a default 'processing image,' so you
+won't have to define it in every process_in_background definition.
+
+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:
+
+<pre><code>
+  module YourApp
+    class Application < Rails::Application
+      # Other code...
+
+      config.delayed_paperclip_defaults = {
+          :url_with_processing => true,
+          :processing_image_url => 'custom_processing.png'
+      }
+    end
+  end
+</code></pre>
 
 h2. What if I'm not using images?
 
@@ -153,4 +214,6 @@ Yes.
 
 h2. Contributing
 
-Checkout out CONTRIBUTING for more info.
+Checkout out CONTRIBUTING.  In short, you'll need a redis server running for testing.  Run all tests with
+
+<pre><code>rake</code></pre>

data/delayed_paperclip.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'delayed_job'
   s.add_development_dependency 'delayed_job_active_record'
   s.add_development_dependency 'resque'
-  s.add_development_dependency 'sidekiq', '< 3.0'
+  s.add_development_dependency 'sidekiq'
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler'

data/gemfiles/rails3_1.gemfile.lock

@@ -159,5 +159,5 @@ DEPENDENCIES
   rake
   resque
   rspec
-  sidekiq (< 3.0)
+  sidekiq
   sqlite3

data/gemfiles/rails3_2.gemfile.lock

@@ -157,5 +157,5 @@ DEPENDENCIES
   rake
   resque
   rspec
-  sidekiq (< 3.0)
+  sidekiq
   sqlite3

data/gemfiles/rails4.gemfile.lock

@@ -153,5 +153,5 @@ DEPENDENCIES
   rake
   resque
   rspec
-  sidekiq (< 3.0)
+  sidekiq
   sqlite3

data/lib/delayed_paperclip.rb

@@ -57,7 +57,7 @@ module DelayedPaperclip
         :priority => 0,
         :only_process => only_process_default,
         :url_with_processing => DelayedPaperclip.options[:url_with_processing],
-        :processing_image_url => options[:processing_image_url],
+        :processing_image_url => DelayedPaperclip.options[:processing_image_url],
         :queue => nil
       }.each do |option, default|
 

data/lib/delayed_paperclip/attachment.rb

@@ -51,10 +51,16 @@ module DelayedPaperclip
         !split_processing? || delayed_options[:only_process].include?(style)
       end
 
+      def delayed_only_process
+        only_process = delayed_options[:only_process].dup
+        only_process = only_process.call(self) if only_process.respond_to?(:call)
+        only_process.map(&:to_sym)
+      end
+
       def process_delayed!
         self.job_is_processing = true
         self.post_processing = true
-        reprocess!(*delayed_options[:only_process])
+        reprocess!(*delayed_only_process)
         self.job_is_processing = false
         update_processing_column
       end

data/lib/delayed_paperclip/railtie.rb

@@ -7,10 +7,14 @@ module DelayedPaperclip
 
     # On initialzation, include DelayedPaperclip
     class Railtie < Rails::Railtie
-      initializer 'delayed_paperclip.insert_into_active_record' do
+      initializer 'delayed_paperclip.insert_into_active_record' do |app|
         ActiveSupport.on_load :active_record do
           DelayedPaperclip::Railtie.insert
         end
+
+        if app.config.respond_to?(:delayed_paperclip_defaults)
+          DelayedPaperclip.options.merge!(app.config.delayed_paperclip_defaults)
+        end
       end
     end
   end

data/lib/delayed_paperclip/version.rb

@@ -1,3 +1,3 @@
 module DelayedPaperclip
-  VERSION = "2.7.1"
+  VERSION = "2.8.0"
 end

data/spec/delayed_paperclip/attachment_spec.rb

@@ -107,6 +107,34 @@ describe DelayedPaperclip::Attachment do
     end
   end
 
+  describe "delayed_only_process" do
+    context "without only_process options" do
+      it "returns []" do
+        expect(dummy.image.delayed_only_process).to eq []
+      end
+    end
+
+    context "with only_process options" do
+      before :each do
+        reset_dummy(paperclip: { only_process: [:small, :large] } )
+      end
+
+      it "returns [:small, :large]" do
+        expect(dummy.image.delayed_only_process).to eq [:small, :large]
+      end
+    end
+
+    context "with only_process set with callable" do
+      before :each do
+        reset_dummy(paperclip: { only_process: lambda { |a| [:small, :large] } } )
+      end
+
+      it "returns [:small, :large]" do
+        expect(dummy.image.delayed_only_process).to eq [:small, :large]
+      end
+    end
+  end
+
   describe "process_delayed!" do
     it "sets job_is_processing to true" do
       dummy.image.expects(:job_is_processing=).with(true).once
@@ -136,6 +164,17 @@ describe DelayedPaperclip::Attachment do
         dummy.image.process_delayed!
       end
     end
+
+    context "with only_process set with callable" do
+      before :each do
+        reset_dummy(paperclip: { only_process: lambda { |a| [:small, :large] } } )
+      end
+
+      it "calls reprocess! with options" do
+        dummy.image.expects(:reprocess!).with(:small, :large)
+        dummy.image.process_delayed!
+      end
+    end
   end
 
   describe "#processing_image_url" do

data/spec/integration/sidekiq_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'sidekiq'
+require 'sidekiq/api'
 
 describe "Sidekiq" do
 
@@ -45,4 +45,4 @@ describe "Sidekiq" do
     Sidekiq::Queue.new(:paperclip).size
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_paperclip
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -11,174 +11,174 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Process your Paperclip attachments in the background with DelayedJob,
@@ -190,11 +190,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rbenv-version
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rbenv-version"
+- ".travis.yml"
 - Appraisals
 - CONTRIBUTING
 - ChangeLog
@@ -249,12 +247,12 @@ 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: []

data/.ruby-gemset

@@ -1 +0,0 @@
-delayed_paperclip

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0-p195