paperclip-vips 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83158c22bc04735dc1f466e6abb2ea88fe7b8c21ecf46abc95c22737bcdd90f6
+  data.tar.gz: a922e67d9223c6097977437754dfc29b0181d3cd9f7587fb86d03e9a3b44538a
+SHA512:
+  metadata.gz: 60b424796be1bd14b8ae5d202d97eac2ae1c80719d5087e06ea1649661aa1c6271a60d728e03b8e0f32c141a7334186dfc6dd088515b849b7775579e498a55e5
+  data.tar.gz: 3bb6bac77224fc613d5d1e2f026da27d83bbc08b2096c255fad5e03de949fae636e6d1c3a60355e3f28a9d8b6c88bf5a21ee793ef35c99420c82a72dd250bf56

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ken@kengreeff.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    paperclip-vips (1.0.0)
+      paperclip (>= 5.2.1)
+      ruby-vips (~> 2.0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    climate_control (0.2.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    mimemagic (0.3.3)
+    minitest (5.11.3)
+    paperclip (6.1.0)
+      activemodel (>= 4.2.0)
+      activesupport (>= 4.2.0)
+      mime-types
+      mimemagic (~> 0.3.0)
+      terrapin (~> 0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby-vips (2.0.13)
+      ffi (~> 1.9)
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  paperclip-vips!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ken Greeff
+
+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,77 @@
+# paperclip-vips
+
+A custom paperclip processor that uses the [libvips image processing library](https://libvips.github.io/libvips) for faster image resizing and manipulation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperclip-vips'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-vips
+
+Note: You will need to have libvips installed on your machine for this processor to work correctly.
+
+## Usage
+
+Basic Example:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    styles: {
+        medium: { geometry: '300x300' },
+        thumb: { geometry: '100x100#' }
+    },
+    processors: [:vips]
+end
+```
+
+You can also provide additional processing steps by passing a json array to paperclip convert_options:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    styles: {
+        medium: { geometry: '300x300' },
+        thumb: { geometry: '100x100#' }
+    },
+    :convert_options => {
+        :cmyk_original => lambda { |file| [{
+            cmd: "icc_transform",
+            args: ["PATH_TO_PROFILE"],
+            optional: {
+                input_profile: "PATH_TO_INPUT_PROFILE",
+                intent: :perceptual,
+            },
+        }].to_json }
+    },
+    processors: [:vips]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/paperclip-vips. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Paperclip::Vips project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/paperclip-vips/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paperclip/vips"
+
+# 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(__FILE__)

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/lib/paperclip-vips/paperclip/vips.rb

@@ -0,0 +1,92 @@
+module Paperclip
+  class Vips < Processor
+    attr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options,
+                  :source_file_options, :auto_orient
+
+    def initialize(file, options = {}, attachment = nil)
+      super
+
+      geometry = options[:geometry].to_s
+      @should_crop = geometry[-1,1] == '#'
+      @target_geometry = options.fetch(:string_geometry_parser, Geometry).parse(geometry)
+      @current_geometry = options.fetch(:file_geometry_parser, Geometry).from_file(@file)
+      @whiny = options.fetch(:whiny, true)
+      
+      @current_format = File.extname(@file.path)&.downcase
+      @format = options[:format] || @current_format
+
+      @basename = File.basename(@file.path, @current_format)
+    end
+
+    def crop
+      if @should_crop
+        return @options[:crop] || :centre
+      end
+
+      nil
+    end
+
+    def make
+      source = @file
+      filename = [@basename, @format ? ".#{@format}" : ""].join
+      destination = TempfileFactory.new.generate(filename)
+
+      begin
+        thumbnail = ::Vips::Image.thumbnail(source.path, width, { height: crop ? height : nil, crop: crop }) if @target_geometry
+        thumbnail = ::Vips::Image.new_from_file(source.path) if !defined?(thumbnail) || thumbnail.nil?
+        thumbnail = process_convert_options(thumbnail)
+        save_thumbnail(thumbnail, destination.path)
+        
+      rescue => e
+        if @whiny
+          message = "There was an error processing the thumbnail for #{@basename}:\n" + e.message
+          raise Paperclip::Error, message
+        end
+      end
+
+      return destination
+    end
+
+    def width
+      @target_geometry&.width || @current_geometry.width
+    end
+
+    def height
+      @target_geometry&.height || @current_geometry.height
+    end
+    
+    def process_convert_options(image)
+      if image && @options[:convert_options].present?
+        commands = JSON.parse(@options[:convert_options], symbolize_names: true)
+        commands.each do |cmd|
+          image = ::Vips::Operation.call(cmd[:cmd], [image, *cmd[:args]], cmd[:optional] || {})
+        end
+      end
+
+      return image
+    end
+
+    def save_thumbnail(thumbnail, path)
+      case @current_format
+      when ".jpeg", ".jpg"
+        save_jpg(thumbnail, path)
+      when ".gif"
+        save_gif(thumbnail, path)
+      when ".png"
+        save_png(thumbnail, path)
+      end
+    end
+
+    def save_jpg(thumbnail, path)
+      thumbnail.jpegsave(path)
+    end
+
+    def save_gif(thumbnail, path)
+      thumbnail.magicksave(path)
+    end
+
+    def save_png(thumbnail, path)
+      thumbnail.pngsave(path)
+    end
+  end
+end

data/lib/paperclip-vips/version.rb

@@ -0,0 +1,3 @@
+module PaperclipVips
+  VERSION = "1.0.0"
+end

data/lib/paperclip-vips.rb

@@ -0,0 +1,10 @@
+require "ruby-vips"
+require "paperclip"
+require "paperclip-vips/version"
+require "paperclip-vips/paperclip/vips"
+
+module PaperclipVips
+  def self.root
+    Gem::Specification.find_by_name('paperclip-vips').gem_dir
+  end
+end

data/paperclip-vips.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "paperclip-vips/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-vips"
+  spec.version       = PaperclipVips::VERSION
+  spec.authors       = ["Ken Greeff"]
+  spec.email         = ["ken@kengreeff.com"]
+
+  spec.summary       = %q{Uses Ruby Vips to when creating thumbnails for faster generation.}
+  spec.homepage      = "https://github.com/realhub/paperclip-vips"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'paperclip', '>= 5.2.1'
+  spec.add_runtime_dependency "ruby-vips", "~> 2.0.13"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-vips
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ken Greeff
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.13
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ken@kengreeff.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paperclip-vips.rb
+- lib/paperclip-vips/paperclip/vips.rb
+- lib/paperclip-vips/version.rb
+- paperclip-vips.gemspec
+homepage: https://github.com/realhub/paperclip-vips
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Uses Ruby Vips to when creating thumbnails for faster generation.
+test_files: []