ruby-vips 2.0.15 → 2.1.2

data/lib/vips/region.rb

@@ -0,0 +1,73 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require "ffi"
+
+module Vips
+  attach_function :vips_region_new, [:pointer], :pointer
+
+  if Vips.at_least_libvips?(8, 8)
+    attach_function :vips_region_fetch, [:pointer, :int, :int, :int, :int, SizeStruct.ptr], :pointer
+    attach_function :vips_region_width, [:pointer], :int
+    attach_function :vips_region_height, [:pointer], :int
+  end
+
+  # A region on an image. Create one, then use `fetch` to quickly get a region
+  # of pixels.
+  #
+  # For example:
+  #
+  #  ```ruby
+  #  region = Vips::Region.new(image)
+  #  pixels = region.fetch(10, 10, 100, 100)
+  #  ```
+  class Region < Vips::Object
+    # The layout of the VipsRegion struct.
+    module RegionLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Object::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Object::Struct
+      include RegionLayout
+    end
+
+    class ManagedStruct < Vips::Object::ManagedStruct
+      include RegionLayout
+    end
+
+    def initialize(name)
+      ptr = Vips.vips_region_new name
+      raise Vips::Error if ptr.null?
+
+      super ptr
+    end
+
+    def width
+      Vips.vips_region_width self
+    end
+
+    def height
+      Vips.vips_region_height self
+    end
+
+    # Fetch a region filled with pixel data.
+    def fetch(left, top, width, height)
+      len = Vips::SizeStruct.new
+      ptr = Vips.vips_region_fetch self, left, top, width, height, len
+      raise Vips::Error if ptr.null?
+
+      # wrap up as an autopointer
+      ptr = FFI::AutoPointer.new(ptr, GLib::G_FREE)
+
+      ptr.get_bytes 0, len[:value]
+    end
+  end
+end

data/lib/vips/source.rb

@@ -0,0 +1,88 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require "ffi"
+
+module Vips
+  if Vips.at_least_libvips?(8, 9)
+    attach_function :vips_source_new_from_descriptor, [:int], :pointer
+    attach_function :vips_source_new_from_file, [:pointer], :pointer
+    attach_function :vips_source_new_from_memory, [:pointer, :size_t], :pointer
+  end
+
+  # A source. For example:
+  #
+  # ```ruby
+  # source = Vips::Source.new_from_file("k2.jpg")
+  # image = Vips::Image.new_from_source(source)
+  # ```
+  class Source < Vips::Connection
+    module SourceLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Connection::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Connection::Struct
+      include SourceLayout
+    end
+
+    class ManagedStruct < Vips::Connection::ManagedStruct
+      include SourceLayout
+    end
+
+    # Create a new source from a file descriptor. File descriptors are
+    # small integers, for example 0 is stdin.
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    #
+    # @param descriptor [Integer] the file descriptor
+    # @return [Source] the new Vips::Source
+    def self.new_from_descriptor(descriptor)
+      ptr = Vips.vips_source_new_from_descriptor descriptor
+      raise Vips::Error if ptr.null?
+
+      Vips::Source.new ptr
+    end
+
+    # Create a new source from a file name.
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    #
+    # @param filename [String] the name of the file
+    # @return [Source] the new Vips::Source
+    def self.new_from_file(filename)
+      raise Vips::Error, "filename is nil" if filename.nil?
+      ptr = Vips.vips_source_new_from_file filename
+      raise Vips::Error if ptr.null?
+
+      Vips::Source.new ptr
+    end
+
+    # Create a new source from an area of memory. Memory areas can be
+    # strings, arrays and so forth -- anything that supports bytesize.
+    #
+    # Pass sources to {Image.new_from_source} to load images from
+    # them.
+    #
+    # @param data [String] memory area
+    # @return [Source] the new Vips::Source
+    def self.new_from_memory(data)
+      ptr = Vips.vips_source_new_from_memory data, data.bytesize
+      raise Vips::Error if ptr.null?
+
+      # FIXME do we need to keep a ref to the underlying memory area? what
+      # about Image.new_from_buffer? Does that need a secret ref too?
+
+      Vips::Source.new ptr
+    end
+  end
+end

data/lib/vips/sourcecustom.rb

@@ -0,0 +1,89 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require "ffi"
+
+module Vips
+  if Vips.at_least_libvips?(8, 9)
+    attach_function :vips_source_custom_new, [], :pointer
+  end
+
+  # A source you can attach action signal handlers to to implement
+  # custom input types.
+  #
+  # For example:
+  #
+  # ```ruby
+  # file = File.open "some/file/name", "rb"
+  # source = Vips::SourceCustom.new
+  # source.on_read { |length| file.read length }
+  # image = Vips::Image.new_from_source source
+  # ```
+  #
+  # (just an example -- of course in practice you'd use {Source#new_from_file}
+  # to read from a named file)
+  class SourceCustom < Vips::Source
+    module SourceCustomLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Source::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Source::Struct
+      include SourceCustomLayout
+    end
+
+    class ManagedStruct < Vips::Source::ManagedStruct
+      include SourceCustomLayout
+    end
+
+    def initialize
+      pointer = Vips.vips_source_custom_new
+      raise Vips::Error if pointer.null?
+
+      super pointer
+    end
+
+    # The block is executed to read data from the source. The interface is
+    # exactly as IO::read, ie. it takes a maximum number of bytes to read and
+    # returns a string of bytes from the source, or nil if the source is already
+    # at end of file.
+    #
+    # @yieldparam length [Integer] Read and return up to this many bytes
+    # @yieldreturn [String] Up to length bytes of data, or nil for EOF
+    def on_read &block
+      signal_connect "read" do |buf, len|
+        chunk = block.call len
+        return 0 if chunk.nil?
+        bytes_read = chunk.bytesize
+        buf.put_bytes(0, chunk, 0, bytes_read)
+        chunk.clear
+
+        bytes_read
+      end
+    end
+
+    # The block is executed to seek the source. The interface is exactly as
+    # IO::seek, ie. it should take an offset and whence, and return the
+    # new read position.
+    #
+    # This handler is optional -- if you do not attach a seek handler,
+    # {Source} will treat your source like an unseekable pipe object and
+    # do extra caching.
+    #
+    # @yieldparam offset [Integer] Seek offset
+    # @yieldparam whence [Integer] Seek whence
+    # @yieldreturn [Integer] the new read position, or -1 on error
+    def on_seek &block
+      signal_connect "seek" do |offset, whence|
+        block.call offset, whence
+      end
+    end
+  end
+end

data/lib/vips/target.rb

@@ -0,0 +1,86 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require "ffi"
+
+module Vips
+  if Vips.at_least_libvips?(8, 9)
+    attach_function :vips_target_new_to_descriptor, [:int], :pointer
+    attach_function :vips_target_new_to_file, [:string], :pointer
+    attach_function :vips_target_new_to_memory, [], :pointer
+  end
+
+  # A target. For example:
+  #
+  # ```ruby
+  # target = Vips::Target.new_to_file('k2.jpg')
+  # image.write_to_target(target, '.jpg')
+  # ```
+  class Target < Vips::Connection
+    # The layout of the VipsRegion struct.
+    module TargetLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Connection::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Connection::Struct
+      include TargetLayout
+    end
+
+    class ManagedStruct < Vips::Connection::ManagedStruct
+      include TargetLayout
+    end
+
+    # Create a new target to a file descriptor. File descriptors are
+    # small integers, for example 1 is stdout.
+    #
+    # Pass targets to {Image#write_to_target} to write images to
+    # them.
+    #
+    # @param descriptor [Integer] the file descriptor
+    # @return [Target] the new Vips::Target
+    def self.new_to_descriptor(descriptor)
+      ptr = Vips.vips_target_new_to_descriptor descriptor
+      raise Vips::Error if ptr.null?
+
+      Vips::Target.new ptr
+    end
+
+    # Create a new target to a file name.
+    #
+    # Pass targets to {Image#write_to_target} to write images to
+    # them.
+    #
+    # @param filename [String] the name of the file
+    # @return [Target] the new Vips::Target
+    def self.new_to_file(filename)
+      raise Vips::Error, "filename is nil" if filename.nil?
+      ptr = Vips.vips_target_new_to_file filename
+      raise Vips::Error if ptr.null?
+
+      Vips::Target.new ptr
+    end
+
+    # Create a new target to an area of memory.
+    #
+    # Pass targets to {Image#write_to_target} to write images to
+    # them.
+    #
+    # Once the image has been written, use {Object#get}`("blob")` to read out
+    # the data.
+    #
+    # @return [Target] the new Vips::Target
+    def self.new_to_memory
+      ptr = Vips.vips_target_new_to_memory
+
+      Vips::Target.new ptr
+    end
+  end
+end

data/lib/vips/targetcustom.rb

@@ -0,0 +1,77 @@
+# This module provides an interface to the top level bits of libvips
+# via ruby-ffi.
+#
+# Author::    John Cupitt  (mailto:jcupitt@gmail.com)
+# License::   MIT
+
+require "ffi"
+
+module Vips
+  if Vips.at_least_libvips?(8, 9)
+    attach_function :vips_target_custom_new, [], :pointer
+  end
+
+  # A target you can attach action signal handlers to to implememt
+  # custom output types.
+  #
+  # For example:
+  #
+  # ```ruby
+  # file = File.open "some/file/name", "wb"
+  # target = Vips::TargetCustom.new
+  # target.on_write { |bytes| file.write bytes }
+  # image.write_to_target target, ".png"
+  # ```
+  #
+  # (just an example -- of course in practice you'd use {Target#new_to_file}
+  # to write to a named file)
+  class TargetCustom < Vips::Target
+    module TargetCustomLayout
+      def self.included(base)
+        base.class_eval do
+          layout :parent, Vips::Target::Struct
+          # rest opaque
+        end
+      end
+    end
+
+    class Struct < Vips::Target::Struct
+      include TargetCustomLayout
+    end
+
+    class ManagedStruct < Vips::Target::ManagedStruct
+      include TargetCustomLayout
+    end
+
+    def initialize
+      pointer = Vips.vips_target_custom_new
+      raise Vips::Error if pointer.null?
+
+      super pointer
+    end
+
+    # The block is executed to write data to the source. The interface is
+    # exactly as IO::write, ie. it should write the string and return the
+    # number of bytes written.
+    #
+    # @yieldparam bytes [String] Write these bytes to the file
+    # @yieldreturn [Integer] The number of bytes written, or -1 on error
+    def on_write &block
+      signal_connect "write" do |p, len|
+        chunk = p.get_bytes(0, len)
+        bytes_written = block.call chunk
+        chunk.clear
+
+        bytes_written
+      end
+    end
+
+    # The block is executed at the end of write. It should do any necessary
+    # finishing action, such as closing a file.
+    def on_finish &block
+      signal_connect "finish" do
+        block.call
+      end
+    end
+  end
+end

data/lib/vips/version.rb

@@ -1,3 +1,3 @@
 module Vips
-  VERSION = "2.0.15"
+  VERSION = "2.1.2"
 end

data/ruby-vips.gemspec

@@ -1,42 +1,48 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'vips/version'
+require_relative "lib/vips/version"
 
 Gem::Specification.new do |spec|
   spec.name = "ruby-vips"
   spec.version = Vips::VERSION
-  spec.authors = ["John Cupitt"]
-  spec.email = "jcupitt@gmail.com"
-
-  spec.summary = "Ruby extension for the vips image processing library."
-  spec.description = "ruby-vips is a binding for the vips image processing library. It is extremely fast and it can process huge images without loading the whole image in memory."
+  spec.summary = "A fast image processing library with low memory needs"
+  spec.description = <<-DESC.strip
+    ruby-vips is a binding for the libvips image processing library. It is fast 
+    and it can process large images without loading the whole image in memory.
+  DESC
   spec.homepage = "http://github.com/libvips/ruby-vips"
   spec.licenses = ["MIT"]
+  spec.authors = ["John Cupitt"]
+  spec.email = ["jcupitt@gmail.com"]
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/libvips/ruby-vips/issues",
+    "changelog_uri" =>
+      "https://github.com/libvips/ruby-vips/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://www.rubydoc.info/gems/ruby-vips",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/libvips/ruby-vips",
+
+    "msys2_mingw_dependencies" => "libvips"
+  }
 
   spec.require_paths = ["lib"]
-  spec.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md",
-    "TODO"
-  ]
+  spec.extra_rdoc_files = %w[LICENSE.txt README.md TODO]
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_runtime_dependency "ffi", ["~> 1.9"]
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_runtime_dependency "ffi", ["~> 1.12"]
 
-  spec.add_development_dependency "rake", ["~> 11.0"]
+  spec.add_development_dependency "rake", ["~> 12.0"]
   spec.add_development_dependency "rspec", ["~> 3.3"]
   spec.add_development_dependency "yard", ["~> 0.9.11"]
-  spec.add_development_dependency "redcarpet", ["~> 3.3"]
-  spec.add_development_dependency "github-markup", ["~> 1.4"]
   spec.add_development_dependency "bundler", [">= 1.0", "< 3"]
 
-  # RuboCop requires Ruby >= 2.2
   if Gem.ruby_version >= Gem::Version.new("2.2")
-    spec.add_development_dependency "rubocop", ["~> 0.64"]
+    spec.add_development_dependency "standard"
   end
 end