has_image 0.3.0 → 0.4.0

data/Changelog.md

@@ -0,0 +1,100 @@
+## 0.4.0 (2010-09-29)
+
+We have picked up maintainence of has\_image after a few years of neglect. This
+is a transitional release which adds Rails 3 compatibility and a few small bug
+fixes, as well as the following:
+
+* Allow passing `nil` to avoid resizing.
+
+## Older changes
+
+### 2009-03-11
+
+* Fix a critical problem with image updates breaking when used together with
+  Rails' partial updates feature (now "on" by default). Thanks to Juan
+  Schwindt <juan@schwindt.org> for the report.
+* Replaced a raw SQL call with update_all.
+
+### 2008-10-22
+
+* Added option to not delete images on destroy
+* Made thumbnail name separator configurable
+* Added height/width methods to storage
+* Allowed regenerating only one thumbnail size
+* Made has_image column configurable
+* Added some compatibility with attachment_fu
+* General refactorings and overall code improvement
+
+### 2008-10-22
+
+* Documentation improvements and minor code cleanups.
+
+### 2008-10-09
+
+* Fixed display of images with special symbols in the name,
+  like '2777-nipple-+-apple-napple.jpg'. + is reserved by HTTP.
+  Now escaping filenames before giving them back in #public_path()
+
+### 2008-09-10
+
+* Fixed images not being converted to target format.
+
+### 2008-08-29
+
+* Fixed bad call to has_image_file
+
+### 2008-08-28
+
+* 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
+
+* Fixed bad call to resize_to in view helper.
+
+### 2008-08-19
+
+* Made storage work more correctly with tempfiles.
+
+### 2008-08-18
+
+* Fixed ability to set the path for storing image files.
+
+### 2008-08-01
+
+* Improved partitioned path handling to avoid collisions when the id is
+  very high, which can happen if you use db:fixtures:load.
+
+### 2008-08-01
+
+* Fixed a bug where overwriting a previous image triggered callbacks more
+  than once, causing errors.
+
+### 2008-07-29
+
+* Downcased generated file names to avoid potential issues on
+  case-insensitive filesystems.
+* Added "absolute path" method to model instances.
+* Made image deletion nullify the "has_image_file" field.
+* Added "has_image?" method to model instances.
+* Fixed ENONENT error with record update when there are no images yet.
+* Reverted thumbnail sorting feature - it's fast but makes terrible quality
+  thumbnails. It's just not worth it.
+
+### 2008-07-28
+
+* Added sorted thumbnail processing. This improves thumbnail generation
+  speed by about 25% for 4.5 meg jpegs with 5 thumbnails.
+* Fixed broken resize for non-fixed-width thumbnails.
+* Added check for bad geometry strings.
+* Added dependencies and Rubyforge project to gemspec, updated docs.
+
+### 2008-07-25
+
+* First public release.

data/MIT-LICENSE

@@ -1,20 +1,18 @@
-Copyright (c) 2008 [name of plugin creator]
+Copyright (c) 2008-2010 Norman Clarke and Adrián Mugnolo
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# has\_image - An Image attachment library for Active Record
+
+The has\_image library extends Active Record to allow Rails applications to have
+attached images. It is very small and lightweight: it only requires one column
+in your model to store the uploaded image's file name.
+
+It was originally created as a smaller, simpler, lighter alternative to
+[attachment_fu](http://github.com/technoweenie/attachment_fu) for applications
+that need to handle uploaded images.
+
+It only supports using a filesystem for storage, and only supports
+[MiniMagick](http://github.com/probablycorey/mini_magick) as an image processor.
+However, its code is very small, clean and hackable, so adding support for other
+backends or processors should be fairly easy.
+
+Some typical use cases are: websites that want to create photo galleries with
+fixed-dimension thumbnails, or that want to store user profile pictures without
+creating a separate model for the images.
+
+It creates only one database record per image, and uses ImageMagick's
+[crop](http://www.imagemagick.org/script/command-line-options.php#crop) and
+[center
+gravity](http://www.imagemagick.org/script/command-line-options.php#gravity)
+functions to produce thumbnails that generally look acceptable, unless the image
+is a panorama, or the subject matter is close to one of the margins, etc. For
+most sites where people upload pictures of themselves the generated thumbnails
+will look good almost all the time.
+
+## Examples
+
+Point-and-drool use case. It's probably not what you want, but it may be useful
+for bootstrapping.
+
+    class Member < ActiveRecord::Base
+      has_image
+    end
+
+Single image, no thumbnails, with some size limits:
+
+    class Picture < ActiveRecord::Base
+      has_image :resize_to => "200x200",
+        :max_size => 3.megabytes,
+        :min_size => 4.kilobytes
+    end
+
+Image with some thumbnails:
+
+    class Photo < ActiveRecord::Base
+      has_image :resize_to => "640x480",
+        :thumbnails => {
+          :square => "200x200",
+          :medium => "320x240"
+        },
+        :max_size => 3.megabytes,
+        :min_size => 4.kilobytes
+    end
+
+It also provides a view helper to make displaying the images extremely simple:
+
+    <%= image_tag_for(@photo) # show the full-sized image %>
+    <%= image_tag_for(@photo, :thumb => :square) # show the square thumbnail %>
+
+The image_tag_for helper calls Rails' image_tag, so you can pass in all the
+regular options to set the alt property, CSS class, etc:
+
+    <%= image_tag_for(@photo, :alt => "my cool picture", :class => "photo") %>
+
+Setting up forms for has\_image is simple, too:
+
+    <% form_for(@photo, :html => {:multipart => true}) do |f| %>
+      <p>
+        <%= f.label :image_data %>
+        <%= f.file_field :image_data %>
+      </p>
+      <p>
+        <%= f.submit %>
+      </p>
+    <% end %>
+
+## Compatibility
+
+Has\_image is compatible with Rails 2.1.x - 3.0.x.
+
+## Getting it
+
+Install has_image via RubyGems:
+
+  gem install has_image
+
+and add it to your Gemfile (Rails 3.0.x) or environment.rb (Rails 2.x).
+
+Then, add a column named `has_image_file` to your model.
+
+## Source code
+
+[http://github.com/norman/has_image](http://github.com/norman/has_image)
+
+## FAQ
+
+### How do I validate the mime type of my uploaded images?
+
+You don't. Rather than examine the mime type, has\_image runs the "identify"
+command on the file to determine if it is processable by ImageMagick, and if it
+is, converts it to the format you specify, which defaults to JPEG.
+
+This is better than checking for mime types, because your users may upload
+exotic image types that you didn't even realize would work, such as Truevision
+Targa images, or Seattle Film Works files.
+
+If you wish to give users a list of file types they can upload, a good start
+would be jpeg, png, bmp, and maybe gif and ttf if your installation of
+ImageMagick understands them. You can find out what image types your ImageMagick
+understands by running:
+
+    identify -list format
+
+Ideally, if your users just upload files that "look like" images on their
+computers, it has\_image should "just work."
+
+## Hacking it
+
+Don't like the way it makes images? Want to pipe the images through some [crazy
+fast seam carving library written in
+OCaml](http://eigenclass.org/hiki/seam-carving-in-ocaml), or watermark them with
+your corporate logo? Happiness is just a
+[monkey-patch](http://en.wikipedia.org/wiki/Monkey_patch) away:
+
+    module HasImage
+      class Processor
+        def resize_image(size)
+          # your new-and-improved thumbnailer code goes here.
+        end
+      end
+    end
+
+Has\_image follows a philosophy of [skinny model, fat
+plugin](http://weblog.jamisbuck.org/2006/10/18/skinny-controller-fat-model.)
+This means that it tries to pollute your ActiveRecord model with as little
+functionality as possible, so that in a sense, the model is acts like a
+"controller" and the plugin like a "model" as regards the image handling
+functionality. This makes it easier to test, hack, and reuse, because the
+storage and processing functionality is largely independent of your model, and
+of Rails.
+
+## Bugs
+
+Please report them on the Github issue tracker.
+
+Copyright (c) 2008-2010 Norman Clarke and Adrian Mugnolo. Released under the MIT
+License.
+
+## Acknowledgements
+
+We'd like to thank the following contributors for their help with has\_image:
+
+* [Juan Schwindt](http://github.com/jschwindt)
+* [Gerrit Keiser](http://github.com/gerrit)
+* the folks from [Tricycle Developments](http://github.com/tricycle)
+* [Dima Sabanin](http://github.com/railsmonk)

data/Rakefile

@@ -1,11 +1,12 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require "rake/gempackagetask"
+require "rake/clean"
 
-desc 'Default: run unit tests.'
-task :default => :test
+CLEAN << "pkg" << "doc" << "coverage"
+Rake::GemPackageTask.new(eval(File.read("has_image.gemspec"))) { |pkg| }
 
-task :all_tests  => [:test, :test_rails]
+task :default => :test
 
 desc 'Test the non-Rails part of has_image.'
 Rake::TestTask.new(:test) do |t|
@@ -13,37 +14,4 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
-end
-
-desc 'Test the Rails part of has_image.'
-Rake::TestTask.new(:test_rails) do |t|
-  t.libs << 'lib'
-  t.libs << 'test_rails'
-  t.pattern = 'test_rails/**/*_test.rb'
-  t.verbose = true
-end
-
-desc "Run rcov"
-task :rcov do
-  rm_f "coverage"
-  rm_f "coverage.data"
-  if PLATFORM =~ /darwin/
-    exclude = '--exclude "gems"'
-  else
-    exclude = '--exclude "rubygems"'
-  end
-  rcov = "rcov --rails -Ilib:test --sort coverage --text-report #{exclude} --no-validator-links"
-  cmd = "#{rcov} #{Dir["test/**/*.rb"].join(" ")}"
-  sh cmd
-end
-
-desc 'Generate documentation for has_image.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'HasImage'
-  rdoc.options << '--line-numbers' << '--inline-source' << '-c UTF-8'
-  rdoc.rdoc_files.include('README.textile')
-  rdoc.rdoc_files.include('FAQ')
-  rdoc.rdoc_files.include('CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/lib/has_image.rb

@@ -1,3 +1,14 @@
+require "cgi"
+require "active_support"
+
+# AR < 3 would autoload everything
+unless "".respond_to? :to_param
+  require "active_support/core_ext/object/blank"
+  require "active_support/core_ext/object/to_param"
+  require "active_support/core_ext/numeric/bytes"
+  require "active_support/core_ext/class/inheritable_attributes"
+end
+
 require 'has_image/processor'
 require 'has_image/storage'
 require 'has_image/view_helpers'
@@ -58,7 +69,7 @@ require 'has_image/view_helpers'
 # directory. Add something like this to your config/environments/test.rb:
 #
 #   config.after_initialize do
-#     MyClass.has_image_options[:base_path] = File.join(RAILS_ROOT, "tmp") 
+#     MyClass.has_image_options[:base_path] = File.join(RAILS_ROOT, "tmp")
 #   end
 #
 # If you want to stub out calls to has_image so that your tests don't do
@@ -90,7 +101,6 @@ module HasImage
     def enable # :nodoc:
       return if ActiveRecord::Base.respond_to? :has_image
       ActiveRecord::Base.send(:include, HasImage)
-      return if ActionView::Base.respond_to? :image_tag_for
       ActionView::Base.send(:include, ViewHelpers)
     end
 
@@ -243,7 +253,7 @@ module HasImage
     end
 
     def image_size
-      [width, height] * 'x'
+      self[:image_size] || [width, height].join('x')
     end
 
     # Deletes the image from the storage.
@@ -254,9 +264,11 @@ module HasImage
           storage.remove_images(self, send(has_image_options[:column]))
           # 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_options[:column]} = NULL WHERE id = #{id}")          
+            # FIXME: although this is cleaner now, it introduces a new issue
+            # with partial updates.
+            updates    = "#{connection.quote_column_name(has_image_options[:column])} = NULL"
+            conditions = "#{connection.quote_column_name(self.class.primary_key)} = #{connection.quote(id)}"
+            self.class.update_all(updates, conditions)
             self.send("#{has_image_options[:column]}=", nil)
           end
         rescue Errno::ENOENT
@@ -297,17 +309,22 @@ module HasImage
     private
 
     def populate_attributes
+      # FIXME: this is a quick and dirty work around for image updates
+      # breaking when running with Rails' partial updates. This is originated
+      # by the update_all call in the remove_images method which bypasses
+      # ActiveRecord::Dirty attribute change tracking.
+      attribute_will_change!(has_image_options[:column].to_s) if respond_to?(:attribute_will_change!, true)
+
       send("#{has_image_options[:column]}=", storage.install_images(self))
       self[:width] = storage.measure(absolute_path, :width) if self.class.column_names.include?('width')
       self[:height] = storage.measure(absolute_path, :height) if self.class.column_names.include?('height')
+      self[:image_size] = [storage.measure(absolute_path, :width), storage.measure(absolute_path, :height)].join('x') if self.class.column_names.include?('image_size')
       save!
     end
 
-
   end
 
   module ModelClassMethods
-
     # Get the hash of thumbnails set by the options specified when invoking
     # HasImage::ClassMethods#has_image.
     def thumbnails
@@ -317,11 +334,13 @@ module HasImage
     def from_partitioned_path(path)
       find HasImage::Storage.id_from_path(path)
     end
-
   end
-
 end
 
-if defined?(Rails) and defined?(ActiveRecord) and defined?(ActionController)
-  HasImage.enable
+if defined?(Rails)
+  if Rails.version >= "3"
+    require "has_image/railtie"
+  else
+    HasImage.enable
+  end
 end