image_clipper 0.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 wrymax
+
+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,78 @@
+# ImageClipper
+
+TODO: Write a gem description
+
+## Installation
+
+Firstly install the ImageMagick components:
+
+    brew install imagemagick
+
+Or go to offcial website and download it:
+
+    http://www.imagemagick.org/script/binary-releases.php
+
+Add this line to your application's Gemfile:
+
+    gem 'image_clipper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install image_clipper
+
+## Directly processing image:
+
+Read image:
+
+    image = ImageClipper::Image.new(image_path)
+    
+Resize image:
+
+    # overwrite the original image:
+    image.resize('200x100')
+    
+    # save to new file
+    image.resize('200x100', save_new_file_path)
+    
+    # use percentage
+    image.resize('35%')
+
+Add watermark:
+
+    # this will add watermark to bottom right corner as default, and will overwrite the original image
+    image.watermarking(watermark_image_path)
+
+    # config the watermark position:
+    # posible selections: %W(top_left top_right bottom_left bottom_right center)
+    image.watermarking(watermark_image_path, position: 'center', save_to: your_watermarked_path)
+
+    # you can also customize the size of watermark picture:
+    # using /\d+x\d+/
+    image.watermarking(watermark_image_path, save_to: your_watermarked_path, resize_to: '177x20')
+
+    # using percentage, and set position
+    image.watermarking(watermark_image_path, save_to: your_watermarked_path, resize_to: '60%', position: '100,230')
+
+## Work with paperclip and Rails
+
+Suppose a model user.rb has :avatar attachment based on paperclip, and I want to add watermark for the existing avatar.
+
+Add some code to user.rb: (just for example)
+
+    def watermark(watermark_path, options = {})
+      ImageClipper::Image.new(avatar.path(:original)).watermarking(watermark_path, options)
+      update_attribute(:avatar, avatar)
+    end
+
+
+## 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/image_clipper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'image_clipper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "image_clipper"
+  spec.version       = ImageClipper::VERSION
+  spec.authors       = ["max_wong"]
+  spec.email         = ["wryma@qq.com"]
+  spec.description   = %q{An easy ruby encapsulation for image processing. All functions are based on ImageMagick.}
+  spec.summary       = %q{An easy ruby encapsulation for image processing.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+	spec.add_development_dependency "rspec"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/image_clipper.rb

@@ -0,0 +1,5 @@
+require "image_clipper/version"
+
+module ImageClipper
+	require 'image_clipper/image'
+end

data/lib/image_clipper/geometry.rb

@@ -0,0 +1,20 @@
+require 'image_clipper'
+
+module ImageClipper
+	class Geometry
+		attr_accessor :width, :height
+
+		def initialize(attrs)
+			case attrs
+			when String
+				raise ArgumentError unless attrs.match(/^\w+x\w+$/)
+				geo = attrs.split('x')
+				@width = geo[0].to_i
+				@height = geo[1].to_i
+			when Hash
+				@width = attrs[:width].to_i
+				@height = attrs[:height].to_i
+			end
+		end
+	end
+end

data/lib/image_clipper/image.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+# basic image class to represent an image
+
+require 'image_clipper'
+require 'image_clipper/geometry'
+
+module ImageClipper
+	class Image
+		attr_accessor :file, :path, :file_size, :type, :geometry
+
+		def initialize(file_path)
+			@file = File.open(file_path)
+			@path = file_path
+			attributes = `identify #{file_path}`.split(' ')
+			@type = attributes[1]
+			@geometry = Geometry.new(attributes[2])
+			@file_size = attributes[6]
+		end
+
+		def resize(new_size, new_file_path = self.path)
+			geo = case new_size
+			when /\d+x\d+/
+				Geometry.new(new_size)
+			when /\d+%/
+				percent = new_size.to_f / 100
+				Geometry.new("#{(geometry.width * percent).round}x#{(geometry.height * percent).round}")
+			end
+
+			`convert #{path} -resize '#{geo.width}x#{geo.height}' #{new_file_path}`
+
+			Image.new(new_file_path)
+		end
+
+		def watermarking(watermark_path, options = {})
+			# options:
+			# 	position: the string position of watermark
+			# 	save_to: the path to save watermarked image
+			#		resize_to: the target size of watermark image
+
+			# read the watermark
+			watermark = Image.new watermark_path
+
+			# config options
+			options = { position: 'bottom_right' }.merge(options)
+
+			# process resizing watermark
+			if options[:resize_to]
+				watermark_geo = case options[:resize_to]
+				when /\d+%/
+					watermark.geometry.width = (watermark.geometry.width * options[:resize_to].to_i / 100).round
+					watermark.geometry.height = (watermark.geometry.height * options[:resize_to].to_i / 100).round
+				when /\d+x\d+/
+					resize_tmp = options[:resize_to].split('x')
+					watermark.geometry.width = resize_tmp[0].to_i
+					watermark.geometry.height = resize_tmp[1].to_i
+				else
+					raise ArgumentError, "resize_to argument format error, try '100x100' or '50%'"
+				end
+			end
+			watermark_geo = "#{watermark.geometry.width},#{watermark.geometry.height}"
+
+			# process watermark position
+			pos_coord = case options[:position]
+			when 'top_left'
+				'0,0'
+			when 'top_right'
+				"#{geometry.width - watermark.geometry.width},0"
+			when 'bottom_left'
+				"0,#{geometry.height - watermark.geometry.height}"
+			when 'bottom_right'
+				"#{geometry.width - watermark.geometry.width},#{geometry.height - watermark.geometry.height}"
+			when 'center'
+				"#{(geometry.width - watermark.geometry.width) / 2},#{(geometry.height - watermark.geometry.height) / 2}"
+			when /\d+,\d+/
+				options[:position]
+			else
+				raise ArgumentError, "position argument missing"
+			end
+
+			# config the watermarked image path
+			watermarked_path = options[:save_to] || path
+
+			# process!
+			# ap "convert #{path} -draw \"image SrcOver #{pos_coord} #{watermark_geo} #{watermark_path}\" #{watermarked_path}"
+			`convert #{path} -draw "image SrcOver #{pos_coord} #{watermark_geo} #{watermark_path}" #{watermarked_path}`
+			
+			# return the new Image object
+			Image.new(watermarked_path)
+		end
+	end
+end

data/lib/image_clipper/version.rb

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

data/spec/geometry_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'image_clipper/geometry'
+
+describe ImageClipper::Geometry do
+	it "new geometry with multiple ways" do
+		geo1 = ImageClipper::Geometry.new('640x480')
+		geo2 = ImageClipper::Geometry.new(width: 640, height: 480)
+
+		geo1.width.should == 640
+		geo1.height.should == 480
+
+		geo2.width.should == 640
+		geo2.height.should == 480
+	end
+end

data/spec/image_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'image_clipper/image'
+
+describe ImageClipper::Image do
+	let :image_1 do
+		`cp test/tmp/original/angelababy.jpg test/tmp/`
+		ImageClipper::Image.new('test/tmp/angelababy.jpg')
+	end
+
+	it "new image and read attributes" do
+		image_1.path.should eql('test/tmp/angelababy.jpg')
+		image_1.type.should == 'JPEG'
+		image_1.file_size.should == '274KB'
+		image_1.geometry.width.should == 584
+		image_1.geometry.height.should == 900
+	end
+
+	describe 'resize image' do
+		it 'resize image to a new file' do
+			new_image = image_1.resize('292x450', 'test/tmp/new_angelababy.jpg')
+			new_image.path.should == 'test/tmp/new_angelababy.jpg'
+			new_image.geometry.width.should == 292
+			new_image.geometry.height.should == 450
+		end
+
+		it 'resize image to the original file' do
+			new_image = image_1.resize('292x450')
+			new_image.path.should == image_1.path
+			new_image.geometry.width.should == 292
+			new_image.geometry.height.should == 450
+		end
+
+		it 'resize image with percentage' do
+			percent = '20%'
+			percentage = percent.to_f / 100
+			new_image = image_1.resize(percent, "test/tmp/resize_angelababy_#{percent}.jpg")
+			new_image.path.should == "test/tmp/resize_angelababy_#{percent}.jpg"
+			new_image.geometry.width.should == (image_1.geometry.width * percentage).round
+			new_image.geometry.height.should == (image_1.geometry.height * percentage).round
+		end
+	end
+
+	describe 'watermarking' do
+		it 'add watermark at right bottom corner as default' do
+			image_1.watermarking('test/tmp/original/logo.png')
+		end
+
+		it "add watermark at custom position, saving at new image path" do
+			%W(top_left top_right bottom_left bottom_right center).each do |pos|
+				image_1.watermarking('test/tmp/original/logo.png', position: pos, save_to: "test/tmp/watermarked_#{pos}.jpg")
+			end
+		end
+
+
+		it "add watermark with special size" do
+			image_1.watermarking('test/tmp/original/logo.png', save_to: "test/tmp/watermarked_resize1.jpg", resize_to: '177x20')
+			image_1.watermarking('test/tmp/original/logo.png', save_to: "test/tmp/watermarked_resize2.jpg", resize_to: '60%', position: '100,230')
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'awesome_print'
+require 'pry'
+require 'image_clipper'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: image_clipper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- max_wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy ruby encapsulation for image processing. All functions are based
+  on ImageMagick.
+email:
+- wryma@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- image_clipper.gemspec
+- lib/image_clipper.rb
+- lib/image_clipper/geometry.rb
+- lib/image_clipper/image.rb
+- lib/image_clipper/version.rb
+- spec/geometry_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: An easy ruby encapsulation for image processing.
+test_files:
+- spec/geometry_spec.rb
+- spec/image_spec.rb
+- spec/spec_helper.rb