micro_magick 0.0.2 → 0.0.3

data/README.md

@@ -24,15 +24,32 @@ source, performs operations on it, and saves the result to a different file.
 
 ```ruby
 img = MicroMagick::Convert.new("/path/to/image.jpg")
+img.width
+# => 3264
+img.height
+# => 2448
 img.strip
 img.quality(85)
 img.resize("640x480>")
-img.write("/different/path/image-640x480.jpg")
+img.write("/new/path/image-640x480.jpg")
 ```
 
 This results in the following system call:
 
-```gm convert -size 640x480 /path/to/image.jpg -strip -quality 85 -resize "640x480>" /different/path/image-640x480.jpg```
+```gm convert -size 640x480 /path/to/image.jpg +profile \* -quality 85 -resize "640x480>" /new/path/image-640x480.jpg```
+
+### "Plus" options
+
+To add an output option that has a "plus" prefix, like, ```+matte```, use ```.add_output_option("+matte")```.
+
+### Goodies
+
+There are a couple additional methods that have been added to address common image tasks:
+
+* ```img.strip``` removes all comments and EXIF headers
+* ```img.square_crop``` crops the image to a square (so a 640x480 image would crop down to a 480x480 image, cropped in the middle).
+
+
 
 Note that all of ```convert```'s options are supported, but ```micro_magick``` does no validations.
 A ```MicroMagick::ArgumentError``` will be raised on ```.write``` if
@@ -75,3 +92,7 @@ and run ```bundle```.
 ### 0.0.1
 
 Let's get this party started.
+
+### 0.0.3
+
+Added square_crop, image dimensions, and support for ```+option```s.

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new
+test_task = Rake::TestTask.new
+test_task.pattern = 'test/*test.rb'
+
 task :default => :test

data/lib/micro_magick.rb

@@ -1,5 +1,6 @@
 require "micro_magick/version"
 require "micro_magick/convert"
+require "micro_magick/geometry"
 require "tempfile"
 
 module MicroMagick

data/lib/micro_magick/convert.rb

@@ -3,41 +3,80 @@ require 'shellwords'
 module MicroMagick
   class Convert
     def initialize(input_file)
-      @args = [Shellwords.escape(input_file)]
+      @input_file = input_file
+      @input_options = []
+      @output_options = []
     end
 
+    def width
+      geometry.width
+    end
+
+    def height
+      geometry.height
+    end
+
+    def geometry
+      @geometry ||= MicroMagick::Geometry.new(@input_file)
+    end
+
+    # strip the image of any profiles or comments
+    # (ImageMagick has the -strip command, but GraphicsMagick doesn't.
+    # It turns out that ```+profile *``` does the same thing.)
+    def strip
+      add_output_option("+profile", "*")
+    end
+
+    # Crop to a square, using the specified gravity.
+    def square_crop(gravity = "Center")
+      gravity(gravity) unless gravity.nil?
+      d = [width, height].min
+      crop("#{d}x#{d}+0+0!")
+    end
+
+    # For normal options, like -resize or -flip, you can call .resize("32x32") or .flip().
+    # If you need to add an output option that starts with a '+', you can use this method.
+    def add_output_option(option_name, *args)
+      (@output_options ||= []) << option_name
+      @output_options += args.collect { |ea| Shellwords.escape(ea.to_s) }
+
+      # if we're a resize call, let's give the -size render hint to gm, but only when it's safe:
+      # * we don't have input options yet,
+      # * we're not cropping (because the -size will prevent the crop from working),
+      # * and we have dimensions in the form of NNNxNNN
+      if %w{-geometry -resize -sample -scale}.include?(option_name) &&
+        @input_options.empty? &&
+        !@output_options.include?("-crop") &&
+        (dimensions = args.first) &&
+        (simple_dim = dimensions.scan(/(\d+x\d+)/).first)
+        @input_options << "-size #{simple_dim}"
+      end
+    end
+
+
+    # Executes `convert`, writing to output_file, and clearing all previously set input and output options.
+    # @return the command given to system()
     def write(output_file)
-      @args << Shellwords.escape(output_file)
-      cmd = build_command()
+      @output_file = output_file
+      cmd = command()
       MicroMagick.exec(cmd)
-      @args = @args.first(1)
-      @pre_input = nil
+      @input_options.clear
+      @output_options.clear
       cmd
     end
 
     protected
 
     def method_missing(method, *args, &block)
-      if @pre_input.nil? && [:geometry, :resize, :sample, :scale].include?(method)
-        dimensions = args.first
-        # let's give the -size render hint to gm, but only if we're a resize call, and we have simple dimensions:
-        if dimensions && (simple_dim = dimensions.scan(/(\d+x\d+)/).first)
-          @pre_input = "-size #{simple_dim}"
-        end
-      end
-
-      if method == :strip
-        # ImageMagick knows that ```-strip```, means ```+profile "*"```
-        @args << '+profile'
-        @args << Shellwords.escape('*')
-      else
-        @args << "-#{method.to_s}"
-      end
-      @args += args.compact.collect { |ea| Shellwords.escape(ea.to_s) }
+      add_output_option("-#{method.to_s}", *args)
     end
 
-    def build_command
-      ([MicroMagick.cmd_prefix, "convert", @pre_input] + @args).compact.join(" ")
+    def command
+      ([MicroMagick.cmd_prefix, "convert"] +
+        @input_options +
+        [Shellwords.escape(@input_file)] +
+        @output_options +
+        [Shellwords.escape(@output_file)]).compact.join(" ")
     end
   end
 end

data/lib/micro_magick/geometry.rb

@@ -0,0 +1,22 @@
+require 'shellwords'
+
+module MicroMagick
+  class Geometry
+    attr_reader :width, :height
+
+    def initialize(input_file)
+      cmd = [MicroMagick.cmd_prefix,
+        "identify",
+        "-format",
+        "%w:%h",
+        Shellwords.escape(input_file)
+      ]
+      geometry = MicroMagick.exec(cmd.join(" "))
+      @width, @height = geometry.split(':').collect { |ea| ea.to_i }
+    end
+
+    def to_s
+      "#{width} x #{height}"
+    end
+  end
+end

data/lib/micro_magick/version.rb

@@ -1,3 +1,3 @@
 module MicroMagick
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/geometry_test.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+
+class GeometryTest < Test::Unit::TestCase
+  def test_geometry
+    img = MicroMagick::Convert.new("test/480x270.jpg")
+    assert_equal 270, img.width
+    assert_equal 480, img.height
+  end
+end

data/test/micro_gmagick_test.rb

@@ -0,0 +1,11 @@
+require "test/micro_magick_test_base"
+
+class MicroGmagickTest < MicroMagickTestBase
+
+  def setup
+    MicroMagick.use(:graphicsmagick)
+    super
+  end
+
+end
+

data/test/micro_imagick_test.rb

@@ -0,0 +1,11 @@
+require "test/micro_magick_test_base"
+
+class MicroImagickTest < MicroMagickTestBase
+
+  def setup
+    MicroMagick.use(:imagemagick)
+    super
+  end
+
+end
+

data/test/micro_magick_test.rb

@@ -0,0 +1,33 @@
+require "test/unit"
+
+class MicroMagickTest < Test::Unit::TestCase
+
+  def test_use_nil
+    # This shouldn't throw:
+    MicroMagick.use(nil)
+
+    # eh, ok, now we should stub out system
+    # and verify that the next call to cmd_prefix
+    # calls `hash gm`?
+
+    # Meh, let's just assume that the test running machine has gm in their PATH.
+    assert_equal MicroMagick.cmd_prefix, "gm"
+  end
+
+  def test_use_invalid
+    assert_raise MicroMagick::InvalidArgument do
+      MicroMagick.use(:boink)
+    end
+  end
+
+  def test_use_gm
+    MicroMagick.use(:graphicsmagick)
+    assert_equal "gm", MicroMagick.cmd_prefix
+  end
+
+  def test_use_im
+    MicroMagick.use(:imagemagick)
+    assert_equal nil, MicroMagick.cmd_prefix
+  end
+
+end

data/test/micro_magick_test_base.rb

@@ -0,0 +1,66 @@
+require "test/unit"
+require "shellwords"
+require "micro_magick"
+
+class MicroMagickTestBase < Test::Unit::TestCase
+
+  def setup
+    @img = MicroMagick::Convert.new("test/480x270.jpg")
+    tmp = Tempfile.new('out.jpg')
+    @outfile = tmp.path
+    tmp.close
+    tmp.delete
+    assert !File.exist?(@outfile)
+  end
+
+  def cmd_prefix
+    s = MicroMagick.cmd_prefix
+    s.nil? ? "" : s + " "
+  end
+
+  def test_resize
+    @img.resize("64x64")
+    command = @img.write(@outfile)
+    assert_equal "#{cmd_prefix}convert -size 64x64 test/480x270.jpg -resize 64x64 " + Shellwords.escape(@outfile), command
+    assert File.exist?(@outfile)
+    g = MicroMagick::Geometry.new(@outfile)
+    assert_equal (64 * (270.0/480.0)).to_i, g.width
+    assert_equal 64, g.height
+  end
+
+  def test_strip
+    @img.strip
+    command = @img.write(@outfile)
+    assert_equal "#{cmd_prefix}convert test/480x270.jpg +profile \\* " + Shellwords.escape(@outfile), command
+  end
+
+  def test_convert_with_crop
+    @img.quality(85)
+    @img.square_crop("North")
+    @img.resize("128x128")
+    command = @img.write(@outfile)
+    assert_equal "#{cmd_prefix}convert test/480x270.jpg " +
+      "-quality 85 -gravity North -crop 270x270\\+0\\+0\\! -resize 128x128 " +
+      Shellwords.escape(@outfile),
+      command
+    assert File.exist?(@outfile)
+    g = MicroMagick::Geometry.new(@outfile)
+    assert_equal 128, g.width
+    assert_equal 128, g.height
+
+    # make sure calling previous arguments don't leak into new calls:
+    @img.resize("64x64")
+    command = @img.write(@outfile)
+    assert_equal "#{cmd_prefix}convert -size 64x64 test/480x270.jpg -resize 64x64 " +
+      Shellwords.escape(@outfile),
+      command
+  end
+
+  def test_bad_args
+    @img.boing
+    assert_raise MicroMagick::InvalidArgument do
+      @img.write(@outfile)
+    end
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: micro_magick
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Matthew McEachen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-01 00:00:00 Z
+date: 2012-03-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -47,10 +47,15 @@ files:
 - Rakefile
 - lib/micro_magick.rb
 - lib/micro_magick/convert.rb
+- lib/micro_magick/geometry.rb
 - lib/micro_magick/version.rb
 - micro_magick.gemspec
-- test/640.jpg
-- test/test_micro_magick.rb
+- test/480x270.jpg
+- test/geometry_test.rb
+- test/micro_gmagick_test.rb
+- test/micro_imagick_test.rb
+- test/micro_magick_test.rb
+- test/micro_magick_test_base.rb
 homepage: ""
 licenses: []
 
@@ -85,5 +90,9 @@ signing_key:
 specification_version: 3
 summary: Simplest ImageMagick/GraphicsMagick ruby wrapper EVAR
 test_files: 
-- test/640.jpg
-- test/test_micro_magick.rb
+- test/480x270.jpg
+- test/geometry_test.rb
+- test/micro_gmagick_test.rb
+- test/micro_imagick_test.rb
+- test/micro_magick_test.rb
+- test/micro_magick_test_base.rb

data/test/test_micro_magick.rb

@@ -1,65 +0,0 @@
-require "test/unit"
-require "shellwords"
-require "micro_magick"
-
-class TestMicroMagick < Test::Unit::TestCase
-
-  def test_use
-    MicroMagick.use(:graphicsmagick)
-    assert_equal MicroMagick.cmd_prefix, "gm"
-    MicroMagick.use(:imagemagick)
-    assert_equal MicroMagick.cmd_prefix, nil
-
-    # This shouldn't throw:
-    MicroMagick.use(nil)
-    # eh, ok, now we should stub out system
-    # and verify that the next call to cmd_prefix
-    # calls `hash gm`?
-
-    # Meh, let's just assume that the test running machine has gm in their PATH.
-    assert_equal MicroMagick.cmd_prefix, "gm"
-
-    assert_raise MicroMagick::InvalidArgument do
-      MicroMagick.use(:boink)
-    end
-  end
-
-  def test_convert
-    i = MicroMagick::Convert.new("test/640.jpg")
-    i.strip
-    i.quality(85)
-    i.gravity("Center")
-    i.crop("250x250")
-    i.resize("128x128")
-    tmp = mktmpfile
-    assert !File.exist?(tmp)
-    command = i.write(tmp)
-    assert_equal command, "gm convert -size 128x128 test/640.jpg +profile \\* " +
-      "-quality 85 -gravity Center -crop 250x250 -resize 128x128 " +
-      Shellwords.escape(tmp)
-    assert File.exist?(tmp)
-
-    # make sure calling previous arguments don't leak into new calls:
-    i.resize("64x64")
-    command = i.write(tmp)
-    assert_equal command, "gm convert -size 64x64 test/640.jpg -resize 64x64 " +
-      Shellwords.escape(tmp)
-  end
-
-  def mktmpfile
-    tmp = Tempfile.new('out.jpg')
-    outfile = tmp.path
-    tmp.close
-    tmp.delete
-    outfile
-  end
-
-  def test_bad_args
-    i = MicroMagick::Convert.new("test/640.jpg")
-    i.boing
-    assert_raise MicroMagick::InvalidArgument do
-      i.write(mktmpfile)
-    end
-  end
-end
-