Class: MiniMagick::Image

Inherits:
Object
  • Object
show all
Defined in:
lib/mini_magick/image.rb,
lib/mini_magick/image/info.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input_path, tempfile = nil) {|MiniMagick::Tool::Mogrify| ... } ⇒ Image

Create a new MiniMagick::Image object.

DANGER: The file location passed in here is the working copy. That is, it gets modified. You can either copy it yourself or use open which creates a temporary file for you and protects your original.

Parameters:

  • input_path (String)

    The location of an image file

Yields:



148
149
150
151
152
153
154
# File 'lib/mini_magick/image.rb', line 148

def initialize(input_path, tempfile = nil, &block)
  @path = input_path
  @tempfile = tempfile
  @info = MiniMagick::Image::Info.new(@path)

  combine_options(&block) if block
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ self

If an unknown method is called then it is sent through the mogrify program.



391
392
393
394
395
# File 'lib/mini_magick/image.rb', line 391

def method_missing(name, *args)
  mogrify do |builder|
    builder.send(name, *args)
  end
end

Instance Attribute Details

#colorspaceString (readonly)

Returns:

  • (String)


240
# File 'lib/mini_magick/image.rb', line 240

attribute :colorspace

#detailsHash (readonly)

Returns the information from identify -verbose in a Hash format.

Returns:

  • (Hash)


271
# File 'lib/mini_magick/image.rb', line 271

attribute :details

#dimensionsArray<Integer> (readonly)

Returns:

  • (Array<Integer>)


224
# File 'lib/mini_magick/image.rb', line 224

attribute :dimensions

#exifHash (readonly)

Returns:

  • (Hash)


244
# File 'lib/mini_magick/image.rb', line 244

attribute :exif

#heightInteger (readonly)

Returns:

  • (Integer)


220
# File 'lib/mini_magick/image.rb', line 220

attribute :height

#human_sizeString (readonly)

Returns the file size in a human readable format.

Returns:

  • (String)


236
# File 'lib/mini_magick/image.rb', line 236

attribute :human_size

#mime_typeString (readonly)

Returns:

  • (String)


212
# File 'lib/mini_magick/image.rb', line 212

attribute :mime_type

#pathString (readonly)

Returns The location of the current working file

Returns:

  • (String)

    The location of the current working file



135
136
137
# File 'lib/mini_magick/image.rb', line 135

def path
  @path
end

#resolutionArray<Integer> (readonly)

Returns the resolution of the photo. You can optionally specify the units measurement.

Examples:

image.resolution("PixelsPerInch") #=> [250, 250]

Returns:

  • (Array<Integer>)

See Also:



254
# File 'lib/mini_magick/image.rb', line 254

attribute :resolution

#signatureString (readonly)

Returns the message digest of this image as a SHA-256, hexidecimal encoded string. This signature uniquely identifies the image and is convenient for determining if an image has been modified or whether two images are identical.

Examples:

image.signature #=> "60a7848c4ca6e36b8e2c5dea632ecdc29e9637791d2c59ebf7a54c0c6a74ef7e"

Returns:

  • (String)

See Also:



266
# File 'lib/mini_magick/image.rb', line 266

attribute :signature

#sizeInteger (readonly)

Returns the file size of the image (in bytes).

Returns:

  • (Integer)


230
# File 'lib/mini_magick/image.rb', line 230

attribute :size

#typeString (readonly)

Returns the image format (e.g. "JPEG", "GIF").

Returns:

  • (String)


208
# File 'lib/mini_magick/image.rb', line 208

attribute :type, "format"

#widthInteger (readonly)

Returns:

  • (Integer)


216
# File 'lib/mini_magick/image.rb', line 216

attribute :width

Class Method Details

.create(ext = nil, validate = MiniMagick.validate_on_create) {|Tempfile| ... } ⇒ MiniMagick::Image

Used to create a new Image object data-copy. Not used to "paint" or that kind of thing.

Takes an extension in a block and can be used to build a new Image object. Used by both open and read to create a new object. Ensures we have a good tempfile.

Parameters:

  • ext (String) (defaults to: nil)

    Specify the extension you want to read it as

  • validate (Boolean) (defaults to: MiniMagick.validate_on_create)

    If false, skips validation of the created image. Defaults to true.

Yields:

  • (Tempfile)

    You can #write bits to this object to create the new Image

Returns:



109
110
111
112
113
114
115
# File 'lib/mini_magick/image.rb', line 109

def self.create(ext = nil, validate = MiniMagick.validate_on_create, &block)
  tempfile = MiniMagick::Utilities.tempfile(ext.to_s.downcase, &block)

  new(tempfile.path, tempfile).tap do |image|
    image.validate! if validate
  end
end

.import_pixels(blob, columns, rows, depth, map, format = 'png') ⇒ MiniMagick::Image

Creates an image object from a binary string blob which contains raw pixel data (i.e. no header data).

Defaults to 'png'.

Parameters:

  • blob (String)

    Binary string blob containing raw pixel data.

  • columns (Integer)

    Number of columns.

  • rows (Integer)

    Number of rows.

  • depth (Integer)

    Bit depth of the encoded pixel data.

  • map (String)

    A code for the mapping of the pixel data. Example: 'gray' or 'rgb'.

  • format (String) (defaults to: 'png')

    The file extension of the image format to be used when creating the image object.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/mini_magick/image.rb', line 52

def self.import_pixels(blob, columns, rows, depth, map, format = 'png')
  # Create an image object with the raw pixel data string:
  create(".dat", false) { |f| f.write(blob) }.tap do |image|
    output_path = image.path.sub(/\.\w+$/, ".#{format}")
    # Use ImageMagick to convert the raw data file to an image file of the
    # desired format:
    MiniMagick::Tool::Convert.new do |convert|
      convert.size "#{columns}x#{rows}"
      convert.depth depth
      convert << "#{map}:#{image.path}"
      convert << output_path
    end

    image.path.replace output_path
  end
end

.open(path_or_url, ext = nil) ⇒ MiniMagick::Image

Opens a specific image file either on the local file system or at a URI. Use this if you don't want to overwrite the image file.

Extension is either guessed from the path or you can specify it as a second parameter.

Parameters:

  • path_or_url (String)

    Either a local file path or a URL that open-uri can read

  • ext (String) (defaults to: nil)

    Specify the extension you want to read it as

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/mini_magick/image.rb', line 81

def self.open(path_or_url, ext = nil)
  ext ||=
    if File.exist?(path_or_url)
      File.extname(path_or_url)
    else
      File.extname(URI(path_or_url).path)
    end

  Kernel.open(path_or_url, "rb") do |file|
    read(file, ext)
  end
end

.read(stream, ext = nil) ⇒ MiniMagick::Image

This is the primary loading method used by all of the other class methods.

Use this to pass in a stream object. Must respond to #read(size) or be a binary string object (BLOBBBB)

Probably easier to use the open method if you want to open a file or a URL.

Parameters:

  • stream (#read, String)

    Some kind of stream object that needs to be read or is a binary String blob

  • ext (String) (defaults to: nil)

    A manual extension to use for reading the file. Not required, but if you are having issues, give this a try.

Returns:



29
30
31
32
33
34
35
# File 'lib/mini_magick/image.rb', line 29

def self.read(stream, ext = nil)
  if stream.is_a?(String)
    stream = StringIO.new(stream)
  end

  create(ext) { |file| IO.copy_stream(stream, file) }
end

Instance Method Details

#[](value) ⇒ String Also known as: info

Use this method if you want to access raw Identify's format API.

Examples:

image["%w %h"]       #=> "250 450"
image["%r"]          #=> "DirectClass sRGB"

Parameters:

  • value (String)

Returns:

  • (String)

See Also:



284
285
286
# File 'lib/mini_magick/image.rb', line 284

def [](value)
  @info[value.to_s]
end

#collapse!(frame = 0) ⇒ self

Collapse images with sequences to the first frame (i.e. animated gifs) and preserve quality.

Parameters:

  • frame (Integer) (defaults to: 0)

    The frame to which to collapse to, defaults to 0.

Returns:

  • (self)


458
459
460
# File 'lib/mini_magick/image.rb', line 458

def collapse!(frame = 0)
  mogrify(frame) { |builder| builder.quality(100) }
end

#combine_options {|MiniMagick::Tool::Mogrify| ... } ⇒ self

You can use multiple commands together using this method. Very easy to use!

Examples:

image.combine_options do |c|
  c.draw "image Over 0,0 10,10 '#{MINUS_IMAGE_PATH}'"
  c.thumbnail "300x500>"
  c.background "blue"
end

Yields:

Returns:

  • (self)

See Also:



380
381
382
# File 'lib/mini_magick/image.rb', line 380

def combine_options(&block)
  mogrify(&block)
end

#composite(other_image, output_extension = type.downcase, mask = nil) ⇒ Object

Examples:

first_image = MiniMagick::Image.open "first.jpg"
second_image = MiniMagick::Image.open "second.jpg"
result = first_image.composite(second_image) do |c|
  c.compose "Over" # OverCompositeOp
  c.geometry "+20+20" # copy second_image onto first_image from (20, 20)
end
result.write "output.jpg"

See Also:



437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/mini_magick/image.rb', line 437

def composite(other_image, output_extension = type.downcase, mask = nil)
  output_tempfile = MiniMagick::Utilities.tempfile(".#{output_extension}")

  MiniMagick::Tool::Composite.new do |composite|
    yield composite if block_given?
    composite << other_image.path
    composite << path
    composite << mask.path if mask
    composite << output_tempfile.path
  end

  Image.new(output_tempfile.path, output_tempfile)
end

#destroy!Object

Destroys the tempfile (created by open) if it exists.



465
466
467
# File 'lib/mini_magick/image.rb', line 465

def destroy!
  @tempfile.unlink if @tempfile
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean)


156
157
158
159
# File 'lib/mini_magick/image.rb', line 156

def eql?(other)
  self.class.equal?(other.class) &&
    signature == other.signature
end

#format(format, page = 0) {|MiniMagick::Tool::Convert| ... } ⇒ self

This is used to change the format of the image. That is, from "tiff to jpg" or something like that. Once you run it, the instance is pointing to a new file with a new extension!

DANGER: This renames the file that the instance is pointing to. So, if you manually opened the file with Image.new(file_path)... Then that file is DELETED! If you used Image.open(file) then you are OK. The original file will still be there. But, any changes to it might not be...

Formatting an animation into a non-animated type will result in ImageMagick creating multiple pages (starting with 0). You can choose which page you want to manipulate. We default to the first page.

If you would like to convert between animated formats, pass nil as your page and ImageMagick will copy all of the pages.

Parameters:

  • format (String)

    The target format... Like 'jpg', 'gif', 'tiff' etc.

  • page (Integer) (defaults to: 0)

    If this is an animated gif, say which 'page' you want with an integer. Default 0 will convert only the first page; 'nil' will convert all pages.

Yields:

Returns:

  • (self)


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/mini_magick/image.rb', line 334

def format(format, page = 0)
  if @tempfile
    new_tempfile = MiniMagick::Utilities.tempfile(".#{format}")
    new_path = new_tempfile.path
  else
    new_path = path.sub(/(\.\w+)?$/, ".#{format}")
    new_path.sub!(/\[(\d+)\]/, '_\1') if layer?
  end

  input_path = path.dup
  input_path << "[#{page}]" if page && !layer?

  MiniMagick::Tool::Convert.new do |convert|
    convert << input_path
    yield convert if block_given?
    convert << new_path
  end

  if @tempfile
    @tempfile.unlink
    @tempfile = new_tempfile
  else
    File.delete(path) unless path == new_path || layer?
  end

  path.replace new_path
  @info.clear

  self
end

#hashObject



162
163
164
# File 'lib/mini_magick/image.rb', line 162

def hash
  signature.hash
end

#identify {|MiniMagick::Tool::Identify| ... } ⇒ String

Runs identify on itself. Accepts an optional block for adding more options to identify.

Examples:

image = MiniMagick::Image.open("image.jpg")
image.identify do |b|
  b.verbose
end # runs `identify -verbose image.jpg`

Yields:

Returns:

  • (String)

    Output from identify



481
482
483
484
485
486
# File 'lib/mini_magick/image.rb', line 481

def identify
  MiniMagick::Tool::Identify.new do |builder|
    yield builder if block_given?
    builder << path
  end
end

#layer?Boolean

Returns:

  • (Boolean)


514
515
516
# File 'lib/mini_magick/image.rb', line 514

def layer?
  path =~ /\[\d+\]$/
end

#layersArray<MiniMagick::Image> Also known as: pages, frames

Returns layers of the image. For example, JPEGs are 1-layered, but formats like PSDs, GIFs and PDFs can have multiple layers/frames/pages.

Examples:

image = MiniMagick::Image.new("document.pdf")
image.pages.each_with_index do |page, idx|
  page.write("page#{idx}.pdf")
end

Returns:



300
301
302
303
304
305
# File 'lib/mini_magick/image.rb', line 300

def layers
  layers_count = identify.lines.count
  layers_count.times.map do |idx|
    MiniMagick::Image.new("#{path}[#{idx}]")
  end
end

#mogrify(page = nil) ⇒ Object



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'lib/mini_magick/image.rb', line 497

def mogrify(page = nil)
  MiniMagick::Tool::Mogrify.new do |builder|
    builder.instance_eval do
      def format(*args)
        fail NoMethodError,
          "you must call #format on a MiniMagick::Image directly"
      end
    end
    yield builder if block_given?
    builder << (page ? "#{path}[#{page}]" : path)
  end

  @info.clear

  self
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)


397
398
399
# File 'lib/mini_magick/image.rb', line 397

def respond_to_missing?(method_name, include_private = false)
  MiniMagick::Tool::Mogrify.option_methods.include?(method_name.to_s)
end

#to_blobString

Returns raw image data.

Returns:

  • (String)

    Binary string



171
172
173
# File 'lib/mini_magick/image.rb', line 171

def to_blob
  File.binread(path)
end

#valid?Boolean

Checks to make sure that MiniMagick can read the file and understand it.

This uses the 'identify' command line utility to check the file. If you are having issues with this, then please work directly with the 'identify' command and see if you can figure out what the issue is.

Returns:

  • (Boolean)


184
185
186
187
188
189
# File 'lib/mini_magick/image.rb', line 184

def valid?
  validate!
  true
rescue MiniMagick::Invalid
  false
end

#validate!Object

Runs identify on the current image, and raises an error if it doesn't pass.



197
198
199
200
201
# File 'lib/mini_magick/image.rb', line 197

def validate!
  identify
rescue MiniMagick::Error => error
  raise MiniMagick::Invalid, error.message
end

#write(output_to) ⇒ Object

Writes the temporary file out to either a file location (by passing in a String) or by passing in a Stream that you can #write(chunk) to repeatedly

Parameters:

  • output_to (String, Pathname, #read)

    Some kind of stream object that needs to be read or a file path as a String



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/mini_magick/image.rb', line 409

def write(output_to)
  case output_to
  when String, Pathname
    if layer?
      MiniMagick::Tool::Convert.new do |builder|
        builder << path
        builder << output_to
      end
    else
      FileUtils.copy_file path, output_to unless path == output_to.to_s
    end
  else
    IO.copy_stream File.open(path, "rb"), output_to
  end
end