mojo_magick 0.5.3 → 0.6.0

data/examples/composite.rb

@@ -1,23 +1,20 @@
 #!/usr/bin/env ruby
-#
+require "mojo_magick"
 
-require 'mojo_magick'
-
-MojoMagick::convert(nil, 'composite_out.png') do |c|
-  c.size '200x200'
+MojoMagick.convert(nil, "composite_out.png") do |c|
+  c.size "200x200"
   c.delay 100
   c.image_block do # first layer
-    c.background 'blue'
-    c.fill 'white'
-    c.gravity 'northwest'
-    c.label 'NW'
+    c.background "blue"
+    c.fill "white"
+    c.gravity "northwest"
+    c.label "NW"
   end
   c.image_block do # second layer
-    c.background 'transparent'
-    c.fill 'red'
-    c.gravity 'southeast'
-    c.label 'SE'
+    c.background "transparent"
+    c.fill "red"
+    c.gravity "southeast"
+    c.label "SE"
   end
   c.composite
 end
-

data/init.rb

@@ -1,3 +1 @@
-require File::expand_path(File::join(File::dirname(__FILE__), 'lib', 'mojo_magick'))
-
-
+require File.expand_path(File.join(File.dirname(__FILE__), "lib", "mojo_magick"))

data/lib/image_magick/fonts.rb

@@ -3,12 +3,12 @@ module ImageMagick
     def get_fonts
       @parser ||= MojoMagick::Util::Parser.new
       raw_fonts = begin
-                    self.raw_command('identify', '-list font')
-                  rescue Exception => ex
-                    puts ex
-                    puts "Failed to execute font list with raw_command - trying straight up execute"
-                    `convert -list font`
-                  end
+        raw_command("identify", "-list font")
+      rescue Exception => e
+        puts e
+        puts "Failed to execute font list with raw_command - trying straight up execute"
+        `convert -list font`
+      end
       @parser.parse_fonts(raw_fonts)
     end
   end

data/lib/initializers/hash.rb

@@ -1,7 +1,11 @@
 class Hash
   def symbolize_keys!
     keys.each do |key|
-      self[(key.to_sym rescue key) || key] = delete(key)
+      self[begin
+        key.to_sym
+      rescue StandardError
+        key
+      end || key] = delete(key)
     end
     self
   end

data/lib/mojo_magick.rb

@@ -1,186 +1,191 @@
-cwd = File::dirname(__FILE__)
-initializers_dir = File::expand_path(File::join(cwd, 'initializers'))
-Dir.glob(File::join(initializers_dir, '*.rb')).each { |f| require f }
-require File::join(cwd, 'mojo_magick/util/parser')
-require File::join(cwd, 'image_magick/resource_limits')
-require File::join(cwd, 'image_magick/fonts')
-require File::join(cwd, 'mojo_magick/opt_builder')
-require File::join(cwd, 'mojo_magick/font')
-require 'tempfile'
-
-
-# MojoMagick is a stateless set of module methods which present a convient interface
-# for accessing common tasks for ImageMagick command line library.
-#
-# MojoMagick is specifically designed to be efficient and simple and most importantly
-# to not leak any memory. For complex image operations, you will find MojoMagick limited.
-# You might consider the venerable MiniMagick or RMagick for your purposes if you care more
-# about ease of use rather than speed and memory management.
-
-# all commands raise "MojoMagick::MojoFailed" if command fails (ImageMagick determines command success status)
-
-# Two command-line builders, #convert and #mogrify, have been added to simplify
-# complex commands. Examples included below.
-#
-# Example #convert usage:
-#
-#   MojoMagick::convert('source.jpg', 'dest.jpg') do |c|
-#     c.crop '250x250+0+0'
-#     c.repage!
-#     c.strip
-#     c.set 'comment', 'my favorite file'
-#   end
-#
-# Equivalent to:
-#
-#   MojoMagick::raw_command('convert', 'source.jpg -crop 250x250+0+0 +repage -strip -set comment "my favorite file" dest.jpg')
-#
-# Example #mogrify usage:
-#
-#   MojoMagick::mogrify('image.jpg') {|i| i.shave '10x10'}
-#
-# Equivalent to:
-#
-#   MojoMagick::raw_command('mogrify', '-shave 10x10 image.jpg')
-#
-# Example showing some additional options:
-#
-#   MojoMagick::convert do |c|
-#     c.file 'source.jpg'
-#     c.blob my_binary_data
-#     c.append
-#     c.crop '256x256+0+0'
-#     c.repage!
-#     c.file 'output.jpg'
-#   end
-#
-# Use .file to specify file names, .blob to create and include a tempfile. The
-# bang (!) can be appended to command names to use the '+' versions
-# instead of '-' versions.
-#
-module MojoMagick
-
-  class MojoMagickException < StandardError; end
-  class MojoError < MojoMagickException; end
-  class MojoFailed < MojoMagickException; end
-
-  # enable resource limiting functionality
-  extend ImageMagick::ResourceLimits
-  extend ImageMagick::Fonts
-
-  def MojoMagick::windows?
-    mem_fix = 1
-    !(RUBY_PLATFORM =~ /win32/).nil?
-  end
-
-  def MojoMagick::raw_command(command, args, options = {})
-    # this suppress error messages to the console
-    err_pipe = windows? ? "2>nul" : "2>/dev/null"
-    begin
-      execute = "#{command} #{get_limits_as_params} #{args} #{err_pipe}"
-      retval = `#{execute}`
-    # guarantee that only MojoError exceptions are raised here
-    rescue Exception => e
-      raise MojoError, "#{e.class}: #{e.message}"
-    end
-    if $? && !$?.success?
-      err_msg = options[:err_msg] || "MojoMagick command failed: #{command}."
-      raise(MojoFailed, "#{err_msg} (Exit status: #{$?.exitstatus})\n  Command: #{execute}")
-    end
-    retval
-  end
-
-  def MojoMagick::shrink(source_file, dest_file, options)
-    opts = options.dup
-    opts.delete(:expand_only)
-    MojoMagick::resize(source_file, dest_file, opts.merge(:shrink_only => true))
-  end
-
-  def MojoMagick::expand(source_file, dest_file, options)
-    opts = options.dup
-    opts.delete(:shrink_only)
-    MojoMagick::resize(source_file, dest_file, opts.merge(:expand_only => true))
-  end
-
-  # resizes an image and returns the filename written to
-  # options:
-  #   :width / :height => scale to these dimensions
-  #   :scale => pass scale options such as ">" to force shrink scaling only or "!" to force absolute width/height scaling (do not preserve aspect ratio)
-  #   :percent => scale image to this percentage (do not specify :width/:height in this case)
-  def MojoMagick::resize(source_file, dest_file, options)
-    retval = nil
-    scale_options = []
-    scale_options << ">" unless options[:shrink_only].nil?
-    scale_options << "<" unless options[:expand_only].nil?
-    scale_options << "!" unless options[:absolute_aspect].nil?
-    scale_options << "^" unless options[:fill].nil?
-    scale_options = scale_options.join
-
-    extras = []
-    if !options[:width].nil? && !options[:height].nil?
-      geometry = "#{options[:width]}X#{options[:height]}"
-    elsif !options[:percent].nil?
-      geometry = "#{options[:percent]}%"
-    else
-      raise MojoMagickError, "Unknown options for method resize: #{options.inspect}"
-    end
-    if !options[:fill].nil? && !options[:crop].nil?
-      extras << "-gravity Center"
-      extras << "-extent #{geometry}"
-    end
-    retval = raw_command("convert", "\"#{source_file}\" -resize \"#{geometry}#{scale_options}\" #{extras.join(' ')} \"#{dest_file}\"")
-    dest_file
-  end
-
-  def MojoMagick::available_fonts
-    # returns width, height of image if available, nil if not
-    Font.all
-  end
-
-  # returns an empty hash or a hash with :width and :height set (e.g. {:width => INT, :height => INT})
-  # raises MojoFailed when results are indeterminate (width and height could not be determined)
-  def MojoMagick::get_image_size(source_file)
-    # returns width, height of image if available, nil if not
-    retval = raw_command("identify", "-format \"w:%w h:%h\" \"#{source_file}\"")
-    return {} if !retval
-    width = retval.match(%r{w:([0-9]+) })
-    width = width ? width[1].to_i : nil
-    height = retval.match(%r{h:([0-9]+)})
-    height = height ? height[1].to_i : nil
-    raise(MojoFailed, "Indeterminate results in get_image_size: #{source_file}") if !height || !width
-    {:width=>width, :height=>height}
-  end
-
-  def MojoMagick::convert(source = nil, dest = nil)
-    opts = OptBuilder.new
-    opts.file source if source
-    yield opts
-    opts.file dest if dest
-    raw_command('convert', opts.to_s)
-  end
-
-  def MojoMagick::mogrify(dest = nil)
-    opts = OptBuilder.new
-    yield opts
-    opts.file dest if dest
-    raw_command('mogrify', opts.to_s)
-  end
-
-
-  def MojoMagick::tempfile(*opts)
-    begin
-      data = opts[0]
-      rest = opts[1]
-      ext = rest && rest[:format]
-      file = Tempfile.new(["mojo", ext ? '.' + ext.to_s : ''])
-      file.binmode
-      file.write(data)
-      file.path
-    rescue Exception => ex
-      raise
-    end
-  ensure
-    file.close
-  end
-
-end # MojoMagick
+cwd = File.dirname(__FILE__)
+require "open3"
+initializers_dir = File.expand_path(File.join(cwd, "initializers"))
+Dir.glob(File.join(initializers_dir, "*.rb")).sort.each { |f| require f }
+require File.join(cwd, "mojo_magick/util/parser")
+require File.join(cwd, "mojo_magick/errors")
+require File.join(cwd, "mojo_magick/command_status")
+require File.join(cwd, "image_magick/fonts")
+require File.join(cwd, "mojo_magick/opt_builder")
+require File.join(cwd, "mojo_magick/font")
+require "tempfile"
+
+# MojoMagick is a stateless set of module methods which present a convient interface
+# for accessing common tasks for ImageMagick command line library.
+#
+# MojoMagick is specifically designed to be efficient and simple and most importantly
+# to not leak any memory. For complex image operations, you will find MojoMagick limited.
+# You might consider the venerable MiniMagick or RMagick for your purposes if you care more
+# about ease of use rather than speed and memory management.
+
+# all commands raise "MojoMagick::MojoFailed" if command fails (ImageMagick determines command success status)
+
+# Two command-line builders, #convert and #mogrify, have been added to simplify
+# complex commands. Examples included below.
+#
+# Example #convert usage:
+#
+#   MojoMagick::convert('source.jpg', 'dest.jpg') do |c|
+#     c.crop '250x250+0+0'
+#     c.repage!
+#     c.strip
+#     c.set 'comment', 'my favorite file'
+#   end
+#
+# Equivalent to:
+#
+#   MojoMagick::raw_command('convert', 'source.jpg -crop 250x250+0+0\
+#         +repage -strip -set comment "my favorite file" dest.jpg')
+#
+# Example #mogrify usage:
+#
+#   MojoMagick::mogrify('image.jpg') {|i| i.shave '10x10'}
+#
+# Equivalent to:
+#
+#   MojoMagick::raw_command('mogrify', '-shave 10x10 image.jpg')
+#
+# Example showing some additional options:
+#
+#   MojoMagick::convert do |c|
+#     c.file 'source.jpg'
+#     c.blob my_binary_data
+#     c.append
+#     c.crop '256x256+0+0'
+#     c.repage!
+#     c.file 'output.jpg'
+#   end
+#
+# Use .file to specify file names, .blob to create and include a tempfile. The
+# bang (!) can be appended to command names to use the '+' versions
+# instead of '-' versions.
+#
+module MojoMagick
+  extend ImageMagick::Fonts
+
+  def self.windows?
+    !(RUBY_PLATFORM =~ /win32/).nil?
+  end
+
+  def self.execute(command, *args)
+    execute = "#{command} #{args}"
+    out, outerr, status = Open3.capture3(command, *args.map(&:to_s))
+    CommandStatus.new execute, out, outerr, status
+  rescue Exception => e
+    raise MojoError, "#{e.class}: #{e.message}"
+  end
+
+  def self.execute!(command, *args)
+    status = execute(command, *args)
+    unless status.success?
+      err_msg = "MojoMagick command failed: #{command}."
+      raise(MojoFailed, "#{err_msg} (Exit status: #{status.exit_code})\n" +
+            "  Command: #{status.command}\n" +
+            "  Error: #{status.error}")
+    end
+    status.return_value
+  end
+
+  def self.raw_command(*args)
+    execute!(*args)
+  end
+
+  def self.shrink(source_file, dest_file, options)
+    opts = options.dup
+    opts.delete(:expand_only)
+    MojoMagick.resize(source_file, dest_file, opts.merge(shrink_only: true))
+  end
+
+  def self.expand(source_file, dest_file, options)
+    opts = options.dup
+    opts.delete(:shrink_only)
+    MojoMagick.resize(source_file, dest_file, opts.merge(expand_only: true))
+  end
+
+  # resizes an image and returns the filename written to
+  # options:
+  #   :width / :height => scale to these dimensions
+  #   :scale => pass scale options such as ">" to force shrink scaling only or "!" to force absolute width/height scaling (do not preserve aspect ratio)
+  #   :percent => scale image to this percentage (do not specify :width/:height in this case)
+  def self.resize(source_file, dest_file, options)
+    scale_options = []
+    scale_options << ">" unless options[:shrink_only].nil?
+    scale_options << "<" unless options[:expand_only].nil?
+    scale_options << "!" unless options[:absolute_aspect].nil?
+    scale_options << "^" unless options[:fill].nil?
+    scale_options = scale_options.join
+
+    extras = []
+    if !options[:width].nil? && !options[:height].nil?
+      geometry = "#{options[:width]}X#{options[:height]}"
+    elsif !options[:percent].nil?
+      geometry = "#{options[:percent]}%"
+    else
+      raise MojoMagickError, "Unknown options for method resize: #{options.inspect}"
+    end
+    if !options[:fill].nil? && !options[:crop].nil?
+      extras << "-gravity"
+      extras << "Center"
+      extras << "-extent"
+      extras << geometry.to_s
+    end
+    raw_command("convert",
+                source_file,
+                "-resize", "#{geometry}#{scale_options}",
+                *extras, dest_file)
+    dest_file
+  end
+
+  def self.available_fonts
+    # returns width, height of image if available, nil if not
+    Font.all
+  end
+
+  def self.get_format(source_file, format_string)
+    raw_command("identify", "-format", format_string, source_file)
+  end
+
+  # returns an empty hash or a hash with :width and :height set (e.g. {:width => INT, :height => INT})
+  # raises MojoFailed when results are indeterminate (width and height could not be determined)
+  def self.get_image_size(source_file)
+    # returns width, height of image if available, nil if not
+    retval = get_format(source_file, "w:%w h:%h")
+    return {} unless retval
+
+    width = retval.match(/w:([0-9]+) /)
+    width = width ? width[1].to_i : nil
+    height = retval.match(/h:([0-9]+)/)
+    height = height ? height[1].to_i : nil
+    raise(MojoFailed, "Indeterminate results in get_image_size: #{source_file}") if !height || !width
+
+    { width: width, height: height }
+  end
+
+  def self.convert(source = nil, dest = nil)
+    opts = OptBuilder.new
+    opts.file source if source
+    yield opts
+    opts.file dest if dest
+
+    raw_command("convert", *opts.to_a)
+  end
+
+  def self.mogrify(dest = nil)
+    opts = OptBuilder.new
+    yield opts
+    opts.file dest if dest
+    raw_command("mogrify", *opts.to_a)
+  end
+
+  def self.tempfile(*opts)
+    data = opts[0]
+    rest = opts[1]
+    ext = rest && rest[:format]
+    file = Tempfile.new(["mojo", ext ? ".#{ext}" : ""])
+    file.binmode
+    file.write(data)
+    file.path
+  ensure
+    file.close
+  end
+end