rszr 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6ab5d9447d5919f0bed35e0562f7645bb5a23db
-  data.tar.gz: 88988dc45c31575db6a1cf11618298be6641fca8
+  metadata.gz: 035d5f7341e71cdc9b5ba70de6e116acd8d8459e
+  data.tar.gz: 3119e97a26295db8f3931821d6ae835aaa6166ee
 SHA512:
-  metadata.gz: 4a5d7d5ba83088cce7de9af7a0d68c92d2e2c0f58029617dfa1c270a83aa58af96168b11b2bebdd0c3ad1a930598726acd0809b5b3a7dea901567402bf23ed1b
-  data.tar.gz: 1a53df4fcbd02f524d42cfadcd9dbacdba3945423f5a244af8da190e4cc59de2b87b267de78b0481c4c8d106d27dc16a2ec30f4f728310eced9e9da8a0191f0f
+  metadata.gz: 003305cff18cc4678a13f238e17d709351a36efea86b5ca2de751d15f933211c0d107601f2be6aa70dfc92a30a87615fdf3372dae26552190d21911451d33445
+  data.tar.gz: 732e05777cf4adc9c87515e043a226ed42bd56d0c76e3a28bf645fa22b492fed2cb2a473dbdccd4980b76a23b2d7bf579ec45c68a305a07c77f890697ff82e66

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)
+[![Gem Version](https://badge.fury.io/rb/rszr.svg)](http://badge.fury.io/rb/rszr) [![build](https://github.com/mtgrosser/rszr/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/rszr/actions/workflows/build.yml)
 # 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
 
@@ -13,7 +14,7 @@ gem 'rszr'
 
 ### Imlib2
 
-Rszr requires the Imlib2 library to do the heavy lifting.
+Rszr requires the `Imlib2` library to do the heavy lifting.
 
 #### OS X
 
@@ -27,10 +28,14 @@ brew install imlib2
 
 Using your favourite package manager:
 
+##### RedHat-based
+
 ```bash
 yum install imlib2 imlib2-devel
 ```
 
+##### Debian-based
+
 ```bash
 apt-get install libimlib2 libimlib2-dev
 ```
@@ -45,6 +50,25 @@ image.resize(400, 300)
 # save it
 image.save('resized.jpg')
 
+# save it as PNG
+image.save('resized.png')
+```
+
+### Image info
+```ruby
+image.width => 400
+image.height => 300
+image.dimensions => [400, 300]
+image.format => "jpeg"
+```
+
+### 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)
 
@@ -57,26 +81,119 @@ image.resize(0.5)
 # crop
 image.crop(200, 200, 100, 100)
 
+# rotate three times 90 deg clockwise
+image.turn!(3)
+
+# rotate one time 90 deg counterclockwise
+image.turn!(-1)
+
+# rotate by arbitrary angle
+image.rotate(45)
+
+# flip vertically
+image.flip
+
+# flop horizontally
+image.flop
+
+# initialize copy
+image.dup
+
 # save memory, do not duplicate instance
 image.resize!(400, :auto)
+```
 
-# image dimensions
-image.width => 400
-image.height => 300
-image.dimensions => [400, 300]
+### Filters
+
+Filters also support bang! and non-bang methods.
+
+```ruby
+# sharpen image by pixel radius
+image.sharpen!(1)
+
+# blur image by pixel radius
+image.blur!(1)
+
+# brighten
+image.brighten(0.1)
+
+# darken
+image.brighten(-0.1)
+
+# contrast
+image.contrast(0.5)
+
+# gamma
+image.gamma(1.1)
+```
+
+### Image auto orientation
+
+Auto-rotation is supported for JPEG and TIFF files that include the necessary
+EXIF metadata.
+
+```ruby
+# load and autorotate
+image = Rszr::Image.load('image.jpg', autorotate: true)
+```
+
+To enable autorotation by default:
+
+```ruby
+# auto-rotate by default, for Rails apps put this into an initializer
+Rszr.autorotate = true
+```
+
+## 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]) %>
+```
+
+## Loading from and saving to memory
+
+The `Imlib2` library is mainly file-oriented and doesn't provide a way of loading
+the undecoded image from a memory buffer. Therefore, the functionality is
+implemented on the Ruby side of the gem, writing the memory buffer to a Tempfile.
+Currently, this local write cannot be avoided.
+
+```ruby
+image = Rszr::Image.load_data(binary_data)
+
+data = image.save_data(format: :jpeg)
 ```
 
 ## Thread safety
 
-As of version 0.4.0, Rszr provides thread safety by synchronizing access to imlib2 function calls.
+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/Rakefile

@@ -9,3 +9,9 @@ begin
 rescue LoadError
   # no rspec available
 end
+
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('rszr') do |ext|
+  ext.lib_dir = 'lib/rszr'
+end

data/ext/rszr/errors.c

@@ -0,0 +1,68 @@
+#ifndef RUBY_RSZR_ERRORS
+#define RUBY_RSZR_ERRORS
+
+#include "rszr.h"
+#include "errors.h"
+
+VALUE eRszrError = Qnil;
+VALUE eRszrFileNotFound = Qnil;
+VALUE eRszrTransformationError = Qnil;
+VALUE eRszrErrorWithMessage = Qnil;
+VALUE eRszrLoadError = Qnil;
+VALUE eRszrSaveError = Qnil;
+
+static const char * const sRszrErrorMessages[] =
+{
+  "File does not exist",
+  "File is a directory",
+  "Read permission denied",
+  "Unsupported format",
+  "Path too long",
+  "Non-existant path component",
+  "Path component is not a directory",
+  "Path outside address space",
+  "Too many symbolic links",
+  "Out of memory",
+  "Out of file descriptors",
+  "Write permission denied",
+  "Out of disk space",
+  "Unknown error"
+};
+const int RSZR_MAX_ERROR_INDEX = 13;
+
+void Init_rszr_errors()
+{
+  eRszrError = rb_define_class_under(mRszr, "Error", rb_eStandardError);
+  eRszrFileNotFound = rb_define_class_under(mRszr, "FileNotFound", eRszrError);
+  eRszrTransformationError = rb_define_class_under(mRszr, "TransformationError", eRszrError);
+  eRszrErrorWithMessage = rb_define_class_under(mRszr, "ErrorWithMessage", eRszrError);
+  eRszrLoadError = rb_define_class_under(mRszr, "LoadError", eRszrErrorWithMessage);
+  eRszrSaveError = rb_define_class_under(mRszr, "SaveError", eRszrErrorWithMessage);
+}
+
+static void rszr_raise_error_with_message(VALUE rb_error_class, Imlib_Load_Error error)
+{
+  VALUE rb_error;
+  int error_index;
+  
+  error_index = (int) error - 1;
+  
+  if (error_index < 1 || error_index > RSZR_MAX_ERROR_INDEX)
+    error_index = RSZR_MAX_ERROR_INDEX;
+  
+  rb_error = rb_exc_new2(rb_error_class, sRszrErrorMessages[error_index]);
+  rb_exc_raise(rb_error);
+}
+
+void rszr_raise_load_error(Imlib_Load_Error error)
+{
+  rszr_raise_error_with_message(eRszrLoadError, error);
+}
+
+void rszr_raise_save_error(Imlib_Load_Error error)
+{
+  rszr_raise_error_with_message(eRszrSaveError, error);
+}
+
+
+#endif

data/ext/rszr/errors.h

@@ -0,0 +1,15 @@
+#ifndef RUBY_RSZR_ERRORS_H
+#define RUBY_RSZR_ERRORS_H
+
+void Init_rszr_errors();
+void rszr_raise_load_error(Imlib_Load_Error error);
+void rszr_raise_save_error(Imlib_Load_Error error);
+
+extern VALUE eRszrError;
+extern VALUE eRszrFileNotFound;
+extern VALUE eRszrTransformationError;
+extern VALUE eRszrErrorWithMessage;
+extern VALUE eRszrLoadError;
+extern VALUE eRszrSaveError;
+
+#endif

data/ext/rszr/extconf.rb

@@ -0,0 +1,18 @@
+require 'mkmf'
+require 'rbconfig'
+
+imlib2_config = with_config('imlib2-config', 'imlib2-config')
+
+$CFLAGS << ' -DX_DISPLAY_MISSING ' << `#{imlib2_config} --cflags`.chomp
+$LDFLAGS << ' ' << `#{imlib2_config} --libs`.chomp
+$LDFLAGS.gsub!(/\ -lX11\ -lXext/, '') if RUBY_PLATFORM =~ /darwin/
+
+unless find_header('Imlib2.h')
+  abort 'imlib2 development headers are missing'
+end
+
+unless find_library('Imlib2', 'imlib_set_cache_size')
+  abort 'Imlib2 is missing'
+end
+
+create_makefile 'rszr/rszr'