image_sorcery 1.0.7 → 1.1.0

data/README.markdown

@@ -1,13 +1,13 @@
-Image Sorcery allows you to leverage all three of ImageMagick's command line tools, [mogrify](http://www.imagemagick.org/script/mogrify.php), [convert](http://www.imagemagick.org/script/convert.php), and [identify](http://www.imagemagick.org/script/identify.php), for maximum magickal power and minimum memory consumption! It lets you use GraphicsMagick if that's you're thing, too.
+Image Sorcery allows you to leverage all three of ImageMagick's command line tools, [mogrify](http://www.imagemagick.org/script/mogrify.php), [convert](http://www.imagemagick.org/script/convert.php), and [identify](http://www.imagemagick.org/script/identify.php), for maximum magickal power and minimum memory consumption! It even lets you use GraphicsMagick, too, if that's your thing.
 
 ## Why?
 
-At [Fol.io](http://fol.io), we need server-side image processing to work well and bend to our will. I wrote this because the ImageMagick libraries we tried suffered from at least one of two problems:
+At [Fol.io](http://fol.io), we needed server-side image processing to work well and bend to our will. I wrote this because the ImageMagick libraries we tried suffered from at least one of two problems:
 
 * Large memory consumption/leaking
-* Didn't expose the entire ImageMagick library
+* Didn't expose the entire ImageMagick API
 
-Due to the way Image Sorcery was written, it manages to avoid both of these problems.
+ImageSorcery doesn't try to be anything more than a wrapper that exposes the full ImageMagick and GraphicsMagick APIs. This makes it small and powerful, eliminating the above problems.
 
 ## Installation
 
@@ -15,17 +15,38 @@ Due to the way Image Sorcery was written, it manages to avoid both of these prob
 
 ## Code Examples
 ```ruby
-image = Sorcery.new("image.png")
+image = ImageSorcery.new("image.png")
 image.identify # => "image.png PNG 500x500 500x500+0+0 8-bit DirectClass 236KB 0.010u 0:00.010\n"
 image.manipulate!(scale: "50%") # => true
 image.dimensions # => { x: 250, y: 250 }
 image.convert("thumbnail.jpg", quality: 80, crop: "100x100>") # => true
 ```
+
+```ruby
+image = ImageSorcery.new("multi-page.pdf")
+image.filename_changed? # => false
+image.manipulate!(format: "png", layer: 0) # => true
+image.filename_changed? # => true
+image.file # => "multi-page.png"
+```
+
+```ruby
+image = ImageSorcery.new("multi-page.pdf")
+image.manipulate!(format: "png") # => true
+image.filename_changed? # => true
+
+# on ImageMagick it returns all layers as a single file
+image.file # => "multi-page-*.png"
+
+# on GrapicksMagick it returns only the fist layer
+image.file # => "multi-page.png"
+```
+
 # Using GraphicsMagick
 Assuming you have GraphicsMagick installed on your box:
 
 ```ruby
-image = Sorcery.gm("image.png")
+image = ImageSorcery.gm("image.png")
 # use as normal
 ```
 

data/lib/gm_support.rb

@@ -4,7 +4,7 @@ module GmSupport
   end
 end
 
-class Sorcery
+class ImageSorcery
   class << self
     def gm file
       instance = new(file)

data/lib/image_sorcery.rb

@@ -1,6 +1,8 @@
 require 'gm_support'
 
-class Sorcery
+class ImageSorcery
+  attr_reader :file
+
   def initialize(file)
     @file = file
   end
@@ -12,8 +14,10 @@ class Sorcery
     tokens  = ["mogrify"]
     tokens << convert_to_arguments(args) if args
     tokens << " '#{@file}#{"[#{args[:layer].to_s}]" if args[:layer]}'"
+    tokens << " -annotate #{args[:annotate].to_s}" if args[:annotate]
     tokens  = convert_to_command(tokens)
     success = run(tokens)[1]
+    replace_file(args[:format].to_s.downcase, args[:layer]) if success && args[:format]
     success
   end
 
@@ -24,6 +28,7 @@ class Sorcery
     tokens  = ["convert"]
     tokens << convert_to_arguments(args) if args
     tokens << " '#{@file}#{"[#{args[:layer].to_s}]" if args[:layer]}'"
+    tokens << " -annotate #{args[:annotate].to_s}" if args[:annotate]
     tokens << " #{output}"
     tokens  = convert_to_command(tokens)
     success = run(tokens)[1]
@@ -46,19 +51,77 @@ class Sorcery
   #
   def dimensions
     dimensions = identify(:layer => 0, :format => "%wx%h").chomp.split("x")
-    { :x => dimensions[0],
-      :y => dimensions[1] }
+    { :x => dimensions[0].to_i,
+      :y => dimensions[1].to_i }
+  end
+
+  # Returns the x dimension of an image as an integer
+  #
+  def width
+    dimensions()[:x]
+  end
+
+  # Returns the y dimension of an image as an integer
+  #
+  def height
+    dimensions()[:y]
+  end
+
+  # Runs ImageMagick's 'montage'.
+  # See http://www.imagemagick.org/script/montage.php
+  #
+  def montage(sources, args={})
+    tokens = ["montage"]
+    tokens << convert_to_arguments(args) if args
+    sources.each {|source| tokens << " '#{source}'" }
+    tokens << " '#{@file}'"
+    tokens  = convert_to_command(tokens)
+    success = run(tokens)[1]
+  end
+
+  def filename_changed?
+    (@filename_changed)
   end
 
   private
 
+  # Replaces the old file (with the old file format) with the newly generated one.
+  # The old file will be deleted and $file will be reset.
+  # If ImageMagick generated more than one file, $file will have a "*", so that all files generated
+  # will be manipulated in the following steps.
+  def replace_file(format, layer)
+    return if  File.extname(@file) == format
+
+    layer ||= 0
+    layer = layer.split(",").first if layer.is_a? String
+
+    File.delete @file
+    @filename_changed = true
+
+    path = File.join File.dirname(@file), File.basename(@file, File.extname(@file))
+    new_file = find_file path, format, layer
+
+    @file = new_file.call(path, format, "*") unless new_file.nil?
+  end
+
+  def find_file(path, format, layer)
+    possible_paths = [
+        Proc.new { |path, format, layer| "#{path}.#{format}" },
+        Proc.new { |path, format, layer| "#{path}-#{layer}.#{format}" },
+        Proc.new { |path, format, layer| "#{path}.#{format}.#{layer}" }
+    ]
+
+    possible_paths.find { |possible_path| File.exists?(possible_path.call(path, format, layer)) }
+  end
+
   def convert_to_command(tokens)
     tokens[0] = prefix(tokens[0]) if respond_to? :prefix
     tokens.flatten.join("")
   end
 
   def convert_to_arguments(args)
-    args.reject {|k, v| k == :layer }.map {|k, v| " -#{k} '#{v}'"}
+    special_args = [:layer, :annotate]
+    args.reject {|k, v| special_args.include?(k) }.map {|k, v| " -#{k} '#{v}'"}
   end
 
   def run(cmds)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_sorcery
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,9 +10,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000Z
-dependencies: []
-description: A ruby ImageMagick library that doesn't suck
+date: 2013-01-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70278859175680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: *70278859175680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70278859175200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *70278859175200
+description: A ruby ImageMagick/GraphicsMagick library that doesn't suck
 email:
 - hello@ericrafaloff.com
 - guy@musicglue.com
@@ -23,7 +45,7 @@ files:
 - lib/gm_support.rb
 - lib/image_sorcery.rb
 - README.markdown
-homepage: https://github.com/musicglue/image_sorcery
+homepage: https://github.com/EricR/image_sorcery
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -47,5 +69,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A ruby ImageMagick library that doesn't suck
+summary: A ruby ImageMagick/GraphicsMagick library that doesn't suck
 test_files: []