micro_magick 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in micro_magick.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# Simplest possible ruby wrapper for [ImageMagick](http://www.imagemagick.org/) and [GraphicsMagick](http://www.graphicsmagick.org/)
+
+### OMG, SRSLY?
+
+Yes. Seriously.
+
+### The other five libraries didn't make you happy?
+
+No.
+
+### OK, Sunshine, cry me a river.
+
+All I wanted was something that
+
+* didn't create temporary files unnecessarily (like mini_magick)
+* didn't fail with valid geometry specifications, like ```640x480>``` (like mini_magick and quick_magick)
+* didn't assume you only needed to resize your images (like imagery)
+* didn't think you're going to run a public image caching service (like magickly)
+
+## Usage
+
+```micro_magick``` is an exec wrapper for the ```convert``` command, which reads from an image
+source, performs operations on it, and saves the result to a different file.
+
+```ruby
+img = MicroMagick::Convert.new("/path/to/image.jpg")
+img.strip
+img.quality(85)
+img.resize("640x480>")
+img.write("/different/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```
+
+Note that all of ```convert```'s options are supported, but ```micro_magick``` does no validations.
+A ```MicroMagick::ArgumentError``` will be raised on ```.write``` if
+convert writes anything to stderr or the return value is not 0.
+
+Note also that GraphicsMagick will be used automatically, if it's in ruby's PATH, and then will fall back to ImageMagick,
+but you can force the library MicroMagick uses by calling ```MicroMagick.use(:graphicsmagick)``` or ```MicroMagick.use(:imagemagick)```.
+
+In-place image edits through ```mogrify``` are not supported (yet).
+
+### GraphicsMagick versus ImageMagick
+
+In resizing a 2248x4000 image to 640x480:
+* GraphicsMagick takes 141 milliseconds. ImageMagick takes over 550 millis.
+* GraphicsMagick outputs a 37K JPG, ImageMagick outputs a 94K JPG, with no detectable visual differences.
+
+At least in my testing, GraphicsMagick blows ImageMagick out of the water.
+
+Not only is it 4 times faster, it produces 2.5x smaller output with the same quality--WIN WIN.
+
+## Installation
+
+You'll want to [install GraphicsMagick](http://www.graphicsmagick.org/README.html), then
+
+```
+gem install micro_magick
+```
+
+or add to your Gemfile:
+
+```
+gem 'micro_magick'
+```
+
+and run ```bundle```.
+
+## Change history
+
+### 0.0.1
+
+Let's get this party started.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new
+task :default => :test

data/lib/micro_magick/convert.rb

@@ -0,0 +1,37 @@
+require 'shellwords'
+
+module MicroMagick
+  class Convert
+    def initialize(input_file)
+      @args = [Shellwords.escape(input_file)]
+    end
+
+    def command
+      ([MicroMagick.cmd_prefix, "convert", @pre_input] + @args).compact.join(" ")
+    end
+
+    def write(output_file)
+      @args << Shellwords.escape(output_file)
+      MicroMagick.exec command
+    end
+
+    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) }
+    end
+  end
+end

data/lib/micro_magick/version.rb

@@ -0,0 +1,3 @@
+module MicroMagick
+  VERSION = "0.0.1"
+end

data/lib/micro_magick.rb

@@ -0,0 +1,48 @@
+require "micro_magick/version"
+require "micro_magick/convert"
+require "tempfile"
+
+module MicroMagick
+
+  InvalidArgument = Class.new(StandardError)
+
+  ENGINE2PREFIX = { :imagemagick => nil, :graphicsmagick => "gm" }
+
+  # @param engine must be :imagemagick, :graphicsmagick, or nil (which means reset to default behavior,
+  # which means the next run will determine if GraphicsMagick or ImageMagick is installed)
+  def self.use(engine)
+    unless engine.nil? || ENGINE2PREFIX.keys.include?(engine)
+      raise InvalidArgument, "Unknown graphics engine #{engine}"
+    end
+    @engine = engine
+  end
+
+  def self.cmd_prefix
+    @engine ||= begin
+      if system("hash gm 2>&-")
+        :graphicsmagick
+      elsif system("hash convert 2>&-")
+        :imagemagick
+      else
+        raise InvalidArgument, "Please install either GraphicsMagick or ImageMagick"
+      end
+    end
+    ENGINE2PREFIX[@engine]
+  end
+
+  def self.exec(cmd)
+    stderr_file = Tempfile.new('stderr')
+    stderr_path = stderr_file.path
+    stderr_file.close
+    result = `#{cmd} 2>"#{stderr_path}"`
+    stderr = File.read(stderr_path).strip
+    stderr_file.delete
+    if $?.exitstatus != 0 || !stderr.empty?
+      raise InvalidArgument, "#{cmd} failed: #{stderr}"
+    end
+    result
+  end
+
+end
+
+

data/micro_magick.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "micro_magick/version"
+
+Gem::Specification.new do |s|
+  s.name        = "micro_magick"
+  s.version     = MicroMagick::VERSION
+  s.authors     = ["Matthew McEachen"]
+  s.email       = ["matthew-github@mceachen.org"]
+  s.homepage    = ""
+  s.summary     = %q{Simplest ImageMagick/GraphicsMagick ruby wrapper EVAR}
+  s.description = %q{Simplest ImageMagick/GraphicsMagick ruby wrapper EVAR}
+
+  s.rubyforge_project = "micro_magick"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+end

data/test/test_micro_magick.rb

@@ -0,0 +1,46 @@
+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 = Tempfile.new('out.jpg')
+    outfile = tmp.path
+    tmp.close
+    tmp.delete
+    assert !File.exist?(outfile)
+    i.write(outfile)
+    assert_equal i.command, "gm convert -size 128x128 test/640.jpg +profile \\* " +
+      "-quality 85 -gravity Center -crop 250x250 -resize 128x128 " +
+      Shellwords.escape(outfile)
+    assert File.exist?(outfile)
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: micro_magick
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  version_requirements: *id001
+description: Simplest ImageMagick/GraphicsMagick ruby wrapper EVAR
+email: 
+- matthew-github@mceachen.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/micro_magick.rb
+- lib/micro_magick/convert.rb
+- lib/micro_magick/version.rb
+- micro_magick.gemspec
+- test/640.jpg
+- test/test_micro_magick.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: micro_magick
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Simplest ImageMagick/GraphicsMagick ruby wrapper EVAR
+test_files: 
+- test/640.jpg
+- test/test_micro_magick.rb