Class: Paperclip::Geometry

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

Overview

Defines the geometry of an image.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(width = nil, height = nil, modifier = nil) ⇒ Geometry

Gives a Geometry representing the given height and width



8
9
10
11
12
 
# File 'lib/paperclip/geometry.rb', line 8

def initialize width = nil, height = nil, modifier = nil
  @height = height.to_f
  @width  = width.to_f
  @modifier = modifier
end

Instance Attribute Details

#height ⇒ Object

Returns the value of attribute height.



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

def height
  @height
end

#modifier ⇒ Object

Returns the value of attribute modifier.



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

def modifier
  @modifier
end

#width ⇒ Object

Returns the value of attribute width.



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

def width
  @width
end

Class Method Details

.from_file(file) ⇒ Object

Uses ImageMagick to determing the dimensions of a file, passed in as either a File or path. NOTE: (race cond) Do not reassign the ‘file’ variable inside this method as it is likely to be a Tempfile object, which would be eligible for file deletion when no longer referenced.

Raises:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/paperclip/geometry.rb', line 18

def self.from_file file
  file_path = file.respond_to?(:path) ? file.path : file
  raise(Errors::NotIdentifiedByImageMagickError.new("Cannot find the geometry of a file with a blank name")) if file_path.blank?
  geometry = begin
               silence_stream(STDERR) do
                 Paperclip.run("identify", "-format %wx%h :file", :file => "#{file_path}[0]")
               end
             rescue Cocaine::ExitStatusError
               ""
             rescue Cocaine::CommandNotFoundError => e
               raise Errors::CommandNotFoundError.new("Could not run the `identify` command. Please install ImageMagick.")
             end
  parse(geometry) ||
    raise(Errors::NotIdentifiedByImageMagickError.new("#{file_path} is not recognized by the 'identify' command."))
end

.parse(string) ⇒ Object

Parses a “WxH” formatted string, where W is the width and H is the height.



35
36
37
38
39
 
# File 'lib/paperclip/geometry.rb', line 35

def self.parse string
  if match = (string && string.match(/\b(\d*)x?(\d*)\b([\>\<\#\@\%^!])?/i))
    Geometry.new(*match[1,3])
  end
end

Instance Method Details

#aspect ⇒ Object

The aspect ratio of the dimensions.



57
58
59
 
# File 'lib/paperclip/geometry.rb', line 57

def aspect
  width / height
end

#horizontal? ⇒ Boolean

True if the dimensions represent a horizontal rectangle

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/paperclip/geometry.rb', line 47

def horizontal?
  height < width
end

#inspect ⇒ Object

Same as to_s



81
82
83
 
# File 'lib/paperclip/geometry.rb', line 81

def inspect
  to_s
end

#larger ⇒ Object

Returns the larger of the two dimensions



62
63
64
 
# File 'lib/paperclip/geometry.rb', line 62

def larger
  [height, width].max
end

#smaller ⇒ Object

Returns the smaller of the two dimensions



67
68
69
 
# File 'lib/paperclip/geometry.rb', line 67

def smaller
  [height, width].min
end

#square? ⇒ Boolean

True if the dimensions represent a square

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/paperclip/geometry.rb', line 42

def square?
  height == width
end

#to_s ⇒ Object

Returns the width and height in a format suitable to be passed to Geometry.parse



72
73
74
75
76
77
78
 
# File 'lib/paperclip/geometry.rb', line 72

def to_s
  s = ""
  s << width.to_i.to_s if width > 0
  s << "x#{height.to_i}" if height > 0
  s << modifier.to_s
  s
end

#transformation_to(dst, crop = false) ⇒ Object

Returns the scaling and cropping geometries (in string-based ImageMagick format) neccessary to transform this Geometry into the Geometry given. If crop is true, then it is assumed the destination Geometry will be the exact final resolution. In this case, the source Geometry is scaled so that an image containing the destination Geometry would be completely filled by the source image, and any overhanging image would be cropped. Useful for square thumbnail images. The cropping is weighted at the center of the Geometry.



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/paperclip/geometry.rb', line 92

def transformation_to dst, crop = false
  if crop
    ratio = Geometry.new( dst.width / self.width, dst.height / self.height )
    scale_geometry, scale = scaling(dst, ratio)
    crop_geometry         = cropping(dst, ratio, scale)
  else
    scale_geometry        = dst.to_s
  end

  [ scale_geometry, crop_geometry ]
end

#vertical? ⇒ Boolean

True if the dimensions represent a vertical rectangle

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/paperclip/geometry.rb', line 52

def vertical?
  height > width
end