kt-delayed_paperclip 3.1.0

data/spec/integration/base_delayed_paperclip_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Base Delayed Paperclip Integration" do
+  let(:dummy) { Dummy.create }
+
+  before :each do
+    reset_dummy(paperclip: { default_url: "/../../fixtures/missing.png" })
+  end
+
+  describe "double save" do
+    before :each do
+      dummy.image_processing.should be_falsey
+      dummy.image = File.open("#{ROOT}/fixtures/12k.png")
+      dummy.save!
+    end
+
+    it "processing column remains true" do
+      dummy.image_processing.should be_truthy
+      dummy.save!
+      dummy.image_processing.should be_truthy
+    end
+  end
+end

data/spec/integration/examples/base.rb

@@ -0,0 +1,326 @@
+shared_examples "base usage" do
+  before :each do
+    DelayedPaperclip.options[:url_with_processing] = true
+    reset_dummy
+  end
+
+  describe "normal paperclip" do
+    before :each do
+      DelayedPaperclip.options[:url_with_processing] = false
+      reset_dummy :with_processed => false
+    end
+
+    it "allows normal paperclip functionality" do
+      Paperclip::Attachment.any_instance.expects(:post_process)
+      dummy.image.delay_processing?.should be_falsey
+      dummy.image.post_processing.should be_truthy
+      dummy.save.should be_truthy
+      File.exists?(dummy.image.path).should be_truthy
+    end
+
+    context "missing url" do
+      it "does not return missing url if false globally" do
+        dummy.save!
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+        process_jobs
+        dummy.reload
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+
+      it "does not return missing url if false on instance" do
+        reset_dummy :with_processed => false, :url_with_processing => false
+        dummy.save!
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+        process_jobs  # There aren't any
+        dummy.reload
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+    end
+
+    # TODO: somewhat duplicate test of the above
+    context "original url without processing column" do
+      it "works normally" do
+        dummy.save!
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+    end
+  end
+
+  describe "set post processing" do
+    before :each do
+      reset_dummy :with_processed => true
+      dummy.image.post_processing = true
+    end
+    it "has delay_processing is false" do
+      dummy.image.delay_processing?.should be_falsey
+    end
+
+    it "post processing returns true" do
+      dummy.image.post_processing.should be_truthy
+    end
+
+    it "writes the file" do
+      dummy.save
+      File.exists?(dummy.image.path).should be_truthy
+    end
+  end
+
+  describe "without processing column" do
+    before :each do
+      build_dummy_table(false)
+      reset_class "Dummy", :with_processed => true
+      Paperclip::Attachment.any_instance.expects(:post_process).never
+    end
+
+    it "delays processing" do
+      dummy.image.delay_processing?.should be_truthy
+    end
+
+    it "post_processing is false" do
+      dummy.image.post_processing.should be_falsey
+    end
+
+    it "has file after save" do
+      dummy.save
+      File.exists?(dummy.image.path).should be_truthy
+    end
+
+  end
+
+  describe "jobs count" do
+    it "increments by 1" do
+      original_job_count = jobs_count
+      dummy.save
+      jobs_count.should == original_job_count + 1
+    end
+  end
+
+  describe "processing column not altered" do
+    it "resets after job finished" do
+      dummy.save!
+      dummy.image_processing?.should be_truthy
+      process_jobs
+      dummy.reload.image_processing?.should be_falsey
+    end
+
+    context "with error" do
+      it "stays true even if errored" do
+        Paperclip::Attachment.any_instance.stubs(:reprocess!).raises(StandardError.new('oops'))
+
+        dummy.save!
+        dummy.image_processing?.should be_truthy
+
+        expect do
+          process_jobs
+        end.to raise_error(StandardError)
+
+        dummy.image_processing?.should be_truthy
+        dummy.reload.image_processing?.should be_truthy
+      end
+    end
+  end
+
+  # TODO: test appears redundant
+  describe "processing is true for new record" do
+    it "is true" do
+      dummy.image_processing?.should be_falsey
+      dummy.new_record?.should be_truthy
+      dummy.save!
+      dummy.reload.image_processing?.should be_truthy
+    end
+  end
+
+  describe "urls" do
+    it "returns missing url until job is finished" do
+      dummy.save!
+      dummy.image.url.should start_with("/images/original/missing.png")
+      process_jobs
+      dummy.reload
+      dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+    end
+
+    context "processing url" do
+      before :each do
+        reset_dummy :processing_image_url => "/images/original/processing.png"
+      end
+
+      it "returns processing url while processing" do
+        dummy.save!
+        dummy.image.url.should start_with("/images/original/processing.png")
+        process_jobs
+        dummy.reload
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+
+      context "defaults to missing when no file" do
+        it "fallsback gracefully" do
+          dummy = Dummy.new()
+          dummy.save!
+          dummy.reload.image.url.should start_with("/images/original/missing.png")
+        end
+      end
+    end
+
+    context "same url if same file assigned" do
+      it "falls to missing while processing" do
+        dummy.save!
+        dummy.image = File.open("#{ROOT}/fixtures/12k.png")
+        dummy.save!
+        dummy.image.url.should start_with("/images/original/missing.png")
+        process_jobs
+        dummy.reload.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+    end
+
+  end
+
+  describe "callbacks" do
+    context "paperclip callback" do
+      before :each do
+        Dummy.send(:define_method, :done_processing) { puts 'done' }
+        Dummy.send(:after_image_post_process, :done_processing)
+        Dummy.any_instance.expects(:done_processing).once
+      end
+
+      it "observes after_image_post_process" do
+        dummy.save!
+        process_jobs
+      end
+    end
+
+    context "after_update callback" do
+      before :each do
+        reset_class "Dummy", :with_processed => true,
+                             :with_after_update_callback => true
+      end
+
+      it "hits after_update" do
+        Dummy.any_instance.expects(:reprocess).once
+        dummy.save!
+        process_jobs
+      end
+    end
+  end
+
+  describe "only_process option" do
+
+    # TODO: This test must be faulty
+    # https://github.com/jrgifford/delayed_paperclip/issues/40
+    context "passed just to delayed_paperclip argument" do
+      before :each do
+        reset_class "Dummy", :with_processed => true, :only_process => [:thumbnail]
+      end
+
+      it "reprocesses just those" do
+        Paperclip::Attachment.any_instance.expects(:reprocess!).with(:thumbnail).once
+        dummy.save!
+        process_jobs
+      end
+    end
+
+    context "inherits from paperclip options" do
+      before :each do
+        reset_class "Dummy", :with_processed => true, :paperclip => { :only_process => [:thumbnail] }
+      end
+
+      it "reprocesses just those" do
+        Paperclip::Attachment.any_instance.expects(:reprocess!).with(:thumbnail).once
+        dummy.save!
+        process_jobs
+      end
+    end
+  end
+
+  describe "converts image formats" do
+    before :each do
+      reset_class "Dummy",  :with_processed => true,
+                            :paperclip => {
+                              :styles => {
+                                :thumbnail => ['12x12', :jpg]
+                              }
+                            }
+    end
+
+    it "observes the option" do
+      dummy.save!
+      process_jobs
+      dummy.reload.image.url(:thumbnail).should start_with("/system/dummies/images/000/000/001/thumbnail/12k.jpg")
+      File.exists?(dummy.image.path).should be_truthy
+    end
+  end
+
+  describe "reprocess_without_delay" do
+    before :each do
+      DelayedPaperclip.options[:url_with_processing] = true
+      reset_dummy :paperclip => {
+                    :styles => {
+                      :thumbnail => '12x12'
+                    }
+                  }
+    end
+
+    it "does not increase jobs count" do
+      dummy.save!
+      dummy.image_processing?.should be_truthy
+      process_jobs
+      dummy.reload.image_processing?.should be_falsey
+
+      Paperclip::Attachment.any_instance.expects(:reprocess!).once
+
+      existing_jobs = jobs_count
+      dummy.image.reprocess_without_delay!(:thumbnail)
+      existing_jobs.should == jobs_count
+
+      dummy.image_processing?.should be_falsey
+      File.exists?(dummy.image.path).should be_truthy
+    end
+
+  end
+
+  describe "reprocessing_url" do
+
+    context "interpolation of styles" do
+      before :each do
+        reset_dummy :processing_image_url => "/images/:style/processing.png",
+                    :paperclip => {
+                      :styles => {
+                        :thumbnail => '12x12'
+                      }
+                    }
+      end
+
+      it "interpolates unporcessed image" do
+        dummy.save!
+        dummy.image.url.should start_with("/images/original/processing.png")
+        dummy.image.url(:thumbnail).should start_with("/images/thumbnail/processing.png")
+        process_jobs
+        dummy.reload.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+    end
+
+    context "proc for reprocessing_url" do
+      before :each do
+        reset_dummy :processing_image_url => lambda { |attachment| attachment.instance.reprocessing_url }
+        Dummy.send(:define_method, :reprocessing_url) { 'done' }
+      end
+
+      it "calls it correctly" do
+        dummy.save!
+        dummy.image.url.should start_with("done")
+        process_jobs
+        dummy.reload
+        dummy.image.url.should start_with("/system/dummies/images/000/000/001/original/12k.png")
+      end
+    end
+  end
+
+  describe "queue option" do
+    it "enqueues job with given queue name" do
+      reset_dummy :queue => "custom"
+
+      expect do
+        dummy.save!
+      end.to change { jobs_count("custom") }.by(1)
+    end
+  end
+end

data/spec/integration/process_job_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+RSpec.describe "DelayedJob::ProcessJob" do
+  before :each do
+    ActiveJob::Base.queue_adapter = :test
+    ActiveJob::Base.logger = nil
+  end
+
+  let(:dummy) { Dummy.new(:image => File.open("#{ROOT}/fixtures/12k.png")) }
+
+  describe "integration tests" do
+    include_examples "base usage"
+  end
+
+  def process_jobs
+    ActiveJob::Base.queue_adapter.enqueued_jobs.each do |job|
+      job[:job].send(:perform_now, *job[:args])
+    end
+  end
+
+  def jobs_count(queue = "paperclip")
+    ActiveJob::Base.queue_adapter.enqueued_jobs.count do |job|
+      job[:queue] == queue
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,122 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rails'
+require 'active_record'
+require 'rspec'
+require 'mocha/api'
+
+begin
+  require 'pry'
+rescue LoadError
+  # Pry is not available, just ignore.
+end
+
+require 'paperclip/railtie'
+Paperclip::Railtie.insert
+
+require 'delayed_paperclip/railtie'
+DelayedPaperclip::Railtie.insert
+
+# silence deprecation warnings in rails 4.2
+# in Rails 5 this setting is deprecated and has no effect
+if ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks=) && Rails::VERSION::MAJOR < 5
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+
+# Connect to sqlite
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3",
+  "database" => ":memory:"
+)
+
+# Path for filesystem writing
+ROOT = Pathname.new(File.expand_path("../.", __FILE__))
+
+logger = Logger.new(ROOT.join("tmp/debug.log"))
+ActiveRecord::Base.logger = logger
+ActiveJob::Base.logger = logger
+Paperclip.logger = logger
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.order = :random
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    reset_global_default_options
+  end
+end
+
+def reset_global_default_options
+  DelayedPaperclip.options.merge!({
+    :background_job_class => DelayedPaperclip::ProcessJob,
+    :url_with_processing  => true,
+    :processing_image_url => nil
+  })
+end
+
+# In order to not duplicate code directly from Paperclip's spec support
+# We're requiring the MockInterpolator object to be used
+require Gem.find_files("../spec/support/mock_interpolator").first
+
+Dir["./spec/integration/examples/*.rb"].sort.each { |f| require f }
+
+# Reset table and class with image_processing column or not
+def reset_dummy(options = {})
+  options[:with_processed] = true unless options.key?(:with_processed)
+  options[:processed_column] = options[:with_processed] unless options.has_key?(:processed_column)
+
+  build_dummy_table(options.delete(:processed_column))
+  reset_class("Dummy", options)
+end
+
+# Dummy Table for images
+# with or without image_processing column
+def build_dummy_table(with_column)
+  ActiveRecord::Base.connection.create_table :dummies, :force => true do |t|
+    t.string   :name
+    t.string   :image_file_name
+    t.string   :image_content_type
+    t.integer  :image_file_size
+    t.datetime :image_updated_at
+    t.boolean :hidden, :default => false
+    t.boolean(:image_processing, :default => false) if with_column
+  end
+end
+
+def reset_class(class_name, options)
+  # setup class and include paperclip
+  options[:paperclip] = {} if options[:paperclip].nil?
+  ActiveRecord::Base.send(:include, Paperclip::Glue)
+  Object.send(:remove_const, class_name) rescue nil
+
+  # Set class as a constant
+  klass = Object.const_set(class_name, Class.new(ActiveRecord::Base))
+
+  # Setup class with paperclip and delayed paperclip
+  klass.class_eval do
+    include Paperclip::Glue
+
+    has_attached_file :image, options.delete(:paperclip)
+
+    validates_attachment :image, :content_type => { :content_type => "image/png" }
+
+    process_in_background :image, options if options[:with_processed]
+
+    after_update :reprocess if options[:with_after_update_callback]
+
+    default_scope options[:default_scope] if options[:default_scope]
+
+    def reprocess
+      image.reprocess!
+    end
+  end
+
+  Rails.stubs(:root).returns(ROOT.join("tmp"))
+  klass.reset_column_information
+  klass
+end