simple_magick 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8721a16bca3964f1c9b62ecff896d1c3b51bfaf3
+  data.tar.gz: 7b5e87b257feca6d8ad365d463ab99b8cb361539
+SHA512:
+  metadata.gz: 19a617f50e2f1583c82d4f22c95069b0dc4402c2eac8e128f900eb54c8eb2d6fcbbe9b1f4151f323db10fe92d7ff06b01c1da32292201055ab9cd214ca89b5e3
+  data.tar.gz: e28ac9c440dcd50b3ea36b1c1a8f62cf8884a68bb4ae8ac677d1e0719a55ca17875fb868fb65b42b452aec2d458e7ecf1aa0a28b25315ca42eb0f4e5d02df4bd

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sugamasao
+
+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,87 @@
+# SimpleMagick
+
+SimpleMagick is Ultra Simple ImageMagick Wrapper.
+
+## Installation(Dependency)
+
+requirements ImageMagick(use mogrify command)
+
+```
+% brew install imagemagick
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_magick', github: 'sugamasao/simple_magick'
+
+And then execute:
+
+    $ bundle
+
+## Supported versions
+
+ - Ruby 2.0.0 or later
+
+## Usage
+
+```ruby
+require 'simple_magick'
+
+if SimpleMagick.imagemagick_installed?
+  image = SimpleMagick::Image.new('/path/to/src_image.jpg')
+  image.resize '150x150'
+  image.convert! '/path/to/dest_image.jpg'
+end
+```
+
+using another option?
+
+```ruby
+  image = SimpleMagick::Image.new('/path/to/src_image.jpg')
+  image.additional_option 'type', 'Grayscale' # mogrify -type Grayscale /path/to/src_image.jpg
+```
+
+## Benchmark
+
+### Benchmark Spec
+
+- OSX 10.8.5
+- CPU: 2.53 GHz Intel Core i5
+- Memory: 8GB
+
+### Version
+
+- ruby 2.1.0p0 (2013-12-25 revision 44422) [x86_64-darwin12.0]
+- mini_magick (3.7.0)
+- simple_magick (0.0.2)
+- ImageMagick 6.8.7-7
+
+### How To Benchmark
+
+Setup.
+
+```
+% cd benchmark
+% brew install imagemagick
+% bundle install
+```
+
+exec.
+
+```sh
+% bundle exec ruby benchmark.rb
+                      user     system      total        real
+simple_magick     0.080000   0.270000  28.530000 ( 29.687068)
+mini_magick       0.410000   0.790000  31.300000 ( 37.115507)
+ImageMagick       0.030000   0.170000  28.620000 ( 29.094316)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/simple_magick/fork )
+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/benchmark/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'simple_magick', github: 'sugamasao/simple_magick'
+gem 'mini_magick'

data/benchmark/benchmark.rb

@@ -0,0 +1,43 @@
+require 'benchmark'
+require 'fileutils'
+require 'simple_magick'
+require 'mini_magick'
+
+simple_magick_dir = File.join(__dir__, 'tmp', 'simple_magick')
+mini_magick_dir   = File.join(__dir__, 'tmp', 'mini_magick')
+image_magick_dir  = File.join(__dir__, 'tmp', 'image_magick')
+
+[mini_magick_dir, simple_magick_dir, image_magick_dir].each do |dir|
+  FileUtils.mkdir_p dir unless File.directory? dir
+end
+
+sample_image = File.join('..', 'spec', 'assets', 'sample.jpg')
+
+n = 100
+Benchmark.bm(15) do |x|
+  x.report('simple_magick') {
+    n.times do |count|
+      image = SimpleMagick::Image.new(sample_image)
+      image.resize '150x150'
+      image.quality '50'
+      image.convert! File.join(simple_magick_dir, "image_#{count}.jpg")
+    end
+  }
+
+  x.report('mini_magick') {
+    n.times do |count|
+      image = MiniMagick::Image.open(sample_image)
+      image.resize '150x150'
+      image.quality '50'
+      image.write File.join(mini_magick_dir, "image_#{count}.jpg")
+    end
+  }
+
+  x.report('ImageMagick') {
+    n.times do |count|
+      result_image = File.join(image_magick_dir, "image_#{count}.jpg")
+      FileUtils.cp(sample_image, result_image)
+      `mogrify -resize 150x150 -quality 50 #{result_image}`
+    end
+  }
+end

data/lib/simple_magick.rb

@@ -0,0 +1,107 @@
+require 'simple_magick/version'
+require 'fileutils'
+require 'open3'
+require 'shellwords'
+
+module SimpleMagick
+  class ConvertError < StandardError;end
+
+  # mogrify is ImageMagick family tool.
+  # @note Windows Not Supported
+  # @return [Boolean] find mogrify command is true
+  def self.imagemagick_installed?
+    !`which mogrify`.split("\n").first.nil?
+  end
+
+  # Convert Image Class.
+  # @example Usage
+  #   image = SimpleMagick::Image.new('/path/to/org.jpg')
+  #   image.resize '150x'
+  #   image.convert!('/path/to/thumb.jpg')
+  class Image
+
+    # @param [String] source_path Target Image File Path
+    # @param [Boolean] verbose print detailed information
+    def initialize(source_path, verbose = false)
+      @source_path = source_path
+      @verbose     = verbose
+      @command     = ['mogrify']
+    end
+
+    # @param [String] size resize size
+    def resize(size)
+      @command << "-resize #{command_escape(size)}"
+    end
+
+    # @param [String] num image quality
+    def quality(num)
+      @command << "-quality #{command_escape(num)}"
+    end
+
+    # @param [String] string define string.
+    def define(string)
+      @command << "-define #{command_escape(string)}"
+    end
+
+    # use other options.
+    # @param [String] option option name
+    # @param [String] value option value. default = ''
+    def additional_option(option, value = '')
+      @command << "-#{command_escape(option)} #{command_escape(value)}".strip
+    end
+
+    # run ImageMagick.
+    # @param [String] destination_path output image path
+    # @return [Void]
+    # @raise [SimpleMagick::ConvertError] mogrify command fail.
+    def convert!(destination_path)
+      file_copy(destination_path)
+      command = create_command(@command, destination_path)
+
+      # ex. % mogrify -resize 90 /path/to/resize_image.jpg
+      begin
+        puts "[INFO] #{command}" if @verbose
+        stdout, stderr, status = Open3.capture3(command)
+      rescue SystemCallError => e
+        raise ConvertError.new("mogrify error. exec command => [#{command}], Error Detail => [#{e.message}]")
+      end
+
+      unless status.success?
+        raise ConvertError.new("mogrify error. exec command => [#{command}], stdout => [#{stdout}], stderr => [#{stderr}]")
+      end
+    end
+
+    private
+
+    # copy source_path to destination_path
+    # @param [String] destination_path
+    # @return [Void]
+    # @raise [SimpleMagick::ConvertError] @source_path not found.
+    def file_copy(destination_path)
+      unless File.file? @source_path
+        raise ConvertError.new("Not Found input file. input file => [#{@source_path}]")
+      end
+
+      dest_dir = File.dirname(destination_path)
+      FileUtils.mkdir_p(dest_dir)
+      puts "[INFO] cp #{@source_path} #{destination_path}" if @verbose
+      FileUtils.cp(@source_path, destination_path)
+    end
+
+    # create exec command line
+    # @param [Array] command mogrify command
+    # @param [String] destination_path create image path
+    # @return [String] command String.
+    def create_command(command, destination_path)
+      command << Shellwords.escape(destination_path)
+      command.join(' ')
+    end
+
+    # option string to CLI Escape.
+    # @return [String] escaped string
+    def command_escape(value)
+      string_value = value.to_s.strip
+      Shellwords.escape(string_value) unless string_value.empty?
+    end
+  end
+end

data/lib/simple_magick/version.rb

@@ -0,0 +1,3 @@
+module SimpleMagick
+  VERSION = '1.0.0'
+end

data/simple_magick.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_magick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_magick"
+  spec.version       = SimpleMagick::VERSION
+  spec.authors       = ["sugamasao"]
+  spec.email         = ["sugamasao@gmail.com"]
+  spec.summary       = %q{Simple ImageMagick Wrapper.}
+  spec.description   = %q{Simple ImageMagick Wrapper.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/spec/simple_magick_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe SimpleMagick do
+
+  describe '.imagemagick_installed?' do
+    it 'installed ImageMagick' do
+      expect(SimpleMagick).to be_imagemagick_installed
+    end
+  end
+
+  describe SimpleMagick::Image do
+    describe '#additional_command' do
+      context 'command and value' do
+        let(:asset_path) { File.join(__dir__, 'assets', 'sample.jpg') }
+
+        it 'set option and value' do
+          image = SimpleMagick::Image.new(asset_path)
+          expect(image.additional_option('type', 'Grayscale').last).to eq '-type Grayscale'
+        end
+
+        it 'set only option' do
+          image = SimpleMagick::Image.new(asset_path)
+          expect(image.additional_option('version').last).to eq '-version'
+        end
+      end
+    end
+
+    describe '#convert!' do
+      let(:asset_path) { File.join(__dir__, 'assets', 'sample.jpg') }
+      let(:result_path) { File.join(__dir__, 'assets', 'result', 'resize.jpg') }
+
+      before do
+        result_dir = File.dirname(result_path)
+        FileUtils.rm_r(result_dir) if File.directory?(result_dir)
+      end
+
+      context 'Resize Image' do
+        it 'Resize Success' do
+          image = SimpleMagick::Image.new(asset_path)
+          image.resize '150x'
+          image.quality '60'
+          image.convert! result_path
+          expect(File).to be_file(result_path)
+        end
+      end
+
+      context 'Not Found assets_path' do
+        let(:not_found_path) { asset_path + '.not_found_ext' }
+        it 'raise SimpleMagick::ConvertError' do
+          image = SimpleMagick::Image.new(not_found_path)
+          image.resize '150x'
+          image.quality '60'
+          expect {
+            image.convert! result_path
+          }.to raise_error(SimpleMagick::ConvertError, /Not Found/)
+        end
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'simple_magick'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: simple_magick
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sugamasao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple ImageMagick Wrapper.
+email:
+- sugamasao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/Gemfile
+- benchmark/benchmark.rb
+- lib/simple_magick.rb
+- lib/simple_magick/version.rb
+- simple_magick.gemspec
+- spec/assets/sample.jpg
+- spec/simple_magick_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Simple ImageMagick Wrapper.
+test_files:
+- spec/assets/sample.jpg
+- spec/simple_magick_spec.rb
+- spec/spec_helper.rb
+has_rdoc: