bulldog 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,6 +1,11 @@
-== 0.0.2 2009-11-16
+== 0.0.3 2009-11-16
+
+ * Add a way to respond to processing errors:
+   - #process returns true/false.
+   - #process! raises a AR::InvalidRecord if any errors.
+   - ...just like ActiveRecord::Base::save.
 
-Fixes:
+== 0.0.2 2009-11-16
 
  * #process_once was stopping other processors from running.
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bulldog.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bulldog}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["George Ogata"]

data/lib/bulldog/attachment/base.rb

@@ -21,7 +21,9 @@ module Bulldog
       #
       # Run the processors for the named event.
       #
-      def process(event_name, *args)
+      # Return true if no errors were encountered, false otherwise.
+      #
+      def process(event_name)
         reflection.events[event_name].each do |event|
           if (types = event.attachment_types)
             next unless types.include?(type)
@@ -29,8 +31,18 @@ module Bulldog
           processor_type = event.processor_type || default_processor_type
           processor_class = Processor.const_get(processor_type.to_s.camelize)
           processor = processor_class.new(self, styles_for_event(event), stream.path)
-          processor.process(*args, &event.callback)
+          processor.process(&event.callback)
         end
+        record.errors.empty?
+      end
+
+      #
+      # Like #process, but raise ActiveRecord::RecordInvalid if there
+      # are any errors.
+      #
+      def process!(event_name, &block)
+        process(event_name, &block) or
+          raise ActiveRecord::RecordInvalid, record
       end
 
       #

data/lib/bulldog/attachment/none.rb

@@ -30,7 +30,10 @@ module Bulldog
       def destroy
       end
 
-      def process(event, *args)
+      def process(event, options={})
+      end
+
+      def process!(event, options={})
       end
     end
   end

data/lib/bulldog/processor/base.rb

@@ -61,12 +61,12 @@ module Bulldog
       # #style will be set to the current style each time the block is
       # called.
       #
-      def process(*args, &block)
+      def process(&block)
         return if styles.empty?
         styles.each do |style|
           @style = style
           begin
-            process_style(*args, &block)
+            process_style(&block)
           ensure
             @style = nil
           end

data/lib/bulldog/processor/ffmpeg.rb

@@ -14,7 +14,7 @@ module Bulldog
         @still_frame_callbacks = style_list_map
       end
 
-      def process(*args)
+      def process
         return if styles.empty?
         super
         run_ffmpeg
@@ -158,7 +158,8 @@ module Bulldog
           command = [self.class.ffmpeg_command]
           command << '-i' << input_file
           command.concat(arguments)
-          Bulldog.run(*command)
+          Bulldog.run(*command) or
+            record.errors.add name, "convert failed (status #$?)"
         end
       end
 

data/lib/bulldog/processor/image_magick.rb

@@ -16,7 +16,7 @@ module Bulldog
         @tree = ArgumentTree.new(styles)
       end
 
-      def process(*args, &block)
+      def process
         return if styles.empty?
         super
         run_convert
@@ -105,7 +105,7 @@ module Bulldog
       def run_convert
         add_final_style_arguments
         output = run_convert_command and
-        run_convert_callbacks(output)
+          run_convert_callbacks(output)
       end
 
       def add_final_style_arguments
@@ -120,7 +120,9 @@ module Bulldog
 
       def run_convert_command
         command = [self.class.convert_command, "#{input_file}[0]", *@tree.arguments].flatten
-        Bulldog.run(*command)
+        output = Bulldog.run(*command) or
+          record.errors.add name, "convert failed (status #$?)"
+        output
       end
 
       def run_convert_callbacks(output)

data/lib/bulldog/processor/one_shot.rb

@@ -6,9 +6,9 @@ module Bulldog
         @styles = StyleSet.new
       end
 
-      def process(*args, &block)
+      def process(&block)
         @style = nil
-        process_style(*args, &block)
+        process_style(&block)
       end
 
       def output_file(style_name)

data/spec/unit/attachment/base_spec.rb

@@ -219,6 +219,17 @@ describe Attachment::Base do
     end
   end
 
+  def with_test_processor(options, &block)
+    test_processor_class = Class.new(Processor::Base) do
+      define_method :process do
+        if options[:error]
+          record.errors.add name, "error"
+        end
+      end
+    end
+    with_temporary_constant_value(Processor, :Test, test_processor_class, &block)
+  end
+
   describe "#process" do
     use_model_class(:Thing)
 
@@ -280,6 +291,54 @@ describe Attachment::Base do
       styles.should be_a(StyleSet)
       styles.map(&:name).should == [:small]
     end
+
+    it "should return true if no errors were encountered" do
+      with_test_processor(:error => false) do
+        Thing.has_attachment :attachment do
+          style :one
+          process(:on => :event, :with => :test){}
+        end
+        thing = Thing.new(:attachment => test_empty_file)
+        thing.attachment.process(:event).should be_true
+      end
+    end
+
+    it "should return false if an error was encountered" do
+      with_test_processor(:error => true) do
+        Thing.has_attachment :attachment do
+          style :one
+          process(:on => :event, :with => :test){}
+        end
+        thing = Thing.new(:attachment => test_empty_file)
+        thing.attachment.process(:event).should be_false
+      end
+    end
+  end
+
+  describe "#process!" do
+    use_model_class(:Thing)
+
+    it "should raise ActiveRecord::RecordInvalid if there are any errors present" do
+      with_test_processor(:error => true) do
+        Thing.has_attachment :attachment do
+          style :one
+          process :on => :event, :with => :test
+        end
+        thing = Thing.new(:attachment => test_empty_file)
+        lambda{thing.attachment.process!(:event)}.should raise_error(ActiveRecord::RecordInvalid)
+      end
+    end
+
+    it "should not raise ActiveRecord::RecordInvalid if there are no errors present" do
+      with_test_processor(:error => false) do
+        Thing.has_attachment :attachment do
+          style :one
+          process :on => :event, :with => :test
+        end
+        thing = Thing.new(:attachment => test_empty_file)
+        lambda{thing.attachment.process!(:event)}.should_not raise_error(ActiveRecord::RecordInvalid)
+      end
+    end
   end
 
   describe "storable attributes" do

data/spec/unit/has_attachment_spec.rb

@@ -66,14 +66,14 @@ describe HasAttachment do
 
     describe "when there is an attachment set" do
       it "should trigger the configured callbacks" do
-        args = nil
+        calls = []
         Thing.has_attachment :photo do
           style :normal
-          process(:on => :my_event){|*args|}
+          process(:on => :my_event){calls << 1}
         end
         thing = Thing.new(:photo => uploaded_file)
-        thing.process_attachment(:photo, :my_event, 1, 2)
-        args.should == [1, 2]
+        thing.process_attachment(:photo, :my_event)
+        calls.should == [1]
       end
     end
 
@@ -85,20 +85,19 @@ describe HasAttachment do
           process(:on => :my_event){|*args|}
         end
         thing = Thing.new(:photo => nil)
-        thing.process_attachment(:photo, :my_event, 1, 2)
+        thing.process_attachment(:photo, :my_event)
         args.should be_nil
       end
     end
 
     it "should raise an ArgumentError if the attachment name is invalid" do
-      args = nil
       Thing.has_attachment :photo do
         style :normal
-        process(:on => :my_event){|*args|}
+        process(:on => :my_event){}
       end
       thing = Thing.new
       lambda do
-        thing.process_attachment(:fail, :my_event, 1, 2)
+        thing.process_attachment(:fail, :my_event)
       end.should raise_error(ArgumentError)
     end
 

data/spec/unit/processor/ffmpeg_spec.rb

@@ -54,7 +54,7 @@ describe Processor::Ffmpeg do
     @thing.video.process(:event)
   end
 
-  describe "when a simple conversion is performed" do
+  describe "#process" do
     before do
       video_style :output
     end
@@ -72,6 +72,20 @@ describe Processor::Ffmpeg do
       end
       File.read(log_path).should include("[Bulldog] Running: #{ffmpeg}")
     end
+
+    it "should add an error to the record if convert fails" do
+      video_style :output
+      Bulldog.stubs(:run).returns(nil)
+      process_video
+      @thing.errors.should be_present
+    end
+
+    it "should not add an error to the record if convert succeeds" do
+      video_style :output
+      Bulldog.stubs(:run).returns('')
+      process_video
+      @thing.errors.should_not be_present
+    end
   end
 
   describe "#encode" do

data/spec/unit/processor/image_magick_spec.rb

@@ -78,6 +78,20 @@ describe Processor::ImageMagick do
       process
     end
 
+    it "should add an error to the record if convert fails" do
+      style :output
+      Bulldog.stubs(:run).returns(nil)
+      process
+      @thing.errors.should be_present
+    end
+
+    it "should not add an error to the record if convert succeeds" do
+      style :output
+      Bulldog.stubs(:run).returns('')
+      process
+      @thing.errors.should_not be_present
+    end
+
     it "should use the given :quality style attribute" do
       style :output, :quality => 50
       Bulldog.expects(:run).once.with(convert, "#{original_path}[0]", '-quality', '50', output_path).returns('')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bulldog
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - George Ogata