rszr 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 430e9433e3e7d2564aa86a124e41b5285ffabf66
-  data.tar.gz: 4477e613b5b98f39f1635cd669d1780e66391f64
+  metadata.gz: f6ab5d9447d5919f0bed35e0562f7645bb5a23db
+  data.tar.gz: 88988dc45c31575db6a1cf11618298be6641fca8
 SHA512:
-  metadata.gz: 9ff2d67706cc334f496af3b522f9071809d774aaac4883bd6a948f27b1f0dc44d11b63c42834d9f2885d27a2d83f1c639e7a372da281b2b98482aee7c87360da
-  data.tar.gz: 3fdf4147d6a4bcb6c99e6feefc017bdcca3b63e1b4b0dc28e90661acdc2d6e9f955669f85426ba590087195cc35332f14d4f67f73be052909ae66281885b55c0
+  metadata.gz: 4a5d7d5ba83088cce7de9af7a0d68c92d2e2c0f58029617dfa1c270a83aa58af96168b11b2bebdd0c3ad1a930598726acd0809b5b3a7dea901567402bf23ed1b
+  data.tar.gz: 1a53df4fcbd02f524d42cfadcd9dbacdba3945423f5a244af8da190e4cc59de2b87b267de78b0481c4c8d106d27dc16a2ec30f4f728310eced9e9da8a0191f0f

data/README.md

@@ -1,7 +1,7 @@
 [![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
+# Rszr - fast image resizer for Ruby
 
-Rszr is a fast image resizer.
+Rszr is an image resizer for Ruby based on the Imlib2 library. It is faster and consumes less memory than MiniMagick, rmagick and GD2.
 
 ## Installation
 
@@ -23,7 +23,7 @@ Using homebrew:
 brew install imlib2
 ```
 
-### Linux
+#### Linux
 
 Using your favourite package manager:
 
@@ -66,12 +66,17 @@ image.height => 300
 image.dimensions => [400, 300]
 ```
 
+## Thread safety
+
+As of version 0.4.0, Rszr provides thread safety by synchronizing access to imlib2 function calls.
+Use of any previous versions in a threaded environment is discouraged.
+
 ## Speed
 
 Resizing an 1500x997 JPEG image to 800x532, 100 times:
 
 Library         | Time
 ----------------|-----------
-MiniMagick      | 11.4 s
-GD2             | 7.2 s
-Rszr            | 3.2 s
+MiniMagick      | 12.9 s
+GD2             | 7.5 s
+Rszr            | 2.8 s

data/lib/rszr.rb

@@ -6,6 +6,7 @@ require 'pathname'
 require 'rszr/version'
 require 'rszr/errors'
 require 'rszr/lib'
+require 'rszr/lock'
 require 'rszr/handle'
 require 'rszr/base'
 require 'rszr/image'

data/lib/rszr/base.rb

@@ -4,6 +4,8 @@ module Rszr
     def self.included(base)
       Rszr::Lib.delegate(base)
       Rszr::Lib.delegate(base.singleton_class)
+      base.include(Lock)
+      base.extend(Lock)
     end
     
     protected

data/lib/rszr/image.rb

@@ -8,7 +8,7 @@ module Rszr
       protected :instantiate
       
       def new(width, height)
-        ptr = imlib_create_image(width, height)
+        ptr = with_lock { imlib_create_image(width, height) }
         raise Error, 'Could not instantiate image' if ptr.null?
         instantiate(ptr)
       end
@@ -17,8 +17,10 @@ module Rszr
         path = path.to_s
         raise FileNotFound unless File.exist?(path)
         load_error = LoadError.new
-        imlib_set_cache_size(0)
-        ptr = imlib_load_image_with_error_return(path, load_error.ptr)
+        ptr = with_lock do
+          imlib_set_cache_size(0)
+          imlib_load_image_with_error_return(path, load_error.ptr)
+        end
         raise load_error, load_error.message if ptr.null?
         return instantiate(ptr)
       end
@@ -27,8 +29,10 @@ module Rszr
       protected
       
       def finalize(ptr)
-        imlib_context_set_image(ptr)
-        imlib_free_image
+        with_lock do
+          imlib_context_set_image(ptr)
+          imlib_free_image
+        end
       end
       
     end
@@ -38,13 +42,11 @@ module Rszr
     end
     
     def width
-      context_set_image
-      imlib_image_get_width
+      with_image { imlib_image_get_width }
     end
     
     def height
-      context_set_image
-      imlib_image_get_height
+      with_image { imlib_image_get_height }
     end
     
     def dimensions
@@ -52,8 +54,7 @@ module Rszr
     end
     
     def format
-      context_set_image
-      str_ptr = imlib_image_format
+      str_ptr = with_image { imlib_image_format }
       return if str_ptr.null?
       str_ptr.to_s
     end
@@ -77,13 +78,14 @@ module Rszr
     end
     
     def save(path, format = nil)
-      context_set_image
-      format ||= format_from_filename(path) || 'jpg'
-      imlib_image_set_format(format)
-      save_error = SaveError.new
-      imlib_save_image_with_error_return(path, save_error.ptr)
-      raise save_error, save_error.message if save_error.error?
-      true
+      with_image do
+        format ||= format_from_filename(path) || 'jpg'
+        imlib_image_set_format(format)
+        save_error = SaveError.new
+        imlib_save_image_with_error_return(path, save_error.ptr)
+        raise save_error, save_error.message if save_error.error?
+        true
+      end
     end
     
     def inspect
@@ -103,35 +105,35 @@ module Rszr
     def create_resized_image(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       assert_valid_keys options, :crop, :background, :skew  #:extend, :width, :height, :max_width, :max_height, :box
-      context_set_image
+      original_width, original_height = width, height
       x, y, = 0, 0
       if args.size == 1
         scale = args.first
         raise ArgumentError, "scale #{scale.inspect} out of range" unless scale > 0 && scale < 1
-        new_width = width.to_f * scale
-        new_height = height.to_f * scale
+        new_width = original_width.to_f * scale
+        new_height = original_height.to_f * scale
       elsif args.size == 2
         box_width, box_height = args
         if :auto == box_width && box_height.is_a?(Numeric)
           new_height = box_height
-          new_width = box_height.to_f / height.to_f * width.to_f
+          new_width = box_height.to_f / original_height.to_f * original_width.to_f
         elsif box_width.is_a?(Numeric) && :auto == box_height
           new_width = box_width
-          new_height = box_width.to_f / width.to_f * height.to_f
+          new_height = box_width.to_f / original_width.to_f * original_height.to_f
         elsif box_width.is_a?(Numeric) && box_height.is_a?(Numeric)
           if options[:skew]
             new_width, new_height = box_width, box_height
           elsif options[:crop]
             # TODO: calculate x, y offset if crop
           else
-            scale = width.to_f / height.to_f
+            scale = original_width.to_f / original_height.to_f
             box_scale = box_width.to_f / box_height.to_f
             if scale >= box_scale # wider
               new_width = box_width
-              new_height = height.to_f * box_width.to_f / width.to_f
+              new_height = original_height.to_f * box_width.to_f / original_width.to_f
             else # narrower
               new_height = box_height
-              new_width = width.to_f * box_height.to_f / height.to_f
+              new_width = original_width.to_f * box_height.to_f / original_height.to_f
             end
           end
         else
@@ -140,29 +142,16 @@ module Rszr
       else
         raise ArgumentError, "wrong number of arguments (#{args.size} for 1..2)"
       end
-      
-      #new_width = options[:width] || imlib_image_get_width
-      #new_height = options[:height] || imlib_image_get_height
-      #if max_width = options[:max_width] and new_width > max_width
-      #  scale  = max_width.to_f / new_width.to_f
-      #  width  = max_width
-      #  new_height = (scale * new_height).to_i
-      #end
-      #if max_height = options[:max_height] and new_height > max_height
-      #  scale  = max_height.to_f / new_height.to_f
-      #  new_height = max_height
-      #  new_width  = (scale * new_width).to_i
-      #end
-      
-      imlib_context_set_anti_alias(1)
-      resized_ptr = imlib_create_cropped_scaled_image(x, y, imlib_image_get_width, imlib_image_get_height, new_width.round, new_height.round)
+      resized_ptr = with_image do
+        imlib_context_set_anti_alias(1)
+        imlib_create_cropped_scaled_image(x, y, imlib_image_get_width, imlib_image_get_height, new_width.round, new_height.round)
+      end
       raise TransformationError, "error resizing image" if resized_ptr.null?
       resized_ptr
     end
     
     def create_cropped_image(x, y, width, height)
-      context_set_image
-      cropped_ptr = imlib_create_cropped_image(x, y, width, height)
+      cropped_ptr = with_image { imlib_create_cropped_image(x, y, width, height) }
       raise TransformationError, 'error cropping image' if cropped_ptr.null?
       cropped_ptr
     end
@@ -175,6 +164,13 @@ module Rszr
       imlib_context_set_image(ptr)
     end
     
+    def with_image
+      with_lock do
+        context_set_image
+        yield
+      end
+    end
+    
     def instantiate(ptr)
       self.class.send(:instantiate, ptr)
     end

data/lib/rszr/lock.rb

@@ -0,0 +1,23 @@
+module Rszr
+  @mutex = Mutex.new
+  
+  class << self
+    
+    def with_lock(&block) # :nodoc:
+      mutex.synchronize(&block)
+    end
+    
+    private
+    
+    def mutex
+      @mutex
+    end
+  end
+  
+  module Lock # :nodoc:
+    def with_lock(&block)
+      Rszr.with_lock(&block)
+    end
+  end
+  
+end

data/lib/rszr/version.rb

@@ -1,3 +1,3 @@
 module Rszr
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rszr
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,7 @@ files:
 - lib/rszr/handle.rb
 - lib/rszr/image.rb
 - lib/rszr/lib.rb
+- lib/rszr/lock.rb
 - lib/rszr/version.rb
 homepage: https://github.com/mtgrosser/rszr
 licenses:
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Fast image resizer