ruby-vips 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9c2a25819da8d93bb3cd90e9c409d475090b789bc2c1f4e30389ad665cb579
-  data.tar.gz: 3d92ec1b0020802e05df6c632c135c8bae07478afa44a76ef2b8d3c9e5466563
+  metadata.gz: 13cfcbea0e56ad3823bf1da4e035884d934253c729d74da5f54c77e87e949c5a
+  data.tar.gz: ebd97fa16da17c0f932bccb49d21d5b1dcaa024e32ace5c3335f093b2043efea
 SHA512:
-  metadata.gz: 1af7c18265746e1553e321bc2410fd37d8c1e627306bf347768893c5d0a6fa57f4663ec80c7c2d877c3a49382bfb49b45759c4af3ee181717f4eecc78f66bab4
-  data.tar.gz: 792c89c07bda9f21e22e0938db16f9182b055b803d41dde4846f804dddc7d3f1c44469ced01f1fba82982b06c204cf22e93ed6510bdb6cac4a061193e085c6b7
+  metadata.gz: a7ff0c920fa2ccfe60e9b1762fce6efaa94413f5a68453156eaa7cad6a63cdbab3639ecc525c52cb11578684bc02e9868b7643ab4bc89a8f23905c7dae0b06c1
+  data.tar.gz: c258fc41dca1d105aa4617bac9a3092a8ea3ce7a2bf41f0ad37aac1baa3ebcdce9a3353a4be014b9748e8e141ca15916b67f789cb1fab76c8a5647832aa2efd0

data/.github/workflows/test.yml

@@ -38,15 +38,17 @@ jobs:
       matrix:
         os-version: [ 'ubuntu-20.04' ]
         ruby-version:
-          - 2.0
-          - 2.1
-          - 2.2
-          - 2.3
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '2.0'
+          - '2.1'
+          - '2.2'
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
           - jruby
       fail-fast: true
 
@@ -54,7 +56,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## master
 
+## Version 2.2.0 (2023-10-18)
+
+* add `draw_point!` [jcupitt]
+* add `Vips.tracked_*` for getting file and memory metrics [jeremy]
+* add `Vips.cache_*` for getting cache settings [jeremy]
+* add `Vips.vector?` to get/set SIMD status [jeremy]
+* add `Vips.concurrency` to get/set threadpool size [jeremy]
+* add `Vips.concurrency_default` to get the default threadpool size [jeremy]
+* fix targetcustom spec test with libvips 8.13 [lucaskanashiro]
+* add ruby 3.2 to CI [petergoldstein]
+* update docs for libvips 8.15 [jcupitt]
+
+## Version 2.1.4 (2021-10-28)
+
+* `write_to_buffer` tries to use the new target API, then falls back to the old 
+  buffer system [jcupitt]
+* don't generate yard docs for deprecated args [jcupitt]
+* add hyperbolic trig functions [jcupitt]
+
 ## Version 2.1.3 (2021-8-23)
 
 * fix a gtype size error on win64 [danini-the-panini]

data/README.md

@@ -4,7 +4,10 @@
 [![Test](https://github.com/libvips/ruby-vips/workflows/Test/badge.svg)](https://github.com/libvips/ruby-vips/actions?query=workflow%3ATest)
 
 This gem is a Ruby binding for the [libvips image processing
-library](https://libvips.github.io/libvips).
+library](https://libvips.github.io/libvips). It has been tested on
+Linux, macOS and Windows, and with ruby 2, ruby 3 and jruby. It uses
+[ruby-ffi](https://github.com/ffi/ffi) to call functions in the libvips
+library.
 
 libvips is a [demand-driven, horizontally
 threaded](https://github.com/libvips/libvips/wiki/Why-is-libvips-quick)
@@ -14,34 +17,32 @@ memory](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
 libvips is licensed under the [LGPL
 2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html).
 
-## Requirements
+## Install on linux and macOS
 
-  * macOS, Linux, and Windows tested
+Install the libvips binary with your package manager (eg. `apt install
+libvips42` or perhaps `brew install vips`, see the [libvips install
+instructions](https://libvips.github.io/libvips/install.html)) then install
+this gem with:
 
-  * libvips 8.2 or later, see the [libvips install instructions](https://libvips.github.io/libvips/install.html)
-
-  * [ruby-ffi](https://github.com/ffi/ffi) 1.9 or later 
+```
+gem install ruby-vips
+```
 
-  * Ruby 2.0+, JRuby
+Or include `gem "ruby-vips"` in your gemfile.
 
-## Install
+## Install on Windows
 
-[Install libvips](https://libvips.github.io/libvips/install.html), then:
+The gemspec will pull in the msys libvips for you, so all you need is:
 
 ```
-$ gem install ruby-vips
+gem install ruby-vips
 ```
 
-or include it in `Gemfile`:
+Or include `gem "ruby-vips"` in your gemfile.
 
-```ruby
-gem "ruby-vips"
-```
+Tested with the ruby and msys from choco, but others may work.
 
-On Windows, you'll need to set the `RUBY_DLL_PATH` environment variable to 
-point to the libvips bin directory.
-
-# Example
+## Example
 
 ```ruby
 require "vips"
@@ -68,19 +69,24 @@ im = im.conv mask, precision: :integer
 im.write_to_file output_filename
 ```
 
-The `Vips` section in the API docs has a [tutorial introduction with
+## Documentation
+
+There are [full API docs for ruby-vips on
+rubydoc](https://www.rubydoc.info/gems/ruby-vips). This sometimes has issues
+updating, so we have a [copy on the gh-pages for this site as
+well](http://libvips.github.io/ruby-vips), which
+should always work.
+
+See the `Vips` section in the docs for a [tutorial introduction with
 examples](https://www.rubydoc.info/gems/ruby-vips/Vips).
 
-ruby-vips has [API
- documentation](http://www.rubydoc.info/gems/ruby-vips). The [libvips
- reference manual](https://libvips.github.io/libvips/API/current/) has a
- complete explanation of every method.
+The [libvips reference manual](https://libvips.github.io/libvips/API/current/)
+has a complete explanation of every method.
 
-The 
-[`example/`](https://github.com/libvips/ruby-vips/tree/master/example)
+The [`example/`](https://github.com/libvips/ruby-vips/tree/master/example)
 directory has some simple example programs.
 
-# Benchmarks
+## Benchmarks
 
 The benchmark at [vips-benchmarks](https://github.com/jcupitt/vips-benchmarks)
 loads a large image, crops, shrinks, sharpens and saves again, and repeats
@@ -101,4 +107,3 @@ rmagick.rb	788768
 
 See also [benchmarks at the official libvips
 website](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
-

data/TODO

@@ -37,8 +37,7 @@
 
 - Push new gem to rubygems, tag repository with version.
 
-	gem signin --otp 111111 
 	bundle exec rake release
 
-  The otp is from authy / google authenticator / etc. 
+  You'll be asked for a otp from authy / google authenticator / etc. 
 

data/VERSION

@@ -1 +1 @@
-2.1.3
+2.2.0

data/example/revalidate.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+
+# demo the "revalidate" feature in libvips 8.15
+
+require "fileutils"
+require "vips"
+
+if ARGV.length != 2
+  puts "usage: ./revalidate.rb IMAGE-FILE-1 IMAGE-FILE-2"
+  exit 1
+end
+
+if File.exist?("fred")
+  puts "file 'fred' exists, delete it first"
+  exit 1
+end
+
+puts "copying #{ARGV[0]} to fred ..."
+FileUtils.cp(ARGV[0], "fred")
+
+image1 = Vips::Image.new_from_file("fred")
+puts "fred.width = #{image1.width}"
+
+puts "copying #{ARGV[1]} to fred ..."
+FileUtils.cp(ARGV[1], "fred")
+
+puts "plain image open ..."
+image2 = Vips::Image.new_from_file("fred")
+puts "fred.width = #{image2.width}"
+
+puts "opening with revalidate ..."
+image2 = Vips::Image.new_from_file("fred", revalidate: true)
+puts "fred.width = #{image2.width}"
+
+puts "opening again, should get cached entry ..."
+image2 = Vips::Image.new_from_file("fred")
+puts "fred.width = #{image2.width}"
+
+File.delete("fred")

data/lib/vips/image.rb

@@ -138,14 +138,14 @@ module Vips
           image = image.cast :float
         end
 
-        new_format = image.format == :double ? :dpcomplex : :complex
+        new_format = (image.format == :double) ? :dpcomplex : :complex
         image = image.copy format: new_format, bands: image.bands / 2
       end
 
       image = block.call(image)
 
       unless Image.complex? original_format
-        new_format = image.format == :dpcomplex ? :double : :float
+        new_format = (image.format == :dpcomplex) ? :double : :float
         image = image.copy format: new_format, bands: image.bands * 2
       end
 
@@ -623,11 +623,27 @@ module Vips
       raise Vips::Error, "filename is nil" if format_string.nil?
       filename = Vips.p2str(Vips.vips_filename_get_filename(format_string))
       option_string = Vips.p2str(Vips.vips_filename_get_options(format_string))
-      saver = Vips.vips_foreign_find_save_buffer filename
-      raise Vips::Error if saver.nil?
 
-      buffer = Vips::Operation.call saver, [self], opts, option_string
-      raise Vips::Error if buffer.nil?
+      # try to save with the new target API first, only fall back to the old
+      # buffer API if there's no target save for this filetype
+      saver = nil
+      if Vips.at_least_libvips?(8, 9)
+        Vips.vips_error_freeze
+        saver = Vips.vips_foreign_find_save_target filename
+        Vips.vips_error_thaw
+      end
+
+      if !saver.nil?
+        target = Vips::Target.new_to_memory
+        Vips::Operation.call saver, [self, target], opts, option_string
+        buffer = target.get("blob")
+      else
+        saver = Vips.vips_foreign_find_save_buffer filename
+        raise Vips::Error if saver.nil?
+
+        buffer = Vips::Operation.call saver, [self], opts, option_string
+        raise Vips::Error if buffer.nil?
+      end
 
       write_gc
 
@@ -1434,6 +1450,48 @@ module Vips
       math :atan
     end
 
+    # Return the hyperbolic sine of an image in radians.
+    #
+    # @return [Image] sine of each pixel
+    def sinh
+      math :sinh
+    end
+
+    # Return the hyperbolic cosine of an image in radians.
+    #
+    # @return [Image] cosine of each pixel
+    def cosh
+      math :cosh
+    end
+
+    # Return the hyperbolic tangent of an image in radians.
+    #
+    # @return [Image] tangent of each pixel
+    def tanh
+      math :tanh
+    end
+
+    # Return the inverse hyperbolic sine of an image in radians.
+    #
+    # @return [Image] inverse sine of each pixel
+    def asinh
+      math :asinh
+    end
+
+    # Return the inverse hyperbolic cosine of an image in radians.
+    #
+    # @return [Image] inverse cosine of each pixel
+    def acosh
+      math :acosh
+    end
+
+    # Return the inverse hyperbolic tangent of an image in radians.
+    #
+    # @return [Image] inverse tangent of each pixel
+    def atanh
+      math :atanh
+    end
+
     # Return the natural log of an image.
     #
     # @return [Image] natural log of each pixel
@@ -1616,8 +1674,8 @@ module Vips
 
       method_args = introspect.method_args
       required_output = introspect.required_output
-      optional_input = introspect.optional_input
-      optional_output = introspect.optional_output
+      optional_input = introspect.doc_optional_input
+      optional_output = introspect.doc_optional_output
 
       print "# @!method "
       print "self." unless introspect.member_x
@@ -1640,17 +1698,18 @@ module Vips
       optional_input.each do |arg_name, details|
         yard_name = details[:yard_name]
         gtype = details[:gtype]
+        rtype = gtype_to_ruby gtype
         blurb = details[:blurb]
 
-        puts "#   @option opts [#{gtype_to_ruby(gtype)}] :#{yard_name} #{blurb}"
+        puts "#   @option opts [#{rtype}] :#{yard_name} #{blurb}"
       end
       optional_output.each do |arg_name, details|
         yard_name = details[:yard_name]
         gtype = details[:gtype]
+        rtype = gtype_to_ruby gtype
         blurb = details[:blurb]
 
-        print "#   @option opts [#{gtype_to_ruby(gtype)}] :#{yard_name}"
-        puts " Output #{blurb}"
+        puts "#   @option opts [#{rtype}] :#{yard_name} Output #{blurb}"
       end
 
       print "#   @return ["