ruby-vips 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b632e0e44fa32da791e46806757e9b6a1a9901d92e2de9b02e16682bc3f3e6b2
-  data.tar.gz: 5d3841b9a656d13003b1b2668c05ab89cf5b65c76a52dad070a67b9a6856fe60
+  metadata.gz: c77f69e33910d95f8f678cff9787066e2af91cd889f24ec3834dcfaf78ee5cfc
+  data.tar.gz: 140effde4d987fff3e293034b0967245aa4f914ba603d8bce41010d0ec1a63ba
 SHA512:
-  metadata.gz: 11c11a729818aa279cf5a157cda6e810174da9089b9ae3a0e92b3c7e6080362dfca5a970b07f3881aa7f31e5aa4acf3cd1a9a05a2e3ef09dc86d7464fe8987fe
-  data.tar.gz: 41bae93d0c491699e0042acfe687bc86766af576c9ffe57da1c20a26de548e08c73c0d7685855a155630ed5d47a3a2e2e60f982df48df2a59d4a9f4bd6ccfd34
+  metadata.gz: 28b7309c3a0744b29c5d100b898aab3521cc07a17667d4041db3d5194db537336bdda578e25fddb79be929c0ac32a246fb47f08862c5273fc94c2e390cc5874c
+  data.tar.gz: d428e645d302329a9544819a188b7b010f1e265086a064cd2480dc5213d61a9ef78b0da5381a6f8bd85754ac5c8f2ce6f253701afb27e3180e157d1e807294d3

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master
 
+## Version 2.1.1 (2021-5-3)
+
+* fix "mutate" with libvips 8.9 [jcupitt]
+* update autodocs for libvips 8.11 [jcupitt]
+
 ## Version 2.1.0 (2021-3-8)
 
 * add "mutate" system [jcupitt]

data/TODO

@@ -37,9 +37,8 @@
 
 - Push new gem to rubygems, tag repository with version.
 
-	gem2.5 signin --otp 111111 / enter username and passwd
+	gem signin --otp 111111 
 	bundle exec rake release
 
-  There's an invisible prompt for the authenticator code. Enter eg. 123456, 
-  press return and the upload should work.
+  The otp is from authy / google authenticator / etc. 
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.1.1

data/lib/vips/image.rb

@@ -1129,14 +1129,10 @@ module Vips
       end
     end
 
-    # Convert to an Array. This will be slow for large images.
+    # Convert to an Enumerator. Similar to `#to_a` but lazier.
     #
-    # @return [Array] array of Fixnum
-    def to_a
-      # we render the image to a big string, then unpack
-      # as a Ruby array of the correct type
-      memory = write_to_memory
-
+    # @return [Enumerator] Enumerator of Enumerators of Arrays of Numerics
+    def to_enum
       # make the template for unpack
       template = {
         char: "c",
@@ -1151,14 +1147,22 @@ module Vips
         dpcomplex: "d"
       }[format] + "*"
 
-      # and unpack into something like [1, 2, 3, 4 ..]
-      array = memory.unpack(template)
+      # we render the image to a big string, then unpack into
+      # one-dimensional array as a Ruby array of the correct type
+      array = write_to_memory.unpack template
+
+      # gather bands of a pixel together
+      pixel_array = array.each_slice bands
 
-      # gather band elements together
-      pixel_array = array.each_slice(bands).to_a
+      # gather pixels of a row together
+      pixel_array.each_slice width
+    end
 
-      # build rows
-      pixel_array.each_slice(width).to_a
+    # Convert to an Array. This will be slow for large images.
+    #
+    # @return [Array] Array of Arrays of Arrays of Numerics
+    def to_a
+      to_enum.to_a
     end
 
     # Return the largest integral value not greater than the argument.

data/lib/vips/methods.rb

@@ -590,21 +590,6 @@ module Vips
 #   @option opts [Integer] :seed Random number seed
 #   @return [Vips::Image] Output image
 
-# @!method self.text(text, **opts)
-#   Make a text image.
-#   @param text [String] Text to render
-#   @param opts [Hash] Set of options
-#   @option opts [String] :font Font to render with
-#   @option opts [Integer] :width Maximum image width in pixels
-#   @option opts [Integer] :height Maximum image height in pixels
-#   @option opts [Vips::Align] :align Align on the low, centre or high edge
-#   @option opts [Integer] :dpi DPI to render at
-#   @option opts [Boolean] :justify Justify lines
-#   @option opts [Integer] :spacing Line spacing
-#   @option opts [String] :fontfile Load this font file
-#   @option opts [Integer] :autofit_dpi Output DPI selected by autofit
-#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
-
 # @!method self.xyz(width, height, **opts)
 #   Make an image where pixel values are coordinates.
 #   @param width [Integer] Image width in pixels
@@ -635,6 +620,22 @@ module Vips
 #   @option opts [Vips::Precision] :precision Generate with this precision
 #   @return [Vips::Image] Output image
 
+# @!method self.text(text, **opts)
+#   Make a text image.
+#   @param text [String] Text to render
+#   @param opts [Hash] Set of options
+#   @option opts [String] :font Font to render with
+#   @option opts [Integer] :width Maximum image width in pixels
+#   @option opts [Integer] :height Maximum image height in pixels
+#   @option opts [Vips::Align] :align Align on the low, centre or high edge
+#   @option opts [Boolean] :rgba Enable RGBA output
+#   @option opts [Integer] :dpi DPI to render at
+#   @option opts [Boolean] :justify Justify lines
+#   @option opts [Integer] :spacing Line spacing
+#   @option opts [String] :fontfile Load this font file
+#   @option opts [Integer] :autofit_dpi Output DPI selected by autofit
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
 # @!method self.eye(width, height, **opts)
 #   Make an image showing the eye's spatial response.
 #   @param width [Integer] Image width in pixels
@@ -961,6 +962,18 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
+# @!method self.vipsload_source(source, **opts)
+#   Load vips from source.
+#   @param source [Vips::Source] Source to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
 # @!method self.analyzeload(filename, **opts)
 #   Load an analyze6 image.
 #   @param filename [String] Filename to load from
@@ -1033,15 +1046,13 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.pdfload(filename, **opts)
-#   Load pdf from file.
+# @!method self.svgload(filename, **opts)
+#   Load svg with rsvg.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
-#   @option opts [Integer] :n Load this many pages
 #   @option opts [Float] :dpi Render at this DPI
 #   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :unlimited Allow SVG of any size
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1050,15 +1061,13 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.pdfload_buffer(buffer, **opts)
-#   Load pdf from buffer.
+# @!method self.svgload_buffer(buffer, **opts)
+#   Load svg with rsvg.
 #   @param buffer [VipsBlob] Buffer to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
-#   @option opts [Integer] :n Load this many pages
 #   @option opts [Float] :dpi Render at this DPI
 #   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :unlimited Allow SVG of any size
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1067,15 +1076,13 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.pdfload_source(source, **opts)
-#   Load pdf from source.
+# @!method self.svgload_source(source, **opts)
+#   Load svg from source.
 #   @param source [Vips::Source] Source to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
-#   @option opts [Integer] :n Load this many pages
 #   @option opts [Float] :dpi Render at this DPI
 #   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :unlimited Allow SVG of any size
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1084,13 +1091,10 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.svgload(filename, **opts)
-#   Load svg with rsvg.
+# @!method self.jxlload(filename, **opts)
+#   Load jpeg-xl image.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Float] :dpi Render at this DPI
-#   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Boolean] :unlimited Allow SVG of any size
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1099,13 +1103,10 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.svgload_buffer(buffer, **opts)
-#   Load svg with rsvg.
+# @!method self.jxlload_buffer(buffer, **opts)
+#   Load jpeg-xl image.
 #   @param buffer [VipsBlob] Buffer to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Float] :dpi Render at this DPI
-#   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Boolean] :unlimited Allow SVG of any size
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1114,13 +1115,49 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.svgload_source(source, **opts)
-#   Load svg from source.
+# @!method self.jxlload_source(source, **opts)
+#   Load jpeg-xl image.
 #   @param source [Vips::Source] Source to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Float] :dpi Render at this DPI
-#   @option opts [Float] :scale Scale output by this factor
-#   @option opts [Boolean] :unlimited Allow SVG of any size
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.jp2kload(filename, **opts)
+#   Load jpeg2000 image.
+#   @param filename [String] Filename to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the image
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.jp2kload_buffer(buffer, **opts)
+#   Load jpeg2000 image.
+#   @param buffer [VipsBlob] Buffer to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the image
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.jp2kload_source(source, **opts)
+#   Load jpeg2000 image.
+#   @param source [Vips::Source] Source to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the image
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1130,11 +1167,11 @@ module Vips
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
 # @!method self.gifload(filename, **opts)
-#   Load gif with giflib.
+#   Load gif with libnsgif.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Integer] :n Load this many pages
+#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1144,11 +1181,11 @@ module Vips
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
 # @!method self.gifload_buffer(buffer, **opts)
-#   Load gif with giflib.
+#   Load gif with libnsgif.
 #   @param buffer [VipsBlob] Buffer to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Integer] :n Load this many pages
+#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1158,11 +1195,11 @@ module Vips
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
 # @!method self.gifload_source(source, **opts)
-#   Load gif with giflib.
+#   Load gif from source.
 #   @param source [Vips::Source] Source to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Integer] :n Load this many pages
+#   @option opts [Integer] :page Load this page from the file
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1357,14 +1394,10 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.openslideload(filename, **opts)
-#   Load file with openslide.
+# @!method self.fitsload(filename, **opts)
+#   Load a fits image.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Boolean] :attach_associated Attach all asssociated images
-#   @option opts [Integer] :level Load this level from the file
-#   @option opts [Boolean] :autocrop Crop to image bounds
-#   @option opts [String] :associated Load this associated image
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1373,14 +1406,10 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.magickload(filename, **opts)
-#   Load file with imagemagick.
-#   @param filename [String] Filename to load from
+# @!method self.fitsload_source(source, **opts)
+#   Load fits from a source.
+#   @param source [Vips::Source] Source to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Boolean] :all_frames Read all frames from an image
-#   @option opts [String] :density Canvas resolution for rendering vector formats like SVG
-#   @option opts [Integer] :page Load this page from the file
-#   @option opts [Integer] :n Load this many pages
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1389,14 +1418,10 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.magickload_buffer(buffer, **opts)
-#   Load buffer with imagemagick.
-#   @param buffer [VipsBlob] Buffer to load from
+# @!method self.openexrload(filename, **opts)
+#   Load an openexr image.
+#   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
-#   @option opts [Boolean] :all_frames Read all frames from an image
-#   @option opts [String] :density Canvas resolution for rendering vector formats like SVG
-#   @option opts [Integer] :page Load this page from the file
-#   @option opts [Integer] :n Load this many pages
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1405,8 +1430,8 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.fitsload(filename, **opts)
-#   Load a fits image.
+# @!method self.niftiload(filename, **opts)
+#   Load nifti volume.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
 #   @option opts [Boolean] :memory Force open via memory
@@ -1417,9 +1442,9 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.openexrload(filename, **opts)
-#   Load an openexr image.
-#   @param filename [String] Filename to load from
+# @!method self.niftiload_source(source, **opts)
+#   Load nifti volumes.
+#   @param source [Vips::Source] Source to load from
 #   @param opts [Hash] Set of options
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
@@ -1429,10 +1454,30 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
-# @!method self.niftiload(filename, **opts)
-#   Load a nifti image.
+# @!method self.openslideload(filename, **opts)
+#   Load file with openslide.
 #   @param filename [String] Filename to load from
 #   @param opts [Hash] Set of options
+#   @option opts [Boolean] :attach_associated Attach all associated images
+#   @option opts [Integer] :level Load this level from the file
+#   @option opts [Boolean] :autocrop Crop to image bounds
+#   @option opts [String] :associated Load this associated image
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.openslideload_source(source, **opts)
+#   Load source with openslide.
+#   @param source [Vips::Source] Source to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Boolean] :attach_associated Attach all associated images
+#   @option opts [Integer] :level Load this level from the file
+#   @option opts [Boolean] :autocrop Crop to image bounds
+#   @option opts [String] :associated Load this associated image
 #   @option opts [Boolean] :memory Force open via memory
 #   @option opts [Vips::Access] :access Required access pattern for this file
 #   @option opts [Boolean] :sequential Sequential read only
@@ -1489,6 +1534,89 @@ module Vips
 #   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
 #   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
 
+# @!method self.pdfload(filename, **opts)
+#   Load pdf from file.
+#   @param filename [String] Filename to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the file
+#   @option opts [Integer] :n Load this many pages
+#   @option opts [Float] :dpi Render at this DPI
+#   @option opts [Float] :scale Scale output by this factor
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.pdfload_buffer(buffer, **opts)
+#   Load pdf from buffer.
+#   @param buffer [VipsBlob] Buffer to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the file
+#   @option opts [Integer] :n Load this many pages
+#   @option opts [Float] :dpi Render at this DPI
+#   @option opts [Float] :scale Scale output by this factor
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.pdfload_source(source, **opts)
+#   Load pdf from source.
+#   @param source [Vips::Source] Source to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :page Load this page from the file
+#   @option opts [Integer] :n Load this many pages
+#   @option opts [Float] :dpi Render at this DPI
+#   @option opts [Float] :scale Scale output by this factor
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.magickload(filename, **opts)
+#   Load file with imagemagick.
+#   @param filename [String] Filename to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Boolean] :all_frames Read all frames from an image
+#   @option opts [String] :density Canvas resolution for rendering vector formats like SVG
+#   @option opts [Integer] :page Load this page from the file
+#   @option opts [Integer] :n Load this many pages
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
+# @!method self.magickload_buffer(buffer, **opts)
+#   Load buffer with imagemagick.
+#   @param buffer [VipsBlob] Buffer to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Boolean] :all_frames Read all frames from an image
+#   @option opts [String] :density Canvas resolution for rendering vector formats like SVG
+#   @option opts [Integer] :page Load this page from the file
+#   @option opts [Integer] :n Load this many pages
+#   @option opts [Boolean] :memory Force open via memory
+#   @option opts [Vips::Access] :access Required access pattern for this file
+#   @option opts [Boolean] :sequential Sequential read only
+#   @option opts [Boolean] :fail Fail on first error
+#   @option opts [Boolean] :disc Open to disc
+#   @option opts [Vips::ForeignFlags] :flags Output Flags for this file
+#   @return [Vips::Image, Hash<Symbol => Object>] Output image, Hash of optional output items
+
 # @!method csvsave(filename, **opts)
 #   Save image to csv.
 #   @param filename [String] Filename to save to
@@ -1554,7 +1682,7 @@ module Vips
 #   @return [nil] 
 
 # @!method vipssave(filename, **opts)
-#   Save image to vips file.
+#   Save image to file in vips format.
 #   @param filename [String] Filename to save to
 #   @param opts [Hash] Set of options
 #   @option opts [Boolean] :strip Strip all metadata from image
@@ -1562,6 +1690,15 @@ module Vips
 #   @option opts [Integer] :page_height Set page height for multipage save
 #   @return [nil] 
 
+# @!method vipssave_target(target, **opts)
+#   Save image to target in vips format.
+#   @param target [Vips::Target] Target to save to
+#   @param opts [Hash] Set of options
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
 # @!method ppmsave(filename, **opts)
 #   Save image to ppm file.
 #   @param filename [String] Filename to save to
@@ -1612,6 +1749,88 @@ module Vips
 #   @option opts [Integer] :page_height Set page height for multipage save
 #   @return [nil] 
 
+# @!method jxlsave(filename, **opts)
+#   Save image in jpeg-xl format.
+#   @param filename [String] Filename to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tier Decode speed tier
+#   @option opts [Float] :distance Target butteraugli distance
+#   @option opts [Integer] :effort Encoding effort
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Quality factor
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
+# @!method jxlsave_buffer(**opts)
+#   Save image in jpeg-xl format.
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tier Decode speed tier
+#   @option opts [Float] :distance Target butteraugli distance
+#   @option opts [Integer] :effort Encoding effort
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Quality factor
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [VipsBlob] Buffer to save to
+
+# @!method jxlsave_target(target, **opts)
+#   Save image in jpeg-xl format.
+#   @param target [Vips::Target] Target to save to
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tier Decode speed tier
+#   @option opts [Float] :distance Target butteraugli distance
+#   @option opts [Integer] :effort Encoding effort
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Quality factor
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
+# @!method jp2ksave(filename, **opts)
+#   Save image in jpeg2000 format.
+#   @param filename [String] Filename to load from
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tile_width Tile width in pixels
+#   @option opts [Integer] :tile_height Tile height in pixels
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Q factor
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
+# @!method jp2ksave_buffer(**opts)
+#   Save image in jpeg2000 format.
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tile_width Tile width in pixels
+#   @option opts [Integer] :tile_height Tile height in pixels
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Q factor
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [VipsBlob] Buffer to save to
+
+# @!method jp2ksave_target(target, **opts)
+#   Save image in jpeg2000 format.
+#   @param target [Vips::Target] Target to save to
+#   @param opts [Hash] Set of options
+#   @option opts [Integer] :tile_width Tile width in pixels
+#   @option opts [Integer] :tile_height Tile height in pixels
+#   @option opts [Boolean] :lossless Enable lossless compression
+#   @option opts [Integer] :Q Q factor
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
 # @!method dzsave(filename, **opts)
 #   Save image to deepzoom file.
 #   @param filename [String] Filename to save to
@@ -1731,7 +1950,7 @@ module Vips
 #   @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
 #   @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
 #   @option opts [Integer] :quant_table Use predefined quantization table with given index
-#   @option opts [Vips::ForeignJpegSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1749,7 +1968,7 @@ module Vips
 #   @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
 #   @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
 #   @option opts [Integer] :quant_table Use predefined quantization table with given index
-#   @option opts [Vips::ForeignJpegSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1768,7 +1987,7 @@ module Vips
 #   @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
 #   @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
 #   @option opts [Integer] :quant_table Use predefined quantization table with given index
-#   @option opts [Vips::ForeignJpegSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1786,7 +2005,7 @@ module Vips
 #   @option opts [Boolean] :overshoot_deringing Apply overshooting to samples with extreme values
 #   @option opts [Boolean] :optimize_scans Split spectrum of DCT coefficients into separate scans
 #   @option opts [Integer] :quant_table Use predefined quantization table with given index
-#   @option opts [Vips::ForeignJpegSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1874,9 +2093,10 @@ module Vips
 #   @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
 #   @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
 #   @option opts [Integer] :level ZSTD compression level
-#   @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
 #   @option opts [Boolean] :lossless Enable WEBP lossless mode
 #   @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
+#   @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
+#   @option opts [Boolean] :premultiply Save with premultiplied alpha
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1904,34 +2124,10 @@ module Vips
 #   @option opts [Boolean] :properties Write a properties document to IMAGEDESCRIPTION
 #   @option opts [Vips::RegionShrink] :region_shrink Method to shrink regions
 #   @option opts [Integer] :level ZSTD compression level
-#   @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
 #   @option opts [Boolean] :lossless Enable WEBP lossless mode
 #   @option opts [Vips::ForeignDzDepth] :depth Pyramid depth
-#   @option opts [Boolean] :strip Strip all metadata from image
-#   @option opts [Array<Double>] :background Background value
-#   @option opts [Integer] :page_height Set page height for multipage save
-#   @return [VipsBlob] Buffer to save to
-
-# @!method magicksave(filename, **opts)
-#   Save file with imagemagick.
-#   @param filename [String] Filename to save to
-#   @param opts [Hash] Set of options
-#   @option opts [String] :format Format to save in
-#   @option opts [Integer] :quality Quality to use
-#   @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
-#   @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
-#   @option opts [Boolean] :strip Strip all metadata from image
-#   @option opts [Array<Double>] :background Background value
-#   @option opts [Integer] :page_height Set page height for multipage save
-#   @return [nil] 
-
-# @!method magicksave_buffer(**opts)
-#   Save image to magick buffer.
-#   @param opts [Hash] Set of options
-#   @option opts [String] :format Format to save in
-#   @option opts [Integer] :quality Quality to use
-#   @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
-#   @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
+#   @option opts [Boolean] :subifd Save pyr layers as sub-IFDs
+#   @option opts [Boolean] :premultiply Save with premultiplied alpha
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1957,12 +2153,13 @@ module Vips
 
 # @!method heifsave(filename, **opts)
 #   Save image in heif format.
-#   @param filename [String] Filename to load from
+#   @param filename [String] Filename to save to
 #   @param opts [Hash] Set of options
 #   @option opts [Integer] :Q Q factor
 #   @option opts [Boolean] :lossless Enable lossless compression
 #   @option opts [Vips::ForeignHeifCompression] :compression Compression format
 #   @option opts [Integer] :speed CPU effort
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1975,6 +2172,7 @@ module Vips
 #   @option opts [Boolean] :lossless Enable lossless compression
 #   @option opts [Vips::ForeignHeifCompression] :compression Compression format
 #   @option opts [Integer] :speed CPU effort
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
@@ -1988,11 +2186,37 @@ module Vips
 #   @option opts [Boolean] :lossless Enable lossless compression
 #   @option opts [Vips::ForeignHeifCompression] :compression Compression format
 #   @option opts [Integer] :speed CPU effort
+#   @option opts [Vips::ForeignSubsample] :subsample_mode Select chroma subsample operation mode
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [nil] 
+
+# @!method magicksave(filename, **opts)
+#   Save file with imagemagick.
+#   @param filename [String] Filename to save to
+#   @param opts [Hash] Set of options
+#   @option opts [String] :format Format to save in
+#   @option opts [Integer] :quality Quality to use
+#   @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
+#   @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
 #   @option opts [Boolean] :strip Strip all metadata from image
 #   @option opts [Array<Double>] :background Background value
 #   @option opts [Integer] :page_height Set page height for multipage save
 #   @return [nil] 
 
+# @!method magicksave_buffer(**opts)
+#   Save image to magick buffer.
+#   @param opts [Hash] Set of options
+#   @option opts [String] :format Format to save in
+#   @option opts [Integer] :quality Quality to use
+#   @option opts [Boolean] :optimize_gif_frames Apply GIF frames optimization
+#   @option opts [Boolean] :optimize_gif_transparency Apply GIF transparency optimization
+#   @option opts [Boolean] :strip Strip all metadata from image
+#   @option opts [Array<Double>] :background Background value
+#   @option opts [Integer] :page_height Set page height for multipage save
+#   @return [VipsBlob] Buffer to save to
+
 # @!method self.thumbnail(filename, width, **opts)
 #   Generate thumbnail from file.
 #   @param filename [String] Filename to read from
@@ -2295,6 +2519,7 @@ module Vips
 #   @param opts [Hash] Set of options
 #   @option opts [Vips::PCS] :pcs Set Profile Connection Space
 #   @option opts [Vips::Intent] :intent Rendering intent
+#   @option opts [Boolean] :black_point_compensation Enable black point compensation
 #   @option opts [Boolean] :embedded Use embedded input profile, if available
 #   @option opts [String] :input_profile Filename to load input profile from
 #   @return [Vips::Image] Output image
@@ -2304,6 +2529,7 @@ module Vips
 #   @param opts [Hash] Set of options
 #   @option opts [Vips::PCS] :pcs Set Profile Connection Space
 #   @option opts [Vips::Intent] :intent Rendering intent
+#   @option opts [Boolean] :black_point_compensation Enable black point compensation
 #   @option opts [String] :output_profile Filename to load output profile from
 #   @option opts [Integer] :depth Output device space depth in bits
 #   @return [Vips::Image] Output image
@@ -2314,6 +2540,7 @@ module Vips
 #   @param opts [Hash] Set of options
 #   @option opts [Vips::PCS] :pcs Set Profile Connection Space
 #   @option opts [Vips::Intent] :intent Rendering intent
+#   @option opts [Boolean] :black_point_compensation Enable black point compensation
 #   @option opts [Boolean] :embedded Use embedded input profile, if available
 #   @option opts [String] :input_profile Filename to load input profile from
 #   @option opts [Integer] :depth Output device space depth in bits

data/lib/vips/mutableimage.rb

@@ -53,8 +53,9 @@ module Vips
       # it's the thing we return at the end of the mutate block.
       copy_image = image.copy
 
-      # use ptr since we need the raw unwrapped pointer inside the image ...
-      # and make the ref that gobject will unref when it finishes
+      # Use ptr since we need the raw unwrapped pointer inside the image ...
+      # and make the ref that gobject will unref when it finishes.
+      # See also the comment on set_type! before changing this.
       pointer = copy_image.ptr
       ::GObject.g_object_ref pointer
       super pointer
@@ -79,7 +80,7 @@ module Vips
     end
 
     def respond_to_missing? name, include_all = false
-      # respond to all vips operations by nickname
+      # Respond to all vips operations by nickname.
       return true if Vips.type_find("VipsOperation", name.to_s) != 0
 
       super
@@ -115,7 +116,21 @@ module Vips
       gvalue = GObject::GValue.alloc
       gvalue.init gtype
       gvalue.set value
-      Vips.vips_image_set self, name, gvalue
+
+      # libvips 8.9.1 had a terrible misfeature which would block metadata
+      # modification unless the object had a ref_count of 1. MutableImage
+      # will always have a ref_count of at least 2 (the parent gobject keeps a
+      # ref, and we keep a ref to the copy ready to return to our caller),
+      # so we must temporarily drop the refs to 1 around metadata changes.
+      #
+      # See https://github.com/libvips/ruby-vips/issues/291
+      begin
+        ::GObject.g_object_unref ptr
+        Vips.vips_image_set self, name, gvalue
+      ensure
+        ::GObject.g_object_ref ptr
+      end
+
       gvalue.unset
     end
 
@@ -148,7 +163,11 @@ module Vips
     #
     # @param name [String] Metadata field to remove
     def remove! name
+      # See set_type! for an explanation. Image#remove can't throw an
+      # exception, so there's no need to ensure we unref.
+      ::GObject.g_object_unref ptr
       Vips.vips_image_remove self, name
+      ::GObject.g_object_ref ptr
     end
   end
 end

data/lib/vips/version.rb

@@ -1,3 +1,3 @@
 module Vips
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-vips
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - John Cupitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi