dragonfly_libvips 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eaa493a04d09a02fff56c6ed9a96d244453142d
+  data.tar.gz: ffc53d69657496a3413d6937715f35a3e261225c
+SHA512:
+  metadata.gz: 6278072c36ef32d7a2b96167b79dec82d92382c41c3aa83586da2b9e4d682a1fd9fdcd82f132b5fc669cba9274d90a488c1c1edc2042df0f99ffb14e09d72545
+  data.tar.gz: 44824ca4a8057952278319e75b84c79546fa41f226fcab7758e58367fcb2b7521433ce6aaf2b07b81f29367ab6d0f9a36746aab659de7ad91b1e52f6e629cd77

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log

data/.travis.yml

@@ -0,0 +1,39 @@
+# libvips build instructions taken from https://github.com/marcbachmann/dockerfile-libvips
+
+language: ruby
+script: 'bundle exec rake'
+sudo: required
+dist: trusty
+rvm:
+  - 2.2.5
+env:
+  - LIBVIPS_VERSION_MAJOR=8 LIBVIPS_VERSION_MINOR=3 LIBVIPS_VERSION_PATCH=3 LIBVIPS_VERSION=$LIBVIPS_VERSION_MAJOR.$LIBVIPS_VERSION_MINOR.$LIBVIPS_VERSION_PATCH
+before_install:
+  - gem install bundler -v 1.12.5
+
+  # Install dependencies
+  - sudo apt-get update
+  - DEBIAN_FRONTEND=noninteractive sudo apt-get install -y automake build-essential curl gobject-introspection gtk-doc-tools libglib2.0-dev libjpeg-turbo8-dev libpng12-dev libwebp-dev libtiff5-dev libexif-dev libxml2-dev swig libpango1.0-dev libmatio-dev libopenslide-dev libcfitsio3-dev
+  - DEBIAN_FRONTEND=noninteractive sudo apt-get install -y libgif-dev librsvg2-dev libpoppler-glib-dev libfftw3-dev liblcms2-dev libpangoft2-1.0-0 liborc-0.4-dev libpoppler-glib-dev
+
+  # Build libvips
+  - curl -O http://www.vips.ecs.soton.ac.uk/supported/$LIBVIPS_VERSION_MAJOR.$LIBVIPS_VERSION_MINOR/vips-$LIBVIPS_VERSION.tar.gz
+  - tar zvxf vips-$LIBVIPS_VERSION.tar.gz && cd vips-$LIBVIPS_VERSION
+  - ./configure $1
+  - sudo make
+  - sudo make install
+  - sudo ldconfig
+
+  # Clean up
+  - sudo apt-get remove -y curl automake build-essential
+  - sudo apt-get autoremove -y
+  - sudo apt-get autoclean
+  - sudo apt-get clean
+  - sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Celizna
+
+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,156 @@
+# Dragonfly libvips
+
+[![Build Status](https://travis-ci.org/tomasc/dragonfly_libvips.svg)](https://travis-ci.org/tomasc/dragonfly_libvips) [![Gem Version](https://badge.fury.io/rb/dragonfly_libvips.svg)](http://badge.fury.io/rb/dragonfly_libvips) [![Coverage Status](https://img.shields.io/coveralls/tomasc/dragonfly_libvips.svg)](https://coveralls.io/r/tomasc/dragonfly_pdf)
+
+Dragonfly analysers and processors for [libvips](https://github.com/jcupitt/libvips) image processing library
+
+From the libvips README:
+
+> libvips is a 2D image processing library. Compared to similar libraries, [libvips runs quickly and uses little memory](http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use). libvips is licensed under the LGPL 2.1+.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dragonfly_libvips'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install dragonfly_libvips
+```
+
+## Dependencies
+
+The [vips](http://www.vips.ecs.soton.ac.uk/index.php?title=Supported) library and its [dependencies](https://github.com/jcupitt/libvips#dependencies).
+
+## Usage
+
+Configure your app the usual way:
+
+```ruby
+Dragonfly.app.configure do
+  plugin :libvips
+end
+```
+
+### Processors
+
+#### Thumb
+
+Create a thumbnail by resizing/cropping
+
+```ruby
+image.thumb('40x30')
+```
+
+Below are some examples of geometry strings for `thumb`:
+
+```ruby
+'400x300' # resize, maintain aspect ratio
+'400x' # resize width, maintain aspect ratio
+'x300' # resize height, maintain aspect ratio
+'400x300<' # resize only if the image is smaller than this
+'400x300>' # resize only if the image is larger than this
+```
+
+#### Encode
+
+Change the encoding with
+
+```ruby
+image.encode('jpg')
+```
+
+optionally pass output arguments (specific to format)
+
+```ruby
+image.encode('jpg', 'Q=50')
+```
+
+#### Rotate
+
+Rotate a number of degrees with
+
+```ruby
+image.rotate(90)
+```
+
+#### Vips
+
+Perform an arbitrary `vips` command
+
+```ruby
+image.vips('resize', '0.5', { 'input_args' => 'page=2', 'output_args' => 'Q=50', 'format' => 'jpg' })
+```
+
+corresponds to the command-line
+
+```
+vips resize <original_path>[page=2] <new_path>[Q=50] 0.5
+```
+
+#### Vipsthumbnail
+
+Perform an arbitrary `vipsthumbnail` command
+
+```ruby
+image.vips('--size=100x100', { 'input_args' => 'page=2', 'output_args' => 'Q=50', 'format' => 'jpg' })
+```
+
+corresponds to the command-line
+
+```
+vipsthumbnail  <original_path>[page=2] --size=100x100 -o <new-path>[Q=50]
+```
+
+### Analysers
+
+The following methods are provided
+
+```ruby
+image.width # => 280
+image.height # => 355
+image.aspect_ratio # => 0.788732394366197
+image.portrait? # => true
+image.landscape? # => false
+image.format # => 'png'
+image.image? # => true
+```
+
+### Configuration
+
+```ruby
+Dragonfly.app.configure do
+  plugin :libvips,
+          vips_command: "/opt/local/bin/vips" # defaults to "vips"
+          vipsheader_command: "/opt/local/bin/vipsheader" # defaults to "vipsheader"
+          vipsthumbnail_command: "/opt/local/bin/vipsthumbnail" # defaults to "vipsthumbnail"
+end
+```
+
+## Acknowledgements
+
+This plugin, its structure, sample files, tests as well as this README are based on the original Dragonfly's [ImageMagick plugin](http://markevans.github.io/dragonfly/imagemagick) by Mark Evans.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/tomasc/dragonfly_libvips>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dragonfly_libvips"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dragonfly_libvips.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dragonfly_libvips/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dragonfly_libvips'
+  spec.version       = DragonflyLibvips::VERSION
+  spec.authors       = ['Tomas Celizna']
+  spec.email         = ['tomas.celizna@gmail.com']
+
+  spec.summary       = 'Dragonfly analysers and processors for libvips image processing library.'
+  spec.homepage      = 'https://github.com/tomasc/dragonfly_libvips'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dragonfly', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/dragonfly_libvips/analysers/image_properties.rb

@@ -0,0 +1,22 @@
+module DragonflyLibvips
+  module Analysers
+    class ImageProperties
+      def call(content)
+        vipsheader_command = content.env[:vipsheader_command] || 'vipsheader'
+        details = content.shell_eval do |path|
+          "#{vipsheader_command} #{path}"
+        end
+
+        _filename, dimensions, _bands, _interpretation, vips_loader = details.split(/\s*[:,]\s*/)
+        width, height = dimensions.split(/\s+/).first.split('x')
+        format = vips_loader.gsub(/\s*load\s*/, '').downcase
+
+        {
+          'format' => format.downcase,
+          'width' => width.to_i,
+          'height' => height.to_i
+        }
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/plugin.rb

@@ -0,0 +1,78 @@
+require 'dragonfly/shell'
+require 'dragonfly_libvips/analysers/image_properties'
+require 'dragonfly_libvips/processors/encode'
+require 'dragonfly_libvips/processors/thumb'
+require 'dragonfly_libvips/processors/vips'
+require 'dragonfly_libvips/processors/vipsthumbnail'
+
+module DragonflyLibvips
+  class Plugin
+    def call(app, opts = {})
+      # ENV
+      app.env[:vips_command] = opts[:vips_command] || 'vips'
+      app.env[:vipsheader_command] = opts[:vipsheader_command] || 'vipsheader'
+      app.env[:vipsthumbnail_command] = opts[:vipsthumbnail_command] || 'vipsthumbnail'
+
+      # Analysers
+      app.add_analyser :image_properties, DragonflyLibvips::Analysers::ImageProperties.new
+
+      app.add_analyser :width do |content|
+        content.analyse(:image_properties)['width']
+      end
+
+      app.add_analyser :height do |content|
+        content.analyse(:image_properties)['height']
+      end
+
+      app.add_analyser :format do |content|
+        content.analyse(:image_properties)['format']
+      end
+
+      app.add_analyser :aspect_ratio do |content|
+        attrs = content.analyse(:image_properties)
+        attrs['width'].to_f / attrs['height']
+      end
+
+      app.add_analyser :portrait do |content|
+        attrs = content.analyse(:image_properties)
+        attrs['width'] <= attrs['height']
+      end
+
+      app.add_analyser :landscape do |content|
+        !content.analyse(:portrait)
+      end
+
+      app.add_analyser :image do |content|
+        begin
+          content.analyse(:image_properties).key?('format')
+        rescue Dragonfly::Shell::CommandFailed
+          false
+        end
+      end
+
+      # Aliases
+      app.define(:portrait?) { portrait }
+      app.define(:landscape?) { landscape }
+      app.define(:image?) { image }
+
+      # Processors
+      app.add_processor :encode, Processors::Encode.new
+      app.add_processor :thumb, Processors::Thumb.new
+      app.add_processor :vips, Processors::Vips.new
+      app.add_processor :vipsthumbnail, Processors::Vipsthumbnail.new
+      app.add_processor :rotate do |content, amount|
+        content.process!(:vips, 'rot', "d#{amount}")
+      end
+
+      # Extra methods
+      app.define :vipsheader do |*args|
+        cli_args = args.first # because ruby 1.8.7 can't deal with default args in blocks
+        shell_eval do |path|
+          "#{app.env[:vipsheader_command]} #{cli_args} #{path}"
+        end
+      end
+    end
+  end
+end
+
+Dragonfly::App.register_plugin(:libvips) { DragonflyLibvips::Plugin.new }

data/lib/dragonfly_libvips/processors/encode.rb

@@ -0,0 +1,14 @@
+module DragonflyLibvips
+  module Processors
+    class Encode
+      def call(content, format, output_args = '')
+        opts = { 'format' => format, 'output_args' => output_args }
+        content.process!(:vips, 'copy', '', opts)
+      end
+
+      def update_url(attrs, format, _args = '')
+        attrs.ext = format.to_s
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/processors/thumb.rb

@@ -0,0 +1,53 @@
+module DragonflyLibvips
+  module Processors
+    class Thumb
+      OPERATORS = '><'.freeze
+      RESIZE_GEOMETRY = /\A\d*x\d*[#{OPERATORS}]?\z/ # e.g. '300x200>'
+
+      def update_url(url_attributes, _geometry, opts = {})
+        format = opts['format']
+        url_attributes.ext = format if format
+      end
+
+      def call(content, geometry, opts = {})
+        image_properties = content.analyse(:image_properties)
+        content.process!(:vipsthumbnail, args_for_geometry(geometry, image_properties), opts)
+      end
+
+      def args_for_geometry(geometry, image_properties)
+        case geometry
+        when RESIZE_GEOMETRY then resize_args(geometry, image_properties)
+        else raise ArgumentError, "Didn't recognise the geometry string #{geometry}"
+        end
+      end
+
+      private
+
+      def resize_args(geometry, image_properties)
+        w = image_properties['width']
+        h = image_properties['height']
+        ratio = w.to_f / h.to_f
+        is_landscape = ratio > 1.0
+
+        width, height = geometry.scan(/\A(\d*)x(\d*)/).flatten.map(&:to_i)
+
+        case geometry
+        when /\Ax\d+[#{OPERATORS}]?/
+          width = is_landscape ? (ratio * height).round : height
+        when /\A\d+x[#{OPERATORS}]?\z/
+          height = is_landscape ? width : (width / ratio).round
+        end
+
+        case geometry
+        when />\z/
+          width, height = w, h if width >= w || height >= h
+        when /<\z/
+          width, height = w, h if width <= w && height <= h
+        end
+
+        dimensions = "#{width}x#{height}"
+        "-s #{dimensions}"
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/processors/vips.rb

@@ -0,0 +1,32 @@
+module DragonflyLibvips
+  module Processors
+    class Vips
+      def call(content, commands, args = '', opts = {})
+        vips_command = content.env[:vips_command] || 'vips'
+        format = opts['format']
+
+        if input_args = opts['input_args']
+          input_args = "[#{input_args}]"
+        end
+
+        if output_args = opts['output_args']
+          output_args = "[#{output_args}]"
+        end
+
+        content.shell_update ext: format do |old_path, new_path|
+          "#{vips_command} #{commands} #{old_path}#{input_args} #{new_path}#{output_args} #{args}"
+        end
+
+        if format
+          content.meta['format'] = format.to_s
+          content.ext = format
+        end
+      end
+
+      def update_url(attrs, _commands, _args = '', opts = {})
+        format = opts['format']
+        attrs.ext = format if format
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/processors/vipsthumbnail.rb

@@ -0,0 +1,24 @@
+module DragonflyLibvips
+  module Processors
+    class Vipsthumbnail
+      def call(content, args = '', opts = {})
+        vipsthumbnail_command = content.env[:vipsthumbnail_command] || 'vipsthumbnail'
+        format = opts['format']
+
+        content.shell_update ext: format do |old_path, new_path|
+          "#{vipsthumbnail_command} #{old_path} -o #{new_path} #{args}"
+        end
+
+        if format
+          content.meta['format'] = format.to_s
+          content.ext = format
+        end
+      end
+
+      def update_url(attrs,  _args = '', opts = {})
+        format = opts['format']
+        attrs.ext = format if format
+      end
+    end
+  end
+end

data/lib/dragonfly_libvips/version.rb

@@ -0,0 +1,3 @@
+module DragonflyLibvips
+  VERSION = '0.1.0'.freeze
+end

data/lib/dragonfly_libvips.rb

@@ -0,0 +1,3 @@
+require 'dragonfly'
+require 'dragonfly_libvips/plugin'
+require 'dragonfly_libvips/version'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: dragonfly_libvips
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dragonfly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dragonfly_libvips.gemspec
+- lib/dragonfly_libvips.rb
+- lib/dragonfly_libvips/analysers/image_properties.rb
+- lib/dragonfly_libvips/plugin.rb
+- lib/dragonfly_libvips/processors/encode.rb
+- lib/dragonfly_libvips/processors/thumb.rb
+- lib/dragonfly_libvips/processors/vips.rb
+- lib/dragonfly_libvips/processors/vipsthumbnail.rb
+- lib/dragonfly_libvips/version.rb
+- samples/beach.png
+- samples/landscape_beach.png
+- samples/memo.pdf
+- samples/white pixel.png
+homepage: https://github.com/tomasc/dragonfly_libvips
+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.1
+signing_key: 
+specification_version: 4
+summary: Dragonfly analysers and processors for libvips image processing library.
+test_files: []