jcnetdev-paperclip 1.0.20080704

data/lib/paperclip/thumbnail.rb

@@ -0,0 +1,80 @@
+module Paperclip
+  # Handles thumbnailing images that are uploaded.
+  class Thumbnail
+
+    attr_accessor :file, :current_geometry, :target_geometry, :format, :whiny_thumbnails
+
+    # Creates a Thumbnail object set to work on the +file+ given. It
+    # will attempt to transform the image into one defined by +target_geometry+
+    # which is a "WxH"-style string. +format+ will be inferred from the +file+
+    # unless specified. Thumbnail creation will raise no errors unless
+    # +whiny_thumbnails+ is true (which it is, by default.
+    def initialize file, target_geometry, format = nil, whiny_thumbnails = true
+      @file             = file
+      @crop             = target_geometry[-1,1] == '#'
+      @target_geometry  = Geometry.parse target_geometry
+      @current_geometry = Geometry.from_file file
+      @whiny_thumbnails = whiny_thumbnails
+
+      @current_format   = File.extname(@file.path)
+      @basename         = File.basename(@file.path, @current_format)
+      
+      @format = format
+    end
+
+    # Creates a thumbnail, as specified in +initialize+, +make+s it, and returns the
+    # resulting Tempfile.
+    def self.make file, dimensions, format = nil, whiny_thumbnails = true
+      new(file, dimensions, format, whiny_thumbnails).make
+    end
+
+    # Returns true if the +target_geometry+ is meant to crop.
+    def crop?
+      @crop
+    end
+
+    # Performs the conversion of the +file+ into a thumbnail. Returns the Tempfile
+    # that contains the new image.
+    def make
+      src = @file
+      dst = Tempfile.new([@basename, @format].compact.join("."))
+      dst.binmode
+
+      command = <<-end_command
+        #{ Paperclip.path_for_command('convert') }
+        "#{ File.expand_path(src.path) }"
+        #{ transformation_command }
+        "#{ File.expand_path(dst.path) }"
+      end_command
+      success = system(command.gsub(/\s+/, " "))
+
+      if success && $?.exitstatus != 0 && @whiny_thumbnails
+        raise PaperclipError, "There was an error processing this thumbnail"
+      end
+
+      dst
+    end
+
+    # Returns the command ImageMagick's +convert+ needs to transform the image
+    # into the thumbnail.
+    def transformation_command
+      scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
+      trans = "-scale \"#{scale}\""
+      trans << " -crop \"#{crop}\" +repage" if crop
+      trans
+    end
+  end
+
+  # Due to how ImageMagick handles its image format conversion and how Tempfile
+  # handles its naming scheme, it is necessary to override how Tempfile makes
+  # its names so as to allow for file extensions. Idea taken from the comments
+  # on this blog post:
+  # http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
+  class Tempfile < ::Tempfile
+    # Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
+    def make_tmpname(basename, n)
+      extension = File.extname(basename)
+      sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
+    end
+  end
+end

data/lib/paperclip/upfile.rb

@@ -0,0 +1,33 @@
+module Paperclip
+  # The Upfile module is a convenience module for adding uploaded-file-type methods
+  # to the +File+ class. Useful for testing.
+  #   user.avatar = File.new("test/test_avatar.jpg")
+  module Upfile
+
+    # Infer the MIME-type of the file from the extension.
+    def content_type
+      type = self.path.match(/\.(\w+)$/)[1] rescue "octet-stream"
+      case type
+      when "jpg", "png", "gif" then "image/#{type}"
+      when "txt" then "text/plain"
+      when "csv", "xml", "html", "htm", "css", "js" then "text/#{type}"
+      else "x-application/#{type}"
+      end
+    end
+
+    # Returns the file's normal name.
+    def original_filename
+      File.basename(self.path)
+    end
+
+    # Returns the size of the file.
+    def size
+      File.size(self)
+    end
+  end
+
+end
+
+class File #:nodoc:
+  include Paperclip::Upfile
+end

data/paperclip.gemspec

@@ -0,0 +1,55 @@
+Gem::Specification.new do |s|
+  s.name = 'paperclip'
+  s.version = '1.0.20080704'
+  s.date = '2008-07-04'
+  
+  s.summary = "Allows easy file uploading for Rails"
+  s.description = "Paperclip is intended as an easy file attachment library for ActiveRecord. The intent behind it was to keep setup as easy as possible and to treat files as much like other attributes as possible. This means they aren't saved to their final locations on disk, nor are they deleted if set to nil, until ActiveRecord::Base#save is called. It manages validations based on size and presence, if required. It can transform its assigned image into thumbnails if needed, and the prerequisites are as simple as installing ImageMagick (which, for most modern Unix-based systems, is as easy as installing the right packages). Attached files are saved to the filesystem and referenced in the browser by an easily understandable specification, which has sensible and useful defaults."
+  
+  s.authors = ['Jon Yurek']
+  s.email = 'info@thoughtbot.com'
+  s.homepage = 'http://github.com/thoughtbot/paperclip'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["LICENSE",
+             "README",
+             "README.rdoc",
+             "Rakefile",
+             "generators/paperclip/paperclip_generator.rb",
+             "generators/paperclip/templates/paperclip_migration.rb",
+             "generators/paperclip/USAGE",
+             "init.rb",
+             "lib/paperclip/attachment.rb",
+             "lib/paperclip/geometry.rb",
+             "lib/paperclip/iostream.rb",
+             "lib/paperclip/storage.rb",
+             "lib/paperclip/thumbnail.rb",
+             "lib/paperclip/upfile.rb",
+             "lib/paperclip.rb",
+             "paperclip.gemspec",
+             "rails/init.rb",
+             "tasks/paperclip_tasks.rake"]
+  
+  s.test_files = ["test/.gitignore",
+                  "test/database.yml",
+                  "test/fixtures/12k.png",
+                  "test/fixtures/50x50.png",
+                  "test/fixtures/5k.png",
+                  "test/fixtures/bad.png",
+                  "test/fixtures/text.txt",
+                  "test/helper.rb",
+                  "test/test_attachment.rb",
+                  "test/test_geometry.rb",
+                  "test/test_integration.rb",
+                  "test/test_iostream.rb",
+                  "test/test_paperclip.rb",
+                  "test/test_storage.rb",
+                  "test/test_thumbnail.rb"]
+  
+end
+

data/rails/init.rb

@@ -0,0 +1 @@
+require 'paperclip'

data/tasks/paperclip_tasks.rake

@@ -0,0 +1,38 @@
+def obtain_class
+  class_name = ENV['CLASS'] || ENV['class']
+  raise "Must specify CLASS" unless class_name
+  @klass = Object.const_get(class_name)
+end
+
+def obtain_attachments
+  name = ENV['ATTACHMENT'] || ENV['attachment']
+  raise "Class #{@klass.name} has no attachments specified" unless @klass.respond_to?(:attachment_definitions)
+  if !name.blank? && @klass.attachment_definitions.keys.include?(name)
+    [ name ]
+  else
+    @klass.attachment_definitions.keys
+  end
+end
+
+namespace :paperclip do
+  desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)"
+  task :refresh => :environment do
+    klass     = obtain_class
+    names     = obtain_attachments
+    instances = klass.find(:all)
+    
+    puts "Regenerating thumbnails for #{instances.length} instances of #{klass.name}:"
+    instances.each do |instance|
+      names.each do |name|
+        result = if instance.send("#{ name }?")
+          instance.send(name).reprocess!
+          instance.send(name).save
+        else
+          true
+        end
+        print result ? "." : "x"; $stdout.flush
+      end
+    end
+    puts " Done."
+  end
+end

data/test/.gitignore

@@ -0,0 +1 @@
+debug.log

data/test/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  #dbfile: paperclip.db
+  database: ":memory:"
+

data/test/fixtures/bad.png

@@ -0,0 +1 @@
+This is not an image.

data/test/helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'tempfile'
+
+require 'active_record'
+begin
+  require 'ruby-debug'
+rescue LoadError
+  puts "ruby-debug not loaded"
+end
+
+ROOT       = File.join(File.dirname(__FILE__), '..')
+RAILS_ROOT = ROOT
+
+$LOAD_PATH << File.join(ROOT, 'lib')
+$LOAD_PATH << File.join(ROOT, 'lib', 'paperclip')
+
+require File.join(ROOT, 'lib', 'paperclip.rb')
+
+ENV['RAILS_ENV'] ||= 'test'
+
+FIXTURES_DIR = File.join(File.dirname(__FILE__), "fixtures") 
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['RAILS_ENV'] || 'test'])
+
+def rebuild_model options = {}
+  ActiveRecord::Base.connection.create_table :dummies, :force => true do |table|
+    table.column :other, :string
+    table.column :avatar_file_name, :string
+    table.column :avatar_content_type, :string
+    table.column :avatar_file_size, :integer
+  end
+
+  ActiveRecord::Base.send(:include, Paperclip)
+  Object.send(:remove_const, "Dummy") rescue nil
+  Object.const_set("Dummy", Class.new(ActiveRecord::Base))
+  Dummy.class_eval do
+    include Paperclip
+    has_attached_file :avatar, options
+  end
+end

data/test/test_attachment.rb

@@ -0,0 +1,286 @@
+require 'test/helper'
+
+class Dummy
+  # This is a dummy class
+end
+
+class AttachmentTest < Test::Unit::TestCase
+  context "Attachment default_options" do
+    setup do
+      rebuild_model
+      @old_default_options = Paperclip::Attachment.default_options.dup
+      @new_default_options = @old_default_options.merge({
+        :path => "argle/bargle",
+        :url => "fooferon",
+        :default_url => "not here.png"
+      })
+    end
+
+    teardown do
+      Paperclip::Attachment.default_options.merge! @old_default_options
+    end
+
+    should "be overrideable" do
+      Paperclip::Attachment.default_options.merge!(@new_default_options)
+      @new_default_options.keys.each do |key|
+        assert_equal @new_default_options[key],
+                     Paperclip::Attachment.default_options[key]
+      end
+    end
+
+    context "without an Attachment" do
+      setup do
+        @dummy = Dummy.new
+      end
+      
+      should "return false when asked exists?" do
+        assert !@dummy.avatar.exists?
+      end
+    end
+
+    context "on an Attachment" do
+      setup do
+        @dummy = Dummy.new
+        @attachment = @dummy.avatar
+      end
+
+      Paperclip::Attachment.default_options.keys.each do |key|
+        should "be the default_options for #{key}" do
+          assert_equal @old_default_options[key], 
+                       @attachment.instance_variable_get("@#{key}"),
+                       key
+        end
+      end
+
+      context "when redefined" do
+        setup do
+          Paperclip::Attachment.default_options.merge!(@new_default_options)
+          @dummy = Dummy.new
+          @attachment = @dummy.avatar
+        end
+
+        Paperclip::Attachment.default_options.keys.each do |key|
+          should "be the new default_options for #{key}" do
+            assert_equal @new_default_options[key],
+                         @attachment.instance_variable_get("@#{key}"),
+                         key
+          end
+        end
+      end
+    end
+  end
+
+  context "An attachment with similarly named interpolations" do
+    setup do
+      rebuild_model :path => ":id.omg/:id-bbq/:idwhat/:id_partition.wtf"
+      @dummy = Dummy.new
+      @dummy.stubs(:id).returns(1024)
+      @file = File.new(File.join(File.dirname(__FILE__),
+                                 "fixtures",
+                                 "5k.png"))
+      @dummy.avatar = @file
+    end
+
+    should "make sure that they are interpolated correctly" do
+      assert_equal "1024.omg/1024-bbq/1024what/000/001/024.wtf", @dummy.avatar.path
+    end
+  end
+
+  context "Assigning an attachment" do
+    setup do
+      rebuild_model
+      
+      @not_file = mock
+      @not_file.stubs(:nil?).returns(false)
+      @not_file.expects(:to_tempfile).returns(self)
+      @not_file.expects(:original_filename).returns("filename.png\r\n")
+      @not_file.expects(:content_type).returns("image/png\r\n")
+      @not_file.expects(:size).returns(10)
+      
+      @dummy = Dummy.new
+      @attachment = @dummy.avatar
+      @attachment.expects(:valid_assignment?).with(@not_file).returns(true)
+      @attachment.expects(:queue_existing_for_delete)
+      @attachment.expects(:post_process)
+      @attachment.expects(:validate)
+      @dummy.avatar = @not_file
+    end
+
+    should "strip whitespace from original_filename field" do
+      assert_equal "filename.png", @dummy.avatar.original_filename
+    end
+
+    should "strip whitespace from content_type field" do
+      assert_equal "image/png", @dummy.avatar.instance.avatar_content_type
+    end
+    
+  end
+
+  context "Attachment with strange letters" do
+    setup do
+      rebuild_model
+      
+      @not_file = mock
+      @not_file.stubs(:nil?).returns(false)
+      @not_file.expects(:to_tempfile).returns(self)
+      @not_file.expects(:original_filename).returns("sheep_say_bæ.png\r\n")
+      @not_file.expects(:content_type).returns("image/png\r\n")
+      @not_file.expects(:size).returns(10)
+      
+      @dummy = Dummy.new
+      @attachment = @dummy.avatar
+      @attachment.expects(:valid_assignment?).with(@not_file).returns(true)
+      @attachment.expects(:queue_existing_for_delete)
+      @attachment.expects(:post_process)
+      @attachment.expects(:validate)
+      @dummy.avatar = @not_file
+    end
+    
+    should "remove strange letters and replace with underscore (_)" do
+      assert_equal "sheep_say_b_.png", @dummy.avatar.original_filename
+    end
+    
+  end
+
+  context "An attachment" do
+    setup do
+      Paperclip::Attachment.default_options.merge!({
+        :path => ":rails_root/tmp/:attachment/:class/:style/:id/:basename.:extension"
+      })
+      FileUtils.rm_rf("tmp")
+      @instance = stub
+      @instance.stubs(:id).returns(41)
+      @instance.stubs(:class).returns(Dummy)
+      @instance.stubs(:[]).with(:test_file_name).returns(nil)
+      @instance.stubs(:[]).with(:test_content_type).returns(nil)
+      @instance.stubs(:[]).with(:test_file_size).returns(nil)
+      @attachment = Paperclip::Attachment.new(:test,
+                                              @instance)
+      @file = File.new(File.join(File.dirname(__FILE__),
+                                 "fixtures",
+                                 "5k.png"))
+    end
+
+    should "return its default_url when no file assigned" do
+      assert @attachment.to_file.nil?
+      assert_equal "/tests/original/missing.png", @attachment.url
+      assert_equal "/tests/blah/missing.png", @attachment.url(:blah)
+    end
+    
+    context "with a file assigned in the database" do
+      setup do
+        @instance.stubs(:[]).with(:test_file_name).returns("5k.png")
+        @instance.stubs(:[]).with(:test_content_type).returns("image/png")
+        @instance.stubs(:[]).with(:test_file_size).returns(12345)
+      end
+
+      should "return a correct url even if the file does not exist" do
+        assert_nil @attachment.to_file
+        assert_equal "/tests/41/blah/5k.png", @attachment.url(:blah)
+      end
+
+      should "return the proper path when filename has a single .'s" do
+        assert_equal "./test/../tmp/tests/dummies/original/41/5k.png", @attachment.path
+      end
+
+      should "return the proper path when filename has multiple .'s" do
+        @instance.stubs(:[]).with(:test_file_name).returns("5k.old.png")      
+        assert_equal "./test/../tmp/tests/dummies/original/41/5k.old.png", @attachment.path
+      end
+
+      context "when expecting three styles" do
+        setup do
+          styles = {:styles => { :large  => ["400x400", :png],
+                                 :medium => ["100x100", :gif],
+                                 :small => ["32x32#", :jpg]}}
+          @attachment = Paperclip::Attachment.new(:test,
+                                                  @instance,
+                                                  styles)
+        end
+
+        context "and assigned a file" do
+          setup do
+            @instance.expects(:[]=).with(:test_file_name,
+                                         File.basename(@file.path))
+            @instance.expects(:[]=).with(:test_content_type, "image/png")
+            @instance.expects(:[]=).with(:test_file_size, @file.size)
+            @instance.expects(:[]=).with(:test_file_name, nil)
+            @instance.expects(:[]=).with(:test_content_type, nil)
+            @instance.expects(:[]=).with(:test_file_size, nil)
+            @attachment.assign(@file)
+          end
+
+          should "be dirty" do
+            assert @attachment.dirty?
+          end
+
+          context "and saved" do
+            setup do
+              @attachment.save
+            end
+
+            should "return the real url" do
+              assert @attachment.to_file
+              assert_equal "/tests/41/original/5k.png", @attachment.url
+              assert_equal "/tests/41/small/5k.jpg", @attachment.url(:small)
+            end
+
+            should "commit the files to disk" do
+              [:large, :medium, :small].each do |style|
+                io = @attachment.to_io(style)
+                assert File.exists?(io)
+                assert ! io.is_a?(::Tempfile)
+              end
+            end
+
+            should "save the files as the right formats and sizes" do
+              [[:large, 400, 61, "PNG"],
+               [:medium, 100, 15, "GIF"],
+               [:small, 32, 32, "JPEG"]].each do |style|
+                cmd = "identify -format '%w %h %b %m' " + 
+                      "#{@attachment.to_io(style.first).path}"
+                out = `#{cmd}`
+                width, height, size, format = out.split(" ")
+                assert_equal style[1].to_s, width.to_s 
+                assert_equal style[2].to_s, height.to_s
+                assert_equal style[3].to_s, format.to_s
+              end
+            end
+
+            should "still have its #file attribute not be nil" do
+              assert ! @attachment.to_file.nil?
+            end
+
+            context "and deleted" do
+              setup do
+                @existing_names = @attachment.styles.keys.collect do |style|
+                  @attachment.path(style)
+                end
+                @instance.expects(:[]=).with(:test_file_name, nil)
+                @instance.expects(:[]=).with(:test_content_type, nil)
+                @instance.expects(:[]=).with(:test_file_size, nil)
+                @attachment.assign nil
+                @attachment.save
+              end
+
+              should "delete the files" do
+                @existing_names.each{|f| assert ! File.exists?(f) }
+              end
+            end
+          end
+        end
+      end
+
+    end
+
+    context "when trying a nonexistant storage type" do
+      setup do
+        rebuild_model :storage => :not_here
+      end
+
+      should "not be able to find the module" do
+        assert_raise(NameError){ Dummy.new.avatar }
+      end
+    end
+  end
+end