graphicsmagick 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTM2MzNjZGMyMjVlYjhlMDhiZjgyYmJhMWRhNTcwOGZmZTE3YjZmOA==
+  data.tar.gz: !binary |-
+    NTY0ZWRiYzQ4YzdmOTA0OTJiODA5ZmM1NGM1ZjEzYjkwZWY2ZWYyNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjVjZGIyZjliZmE2YWQyNDEwMzViZWU2NWY1YzNlYzRhYTJmNWZkOGFiMjkx
+    MzE1NzcwZjM3ZDZhZmYwM2U2MGZlNzc3MTQ4NzIwYTNlODI4OTk2NDRmN2U5
+    NTkzZmI2ZDA3MjYxNTU0NmQ0NDZjODBmYTA0NmYxMWJmMThlMjY=
+  data.tar.gz: !binary |-
+    NWUwMTEyNGRlYmFhNzAwOTUxOTc0NjZmNmUzNjZiNzVkMTY2YjU1NGJlZjI4
+    NTc2ODI2NDI4NjY0MzQzNmUzODk4N2ZlZmJjMTJiNWFhZDhhZmY4ODc1OTZk
+    ZTU1ZGI5NmQyM2ViMjAwOWYxZWRjZDRkMWJkOTMzYTQ2NWRiNDQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# GraphicsMagick Changelog
+
+## 1.0.0
+Initial release with support for mogrify, convert, and composite utilities, plus a few identify convenience methods.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chad McGimpsey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Graphicsmagick
+
+A very light Ruby wrapper for the Graphicsmagick CLI that supports mogrify, composite, and convert, plus a few convenience methods.
+
+## Why?
+
+Graphicsmagick was 10x faster for our image processing needs than ImageMagick.
+I wanted to use Graphicsmagick, but wanted a Ruby wrapper to help deal with exceptions and long running tasks. I needed to use multiple utilities within Graphicsmagick and the current crop of *_magick gems either did not support all of them, or had costly overhead (or both).
+
+## Installation
+
+#### Install Graphicsmagick
+http://www.graphicsmagick.org/README.html
+
+On OS X, it's recommended to use `brew`
+```bash
+brew update
+brew install graphicsmagick
+```
+
+#### Install gem
+Add this line to your application's Gemfile:
+
+    gem 'graphicsmagick'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphicsmagick
+
+## Usage
+
+#### Mogrify commands and overwriting file
+```ruby
+img = GraphicsMagick::Image.new('my_file.jpg')
+img.crop('360x504+432+72').resize('125x177!')
+img.write!
+```
+Equivalent to
+```bash
+gm mogrify -crop '360x504+432+72' -resize '125x177!' my_file.jpg
+```
+
+
+#### Mogrify commands and write to new file
+```ruby
+img = GraphicsMagick::Image.new('my_file.jpg')
+img.crop('360x504+432+72').resize('125x177!')
+img.write('my_new_file.jpg')
+```
+Equivalent to
+```bash
+cp my_file.jpg my_new_file.jpg & gm mogrify -crop '360x504+432+72' -resize '125x177!' my_new_file.jpg
+```
+
+
+#### Convert a PDF file to a PNG while passing options at both steps
+```ruby
+img = GraphicsMagick::Image.new("my_file.pdf")
+img.strip.density(144).colorspace('RGB').auto-orient
+img.convert.resize('50%')
+img.write('my_new_file.png')
+```
+Equivalent to
+```bash
+gm convert -density 144 -strip -colorspace RGB -auto-orient "my_file.pdf" -resize '50%' my_new_file.png
+```
+
+
+#### Composite an image over another image
+```ruby
+background = GraphicsMagick::Image.new("background.png")
+img = GraphicsMagick::Image.new("overlay.png")
+img.composite(background).geometry('+100+150')
+img.write('composite.png')
+```
+Equivalent to
+```bash
+gm composite -geometry +100+150 background.png overlay.png composite.png
+```
+
+
+#### You can pass a file too
+```ruby
+file = File.new('my_file.png')
+img = GraphicsMagick::Image.new(file)
+
+temp_img = GraphicsMagick::Image.new(Tempfile.new('foo'))
+temp_img.path  #=> "path/to/temp/file"
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/graphicsmagick.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphicsmagick/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "graphicsmagick"
+  gem.version       = GraphicsMagick::VERSION
+  gem.authors       = ["Chad McGimpsey"]
+  gem.email         = ["chad.mcgimpsey@gmail.com"]
+  gem.description   = "Light ruby wrapper for the GraphicsMagick CLI."
+  gem.summary       = "Light ruby wrapper for the GraphicsMagick CLI."
+  gem.homepage      = "https://github.com/dignoe/graphicsmagick"
+
+  gem.add_dependency('subexec')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/graphicsmagick.rb

@@ -0,0 +1,8 @@
+module GraphicsMagick
+  
+end
+
+raise StandardError, "Please install GraphicsMagick" unless system("hash gm 2>&-")
+
+require "graphicsmagick/version"
+require "graphicsmagick/image"

data/lib/graphicsmagick/image.rb

@@ -0,0 +1,88 @@
+require 'tempfile'
+require 'subexec'
+require 'shellwords'
+require 'graphicsmagick/utilities'
+require 'active_support/core_ext/numeric/time'
+
+module GraphicsMagick
+
+	UnknownOptionError = Class.new(StandardError)
+
+	class Image
+		attr_reader :file
+
+		include GraphicsMagick::Utilities
+
+    def initialize(input)
+    	@command_options = []
+    	@utility = nil
+
+    	@file = parse_input(input)
+  	end
+
+  	# Returns the path of the associated file
+  	def path
+  		@file.path
+  	end
+
+  	# Writes the changes to the file specified in +output+.
+  	# Set +:timeout => 30.seconds+ to change the timeout value. Default is one minute.
+  	def write output, opts={}
+  		output_path = parse_input(output, false)
+
+  		FileUtils.copy_file(self.path, output_path) unless requires_output_file?
+  		
+  		command = build_command(output_path)
+  		run(command, opts)
+  		GraphicsMagick::Image.new(output_path)
+  	end
+
+
+  	# Writes the changes to the current file.
+  	# Set +:timeout => 30.seconds+ to change the timeout value. Default is one minute.
+  	def write! opts={}
+  		raise NoMethodError, "You cannot use Image#write(output) with the #{current_utility} command" if requires_output_file?
+
+  		command = build_command(path)
+  		run(command, opts)
+  		self
+  	end
+
+  	protected
+
+  	def method_missing(method, *args, &block)
+      add_option("-#{method.to_s.gsub(/_/,'-')}", *args)
+    end
+
+    private
+
+    def add_option option_name, *args
+    	@command_options << {:name => option_name, :args => args.collect { |a| Shellwords.escape(a.to_s) }.join(" ")}
+    	self
+    end
+
+    def run command, opts={}
+    	opts.reverse_merge!(:timeout => 1.minute)
+    	command = "gm #{command}"
+    	cmd = Subexec.run(command, opts)
+
+      if cmd.exitstatus != 0
+      	raise UnknownOptionError, "#{command} failed: #{cmd.output}"
+      end
+    ensure
+    	@command_options = []
+    	@utility = nil
+    end
+
+    def parse_input(input, output_as_file=true)
+    	if input.is_a? String
+    		return output_as_file ? File.new(input) : input
+    	elsif input.is_a?(File) || input.is_a?(Tempfile)
+    		return output_as_file ? input : input.path
+    	else
+    		raise TypeError, "You must specify a file as a String, File, or Tempfile object"
+    	end
+    end
+
+	end
+end

data/lib/graphicsmagick/utilities.rb

@@ -0,0 +1,42 @@
+require 'graphicsmagick/utilities/mogrify'
+require 'graphicsmagick/utilities/identify'
+require 'graphicsmagick/utilities/convert'
+require 'graphicsmagick/utilities/composite'
+
+module GraphicsMagick
+	module Utilities
+		include GraphicsMagick::Utilities::Identify
+		include GraphicsMagick::Utilities::Convert
+		include GraphicsMagick::Utilities::Composite
+		include GraphicsMagick::Utilities::Mogrify
+
+		DEFAULT_UTILITY = "mogrify"
+
+		def current_utility
+			@utility || DEFAULT_UTILITY
+		end
+
+		def to_cmd
+			"gm " + build_command('output_file')
+		end
+
+		private
+
+		def requires_output_file?
+			send(:"#{current_utility}_requires_output_file?")
+		end
+
+		def build_command(file)
+			send(:"build_#{current_utility}_command", file)
+		end
+
+		def options_to_str(opts)
+			if opts.nil?
+				""
+			else
+				opts.collect {|opt| "#{opt[:name]} #{opt[:args]}"}.join(" ")
+			end
+		end
+
+	end
+end

data/lib/graphicsmagick/utilities/composite.rb

@@ -0,0 +1,30 @@
+module GraphicsMagick
+	module Utilities
+		module Composite
+
+			def composite(base, mask=nil)
+				if @utility.nil?
+					@utility = "composite"
+					@base_file = parse_input(base)
+					@mask_file = parse_input(mask) if mask
+				else
+					raise NoMethodError, "You can't use Image#composite with #{@utility}"
+				end
+				self
+			end
+
+
+			private
+
+			def composite_requires_output_file?
+				true
+			end
+
+			# gm convert [options] change-path base-path mask-path output-path
+			def build_composite_command(output_path)
+  			"composite #{options_to_str(@command_options)} #{path} #{@base_file.path} #{@mask_file.path if @mask_file} #{output_path}"
+			end
+
+		end
+	end
+end

data/lib/graphicsmagick/utilities/convert.rb

@@ -0,0 +1,29 @@
+module GraphicsMagick
+	module Utilities
+		module Convert
+			def convert
+				if @utility.nil?
+					@utility = "convert"
+					@command_options = [@command_options]
+				else
+					raise NoMethodError, "You can't use Image#convert with #{@utility}"
+				end
+				self
+			end
+
+			private
+
+			def convert_requires_output_file?
+				true
+			end
+
+			# gm convert [options] input-path [options] output-path
+			def build_convert_command(output_path)
+  			first_options = @command_options[0]
+  			second_options = @command_options[1..@command_options.length]
+  			"convert #{options_to_str(first_options)} #{path} #{options_to_str(second_options)} #{output_path}"
+			end
+
+		end
+	end
+end

data/lib/graphicsmagick/utilities/identify.rb

@@ -0,0 +1,24 @@
+module GraphicsMagick
+	module Utilities
+		module Identify
+
+			def width
+				get_identity.strip.split('x')[0].to_i
+			end
+
+			def height
+				get_identity.strip.split('x')[1].to_i
+			end
+
+			private
+
+			def composite_requires_output_file?
+				false
+			end
+
+			def get_identity
+				@identity ||= `gm identify -ping -format '%wx%h' #{path}`
+			end
+		end
+	end
+end

data/lib/graphicsmagick/utilities/mogrify.rb

@@ -0,0 +1,17 @@
+module GraphicsMagick
+	module Utilities
+		module Mogrify
+
+			private
+
+			def mogrify_requires_output_file?
+				false
+			end
+
+			# gm mogrify [options] file
+			def build_mogrify_command(file_path)
+				"mogrify #{options_to_str(@command_options)} #{file_path}"
+			end
+		end
+	end
+end

data/lib/graphicsmagick/version.rb

@@ -0,0 +1,3 @@
+module GraphicsMagick
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: graphicsmagick
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chad McGimpsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: subexec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Light ruby wrapper for the GraphicsMagick CLI.
+email:
+- chad.mcgimpsey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- graphicsmagick.gemspec
+- lib/graphicsmagick.rb
+- lib/graphicsmagick/.DS_Store
+- lib/graphicsmagick/image.rb
+- lib/graphicsmagick/utilities.rb
+- lib/graphicsmagick/utilities/composite.rb
+- lib/graphicsmagick/utilities/convert.rb
+- lib/graphicsmagick/utilities/identify.rb
+- lib/graphicsmagick/utilities/mogrify.rb
+- lib/graphicsmagick/version.rb
+homepage: https://github.com/dignoe/graphicsmagick
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Light ruby wrapper for the GraphicsMagick CLI.
+test_files: []