Class: Paperclip::Thumbnail

Inherits:
Object
  • Object
show all
Defined in:
lib/paperclip/thumbnail.rb

Overview

Handles thumbnailing images that are uploaded.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file, target_geometry, format = nil, convert_options = nil, whiny_thumbnails = true) ⇒ Thumbnail

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. If convert_options is set, the options will be appended to the convert command upon image conversion



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/paperclip/thumbnail.rb', line 13

def initialize file, target_geometry, format = nil, convert_options = nil, whiny_thumbnails = true
  @file             = file
  @crop             = target_geometry[-1,1] == '#'
  @target_geometry  = Geometry.parse target_geometry
  @current_geometry = Geometry.from_file file
  @convert_options  = convert_options
  @whiny_thumbnails = whiny_thumbnails

  @current_format   = File.extname(@file.path)
  @basename         = File.basename(@file.path, @current_format)
  
  @format = format
end

Instance Attribute Details

#convert_options ⇒ Object

Returns the value of attribute convert_options.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def convert_options
  @convert_options
end

#current_geometry ⇒ Object

Returns the value of attribute current_geometry.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def current_geometry
  @current_geometry
end

#file ⇒ Object

Returns the value of attribute file.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def file
  @file
end

#format ⇒ Object

Returns the value of attribute format.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def format
  @format
end

#target_geometry ⇒ Object

Returns the value of attribute target_geometry.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def target_geometry
  @target_geometry
end

#whiny_thumbnails ⇒ Object

Returns the value of attribute whiny_thumbnails.



5
6
7
 
# File 'lib/paperclip/thumbnail.rb', line 5

def whiny_thumbnails
  @whiny_thumbnails
end

Class Method Details

.make(file, dimensions, format = nil, convert_options = nil, whiny_thumbnails = true) ⇒ Object

Creates a thumbnail, as specified in initialize, makes it, and returns the resulting Tempfile.



29
30
31
 
# File 'lib/paperclip/thumbnail.rb', line 29

def self.make file, dimensions, format = nil, convert_options = nil, whiny_thumbnails = true
  new(file, dimensions, format, convert_options, whiny_thumbnails).make
end

Instance Method Details

#convert_options? ⇒ Boolean

Returns true if the image is meant to make use of additional convert options.

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/paperclip/thumbnail.rb', line 39

def convert_options?
  not @convert_options.blank?
end

#crop? ⇒ Boolean

Returns true if the target_geometry is meant to crop.

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/paperclip/thumbnail.rb', line 34

def crop?
  @crop
end

#make ⇒ Object

Performs the conversion of the file into a thumbnail. Returns the Tempfile that contains the new image.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/paperclip/thumbnail.rb', line 45

def make
  src = @file
  dst = Tempfile.new([@basename, @format].compact.join("."))
  dst.binmode

  command = <<-end_command
    "#{ File.expand_path(src.path) }[0]"
    #{ transformation_command }
    "#{ File.expand_path(dst.path) }"
  end_command

  begin
    success = Paperclip.run("convert", command.gsub(/\s+/, " "))
  rescue PaperclipCommandLineError
    raise PaperclipError, "There was an error processing the thumbnail for #{@basename}" if @whiny_thumbnails
  end

  dst
end

#transformation_command ⇒ Object

Returns the command ImageMagick’s convert needs to transform the image into the thumbnail.



67
68
69
70
71
72
73
 
# File 'lib/paperclip/thumbnail.rb', line 67

def transformation_command
  scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
  trans = "-resize \"#{scale}\""
  trans << " -crop \"#{crop}\" +repage" if crop
  trans << " #{convert_options}" if convert_options?
  trans
end