module MiniMagick::Configuration

Attributes

cli[RW]

Set whether you want to use [ImageMagick](www.imagemagick.org) or [GraphicsMagick](www.graphicsmagick.org).

@return [Symbol] `:imagemagick` or `:graphicsmagick`

cli_path[RW]

If you don't have the CLI tools in your PATH, you can set the path to the executables.

@return [String]

debug[RW]

When set to `true`, it outputs each command to STDOUT in their shell version.

@return [Boolean]

logger[RW]

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.

@return [Logger]

processor[RW]

@private (for backwards compatibility)

processor_path[RW]

@private (for backwards compatibility)

shell_api[RW]

Instructs MiniMagick how to execute the shell commands. Available APIs are “open3” (default) and “posix-spawn” (requires the “posix-spawn” gem).

@return [String]

timeout[RW]

If you don't want commands to take too long, you can set a timeout (in seconds).

@return [Integer]

validate_on_create[RW]

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]

validate_on_write[RW]

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, although it adds a bit of overhead. Defaults to `true`.

@return [Boolean]

whiny[RW]

If set to `false`, it will not raise errors when ImageMagick returns status code different than 0. Defaults to `true`.

@return [Boolean]

Public Class Methods

extended(base) click to toggle source
# File lib/mini_magick/configuration.rb, line 85
def self.extended(base)
  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 }
end

Public Instance Methods

cli=(value) click to toggle source
# File lib/mini_magick/configuration.rb, line 131
def cli=(value)
  @cli = value

  if not [:imagemagick, :graphicsmagick].include?(@cli)
    raise ArgumentError,
      "CLI has to be set to either :imagemagick or :graphicsmagick" \
      ", was set to #{@cli.inspect}"
  end
end
configure() { |self| ... } click to toggle source

@yield [self] @example

MiniMagick.configure do |config|
  config.cli = :graphicsmagick
  config.timeout = 5
end
# File lib/mini_magick/configuration.rb, line 101
def configure
  yield self
end
debug=(value) click to toggle source
# File lib/mini_magick/configuration.rb, line 145
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
processor=(processor) click to toggle source
# File lib/mini_magick/configuration.rb, line 111
def processor=(processor)
  @processor = processor.to_s

  unless ["mogrify", "gm"].include?(@processor)
    raise ArgumentError,
      "processor has to be set to either \"mogrify\" or \"gm\"" \
      ", was set to #{@processor.inspect}"
  end
end
reload_tools() click to toggle source

Backwards compatibility

# File lib/mini_magick/configuration.rb, line 151
def reload_tools
  warn "MiniMagick.reload_tools is deprecated because it is no longer necessary"
end