mini_magick 4.0.0.rc → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e11b9e22bbabb55096ee32c8635e5302459b234
-  data.tar.gz: ed3df8df5bd3c55605760ce4d68eb070180fd890
+  metadata.gz: 65e1d54473e9a429c269d44123e8a6977bf489fe
+  data.tar.gz: 7b2b4762e6ee9d6d47ade148b65df993c3b9e08e
 SHA512:
-  metadata.gz: e97b6cce0e021ab9f21a31e74e9b8afe9aca5e95c722fcd1230d31a3ece8310bed90fe91f2dc131a783a3e9c987217cc962b6fc296926c6f73fbb8ab263ce06d
-  data.tar.gz: 7f489774f7ce93a2e63d5fce3d12ddea5f70aa2a98b6343ff5f49df3cf66f67d9f8fbcd135f9eb9d3214e5160af7bfcc82d425895e5491dbe5194228b66a2b50
+  metadata.gz: 4852bcf9522da52f7603a2ef96635312b91fef2e72dbcaa77dbec94dddd8e949e4c34d3e6ccc3da8588e42efe6c43b01cace0166d840f40c478966252f0390d0
+  data.tar.gz: 77bd9eac7c1a015ad7e6cc6de77657a210fc6b7bbb907928aafb08a0bb0b0c237e85a2ca4cd7ecd75cdfda7b55732352ebda096f46adb699ea62b52695385feb

data/lib/mini_magick/image.rb

@@ -149,6 +149,16 @@ module MiniMagick
       combine_options(&block) if block
     end
 
+    def eql?(other)
+      self.class.equal?(other.class) &&
+        signature == other.signature
+    end
+    alias == eql?
+
+    def hash
+      signature.hash
+    end
+
     ##
     # Returns raw image data.
     #
@@ -232,6 +242,18 @@ module MiniMagick
     # @return [Array<Integer>]
     #
     attribute :resolution
+    ##
+    # Returns the message digest of this image as a SHA-256, hexidecimal
+    # encoded string. This signature uniquely identifies the image and is
+    # convenient for determining if an image has been modified or whether two
+    # images are identical.
+    #
+    # @example
+    #   image.signature #=> "60a7848c4ca6e36b8e2c5dea632ecdc29e9637791d2c59ebf7a54c0c6a74ef7e"
+    # @see http://www.imagemagick.org/api/signature.php
+    # @return [String]
+    #
+    attribute :signature
 
     ##
     # Use this method if you want to access raw Identify's format API.
@@ -358,6 +380,10 @@ module MiniMagick
       end
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      MiniMagick::Tool::Mogrify.new.respond_to?(method_name, include_private)
+    end
+
     ##
     # Writes the temporary file out to either a file location (by passing in a
     # String) or by passing in a Stream that you can #write(chunk) to

data/lib/mini_magick/image/info.rb

@@ -2,6 +2,7 @@ module MiniMagick
   class Image
     # @private
     class Info
+      ASCII_ENCODED_EXIF_KEYS = %w[ExifVersion FlashPixVersion]
 
       def initialize(path)
         @path = path
@@ -18,6 +19,8 @@ module MiniMagick
           mime_type
         when "resolution"
           resolution(*args)
+        when "signature"
+          signature
         when /^EXIF\:/i
           raw_exif(value)
         when "exif"
@@ -76,11 +79,11 @@ module MiniMagick
           output = self["%[EXIF:*]"]
           pairs = output.gsub(/^exif:/, "").split("\n").map { |line| line.split("=") }
           exif = Hash[pairs].tap do |hash|
-            hash.each do |key, value|
-              if value.include?(",")
-                # Sometimes exif comes in a comma-separated list of character values
-                hash[key] = value.scan(/\d+/).map(&:to_i).map(&:chr).join
-              end
+            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
 
@@ -89,7 +92,16 @@ module MiniMagick
       end
 
       def raw(value)
-        identify { |b| b.format(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
@@ -99,6 +111,12 @@ module MiniMagick
         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

data/lib/mini_magick/shell.rb

@@ -26,6 +26,8 @@ module MiniMagick
         fail MiniMagick::Error, stderr
       end if @whiny
 
+      $stderr.print(stderr)
+
       stdout
     end
 

data/lib/mini_magick/tool.rb

@@ -59,9 +59,16 @@ module MiniMagick
     # @private
     attr_reader :name, :args
 
-    def initialize(name)
-      @name = name
-      @args = []
+    # @param whiny [Boolean] Whether to raise errors on exit codes different
+    #   than 0.
+    # @example
+    #   MiniMagick::Tool::Identify.new(false) do |identify|
+    #     identify.help # returns exit status 1, which would otherwise throw an error
+    #   end
+    def initialize(name, whiny = true)
+      @name  = name
+      @whiny = whiny
+      @args  = []
     end
 
     ##
@@ -80,7 +87,7 @@ module MiniMagick
     #
     # @return [String] Output of the command
     #
-    def call(whiny = true)
+    def call(whiny = @whiny)
       shell = MiniMagick::Shell.new(whiny)
       shell.run(command).strip
     end
@@ -128,6 +135,16 @@ module MiniMagick
       self
     end
 
+    ##
+    # Merges a list of raw options.
+    #
+    # @return [self]
+    #
+    def merge!(new_args)
+      new_args.each { |arg| self << arg }
+      self
+    end
+
     ##
     # Changes the last operator to its "plus" form.
     #
@@ -139,9 +156,9 @@ module MiniMagick
     #
     # @return [self]
     #
-    def +(value = nil)
-      args.last.sub!(/^-/, '+')
-      args << value.to_s if value
+    def +(*values)
+      args[-1] = args[-1].sub(/^-/, '+')
+      self.merge!(values)
       self
     end
 
@@ -155,23 +172,20 @@ module MiniMagick
     #
     # @private
     #
-    class OptionMethods < Module
+    class OptionMethods < Module # think about it for a minute
 
       def self.instances
         @instances ||= []
       end
 
-      def self.new(*args, &block)
-        super.tap do |instance|
-          self.instances << instance
-        end
+      def initialize(tool_name)
+        @tool_name = tool_name
+        reload_methods
+        self.class.instances << self
       end
 
-      def initialize(tool_name)
-        super() do
-          @tool_name = tool_name
-          reload_methods
-        end
+      def to_s
+        "OptionMethods(#{@tool_name})"
       end
 
       ##
@@ -179,15 +193,12 @@ module MiniMagick
       #
       def reload_methods
         instance_methods(false).each { |method| undef_method(method) }
-
-        self.creation_operator *%w[xc canvas logo rose gradient radial-gradient
-                                   plasma tile pattern label caption text]
-
-        help = (MiniMagick::Tool.new(@tool_name) << "-help").call(false)
-        cli_options = help.scan(/^\s+-[a-z\-]+/).map(&:strip)
-        self.option *cli_options
+        creation_operator *creation_operators
+        option *cli_options
       end
 
+      private
+
       ##
       # Creates method based on command-line option's name.
       #
@@ -199,10 +210,10 @@ module MiniMagick
       #
       def option(*options)
         options.each do |option|
-          define_method(option[1..-1].gsub('-', '_')) do |value = nil|
-          self << option
-          self << value.to_s if value
-          self
+          define_method(option[1..-1].gsub('-', '_')) do |*values|
+            self << option
+            self.merge!(values)
+            self
           end
         end
       end
@@ -223,8 +234,14 @@ module MiniMagick
         end
       end
 
-      def to_s
-        "OptionMethods(#{@tool_name})"
+      def creation_operators
+        %w[xc canvas logo rose gradient radial-gradient
+           plasma tile pattern label caption text]
+      end
+
+      def cli_options
+        help = MiniMagick::Tool.new(@tool_name, false) { |b| b << "-help" }
+        cli_options = help.scan(/^\s+-[a-z\-]+/).map(&:strip)
       end
 
     end

data/lib/mini_magick/tool/animate.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Animate < MiniMagick::Tool
 
-      def initialize
-        super("animate")
+      def initialize(*args)
+        super("animate", *args)
       end
 
     end

data/lib/mini_magick/tool/compare.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Compare < MiniMagick::Tool
 
-      def initialize
-        super("compare")
+      def initialize(*args)
+        super("compare", *args)
       end
 
     end

data/lib/mini_magick/tool/composite.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Composite < MiniMagick::Tool
 
-      def initialize
-        super("composite")
+      def initialize(*args)
+        super("composite", *args)
       end
 
     end

data/lib/mini_magick/tool/conjure.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Conjure < MiniMagick::Tool
 
-      def initialize
-        super("conjure")
+      def initialize(*args)
+        super("conjure", *args)
       end
 
     end

data/lib/mini_magick/tool/convert.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Convert < MiniMagick::Tool
 
-      def initialize
-        super("convert")
+      def initialize(*args)
+        super("convert", *args)
       end
 
     end

data/lib/mini_magick/tool/display.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Display < MiniMagick::Tool
 
-      def initialize
-        super("display")
+      def initialize(*args)
+        super("display", *args)
       end
 
     end

data/lib/mini_magick/tool/identify.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Identify < MiniMagick::Tool
 
-      def initialize
-        super("identify")
+      def initialize(*args)
+        super("identify", *args)
       end
 
     end

data/lib/mini_magick/tool/import.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Import < MiniMagick::Tool
 
-      def initialize
-        super("import")
+      def initialize(*args)
+        super("import", *args)
       end
 
     end

data/lib/mini_magick/tool/mogrify.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Mogrify < MiniMagick::Tool
 
-      def initialize
-        super("mogrify")
+      def initialize(*args)
+        super("mogrify", *args)
       end
 
     end

data/lib/mini_magick/tool/montage.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Montage < MiniMagick::Tool
 
-      def initialize
-        super("montage")
+      def initialize(*args)
+        super("montage", *args)
       end
 
     end

data/lib/mini_magick/tool/stream.rb

@@ -5,8 +5,8 @@ module MiniMagick
     #
     class Stream < MiniMagick::Tool
 
-      def initialize
-        super("stream")
+      def initialize(*args)
+        super("stream", *args)
       end
 
     end

data/lib/mini_magick/version.rb

@@ -10,7 +10,7 @@ module MiniMagick
     MAJOR = 4
     MINOR = 0
     TINY  = 0
-    PRE   = "rc"
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/spec/lib/mini_magick/image_spec.rb

@@ -119,6 +119,35 @@ require "stringio"
         end
       end
 
+      describe "equivalence" do
+        subject(:image) { described_class.new(image_path) }
+        let(:same_image) { described_class.new(image_path) }
+        let(:other_image) { described_class.new(image_path(:exif)) }
+
+        it "is #== and #eql? to itself" do
+          expect(image).to eq(image)
+          expect(image).to eql(image)
+        end
+
+        it "is #== and #eql? to an instance of the same image" do
+          expect(image).to eq(same_image)
+          expect(image).to eql(same_image)
+        end
+
+        it "is not #== nor #eql? to an instance of a different image" do
+          expect(image).not_to eq(other_image)
+          expect(image).not_to eql(other_image)
+        end
+
+        it "generates the same hash code for an instance of the same image" do
+          expect(image.hash).to eq(same_image.hash)
+        end
+
+        it "generates different same hash codes for a different image" do
+          expect(image.hash).not_to eq(other_image.hash)
+        end
+      end
+
       describe "#format" do
         subject { described_class.open(image_path(:jpg)) }
 
@@ -225,6 +254,7 @@ require "stringio"
           expect(subject[:dimensions]).to all(be_a(Fixnum))
           expect(subject[:colorspace]).to be_a(String)
           expect(subject[:format]).to match(/[A-Z]/)
+          expect(subject[:signature]).to match(/[[:alnum:]]{64}/)
         end
 
         it "supports string keys" do
@@ -233,11 +263,17 @@ require "stringio"
           expect(subject["dimensions"]).to all(be_a(Fixnum))
           expect(subject["colorspace"]).to be_a(String)
           expect(subject["format"]).to match(/[A-Z]/)
+          expect(subject['signature']).to match(/[[:alnum:]]{64}/)
         end
 
         it "reads exif" do
           subject = described_class.new(image_path(:exif))
+          gps_latitude = subject.exif["GPSLatitude"].split(/\s*,\s*/)
+          gps_longitude = subject.exif["GPSLongitude"].split(/\s*,\s*/)
+
           expect(subject["EXIF:ColorSpace"]).to eq "1"
+          expect(gps_latitude.size).to eq 3
+          expect(gps_longitude.size).to eq 3
         end
 
         it "passes unknown values directly to -format" do
@@ -254,6 +290,7 @@ require "stringio"
         expect(subject.size).to be_a(Fixnum).and be_nonzero
         expect(subject.colorspace).to be_a(String)
         expect(subject.resolution).to all(be_a(Fixnum))
+        expect(subject.signature).to match(/[[:alnum:]]{64}/)
       end
 
       describe "#exif" do
@@ -262,6 +299,10 @@ require "stringio"
         it "returns a hash of EXIF data" do
           expect(subject.exif["DateTimeOriginal"]).to be_a(String)
         end
+
+        it "decodes the ExifVersion" do
+          expect(subject.exif["ExifVersion"]).to eq("0221")
+        end
       end
 
       describe "#resolution" do
@@ -299,19 +340,31 @@ require "stringio"
         end
       end
 
-      describe "#method_missing" do
-        it "executes the command correctly" do
-          expect { subject.resize '20x30!' }
-            .to change { subject.dimensions }.to [20, 30]
-        end
+      describe "missing methods" do
+        context "for a known method" do
+          it "is executed by #method_missing" do
+            expect { subject.resize '20x30!' }
+              .to change { subject.dimensions }.to [20, 30]
+          end
+
+          it "returns self" do
+            expect(subject.resize('20x30!')).to eq subject
+          end
 
-        it "fails with a correct NoMethodError" do
-          expect { subject.foo }
-            .to raise_error(NoMethodError, /MiniMagick::Image/)
+          it "can be responed to" do
+            expect(subject.respond_to?(:resize)).to eq true
+          end
         end
 
-        it "returns self" do
-          expect(subject.resize('20x30!')).to eq subject
+        context "for an unknown method" do
+          it "fails with a NoMethodError" do
+            expect { subject.foo }
+              .to raise_error(NoMethodError, /MiniMagick::Image/)
+          end
+
+          it "cannot be responded to" do
+            expect(subject.respond_to?(:foo)).to eq false
+          end
         end
       end
 

data/spec/lib/mini_magick/shell_spec.rb

@@ -32,6 +32,12 @@ RSpec.describe MiniMagick::Shell do
       allow(subject).to receive(:execute).and_return(["stdout", "", 127])
       expect(subject.run(%W[foo])).to eq "stdout"
     end
+
+    it "prints to stderr output to $stderr in non-whiny mode" do
+      subject = described_class.new(false)
+      allow(subject).to receive(:execute).and_return(["", "stderr", 1])
+      expect { subject.run(%W[foo]) }.to output("stderr").to_stderr
+    end
   end
 
   describe "#execute" do
@@ -40,12 +46,6 @@ RSpec.describe MiniMagick::Shell do
       expect(stdout).to match("GIF")
     end
 
-    it "timeouts afer a period of time" do
-      allow(MiniMagick).to receive(:timeout).and_return(0.001)
-      expect { subject.execute(%W[identify -format %[EXIF:*] #{image_path(:exif)}]) }
-        .to raise_error(Timeout::Error)
-    end
-
     it "logs the command and execution time in debug mode" do
       allow(MiniMagick).to receive(:debug).and_return(true)
       expect { subject.execute(%W[identify #{image_path(:gif)}]) }.

data/spec/lib/mini_magick/tool_spec.rb

@@ -48,16 +48,26 @@ RSpec.describe MiniMagick::Tool do
 
   describe "#<<" do
     it "adds argument to the args list" do
-      subject << "foo" << "bar"
-      expect(subject.args).to eq %W[foo bar]
+      subject << "foo" << "bar" << 123
+      expect(subject.args).to eq %W[foo bar 123]
+    end
+  end
+
+  describe "#merge!" do
+    it "adds arguments to the args list" do
+      subject << "pre-existing"
+      subject.merge! ["foo", 123]
+      expect(subject.args).to eq %W[pre-existing foo 123]
     end
   end
 
   describe "#+" do
     it "switches the last option to + form" do
+      subject.help
       subject.help.+
-      subject.debug.+ 8
-      expect(subject.args).to eq %W[+help +debug 8]
+      subject.debug.+ "foo"
+      subject.debug.+ 8, "bar"
+      expect(subject.args).to eq %W[-help +help +debug foo +debug 8 bar]
     end
   end
 
@@ -87,4 +97,11 @@ RSpec.describe MiniMagick::Tool do
     expect(subject).not_to respond_to(:quiet)
     expect(subject).to respond_to(:ping)
   end
+
+  it "doesn't raise errors when false is passed to the constructor" do
+    subject.help
+    subject.call(false)
+
+    MiniMagick::Tool::Identify.new(false, &:help)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_magick
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc
+  version: 4.0.0
 platform: ruby
 authors:
 - Corey Johnson
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-05 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - You must have ImageMagick or GraphicsMagick installed
 rubyforge_project: