mini_magick 4.13.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20fbff9386132eb3f620062d678ebf081cf68e4c99101bec9841590d8d959190
-  data.tar.gz: 5fce4715201eeaa2435a2e2664ffcf9e9e6b9f7c198289d93b54ac0950b5c70d
+  metadata.gz: b2a979a253bd3d26fe275850919ab3569c69ae6b2817fadf6660bbeaa9ec3e07
+  data.tar.gz: a1c7c90b81883cdf2c1734906ff07a72bc50c427cf35835f67818d5245e78936
 SHA512:
-  metadata.gz: 20b8a2642d64aa874f3bc9c2d31d8db00009b06f870216f788a46a70bf68c8164796477d0cd8b6c92de13e13151587bf4b8e40de4205bb8e95105439933fe49b
-  data.tar.gz: 07bc65b8d3bb29d2fb8f1d4be21d9fd2eeaed1d0059cd8bb8aa64b9faa737f78adf299e06a6f62d88b11565a6de42392f1db12e5256eb2bfe0ff6adb8dc7ce31
+  metadata.gz: 6cd0afcaab4af7f1f069938fef824290cdf03b5b17920594acc81c2dbb7b1c6828cb88af157e784fd27ba387cd27d2acf0fa8a5e1c3b9a02924ec11d7a4630eb
+  data.tar.gz: b99d1936faea4689b647d39832de3424dc1bdde6d748c0c9b0d8432dd24b6e89661690f141089d5a0a88315fcd2658a4da8c3ba2736929aeafbb4113cdc43541

data/README.md

@@ -4,8 +4,7 @@
 [![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.
+A ruby wrapper for [ImageMagick](http://imagemagick.org/) command line.
 
 ## Why?
 
@@ -26,8 +25,8 @@ MiniMagick gives you access to all the command line options ImageMagick has
 
 ## Requirements
 
-ImageMagick or GraphicsMagick command-line tool has to be installed. You can
-check if you have it installed by running
+ImageMagick command-line tool has to be installed. You can check if you have it
+installed by running
 
 ```sh
 $ magick -version
@@ -43,8 +42,8 @@ Compiler: gcc (4.2)
 
 Add the gem to your Gemfile:
 
-```rb
-gem "mini_magick"
+```sh
+$ bundle add mini_magick
 ```
 
 ## Information
@@ -73,7 +72,7 @@ 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.
+forwarded to [open-uri](https://github.com/ruby/open-uri).
 
 ```rb
 image = MiniMagick::Image.open("http://example.com/image.jpg")
@@ -117,8 +116,8 @@ image = MiniMagick::Image.new("input.jpg") do |b|
 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.
+The yielded builder is an instance of `MiniMagick::Tool`. To learn more
+about its interface, see [Tools](#tools) below.
 
 ### Attributes
 
@@ -126,7 +125,6 @@ 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]
@@ -145,7 +143,7 @@ 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:
+which returns the output from `magick input.jpg json:`:
 
 ```rb
 image.data #=>
@@ -193,10 +191,6 @@ image.data #=>
 # }
 ```
 
-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
@@ -221,6 +215,7 @@ 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
@@ -229,22 +224,27 @@ 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
 
+Here are the available configuration options with their default values:
+
 ```rb
 MiniMagick.configure do |config|
-  config.cli = :graphicsmagick
-  config.timeout = 5
+  config.timeout = nil # number of seconds IM commands may take
+  config.errors = true # raise errors non nonzero exit status
+  config.warnings = true # forward warnings to standard error
+  config.tmdir = Dir.tmpdir # alternative directory for tempfiles
+  config.logger = Logger.new($stdout) # where to log IM commands
+  config.cli_prefix = nil # add prefix to all IM commands
 end
 ```
 
-For a complete list of configuration options, see
-[Configuration](http://rubydoc.info/github/minimagick/minimagick/MiniMagick/Configuration).
+For a more information, see
+[Configuration](http://rubydoc.info/github/minimagick/minimagick/MiniMagick/Configuration) API documentation.
 
 ### Composite
 
@@ -277,19 +277,7 @@ 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:
+You can test whether an image is valid by running it through `identify`:
 
 ```rb
 image.valid?
@@ -309,67 +297,36 @@ D, [2016-03-19T07:31:36.755338 #87191] DEBUG -- : [0.01s] identify /var/folders/
 
 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
+## Tools
 
-If you want to be close to the metal, you can use ImageMagick's command-line
-tools directly.
+If you prefer not to use the `MiniMagick::Image` abstraction, 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"
+MiniMagick.convert do |convert|
+  convert << "input.jpg"
+  convert.resize("100x100")
+  convert.negate
+  convert << "output.jpg"
 end #=> `magick input.jpg -resize 100x100 -negate output.jpg`
 
 # OR
 
-convert = MiniMagick::Tool::Convert.new
+convert = MiniMagick.convert
 convert << "input.jpg"
 convert.resize("100x100")
 convert.negate
 convert << "output.jpg"
-convert.call #=> `convert input.jpg -resize 100x100 -negate output.jpg`
+convert.call #=> `magick 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. There are class methods for each CLI tool: `animate`, `compare`, `composite`, `conjure`, `convert`, `display`, `identify`, `import`, `mogrify` and `stream`. The `MiniMagick.convert` method will use `magick` on ImageMagick 7 and `convert` on ImageMagick 6.
 
-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
+### Appending
 
 The most basic way of building a command is appending strings:
 
 ```rb
-MiniMagick::Tool::Magick.new do |convert|
+MiniMagick.convert do |convert|
   convert << "input.jpg"
   convert.merge! ["-resize", "500x500", "-negate"]
   convert << "output.jpg"
@@ -396,10 +353,10 @@ 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'
+magick -distort Perspective '0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35'
 ```
 
-#### Methods
+### Methods
 
 Instead of passing in options directly, you can use Ruby methods:
 
@@ -409,15 +366,12 @@ 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
+### Chaining
 
 Every method call returns `self`, so you can chain them to create logical groups.
 
 ```rb
-MiniMagick::Tool::Magick.new do |convert|
+MiniMagick.convert do |convert|
   convert << "input.jpg"
   convert.clone(0).background('gray').shadow('80x5+5+5')
   convert.negate
@@ -425,23 +379,23 @@ MiniMagick::Tool::Magick.new do |convert|
 end
 ```
 
-#### "Plus" options
+### "Plus" options
 
 ```rb
-MiniMagick::Tool::Magick.new do |convert|
+MiniMagick.convert do |convert|
   convert << "input.jpg"
   convert.repage.+
   convert.distort.+("Perspective", "more args")
 end
 ```
 ```
-convert input.jpg +repage +distort Perspective 'more args'
+magick input.jpg +repage +distort Perspective 'more args'
 ```
 
-#### Stacks
+### Stacks
 
 ```rb
-MiniMagick::Tool::Magick.new do |convert|
+MiniMagick.convert do |convert|
   convert << "wand.gif"
 
   convert.stack do |stack|
@@ -456,16 +410,16 @@ MiniMagick::Tool::Magick.new do |convert|
 end
 ```
 ```
-convert wand.gif \( wand.gif -rotate 90 -foo bar baz \) images.gif
+magick wand.gif \( wand.gif -rotate 90 -foo bar baz \) images.gif
 ```
 
-#### STDIN and STDOUT
+### 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 = MiniMagick.identify
 identify.stdin # alias for "-"
 identify.call(stdin: image_content)
 ```
@@ -474,14 +428,14 @@ MiniMagick also has `#stdout` alias for "-" for outputting file contents to
 standard output:
 
 ```rb
-content = MiniMagick::Tool::Magick.new do |convert|
+content = MiniMagick.convert do |convert|
   convert << "input.jpg"
   convert.auto_orient
   convert.stdout # alias for "-"
 end
 ```
 
-#### Capturing STDERR
+### 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
@@ -489,14 +443,30 @@ standard error, even if the command succeeded. The result of
 block, it will yield the stdout, stderr and exit status of the command:
 
 ```rb
-compare = MiniMagick::Tool::Compare.new
+compare = MiniMagick.compare
 # build the command
 compare.call do |stdout, stderr, status|
   # ...
 end
 ```
 
-## Limiting resources
+## Configuring
+
+### GraphicsMagick
+
+As of MiniMagick 5+, [GraphicsMagick](http://www.graphicsmagick.org/) isn't
+officially supported. However, you can still configure MiniMagick to use it:
+
+```rb
+MiniMagick.configure do |config|
+  config.cli_prefix = "gm"
+end
+```
+
+Some MiniMagick features won't be supported, such as global timeout,
+`MiniMagick::Image#data` and `MiniMagick::Image#exif`.
+
+### 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
@@ -509,7 +479,7 @@ setting the following variables in your application's process environment:
 For a full list of variables and description, see [ImageMagick's resources
 documentation](http://www.imagemagick.org/script/resources.php#environment).
 
-## Changing temporary directory
+### Changing temporary directory
 
 ImageMagick allows you to change the temporary directory to process the image file:
 
@@ -523,7 +493,7 @@ The example directory `/my/new/tmp_dir` must exist and must be writable.
 
 If not configured, it will default to `Dir.tmpdir`.
 
-## Ignoring STDERR
+### Ignoring STDERR
 
 If you're receiving warnings from ImageMagick that you don't care about, you
 can avoid them being forwarded to standard error:
@@ -534,9 +504,7 @@ MiniMagick.configure do |config|
 end
 ```
 
-## Troubleshooting
-
-### Errors being raised when they shouldn't
+### Avoiding raising errors
 
 This gem raises an error when ImageMagick returns a nonzero exit code.
 Sometimes, however, ImageMagick returns nonzero exit codes when the command
@@ -545,15 +513,14 @@ following configuration:
 
 ```rb
 MiniMagick.configure do |config|
-  config.whiny = false
+  config.errors = false
 end
 ```
 
-If you're using the tool directly, you can pass `whiny: false` value to the
-constructor:
+You can also pass `errors: false` to individual commands:
 
 ```rb
-MiniMagick::Tool::Identify.new(whiny: false) do |b|
+MiniMagick.identify(errors: false) do |b|
   b.help
 end
 ```

data/lib/mini_magick/configuration.rb

@@ -4,14 +4,6 @@ require 'logger'
 module MiniMagick
   module Configuration
 
-    ##
-    # If you don't have the CLI tools in your PATH, you can set the path to the
-    # executables.
-    #
-    attr_writer :cli_path
-    # @private (for backwards compatibility)
-    attr_accessor :processor_path
-
     ##
     # Adds a prefix to the CLI command.
     # For example, you could use `firejail` to run all commands in a sandbox.
@@ -31,16 +23,8 @@ module MiniMagick
     #
     attr_accessor :timeout
     ##
-    # When get to `true`, it outputs each command to STDOUT in their shell
-    # version.
-    #
-    # @return [Boolean]
-    #
-    attr_reader :debug
-    ##
-    # Logger for {#debug}, default is `MiniMagick::Logger.new(STDOUT)`, but
-    # you can override it, for example if you want the logs to be written to
-    # a file.
+    # Logger for commands, default is `Logger.new($stdout)`, but you can
+    # override it, for example if you want the logs to be written to a file.
     #
     # @return [Logger]
     #
@@ -53,31 +37,13 @@ module MiniMagick
     #
     attr_accessor :tmpdir
 
-    ##
-    # If set to `true`, it will `identify` every newly created image, and raise
-    # `MiniMagick::Invalid` if the image is not valid. Useful for validating
-    # user input, although it adds a bit of overhead. Defaults to `true`.
-    #
-    # @return [Boolean]
-    #
-    attr_accessor :validate_on_create
-    ##
-    # 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 successful,
-    # although it adds a bit of overhead. Defaults to `true`.
-    #
-    # @return [Boolean]
-    #
-    attr_accessor :validate_on_write
-
     ##
     # If set to `false`, it will not raise errors when ImageMagick returns
     # status code different than 0. Defaults to `true`.
     #
     # @return [Boolean]
     #
-    attr_accessor :whiny
+    attr_accessor :errors
 
     ##
     # If set to `false`, it will not forward warnings from ImageMagick to
@@ -86,9 +52,7 @@ module MiniMagick
 
     def self.extended(base)
       base.tmpdir = Dir.tmpdir
-      base.validate_on_create = true
-      base.validate_on_write = true
-      base.whiny = true
+      base.errors = true
       base.logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
       base.warnings = true
     end
@@ -97,107 +61,11 @@ module MiniMagick
     # @yield [self]
     # @example
     #   MiniMagick.configure do |config|
-    #     config.cli = :graphicsmagick
     #     config.timeout = 5
     #   end
     #
     def configure
       yield self
     end
-
-    CLI_DETECTION = {
-      imagemagick7:   "magick",
-      imagemagick:    "mogrify",
-      graphicsmagick: "gm",
-    }
-
-    # @private (for backwards compatibility)
-    def processor
-      @processor ||= CLI_DETECTION.values.detect do |processor|
-        MiniMagick::Utilities.which(processor)
-      end
-    end
-
-    # @private (for backwards compatibility)
-    def processor=(processor)
-      @processor = processor.to_s
-
-      unless CLI_DETECTION.value?(@processor)
-        raise ArgumentError,
-          "processor has to be set to either \"magick\", \"mogrify\" or \"gm\"" \
-          ", was set to #{@processor.inspect}"
-      end
-    end
-
-    ##
-    # Get [ImageMagick](http://www.imagemagick.org) or
-    # [GraphicsMagick](http://www.graphicsmagick.org).
-    #
-    # @return [Symbol] `:imagemagick` or `:graphicsmagick`
-    #
-    def cli
-      if instance_variable_defined?("@cli")
-        instance_variable_get("@cli")
-      else
-        cli = CLI_DETECTION.key(processor) or
-          fail MiniMagick::Error, "You must have ImageMagick or GraphicsMagick installed"
-
-        instance_variable_set("@cli", cli)
-      end
-    end
-
-    ##
-    # Set whether you want to use [ImageMagick](http://www.imagemagick.org) or
-    # [GraphicsMagick](http://www.graphicsmagick.org).
-    #
-    def cli=(value)
-      @cli = value
-
-      if not CLI_DETECTION.key?(@cli)
-        raise ArgumentError,
-          "CLI has to be set to either :imagemagick, :imagemagick7 or :graphicsmagick" \
-          ", was set to #{@cli.inspect}"
-      end
-    end
-
-    ##
-    # If you set the path of CLI tools, you can get the path of the
-    # executables.
-    #
-    # @return [String]
-    #
-    def cli_path
-      if instance_variable_defined?("@cli_path")
-        instance_variable_get("@cli_path")
-      else
-        processor_path = instance_variable_get("@processor_path") if instance_variable_defined?("@processor_path")
-
-        instance_variable_set("@cli_path", processor_path)
-      end
-    end
-
-    ##
-    # When set to `true`, it outputs each command to STDOUT in their shell
-    # version.
-    #
-    def debug=(value)
-      warn "MiniMagick.debug is deprecated and will be removed in MiniMagick 5. Use `MiniMagick.logger.level = Logger::DEBUG` instead."
-      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"
-    end
-
   end
 end