evented_magick 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+group :dev do
+  gem 'rake'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake

data/README.md

@@ -0,0 +1,20 @@
+EventedMagick
+----------------
+
+A EventMachine-aware wrapper for the ImageMagick command line.  Uses EM.system to execute if available.
+Requires Ruby 1.9 since it uses Fibers.  The internals have also been rewritten to reduce the number
+of system() calls.  These changes together reduced the time required to run my test from 20sec to 5sec versus the stock MiniMagick library.
+
+Thanks
+==========
+
+Based on mini_magick by <http://github.com/probablycorey>
+
+Author
+==========
+
+Mike Perham, mperham AT gmail.com,
+[Github](http://github.com/mperham), 
+[Twitter](http://twitter.com/mperham),
+[Blog](http://mikeperham.com)
+

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'evented_magick'
+    gem.summary = "MiniMagick on Eventmachine"
+    gem.email = "mperham@gmail.com"
+    gem.homepage = "https://github.com/mperham/evented/tree/master/evented_magick"
+    gem.authors = ["Mike Perham"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/evented_magick.gemspec

@@ -0,0 +1,42 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{evented_magick}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Perham"]
+  s.date = %q{2011-05-19}
+  s.email = %q{mperham@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "evented_magick.gemspec",
+    "examples/processor.rb",
+    "lib/evented_magick.rb",
+    "lib/image_temp_file.rb"
+  ]
+  s.homepage = %q{https://github.com/mperham/evented/tree/master/evented_magick}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{MiniMagick on Eventmachine}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/examples/processor.rb

@@ -0,0 +1,56 @@
+# Change this to a directory full of random images
+GLOB='/Users/mike/junk/test_images/*.jpg'
+
+require 'evented_magick'
+
+# Execute using Ruby's normal system() call.
+a = Time.now
+files = Dir[GLOB]
+files.each do |filename|
+  image = EventedMagick::Image.new(filename)
+  image['dimensions']
+end
+
+puts "Processed #{files.size} in #{Time.now - a} sec"
+
+# Use Fibers in Ruby 1.9 and EventMachine to run the system
+# calls in parallel.  We only run up to 5 system() calls in parallel
+# to prevent a fork bomb.
+if defined? Fiber
+  require 'fiber'
+  require 'eventmachine'
+  
+  NUM = 5
+  items = EM::Queue.new
+  total = 0
+  process = proc do |filename|
+    begin
+      Fiber.new do
+        image = EventedMagick::Image.new(filename)
+        image['dimensions']
+        total = total + 1
+        items.pop(process)
+      end.resume
+    rescue Exception => ex
+      puts ex.message
+      puts ex.backtrace.join("\n")
+    end
+  end
+
+  EM.run do
+    a = Time.now
+    files = Dir[GLOB]
+    files.each do |filename|
+      items.push filename
+    end
+
+    NUM.times{ items.pop(process) }
+    EM.add_periodic_timer(1) do
+      if items.empty?
+        puts "Processed #{total} in #{Time.now - a} sec"
+        EM.stop
+      end
+    end
+  end
+
+end    

data/lib/evented_magick.rb

@@ -0,0 +1,184 @@
+require "open-uri"
+require "stringio"
+require "fileutils"
+require "open3"
+
+require File.join(File.dirname(__FILE__), '/image_temp_file')
+
+module EventedMagick
+  class MiniMagickError < RuntimeError; end
+
+  class Image
+    attr :path
+    attr :tempfile
+    attr :output
+
+    # Class Methods
+    # -------------
+    class << self
+      def from_blob(blob, ext = nil)
+        begin
+          tempfile = ImageTempFile.new(ext)
+          tempfile.binmode
+          tempfile.write(blob)
+        ensure
+          tempfile.close if tempfile
+        end
+
+        return self.new(tempfile.path, tempfile)
+      end
+
+      # Use this if you don't want to overwrite the image file
+      def open(image_path)
+        File.open(image_path, "rb") do |f|
+          self.from_blob(f.read, File.extname(image_path))
+        end
+      end
+      alias_method :from_file, :open
+    end
+
+    # Instance Methods
+    # ----------------
+    def initialize(input_path, tempfile=nil)
+      @path = input_path
+      @tempfile = tempfile # ensures that the tempfile will stick around until this image is garbage collected.
+      @method = defined?(::EM) && EM.reactor_running? ? :evented_execute : :blocking_execute
+
+      # Ensure that the file is an image
+      output = run_command("identify", "-format", format_option("%m %w %h"), @path)
+      (format, width, height) = output.split
+      @values = { 'format' => format, 'width' => width.to_i, 'height' => height.to_i, 'dimensions' => [width.to_i, height.to_i] }
+    end
+
+    # For reference see http://www.imagemagick.org/script/command-line-options.php#format
+    def [](value)
+      key = value.to_s
+      return @values[key] if %w(format width height dimensions).include? key
+      if key == "size"
+        File.size(@path)
+      else
+        run_command('identify', '-format', "\"#{key}\"", @path).split("\n")[0]
+      end
+    end
+
+    # Sends raw commands to imagemagick's mogrify command. The image path is automatically appended to the command
+    def <<(*args)
+      run_command("mogrify", *args << @path)
+    end
+
+    # This is a 'special' command because it needs to change @path to reflect the new extension
+    # Formatting an animation into a non-animated type will result in ImageMagick creating multiple
+    # pages (starting with 0).  You can choose which page you want to manipulate.  We default to the
+    # first page.
+    def format(format, page=0)
+      run_command("mogrify", "-format", format, @path)
+
+      old_path = @path.dup
+      @path.sub!(/(\.\w+)?$/, ".#{format}")
+      File.delete(old_path) unless old_path == @path
+
+      unless File.exists?(@path)
+        begin
+          FileUtils.copy_file(@path.sub(".#{format}", "-#{page}.#{format}"), @path)
+        rescue e
+          raise MiniMagickError, "Unable to format to #{format}; #{e}" unless File.exist?(@path)
+        end
+      end
+    ensure
+      Dir[@path.sub(/(\.\w+)?$/, "-[0-9]*.#{format}")].each do |fname|
+        File.unlink(fname)
+      end
+    end
+
+    # Writes the temporary image that we are using for processing to the output path
+    def write(output_path)
+      FileUtils.copy_file @path, output_path
+      run_command "identify", output_path # Verify that we have a good image
+    end
+
+    # Give you raw data back
+    def to_blob
+      f = File.new @path
+      f.binmode
+      f.read
+    ensure
+      f.close if f
+    end
+
+    # If an unknown method is called then it is sent through the morgrify program
+    # Look here to find all the commands (http://www.imagemagick.org/script/mogrify.php)
+    def method_missing(symbol, *args)
+      args.push(@path) # push the path onto the end
+      run_command("mogrify", "-#{symbol}", *args)
+      self
+    end
+
+    # You can use multiple commands together using this method
+    def combine_options(&block)
+      c = CommandBuilder.new
+      block.call c
+      run_command("mogrify", *c.args << @path)
+    end
+
+    # Check to see if we are running on win32 -- we need to escape things differently
+    def windows?
+      !(RUBY_PLATFORM =~ /win32/).nil?
+    end
+
+    # Outputs a carriage-return delimited format string for Unix and Windows
+    def format_option(format)
+      windows? ? "#{format}\\n" : "#{format}\\\\n"
+    end
+
+    def run_command(command, *args)
+      full_args = args.collect do |arg|        
+        # args can contain characters like '>' so we must escape them, but don't quote switches
+        if arg !~ /^[\+\-]/
+          "\"#{arg}\""
+        else
+          arg.to_s
+        end
+      end.join(' ')
+
+      full_cmd = "#{command} #{full_args}"
+      (output, status) = send(@method, full_cmd)
+
+      if status.exitstatus == 0
+        output
+      else
+        raise MiniMagickError, "ImageMagick command (#{full_cmd.inspect}) failed: #{{:status_code => status, :output => output}.inspect}"
+      end
+    end
+
+    def evented_execute(cmd)
+      fiber = Fiber.current
+      EM::system(cmd) do |output, status|
+        fiber.resume([output, status])
+      end
+      
+      Fiber.yield
+    end
+    
+    def blocking_execute(cmd)
+      output = `#{cmd}`
+      [output, $?]
+    end
+  end
+
+  class CommandBuilder
+    attr :args
+
+    def initialize
+      @args = []
+    end
+
+    def method_missing(symbol, *args)
+      @args << "-#{symbol}"
+      @args += args
+    end
+
+    def +(value)
+      @args << "+#{value}"
+    end
+  end
+end

data/lib/image_temp_file.rb

@@ -0,0 +1,9 @@
+require "tempfile"
+
+module EventedMagick
+  class ImageTempFile < Tempfile
+    def make_tmpname(ext, n)
+      'mini_magick%d-%d%s' % [$$, n, ext ? ".#{ext}" : '']
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: evented_magick
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Perham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mperham@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- evented_magick.gemspec
+- examples/processor.rb
+- lib/evented_magick.rb
+- lib/image_temp_file.rb
+has_rdoc: true
+homepage: https://github.com/mperham/evented/tree/master/evented_magick
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: MiniMagick on Eventmachine
+test_files: []
+