mojo_magick 0.5.5 → 0.6.3

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

@@ -1,15 +1,8 @@
 module ImageMagick
-  module Fonts
-    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
-      @parser.parse_fonts(raw_fonts)
+  class Fonts
+    def self.all
+      raw_fonts = MojoMagick::Commands.raw_command("identify", "-list", "font")
+      MojoMagick::Util::FontParser.new(raw_fonts).parse
     end
   end
 end

data/lib/mojo_magick.rb

@@ -1,16 +1,12 @@
-cwd = File::dirname(__FILE__)
-require 'open3'
-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, 'mojo_magick/errors')
-require File::join(cwd, 'mojo_magick/command_status')
-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'
-
+require "tempfile"
+require "open3"
+require_relative "./mojo_magick/util/font_parser"
+require_relative "./mojo_magick/errors"
+require_relative "./mojo_magick/command_status"
+require_relative "./mojo_magick/commands"
+require_relative "./image_magick/fonts"
+require_relative "./mojo_magick/opt_builder"
+require_relative "./mojo_magick/font"
 
 # MojoMagick is a stateless set of module methods which present a convient interface
 # for accessing common tasks for ImageMagick command line library.
@@ -36,7 +32,8 @@ require 'tempfile'
 #
 # Equivalent to:
 #
-#   MojoMagick::raw_command('convert', 'source.jpg -crop 250x250+0+0 +repage -strip -set comment "my favorite file" dest.jpg')
+#   MojoMagick::Commands.raw_command('convert', 'source.jpg -crop 250x250+0+0\
+#         +repage -strip -set comment "my favorite file" dest.jpg')
 #
 # Example #mogrify usage:
 #
@@ -44,7 +41,7 @@ require 'tempfile'
 #
 # Equivalent to:
 #
-#   MojoMagick::raw_command('mogrify', '-shave 10x10 image.jpg')
+#   MojoMagick::Commands.raw_command('mogrify', '-shave 10x10 image.jpg')
 #
 # Example showing some additional options:
 #
@@ -61,134 +58,150 @@ require 'tempfile'
 # bang (!) can be appended to command names to use the '+' versions
 # instead of '-' versions.
 #
-module MojoMagick
 
-  # enable resource limiting functionality
-  extend ImageMagick::ResourceLimits
-  extend ImageMagick::Fonts
+module MojoMagickDeprecations
+  # rubocop:disable Naming/AccessorMethodName
+  def get_fonts
+    warn "DEPRECATION WARNING: #{__method__} is deprecated and will be removed with the next minor version release."\
+         "  Please use `available_fonts` instead"
+    MojoMagick.available_fonts
+  end
 
-  def MojoMagick::windows?
-    mem_fix = 1
-    !(RUBY_PLATFORM =~ /win32/).nil?
+  # rubocop:enable Naming/AccessorMethodName
+  ### Moved to `Commands`
+  def execute!(*args)
+    warn "DEPRECATION WARNING: #{__method__} is deprecated and will be removed with the next minor version release."\
+         "  Please use `MojoMagick::Commands.execute!` instead"
+    MojoMagick::Commands.send(:execute!, *args)
   end
 
-  def MojoMagick::execute(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}"
-      out, outerr, status = Open3.capture3(execute)
-      CommandStatus.new execute, out, outerr, status
-    rescue Exception => e
-      raise MojoError, "#{e.class}: #{e.message}"
-    end
+  def execute(*args)
+    warn "DEPRECATION WARNING: #{__method__} is deprecated and will be removed with the next minor version release."\
+         "  Please use `MojoMagick::Commands.execute!` instead"
+    MojoMagick::Commands.send(:execute, *args)
   end
-  
-  def MojoMagick::execute!(command, args, options = {})
-    # this suppress error messages to the console
-    # err_pipe = windows? ? "2>nul" : "2>/dev/null"
-    status = execute(command, args, options)
-    if !status.success? 
-      err_msg = options[: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
+
+  def raw_command(*args)
+    warn "DEPRECATION WARNING: #{__method__} is deprecated and will be removed with the next minor version release."\
+         "  Please use `MojoMagick::Commands.execute!` instead"
+    MojoMagick::Commands.raw_command(*args)
   end
-  
-  def MojoMagick::raw_command(*args)
-    self.execute! *args
+end
+
+module MojoMagick
+  extend MojoMagickDeprecations
+  def self.windows?
+    !RUBY_PLATFORM.include(win32)
   end
 
-  def MojoMagick::shrink(source_file, dest_file, options)
+  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))
+    MojoMagick.resize(source_file, dest_file, opts.merge(shrink_only: true))
   end
 
-  def MojoMagick::expand(source_file, dest_file, options)
+  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))
+    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)
+  #   :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
-
+  def self.resize(source_file, dest_file, options)
+    scale_options = extract_scale_options(options)
+    geometry = extract_geometry_options(options)
     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}"
+      extras << "-gravity"
+      extras << "Center"
+      extras << "-extent"
+      extras << geometry.to_s
     end
-    retval = raw_command("convert", "\"#{source_file}\" -resize \"#{geometry}#{scale_options}\" #{extras.join(' ')} \"#{dest_file}\"")
+    Commands.raw_command("convert",
+                         source_file,
+                         "-resize", "#{geometry}#{scale_options}",
+                         *extras, dest_file)
     dest_file
   end
 
-  def MojoMagick::available_fonts
+  def self.convert(source = nil, dest = nil)
+    opts = OptBuilder.new
+    opts.file source if source
+    yield opts
+    opts.file dest if dest
+
+    Commands.raw_command("convert", *opts.to_a)
+  end
+
+  def self.mogrify(dest = nil)
+    opts = OptBuilder.new
+    yield opts
+    opts.file dest if dest
+    Commands.raw_command("mogrify", *opts.to_a)
+  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)
+    Commands.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 MojoMagick::get_image_size(source_file)
+  def self.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]+) })
+    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(%r{h:([0-9]+)})
+    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 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)
+    { width: width, height: height }
   end
 
-  def MojoMagick::mogrify(dest = nil)
-    opts = OptBuilder.new
-    yield opts
-    opts.file dest if dest
-    raw_command('mogrify', opts.to_s)
+  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
 
-  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
-    ensure
-      file.close
+  class << self
+    private
+
+    def extract_geometry_options(options)
+      if !options[:width].nil? && !options[:height].nil?
+        "#{options[:width]}X#{options[:height]}"
+      elsif !options[:percent].nil?
+        "#{options[:percent]}%"
+      else
+        raise MojoMagickError, "Resize requires width and height or percentage: #{options.inspect}"
+      end
     end
-  end
 
-end # MojoMagick
+    def extract_scale_options(options)
+      [].tap { |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?
+      }.join
+    end
+  end
+end

data/lib/mojo_magick/command_status.rb

@@ -1,10 +1,11 @@
 module MojoMagick
-  class CommandStatus < Struct.new(:command, :return_value, :error, :system_status)
+  CommandStatus = Struct.new(:command, :return_value, :error, :system_status) do
     def success?
       system_status.success?
     end
+
     def exit_code
-      system_status.exitstatus || 'unknown'
+      system_status.exitstatus || "unknown"
     end
   end
 end

data/lib/mojo_magick/commands.rb

@@ -0,0 +1,32 @@
+require_relative "opt_builder"
+
+module MojoMagick
+  class Commands
+    def self.raw_command(*args)
+      execute!(*args)
+    end
+
+    class << self
+      private
+
+      def execute(command, *args)
+        execute = "#{command} #{args}"
+        out, outerr, status = Open3.capture3(command, *args.map(&:to_s))
+        CommandStatus.new execute, out, outerr, status
+      rescue StandardError => e
+        raise MojoError, "#{e.class}: #{e.message}"
+      end
+
+      def 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
+    end
+  end
+end

data/lib/mojo_magick/errors.rb

@@ -2,4 +2,4 @@ module MojoMagick
   class MojoMagickException < StandardError; end
   class MojoError < MojoMagickException; end
   class MojoFailed < MojoMagickException; end
-end 
+end

data/lib/mojo_magick/font.rb

@@ -1,23 +1,20 @@
 module MojoMagick
-
   class Font
-
     attr_accessor :name, :family, :style, :stretch, :weight, :glyphs
 
     def valid?
-      !(name.nil?)
+      !name.nil?
     end
 
     def initialize(property_hash = {})
-      property_hash.symbolize_keys!
-      [:name, :family, :style, :stretch, :weight, :glyphs].each do |f|
+      %i[name family style stretch weight glyphs].each do |f|
         setter = "#{f}="
-        self.send(setter, property_hash[f])
+        send(setter, property_hash[f])
       end
     end
 
     def self.all
-      ImageMagick::Font.all.map{|font_info| Font.new(font_info)}
+      ImageMagick::Fonts.all
     end
   end
 end

data/lib/mojo_magick/opt_builder.rb

@@ -17,9 +17,7 @@ module MojoMagick
 
     # Add files to command line, formatted if necessary
     def file(*args)
-      args.each do |arg|
-        add_formatted arg
-      end
+      @opts << args
       self
     end
     alias files file
@@ -29,32 +27,26 @@ module MojoMagick
     end
 
     # annotate takes non-standard args
-    def annotate(*args)
-      @opts << '-annotate'
-      arguments = args.join.split
-      if arguments.length == 1
-        arguments.unshift '0'
-      end
-      arguments.each do |arg|
-        add_formatted arg
-      end
+    def annotate(*args, geometry: 0)
+      @opts << "-annotate"
+      arguments = [args.join]
+      arguments.unshift geometry.to_s
+      @opts << arguments
     end
 
     # Create a temporary file for the given image and add to command line
     def format(*args)
-      @opts << '-format'
-      args.each do |arg|
-        add_formatted arg
-      end
+      @opts << "-format"
+      @opts << args
     end
 
     def blob(*args)
       data = args[0]
       opts = args[1] || {}
-      opts.each do |k,v|
-        send(k.to_s,v.to_s)
+      opts.each do |k, v|
+        send(k.to_s, v.to_s)
       end
-      tmpfile = MojoMagick::tempfile(data, opts)
+      tmpfile = MojoMagick.tempfile(data, opts)
       file tmpfile
     end
 
@@ -66,31 +58,28 @@ module MojoMagick
     end
 
     # Generic commands. Arguments will be formatted if necessary
+    # rubocop:disable Lint/MissingSuper, Style/MissingRespondToMissing
     def method_missing(command, *args)
-      if command.to_s[-1, 1] == '!'
-        @opts << "+#{command.to_s.chop}"
-      else
-        @opts << "-#{command}"
-      end
-      args.each do |arg|
-        add_formatted arg
-      end
+      @opts << if command.to_s[-1, 1] == "!"
+                 "+#{command.to_s.chop}"
+               else
+                 "-#{command}"
+               end
+      @opts << args
       self
     end
 
-    def to_s
-      @opts.join ' '
+    # rubocop:enable Lint/MissingSuper, Style/MissingRespondToMissing
+    def to_a
+      @opts.flatten
     end
 
     protected
-    def add_formatted(arg)
-      # Quote anything that would cause problems on *nix or windows
-      @opts << quoted_arg(arg)
-    end
 
     def quoted_arg(arg)
-      return arg unless arg =~ /[#'<>^|&();` ]/
-      [ '"', arg.gsub('"', '\"').gsub("'", "\'"), '"'].join
+      return arg unless /[#'<>^|&();` ]/.match?(arg)
+
+      ['"', arg.gsub('"', '\"').tr("'", "\'"), '"'].join
     end
   end
 end