refile-mini_magick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10851b9908e5028f56547ef5f88631c42c8833d6
+  data.tar.gz: 5675f42a9d038b1129c8f7c606ee464a7ee217b8
+SHA512:
+  metadata.gz: 9eb1c20278a5f1772aaf60e6d39f98e2940f65fb79f9d31f134fc0f45cd896f6063254b5cd21f247a863c801b6960ae0b645ec4076914eca878e4eb2f83fdeb4
+  data.tar.gz: e926a3da9fdfa501630297b702815c560eb776c3075d37a911038786bc6522f086214865580edaccdb961d8defc40bdb0f2f89f04e0ad2ea93e069a5f4946b85

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in refile-mini_magick.gemspec
+gemspec
+
+gem "refile", github: "refile/refile"
+gem "rspec", "~> 3.0"
+gem "rake"
+gem "pry"
+gem "phashion"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonas Nicklas
+
+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,31 @@
+# Refile::MiniMagick
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'refile-mini_magick'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install refile-mini_magick
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/refile-mini_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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: "spec"
+

data/lib/refile/mini_magick.rb

@@ -0,0 +1,127 @@
+require "refile"
+require "refile/mini_magick/version"
+require "mini_magick"
+
+module Refile
+  # Processes images via MiniMagick, resizing cropping and padding them.
+  class MiniMagick
+    # @param [Symbol] method        The method to invoke on {#call}
+    def initialize(method)
+      @method = method
+    end
+
+    # Changes the image encoding format to the given format
+    #
+    # @see http://www.imagemagick.org/script/command-line-options.php#format
+    # @param [MiniMagick::Image] img      the image to convert
+    # @param [String] format              the format to convert to
+    # @return [void]
+    def convert(img, format)
+      img.format(format.to_s.downcase, nil)
+    end
+
+    # 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] img      the image to convert
+    # @param [#to_s] width                the maximum width
+    # @param [#to_s] height               the maximum height
+    # @return [void]
+    def limit(img, width, height)
+      img.resize "#{width}x#{height}>"
+    end
+
+    # 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] img      the image to convert
+    # @param [#to_s] width                the width to fit into
+    # @param [#to_s] height               the height to fit into
+    # @return [void]
+    def fit(img, width, height)
+      img.resize "#{width}x#{height}"
+    end
+
+    # 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] img      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
+    # @return [void]
+    # @see http://www.imagemagick.org/script/command-line-options.php#gravity
+    def fill(img, width, height, gravity = "Center")
+      img.combine_options do |cmd|
+        cmd.resize "#{width}x#{height}^"
+        cmd.gravity gravity
+        cmd.extent "#{width}x#{height}"
+      end
+    end
+
+    # 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] img      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
+    # @return [void]
+    # @see http://www.imagemagick.org/script/color.php
+    # @see http://www.imagemagick.org/script/command-line-options.php#gravity
+    def pad(img, width, height, background = "transparent", gravity = "Center")
+      img.combine_options do |cmd|
+        cmd.thumbnail "#{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
+
+    # Process the given file. The file will be processed via one of the
+    # instance methods of this class, depending on the `method` argument passed
+    # to the constructor on initialization.
+    #
+    # If the format is given it will convert the image to the given file format.
+    #
+    # @param [Tempfile] file        the file to manipulate
+    # @param [String] format        the file format to convert to
+    # @return [File]                the processed file
+    def call(file, *args, format: nil)
+      img = ::MiniMagick::Image.new(file.path)
+      img.format(format.to_s.downcase, nil) if format
+      send(@method, img, *args)
+
+      ::File.open(img.path, "rb")
+    end
+  end
+end
+
+[:fill, :fit, :limit, :pad, :convert].each do |name|
+  Refile.processor(name, Refile::MiniMagick.new(name))
+end

data/lib/refile/mini_magick/version.rb

@@ -0,0 +1,5 @@
+module Refile
+  class MiniMagick
+    VERSION = "0.1.0"
+  end
+end

data/refile-mini_magick.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'refile/mini_magick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "refile-mini_magick"
+  spec.version       = Refile::MiniMagick::VERSION
+  spec.authors       = ["Jonas Nicklas"]
+  spec.email         = ["jonas.nicklas@gmail.com"]
+  spec.summary       = "Image processing via MiniMagick for Refile"
+  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_dependency "refile", "~> 0.5"
+  spec.add_dependency "mini_magick", "~> 4.0"
+end

data/spec/refile/mini_magick_spec.rb

@@ -0,0 +1,125 @@
+require "pry"
+require "refile/mini_magick"
+require "phashion"
+
+describe Refile::MiniMagick do
+  let(:portrait) { Tempfile.new(["portrait", ".jpg"]) }
+  let(:landscape) { Tempfile.new(["landscape", ".jpg"]) }
+
+  matcher :be_similar_to do |expected|
+    match do |actual|
+      a = Phashion::Image.new(expected)
+      b = Phashion::Image.new(actual)
+      @distance = a.distance_from(b).abs
+      @distance < allowed_distance
+    end
+
+    failure_message do
+      "perceptual hash distance between images should be < #{allowed_distance} but was #{@distance}"
+    end
+
+    def allowed_distance
+      2
+    end
+  end
+
+  def fixture_path(name)
+    File.expand_path("./fixtures/#{name}", File.dirname(__FILE__))
+  end
+
+  before do
+    FileUtils.cp(fixture_path("portrait.jpg"), portrait.path)
+    FileUtils.cp(fixture_path("landscape.jpg"), landscape.path)
+  end
+
+  describe "#convert" do
+    it "changes the image format" do
+      file = Refile::MiniMagick.new(:convert).call(portrait, "png")
+      expect(::MiniMagick::Image.new(file.path).identify).to match(/PNG/)
+    end
+  end
+
+  describe "#limit" do
+    it "resizes the image up to a given limit" do
+      file = Refile::MiniMagick.new(:limit).call(portrait, "400", "400")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(300)
+      expect(result.height).to eq(400)
+    end
+
+    it "does not resize the image if it is smaller than the limit" do
+      file = Refile::MiniMagick.new(:limit).call(portrait, "1000", "1000")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(600)
+      expect(result.height).to eq(800)
+    end
+
+    it "produces correct image" do
+      file = Refile::MiniMagick.new(:limit).call(portrait, "400", "400")
+      expect(file.path).to be_similar_to(fixture_path("limit.jpg"))
+    end
+  end
+
+  describe "#fit" do
+    it "resizes the image to fit given dimensions" do
+      file = Refile::MiniMagick.new(:fit).call(portrait, "400", "400")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(300)
+      expect(result.height).to eq(400)
+    end
+
+    it "enlarges image if it is smaller than given dimensions" do
+      file = Refile::MiniMagick.new(:fit).call(portrait, "1000", "1000")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(750)
+      expect(result.height).to eq(1000)
+    end
+
+    it "produces correct image" do
+      file = Refile::MiniMagick.new(:fit).call(portrait, "400", "400")
+      expect(file.path).to be_similar_to(fixture_path("fit.jpg"))
+    end
+  end
+
+  describe "#fill" do
+    it "resizes and crops the image to fill out the given dimensions" do
+      file = Refile::MiniMagick.new(:fill).call(portrait, "400", "400")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(400)
+      expect(result.height).to eq(400)
+    end
+
+    it "enlarges image and crops it if it is smaller than given dimensions" do
+      file = Refile::MiniMagick.new(:fill).call(portrait, "1000", "1000")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(1000)
+      expect(result.height).to eq(1000)
+    end
+
+    it "produces correct image" do
+      file = Refile::MiniMagick.new(:fill).call(portrait, "400", "400")
+      expect(file.path).to be_similar_to(fixture_path("fill.jpg"))
+    end
+  end
+
+  describe "#fill" do
+    it "resizes and fills out the remaining space to fill out the given dimensions" do
+      file = Refile::MiniMagick.new(:pad).call(portrait, "400", "400", "red")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(400)
+      expect(result.height).to eq(400)
+    end
+
+    it "enlarges image and fills out the remaining space to fill out the given dimensions" do
+      file = Refile::MiniMagick.new(:pad).call(portrait, "1000", "1000", "red")
+      result = ::MiniMagick::Image.new(file.path)
+      expect(result.width).to eq(1000)
+      expect(result.height).to eq(1000)
+    end
+
+    it "produces correct image" do
+      file = Refile::MiniMagick.new(:pad).call(portrait, "400", "400")
+      expect(file.path).to be_similar_to(fixture_path("pad.jpg"))
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: refile-mini_magick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Nicklas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- jonas.nicklas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/refile/mini_magick.rb
+- lib/refile/mini_magick/version.rb
+- refile-mini_magick.gemspec
+- spec/refile/fixtures/fill.jpg
+- spec/refile/fixtures/fit.jpg
+- spec/refile/fixtures/landscape.jpg
+- spec/refile/fixtures/limit.jpg
+- spec/refile/fixtures/pad.jpg
+- spec/refile/fixtures/portrait.jpg
+- spec/refile/mini_magick_spec.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.4.5
+signing_key: 
+specification_version: 4
+summary: Image processing via MiniMagick for Refile
+test_files:
+- spec/refile/fixtures/fill.jpg
+- spec/refile/fixtures/fit.jpg
+- spec/refile/fixtures/landscape.jpg
+- spec/refile/fixtures/limit.jpg
+- spec/refile/fixtures/pad.jpg
+- spec/refile/fixtures/portrait.jpg
+- spec/refile/mini_magick_spec.rb