module MiniMagick::Configuration

Attributes

cli_env[RW]

Adds environment variables to every CLI command call. For example, you could use it to set ‘LD_PRELOAD=“/path/to/libsomething.so”`. Must be a hash of strings keyed to valid environment variable name strings. e.g. {’MY_ENV’ => ‘my value’}

@return [Hash]

cli_prefix[RW]

Adds a prefix to the CLI command. For example, you could use ‘firejail` to run all commands in a sandbox. Can be a string, or an array of strings. e.g. ’firejail’, or [‘firejail’, ‘–force’]

@return [String] @return [Array<String>]

errors[RW]

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

@return [Boolean]

graphicsmagick[RW]

Uses [GraphicsMagick](www.graphicsmagick.org/) instead of ImageMagick, by prefixing commands with ‘gm` instead of `magick`.

@return [Boolean]

logger[RW]

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]

restricted_env[RW]

If set to true, Open3 will restrict system calls to access only environment variables defined in :cli_env, plus HOME, PATH, and LANG since those are required for such system calls. It will not pass on any other environment variables from the system.

@return [Boolean]

timeout[RW]

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

@return [Integer]

tmpdir[RW]

Temporary directory used by MiniMagick, default is ‘Dir.tmpdir`, but you can override it.

@return [String]

warnings[RW]

If set to ‘false`, it will not forward warnings from ImageMagick to standard error.

Public Class Methods

extended(base) click to toggle source

# File lib/mini_magick/configuration.rb, line 80
def self.extended(base)
  base.tmpdir = Dir.tmpdir
  base.errors = true
  base.logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
  base.warnings = true
  base.cli_env = {}.freeze
  base.restricted_env = false
  base.graphicsmagick = false
end

Public Instance Methods

configure() { |self| ... } click to toggle source

@yield [self] @example

MiniMagick.configure do |config|
  config.timeout = 5
end

# File lib/mini_magick/configuration.rb, line 97
def configure
  yield self
end