neofiles 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d227855f99ea74fc7b13a202cca5d72689fd554c
-  data.tar.gz: 48e527165016fd379303bcca7913cb236b422f4e
+  metadata.gz: aa7c4f908b80a9d8ba5b307b8530d61aca743fe4
+  data.tar.gz: 6777e03478b6e518aa531238d2ef8b4a9922512d
 SHA512:
-  metadata.gz: b3d5d75d416021bb11f6c21cd60f807341198695080929c68fca7cde77a56740393310633850e7aa5972720642d6ba2210534d90be3ad74c11123c76b2d861b1
-  data.tar.gz: 18814fd631099783c7f05f37a9bdab996a3a47b67d540aaef16d736a83123da08cd2cd618e32f6bdfe6146a6faf0bf318fc488c193675c17a8db735e195d792d
+  metadata.gz: 347e357315fcfd834992b69f2e802fdd96602d0e4ce3e57a733d9061dc1bb39958b936546d4fe04119affffee6bc30d9c4b5c86055a6fba555cb09adffe2ff0d
+  data.tar.gz: a38625dcf3f94134b783150b9d626a12d42f94cad746554789812c266ba91f4cba1a7131c829beb9c8fa29f9be0563719d3ad75077073d190e2af1ccb8bc87c2

data/README.md

@@ -76,6 +76,7 @@ Add Neofiles and its dependencies to your gemfile:
 gem 'neofiles'
 gem 'ruby-imagespec', git: 'git://github.com/dim/ruby-imagespec.git'
 gem 'mini_magick', '3.7.0'
+gem 'png_quantizator', '0.2.1'
 ```
 
 ***ruby-imagespec*** is needed to get an image file dimensions & content type.
@@ -83,6 +84,9 @@ gem 'mini_magick', '3.7.0'
 ***mini_magick*** does resizing & watermarking. Actually it is a lightweight wrapper around command-line utility
 ImageMagick, which must be installed also. Refer to the gem's description for installation instructions.
 
+***png_quantizator*** does lossless PNG compression. Actually it is a lightweight wrapper around command-line utility
+Pngquant, which must be installed also. Refer to the gem's description for installation instructions.
+
 Also, you must have installed MongoDB with its default driver ***mongoid*** (5 version at least) and Rails framework
 with HAML templating engine. By default the gem needs `neofiles` mongoid client defined in `config/mongoid.yml`, which
 can be changed in ***Configuration*** section.

data/app/controllers/neofiles/images_controller.rb

@@ -1,3 +1,5 @@
+require 'png_quantizator'
+
 # Special controller for serving images from the database via single action #show.
 #
 class Neofiles::ImagesController < ActionController::Metal
@@ -21,9 +23,10 @@ class Neofiles::ImagesController < ActionController::Metal
   #   format  - resize image to no more than that size, example: '100x200'
   #   crop    - if '1' and params[:format] is present, then cut image sides if its aspect ratio differs from
   #             params[:format] (otherwise image aspect ration will be preserved)
-  #   quality - output JPEG quality, integer from 1 till 100 (forces JPEG output, otherwise image type is preserved)
+  #   quality - output quality, integer from 1 till 100 for JPEG input, default is 75
+  #             for PNG input any value less than 75 triggers lossless compression using pngquant library
   #   nowm    - force returned image to not contain watermark - user must be admin or 403 Forbidden response is returned
-  #             @see #admin_or_die
+  #             @see #admin_or_die (also this removes the default quality to let admins download image originals)
   #
   # Maximum allowed format dimensions are set via Rails.application.config.neofiles.image_max_crop_width/height.
   #
@@ -31,77 +34,41 @@ class Neofiles::ImagesController < ActionController::Metal
   # Rails.application.config.neofiles.watermarker if present.
   #
   def show
-
     # get image
     image_file = Neofiles::Image.find params[:id]
 
     # prepare headers
     data = image_file.data
     options = {
-      filename: CGI::escape(image_file.filename),
-      type: image_file.content_type || 'image/jpeg',
-      disposition: 'inline',
+        filename: CGI::escape(image_file.filename),
+        type: image_file.content_type || 'image/jpeg',
+        disposition: 'inline',
     }
+    quality = [[Neofiles::quality_requested(params), 100].min, 1].max if Neofiles::quality_requested?(params)
+    quality ||= 75 unless nowm?(image_file)
 
-    # is resizing needed?
-    watermark_image, watermark_width, watermark_height = data, image_file.width, image_file.height
-    if params[:format].present?
+    image = MiniMagick::Image.read(data)
 
+    if params[:format].present?
       width, height = params[:format].split('x').map(&:to_i)
-      watermark_width, watermark_height = width, height
       raise Mongoid::Errors::DocumentNotFound unless width.between?(1, CROP_MAX_WIDTH) and height.between?(1, CROP_MAX_HEIGHT)
+    end
 
-      quality = [[Neofiles::quality_requested(params), 100].min, 1].max if Neofiles::quality_requested?(params)
-      setting_quality = quality && options[:type] == 'image/jpeg'
-
-      image = MiniMagick::Image.read(data)
-
-      if Neofiles.crop_requested? params
-        # construct ImageMagick call:
-        # 1) resize to WxH, allow the result to be bigger on one side
-        # 2) allign resized to center
-        # 3) cut the extending parts
-        # 4) set quality if requested
-        image.combine_options do |c|
-          c.resize "#{width}x#{height}^"
-          c.gravity 'center'
-          c.extent "#{width}x#{height}"
-          c.quality "#{quality}" if setting_quality
-        end
-      else
-        # no cropping so just resize to fit in WxH, one side can be smaller than requested
-        if image_file.width > width || image_file.height > height
-          image.combine_options do |c|
-            c.resize "#{width}x#{height}"
-            c.quality "#{quality}" if setting_quality
-          end
-        else
-          setting_quality = false
-          watermark_width, watermark_height = image_file.width, image_file.height
-        end
-      end
-
-      # quality requested, but we didn't have a chance to set it before -> forcibly resave as JPEG
-      if quality && !setting_quality
-        image.format 'jpeg'
-        image.quality quality.to_s
-      end
-
-      # get image bytes and stuff
-      data = image.to_blob
-      watermark_image = image
-      options[:type] = image.mime_type
+    crop_requested = Neofiles.crop_requested? params
+    need_resize_without_crop = width && height && (image_file.width > width || image_file.height > height)
+
+    image.combine_options do |mogrify|
+      resize_image(mogrify, width, height, crop_requested, need_resize_without_crop) if width && height
+      compress_image(mogrify, quality) if quality
     end
 
-    watermark_image = MiniMagick::Image.read watermark_image unless watermark_image.is_a? MiniMagick::Image
+    # use pngquant when quality less than 75
+    ::PngQuantizator::Image.new(image.path).quantize! if options[:type] == 'image/png' && quality && quality < 75
 
     # set watermark
-    data = Rails.application.config.neofiles.watermarker.(
-      watermark_image,
-      no_watermark: nowm?(image_file),
-      watermark_width: watermark_width,
-      watermark_height: watermark_height
-    )
+    width, height = image_file.width, image_file.height if !crop_requested && !need_resize_without_crop
+
+    data = set_watermark(image, image_file, width, height)
 
     # stream image headers & bytes
     send_file_headers! options
@@ -132,4 +99,43 @@ class Neofiles::ImagesController < ActionController::Metal
       raise NotAdminException
     end
   end
-end
+
+  # Fill mogrify command pipe with resize commands
+  def resize_image(mogrify, width, height, crop_requested, need_resize_without_crop)
+    if crop_requested
+      mogrify.resize "#{width}x#{height}^"
+      mogrify.gravity 'center'
+      mogrify.extent "#{width}x#{height}"
+    elsif need_resize_without_crop
+      mogrify.resize "#{width}x#{height}"
+    end
+  end
+
+  # Fill mogrify command pipe with compression commands for JPEG and PNG
+  # More information: https://www.smashingmagazine.com/2015/06/efficient-image-resizing-with-imagemagick/
+  def compress_image(mogrify, quality)
+    mogrify.quality "#{quality}"
+    mogrify << '-unsharp' << '0.25x0.25+8+0.065'
+    mogrify << '-dither' << 'None'
+    mogrify << '-posterize' << '136'
+    mogrify << '-define' << 'jpeg:fancy-upsampling=off'
+    mogrify << '-define' << 'png:compression-filter=5'
+    mogrify << '-define' << 'png:compression-level=9'
+    mogrify << '-define' << 'png:compression-strategy=1'
+    mogrify << '-define' << 'png:exclude-chunk=all'
+    mogrify << '-interlace' << 'none'
+    mogrify << '-colorspace' << 'sRGB'
+    mogrify.strip
+  end
+
+  # Place watermark on the image, if needed
+  def set_watermark(image, image_file, width, height)
+    Rails.application.config.neofiles.watermarker.(
+      image,
+      no_watermark: nowm?(image_file),
+      watermark_width: width,
+      watermark_height: height
+    )
+  end
+
+end

data/lib/neofiles/version.rb

@@ -1,3 +1,3 @@
 module Neofiles
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neofiles
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Konanykhin Ilya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: png_quantizator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: 'Library for managing files: creating & storing, linking to file owners,
   serving files from MongoDB'
 email: