bulldog 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.0.6 2009-11-17
+
+ * Add attachment#reload for when the file changes behind Bulldog's
+   back.
+
 == 0.0.5 2009-11-17
 
  * Fix @original_attachments not being set in after save.

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/bulldog.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bulldog}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["George Ogata"]
@@ -62,6 +62,7 @@ Flexible file attachments for active record.
      "spec/data/empty.txt",
      "spec/data/test.jpg",
      "spec/data/test.mov",
+     "spec/data/test.ogg",
      "spec/data/test.pdf",
      "spec/data/test.png",
      "spec/data/test2.jpg",

data/lib/bulldog/attachment/base.rb

@@ -118,6 +118,11 @@ module Bulldog
         end
       end
 
+      def unload
+        super
+        @examination_result = nil
+      end
+
       protected  # ---------------------------------------------------
 
       #

data/lib/bulldog/attachment/image.rb

@@ -27,6 +27,11 @@ module Bulldog
 
       include HasDimensions
 
+      def unload
+        super
+        @original_dimensions = nil
+      end
+
       protected  # ---------------------------------------------------
 
       #

data/lib/bulldog/attachment/maybe.rb

@@ -66,9 +66,12 @@ module Bulldog
       end
 
       #
-      # Set the stored attributes in the record.
+      # Load the attachment.
       #
-      def set_stored_attributes
+      # Called just after initializing the attachment, or after a
+      # reload on the new attachment.
+      #
+      def load
         storable_attributes.each do |name, storable_attribute|
           if (column_name = reflection.column_name_for_stored_attribute(name))
             value = storable_attribute.value_for(self, :original)
@@ -78,16 +81,46 @@ module Bulldog
       end
 
       #
-      # Clear the stored attributes in the record.
+      # Unload the attachment.
+      #
+      # Called before a reload on the old attachment, or before a
+      # destroy.
       #
-      def clear_stored_attributes
-        storable_attributes.each do |name, callback|
+      def unload
+        storable_attributes.each do |name, storable_attribute|
           if (column_name = reflection.column_name_for_stored_attribute(name))
             record.send("#{column_name}=", nil)
           end
+          if storable_attribute.memoize?
+            send("memoized_#{name}").clear
+          end
         end
       end
 
+      #
+      # Refresh the attachment.  This includes anything read from the
+      # file, such as stored attributes, and dimensions.
+      #
+      # Use this to update the record if the underlying file has been
+      # modified outside of Bulldog.  Note that the file has to be
+      # initialized from a saved file for this to work.
+      #
+      # Example:
+      #
+      #     article = Article.create(:photo => photo_file)
+      #     article = Article.find(article.id)
+      #
+      #     # ... file is modified by an outside force ...
+      #
+      #     article.photo.reload
+      #     article.photo.dimensions  # now reflects the new dimensions
+      #
+      def reload
+        unload
+        stream.reload
+        load
+      end
+
       #
       # Set the stored attributes in the attachment from the values in
       # the record.

data/lib/bulldog/attachment/video.rb

@@ -80,6 +80,13 @@ module Bulldog
 
       storable_attribute :duration    , :per_style => true, :memoize => true
 
+      def unload
+        super
+        instance_variables.grep(/@original_/).each do |name|
+          instance_variable_set(name, nil)
+        end
+      end
+
       protected  # ---------------------------------------------------
 
       #

data/lib/bulldog/has_attachment.rb

@@ -99,9 +99,9 @@ module Bulldog
     def assign_attachment(name, value)
       old_attachment = _attachment_for(name)
       unless old_attachment.value == value
-        old_attachment.clear_stored_attributes
+        old_attachment.unload
         new_attachment = make_attachment_for(name, value)
-        new_attachment.set_stored_attributes
+        new_attachment.load
         write_attribute(name, new_attachment)
       end
     end

data/lib/bulldog/stream.rb

@@ -88,6 +88,13 @@ module Bulldog
           FileUtils.cp src, dst
         end
       end
+
+      #
+      # Reload data from the target.
+      #
+      def reload
+        @content_type = nil
+      end
     end
 
     class ForTempfile < Base

data/spec/unit/attachment/image_spec.rb

@@ -125,4 +125,40 @@ describe Attachment::Image do
       end
     end
   end
+
+  describe "#reload" do
+    before do
+      thing = Thing.create(:photo => test_image_file('test.jpg'))
+      @thing = Thing.find(thing.id)
+    end
+
+    it "should update the stored attributes from the file" do
+      # Prime the cached values.
+      @thing.photo_width.should == 40
+      @thing.photo_height.should == 30
+      @thing.photo_aspect_ratio.should be_close(4.0/3, 1e-5)
+      @thing.photo_dimensions.should == '40x30'
+
+      FileUtils.cp(test_path('test2.jpg'), @thing.photo.path(:original))
+      @thing.photo.reload
+      @thing.photo_width.should == 2
+      @thing.photo_height.should == 2
+      @thing.photo_aspect_ratio.should == 1
+      @thing.photo_dimensions.should == '2x2'
+    end
+
+    it "should update the original dimensions from the file" do
+      @thing.photo.dimensions(:original).should == [40, 30]
+      FileUtils.cp(test_path('test2.jpg'), @thing.photo.path(:original))
+      @thing.photo.reload
+      @thing.photo.dimensions(:original).should == [2, 2]
+    end
+
+    it "should update the dimensions for each style from the file" do
+      @thing.photo.dimensions(:double).should == [80, 60]
+      FileUtils.cp(test_path('test2.jpg'), @thing.photo.path(:original))
+      @thing.photo.reload
+      @thing.photo.dimensions(:double).should == [60, 60]
+    end
+  end
 end

data/spec/unit/attachment/maybe_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
 
 describe Attachment::Maybe do
-  use_model_class(:Thing, :photo_file_name => :string)
+  use_model_class(:Thing,
+                  :photo_file_name => :string,
+                  :photo_file_size => :integer,
+                  :photo_content_type => :string)
 
   before do
     spec = self
@@ -123,4 +126,23 @@ describe Attachment::Maybe do
       end
     end
   end
+
+  describe "#reload" do
+    before do
+      thing = Thing.create(:photo => test_file('test.png'))
+      @thing = Thing.find(thing.id)
+    end
+
+    it "should update the file size stored attribute from the file" do
+      FileUtils.cp(test_path('test2.jpg'), @thing.photo.path(:original))
+      @thing.photo.reload
+      @thing.photo_file_size.should == File.size(test_path('test2.jpg'))
+    end
+
+    it "should reload the content type stored attribute from the file" do
+      FileUtils.cp(test_path('test.png'), @thing.photo.path(:original))
+      @thing.photo.reload
+      @thing.photo_content_type.should =~ %r'image/png'
+    end
+  end
 end

data/spec/unit/attachment/video_spec.rb

@@ -173,4 +173,40 @@ describe Attachment::Video do
       end
     end
   end
+
+  describe "#reload" do
+    before do
+      thing = Thing.create(:video => test_video_file('test.mov'))
+      @thing = Thing.find(thing.id)
+    end
+
+    it "should update the stored attributes from the file" do
+      # Prime the cached values.
+      @thing.video_width.should == 640
+      @thing.video_height.should == 480
+      @thing.video_aspect_ratio.should be_close(4.0/3, 1e-5)
+      @thing.video_dimensions.should == '640x480'
+
+      FileUtils.cp(test_path('test.ogg'), @thing.video.path(:original))
+      @thing.video.reload
+      @thing.video_width.should == 176
+      @thing.video_height.should == 144
+      @thing.video_aspect_ratio.should == 176.0/144
+      @thing.video_dimensions.should == '176x144'
+    end
+
+    it "should update the original dimensions from the file" do
+      @thing.video.dimensions(:original).should == [640, 480]
+      FileUtils.cp(test_path('test.ogg'), @thing.video.path(:original))
+      @thing.video.reload
+      @thing.video.dimensions(:original).should == [176, 144]
+    end
+
+    it "should update the dimensions for each style from the file" do
+      @thing.video.dimensions(:half).should == [320, 240]
+      FileUtils.cp(test_path('test.ogg'), @thing.video.path(:original))
+      @thing.video.reload
+      @thing.video.dimensions(:half).should == [292, 240]
+    end
+  end
 end

data/spec/unit/stream_spec.rb

@@ -82,6 +82,40 @@ describe Stream do
         end
       end
     end
+
+    describe "#reload" do
+      if options[:reloadable]
+        it "should make #size return the new size of the file" do
+          stream = stream('content')
+          update_target(stream, 'new content')
+          stream.reload
+          stream.size.should == 'new content'.size
+        end
+
+        it "should make #content_type return the new content type of the file" do
+          jpg_data = File.read(test_path('test.jpg'))
+          png_data = File.read(test_path('test.png'))
+          stream = stream(jpg_data)
+          stream.content_type.should =~ %r'\Aimage/jpeg'
+          update_target(stream, png_data)
+          stream.reload
+          stream.content_type.should =~ %r'\Aimage/png'
+        end
+      else
+        it "should not change the result of #size" do
+          stream = stream('content')
+          stream.reload
+          stream.size.should == 'content'.size
+        end
+
+        it "should not change the result of #content_type" do
+          jpg_data = File.read(test_path('test.jpg'))
+          stream = stream(jpg_data)
+          stream.reload
+          stream.content_type.should =~ %r'\Aimage/jpeg'
+        end
+      end
+    end
   end
 
   describe 'for a small uploaded file' do
@@ -100,28 +134,28 @@ describe Stream do
     it_should_behave_like_all_streams :file_name => :original_path
 
     def object(content)
-      stringio = StringIO.new(content)
-      class << stringio
+      tempfile = Tempfile.new('bulldog-spec')
+      tempfile.print(content)
+      class << tempfile
         attr_accessor :original_path
       end
-      stringio
+      tempfile
     end
   end
 
-  describe 'for a StringIO' do
+  describe Stream::ForStringIO do
     it_should_behave_like_all_streams
 
     def object(content)
-      tempfile = Tempfile.new('bulldog-spec')
-      tempfile.print(content)
-      class << tempfile
+      stringio = StringIO.new(content)
+      class << stringio
         attr_accessor :original_path
       end
-      tempfile
+      stringio
     end
   end
 
-  describe 'for a Tempfile' do
+  describe Stream::ForTempfile do
     it_should_behave_like_all_streams
 
     def object(content)
@@ -131,7 +165,7 @@ describe Stream do
     end
   end
 
-  describe 'for a File opened for reading' do
+  describe "Stream::ForFile (opened for writing)" do
     it_should_behave_like_all_streams :file_name => :basename
 
     def object(content)
@@ -152,7 +186,7 @@ describe Stream do
     end
   end
 
-  describe 'for a File opened for writing' do
+  describe "Stream::ForFile (opened for writing)" do
     it_should_behave_like_all_streams :file_name => :basename
 
     def object(content)
@@ -162,17 +196,21 @@ describe Stream do
     end
   end
 
-  describe 'for an SavedFile' do
-    it_should_behave_like_all_streams :file_name => :file_name
+  describe Stream::ForSavedFile do
+    it_should_behave_like_all_streams :file_name => :file_name, :reloadable => true
 
     def object(content)
       path = "#{temporary_directory}/file"
       open(path, 'w'){|f| f.print content}
       SavedFile.new(path)
     end
+
+    def update_target(stream, content)
+      open(stream.target.path, 'w'){|f| f.print content}
+    end
   end
 
-  describe 'for a MissingFile' do
+  describe Stream::ForMissingFile do
     it_should_behave_like_all_streams :file_name => :file_name
 
     def object(content)
@@ -210,12 +248,14 @@ describe Stream do
     end
   end
 
-  describe 'for an IO' do
+  describe Stream::ForIO do
     it_should_behave_like_all_streams
 
     def object(content)
-      io = IO.popen("echo -n #{content}")
-      autoclose_stream(io)
+      readable, writable = IO.pipe
+      writable.print content
+      writable.close
+      autoclose_stream(readable)
     end
 
     describe "#path" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bulldog
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - George Ogata
@@ -98,6 +98,7 @@ files:
 - spec/data/empty.txt
 - spec/data/test.jpg
 - spec/data/test.mov
+- spec/data/test.ogg
 - spec/data/test.pdf
 - spec/data/test.png
 - spec/data/test2.jpg