attachment_saver 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35a16fce5a99e7ed88cc052759edcfbe3888202
-  data.tar.gz: 79cb33e50d35f9dd4828a42e07cb11781637e3eb
+  metadata.gz: 1ab301b6cb41a742a469e6570ee68098947546bf
+  data.tar.gz: b2b922db15fc14b957f9fe6c3ef3ad7493ab4f3a
 SHA512:
-  metadata.gz: '0911d907f27e14f6f75c1e3c80dc70f492e465868de2f38c6f7325d52eb7fa79dbaef9007070be838da7ddf76d4302b64e59b41fa268f8c176ac32191cb7612d'
-  data.tar.gz: 649583ca6636e12a6f3f4e03ea1a8ea71124c09f5c728f116b1765e4457cdbe8ef874800b5acdc4c3c08bdbdb346fc8f954b42ee1b8d6bb6a4802b9d43f5fe78
+  metadata.gz: 73d1c02e925c5855493f40c313cd5320d169cfc55da1a613cdf15c15484c74e1406db90c18fed8dcb9d728dd4e89b0938fbe2cf3da2e08b092001e383684366f
+  data.tar.gz: c7a870a119aca14f8fb6696841f13dc8fe6300eea0db95e317eb88cc6a0d226d5771d50d1ddd649b7198b9e8466dfeeaeb55e0aedf13cde0dd40cac9895b6e5f

data/.gitignore

@@ -1,3 +1,5 @@
 test/log/*
 test/tmp/*
 test/attachment_saver_test_sqlite.db
+samples.html
+samples/

data/Gemfile

@@ -9,3 +9,5 @@ gemspec
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
+
+gem 'activerecord', ENV['RAILS_VERSION']

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attachment_saver (1.2.0)
+    attachment_saver (1.4.0)
       activerecord
       mimemagic
 
@@ -11,19 +11,23 @@ GEM
     RubyInline (3.12.4)
       ZenTest (~> 4.3)
     ZenTest (4.11.1)
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
+    activemodel (5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+    activerecord (5.2.0.beta2)
+      activemodel (= 5.2.0.beta2)
+      activesupport (= 5.2.0.beta2)
+      arel (>= 9.0)
+    activesupport (5.2.0.beta2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (8.0.0)
+    arel (9.0.0)
     concurrent-ruby (1.0.5)
+    gdk_pixbuf2 (2.2.5)
+      glib2 (= 2.2.5)
+    glib2 (2.2.5)
+      pkg-config
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     image_science (1.3.0)
@@ -32,9 +36,10 @@ GEM
     metaclass (0.0.4)
     mimemagic (0.3.2)
     mini_magick (4.8.0)
-    minitest (5.10.3)
+    minitest (5.11.0)
     mocha (1.3.0)
       metaclass (~> 0.0.1)
+    pkg-config (1.2.8)
     rake (12.3.0)
     rmagick (2.16.0)
     sqlite3 (1.3.13)
@@ -46,7 +51,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   attachment_saver!
+  gdk_pixbuf2
   image_science
   image_size
   mini_magick
@@ -56,4 +63,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.15.3
+   1.16.1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Will Bryant, Sekuda Ltd
+Copyright (c) 2007-2018 Will Bryant, Sekuda Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -8,14 +8,16 @@ provided, and the architecture simplifies clean implementation of other types
 of processing.  Errors are carefully handled to minimize the possibility of
 broken uploads leaving incomplete or corrupt data.
 
-RMagick, MiniMagick, and ImageScience image processors are supported.
+RMagick, MiniMagick, ImageScience, and GdkPixbuf image processors are supported.
+
+The pure-ruby ImageSize image processor is also supported (for inspecting images but not resizing them).
 
 
 Compatibility
 =============
 
-Currently tested against Rails 3.2.13 and 3.1.8, on Ruby 1.8.7 and 2.0.0p0.
-Was also tested compatible with 2.3.14 and 3.0.17.
+Currently tested against Rails 5.2 (up to 5.2.0.beta2), 5.1 (up to 5.1.4), 5.0 (up to 5.0.6), and 4.2 (up to 4.2.10), on Ruby 2.3.6, 2.4.3, and 2.5.0.
+Was also tested compatible with 2.3.14, 3.0.17, 3.1.8, 3.2.13, 4.2, and 5.0.
 
 
 Examples
@@ -116,7 +118,7 @@ A custom image-processing format using your image-processor's features
 ----------------------------------------------------------------------
 
 # in a file in your lib/ directory that's required in somewhere:
-module AttachmentSaver::Processors::RMagick::Operations # or MiniMagick::Operations or ImageScience::Operations - see lib/processors
+module AttachmentSaver::Processors::RMagick::Operations # or MiniMagick::Operations or ImageScience::Operations or GdkPixbuf::Operations - see lib/processors
   # this module is mixed in to the actual image objects built by the processor, so you can call its' methods directly
   def wavy_black_and_white(wave_height, wave_length, &block)
     # RMagick returns the new object; MiniMagick acts on the same object (so you must dup); ImageScience yields; so, look at the existing lib/processors to see the appropriate pattern

data/attachment_saver.gemspec

@@ -33,6 +33,7 @@ EOF
   gem.add_development_dependency "rmagick"
   gem.add_development_dependency "mini_magick"
   gem.add_development_dependency "image_size"
+  gem.add_development_dependency "gdk_pixbuf2"
   gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "mocha"
 end

data/lib/attachment_saver/version.rb

@@ -1,3 +1,3 @@
 module AttachmentSaver
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/lib/processors/gdk_pixbuf.rb

@@ -0,0 +1,106 @@
+require 'gdk_pixbuf2'
+require 'misc/extended_tempfile'
+require 'processors/image'
+
+class GdkPixbufProcessorError < ImageProcessorError; end
+
+module AttachmentSaver
+  module Processors
+    module GdkPixbuf
+      include Image
+
+      def with_image(filename, &block)
+        # we use Gdk::PixbufLoader rather than Gdk::Pixbuf.new(filename) so that we can learn the format of the
+        # image, which process_image wants to know so that it can save the derived images in the same format.
+        loader = Gdk::PixbufLoader.new
+        File.open(filename, "rb") do |file|
+          while buf = file.read(65536)
+            loader.write(buf)
+          end
+        end
+        loader.close
+        image = loader.pixbuf
+        image.extend(Operations)
+        image.format = loader.format.name
+        block.call(image)
+      end
+
+      def examine_image
+        fileinfo, width, height = Gdk::Pixbuf.get_file_info(uploaded_file_path)
+        raise GdkPixbufProcessorError, "Not an image" if fileinfo.nil?
+
+        self.width = width if respond_to?(:width)
+        self.height = height if respond_to?(:height)
+        self.content_type = fileinfo.mime_types.first unless self.class.attachment_options[:keep_content_type] || fileinfo.mime_types.empty?
+        self.file_extension = normalize_extension(fileinfo.extensions.first) unless self.class.attachment_options[:keep_file_extension] || fileinfo.extensions.empty?
+      rescue AttachmentSaverError
+        raise
+      rescue Exception => ex
+        raise GdkPixbufProcessorError, "#{ex.class}: #{ex.message}", ex.backtrace
+      end
+
+      def normalize_extension(extension)
+        case extension
+        when 'jpeg' then 'jpg'
+        else extension
+        end
+      end
+
+      def process_image(original_image, derived_format_name, resize_format)
+        resize_format = Image.from_geometry_string(resize_format) if resize_format.is_a?(String)
+
+        result = original_image.send(*resize_format) do |derived_image|
+          return nil unless want_format?(derived_format_name, derived_image.width, derived_image.height)
+
+          # both original_filename and content_type must be defined for parents when using image processing
+          # - but apps can just define them using attr_accessor if they don't want them persisted to db
+          derived_content_type = content_type
+          derived_extension = derived_image.file_type_extension
+
+          # we leverage tempfiles as discussed in the uploaded_file method
+          temp = ExtendedTempfile.new("asgtemp", tempfile_directory, derived_extension)
+          temp.binmode
+          temp.close
+          derived_image.save(temp.path, original_image.format)
+          temp.open # we close & reopen so we see the file the processor wrote to, even if it created a new file rather than writing into our tempfile
+
+          { :format_name => derived_format_name.to_s,
+            :width => derived_image.width,
+            :height => derived_image.height,
+            :content_type => derived_content_type,
+            :file_extension => derived_extension,
+            :uploaded_data => temp }
+        end
+
+        result
+      end
+
+      module Operations
+        include AttachmentSaver::Processors::Image::Operations
+
+        attr_accessor :format
+
+        def file_type_extension
+          case format
+            when 'jpeg' then 'jpg'
+            else format.downcase
+          end
+        end
+
+        def resize_to(new_width, new_height, &block)
+          image = scale(new_width, new_height)
+          image.extend Operations
+          image.format = format
+          block.call(image)
+        end
+
+        def crop_to(new_width, new_height, &block) # crops to the center
+          image = Gdk::Pixbuf.new(self, (width - new_width)/2, (height - new_height)/2, new_width, new_height)
+          image.extend Operations
+          image.format = format
+          block.call(image)
+        end
+      end
+    end
+  end
+end

data/lib/processors/image.rb

@@ -132,7 +132,7 @@ module AttachmentSaver
       module Operations
         # if they choose to use this module to implement the resize operations, the processor
         # module just needs to implement width, height, resize_to(new_width, new_height, &block),
-        # and crop_to(new_width, new_height, &block)
+        # and crop_to(new_width, new_height, &block).  they also need with_image for process_attachment.
         
         # squishes the image to the given width and height, without preserving the aspect ratio.
         # yields this image itself if it is already the given size.

data/lib/processors/image_size.rb

@@ -0,0 +1,42 @@
+require 'image_size'
+require 'misc/extended_tempfile'
+require 'processors/image'
+
+class ImageSizeProcessorError < ImageProcessorError; end
+
+module AttachmentSaver
+  module Processors
+    module ImageSize
+      include Image
+      
+      def examine_image
+        image_size = ::ImageSize.path(uploaded_file_path)
+        raise ImageSizeProcessorError, "Not an image" if image_size.format.nil?
+
+        self.width = image_size.width if respond_to?(:width)
+        self.height = image_size.height if respond_to?(:height)
+        self.file_extension = extension_for_image_format(image_size.format) unless self.class.attachment_options[:keep_file_extension]
+        self.content_type = mime_type_for_image_format(image_size.format) unless self.class.attachment_options[:keep_content_type]
+      rescue AttachmentSaverError
+        raise
+      rescue Exception => ex
+        raise ImageSizeProcessorError, "#{ex.class}: #{ex.message}", ex.backtrace
+      end
+
+      def extension_for_image_format(format)
+        case format
+        when :jpeg then 'jpg'
+        else format.to_s
+        end
+      end
+
+      def mime_type_for_image_format(format)
+        "image/#{format}"
+      end
+
+      def with_image(*args)
+        raise NotImplementedError, "the image_size processor can only be used to check image types and dimensions, not produce resized images"
+      end
+    end
+  end
+end

data/samples.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'active_record'
+require 'active_support/inflector'
+require 'attachment_saver'
+require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'image_operations'))
+
+sample_dir = File.expand_path(File.join(File.dirname(__FILE__), 'samples'))
+FileUtils.rm_r(sample_dir)
+FileUtils.mkdir(sample_dir)
+
+original_filenames = %w(test/fixtures/test.jpg test/fixtures/pd.png)
+
+processors = %w(ImageScience RMagick MiniMagick GdkPixbuf).each.with_object({}) do |processor, results|
+  require "processors/#{processor.underscore}"
+
+  instance = Object.new
+  instance.class_eval { attr_accessor :content_type }
+  instance.extend(AttachmentSaver::InstanceMethods)
+  instance.extend(AttachmentSaver::Processors.const_get(processor))
+
+  results[processor] = instance
+end
+
+File.open("samples.html", "w") do |html|
+  html.write "<html><body>"
+
+  original_filenames.each do |original_filename|
+    html.write "<h1>#{original_filename}</h1><table border='2'><tr><th></th>"
+    processors.each do |processor, instance|
+      html.write "<th>#{processor}</th>"
+    end
+    html.write "</tr>"
+
+    ImageOperations.resize_operations.each do |derived_format_name, format_definition|
+      html.write "<tr><th>#{derived_format_name}<br/><pre>#{format_definition.inspect}</pre></th>"
+      processors.each do |processor, instance|
+        instance.with_image(original_filename) do |original_image|
+          result = instance.process_image(original_image, derived_format_name, format_definition)
+
+          filename = "#{sample_dir}/#{processor.underscore}-#{File.basename original_filename}-#{result[:format_name]}.#{result[:file_extension]}"
+          File.open(filename, "wb") do |f|
+            result[:uploaded_data].rewind
+            IO.copy_stream(result[:uploaded_data], f)
+          end
+          size = result[:uploaded_data].size < 1024 ? "#{result[:uploaded_data].size} bytes" : "%0.1fkb" % (result[:uploaded_data].size/1024.0)
+          html.write "<td><img src='#{filename}' width='#{result[:width]}' height='#{result[:height]}'><br/>#{size}</td>"
+        end
+      end
+      html.write "</tr>"
+    end
+
+    html.write "</table>"
+  end
+
+  html.write "</html></body>"
+end

data/test/gdk_pixbuf_processor_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'image_processor_test_common'))
+require 'processors/gdk_pixbuf'
+
+class GdkPixbufProcessorTest < ActiveSupport::TestCase
+  class GdkPixbufTestModel
+    include AttachmentSaver::InstanceMethods
+    include AttachmentSaver::Processors::GdkPixbuf
+    include ImageProcessorTestModel
+  end
+
+  def processor_model
+    GdkPixbufTestModel
+  end
+
+  def processor_exception
+    GdkPixbufProcessorError
+  end
+
+  include ImageProcessorTests
+end

data/test/image_operations.rb

@@ -40,7 +40,8 @@ class ImageOperations
       :scaletocover2 =>   [:scale_to_cover, 720, 900],
       
       :coverandcrop1 =>   [:cover_and_crop, 200, 300],
-      :coverandcrop2 =>   [:cover_and_crop, 720, 900],
+      :coverandcrop2 =>   [:cover_and_crop, 300, 200],
+      :coverandcrop3 =>   [:cover_and_crop, 720, 900],
     }
   end
   
@@ -75,7 +76,8 @@ class ImageOperations
       :scaletocover2 =>   [720, 720*600/448],
       
       :coverandcrop1 =>   [200, 300],
-      :coverandcrop2 =>   [720, 900],
+      :coverandcrop2 =>   [300, 200],
+      :coverandcrop3 =>   [720, 900],
     }
   end
   

data/test/image_size_processor_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'image_processor_test_common'))
+require 'processors/image_size'
+
+class ImageSizeProcessorTest < ActiveSupport::TestCase
+  class ImageSizeTestModel
+    include AttachmentSaver::InstanceMethods
+    include AttachmentSaver::Processors::ImageSize
+    include ImageProcessorTestModel
+  end
+  
+  def processor_model
+    ImageSizeTestModel
+  end
+  
+  def processor_exception
+    ImageSizeProcessorError
+  end
+
+  include ImageProcessorTests
+
+  def processes_images?
+    false
+  end
+end

data/test_all.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+for version in 4.2.10 5.0.6 5.1.4 5.2.0.beta2
+do
+	RAILS_VERSION=$version bundle update activerecord
+	bundle exec rake
+done

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attachment_saver
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gdk_pixbuf2
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -166,25 +180,31 @@ files:
 - lib/misc/extended_tempfile.rb
 - lib/misc/image_science_extensions.rb
 - lib/misc/mini_magick_extensions.rb
+- lib/processors/gdk_pixbuf.rb
 - lib/processors/image.rb
 - lib/processors/image_science.rb
+- lib/processors/image_size.rb
 - lib/processors/mini_magick.rb
 - lib/processors/r_magick.rb
+- samples.rb
 - test/attachment_saver_test.rb
 - test/database.yml
 - test/file_system_datastore_test.rb
 - test/fixtures/broken.jpg
 - test/fixtures/emptyextension.
 - test/fixtures/noextension
+- test/fixtures/pd.png
 - test/fixtures/ssrf.png
 - test/fixtures/test.jpg
 - test/fixtures/test.js
 - test/fixtures/wrongextension.png
+- test/gdk_pixbuf_processor_test.rb
 - test/image_fixtures.rb
 - test/image_operations.rb
 - test/image_processor_test.rb
 - test/image_processor_test_common.rb
 - test/image_science_processor_test.rb
+- test/image_size_processor_test.rb
 - test/in_column_datastore_test.rb
 - test/mini_magick_processor_test.rb
 - test/model_test.rb
@@ -192,6 +212,7 @@ files:
 - test/rmagick_processor_test.rb
 - test/schema.rb
 - test/test_helper.rb
+- test_all.sh
 homepage: http://github.com/willbryant/attachment_saver
 licenses:
 - MIT
@@ -223,15 +244,18 @@ test_files:
 - test/fixtures/broken.jpg
 - test/fixtures/emptyextension.
 - test/fixtures/noextension
+- test/fixtures/pd.png
 - test/fixtures/ssrf.png
 - test/fixtures/test.jpg
 - test/fixtures/test.js
 - test/fixtures/wrongextension.png
+- test/gdk_pixbuf_processor_test.rb
 - test/image_fixtures.rb
 - test/image_operations.rb
 - test/image_processor_test.rb
 - test/image_processor_test_common.rb
 - test/image_science_processor_test.rb
+- test/image_size_processor_test.rb
 - test/in_column_datastore_test.rb
 - test/mini_magick_processor_test.rb
 - test/model_test.rb