has_image 0.1.11 → 0.2.0

data/CHANGELOG

@@ -1,5 +1,12 @@
 2008-08-28 Norman Clarke <norman@randomba.org>
   * Added ability to regenerate a model's thumbnails.
+  * Changed a few methods in storage to accept the model rather than the id.
+    This makes storage more hackable as regards generating paths and file names.
+  * Added "has_image_id" method to model instance methods to facilitate
+    grouping the images under a directory structure based on a related model's
+    ids.
+  * Made the generated file name simply by the image object's id - this
+    is better adherance to the principle of least surprise.
 
 2008-08-25 Norman Clarke <norman@randomba.org>
   * Fixed bad call to resize_to in view helper.

data/lib/has_image/storage.rb

@@ -25,14 +25,11 @@ module HasImage
         ["%04d" % ((id.to_i / 1e4) % 1e4), "%04d" % (id.to_i % 1e4)].concat(args)
       end
 
-      # Generates a 4-6 character random file name to use for the image and
-      # its thumbnails. This is done to avoid having files with unfortunate
-      # names. On one of my sites users frequently upload images with Arabic
-      # names, and they end up being hard to manipulate on the command line.
-      # This also helps prevent a possibly undesirable sitation where the
-      # uploaded images have offensive names.
-      def generated_file_name
-        Zlib.crc32(Time.now.to_s + rand(10e10).to_s).to_s(36).downcase
+      # By default, simply accepts and returns the id of the object. This is
+      # here to allow you to monkey patch this method, for example, if you
+      # wish instead to generate and return a UUID.
+      def generated_file_name(*args)
+        return args.first.to_param.to_s
       end
           
     end
@@ -76,10 +73,10 @@ module HasImage
     
     # Invokes the processor to resize the image(s) and the installs them to
     # the appropriate directory.
-    def install_images(id)
-      generated_name = Storage.generated_file_name
-      install_main_image(id, generated_name)
-      install_thumbnails(id, generated_name) if !options[:thumbnails].empty?
+    def install_images(object)
+      generated_name = Storage.generated_file_name(object)
+      install_main_image(object.has_image_id, generated_name)
+      install_thumbnails(object.has_image_id, generated_name) if !options[:thumbnails].empty?
       return generated_name
     ensure  
       @temp_file.close! if !@temp_file.closed?
@@ -94,8 +91,10 @@ module HasImage
     end
     
     # Deletes the images and directory that contains them.
-    def remove_images(id)
-      FileUtils.rm_r path_for(id)
+    def remove_images(object, name)
+      FileUtils.rm Dir.glob(File.join(path_for(object.has_image_id), name + '*'))
+      Dir.rmdir path_for(object.has_image_id)
+    rescue SystemCallError 
     end
 
     # Is the uploaded file within the min and max allowed sizes?
@@ -133,7 +132,7 @@ module HasImage
     #
     #   /var/sites/example.com/production/public/photos/0000/0001/3er0zs.jpg
     def filesystem_path_for(object, thumbnail = nil)
-      File.join(path_for(object.id), file_name_for(object.has_image_file, thumbnail))
+      File.join(path_for(object.has_image_id), file_name_for(object.has_image_file, thumbnail))
     end
     
     # Write the main image to the install directory - probably somewhere under

data/lib/has_image.rb

@@ -209,7 +209,7 @@ module HasImage
     
     # Regenerates the thumbails from the main image.
     def regenerate_thumbnails
-      storage.regenerate_thumbnails(id, has_image_file)
+      storage.regenerate_thumbnails(has_image_id, has_image_file)
     end
     
     # Deletes the image from the storage.
@@ -217,11 +217,14 @@ module HasImage
       return if has_image_file.blank?
       self.class.transaction do
         begin
-          # Resorting to SQL here to avoid triggering callbacks. There must be
-          # a better way to do this.
-          self.connection.execute("UPDATE #{self.class.table_name} SET has_image_file = NULL WHERE id = #{id}")
-          self.has_image_file = nil
-          storage.remove_images(self.id)
+          storage.remove_images(self, has_image_file)
+          # The record will be frozen if we're being called after destroy.
+          unless frozen?
+            # Resorting to SQL here to avoid triggering callbacks. There must be
+            # a better way to do this.
+            self.connection.execute("UPDATE #{self.class.table_name} SET has_image_file = NULL WHERE id = #{id}")          
+            self.has_image_file = nil
+          end
         rescue Errno::ENOENT
           logger.warn("Could not delete files for #{self.class.to_s} #{to_param}")
         end
@@ -233,13 +236,13 @@ module HasImage
     def update_images
       return if storage.temp_file.blank?
       remove_images
-      update_attribute(:has_image_file, storage.install_images(self.id))      
+      update_attribute(:has_image_file, storage.install_images(has_image_id))      
     end
 
     # Processes and installs the image and its thumbnails.
     def install_images
       return if !storage.temp_file
-      update_attribute(:has_image_file, storage.install_images(self.id))
+      update_attribute(:has_image_file, storage.install_images(self))
     end
     
     # Gets an instance of the underlying storage functionality. See
@@ -248,6 +251,15 @@ module HasImage
       @storage ||= HasImage::Storage.new(has_image_options)
     end
     
+    # By default, just returns the model's id. Since this id is used to divide
+    # the images up in directories, you can override this to return a related
+    # model's id if you want the images to be grouped differently. For example,
+    # if a "member" has_many "photos" you can override this to return
+    # member.id to group images by member.
+    def has_image_id
+      id
+    end
+    
   end
 
   module ModelClassMethods

data/test/storage_test.rb

@@ -26,7 +26,7 @@ class StorageTest < Test::Unit::TestCase
   end
   
   def test_generated_file_name
-    assert_match(/[a-z0-9]{4,6}/i, HasImage::Storage.generated_file_name)
+    assert_equal("1", HasImage::Storage.generated_file_name(stub(:to_param => 1)))
   end
   
   def test_path_for
@@ -36,7 +36,7 @@ class StorageTest < Test::Unit::TestCase
   
   def test_public_path_for
     @storage = HasImage::Storage.new(default_options.merge(:base_path => '/public'))
-    pic = stub(:has_image_file => "mypic", :id => 1)
+    pic = stub(:has_image_file => "mypic", :has_image_id => 1)
     assert_equal "/tests/0000/0001/mypic_square.jpg", @storage.public_path_for(pic, :square)
   end
   
@@ -64,8 +64,8 @@ class StorageTest < Test::Unit::TestCase
     @storage = HasImage::Storage.new(default_options.merge(:thumbnails => {
       :one => "100x100", :two => "200x200"}))
     @storage.image_data = temp_file("image.jpg")
-    assert @storage.install_images(1)
-    assert @storage.remove_images(1)    
+    @name = @storage.install_images(stub(:has_image_id => 1))
+    assert @storage.remove_images(stub(:has_image_id => 1), @name)    
   end
 
   def test_image_not_too_small

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: has_image
 version: !ruby/object:Gem::Version 
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors: 
 - Norman Clarke