ruby-vips 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4678e6b9ab0569b528f25f1ad9eaaa01c40d9142
-  data.tar.gz: 5e7cfa1695d8cc2e75bbb944c0c6b71bcf030d64
+  metadata.gz: bc07fdb1e2def0cb74571c3662c1a7cc568505c8
+  data.tar.gz: 2302be93ac930c25b90eacade712c8fbe685abeb
 SHA512:
-  metadata.gz: f93eaaa519c4b6e5c1089d4e2a22c5901cd3bd5f818ee72f8c064633dbe772939381e78482db1d8521faea53bb70624274d29e8c47c76a6637cfaaf9c0d7549b
-  data.tar.gz: abccdf5bd42c8e8a2b3bf3bfdac36805d461edc1d38d84ceb6805e754f2f25b1cc76f6004785169468478de697c75706c8ebcb5af4a020514043fb8b4b90d664
+  metadata.gz: 59b7246675bb70923a0df56fe3ea1a2f5d9de71040377c74851d911e982555961bd3fc280f290f5714666479726e766b8c63c30a58b0c3146280ffe972ef266b
+  data.tar.gz: f325a99c620ca792ff0380292312020edbfc7faf5e6f7ee6436646fc6fe89d2acf7e2fbd3ef7c624bcc08c0ed6d6ada149d894ba2a15662fb02e8ef08197a45a

data/CHANGELOG.md

@@ -1,20 +1,28 @@
-# master 
+# Changelog
 
-# Version 2.0.1
+## master
 
-* add support for VipsRefStr in gvalue, thanks tomasc
+## Version 2.0.2 (2017-08-26)
 
-# Version 2.0.0
+* switch to `logger` for all logging output
+* add libvips cache control functions `Vips::cache_set_max()` etc.
+* fix a ref leak
+
+## Version 2.0.1 (2017-08-23)
+
+* add support for `VipsRefStr` in gvalue, thanks tomasc
+
+## Version 2.0.0 (2017-08-22)
 
 * rewrite on top of 'ffi' [John Cupitt, Kleis Auke Wolthuizen]
 
-# Version 1.0.6
+## Version 1.0.6 (2017-07-17)
 
 * remove lazy load, fixing a race with multi-threading [felixbuenemann]
 * make `Image#to_a` much faster [John Cupitt]
 * remove the `at_exit` handler [John Cupitt]
 
-# Version 1.0.5
+## Version 1.0.5 (2017-04-29)
 
 * fix `_const` for libvips 8.5 [John Cupitt]
 * add `scaleimage`, the scale operation renamed to avoid a clash with the
@@ -24,7 +32,7 @@
 * update generated docs for libvips 8.5 [John Cupitt]
 * added docs for new libvips 8.5 enums [John Cupitt]
 
-# Version 1.0.4
+## Version 1.0.4 (2017-02-07)
 
 * remove stray comma from some docs lines [John Cupitt]
 * update generated docs for libvips 8.5 [John Cupitt]
@@ -32,52 +40,52 @@
 * update for gobject-introspection 3.1 [John Cupitt]
 * support ruby 2.4 [John Cupitt]
 
-# Version 1.0.3
+## Version 1.0.3 (2016-08-18)
 
 * doc improvements [John Cupitt]
-* add #size to get [width, height] [John Cupitt]
-* only ask for ruby 2.0 to help OS X [John Cupitt] 
-* break up Image.call to make it easier to understand [John Cupitt] 
+* add `Image#size` to get `[width, height]` [John Cupitt]
+* only ask for ruby 2.0 to help OS X [John Cupitt]
+* break up `Image.call` to make it easier to understand [John Cupitt]
 * detect operation build fail correctly [John Cupitt]
 * lock gobject-introspection at 3.0.8 to avoid breakage [John Cupitt]
 
-# Version 1.0.2
+## Version 1.0.2 (2016-07-07)
 
-* add .yardopts to fix ruby-gems docs [John Cupitt]
+* add `.yardopts` to fix ruby-gems docs [John Cupitt]
 
-# Version 1.0.1
+## Version 1.0.1 (2016-07-07)
 
 * simplify gemspec [sandstrom]
 * remove jeweler dependency [John Cupitt]
 * add `.to_a` to Image [John Cupitt]
 
-# Version 1.0.0
+## Version 1.0.0 (2016-06-07)
 
 * complete rewrite, API break [John Cupitt]
 
-# Version 0.3.14
+## Version 0.3.14 (2016-01-25)
 
 * more GC tuning [felixbuenemann]
 * add `write.rb` example program [felixbuenemann]
 
-# Version 0.3.13
+## Version 0.3.13 (2016-01-18)
 
 * don't use generational GC options on old Rubys [John Cupitt]
 
-# Version 0.3.12
+## Version 0.3.12 (2016-01-17)
 
 * incremental GC every 10 writes [felixbuenemann]
 * updated bundle [John Cupitt]
 
-# Version 0.3.11
+## Version 0.3.11 (2015-10-15)
 
 * added magick load from buffer [John Cupitt]
 
-# Version 0.3.10
+## Version 0.3.10 (2015-06-24)
 
 * added webp write [John Cupitt]
 
-# Version 0.3.9
+## Version 0.3.9 (2014-07-17)
 
 * removed a stray file from gemspec [Alessandro Tagliapietra]
 * updated bundle [John Cupitt]
@@ -89,16 +97,16 @@
 * add .size, see issue #58 [John Cupitt]
 * add rdoc-data dep, maybe it will help ruby-gems docs [John Cupitt]
 
-# Version 0.3.8
+## Version 0.3.8 (2014-05-11)
 
 * add VIPS::thread_shutdown(), must be called on foreign thread exit [John Cupitt]
 
-# Version 0.3.7
+## Version 0.3.7 (2014-02-04)
 
 * update build dependencies [John Cupitt]
 * README updated [John Cupitt]
 
-# Version 0.3.6
+## Version 0.3.6 (2013-06-25)
 
 * add png and jpg load from memory buffer [John Cupitt]
 * README updated to include buffer read/write example [John Cupitt]
@@ -107,30 +115,30 @@
 * fix rdoc build to include C sources [John Cupitt]
 * better compat with older libvips [John Cupitt]
 
-# Version 0.3.5
+## Version 0.3.5 (2013-01-15)
 
 * rb_raise() in mask.c no longer passes a string pointer as the fmt arg, stopping gcc bailing out on some platforms [John Cupitt]
 * Image.magick() now calls im_magick2vips() directly rather than relying on libvips file type sniffing [John Cupitt]
 
-# Version 0.3.4
+## Version 0.3.4 (2012-09-11)
 
 * Update specs for lcms changes, thanks Stanislaw [John Cupitt]
 * VIPS::Reader supports .exif() / .exif?() methods for better back compat, thanks Jeremy [John Cupitt]
 * VIPS::Reader fallbacks load the image if its not been loaded [John Cupitt]
 * VIPS::Reader no longer allows VIPS::Header methods [John Cupitt]
 
-# Version 0.3.3
+## Version 0.3.3 (2012-08-31)
 
 * Typo in workaround in 0.3.2 [John Cupitt]
 
-# Version 0.3.2
+## Version 0.3.2 (2012-08-31)
 
 ### Fixed
 
 * Workaround helps ruby-vips compile (and run) against 7.26.3 [John Cupitt and 
 James Harrison]
 
-# Version 0.3.1
+## Version 0.3.1 (2012-08-30)
 
 ### Fixed
 
@@ -139,9 +147,7 @@ James Harrison]
 * Image read now runs GC and retries on fail [John Cupitt]
 * Image write GCs every 100 images [John Cupitt]
 
-# Version 0.3.0
-
-Release date: 2012-07-20
+## Version 0.3.0 (2012-07-20)
 
 ### Added
 
@@ -161,9 +167,7 @@ Release date: 2012-07-20
 * Now passes rspec test suite cleanly in valgrind [John Cupitt]
 * Fixed check of sequential mode support [Stanislaw Pankevich]
 
-# Version 0.2.0
-
-Release date: 2012-06-29
+## Version 0.2.0 (2012-06-29)
 
 ### Added
 
@@ -183,9 +187,7 @@ Release date: 2012-06-29
 
 * #8: Memory allocation-free issues [Grigoriy Chudnov]
 
-# Version 0.1.1
-
-Release date: 2012-06-22
+## Version 0.1.1 (2012-06-22)
 
 ### Changed
 
@@ -197,6 +199,6 @@ Release date: 2012-06-22
 * Added Gemfile with the only 'rspec' dependency. [Stanislaw Pankevich]
 * Added Jeweler Rakefile contents to release ruby-vips as a gem. [Stanislaw Pankevich]
 
-# Before (initial unreleased version 0.1.0)
+## Before (initial unreleased version 0.1.0)
 
 Long-long history here undocumented...

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.2

data/example/example1.rb

@@ -1,84 +1,12 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
+require 'logger'
 require 'vips'
-$vips_debug = true
 
-puts ""
-puts "starting up:"
+GLib::logger.level = Logger::DEBUG
 
-# this makes vips keep a list of all active objects which we can print out
-Vips::leak_set true
-
-# disable the operation cache
-Vips::cache_set_max 0
-
-puts ""
-puts "creating object:"
-x = Vips::Image.new
-Vips::Object::print_all
-
-puts ""
-puts "freeing object:"
-x = nil
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "creating operation:"
 op = Vips::Operation.new "black"
-Vips::Object::print_all
-op.set_property "width", 200
-op.set_property "height", 300
 
-puts ""
-puts "after operation init:"
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "operation lookup:"
-op2 = Vips::cache_operation_lookup op
-if op2
-    puts "cache hit"
-    op = op2
-    op2 = nil
-else
-    puts "cache miss ... building"
-    if not op.build
-        puts "*** build error"
-    end
-    Vips::cache_operation_add op
-end
-
-puts ""
-puts "after build:"
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "fetching output:"
-im = op.get_property "out"
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "fetching output again:"
-im2 = op.get_property "out"
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "freeing operation:"
-op.unref_outputs
 op = nil
-op2 = nil
-GC.start
-Vips::Object::print_all
-
-puts ""
-puts "shutting down:"
-im = nil
-im2 = nil
-GC.start
-Vips::shutdown
 GC.start
+Vips::Operation.print_all

data/example/example2.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby
 
+require 'logger'
 require 'vips'
 
 puts ""
@@ -11,12 +12,14 @@ Vips::leak_set true
 # disable the operation cache
 Vips::cache_set_max 0
 
-n = 100
+# GLib::logger.level = Logger::DEBUG
+
+n = 10000
 
 n.times do |i|
     puts ""
     puts "call #{i} ..."
-    out = Vips::call "black", 200, 300
+    out = Vips::Operation.call "black", [200, 300]
     if out.width != 200 or out.height != 300
         puts "bad image result from black"
     end

data/example/example3.rb

@@ -3,15 +3,15 @@
 require 'vips'
 
 # this makes vips keep a list of all active objects 
-# Vips::leak_set true
+Vips::leak_set true
 
 # disable the operation cache
 # Vips::cache_set_max 0
 
 # turn on debug logging
-#Vips.set_debug true
+GLib::logger.level = Logger::DEBUG
 
-10000.times do |i|
+1.times do |i|
     puts "loop #{i} ..."
     im = Vips::Image.new_from_file ARGV[0]
     im = im.embed 100, 100, 3000, 3000, :extend => :mirror

data/lib/vips/gobject.rb

@@ -54,9 +54,10 @@ module GObject
             include GObjectLayout
 
             def self.release ptr
-                # Vips::log "GObject::GObject::ManagedStruct.release: " +
+                # GLib::logger.debug("GObject::GObject::ManagedStruct.release") {
                 #     "unreffing #{ptr}"
-                GObject::g_object_unref ptr
+                # }
+                ::GObject::g_object_unref ptr
             end
         end
 
@@ -72,7 +73,7 @@ module GObject
         # here we use ManagedStruct, not Struct, since this is the ref that will
         # need the unref
         def initialize ptr
-            # Vips::log "GObject::GObject.initialize: ptr = #{ptr}"
+            # GLib::logger.debug("GObject::GObject.initialize") {"ptr = #{ptr}"}
             @struct = ffi_managed_struct.new ptr
         end
 
@@ -109,13 +110,13 @@ module GObject
                :owner_type, :GType
     end
 
+    class GParamSpecPtr < FFI::Struct
+        layout :value, GParamSpec.ptr
+    end
+
     attach_function :g_param_spec_get_blurb, [GParamSpec.ptr], :string
 
     attach_function :g_object_ref, [:pointer], :void
     attach_function :g_object_unref, [:pointer], :void
 
-    class GParamSpecPtr < FFI::Struct
-        layout :value, GParamSpec.ptr
-    end
-
 end

data/lib/vips/gvalue.rb

@@ -24,7 +24,7 @@ module GObject
                :data, [:ulong_long, 2]
 
         def self.release ptr
-            # Vips::log "GObject::GValue::release ptr = #{ptr}"
+            # GLib::logger.debug("GObject::GValue::release") {"ptr = #{ptr}"}
             ::GObject::g_value_unset ptr 
         end
 
@@ -58,7 +58,9 @@ module GObject
         #
         # @param value [Any] The value to set
         def set value
-            # Vips::log "GObject::GValue.set: value = #{value.inspect[0..50]}"
+            # GLib::logger.debug("GObject::GValue.set") {
+            #     "value = #{value.inspect[0..50]}"
+            # }
 
             gtype = self[:gtype]
             fundamental = ::GObject::g_type_fundamental gtype
@@ -221,7 +223,9 @@ module GObject
                 end
             end
 
-            # Vips::log "GObject::GValue.get: result = #{result.inspect[0..50]}"
+            # GLib::logger.debug("GObject::GValue.get") {
+            #     "result = #{result.inspect[0..50]}"
+            # }
 
             return result
 

data/lib/vips/object.rb

@@ -9,6 +9,9 @@ require 'ffi'
 module Vips
     private
 
+    # debugging support
+    attach_function :vips_object_print_all, [], :void
+
     # we must init these by hand, since they are usually made on first image
     # create
     attach_function :vips_band_format_get_type, [], :GType
@@ -69,6 +72,13 @@ module Vips
 
     class Object < GObject::GObject
 
+        # print all active VipsObjects, with their reference counts. Handy for
+        # debugging ruby-vips. 
+        def self.print_all
+            GC.start
+            Vips::vips_object_print_all
+        end
+
         # the layout of the VipsObject struct
         module ObjectLayout
             def self.included base
@@ -117,13 +127,13 @@ module Vips
             GObject::g_object_get_property self, name, gvalue
             result = gvalue.get
 
-            # Vips::log "Vips::Object.get(\"#{name}\"): result = #{result}"
+            GLib::logger.debug("Vips::Object.get") {"#{name} == #{result}"}
 
             return result
         end
 
         def set name, value
-            # Vips::log "Vips::Object.set: #{name} = #{value}"
+            GLib::logger.debug("Vips::Object.set") {"#{name} = #{value}"}
 
             gtype = get_typeof name
             gvalue = GObject::GValue.alloc 

data/lib/vips/operation.rb

@@ -223,9 +223,10 @@ module Vips
         # the constant value 255. 
 
         def self.call name, supplied, optional = {}, option_string = ""
-            #Vips::log "Vips::VipsOperation.call: name = #{name}, " + 
-            #    "supplied = #{supplied} optional = #{optional} " +
-            #    "option_string = #{option_string}"
+            GLib::logger.debug("Vips::VipsOperation.call") {
+                "name = #{name}, supplied = #{supplied}, " +
+                "optional = #{optional}, option_string = #{option_string}"
+            }
 
             op = Operation.new name
 
@@ -351,7 +352,7 @@ module Vips
                 result = nil
             end
 
-            # Vips::log "Vips::Operation.call: result = #{result}"
+            GLib::logger.debug("Vips::Operation.call") {"result = #{result}"}
 
             Vips::vips_object_unref_outputs op
 

data/lib/vips/version.rb

@@ -1,4 +1,4 @@
 module Vips
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
 end
 

data/lib/vips.rb

@@ -5,11 +5,18 @@
 # License::   MIT
 
 require 'ffi'
+require 'logger'
 
 # This module uses FFI to make a simple layer over the glib and gobject 
 # libraries. 
 
 module GLib
+    class << self
+        attr_accessor :logger
+    end
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::WARN
+
     extend FFI::Library
 
     if FFI::Platform.windows?
@@ -20,19 +27,83 @@ module GLib
 
     ffi_lib glib_libname 
 
-    # nil being the default
-    glib_log_domain = nil
-
-    def self.set_log_domain domain
-        glib_log_domain = domain
-    end
-
     attach_function :g_malloc, [:size_t], :pointer
 
     # save the FFI::Function that attach will return ... we can use it directly
     # as a param for callbacks
     G_FREE = attach_function :g_free, [:pointer], :void
 
+    callback :g_log_func, [:string, :int, :string, :pointer], :void
+    attach_function :g_log_set_handler, 
+        [:string, :int, :g_log_func, :pointer], :int
+    attach_function :g_log_remove_handler, [:string, :int], :void
+
+    # log flags 
+    LOG_FLAG_RECURSION          = 1 << 0
+    LOG_FLAG_FATAL              = 1 << 1
+
+    # GLib log levels 
+    LOG_LEVEL_ERROR             = 1 << 2       # always fatal 
+    LOG_LEVEL_CRITICAL          = 1 << 3
+    LOG_LEVEL_WARNING           = 1 << 4
+    LOG_LEVEL_MESSAGE           = 1 << 5
+    LOG_LEVEL_INFO              = 1 << 6
+    LOG_LEVEL_DEBUG             = 1 << 7
+
+    # map glib levels to Logger::Severity
+    GLIB_TO_SEVERITY = {
+        LOG_LEVEL_ERROR => Logger::ERROR,
+        LOG_LEVEL_CRITICAL => Logger::FATAL,
+        LOG_LEVEL_WARNING => Logger::WARN,
+        LOG_LEVEL_MESSAGE => Logger::UNKNOWN,
+        LOG_LEVEL_INFO => Logger::INFO,
+        LOG_LEVEL_DEBUG => Logger::DEBUG
+    }
+    GLIB_TO_SEVERITY.default = Logger::UNKNOWN
+
+    # nil being the default
+    @glib_log_domain = nil
+    @glib_log_handler_id = 0
+
+    # module-level, so it's not GCd away
+    LOG_HANDLER = Proc.new do |domain, level, message, user_data|
+        @logger.log(GLIB_TO_SEVERITY[level], message, domain) 
+    end
+
+    def self.remove_log_handler
+        if @glib_log_handler_id and @glib_log_domain
+            g_log_remove_handler @glib_log_domain, @glib_log_handler_id
+            @glib_log_handler_id = nil
+        end
+    end
+
+    def self.set_log_domain domain
+        GLib::remove_log_handler
+
+        @glib_log_domain = domain
+
+        # forward all glib logging output from this domain to a Ruby logger
+        if @glib_log_domain
+            @glib_log_handler_id = g_log_set_handler @glib_log_domain,
+                LOG_LEVEL_DEBUG | 
+                LOG_LEVEL_INFO | 
+                LOG_LEVEL_MESSAGE | 
+                LOG_LEVEL_WARNING | 
+                LOG_LEVEL_ERROR | 
+                LOG_LEVEL_CRITICAL | 
+                LOG_FLAG_FATAL | LOG_FLAG_RECURSION,
+                LOG_HANDLER, nil
+
+            # we must remove any handlers on exit, since libvips may log stuff 
+            # on shutdown and we don't want LOG_HANDLER to be invoked 
+            # after Ruby has gone
+            at_exit {
+                GLib::remove_log_handler
+            }
+        end
+
+    end
+
 end
 
 module GObject
@@ -292,6 +363,19 @@ require 'vips/gvalue'
 # ```
 #
 # and so on. 
+#
+# # Logging
+#
+# The wrapper uses `logger` to log debug, info, warning, and error messages. By
+# default, it will send messages of level `Logger::WARN` and above to `STDOUT`.
+#
+# You can use the {GLib::logger} accessor to change the log level, or to
+# redirect logging somewhere else. For example:
+#
+# ```ruby
+# GLib.logger.level = Logger::ERROR
+# GLib.logger = Rails.logger
+# ```
 # 
 # # Automatic YARD documentation
 #
@@ -378,22 +462,6 @@ module Vips
     LOG_DOMAIN = "VIPS"
     GLib::set_log_domain LOG_DOMAIN
 
-    @@debug = false
-
-    # Turn debug logging on and off.
-    #
-    # @param dbg [Boolean] Set true to print debug log messages
-    def self.set_debug dbg 
-        @@debug = dbg
-    end
-
-    # Print a log message to the output. See {Vips::set_debug}.
-    def self.log str 
-        if @@debug
-            puts str
-        end
-    end
-
     typedef :ulong, :GType
 
     attach_function :vips_error_buffer, [], :string
@@ -435,18 +503,44 @@ module Vips
     # don't use at_exit to call vips_shutdown, it causes problems with fork, and
     # in any case libvips does this for us
 
-    attach_function :vips_object_print_all, [], :void
     attach_function :vips_leak_set, [:int], :void
 
-    def self.showall
-        if @@debug
-            GC.start
-            vips_object_print_all
-        end
+    # Turn libvips leak testing on and off. Handy for debugging ruby-vips, not
+    # very useful for user code. 
+    def self.leak_set leak
+        vips_leak_set (leak ? 1 : 0)
+    end
+
+    attach_function :vips_cache_set_max, [:int], :void
+    attach_function :vips_cache_set_max_mem, [:int], :void
+    attach_function :vips_cache_set_max_files, [:int], :void
+
+    # Set the maximum number of operations that libvips should cache. Set 0 to
+    # disable the operation cache. The default is 1000. 
+    def self.cache_set_max size
+        vips_cache_set_max size
+    end
+
+    # Set the maximum amount of memory that libvips should use for the operation
+    # cache. Set 0 to disable the operation cache. The default is 100mb.
+    def self.cache_set_max_mem size
+        vips_cache_set_max_mem size
+    end
+
+    # Set the maximum number of files libvips should keep open in the 
+    # operation cache. Set 0 to disable the operation cache. The default is 
+    # 100.
+    def self.cache_set_max_files size
+        vips_cache_set_max_files size
     end
 
-    if @@debug
-        vips_leak_set 1
+    # Deprecated compatibility function.
+    #
+    # Don't use this, instead change {GLib::logger.level}.
+    def self.set_debug debug
+        if debug
+            GLib::logger.level = Logger::DEBUG
+        end
     end
 
     attach_function :version, :vips_version, [:int], :int

data/ruby-vips.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   spec.name = "ruby-vips"
   spec.version = Vips::VERSION
   spec.authors = ["John Cupitt"]
-  spec.date = "2017-07-15"
   spec.email = "jcupitt@gmail.com"
 
   spec.summary = "Ruby extension for the vips image processing library."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-vips
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - John Cupitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi