bulldog 0.1.1 → 0.2.0

data/lib/bulldog/version.rb

@@ -1,5 +1,5 @@
 module Bulldog
-  VERSION = [0, 1, 1]
+  VERSION = [0, 2, 0]
 
   class << VERSION
     include Comparable

data/spec/data/3-bytes.txt

@@ -0,0 +1 @@
+...

data/spec/data/4-bytes.txt

@@ -0,0 +1 @@
+....

data/spec/data/5-bytes.txt

@@ -0,0 +1 @@
+.....

data/spec/data/6-bytes.txt

@@ -0,0 +1 @@
+......

data/spec/helpers/files.rb

@@ -0,0 +1,123 @@
+#
+# Temporary file and directory support.
+#
+module Files
+  def self.included(base)
+    base.before(:all) { init_temporary_directory }
+    base.after(:all) { remove_temporary_directory }
+    base.after(:each) { close_open_files }
+  end
+
+  #
+  # Path of the temporary directory.
+  #
+  # This is automatically created before any specs are run, and
+  # destroyed after the last spec has finished.
+  #
+  def temporary_directory
+    "#{ROOT}/spec/tmp"
+  end
+
+  #
+  # Return the path to a temporary copy of the file at +path+
+  # (relative to spec/data).
+  #
+  # The copy will be deleted automatically after the last spec has
+  # finished.
+  #
+  # If you want an io object, use #file instead - it will be
+  # automatically closed at the end of the spec too.
+  #
+  def temporary_path(path)
+    src = source_path(path)
+    dst = temporary_unique_path(path)
+    FileUtils.mkdir_p File.dirname(dst)
+    FileUtils.cp src, dst
+    dst
+  end
+
+  #
+  # Return an open file for a copy of the file at +path+ (relative to
+  # spec/data).
+  #
+  # The copy will be deleted automatically after the last spec has
+  # finished. The file handle will be automatically closed at the end
+  # of the spec.
+  #
+  def temporary_file(path)
+    tmp_path = temporary_path(path)
+    file = open(tmp_path)
+    files_to_close << file
+    file
+  end
+
+  #
+  # Like #file, but return an ActionController::UploadedFile.
+  #
+  # This is the object that Rails provides to a controller when a file
+  # is uploaded through a multipart form.
+  #
+  def uploaded_file(path, content_type=nil)
+    io = temporary_file(path)
+    io.extend(ActionController::UploadedFile)
+    io.original_path = File.basename(path)
+    io.content_type = content_type || guess_content_type(path)
+    io
+  end
+
+  private
+
+  def init_temporary_directory
+    remove_temporary_directory
+    FileUtils.mkdir_p(temporary_directory)
+
+    # When an attachment is deleted, it deletes empty ancestral
+    # directories.  Don't delete past the temporary directory.
+    FileUtils.touch "#{temporary_directory}/.do_not_delete"
+  end
+
+  def remove_temporary_directory
+    FileUtils.rm_rf(temporary_directory)
+  end
+
+  def close_open_files
+    files_to_close.each{|f| f.close unless f.closed?}
+    files_to_close.clear
+  end
+
+  def files_to_close
+    @files_to_close ||= []
+  end
+
+  def source_path(path)
+    "#{ROOT}/spec/data/#{path}"
+  end
+
+  def temporary_unique_path(path)
+    # Find a unique directory name for this process and
+    # thread. Maintain the same base name.
+    pid_tid = "#{Process.pid}.#{Thread.current.__id__}"
+    n = 0
+    begin
+      dir = "#{temporary_directory}/#{pid_tid}.#{n += 1}"
+    end while File.exist?(dir)
+    "#{dir}/#{File.basename(path)}"
+  end
+
+  def guess_content_type(path)
+    case path
+    when /\.jpe?g\z/
+      'image/jpeg'
+    when /\.png\z/
+      'image/png'
+    when /\.mov\z/
+      'video/quicktime'
+    when /\.pdf\z/
+      'application/pdf'
+    when /\.txt\z/
+      'text/plain'
+    else
+      raise ArgumentError, "can't deduce content type for #{path}"
+    end
+  end
+end

data/spec/integration/lifecycle_hooks_spec.rb

@@ -194,7 +194,7 @@ describe "Lifecycle hooks" do
     end
     thing = Thing.new(:attachment => @file)
     thing.process_attachment(:attachment, :test_event)
-    thing.attachment = uploaded_file_with_content('test.avi', "RIFF    AVI ")
+    thing.attachment = uploaded_file('test.mov')
     thing.process_attachment(:attachment, :test_event)
     runs.should == 2
   end

data/spec/integration/processing_image_attachments.rb

@@ -28,19 +28,7 @@ describe "Processing image attachments" do
     end
     @thing = Thing.new
     @thing.stubs(:id).returns(5)
-    @file = small_uploaded_file(:size => "40x30")
-  end
-
-  def small_uploaded_file(options={})
-    tmp_path = "#{temporary_directory}/small_uploaded_file.tmp.png"
-    create_image(tmp_path, options)
-    content = File.read(tmp_path)
-    File.unlink(tmp_path)
-
-    io = ActionController::UploadedStringIO.new(content)
-    io.original_path = "tmp.png"
-    io.content_type = 'image/png'
-    io
+    @file = uploaded_file('test-40x30.jpg')
   end
 
   after do

data/spec/macros/attachment/has_dimensions_spec.rb

@@ -0,0 +1,313 @@
+require 'spec_helper'
+
+module HasDimensionsSpec
+  def it_should_behave_like_an_attachment_with_dimensions(params)
+    # For some reason, params gets clobbered by subsequent invocations
+    # if this is a shared example group.
+    def it_should_behave_like_whether_or_not_the_width_and_height_are_stored(params)
+      describe 'for a new record with an attachment' do
+        before do
+          @thing = Thing.new(:attachment => uploaded_file(params[:file_40x30]))
+        end
+
+        describe "#width" do
+          it "should return the width of the given style" do
+            @thing.attachment.width(:original).should == 40
+            @thing.attachment.width(:double).should == 80
+          end
+
+          it "should take into account the filledness of the style" do
+            @thing.attachment.width(:filled).should == 60
+            @thing.attachment.width(:unfilled).should == 120
+          end
+
+          it "should use the default style if no style is given" do
+            @thing.attachment.width.should == 80
+          end
+        end
+
+        describe "#height" do
+          it "should return the height of the given style" do
+            @thing.attachment.height(:original).should == 30
+            @thing.attachment.height(:double).should == 60
+          end
+
+          it "should take into account the filledness of the style" do
+            @thing.attachment.height(:filled).should == 60
+            @thing.attachment.height(:unfilled).should == 90
+          end
+
+          it "should use the default style if no style is given" do
+            @thing.attachment.height.should == 60
+          end
+        end
+
+        describe "#dimensions" do
+          it "should return the width and height of the given style" do
+            @thing.attachment.dimensions(:original).should == [40, 30]
+            @thing.attachment.dimensions(:double).should == [80, 60]
+          end
+
+          it "should take into account the filledness of the style" do
+            @thing.attachment.dimensions(:filled).should == [60, 60]
+            @thing.attachment.dimensions(:unfilled).should == [120, 90]
+          end
+
+          it "should use the default style if no style is given" do
+            @thing.attachment.dimensions.should == [80, 60]
+          end
+        end
+
+        describe "#aspect_ratio" do
+          it "should return the aspect ratio of the given style" do
+            @thing.attachment.aspect_ratio(:original).should be_close(4.0/3, 1e-5)
+            @thing.attachment.aspect_ratio(:double).should be_close(4.0/3, 1e-5)
+          end
+
+          it "should take into account the filledness of the style" do
+            @thing.attachment.aspect_ratio(:filled).should be_close(1, 1e-5)
+            @thing.attachment.aspect_ratio(:unfilled).should be_close(4.0/3, 1e-5)
+          end
+
+          it "should use the default style if no style is given" do
+            @thing.attachment.aspect_ratio.should be_close(4.0/3, 1e-5)
+          end
+        end
+
+        describe "when the attachment is updated and the record reloaded" do
+          before do
+            @thing.update_attributes(:attachment => uploaded_file(params[:file_20x10]))
+            @thing = Thing.find(@thing.id)
+          end
+
+          describe "#width" do
+            it "should return the stored width for the original style" do
+              @thing.attachment.width(:original).should == 20
+            end
+          end
+
+          describe "#height" do
+            it "should return the stored height for the original style" do
+              @thing.attachment.height(:original).should == 10
+            end
+          end
+
+          describe "#dimensions" do
+            it "should return the stored width and height for the original style" do
+              @thing.attachment.dimensions(:original) == [20, 10]
+            end
+          end
+
+          describe "#aspect_ratio" do
+            it "should use the stored width and height for the original" do
+              @thing.attachment.aspect_ratio(:original).should be_close(2, 1e-5)
+            end
+          end
+        end
+      end
+    end
+
+    describe "when the width and height are stored" do
+      use_model_class(:Thing,
+                      :attachment_file_name => :string,
+                      :attachment_width => :integer,
+                      :attachment_height => :integer)
+
+      before do
+        Thing.has_attachment :attachment do
+          type params[:type]
+          style :double, :size => '80x60'
+          style :filled, :size => '60x60', :filled => true
+          style :unfilled, :size => '120x120'
+          default_style :double
+        end
+      end
+
+      it_should_behave_like_whether_or_not_the_width_and_height_are_stored(params)
+
+      describe "when a record is instantiated" do
+        before do
+          @thing = Thing.new
+        end
+
+        describe "when the attachment is assigned a file" do
+          before do
+            @thing.attachment = uploaded_file(params[:file_40x30])
+          end
+
+          it "should set the stored attributes" do
+            @thing.attachment_width.should == 40
+            @thing.attachment_height.should == 30
+          end
+
+          describe "when the record is saved" do
+            before do
+              @thing.save!
+            end
+
+            describe "when the record is reinstantiated" do
+              it "should not make any system calls to find the dimensions"
+            end
+
+            describe "when the stored values are hacked, and the record is reinstantiated" do
+              before do
+                Thing.update_all(
+                  {:attachment_width => 100, :attachment_height => 10},
+                  {:id => @thing.id}
+                )
+                @thing = Thing.find(@thing.id)
+              end
+
+              describe "#width" do
+                it "should use the stored width for the original" do
+                  @thing.attachment.width(:original).should == 100
+                end
+
+                it "should calculate the width of other styles from that of the original" do
+                  @thing.attachment.width(:double).should == 80
+                end
+              end
+
+              describe "#height" do
+                it "should use the stored height for the original" do
+                  @thing.attachment.height(:original).should == 10
+                end
+
+                it "should calculate the height of other styles from that of the original" do
+                  @thing.attachment.height(:double).should == 8
+                end
+              end
+
+              describe "#dimensions" do
+                it "should use the stored width and height for the original" do
+                  @thing.attachment.dimensions(:original).should == [100, 10]
+                end
+
+                it "should calculate the width and height of other styles from those of the original" do
+                  @thing.attachment.dimensions(:double).should == [80, 8]
+                end
+              end
+
+              describe "#aspect_ratio" do
+                it "should use the stored width and height for the original" do
+                  @thing.attachment.aspect_ratio(:original).should be_close(10, 1e-5)
+                end
+
+                it "should calculate the width and height of other styles from those of the original" do
+                  @thing.attachment.aspect_ratio(:double).should be_close(10, 1e-5)
+                end
+
+                it "should take into account the filledness of the style" do
+                  @thing.attachment.aspect_ratio(:filled).should be_close(1, 1e-5)
+                end
+              end
+            end
+
+            describe "when the file is removed and the record reloaded (file is missing)" do
+              before do
+                File.unlink(@thing.attachment.path(:original))
+                @thing = Thing.find(@thing.id)
+              end
+
+              describe "#width" do
+                it "should return the stored width for the original" do
+                  @thing.attachment.width(:original).should == 40
+                end
+              end
+
+              describe "#height" do
+                it "should return the stored height for the original" do
+                  @thing.attachment.height(:original).should == 30
+                end
+              end
+
+              describe "#dimensions" do
+                it "should return the stored width and height for the original" do
+                  @thing.attachment.dimensions(:original).should == [40, 30]
+                end
+              end
+
+              describe "#aspect_ratio" do
+                it "should return the stored aspect ratio for the original" do
+                  @thing.attachment.aspect_ratio(:original).should be_close(4.0/3, 1e-5)
+                end
+              end
+            end
+          end
+        end
+
+        describe "when the attachment is assigned nil" do
+          before do
+            @thing.attachment = nil
+          end
+
+          it "should clear the stored attributes" do
+            @thing.attachment_width.should be_nil
+            @thing.attachment_height.should be_nil
+          end
+        end
+      end
+    end
+
+    describe "when the width and height are not stored" do
+      use_model_class(:Thing, :attachment_file_name => :string)
+
+      it_should_behave_like_whether_or_not_the_width_and_height_are_stored(params)
+
+      before do
+        Thing.has_attachment :attachment do
+          type params[:type]
+          style :double, :size => '80x60'
+          style :filled, :size => '60x60', :filled => true
+          style :unfilled, :size => '120x120'
+          default_style :double
+        end
+      end
+
+      describe "when a record is created with an attachment" do
+        before do
+          @thing = Thing.create!(:attachment => uploaded_file(params[:file_40x30]))
+        end
+
+        describe "when the record is reinstantiated" do
+          it "should log the system calls to find the dimensions"
+        end
+
+        describe "when the record is reinstantiated but the file is missing" do
+          w, h = *params[:missing_dimensions]
+
+          before do
+            File.unlink(@thing.attachment.path(:original))
+            @thing = Thing.find(@thing.id)
+          end
+
+          describe "#width" do
+            it "should return #{w} for the original" do
+              @thing.attachment.width(:original).should == w
+            end
+          end
+
+          describe "#height" do
+            it "should return #{h} for the original" do
+              @thing.attachment.height(:original).should == h
+            end
+          end
+
+          describe "#dimensions" do
+            it "should return [#{w}, #{h}] for the original" do
+              @thing.attachment.dimensions(:original).should == [w, h]
+            end
+          end
+
+          describe "#aspect_ratio" do
+            it "should return #{w}/#{h} for the original" do
+              @thing.attachment.aspect_ratio(:original).should be_close(w.to_f/h, 1e-5)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  Spec::Runner.configure{|c| c.extend self}
+end