mini_magick 4.10.1 → 4.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29b57b7ad13279ad3a6cdef274c7b9cc6efd5c509db5f6bd826e6affe6364081
-  data.tar.gz: e958f807b9d779f94e502786510b656948d3ecbb9f89c2539ff0aa11afd0079e
+  metadata.gz: 44b0562f09fa6d0cc281ad1c4317b8e9915aa60dc6175072dc0cdc872f3d8367
+  data.tar.gz: 96225cd5bd66e3c0c065cb169057e196becfcdd1e0c883cb7c23f746d76bcda6
 SHA512:
-  metadata.gz: 71843702fea5e44a8ef160c03af2319b6cce43d8191201056fff1a32e9297c3045e0c2cb15a6611243c4ab0ed9f8883a4f1669ef570c8da659e1c1a17d3e922f
-  data.tar.gz: 5cb059a1319aa29750ec2e5e46d04b5b9256b2ca4896a72f28ca94594df573a16d607f35558fc49b00f9839b4e8553df94788e24842f43b18aaa10d9ec39c7e7
+  metadata.gz: a39cb409419be063b9cc27fd107a361d94d3f5dbdad719ed1f472efca70650c710160494f22b18f1408df479f29836d29c2bd71262ad1988cdf22caf85a9251a
+  data.tar.gz: dbb5ba23b0b773a696812ec343f0d267aee1653b0ebfb61ea9560af9c4cac68352b7c936c57233913d8848a1de3c9fe02e31070a94e5f3f0d7f471e444615a55

data/README.md

@@ -0,0 +1,573 @@
+# MiniMagick
+[![Gem Version](https://img.shields.io/gem/v/mini_magick.svg)](http://rubygems.org/gems/mini_magick)
+[![Gem Downloads](https://img.shields.io/gem/dt/mini_magick.svg)](http://rubygems.org/gems/mini_magick)
+[![CI](https://github.com/minimagick/minimagick/actions/workflows/ci.yml/badge.svg)](https://github.com/minimagick/minimagick/actions/workflows/ci.yml)
+[![Code Climate](https://codeclimate.com/github/minimagick/minimagick/badges/gpa.svg)](https://codeclimate.com/github/minimagick/minimagick)
+
+A ruby wrapper for [ImageMagick](http://imagemagick.org/) or
+[GraphicsMagick](http://www.graphicsmagick.org/) command line.
+
+## Why?
+
+I was using [RMagick](https://github.com/rmagick/rmagick) and loving it, but it
+was eating up huge amounts of memory. Even a simple script would use over 100MB
+of RAM. On my local machine this wasn't a problem, but on my hosting server the
+ruby apps would crash because of their 100MB memory limit.
+
+## Solution!
+
+Using MiniMagick the ruby processes memory remains small (it spawns
+ImageMagick's command line program mogrify which takes up some memory as well,
+but is much smaller compared to RMagick). See [Thinking of switching from
+RMagick?](#thinking-of-switching-from-rmagick) below.
+
+MiniMagick gives you access to all the command line options ImageMagick has
+(found [here](http://www.imagemagick.org/script/command-line-options.php)).
+
+## Requirements
+
+ImageMagick or GraphicsMagick command-line tool has to be installed. You can
+check if you have it installed by running
+
+```sh
+$ magick -version
+Version: ImageMagick 7.1.1-33 Q16-HDRI aarch64 22263 https://imagemagick.org
+Copyright: (C) 1999 ImageMagick Studio LLC
+License: https://imagemagick.org/script/license.php
+Features: Cipher DPC HDRI Modules OpenMP(5.0)
+Delegates (built-in): bzlib fontconfig freetype gslib heic jng jp2 jpeg jxl lcms lqr ltdl lzma openexr png ps raw tiff webp xml zlib zstd
+Compiler: gcc (4.2)
+```
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```rb
+gem "mini_magick"
+```
+
+## Information
+
+* [API documentation](http://rubydoc.info/github/minimagick/minimagick)
+
+## Usage
+
+Let's first see a basic example of resizing an image.
+
+```rb
+require "mini_magick"
+
+image = MiniMagick::Image.open("input.jpg")
+image.path #=> "/var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/magick20140921-75881-1yho3zc.jpg"
+image.resize "100x100"
+image.format "png"
+image.write "output.png"
+```
+
+`MiniMagick::Image.open` makes a copy of the image, and further methods modify
+that copy (the original stays untouched). We then
+[resize](http://www.imagemagick.org/script/command-line-options.php#resize)
+the image, and write it to a file. The writing part is necessary because
+the copy is just temporary, it gets garbage collected when we lose reference
+to the image.
+
+`MiniMagick::Image.open` also accepts URLs, and options passed in will be
+forwarded to open-uri.
+
+```rb
+image = MiniMagick::Image.open("http://example.com/image.jpg")
+image.contrast
+image.write("from_internets.jpg")
+```
+
+On the other hand, if we want the original image to actually *get* modified,
+we can use `MiniMagick::Image.new`.
+
+```rb
+image = MiniMagick::Image.new("input.jpg")
+image.path #=> "input.jpg"
+image.resize "100x100"
+# Not calling #write, because it's not a copy
+```
+
+### Combine options
+
+While using methods like `#resize` directly is convenient, if we use more
+methods in this way, it quickly becomes inefficient, because it calls the
+command on each methods call. `MiniMagick::Image#combine_options` takes
+multiple options and from them builds one single command.
+
+```rb
+image.combine_options do |b|
+  b.resize "250x200>"
+  b.rotate "-90"
+  b.flip
+end # the command gets executed
+```
+
+As a handy shortcut, `MiniMagick::Image.new` also accepts an optional block
+which is used to `combine_options`.
+
+```rb
+image = MiniMagick::Image.new("input.jpg") do |b|
+  b.resize "250x200>"
+  b.rotate "-90"
+  b.flip
+end # the command gets executed
+```
+
+The yielded builder is an instance of `MiniMagick::Tool::Mogrify`. To learn more
+about its interface, see [Metal](#metal) below.
+
+### Attributes
+
+A `MiniMagick::Image` has various handy attributes.
+
+```rb
+image.type        #=> "JPEG"
+image.mime_type   #=> "image/jpeg"
+image.width       #=> 250
+image.height      #=> 300
+image.dimensions  #=> [250, 300]
+image.size        #=> 3451 (in bytes)
+image.colorspace  #=> "DirectClass sRGB"
+image.exif        #=> {"DateTimeOriginal" => "2013:09:04 08:03:39", ...}
+image.resolution  #=> [75, 75]
+image.signature   #=> "60a7848c4ca6e36b8e2c5dea632ecdc29e9637791d2c59ebf7a54c0c6a74ef7e"
+```
+
+If you need more control, you can also access [raw image
+attributes](http://www.imagemagick.org/script/escape.php):
+
+```rb
+image["%[gamma]"] # "0.9"
+```
+
+To get the all information about the image, MiniMagick gives you a handy method
+which returns the output from `identify -verbose` in hash format:
+
+```rb
+image.data #=>
+# {
+#   "format": "JPEG",
+#   "mimeType": "image/jpeg",
+#   "class": "DirectClass",
+#   "geometry": {
+#     "width": 200,
+#     "height": 276,
+#     "x": 0,
+#     "y": 0
+#   },
+#   "resolution": {
+#     "x": "300",
+#     "y": "300"
+#   },
+#   "colorspace": "sRGB",
+#   "channelDepth": {
+#     "red": 8,
+#     "green": 8,
+#     "blue": 8
+#   },
+#   "quality": 92,
+#   "properties": {
+#     "date:create": "2016-07-11T19:17:53+08:00",
+#     "date:modify": "2016-07-11T19:17:53+08:00",
+#     "exif:ColorSpace": "1",
+#     "exif:ExifImageLength": "276",
+#     "exif:ExifImageWidth": "200",
+#     "exif:ExifOffset": "90",
+#     "exif:Orientation": "1",
+#     "exif:ResolutionUnit": "2",
+#     "exif:XResolution": "300/1",
+#     "exif:YResolution": "300/1",
+#     "icc:copyright": "Copyright (c) 1998 Hewlett-Packard Company",
+#     "icc:description": "sRGB IEC61966-2.1",
+#     "icc:manufacturer": "IEC http://www.iec.ch",
+#     "icc:model": "IEC 61966-2.1 Default RGB colour space - sRGB",
+#     "jpeg:colorspace": "2",
+#     "jpeg:sampling-factor": "1x1,1x1,1x1",
+#     "signature": "1b2336f023e5be4a9f357848df9803527afacd4987ecc18c4295a272403e52c1"
+#   },
+#   ...
+# }
+```
+
+Note that `MiniMagick::Image#data` is supported only on ImageMagick 6.8.8-3 or
+above, for GraphicsMagick or older versions of ImageMagick use
+`MiniMagick::Image#details`.
+
+### Pixels
+
+With MiniMagick you can retrieve a matrix of image pixels, where each member of
+the matrix is a 3-element array of numbers between 0-255, one for each range of
+the RGB color channels.
+
+```rb
+image = MiniMagick::Image.open("image.jpg")
+pixels = image.get_pixels
+pixels[3][2][1] # the green channel value from the 4th-row, 3rd-column pixel
+```
+
+It can also be called after applying transformations:
+
+```rb
+image = MiniMagick::Image.open("image.jpg")
+image.crop "20x30+10+5"
+image.colorspace "Gray"
+pixels = image.get_pixels
+```
+
+### Pixels To Image
+
+Sometimes when you have pixels and want to create image from pixels, you can do this to form an image:
+```rb
+image = MiniMagick::Image.open('/Users/rabin/input.jpg')
+pixels = image.get_pixels
+depth = 8
+dimension = [image.width, image.height]
+map = 'rgb'
+image = MiniMagick::Image.get_image_from_pixels(pixels, dimension, map, depth ,'jpg')
+image.write('/Users/rabin/output.jpg')
+
+```
+
+In this example, the returned pixels should now have equal R, G, and B values.
+
+### Configuration
+
+```rb
+MiniMagick.configure do |config|
+  config.cli = :graphicsmagick
+  config.timeout = 5
+end
+```
+
+For a complete list of configuration options, see
+[Configuration](http://rubydoc.info/github/minimagick/minimagick/MiniMagick/Configuration).
+
+### Composite
+
+MiniMagick also allows you to
+[composite](http://www.imagemagick.org/script/composite.php) images:
+
+```rb
+first_image  = MiniMagick::Image.new("first.jpg")
+second_image = MiniMagick::Image.new("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"
+```
+
+### Layers/Frames/Pages
+
+For multilayered images you can access its layers.
+
+```rb
+gif.frames #=> [...]
+pdf.pages  #=> [...]
+psd.layers #=> [...]
+
+gif.frames.each_with_index do |frame, idx|
+  frame.write("frame#{idx}.jpg")
+end
+```
+
+### Image validation
+
+By default, MiniMagick validates images each time it's opening them. It
+validates them by running `identify` on them, and see if ImageMagick finds
+them valid. This adds slight overhead to the whole processing. Sometimes it's
+safe to assume that all input and output images are valid by default and turn
+off validation:
+
+```rb
+MiniMagick.configure do |config|
+  config.validate_on_create = false
+end
+```
+
+You can test whether an image is valid:
+
+```rb
+image.valid?
+image.validate! # raises MiniMagick::Invalid if image is invalid
+```
+
+### Logging
+
+You can choose to log MiniMagick commands and their execution times:
+
+```rb
+MiniMagick.logger.level = Logger::DEBUG
+```
+```
+D, [2016-03-19T07:31:36.755338 #87191] DEBUG -- : [0.01s] identify /var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/mini_magick20160319-87191-1ve31n1.jpg
+```
+
+In Rails you'll probably want to set `MiniMagick.logger = Rails.logger`.
+
+### Switching CLIs (ImageMagick \<=\> GraphicsMagick)
+
+Default CLI is ImageMagick, but if you want to use GraphicsMagick, you can
+specify it in configuration:
+
+```rb
+MiniMagick.configure do |config|
+  config.cli = :graphicsmagick # or :imagemagick or :imagemagick7
+end
+```
+
+You can also use `.with_cli` to temporary switch the CLI:
+
+```rb
+MiniMagick.with_cli(:graphicsmagick) do
+  # Some processing that GraphicsMagick is better at
+end
+```
+
+**WARNING**: If you're building a multithreaded web application, you should
+change the CLI only on application startup. This is because the configuration is
+global, so if you change it in a controller action, other threads in the same
+process will also have their CLI changed, which could lead to race conditions.
+
+### Metal
+
+If you want to be close to the metal, you can use ImageMagick's command-line
+tools directly.
+
+```rb
+MiniMagick::Tool::Magick.new do |magick|
+  magick << "input.jpg"
+  magick.resize("100x100")
+  magick.negate
+  magick << "output.jpg"
+end #=> `magick input.jpg -resize 100x100 -negate output.jpg`
+
+# OR
+
+convert = MiniMagick::Tool::Convert.new
+convert << "input.jpg"
+convert.resize("100x100")
+convert.negate
+convert << "output.jpg"
+convert.call #=> `convert input.jpg -resize 100x100 -negate output.jpg`
+```
+
+If you're on ImageMagick 7, you should probably use `MiniMagick::Tool::Magick`,
+though the legacy `MiniMagick::Tool::Convert` and friends will work too. On
+ImageMagick 6 `MiniMagick::Tool::Magick` won't be available, so you should
+instead use `MiniMagick::Tool::Convert` and friends.
+
+This way of using MiniMagick is highly recommended if you want to maximize
+performance of your image processing. We will now show the features available.
+
+#### Appending
+
+The most basic way of building a command is appending strings:
+
+```rb
+MiniMagick::Tool::Magick.new do |convert|
+  convert << "input.jpg"
+  convert.merge! ["-resize", "500x500", "-negate"]
+  convert << "output.jpg"
+end
+```
+
+Note that it is important that every command you would pass to the command line
+has to be separated with `<<`, e.g.:
+
+```rb
+# GOOD
+convert << "-resize" << "500x500"
+
+# BAD
+convert << "-resize 500x500"
+```
+
+Shell escaping is also handled for you. If an option has a value that has
+spaces inside it, just pass it as a regular string.
+
+```rb
+convert << "-distort"
+convert << "Perspective"
+convert << "0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35"
+```
+```
+convert -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35'
+```
+
+#### Methods
+
+Instead of passing in options directly, you can use Ruby methods:
+
+```rb
+convert.resize("500x500")
+convert.rotate(90)
+convert.distort("Perspective", "0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35")
+```
+
+MiniMagick knows which options each tool has, so you will get an explicit
+`NoMethodError` if you happen to have misspelled an option.
+
+#### Chaining
+
+Every method call returns `self`, so you can chain them to create logical groups.
+
+```rb
+MiniMagick::Tool::Magick.new do |convert|
+  convert << "input.jpg"
+  convert.clone(0).background('gray').shadow('80x5+5+5')
+  convert.negate
+  convert << "output.jpg"
+end
+```
+
+#### "Plus" options
+
+```rb
+MiniMagick::Tool::Magick.new do |convert|
+  convert << "input.jpg"
+  convert.repage.+
+  convert.distort.+("Perspective", "more args")
+end
+```
+```
+convert input.jpg +repage +distort Perspective 'more args'
+```
+
+#### Stacks
+
+```rb
+MiniMagick::Tool::Magick.new do |convert|
+  convert << "wand.gif"
+
+  convert.stack do |stack|
+    stack << "wand.gif"
+    stack.rotate(30)
+    stack.foo("bar", "baz")
+  end
+  # or
+  convert.stack("wand.gif", { rotate: 30, foo: ["bar", "baz"] })
+
+  convert << "images.gif"
+end
+```
+```
+convert wand.gif \( wand.gif -rotate 90 -foo bar baz \) images.gif
+```
+
+#### STDIN and STDOUT
+
+If you want to pass something to standard input, you can pass the `:stdin`
+option to `#call`:
+
+```rb
+identify = MiniMagick::Tool::Identify.new
+identify.stdin # alias for "-"
+identify.call(stdin: image_content)
+```
+
+MiniMagick also has `#stdout` alias for "-" for outputting file contents to
+standard output:
+
+```rb
+content = MiniMagick::Tool::Magick.new do |convert|
+  convert << "input.jpg"
+  convert.auto_orient
+  convert.stdout # alias for "-"
+end
+```
+
+#### Capturing STDERR
+
+Some MiniMagick tools such as `compare` output the result of the command on
+standard error, even if the command succeeded. The result of
+`MiniMagick::Tool#call` is always the standard output, but if you pass it a
+block, it will yield the stdout, stderr and exit status of the command:
+
+```rb
+compare = MiniMagick::Tool::Compare.new
+# build the command
+compare.call do |stdout, stderr, status|
+  # ...
+end
+```
+
+## Limiting resources
+
+ImageMagick supports a number of environment variables for controlling its
+resource limits. For example, you can enforce memory or execution time limits by
+setting the following variables in your application's process environment:
+
+* `MAGICK_MEMORY_LIMIT=128MiB`
+* `MAGICK_MAP_LIMIT=64MiB`
+* `MAGICK_TIME_LIMIT=30`
+
+For a full list of variables and description, see [ImageMagick's resources
+documentation](http://www.imagemagick.org/script/resources.php#environment).
+
+## Changing temporary directory
+
+ImageMagick allows you to change the temporary directory to process the image file:
+
+```rb
+MiniMagick.configure do |config|
+  config.tmpdir = File.join(Dir.tmpdir, "/my/new/tmp_dir")
+end
+```
+
+The example directory `/my/new/tmp_dir` must exist and must be writable.
+
+If not configured, it will default to `Dir.tmpdir`.
+
+## Ignoring STDERR
+
+If you're receiving warnings from ImageMagick that you don't care about, you
+can avoid them being forwarded to standard error:
+
+```rb
+MiniMagick.configure do |config|
+  config.warnings = false
+end
+```
+
+## Troubleshooting
+
+### Errors being raised when they shouldn't
+
+This gem raises an error when ImageMagick returns a nonzero exit code.
+Sometimes, however, ImageMagick returns nonzero exit codes when the command
+actually went ok. In these cases, to avoid raising errors, you can add the
+following configuration:
+
+```rb
+MiniMagick.configure do |config|
+  config.whiny = false
+end
+```
+
+If you're using the tool directly, you can pass `whiny: false` value to the
+constructor:
+
+```rb
+MiniMagick::Tool::Identify.new(whiny: false) do |b|
+  b.help
+end
+```
+
+## Thinking of switching from RMagick?
+
+Unlike RMagick, MiniMagick is a much thinner wrapper around ImageMagick.
+
+* To piece together MiniMagick commands refer to the [Mogrify
+  Documentation](https://imagemagick.org/script/mogrify.php). For instance
+  you can use the `-flop` option as `image.flop`.
+* Operations on a MiniMagick image tend to happen in-place as `image.trim`,
+  whereas RMagick has both copying and in-place methods like `image.trim` and
+  `image.trim!`.
+* To open files with MiniMagick you use `MiniMagick::Image.open` as you would
+  `Magick::Image.read`. To open a file and directly edit it, use
+  `MiniMagick::Image.new`.

data/lib/mini_magick/configuration.rb

@@ -4,14 +4,6 @@ require 'logger'
 module MiniMagick
   module Configuration
 
-    ##
-    # Set whether you want to use [ImageMagick](http://www.imagemagick.org) or
-    # [GraphicsMagick](http://www.graphicsmagick.org).
-    #
-    # @return [Symbol] `:imagemagick`, `:imagemagick7`, or `:graphicsmagick`
-    #
-    attr_accessor :cli
-
     ##
     # If you don't have the CLI tools in your PATH, you can set the path to the
     # executables.
@@ -53,6 +45,13 @@ module MiniMagick
     # @return [Logger]
     #
     attr_accessor :logger
+    ##
+    # Temporary directory used by MiniMagick, default is `Dir.tmpdir`, but
+    # you can override it.
+    #
+    # @return [String]
+    #
+    attr_accessor :tmpdir
 
     ##
     # If set to `true`, it will `identify` every newly created image, and raise
@@ -65,7 +64,7 @@ module MiniMagick
     ##
     # If set to `true`, it will `identify` every image that gets written (with
     # {MiniMagick::Image#write}), and raise `MiniMagick::Invalid` if the image
-    # is not valid. Useful for validating that processing was sucessful,
+    # is not valid. Useful for validating that processing was successful,
     # although it adds a bit of overhead. Defaults to `true`.
     #
     # @return [Boolean]
@@ -81,20 +80,17 @@ module MiniMagick
     attr_accessor :whiny
 
     ##
-    # Instructs MiniMagick how to execute the shell commands. Available
-    # APIs are "open3" (default) and "posix-spawn" (requires the "posix-spawn"
-    # gem).
-    #
-    # @return [String]
-    #
-    attr_accessor :shell_api
+    # If set to `false`, it will not forward warnings from ImageMagick to
+    # standard error.
+    attr_accessor :warnings
 
     def self.extended(base)
+      base.tmpdir = Dir.tmpdir
       base.validate_on_create = true
       base.validate_on_write = true
       base.whiny = true
-      base.shell_api = "open3"
       base.logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
+      base.warnings = true
     end
 
     ##
@@ -189,6 +185,15 @@ module MiniMagick
       logger.level = value ? Logger::DEBUG : Logger::INFO
     end
 
+    def shell_api=(value)
+      warn "MiniMagick.shell_api is deprecated and will be removed in MiniMagick 5. The posix-spawn gem doesn't improve performance recent Ruby versions anymore, so support for it will be removed."
+      @shell_api = value
+    end
+
+    def shell_api
+      @shell_api || "open3"
+    end
+
     # Backwards compatibility
     def reload_tools
       warn "MiniMagick.reload_tools is deprecated because it is no longer necessary"

data/lib/mini_magick/image/info.rb

@@ -42,7 +42,7 @@ module MiniMagick
 
       def cheap_info(value)
         @info.fetch(value) do
-          format, width, height, size = self["%m %w %h %b"].split(" ")
+          format, width, height, size = parse_warnings(self["%m %w %h %b"]).split(" ")
 
           path = @path
           path = path.match(/\[\d+\]$/).pre_match if path =~ /\[\d+\]$/
@@ -62,11 +62,23 @@ module MiniMagick
         raise MiniMagick::Invalid, "image data can't be read"
       end
 
+      def parse_warnings(raw_info)
+        return raw_info unless raw_info.split("\n").size > 1
+
+        raw_info.split("\n").each do |line|
+          # must match "%m %w %h %b"
+          return line if line.match?(/^[A-Z]+ \d+ \d+ \d+(|\.\d+)([KMGTPEZY]{0,1})B$/)
+        end
+        raise TypeError
+      end
+
       def colorspace
         @info["colorspace"] ||= self["%r"]
       end
 
       def mime_type
+        warn "[MiniMagick] MiniMagick::Image#mime_type has been deprecated, because it wasn't returning correct result for all formats ImageMagick supports. Unfortunately, returning the correct MIME type would be very slow, because it would require ImageMagick to read the whole file. It's better to use Marcel and MimeMagic gems, which are able to determine the MIME type just from the image header."
+
         "image/#{self["format"].downcase}"
       end
 

data/lib/mini_magick/image.rb

@@ -15,7 +15,7 @@ module MiniMagick
     # methods.
     #
     # Use this to pass in a stream object. Must respond to #read(size) or be a
-    # binary string object (BLOBBBB)
+    # binary string object (BLOB)
     #
     # Probably easier to use the {.open} method if you want to open a file or a
     # URL.
@@ -274,7 +274,7 @@ module MiniMagick
     #
     attribute :resolution
     ##
-    # Returns the message digest of this image as a SHA-256, hexidecimal
+    # Returns the message digest of this image as a SHA-256, hexadecimal
     # 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.
@@ -340,13 +340,18 @@ module MiniMagick
     #
     # 1) one for each row of pixels
     # 2) one for each column of pixels
-    # 3) three elements in the range 0-255, one for each of the RGB color channels
+    # 3) three or four elements in the range 0-255, one for each of the RGB(A) color channels
     #
     # @example
     #   img = MiniMagick::Image.open 'image.jpg'
     #   pixels = img.get_pixels
     #   pixels[3][2][1] # the green channel value from the 4th-row, 3rd-column pixel
     #
+    # @example
+    #   img = MiniMagick::Image.open 'image.jpg'
+    #   pixels = img.get_pixels("RGBA")
+    #   pixels[3][2][3] # the alpha channel value from the 4th-row, 3rd-column pixel
+    #
     # It can also be called after applying transformations:
     #
     # @example
@@ -357,19 +362,22 @@ module MiniMagick
     #
     # In this example, all pixels in pix should now have equal R, G, and B values.
     #
+    # @param map [String] A code for the mapping of the pixel data. Must be either
+    #   'RGB' or 'RGBA'. Default to 'RGB'
     # @return [Array] Matrix of each color of each pixel
-    def get_pixels
+    def get_pixels(map="RGB")
+      raise ArgumentError, "Invalid map value" unless ["RGB", "RGBA"].include?(map)
       convert = MiniMagick::Tool::Convert.new
       convert << path
       convert.depth(8)
-      convert << "RGB:-"
+      convert << "#{map}:-"
 
       # Do not use `convert.call` here. We need the whole binary (unstripped) output here.
       shell = MiniMagick::Shell.new
       output, * = shell.run(convert.command)
 
       pixels_array = output.unpack("C*")
-      pixels = pixels_array.each_slice(3).each_slice(width).to_a
+      pixels = pixels_array.each_slice(map.length).each_slice(width).to_a
 
       # deallocate large intermediary objects
       output.clear
@@ -378,6 +386,23 @@ module MiniMagick
       pixels
     end
 
+    ##
+    # This is used to create image from pixels. This might be required if you
+    # create pixels for some image processing reasons and you want to form 
+    # image from those pixels.
+    #
+    # *DANGER*: This operation can be very expensive. Please try to use with
+    # caution. 
+    # 
+    # @example
+    #   # It is given in readme.md file
+    ##
+    def self.get_image_from_pixels(pixels, dimension, map, depth, mime_type)
+      pixels = pixels.flatten
+      blob = pixels.pack('C*')
+      import_pixels(blob, *dimension, depth, map, mime_type)
+    end
+
     ##
     # 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
@@ -436,6 +461,9 @@ module MiniMagick
       @info.clear
 
       self
+    rescue MiniMagick::Invalid, MiniMagick::Error => e
+      new_tempfile.unlink if new_tempfile && @tempfile != new_tempfile
+      raise e
     end
 
     ##

data/lib/mini_magick/shell.rb

@@ -14,9 +14,10 @@ module MiniMagick
       stdout, stderr, status = execute(command, stdin: options[:stdin])
 
       if status != 0 && options.fetch(:whiny, MiniMagick.whiny)
-        fail MiniMagick::Error, "`#{command.join(" ")}` failed with error:\n#{stderr}"
+        fail MiniMagick::Error, "`#{command.join(" ")}` failed with status: #{status.inspect} and error:\n#{stderr}"
       end
 
+      stderr = stderr.lines[2..-1].join if stderr.start_with? %(WARNING: The convert command is deprecated in IMv7)
       $stderr.print(stderr) unless options[:stderr] == false
 
       [stdout, stderr, status]
@@ -25,10 +26,10 @@ module MiniMagick
     def execute(command, options = {})
       stdout, stderr, status =
         log(command.join(" ")) do
-          send("execute_#{MiniMagick.shell_api.gsub("-", "_")}", command, options)
+          send("execute_#{MiniMagick.shell_api.tr("-", "_")}", command, options)
         end
 
-      [stdout, stderr, status.exitstatus]
+      [stdout, stderr, status&.exitstatus]
     rescue Errno::ENOENT, IOError
       ["", "executable not found: \"#{command.first}\"", 127]
     end
@@ -50,9 +51,7 @@ module MiniMagick
         end
         in_w.close
 
-        begin
-          Timeout.timeout(MiniMagick.timeout) { thread.join }
-        rescue Timeout::Error
+        unless thread.join(MiniMagick.timeout)
           Process.kill("TERM", thread.pid) rescue nil
           Process.waitpid(thread.pid)      rescue nil
           raise Timeout::Error, "MiniMagick command timed out: #{command}"

data/lib/mini_magick/tool.rb

@@ -44,8 +44,10 @@ module MiniMagick
     # @private
     attr_reader :name, :args
 
-    # @param whiny [Boolean] Whether to raise errors on exit codes different
-    #   than 0.
+    # @param name [String]
+    # @param options [Hash]
+    # @option options [Boolean] :whiny Whether to raise errors on non-zero
+    #   exit codes.
     # @example
     #   MiniMagick::Tool::Identify.new(whiny: false) do |identify|
     #     identify.help # returns exit status 1, which would otherwise throw an error
@@ -84,7 +86,7 @@ module MiniMagick
       whiny = args.fetch(0, @whiny)
 
       options[:whiny] = whiny
-      options[:stderr] = false if block_given?
+      options[:stderr] = MiniMagick.warnings && !block_given?
 
       shell = MiniMagick::Shell.new
       stdout, stderr, status = shell.run(command, options)
@@ -179,7 +181,7 @@ module MiniMagick
     # Create an ImageMagick stack in the command (surround.
     #
     # @example
-    #   MiniMagick::Tool::Convert.new do |convert|
+    #   MiniMagick::Tool::Magick.new do |convert|
     #     convert << "wand.gif"
     #     convert.stack do |stack|
     #       stack << "wand.gif"
@@ -190,9 +192,15 @@ module MiniMagick
     #   end
     #   # executes `convert wand.gif \( wizard.gif -rotate 30 \) +append images.gif`
     #
-    def stack
+    def stack(*args)
       self << "("
-      yield self
+      args.each do |value|
+        case value
+        when Hash   then value.each { |key, value| send(key, *value) }
+        when String then self << value
+        end
+      end
+      yield self if block_given?
       self << ")"
     end
 
@@ -213,7 +221,7 @@ module MiniMagick
     # Adds ImageMagick's pseudo-filename `-` for standard output.
     #
     # @example
-    #   content = MiniMagick::Tool::Convert.new do |convert|
+    #   content = MiniMagick::Tool::Magick.new do |convert|
     #     convert << "input.jpg"
     #     convert.auto_orient
     #     convert.stdout
@@ -227,12 +235,13 @@ module MiniMagick
     ##
     # Define creator operator methods
     #
+    # @example
     #   mogrify = MiniMagick::Tool.new("mogrify")
     #   mogrify.canvas("khaki")
     #   mogrify.command.join(" ") #=> "mogrify canvas:khaki"
     #
     CREATION_OPERATORS.each do |operator|
-      define_method(operator.gsub('-', '_')) do |value = nil|
+      define_method(operator.tr('-', '_')) do |value = nil|
         self << "#{operator}:#{value}"
         self
       end
@@ -251,10 +260,11 @@ module MiniMagick
     ##
     # Any undefined method will be transformed into a CLI option
     #
+    # @example
     #   mogrify = MiniMagick::Tool.new("mogrify")
     #   mogrify.adaptive_blur("...")
     #   mogrify.foo_bar
-    #   mogrify.command.join(" ") "mogrify -adaptive-blur ... -foo-bar"
+    #   mogrify.command.join(" ") # => "mogrify -adaptive-blur ... -foo-bar"
     #
     def method_missing(name, *args)
       option = "-#{name.to_s.tr('_', '-')}"

data/lib/mini_magick/utilities.rb

@@ -24,7 +24,7 @@ module MiniMagick
     end
 
     def tempfile(extension)
-      Tempfile.new(["mini_magick", extension]).tap do |tempfile|
+      Tempfile.new(["mini_magick", extension], MiniMagick.tmpdir).tap do |tempfile|
         tempfile.binmode
         yield tempfile if block_given?
         tempfile.close

data/lib/mini_magick/version.rb

@@ -8,8 +8,8 @@ module MiniMagick
 
   module VERSION
     MAJOR = 4
-    MINOR = 10
-    TINY  = 1
+    MINOR = 13
+    TINY  = 2
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_magick
 version: !ruby/object:Gem::Version
-  version: 4.10.1
+  version: 4.13.2
 platform: ruby
 authors:
 - Corey Johnson
@@ -10,10 +10,10 @@ authors:
 - James Miller
 - Thiago Fernandes Massa
 - Janko Marohnić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,48 +43,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: posix-spawn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -112,13 +70,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/mini_gmagick.rb
 - lib/mini_magick.rb
 - lib/mini_magick/configuration.rb
 - lib/mini_magick/image.rb
 - lib/mini_magick/image/info.rb
-- lib/mini_magick/immutable_image.rb
 - lib/mini_magick/shell.rb
 - lib/mini_magick/tool.rb
 - lib/mini_magick/tool/animate.rb
@@ -140,7 +98,7 @@ homepage: https://github.com/minimagick/minimagick
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,8 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - You must have ImageMagick or GraphicsMagick installed
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick
 test_files: []

data/lib/mini_magick/immutable_image.rb

@@ -1,18 +0,0 @@
-module MiniMagick
-  class Image
-    def initialize(source)
-      if source.is_a?(String) || source.is_a?(Pathname)
-        @source_path = source.to_s
-      elsif source.respond_to?(:path)
-        @source_path = source.path
-      else
-        fail ArgumentError, "invalid source object: #{source.inspect} (expected String, Pathname or #path)"
-      end
-    end
-
-    def method_missing
-    end
-  end
-end
-
-image = MiniMagick::Image.new()