rszr 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4fc21afb848256445e310a0feebab86b2b10ee6baf464bd7e67a44b282b4d07
-  data.tar.gz: bfe92bbc780dbf03135b4b3d7296df141bee74279412b6bd3b6d2ba70362a140
+  metadata.gz: d7322db19722cd5afc93e887fabe4031fa3a3064949956dc3bac562299918f10
+  data.tar.gz: 8c03c8922f29d3f7989f427018e7baeb6f09c4c9f561fef1b6a92a80f4042ec8
 SHA512:
-  metadata.gz: 26d46f7b4d594da5e871d75975d99cd54358bb6585d8b18fbddcba1b4383970099891f7af6d16b51b8dcf19f5ed179b275d001b15f546c3baa58a3b6573613f9
-  data.tar.gz: 0f5866b917277c7afb518fb15ba83451fc7b448681fec26dad4321d17cfa464854e9182cff88008f7ee25b1c6df135f6a14f3980b64a145db9ef93e035de1d9e
+  metadata.gz: 82b7c3ea10061666bacd712c39319ef36f19b2aecce3fa89556c591c0ef6f2cedf10b0fb1ed4ee6ac8613cfb40904b7e42306cd08d247d2653ca3135450244ba
+  data.tar.gz: 52cac4fe43b0feb24e6fb837fdbed69bb4c91e53807ef5d5821c5ab1793d41a698632e1b342e8b14fed0219db080d05179d37eeb6fcef91e8052b66205c2ab07

data/README.md

@@ -1,7 +1,8 @@
 [![Gem Version](https://badge.fury.io/rb/rszr.svg)](http://badge.fury.io/rb/rszr) [![Build Status](https://travis-ci.org/mtgrosser/rszr.svg)](https://travis-ci.org/mtgrosser/rszr)
 # Rszr - fast image resizer for Ruby
 
-Rszr is an image resizer for Ruby based on the Imlib2 library. It is faster and consumes less memory than MiniMagick, rmagick and GD2.
+Rszr is an image resizer for Ruby based on the Imlib2 library.
+It is faster and consumes less memory than MiniMagick, GD2 and VIPS, and comes with an optional drop-in interface for Rails ActiveStorage image processing.
 
 ## Installation
 
@@ -47,7 +48,15 @@ image.save('resized.jpg')
 
 # save it as PNG
 image.save('resized.png')
+```
+
+### Transformations
+
+For each transformation, there is a bang! and non-bang method.
+The bang method changes the image in place, while the non-bang method
+creates a copy of the image in memory.
 
+```ruby
 # auto height
 image.resize(400, :auto)
 
@@ -66,30 +75,67 @@ image.turn!(3)
 # rotate one time 90 deg counterclockwise
 image.turn!(-1)
 
+# rotate by arbitrary angle
+image.rotate(45)
+
+# sharpen image by pixel radius
+image.sharpen!(1)
+
+# blur image by pixel radius
+image.blur!(1)
+
 # initialize copy
 image.dup
 
 # save memory, do not duplicate instance
 image.resize!(400, :auto)
+```
 
-# image info
+### Image info
+```ruby
 image.width => 400
 image.height => 300
 image.dimensions => [400, 300]
 image.format => "jpeg"
 ```
 
+## Rails / ActiveStorage interface
+
+Rszr provides a drop-in interface to the `image_resizing` gem.
+It is faster than both `mini_magick` and `vips` and way easier to install than the latter.
+
+```ruby
+# Gemfile
+gem 'image_resizing'
+gem 'rszr'
+
+# config/initializers/rszr.rb
+require 'rszr/image_processing'
+
+# config/application.rb
+config.active_storage.variant_processor = :rszr
+```
+
+When creating image variants, you can use all of Rszr's transformation methods:
+
+```erb
+<%= image_tag user.avatar.variant(resize_to_fit: [300, 200]) %>
+```
+
 ## Thread safety
 
-As of version 0.4.0, Rszr is thread safe through the Ruby GIL.
+As of version 0.5.0, Rszr is thread safe through Ruby's global VM lock.
 Use of any previous versions in a threaded environment is discouraged.
 
 ## Speed
 
-Resizing an 1500x997 JPEG image to 800x532, 100 times:
+Resizing a 1500x997 JPEG image to 800x532, 500 times:
+![Speed](https://github.com/mtgrosser/rszr/blob/master/benchmark/speed.png)
+
 
 Library         | Time
 ----------------|-----------
-MiniMagick      | 12.9 s
-GD2             | 7.5 s
-Rszr            | 2.8 s
+MiniMagick      | 27.0 s
+GD2             | 28.2 s
+VIPS            | 13.6 s
+Rszr            |  7.9 s

data/ext/rszr/image.c

@@ -75,7 +75,7 @@ static VALUE rszr_image_s__load(VALUE klass, VALUE rb_path)
 }
 
 
-static VALUE rszr_image_format(VALUE self)
+static VALUE rszr_image_format_get(VALUE self)
 {
   rszr_image_handle * handle;
   char * format;
@@ -93,6 +93,20 @@ static VALUE rszr_image_format(VALUE self)
 }
 
 
+static VALUE rszr_image__format_set(VALUE self, VALUE rb_format)
+{
+  rszr_image_handle * handle;
+  char * format = StringValueCStr(rb_format);
+  
+  Data_Get_Struct(self, rszr_image_handle, handle);
+  
+  imlib_context_set_image(handle->image);
+  imlib_image_set_format(format);
+  
+  return self;
+}
+
+
 static VALUE rszr_image_width(VALUE self)
 {
   rszr_image_handle * handle;
@@ -120,6 +134,44 @@ static VALUE rszr_image_height(VALUE self)
   return INT2NUM(height);
 }
 
+/*
+static VALUE rszr_image_get_quality(VALUE self)
+{
+  rszr_image_handle * handle;
+  int quality;
+  
+  Data_Get_Struct(self, rszr_image_handle, handle);
+  
+  imlib_context_set_image(handle->image);
+  quality = imlib_image_get_attached_value("quality");
+  
+  if (quality) {
+    return INT2NUM(quality);
+  } else {
+    return Qnil;
+  }
+}
+
+static VALUE rszr_image_set_quality(VALUE self, VALUE rb_quality)
+{
+  rszr_image_handle * handle;
+  int quality;
+  
+  Check_Type(rb_quality, T_FIXNUM);
+  quality = FIX2INT(rb_quality);
+  if (quality <= 0) {
+    rb_raise(rb_eArgError, "quality must be >= 0");
+    return Qnil;
+  }
+  
+  Data_Get_Struct(self, rszr_image_handle, handle);
+  
+  imlib_context_set_image(handle->image);
+  imlib_image_attach_data_value("quality", NULL, quality, NULL);
+  
+  return INT2NUM(quality);
+}
+*/
 
 static VALUE rszr_image_dup(VALUE self)
 {
@@ -159,6 +211,77 @@ static VALUE rszr_image__turn_bang(VALUE self, VALUE orientation)
 }
 
 
+static VALUE rszr_image__rotate(VALUE self, VALUE bang, VALUE rb_angle)
+{
+  rszr_image_handle * handle;
+  rszr_image_handle * rotated_handle;
+  Imlib_Image rotated_image;
+  VALUE oRotatedImage;
+  double angle;
+  
+  angle = NUM2DBL(rb_angle);
+  
+  Data_Get_Struct(self, rszr_image_handle, handle);
+  
+  imlib_context_set_image(handle->image);
+  rotated_image = imlib_create_rotated_image(angle);
+  
+  if (!rotated_image) {
+    rb_raise(eRszrTransformationError, "error rotating image");
+    return Qnil;
+  }
+  
+  if (RTEST(bang)) {
+    rszr_free_image(handle->image);
+    handle->image = rotated_image;
+    
+    return self;
+  }
+  else {
+    oRotatedImage = rszr_image_s_allocate(cImage);
+    Data_Get_Struct(oRotatedImage, rszr_image_handle, rotated_handle);
+    rotated_handle->image = rotated_image;
+  
+    return oRotatedImage;
+  }
+}
+
+/*
+static VALUE rszr_image__brighten_bang(VALUE self, VALUE rb_brightness)
+{
+  rszr_image_handle * handle;
+  double brightness;
+  
+  brightness = NUM2DBL(rb_brightness);
+  
+  imlib_context_set_image(handle->image);
+  imlib_modify_color_modifier_brightness(brightness);
+  
+  return self;
+}
+*/
+
+static VALUE rszr_image__sharpen_bang(VALUE self, VALUE rb_radius)
+{
+  rszr_image_handle * handle;
+  int radius;
+  
+  radius = NUM2INT(rb_radius);
+  
+  Data_Get_Struct(self, rszr_image_handle, handle);
+  
+  imlib_context_set_image(handle->image);
+  
+  if (radius >= 0) {
+    imlib_image_sharpen(radius);
+  } else {
+    imlib_image_blur(radius);
+  }
+  
+  return self;
+}
+
+
 static Imlib_Image rszr_create_cropped_scaled_image(const Imlib_Image image, VALUE rb_src_x, VALUE rb_src_y, VALUE rb_src_w, VALUE rb_src_h, VALUE rb_dst_w, VALUE rb_dst_h)
 {
   Imlib_Image resized_image;
@@ -262,20 +385,24 @@ static VALUE rszr_image__crop(VALUE self, VALUE bang, VALUE rb_x, VALUE rb_y, VA
 }
 
 
-static VALUE rszr_image__save(VALUE self, VALUE rb_path, VALUE rb_format)
+static VALUE rszr_image__save(VALUE self, VALUE rb_path, VALUE rb_format, VALUE rb_quality)
 {
   rszr_image_handle * handle;
   char * path;
   char * format;
+  int quality;
   Imlib_Load_Error save_error;
   
   path = StringValueCStr(rb_path);
   format = StringValueCStr(rb_format);
-  
+  quality = (NIL_P(rb_quality)) ? 0 : FIX2INT(rb_quality);
+
   Data_Get_Struct(self, rszr_image_handle, handle);
   
   imlib_context_set_image(handle->image);
   imlib_image_set_format(format);
+  if (quality)
+    imlib_image_attach_data_value("quality", NULL, quality, NULL);
   imlib_save_image_with_error_return(path, &save_error);
   
   if (save_error) {
@@ -298,12 +425,21 @@ void Init_rszr_image()
   rb_define_method(cImage, "initialize",  rszr_image_initialize, 2);
   rb_define_method(cImage, "width",       rszr_image_width, 0);
   rb_define_method(cImage, "height",      rszr_image_height, 0);
-  rb_define_method(cImage, "format",      rszr_image_format, 0);
+  rb_define_method(cImage, "format",      rszr_image_format_get, 0);
   rb_define_method(cImage, "dup",         rszr_image_dup, 0);
+  // rb_define_method(cImage, "quality",     rszr_image_get_quality, 0);
+  // rb_define_method(cImage, "quality=",    rszr_image_set_quality, 1);
+  
+  rb_define_protected_method(cImage, "_format=", rszr_image__format_set, 1);
+  
   rb_define_private_method(cImage, "_resize",  rszr_image__resize, 7);
   rb_define_private_method(cImage, "_crop",    rszr_image__crop, 5);
   rb_define_private_method(cImage, "_turn!",   rszr_image__turn_bang, 1);
-  rb_define_private_method(cImage, "_save",    rszr_image__save, 2);
+  rb_define_private_method(cImage, "_rotate",  rszr_image__rotate, 2);
+  rb_define_private_method(cImage, "_sharpen!",   rszr_image__sharpen_bang, 1);
+  /* rb_define_private_method(cImage, "_brighten!",  rszr_image__brighten_bang, 1); */
+  
+  rb_define_private_method(cImage, "_save",       rszr_image__save, 3);
 }
 
 #endif

data/lib/rszr/image.rb

@@ -3,7 +3,7 @@ module Rszr
 
     class << self
       
-      def load(path, options = {})
+      def load(path, **opts)
         path = path.to_s
         raise FileNotFound unless File.exist?(path)
         _load(path)
@@ -15,6 +15,11 @@ module Rszr
     def dimensions
       [width, height]
     end
+    
+    def format=(fmt)
+      fmt = fmt.to_s if fmt.is_a?(Symbol)
+      self._format = fmt
+    end
 
     def inspect
       fmt = format
@@ -22,30 +27,72 @@ module Rszr
       "#<#{self.class.name}:0x#{object_id.to_s(16)} #{width}x#{height}#{fmt}>"
     end
 
-    def resize(*args)
-      _resize(false, *calculate_size(*args))
-    end
+    module Transformations
+      def resize(*args)
+        _resize(false, *calculate_size(*args))
+      end
 
-    def resize!(*args)
-      _resize(true, *calculate_size(*args))
-    end
+      def resize!(*args)
+        _resize(true, *calculate_size(*args))
+      end
 
-    def crop(x, y, width, height)
-      _crop(false, x, y, width, height)
-    end
+      def crop(x, y, width, height)
+        _crop(false, x, y, width, height)
+      end
 
-    def crop!(x, y, width, height)
-      _crop(true, x, y, width, height)
-    end
+      def crop!(x, y, width, height)
+        _crop(true, x, y, width, height)
+      end
+    
+      def turn(orientation)
+        dup.turn!(orientation)
+      end
 
-    def turn!(orientation)
-      orientation = orientation.abs + 2 if orientation.negative?
-      _turn!(orientation % 4)
+      def turn!(orientation)
+        orientation = orientation.abs + 2 if orientation.negative?
+        _turn!(orientation % 4)
+      end
+    
+      def rotate(deg)
+        _rotate(false, deg.to_f * Math::PI / 180.0)
+      end
+    
+      def rotate!(deg)
+        _rotate(true, deg.to_f * Math::PI / 180.0)
+      end
+    
+      def sharpen(radius)
+        dup.sharpen!(radius)
+      end
+    
+      def sharpen!(radius)
+        raise ArgumentError, 'illegal radius' if radius < 0
+        _sharpen!(radius)
+      end
+    
+      def blur(radius)
+        dup.blur!(radius)
+      end
+    
+      def blur!(radius)
+        raise ArgumentError, 'illegal radius' if radius < 0
+        _sharpen!(-radius)
+      end
+      
+      # TODO
+      #def brighten!(brightness)
+      #  raise ArgumentError, 'illegal brightness' if brightness > 1 || brightness < -1
+      #  _brighten!(brightness)
+      #end
     end
+    
+    include Transformations
 
-    def save(path, format = nil)
-      format ||= format_from_filename(path) || 'jpg'
-      _save(path.to_s, format.to_s)
+    def save(path, format: nil, quality: nil)
+      format ||= format_from_filename(path) || self.format || 'jpg'
+      raise ArgumentError, "invalid quality #{quality.inspect}" if quality && !(0..100).cover?(quality)
+      ensure_path_is_writable(path)
+      _save(path.to_s, format.to_s, quality)
     end
 
     private
@@ -56,7 +103,7 @@ module Rszr
     # :auto, 300        auto width, fit height
     # 400, 300, crop: :center_middle
     # 400, 300, background: rgba
-    # 400, 300, aspect: false
+    # 400, 300, skew: true
     
     def calculate_size(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
@@ -104,6 +151,15 @@ module Rszr
     def format_from_filename(path)
       File.extname(path)[1..-1]
     end
+    
+    def ensure_path_is_writable(path)
+      path = Pathname.new(path)
+      path.dirname.realpath.writable?
+    rescue Errno::ENOENT => e
+      raise SaveError, 'Non-existant path component'
+    rescue SystemCallError => e
+      raise SaveError, e.message
+    end
 
     def assert_valid_keys(hsh, *valid_keys)
       if unknown_key = (hsh.keys - valid_keys).first

data/lib/rszr/image_processing.rb

@@ -0,0 +1,82 @@
+require 'rszr'
+require 'image_processing'
+
+module ImageProcessing
+  module Rszr
+    extend Chainable
+
+    class << self
+      
+      # Returns whether the given image file is processable.
+      def valid_image?(file)
+        ::Rszr::Image.load(file).width
+        true
+      rescue ::Rszr::Error
+        false
+      end
+      
+    end
+
+    class Processor < ImageProcessing::Processor
+      accumulator :image, ::Rszr::Image
+
+      class << self
+
+        # Loads the image on disk into a Rszr::Image object
+        def load_image(path_or_image, **options)
+          if path_or_image.is_a?(::Rszr::Image)
+            path_or_image
+          else
+            ::Rszr::Image.load(path_or_image)
+          end
+          # TODO: image = image.autorot if autorot && !options.key?(:autorotate)
+        end
+
+        # Writes the image object to disk. 
+        # Accepts additional options (quality, format).
+        def save_image(image, destination_path, **options)
+          image.save(destination_path, **options)
+        end
+
+        # Calls the operation to perform the processing. If the operation is
+        # defined on the processor (macro), calls it. Otherwise calls the
+        # bang variant of the method directly on the Rszr image object.
+        def apply_operation(accumulator, (name, args, block))
+          return super if method_defined?(name)
+          accumulator.send("#{name}!", *args, &block)
+        end
+
+      end
+
+      # Resizes the image to not be larger than the specified dimensions.
+      def resize_to_limit(width, height, **options)
+        width, height = default_dimensions(width, height)
+        thumbnail(width, height, **options)
+      end
+
+      # Resizes the image to fit within the specified dimensions.
+      def resize_to_fit(width, height, **options)
+        width, height = default_dimensions(width, height)
+        thumbnail(width, height, **options)
+      end
+
+      # Resizes the image to fill the specified dimensions, applying any
+      # necessary cropping.
+      def resize_to_fill(width, height, **options)
+        thumbnail(width, height, crop: :center, **options)
+      end
+
+      private
+
+      def thumbnail(width, height, **options)
+        image.resize!(width, height, **options)
+      end
+
+      def default_dimensions(width, height)
+        raise Error, 'either width or height must be specified' unless width || height
+        [width || :auto, height || :auto]
+      end
+
+    end
+  end
+end

data/lib/rszr/version.rb

@@ -1,3 +1,3 @@
 module Rszr
-  VERSION = "0.5.2"
+  VERSION = '0.5.3'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rszr
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Matthias Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  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: gd2-ffij
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  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: memory_profiler
   requirement: !ruby/object:Gem::Requirement
@@ -156,12 +198,13 @@ files:
 - ext/rszr/rszr.h
 - lib/rszr.rb
 - lib/rszr/image.rb
+- lib/rszr/image_processing.rb
 - lib/rszr/version.rb
 homepage: https://github.com/mtgrosser/rszr
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,9 +219,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+requirements:
+- Imlib2
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Fast image resizer
 test_files: []