image_processing 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d685d2233ad9b0da42966e273cc5a453215eb82a
+  data.tar.gz: 18ce0a061ba6eeff0501c311aa9f217404c25371
+SHA512:
+  metadata.gz: 8859c7bcf11803b4e41b8eb03f04fc30ddf65ffd4756c4c4d76907189fb7a7c5fb9bb4f1b6287b34ce21cd07b7c0edd566fb9ec14b30d128bdea910c6f31c802
+  data.tar.gz: 649891929efd850e926f6f30487dfca66c44e12f614dff1b47fa0e4191e368880f331ee88634cebe381aad90fa73824eca8afaf0c432f1a1adc53d651235abd6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+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 @@
+# ImageProcessing
+
+Provides higher-level helper methods for image processing in Ruby using
+ImageMagick. This methods are extracted from CarrierWave and Refile, and
+can be reused in any project.
+
+## Installation
+
+```ruby
+gem 'image_processing'
+```
+
+## Usage
+
+Typically you will include the module in your class:
+
+```rb
+require "image_processing/mini_magick"
+
+include ImageProcessing::MiniMagick
+
+original = File.open("path/to/image.jpg")
+
+converted = convert(original, "png") # makes a converted copy
+converted #=> #<Tempfile:/var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/mini_magick20151003-23030-9e1vjz.png (closed)>
+File.exist?(original.path) #=> true
+
+converted = convert!(original, "png") # destructively converts the file
+converted #=> #<Tempfile:/var/folders/k7/6zx6dx6x7ys3rv3srh0nyfj00000gn/T/mini_magick20151003-23030-9e1vjz.png (closed)>
+File.exist?(original.path) #=> false
+```
+
+If you would rather not pollute your namespace, you can also call the methods
+directly on the module:
+
+```rb
+image = File.open("path/to/image.jpg")
+
+ImageProcessing::MiniMagick.resize_to_fit(image, 400, 400)
+```
+
+The following is the list of helper methods that ImageProcessing provides:
+
+```rb
+# Converts file to the specified format.
+convert(file, format)  # nondestructive
+convert!(file, format) # destructive
+
+# Resizes image to fit the specified dimensions (shrinks if larger, enlarges if
+# smaller, but keeps the aspect ratio).
+resize_to_fit(file, width, height)  # nondestructive
+resize_to_fit!(file, width, height) # destructive
+
+# Resizes image in limit of the specified dimensions (shrinks if larger, keeps
+# if smaller, but keeps the aspect ratio).
+resize_to_limit(file, width, height)  # nondestructive
+resize_to_limit!(file, width, height) # destructive
+
+# Resizes image to fill the specified dimensions (shrinks if larger,
+# enlarges if smaller, crops the longer side).
+resize_to_fill(file, width, height, gravity: "Center")  # nondestructive
+resize_to_fill!(file, width, height, gravity: "Center") # destructive
+
+# Resizes image to the specified dimensions and pads missing space (shrinks if
+# larger, enlarges if smaller, fills the shorter side with specified color).
+resize_and_pad(file, width, height, background: "transparent", gravity: "Center")  # nondestructive
+resize_and_pad!(file, width, height, background: "transparent", gravity: "Center") # destructive
+```
+
+## Contributing
+
+ImageMagick and GraphicsMagick are both required to be installed, on Mac this is
+
+```
+$ brew install imagemagick
+$ brew install graphicsmagick
+```
+
+Run tests with
+
+```
+$ rake test
+```
+
+## License
+
+[MIT](LICENSE.txt)

data/image_processing.gemspec

@@ -0,0 +1,22 @@
+require_relative "lib/image_processing/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "image_processing"
+  spec.version       = ImageProcessing::VERSION
+  spec.authors       = ["Janko Marohnić"]
+  spec.email         = ["janko.marohnic@gmail.com"]
+
+  spec.summary       = "Set of higher-level helper methods for image processing."
+  spec.description   = "Set of higher-level helper methods for image processing."
+  spec.homepage      = "https://github.com/janko-m/image_processing"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["README.md", "LICENSE.txt", "lib/**/*", "image_processing.gemspec"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "minitest-hooks"
+  spec.add_development_dependency "minispec-metadata"
+  spec.add_development_dependency "mini_magick", ">= 4.3.5"
+  spec.add_development_dependency "phashion"
+end

data/lib/image_processing/mini_magick.rb

@@ -0,0 +1,179 @@
+require "image_processing/version"
+require "mini_magick"
+require "tempfile"
+
+if MiniMagick.version < Gem::Version.new("4.3.5")
+  raise "image_processing requires mini_magick version >= 4.3.5"
+end
+
+module ImageProcessing
+  module MiniMagick
+    def self.nondestructive_alias(name, original)
+      define_method(name) do |image, *args, &block|
+        send(original, _copy_to_tempfile(image), *args, &block)
+      end
+    end
+
+    module_function
+
+    # Changes the image encoding format to the given format
+    #
+    # @see http://www.imagemagick.org/script/command-line-options.php#format
+    # @param [MiniMagick::Image] image    the image to convert
+    # @param [String] format              the format to convert to
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    def convert!(image, format, &block)
+      _with_minimagick(image) do |img|
+        img.format(format.downcase, nil, &block)
+      end
+    end
+    nondestructive_alias :convert, :convert!
+
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. Will only resize the image if it is larger
+    # than the specified dimensions. The resulting image may be shorter or
+    # narrower than specified in either dimension but will not be larger than
+    # the specified values.
+    #
+    # @param [MiniMagick::Image] image    the image to convert
+    # @param [#to_s] width                the maximum width
+    # @param [#to_s] height               the maximum height
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    def resize_to_limit!(image, width, height)
+      _with_minimagick(image) do |img|
+        img.combine_options do |cmd|
+          yield cmd if block_given?
+          cmd.resize "#{width}x#{height}>"
+        end
+      end
+    end
+    nondestructive_alias :resize_to_limit, :resize_to_limit!
+
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio. The image may be shorter or narrower than
+    # specified in the smaller dimension but will not be larger than the
+    # specified values.
+    #
+    # @param [MiniMagick::Image] image    the image to convert
+    # @param [#to_s] width                the width to fit into
+    # @param [#to_s] height               the height to fit into
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    def resize_to_fit!(image, width, height)
+      _with_minimagick(image) do |img|
+        img.combine_options do |cmd|
+          yield cmd if block_given?
+          cmd.resize "#{width}x#{height}"
+        end
+      end
+    end
+    nondestructive_alias :resize_to_fit, :resize_to_fit!
+
+    # Resize the image so that it is at least as large in both dimensions as
+    # specified, then crops any excess outside the specified dimensions.
+    #
+    # The resulting image will always be exactly as large as the specified
+    # dimensions.
+    #
+    # By default, the center part of the image is kept, and the remainder
+    # cropped off, but this can be changed via the `gravity` option.
+    #
+    # @param [MiniMagick::Image] image    the image to convert
+    # @param [#to_s] width                the width to fill out
+    # @param [#to_s] height               the height to fill out
+    # @param [String] gravity             which part of the image to focus on
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    # @see http://www.imagemagick.org/script/command-line-options.php#gravity
+    def resize_to_fill!(image, width, height, gravity: "Center")
+      _with_minimagick(image) do |img|
+        img.combine_options do |cmd|
+          yield cmd if block_given?
+          cmd.resize "#{width}x#{height}^"
+          cmd.gravity gravity
+          cmd.extent "#{width}x#{height}"
+        end
+      end
+    end
+    nondestructive_alias :resize_to_fill, :resize_to_fill!
+
+    # Resize the image to fit within the specified dimensions while retaining
+    # the original aspect ratio in the same way as {#fill}. Unlike {#fill} it
+    # will, if necessary, pad the remaining area with the given color, which
+    # defaults to transparent where supported by the image format and white
+    # otherwise.
+    #
+    # The resulting image will always be exactly as large as the specified
+    # dimensions.
+    #
+    # By default, the image will be placed in the center but this can be
+    # changed via the `gravity` option.
+    #
+    # @param [MiniMagick::image] image    the image to convert
+    # @param [#to_s] width                the width to fill out
+    # @param [#to_s] height               the height to fill out
+    # @param [string] background          the color to use as a background
+    # @param [string] gravity             which part of the image to focus on
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    # @see http://www.imagemagick.org/script/color.php
+    # @see http://www.imagemagick.org/script/command-line-options.php#gravity
+    def resize_and_pad!(image, width, height, background: "transparent", gravity: "Center")
+      _with_minimagick(image) do |img|
+        img.combine_options do |cmd|
+          yield cmd if block_given?
+          cmd.resize "#{width}x#{height}"
+          if background == "transparent"
+            cmd.background "rgba(255, 255, 255, 0.0)"
+          else
+            cmd.background background
+          end
+          cmd.gravity gravity
+          cmd.extent "#{width}x#{height}"
+        end
+      end
+    end
+    nondestructive_alias :resize_and_pad, :resize_and_pad!
+
+    # Resample the image to fit within the specified resolution while retaining
+    # the original image size.
+    #
+    # The resulting image will always be the same pixel size as the source with
+    # an adjusted resolution dimensions.
+    #
+    # @param [MiniMagick::Image] img      the image to convert
+    # @param [#to_s] width                the dpi width
+    # @param [#to_s] height               the dpi height
+    # @yield [MiniMagick::Tool::Mogrify, MiniMagick::Tool::Convert]
+    # @return [File, Tempfile]
+    # @see http://www.imagemagick.org/script/command-line-options.php#resample
+    def resample!(image, width, height)
+      _with_minimagick(image) do |img|
+        img.combine_options do |cmd|
+          yield cmd if block_given?
+          cmd.resample "#{width}x#{height}"
+        end
+      end
+    end
+    nondestructive_alias :resample, :resample!
+
+    # Convert an image into a MiniMagick::Image for the duration of the block,
+    # and at the end return a File object.
+    def _with_minimagick(image)
+      image = ::MiniMagick::Image.new(image.path, image)
+      yield image
+      image.instance_variable_get("@tempfile")
+    end
+
+    # Creates a copy of the file and stores it into a Tempfile. Works for any
+    # IO object that responds to `#read(length = nil, outbuf = nil)`.
+    def _copy_to_tempfile(file)
+      args = [File.basename(file.path, ".*"), File.extname(file.path)] if file.respond_to?(:path)
+      tempfile = Tempfile.new(args || "image", binmode: true)
+      IO.copy_stream(file, tempfile.path)
+      tempfile
+    end
+  end
+end

data/lib/image_processing/version.rb

@@ -0,0 +1,3 @@
+module ImageProcessing
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: image_processing
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  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: minispec-metadata
+  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: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+- !ruby/object:Gem::Dependency
+  name: phashion
+  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: Set of higher-level helper methods for image processing.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- image_processing.gemspec
+- lib/image_processing/mini_magick.rb
+- lib/image_processing/version.rb
+homepage: https://github.com/janko-m/image_processing
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Set of higher-level helper methods for image processing.
+test_files: []
+has_rdoc: