ruby-vips 2.0.13 → 2.0.14

data/.travis.yml

@@ -1,12 +1,11 @@
-dist: trusty
-sudo: false
+dist: xenial
 
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
     - VIPS_VERSION_MAJOR=8
-    - VIPS_VERSION_MINOR=6
-    - VIPS_VERSION_MICRO=4
+    - VIPS_VERSION_MINOR=7
+    - VIPS_VERSION_MICRO=2
     - PATH=$HOME/vips/bin:$PATH
     - LD_LIBRARY_PATH=$HOME/vips/lib:$LD_LIBRARY_PATH
     - PKG_CONFIG_PATH=$HOME/vips/lib/pkgconfig:$PKG_CONFIG_PATH
@@ -33,6 +32,7 @@ addons:
       - libwebp-dev
 
 cache:
+  bundler: true
   directories:
     - $HOME/vips
 
@@ -44,12 +44,19 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 
-script: "bundle exec rake"
+script: bundle exec rake spec
 
 gemfile:
   - Gemfile
 
 before_install:
   - uname -a
-  - bash install-vips.sh 
+  - bash install-vips.sh
+
+jobs:
+  include:
+    - stage: Lint
+      rvm: 2.6
+      script: bundle exec rake rubocop

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## Version 2.0.14 (2018-10-3)
+
+* update links for new home [jcupitt]
+* various doc fixes [janko-m]
+* add `Vips::get_suffixes` [jcupitt]
+* prefer options splat [ioquatix]
+* update docs for 8.8 [jcupitt]
+
 ## Version 2.0.13 (2018-8-6)
 
 * allow optional args to have `nil` as a value [janko-m]

data/README.md

@@ -1,10 +1,10 @@
 # ruby-vips
 
 [![Gem Version](https://badge.fury.io/rb/ruby-vips.svg)](https://badge.fury.io/rb/ruby-vips)
-[![Build Status](https://travis-ci.org/jcupitt/ruby-vips.svg?branch=master)](https://travis-ci.org/jcupitt/ruby-vips)
+[![Build Status](https://travis-ci.org/libvips/ruby-vips.svg?branch=master)](https://travis-ci.org/libvips/ruby-vips)
 
 This gem provides a Ruby binding for the [libvips image processing
-library](https://jcupitt.github.io/libvips).
+library](https://libvips.github.io/libvips).
 
 Programs that use `ruby-vips` don't
 manipulate images directly, instead they create pipelines of image processing
@@ -31,16 +31,13 @@ rmagick.rb	788768
 ```
 
 See also [benchmarks at the official libvips
-website](https://github.com/jcupitt/libvips/wiki/Speed-and-memory-use).
-There's a handy blog post explaining [how libvips opens
-files](http://libvips.blogspot.co.uk/2012/06/how-libvips-opens-file.html)
-which gives some more background.
+website](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
 
 ## Requirements
 
   * macOS, Linux, and Windows tested
 
-  * libvips 8.2 or later, see the [libvips install instructions](https://jcupitt.github.io/libvips/install.html)
+  * 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 
 
@@ -76,7 +73,7 @@ im = Vips::Image.new_from_file filename
 # put im at position (100, 100) in a 3000 x 3000 pixel image, 
 # make the other pixels in the image by mirroring im up / down / 
 # left / right, see
-# https://jcupitt.github.io/libvips/API/current/libvips-conversion.html#vips-embed
+# https://libvips.github.io/libvips/API/current/libvips-conversion.html#vips-embed
 im = im.embed 100, 100, 3000, 3000, extend: :mirror
 
 # multiply the green (middle) band by 2, leave the other two alone

data/Rakefile

@@ -27,3 +27,9 @@ require "yard/rake/yardoc_task"
 
 YARD::Rake::YardocTask.new do |yard|
 end
+
+# RuboCop requires Ruby >= 2.2
+if Gem.ruby_version >= Gem::Version.new("2.2.0")
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end

data/VERSION

@@ -1 +1 @@
-2.0.13
+2.0.14

data/example/annotate.rb

@@ -5,13 +5,13 @@ require 'vips'
 im = Vips::Image.new_from_file ARGV[0], :access => :sequential
 
 left_text = Vips::Image.text "left corner", :dpi => 300
-left = left_text.embed 50, 50, im.width, 150 
+left = left_text.embed 50, 50, im.width, 150
 
 right_text = Vips::Image.text "right corner", :dpi => 300
 right = right_text.embed im.width - right_text.width - 50, 50, im.width, 150
 
 footer = (left | right).ifthenelse(0, [255, 0, 0], :blend => true)
 
-im = im.insert footer, 0, im.height, :expand => true   
+im = im.insert footer, 0, im.height, :expand => true
 
 im.write_to_file ARGV[1]

data/example/daltonize8.rb

@@ -28,20 +28,20 @@ im = Vips::Image.new_from_file ARGV[0]
 # remove any alpha channel before processing
 alpha = nil
 if im.bands == 4
-    alpha = im[3]
-    im = im.extract_band 0, :n => 3 
+  alpha = im[3]
+  im = im.extract_band 0, :n => 3
 end
 
 begin
-    # import to XYZ with lcms
-    # if there's no profile there, we'll fall back to the thing below
-    xyz = im.icc_import :embedded => true, :pcs => :xyz 
+  # import to XYZ with lcms
+  # if there's no profile there, we'll fall back to the thing below
+  xyz = im.icc_import :embedded => true, :pcs => :xyz
 rescue Vips::Error
-    # nope .. use the built-in converter instead
-    xyz = im.colourspace :xyz
+  # nope .. use the built-in converter instead
+  xyz = im.colourspace :xyz
 end
 
-brad = xyz.recomb xyz_to_brad 
+brad = xyz.recomb xyz_to_brad
 
 # through the Deuteranope matrix
 # we need rows to sum to 1 in Bradford space --- the matrix in the original
@@ -52,24 +52,24 @@ deut = brad.recomb [
     [0, 0, 1]
 ]
 
-xyz = deut.recomb brad_to_xyz 
+xyz = deut.recomb brad_to_xyz
 
-# .. and back to sRGB 
+# .. and back to sRGB
 rgb = xyz.colourspace :srgb
 
-# so this is the colour error 
+# so this is the colour error
 err = im - rgb
 
 # add the error back to other channels to make a compensated image
 im = im + err.recomb([
-    [0, 0, 0], 
+    [0, 0, 0],
     [0.7, 1, 0],
     [0.7, 0, 1]
 ])
 
 # reattach any alpha we saved above
 if alpha
-    im = im.bandjoin(alpha)
+  im = im.bandjoin(alpha)
 end
 
-im.write_to_file ARGV[1] 
+im.write_to_file ARGV[1]

data/example/example2.rb

@@ -17,12 +17,12 @@ Vips::cache_set_max 0
 n = 10000
 
 n.times do |i|
-    puts ""
-    puts "call #{i} ..."
-    out = Vips::Operation.call "black", [200, 300]
-    if out.width != 200 or out.height != 300
-        puts "bad image result from black"
-    end
+  puts ""
+  puts "call #{i} ..."
+  out = Vips::Operation.call "black", [200, 300]
+  if out.width != 200 or out.height != 300
+    puts "bad image result from black"
+  end
 end
 
 puts ""

data/example/example3.rb

@@ -2,7 +2,7 @@
 
 require 'vips'
 
-# this makes vips keep a list of all active objects 
+# this makes vips keep a list of all active objects
 Vips::leak_set true
 
 # disable the operation cache
@@ -12,8 +12,8 @@ Vips::leak_set true
 GLib::logger.level = Logger::DEBUG
 
 1.times do |i|
-    puts "loop #{i} ..."
-    im = Vips::Image.new_from_file ARGV[0]
-    im = im.embed 100, 100, 3000, 3000, :extend => :mirror
-    im.write_to_file "x.v"
+  puts "loop #{i} ..."
+  im = Vips::Image.new_from_file ARGV[0]
+  im = im.embed 100, 100, 3000, 3000, :extend => :mirror
+  im.write_to_file "x.v"
 end

data/example/example4.rb

@@ -2,7 +2,7 @@
 
 require 'vips'
 
-# this makes vips keep a list of all active objects 
+# this makes vips keep a list of all active objects
 Vips::leak_set true
 
 # disable the operation cache
@@ -12,7 +12,7 @@ Vips::leak_set true
 #Vips.set_debug true
 
 ARGV.each do |filename|
-    im = Vips::Image.new_from_file filename
-    profile = im.get_value "icc-profile-data"
-    puts "profile has #{profile.length} bytes"
+  im = Vips::Image.new_from_file filename
+  profile = im.get_value "icc-profile-data"
+  puts "profile has #{profile.length} bytes"
 end

data/example/example5.rb

@@ -2,7 +2,7 @@
 
 require 'vips'
 
-# this makes vips keep a list of all active objects 
+# this makes vips keep a list of all active objects
 # Vips::leak_set true
 
 # disable the operation cache
@@ -12,7 +12,7 @@ require 'vips'
 #Vips.set_debug true
 
 if ARGV.length < 2
-    raise "usage: #{$PROGRAM_NAME}: input-file output-file"
+  raise "usage: #{$PROGRAM_NAME}: input-file output-file"
 end
 
 im = Vips::Image.new_from_file ARGV[0], :access => :sequential

data/example/inheritance_with_refcount.rb

@@ -10,277 +10,277 @@ $vips_debug = true
 
 # @private
 def log str
-    if $vips_debug
-        puts str
-    end
+  if $vips_debug
+    puts str
+  end
 end
 
 def set_debug debug
-    $vips_debug = debug
+  $vips_debug = debug
 end
 
 module Libc
-    extend FFI::Library
-    ffi_lib FFI::Library::LIBC
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
 
-    attach_function :malloc, [:size_t], :pointer
-    attach_function :free, [:pointer], :void
+  attach_function :malloc, [:size_t], :pointer
+  attach_function :free, [:pointer], :void
 end
 
 module GLib
-    extend FFI::Library
-    ffi_lib 'gobject-2.0'
-
-    # nil being the default
-    glib_log_domain = nil
-
-    def self.set_log_domain(domain)
-        glib_log_domain = domain
-    end
-
-    # we have a set of things we need to inherit in different ways:
-    #
-    # - we want to be able to subclass GObject in a simple way
-    # - the layouts of the nested structs
-    # - casting between structs which share a base
-    # - gobject refcounting
-    #
-    # the solution is to split the class into four areas which we treat
-    # differently:
-    #
-    # - we have a "wrapper" Ruby class to allow easy subclassing ... this has a
-    #   @struct member which holds the actual pointer
-    # - we use "forwardable" to forward the various ffi methods on to the
-    #   @struct member ... we arrange things so that subclasses do not need to
-    #   do the forwarding themselves
-    # - we have two versions of the struct: a plain one which we can use for
-    #   casting that will not change the refcounts
-    # - and a managed one with an unref which we just use for .new
-    # - we separate the struct layout into a separate module to avoid repeating
-    #   ourselves
-
-    class GObject
-        extend Forwardable
-        extend SingleForwardable
-
-        def_instance_delegators :@struct, :[], :to_ptr
-        def_single_delegators :ffi_struct, :ptr
-
-        # the layout of the GObject struct
-        module GObjectLayout
-            def self.included(base)
-                base.class_eval do
-                    layout :g_type_instance, :pointer,
-                           :ref_count, :uint,
-                           :qdata, :pointer
-                end
-            end
+  extend FFI::Library
+  ffi_lib 'gobject-2.0'
+
+  # nil being the default
+  glib_log_domain = nil
+
+  def self.set_log_domain(domain)
+    glib_log_domain = domain
+  end
+
+  # we have a set of things we need to inherit in different ways:
+  #
+  # - we want to be able to subclass GObject in a simple way
+  # - the layouts of the nested structs
+  # - casting between structs which share a base
+  # - gobject refcounting
+  #
+  # the solution is to split the class into four areas which we treat
+  # differently:
+  #
+  # - we have a "wrapper" Ruby class to allow easy subclassing ... this has a
+  #   @struct member which holds the actual pointer
+  # - we use "forwardable" to forward the various ffi methods on to the
+  #   @struct member ... we arrange things so that subclasses do not need to
+  #   do the forwarding themselves
+  # - we have two versions of the struct: a plain one which we can use for
+  #   casting that will not change the refcounts
+  # - and a managed one with an unref which we just use for .new
+  # - we separate the struct layout into a separate module to avoid repeating
+  #   ourselves
+
+  class GObject
+    extend Forwardable
+    extend SingleForwardable
+
+    def_instance_delegators :@struct, :[], :to_ptr
+    def_single_delegators :ffi_struct, :ptr
+
+    # the layout of the GObject struct
+    module GObjectLayout
+      def self.included(base)
+        base.class_eval do
+          layout :g_type_instance, :pointer,
+                 :ref_count, :uint,
+                 :qdata, :pointer
         end
+      end
+    end
 
-        # the struct with unref ... manage object lifetime with this
-        class ManagedStruct < FFI::ManagedStruct
-            include GObjectLayout
-
-            def initialize(ptr)
-                log "GLib::GObject::ManagedStruct.new: #{ptr}"
-                super
-            end
+    # the struct with unref ... manage object lifetime with this
+    class ManagedStruct < FFI::ManagedStruct
+      include GObjectLayout
 
-            def self.release(ptr)
-                log "GLib::GObject::ManagedStruct.release: unreffing #{ptr}"
-                GLib::g_object_unref(ptr) unless ptr.null?
-            end
+      def initialize(ptr)
+        log "GLib::GObject::ManagedStruct.new: #{ptr}"
+        super
+      end
 
-        end
+      def self.release(ptr)
+        log "GLib::GObject::ManagedStruct.release: unreffing #{ptr}"
+        GLib::g_object_unref(ptr) unless ptr.null?
+      end
 
-        # the plain struct ... cast with this
-        class Struct < FFI::Struct
-            include GObjectLayout
+    end
 
-            def initialize(ptr)
-                log "GLib::GObject::Struct.new: #{ptr}"
-                super
-            end
+    # the plain struct ... cast with this
+    class Struct < FFI::Struct
+      include GObjectLayout
 
-        end
+      def initialize(ptr)
+        log "GLib::GObject::Struct.new: #{ptr}"
+        super
+      end
 
-        # don't allow ptr == nil, we never want to allocate a GObject struct
-        # ourselves, we just want to wrap GLib-allocated GObjects
-        #
-        # here we use ManagedStruct, not Struct, since this is the ref that will
-        # need the unref
-        def initialize(ptr)
-            log "GLib::GObject.initialize: ptr = #{ptr}"
-            @struct = ffi_managed_struct.new(ptr)
-        end
+    end
 
-        # access to the cast struct for this class
-        def ffi_struct
-            self.class.ffi_struct
-        end
+    # don't allow ptr == nil, we never want to allocate a GObject struct
+    # ourselves, we just want to wrap GLib-allocated GObjects
+    #
+    # here we use ManagedStruct, not Struct, since this is the ref that will
+    # need the unref
+    def initialize(ptr)
+      log "GLib::GObject.initialize: ptr = #{ptr}"
+      @struct = ffi_managed_struct.new(ptr)
+    end
 
-        class << self
-            def ffi_struct
-                self.const_get(:Struct)
-            end
-        end
+    # access to the cast struct for this class
+    def ffi_struct
+      self.class.ffi_struct
+    end
 
-        # access to the lifetime managed struct for this class
-        def ffi_managed_struct
-            self.class.ffi_managed_struct
-        end
+    class << self
+      def ffi_struct
+        self.const_get(:Struct)
+      end
+    end
 
-        class << self
-            def ffi_managed_struct
-                self.const_get(:ManagedStruct)
-            end
-        end
+    # access to the lifetime managed struct for this class
+    def ffi_managed_struct
+      self.class.ffi_managed_struct
+    end
 
+    class << self
+      def ffi_managed_struct
+        self.const_get(:ManagedStruct)
+      end
     end
 
-    # :gtype will usually be 64-bit, but will be 32-bit on 32-bit Windows
-    typedef :ulong, :GType
+  end
+
+  # :gtype will usually be 64-bit, but will be 32-bit on 32-bit Windows
+  typedef :ulong, :GType
 
 end
 
 module Vips
-    extend FFI::Library
-    ffi_lib 'vips'
+  extend FFI::Library
+  ffi_lib 'vips'
 
-    LOG_DOMAIN = "VIPS"
-    GLib::set_log_domain(LOG_DOMAIN)
+  LOG_DOMAIN = "VIPS"
+  GLib::set_log_domain(LOG_DOMAIN)
 
-    # need to repeat this
-    typedef :ulong, :GType
+  # need to repeat this
+  typedef :ulong, :GType
 
-    attach_function :vips_init, [:string], :int
-    attach_function :vips_shutdown, [], :void
+  attach_function :vips_init, [:string], :int
+  attach_function :vips_shutdown, [], :void
 
-    attach_function :vips_error_buffer, [], :string
-    attach_function :vips_error_clear, [], :void
+  attach_function :vips_error_buffer, [], :string
+  attach_function :vips_error_clear, [], :void
 
-    def self.get_error
-        errstr = Vips::vips_error_buffer
-        Vips::vips_error_clear
-        errstr
-    end
-
-    if Vips::vips_init($0) != 0
-        puts Vips::get_error
-        exit 1
-    end
+  def self.get_error
+    errstr = Vips::vips_error_buffer
+    Vips::vips_error_clear
+    errstr
+  end
 
-    at_exit {
-        Vips::vips_shutdown
-    }
+  if Vips::vips_init($0) != 0
+    puts Vips::get_error
+    exit 1
+  end
 
-    attach_function :vips_object_print_all, [], :void
-    attach_function :vips_leak_set, [:int], :void
+  at_exit {
+    Vips::vips_shutdown
+  }
 
-    def self.showall
-        if $vips_debug
-            GC.start
-            vips_object_print_all
-        end
-    end
+  attach_function :vips_object_print_all, [], :void
+  attach_function :vips_leak_set, [:int], :void
 
+  def self.showall
     if $vips_debug
-        vips_leak_set 1
+      GC.start
+      vips_object_print_all
     end
-
-    class VipsObject < GLib::GObject
-
-        # the layout of the VipsObject struct
-        module VipsObjectLayout
-            def self.included(base)
-                base.class_eval do
-                    # don't actually need most of these, remove them later
-                    layout :parent, GLib::GObject::Struct, 
-                       :constructed, :int,
-                       :static_object, :int,
-                       :argument_table, :pointer,
-                       :nickname, :string,
-                       :description, :string,
-                       :preclose, :int,
-                       :close, :int,
-                       :postclose, :int,
-                       :local_memory, :size_t
-                end
-            end
+  end
+
+  if $vips_debug
+    vips_leak_set 1
+  end
+
+  class VipsObject < GLib::GObject
+
+    # the layout of the VipsObject struct
+    module VipsObjectLayout
+      def self.included(base)
+        base.class_eval do
+          # don't actually need most of these, remove them later
+          layout :parent, GLib::GObject::Struct,
+             :constructed, :int,
+             :static_object, :int,
+             :argument_table, :pointer,
+             :nickname, :string,
+             :description, :string,
+             :preclose, :int,
+             :close, :int,
+             :postclose, :int,
+             :local_memory, :size_t
         end
+      end
+    end
 
-        class Struct < GLib::GObject::Struct
-            include VipsObjectLayout
-
-            def initialize(ptr)
-                log "Vips::VipsObject::Struct.new: #{ptr}"
-                super
-            end
+    class Struct < GLib::GObject::Struct
+      include VipsObjectLayout
 
-        end
+      def initialize(ptr)
+        log "Vips::VipsObject::Struct.new: #{ptr}"
+        super
+      end
 
-        class ManagedStruct < GLib::GObject::ManagedStruct
-            include VipsObjectLayout
+    end
 
-            def initialize(ptr)
-                log "Vips::VipsObject::ManagedStruct.new: #{ptr}"
-                super
-            end
+    class ManagedStruct < GLib::GObject::ManagedStruct
+      include VipsObjectLayout
 
-        end
+      def initialize(ptr)
+        log "Vips::VipsObject::ManagedStruct.new: #{ptr}"
+        super
+      end
 
     end
 
-    class VipsImage < VipsObject
+  end
 
-        # the layout of the VipsImage struct
-        module VipsImageLayout
-            def self.included(base)
-                base.class_eval do
-                    layout :parent, VipsObject::Struct
-                    # rest opaque
-                end
-            end
-        end
+  class VipsImage < VipsObject
 
-        class Struct < VipsObject::Struct
-            include VipsImageLayout
+    # the layout of the VipsImage struct
+    module VipsImageLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, VipsObject::Struct
+          # rest opaque
+        end
+      end
+    end
 
-            def initialize(ptr)
-                log "Vips::VipsImage::Struct.new: #{ptr}"
-                super
-            end
+    class Struct < VipsObject::Struct
+      include VipsImageLayout
 
-        end
+      def initialize(ptr)
+        log "Vips::VipsImage::Struct.new: #{ptr}"
+        super
+      end
 
-        class ManagedStruct < VipsObject::ManagedStruct
-            include VipsImageLayout
+    end
 
-            def initialize(ptr)
-                log "Vips::VipsImage::ManagedStruct.new: #{ptr}"
-                super
-            end
+    class ManagedStruct < VipsObject::ManagedStruct
+      include VipsImageLayout
 
-        end
+      def initialize(ptr)
+        log "Vips::VipsImage::ManagedStruct.new: #{ptr}"
+        super
+      end
 
-        def self.new_partial
-            VipsImage.new(Vips::vips_image_new)
-        end
+    end
 
+    def self.new_partial
+      VipsImage.new(Vips::vips_image_new)
     end
 
-    attach_function :vips_image_new, [], :pointer
+  end
+
+  attach_function :vips_image_new, [], :pointer
 
 end
 
 puts "creating image"
 begin
-    x = Vips::VipsImage.new_partial 
-    puts "x = #{x}"
-    puts ""
-    puts "x[:parent] = #{x[:parent]}"
-    puts ""
-    puts "x[:parent][:description] = #{x[:parent][:description]}"
-    puts ""
+  x = Vips::VipsImage.new_partial
+  puts "x = #{x}"
+  puts ""
+  puts "x[:parent] = #{x[:parent]}"
+  puts ""
+  puts "x[:parent][:description] = #{x[:parent][:description]}"
+  puts ""
 end