image_genie 0.2.0

data/Manifest

@@ -0,0 +1,12 @@
+Manifest
+README.rdoc
+Rakefile
+lib/image_genie.rb
+lib/image_genie/base.rb
+lib/image_genie/command.rb
+lib/image_genie/convert.rb
+lib/image_genie/identify.rb
+lib/image_genie/montage.rb
+lib/image_genie/verify.rb
+test/test_helper.rb
+test/unit/base_test.rb

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'  
+require 'rake'
+require 'echoe'  
+require 'rake/testtask'
+
+Echoe.new('image_genie', '0.2.0') do |p|  
+  p.description     = "ImageGenie - Simple Wrapper for command line ImageMagick"  
+  p.url             = "https://github.com/bkimble"
+  p.author          = "Billy Kimble"  
+  p.email           = "basslines@gmail.com"  
+  p.ignore_pattern  = ["tmp/*", "script/*"]  
+  p.development_dependencies = ["open4"]  
+end  
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/image_genie.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{image_genie}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Billy Kimble"]
+  s.date = %q{2011-02-08}
+  s.description = %q{ImageGenie - Simple Wrapper for command line ImageMagick}
+  s.email = %q{basslines@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/image_genie.rb", "lib/image_genie/base.rb", "lib/image_genie/command.rb", "lib/image_genie/convert.rb", "lib/image_genie/identify.rb", "lib/image_genie/montage.rb", "lib/image_genie/verify.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/image_genie.rb", "lib/image_genie/base.rb", "lib/image_genie/command.rb", "lib/image_genie/convert.rb", "lib/image_genie/identify.rb", "lib/image_genie/montage.rb", "lib/image_genie/verify.rb", "test/test_helper.rb", "test/unit/base_test.rb", "image_genie.gemspec"]
+  s.homepage = %q{https://github.com/bkimble}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Image_genie", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{image_genie}
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{ImageGenie - Simple Wrapper for command line ImageMagick}
+  s.test_files = ["test/test_helper.rb", "test/unit/base_test.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<open4>, [">= 0"])
+    else
+      s.add_dependency(%q<open4>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<open4>, [">= 0"])
+  end
+end

data/lib/image_genie.rb

@@ -0,0 +1,49 @@
+require 'open4'
+
+# ImageGenie -- a simple wrapper for ImageMagick.
+# Billy Kimble 2011
+
+# Usage: 
+#
+# ImageGenie.convert(src=<File>, options)
+#   converts a file at src.path with command line options given as options, and returns a handle to a tempfile containing the
+#   contents of the converted file. Raises an exception with the errors if it can't find the file or has problems converting it.
+#
+# ImageGenie.montage(filenames=[], options)
+#   combines all files contained in filenames into a montage (mosaic) image, and returns a tempfile handle to the contents of the montage.
+#   Raises an exception with the errors if any 1 of the files in filenames has errors.
+#
+# ImageGenie.identify(filename=<String>, options)
+#   identifies the file and returns a hash containing:
+#   :filename, :format, :dimensions, :geometry, :bit, :image_class, :colors, :filesize, :usertime, :identify_time
+#   Raises an exception with the errors if it can't find the file or has problems identfying it.
+#
+# ImageGenie.verify(filename=<String>, options)
+#   verifies that the file pointed to by filename is valid. Returns true on success, or an an exception with the errors 
+#  if it can't find the file or has problems identfying it
+  
+module ImageGenie
+  class UnableToLocateBinaryError < StandardError; end;   
+  # Autoload any modules defined in classes in the image_genie directory.
+  module_path = [File.dirname(__FILE__),self.name.underscore,'*'].join('/')
+  Dir[module_path].each do |file|
+    constant_name = File.basename(file,'.rb').camelcase.to_sym
+    autoload constant_name, file
+  end
+  
+  module ClassMethods
+    # Make helper methods
+    [:convert,:montage,:identify,:verify].each do |method|
+      define_method(method) do |*splat|
+        module_name = "#{self.name}::#{method.to_s.capitalize}"
+        target = module_name.constantize
+        target.run(*splat)
+      end
+    end
+  end
+  
+  class << self
+    include ClassMethods
+  end    
+end
+

data/lib/image_genie/base.rb

@@ -0,0 +1,63 @@
+module ImageGenie
+  class Base
+    
+    # Discover ImageMagick paths on the current system    
+    def self.paths
+      if !@paths
+        @paths = {:identify => "",:montage => "",:convert => ""}
+        @paths.keys.each do |program|
+          command = "which #{program}"
+          pid, stdin, stdout, stderr = Open4::popen4(command)
+          path = stdout.read.strip
+          @paths[program] = path
+        end
+      end
+      @paths
+    end    
+
+    # Eventually I want this method to accept a model that encapsulates its command execution logic. 
+    def self.execute(command)
+      logger.info("Executing #{command}")
+      pid, stdin, stdout, stderr = Open4::popen4(command)
+      yield pid,stdin,stdout,stderr
+    end
+
+    def self.path_for(program)
+      paths[program.to_sym]
+    end
+    
+    def self.make_command(command,*args)
+      command.strip!
+      components = [command]
+      args.each do |component|
+        components << case (component.class.name)
+            when 'Hash': make_flags(component)
+            when 'Array': make_args(component)
+            else " #{component}"
+        end
+      end
+      components.compact.join(' ')
+    end
+    
+    def self.make_args(args)
+      args = [args] if !args.is_a?(Array)
+      return nil if args.empty?
+      args.join(' ')
+    end
+    
+    # There is probably a better library to handle creation of command line flags,
+    # but this works for now.
+    def self.make_flags(options={})
+      return nil if options.empty?
+      options.collect{|k,v| "-#{k} #{v}"}.join(' ')
+    end
+    
+    def self.logger
+      @log ||= TimestampedBufferedLogger.new(Rails.root.join('log','image_genie.log'))
+    end   
+    
+    def logger
+      self.class.logger
+    end     
+  end
+end

data/lib/image_genie/command.rb

@@ -0,0 +1,11 @@
+module ImageGenie
+  class Command < Base    
+    def self.handle_errors(stderr,status,exception)
+      unless status.exitstatus.zero?
+        errors = stderr.read.strip
+        logger.error("#{self.name} #{errors}")
+        raise(exception, errors)
+      end      
+    end
+  end
+end

data/lib/image_genie/convert.rb

@@ -0,0 +1,33 @@
+module ImageGenie
+  class ConvertError < StandardError; end; 
+  class Convert < Command
+    def self.run(src, options={})
+      raise(UnableToLocateBinaryError, 'convert') if path_for(:convert).blank?
+
+      logger.info("#{self.name} Attempting to convert #{src.path}")
+
+      begin
+        raise Errno::ENOENT,"#{src.path}" unless File.exists?(src.path)
+      rescue Errno::ENOENT => e
+        logger.error("#{self.name} #{e.message}")
+        raise
+      end
+
+      format = File.extname(src.path).downcase.gsub(/\.|\?/,'')
+
+      command = "#{path_for(:convert)} #{make_flags(options)} #{format}:#{src.path} #{format}:-"
+      temp_image_file = Tempfile.new([src.original_filename,".#{format}"]) 
+
+      execute(command) do |pid,stdin,stdout,stderr|
+        while line = stdout.gets
+          temp_image_file.puts line
+        end
+        ignored, status = Process::waitpid2 pid
+        handle_errors(stderr,status,ConvertError)
+      end
+
+      temp_image_file.rewind
+      return temp_image_file
+    end
+  end
+end

data/lib/image_genie/identify.rb

@@ -0,0 +1,33 @@
+# Verify an image is valid by calling 'identify' on it and testing for errors on the return.
+module ImageGenie
+  class IdentifyError < StandardError; end;
+  class Identify < Command
+    def self.run(filename, options={})
+      raise(UnableToLocateBinaryError, 'identify') if path_for(:identify).blank?
+
+      begin
+        raise Errno::ENOENT,"#{filename}" unless File.exists?(filename)
+      rescue Errno::ENOENT => e
+        logger.error("#{self.name} #{e.message}")
+        raise
+      end
+
+      command = "#{path_for(:identify)} #{filename}"
+      output = ''
+
+      # We test for STDERR content
+      execute(command) do |pid,stdin,stdout,stderr|
+        while !stdout.eof?
+          output += stdout.readline
+        end
+
+        ignored, status = Process::waitpid2 pid
+        handle_errors(stderr,status,IdentifyError)
+      end
+
+      fields = [:filename,:format,:dimensions,:geometry,:bit,:image_class,:colors,:filesize,:usertime,:identify_time]                    
+      return Hash[fields.zip(stdout.read.split(' '))]
+    end
+  end
+end
+

data/lib/image_genie/montage.rb

@@ -0,0 +1,57 @@
+module ImageGenie
+  class MontageError < StandardError; end; 
+  class Montage < Command
+    attr_accessor :filenames,:filename,:options
+
+    def initialize(options={})
+      self.filenames = []
+      self.options = options
+    end
+
+
+    def self.run(filenames, options={})
+      raise(UnableToLocateBinaryError, 'montage') if path_for(:montage).blank?
+      # Montage hates when you attempt to give it files with a path in it, so we
+      # need to change to the system specified temp directory to do our work.
+      Dir.chdir(Dir::tmpdir)
+      # Create a temp file that will be all component files of this montage
+      temp_image_file = Tempfile.new(['montage','.jpg'])
+      temp_image_list_file = Tempfile.new(['montage_image_filenames','.txt']) 
+      temp_image_list_file.puts filenames.join("\n")
+      temp_image_list_file.rewind
+
+      logger.info("#{self.name} Attempting to make a montage of #{filenames.size} files")
+
+      command = make_command(path_for(:montage), "@\"#{File.basename(temp_image_list_file.path)}\"", options, "jpeg:-")
+
+      begin
+        execute(command) do |pid,stdin,stdout,stderr|
+          while !stdout.eof?
+            temp_image_file.puts stdout.readline
+          end
+          temp_image_file.rewind
+
+          # Still foggy on if we need to wait until we read from STDOUT before waiting, or if
+          # we wait until we read STDOUT and STDERR.
+          ignored, status = Process::waitpid2 pid
+          handle_errors(stderr,status,MontageError)
+        end
+      rescue Exception => e
+        # Close the tempfile before raising
+        temp_image_file.close
+        raise
+      ensure
+        logger.info("#{self.name} Cleaning up files")
+        temp_image_list_file.close
+      end
+
+      return temp_image_file
+
+    end
+  end
+end
+
+
+
+
+

data/lib/image_genie/verify.rb

@@ -0,0 +1,27 @@
+# Verify an image is valid by calling 'identify' on it with verbose turned on , 
+# and testing for errors on the return.
+module ImageGenie
+  class VerifyError < StandardError; end;
+  class Verify < Command
+
+    def self.run(filename, options={})
+      raise(UnableToLocateBinaryError, 'identify') if path_for(:identify).blank?
+
+      begin
+        raise Errno::ENOENT,"#{filename}" unless File.exists?(filename)
+      rescue Errno::ENOENT => e
+        logger.error("#{self.name} #{e.message}")
+        raise
+      end      
+
+      command = "#{path_for(:identify)} #{filename}"
+      # We test for STDERR content        
+      execute(command) do |pid,stdin,stdout,stderr|
+        ignored, status = Process::waitpid2 pid    
+        handle_errors(stderr,status,VerifyError)
+      end
+      
+      return true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'tempfile'
+require 'test/unit'
+require 'active_support'
+require 'active_support/inflector' # needed for string methods like underscore
+require 'open4'
+require 'mocha'
+require 'image_genie'
+
+require 'active_support/testing/declarative'
+include ActiveSupport::Testing::Declarative # for syntactic sugar of "test 'foo' do .."

data/test/unit/base_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class BaseTest < Test::Unit::TestCase
+  test "path for when path exists" do
+    ImageGenie::Base.expects(:paths).returns({:convert => "/some/dir/convert", :montage => "/some/dir/montage"}).times(2)
+    assert_equal("/some/dir/convert", ImageGenie::Base.path_for(:convert))
+    assert_equal("/some/dir/montage", ImageGenie::Base.path_for(:montage))    
+  end
+
+  test "path for when path doesnt exist" do
+    ImageGenie::Base.expects(:paths).returns({:convert => "/some/dir/convert", :montage => "/some/dir/montage"})
+    assert_equal(nil, ImageGenie::Base.path_for(:identify))
+  end
+  
+  test "make command with args only" do
+    command = "some_command"
+    args = ["abc","def"]
+    assert_equal("some_command abc def", ImageGenie::Base.make_command(command,args))
+  end
+
+  test "make command with flags only" do
+    command = "some_command"
+    flags = {:foo => 1, :bar => 2}
+    assert_equal("some_command -foo 1 -bar 2", ImageGenie::Base.make_command(command,flags))
+  end
+  
+  test "make command" do
+    command = "some_command"
+    args = ["abc","def"]
+    flags = {:foo => 1, :bar => 2}
+    assert_equal("some_command -foo 1 -bar 2 abc def", ImageGenie::Base.make_command(command,flags,args))
+  end
+  
+  test "make command with no flags or args" do
+    command = "some_command"
+    args = []
+    flags = {}
+    assert_equal("some_command", ImageGenie::Base.make_command(command))
+  end
+  
+  test "make flags" do
+    flags = {:foo => 1, :bar => 2}
+    assert_equal("-foo 1 -bar 2", ImageGenie::Base.make_flags(flags))
+  end
+  
+  test "make flags with nothing" do
+    flags = {}
+    assert_equal(nil, ImageGenie::Base.make_flags(flags))
+  end
+
+  test "make args" do
+    args = ["abc","def"]
+    assert_equal("abc def", ImageGenie::Base.make_args(args))
+  end
+
+  test "make args with nothing" do
+    args = []
+    assert_equal(nil, ImageGenie::Base.make_args(args))
+  end
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: image_genie
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Billy Kimble
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: ImageGenie - Simple Wrapper for command line ImageMagick
+email: basslines@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/image_genie.rb
+- lib/image_genie/base.rb
+- lib/image_genie/command.rb
+- lib/image_genie/convert.rb
+- lib/image_genie/identify.rb
+- lib/image_genie/montage.rb
+- lib/image_genie/verify.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/image_genie.rb
+- lib/image_genie/base.rb
+- lib/image_genie/command.rb
+- lib/image_genie/convert.rb
+- lib/image_genie/identify.rb
+- lib/image_genie/montage.rb
+- lib/image_genie/verify.rb
+- test/test_helper.rb
+- test/unit/base_test.rb
+- image_genie.gemspec
+has_rdoc: true
+homepage: https://github.com/bkimble
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Image_genie
+- --main
+- README
+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: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: image_genie
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: ImageGenie - Simple Wrapper for command line ImageMagick
+test_files: 
+- test/test_helper.rb
+- test/unit/base_test.rb