mini_magick 3.8.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7708f032a0b010ff31ed437bd5f28c5bdf4b269b
-  data.tar.gz: 866153c83f7e87dfe3d1564ca32821221240d6a4
+  metadata.gz: 8921e089d8d63d1391e76876bc63b4e3ff953706
+  data.tar.gz: 38930195578ded9545d86b4225718671a9cd8b6a
 SHA512:
-  metadata.gz: f1af9965e59c483a1566299d984f1657a2fc673c398a07e2fc07fb8e3d821eb9ec4f4f6fbcbcbb2f4497714f703f410ab64bc2b02ded74cb952b019171663ef7
-  data.tar.gz: efe209dfdd7bedd32e7d44dc49cdda24e339a68e49fe4cfbfa900edb60c7a7b9c9627316df330d8ab90a6054e03f6db213c6360313d4ce26d35c925094437a11
+  metadata.gz: 39cc0fccd098a964a02be8e2cde7565d492ab9a5831df89a2f1b90d751d67368c13584c05ef3253aab51f8aecf107a52ca489a6849bd32e80a334869500f4628
+  data.tar.gz: 9c620a81d8b8e601a172d3b8333f4020048e2b7d385ce40fe85caff7f6df7480f1e08c8046d8fa10d66164eb264efe06d9303f111444f55c6193546ca34ab0f2

data/lib/mini_gmagick.rb

@@ -1,2 +1,3 @@
 require 'mini_magick'
+
 MiniMagick.processor = :gm

data/lib/mini_magick/configuration.rb

@@ -0,0 +1,158 @@
+require 'mini_magick/utilities'
+
+module MiniMagick
+  module Configuration
+
+    ##
+    # Set whether you want to use [ImageMagick](http://www.imagemagick.org) or
+    # [GraphicsMagick](http://www.graphicsmagick.org).
+    #
+    # @return [Symbol] `:imagemagick` or `:minimagick`
+    #
+    attr_accessor :cli
+    # @private (for backwards compatibility)
+    attr_accessor :processor
+
+    ##
+    # If you don't have the CLI tools in your PATH, you can set the path to the
+    # executables.
+    #
+    # @return [String]
+    #
+    attr_accessor :cli_path
+    # @private (for backwards compatibility)
+    attr_accessor :processor_path
+
+    ##
+    # If you don't want commands to take too long, you can set a timeout (in
+    # seconds).
+    #
+    # @return [Integer]
+    #
+    attr_accessor :timeout
+    ##
+    # When set to `true`, it outputs each command to STDOUT in their shell
+    # version.
+    #
+    # @return [Boolean]
+    #
+    attr_accessor :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.
+    #
+    # @return [Logger]
+    #
+    attr_accessor :logger
+
+    ##
+    # 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 sucessful,
+    # 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
+
+    ##
+    # Instructs MiniMagick how to execute the shell commands. Available
+    # APIs are "open3" (default) and "posix-spawn" (requires the "posix-spawn"
+    # gem).
+    #
+    # @return [String]
+    #
+    attr_accessor :shell_api
+
+    def self.extended(base)
+      base.validate_on_create = true
+      base.validate_on_write = true
+      base.whiny = true
+      base.shell_api = "open3"
+    end
+
+    ##
+    # @yield [self]
+    # @example
+    #   MiniMagick.configure do |config|
+    #     config.cli = :graphicsmagick
+    #     config.timeout = 5
+    #   end
+    #
+    def configure
+      yield self
+    end
+
+    def processor
+      @processor ||= ["mogrify", "gm"].detect do |processor|
+        MiniMagick::Utilities.which(processor)
+      end
+    end
+
+    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
+
+      reload_tools
+    end
+
+    def cli
+      @cli ||
+        case processor.to_s
+        when "mogrify" then :imagemagick
+        when "gm"      then :graphicsmagick
+        else
+          raise MiniMagick::Error, "ImageMagick/GraphicsMagick is not installed"
+        end
+    end
+
+    def cli=(value)
+      @cli = value
+
+      unless [:imagemagick, :graphicsmagick].include?(@cli)
+        raise ArgumentError,
+          "CLI has to be set to either :imagemagick or :graphicsmagick" \
+          ", was set to #{@cli.inspect}"
+      end
+
+      reload_tools
+    end
+
+    def cli_path
+      @cli_path || @processor_path
+    end
+
+    def logger
+      @logger || MiniMagick::Logger.new($stdout)
+    end
+
+    private
+
+    def reload_tools
+      MiniMagick::Tool::OptionMethods.instances.each(&:reload_methods)
+    end
+
+  end
+end

data/lib/mini_magick/image/info.rb

@@ -0,0 +1,122 @@
+module MiniMagick
+  class Image
+    # @private
+    class Info
+      ASCII_ENCODED_EXIF_KEYS = %w[ExifVersion FlashPixVersion]
+
+      def initialize(path)
+        @path = path
+        @info = {}
+      end
+
+      def [](value, *args)
+        case value
+        when "format", "width", "height", "dimensions", "size"
+          cheap_info(value)
+        when "colorspace"
+          colorspace
+        when "mime_type"
+          mime_type
+        when "resolution"
+          resolution(*args)
+        when "signature"
+          signature
+        when /^EXIF\:/i
+          raw_exif(value)
+        when "exif"
+          exif
+        else
+          raw(value)
+        end
+      end
+
+      def clear
+        @info.clear
+      end
+
+      private
+
+      def cheap_info(value)
+        @info.fetch(value) do
+          format, width, height, size = self["%m %w %h %b"].split(" ")
+
+          @info.update(
+            "format"     => format,
+            "width"      => Integer(width),
+            "height"     => Integer(height),
+            "dimensions" => [Integer(width), Integer(height)],
+            "size"       => size.to_i,
+          )
+
+          @info.fetch(value)
+        end
+      end
+
+      def colorspace
+        @info.fetch("colorspace") do
+          @info["colorspace"] = self["%r"]
+        end
+      end
+
+      def mime_type
+        "image/#{self["format"].downcase}"
+      end
+
+      def resolution(unit = nil)
+        output = identify do |b|
+          b.units unit if unit
+          b.format "%x %y"
+        end
+        output.split(" ").map(&:to_i)
+      end
+
+      def raw_exif(value)
+        self["%[#{value}]"]
+      end
+
+      def exif
+        @info.fetch("exif") do
+          output = self["%[EXIF:*]"]
+          pairs = output.gsub(/^exif:/, "").split("\n").map { |line| line.split("=") }
+          exif = Hash[pairs].tap do |hash|
+            ASCII_ENCODED_EXIF_KEYS.each do |key|
+              next unless hash.has_key?(key)
+
+              value = hash[key]
+              hash[key] = decode_comma_separated_ascii_characters(value)
+            end
+          end
+
+          @info["exif"] = exif
+        end
+      end
+
+      def raw(value)
+        key = "raw:#{value}"
+        @info.fetch(key) do
+          @info[key] = identify { |b| b.format(value) }
+        end
+      end
+
+      def signature
+        @info.fetch("signature") do
+          @info["signature"] = self["%#"]
+        end
+      end
+
+      def identify
+        MiniMagick::Tool::Identify.new do |builder|
+          yield builder if block_given?
+          builder << "#{@path}[0]"
+        end
+      end
+
+      def decode_comma_separated_ascii_characters(encoded_value)
+        return encoded_value unless encoded_value.include?(',')
+
+        encoded_value.scan(/\d+/).map(&:to_i).map(&:chr).join
+      end
+
+    end
+  end
+end