morandi 0.12.1 → 0.99.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6da7620befd8e8fdac1a547cafbbcb0dd9e12c7d8edb5c2be0e57112e4e26ec
-  data.tar.gz: 2d883102edca613748f79c7aa54b6ebe7a95930b8372c2812fddde7b3762a1b9
+  metadata.gz: a794ac03476df828589c8239af24558daba1b32c4db9052f1dcf3704442eae43
+  data.tar.gz: 71fb0af31081d29907392d57ceb7adda9fc6b277835fd7540a9c91a6b1b9c90c
 SHA512:
-  metadata.gz: 92dae873f4b4de40ad3e2b89d1dd4203ef48281b6390f6d59f425364aeb503b949fa6f10972fda1f1f77854dc21873cf52f1611cba38f52702d903252ec618c3
-  data.tar.gz: 6eb80b2a9f8b1a0fb84788a275e69f1a66c408a96337e49b33dafcc3da7ed11e80df2d74de0c9dabb1568e5bc2760b0c6ecca03c81864e55080b729034ee31ec
+  metadata.gz: be85f2a459dad73012fe696f285f1eae17b098e48002f5da9cf868ed876854b915115e1e6f85929948427208d2b3363abe3d7b492b6187e729bf408ad6fccb95
+  data.tar.gz: 78beadc94f1387ff9af6d9c00d2f518f17d71f241880a5d2a828568dfaa2eb1b2aade57b198fc7f8ceeae429c1445d1c9c36c9fd461c84b3516e88964c32bf19

data/CHANGELOG.md

@@ -4,7 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Last updated 10.12.2020
+## Unreleased
+### Added
+- Copied pixbufutils and redeye gems into main gem
+- Added gdk_pixbuf_cairo C extension to convert between GdkPixbufs and ImageSurfaces
+- Added Ruby 3 support
+- Bumped version to 0.99.01 in preparation for a 1.0 release
+
+### Removed
+- support for Ruby 2.0 (and illusion of it being tested by CI)
+- support for Ruby 2.3
+- gtk2 dependency
+
+## [0.13.0] 16.12.2020
+### Fixed
+- Refactored test suite
+- Fixed most rubocop offenses
+### Aded
+- CI pipeline
+- rubocop
+- Development image
 
 ## [0.12.1] 10.12.2020
 ### Fixed

data/README.md

@@ -5,7 +5,7 @@ morandi-js.
 
 ## Installation
 
-Install `liblcms2-utils` to provide the `jpgicc` command used by `Morandi::ProfiledPixbuf`
+Install `liblcms2-utils` to provide the `jpgicc` command used by `Morandi::ProfiledPixbuf`. Also ensure that your host system has `imagemagick` installed, which is required bi the `colorscore` gem.
 
 Add this line to your application's Gemfile:
 
@@ -36,6 +36,7 @@ contrast     | Integer -20..20  | Change image contrast
 sharpen      | Integer -5..5  | Sharpen / Blur (negative value)
 redeye       | Array[[Integer,Integer],...]  | Apply redeye correction at point
 angle        | Integer 0,90,180,270  | Rotate image
+straighten   | Float | Rotate by N degrees and zoom
 crop         | Array[Integer,Integer,Integer,Integer] | Crop image
 fx           | String greyscale,sepia,bluetone | Apply colour filters
 border-style  | String square,retro | Set border style
@@ -49,3 +50,7 @@ quality       | String '1'..'100' | Set JPG compression value, defaults to 97%
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+### Development
+
+Since this gem depends on the `liblcms2-utils` library, which can be awkward to install on some operating systems, we also provide a development docker image. A Makefile is also provided as a simple CLI. To build the image and run the container, type `make` from the project root. The container itself runs `guard` as its main process. Running the container via `make` will drop you into the guard  prompt, which will run the test suite whenever any of the source code or tests are changed. The tests can be kicked-off manually via the `all` command at the guard prompt. Individual test can be run using the `focus: true` annotation on an example or describe block. If you need to access a bash shell in the container (for example, to run rubocop), use the command `make shell`.

data/ext/gdk_pixbuf_cairo/extconf.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/GlobalVars
+require 'mkmf'
+
+require 'English'
+require 'rubygems'
+gem 'glib2'
+require 'mkmf-gnome'
+
+def macos?
+  !!(RUBY_PLATFORM =~ /darwin/)
+end
+
+def clang?
+  cc_version = `#{RbConfig.expand('$(CC) --version'.dup)}`
+  cc_version.match?(/clang/i)
+end
+
+# XCode 14 warns if `-Wl,-undefined dynamic_lookup` is specified, and as
+# a result Ruby interpreters compiled under XCode 14 no longer specify
+# this flag by default in DLDFLAGS. Let's specify the list of dynamic symbols
+# here to avoid compilation failures.
+if clang? && macos?
+  dynamic_symbols = %w[
+    _rb_cairo_surface_from_ruby_object
+    _rb_cairo_surface_to_ruby_object_with_destroy
+    _rbgobj_instance_from_ruby_object
+    _rbgobj_ruby_object_from_instance
+  ]
+  dynamic_symbols.each do |sym|
+    $DLDFLAGS << " -Wl,-U,#{sym.strip}"
+  end
+end
+
+%w[rbglib.h rbpango.h rcairo.h].each do |header|
+  Gem.find_files(header).each do |f|
+    $CFLAGS += " '-I#{File.dirname(f)}'"
+  end
+end
+# Look for headers in {gem_root}/ext/{package}
+%w[glib2 cairo].each do |package|
+  require package
+  if Gem.loaded_specs[package]
+    $CFLAGS += " -I#{Gem.loaded_specs[package].full_gem_path}/ext/#{package}"
+  else
+    fn = $LOADED_FEATURES.find { |n| n.sub(/[.](so|rb)$/, '') == package }
+    if fn
+      dr = $LOAD_PATH.find { |d| File.exist?(File.join(d, fn)) }
+      pt = File.join(dr, fn) if dr && fn
+    else
+      pt = '??'
+    end
+    warn "require '#{package}' loaded '#{pt}' instead of the gem - trying to continue, but build may fail"
+  end
+end
+$CFLAGS += " -I#{RbConfig::CONFIG['rubyhdrdir']}/ruby" if RbConfig::CONFIG.key?('rubyhdrdir')
+
+$CFLAGS += ' -I.'
+have_func('rb_errinfo')
+PKGConfig.have_package('gdk-pixbuf-2.0') or exit(-1)
+# PKGConfig.have_package('gdk-2.0') or exit(-1)
+PKGConfig.have_package('cairo') or exit(-1)
+
+unless have_header('gdk-pixbuf/gdk-pixbuf.h')
+  paths = Gem.find_files('gdk-pixbuf/gdk-pixbuf.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('gdk-pixbuf/gdk-pixbuf.h') or exit(-1)
+end
+
+unless have_header('rbglib.h')
+  paths = Gem.find_files('rbglib.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('rbglib.h') or exit(-1)
+end
+
+unless have_header('rbgobject.h')
+  paths = Gem.find_files('rbgobject.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('rbgobject.h') or exit(-1)
+end
+
+$defs << '-DHAVE_OBJECT_ALLOCATE'
+
+top = File.expand_path("#{File.dirname(__FILE__)}/..") # XXX
+$CFLAGS << ' ' << ['glib/src'].map do |d|
+  "-I#{File.join(top, d)}"
+end.join(' ')
+
+begin
+  srcdir = File.expand_path(File.dirname($PROGRAM_NAME))
+
+  obj_ext = ".#{$OBJEXT}"
+  $libs = $libs.split(/ /).uniq.join(' ')
+  $source_files = Dir.glob(format('%s/*.c', srcdir)).map do |fname|
+    fname[0, srcdir.length + 1] = ''
+    fname
+  end
+  $objs = $source_files.collect do |item|
+    item.gsub(/.c$/, obj_ext)
+  end
+
+  #
+  # create Makefile
+  #
+  $defs << '-DRUBY_MORANDI_NATIVE_COMPILATION'
+  create_makefile('gdk_pixbuf_cairo', srcdir)
+  raise Interrupt unless FileTest.exist? 'Makefile'
+
+  File.open('Makefile', 'a') do |mfile|
+    $source_files.each do |e|
+      mfile.print("#{e.gsub(/.c$/, obj_ext)}: #{e}\n")
+    end
+  end
+rescue Interrupt
+  print "  [error] #{$ERROR_INFO}\n"
+end
+# rubocop:enable Style/GlobalVars

data/ext/gdk_pixbuf_cairo/gdk_pixbuf_cairo.c

@@ -0,0 +1,260 @@
+/* Includes */
+#include <ruby.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#if defined GCC
+#define OPTIONAL_ATTR __attribute__((unused))
+#else
+#define OPTIONAL_ATTR
+#endif
+
+#include "gdk-pixbuf/gdk-pixbuf.h"
+#include "rbglib.h"
+#include "rbgobject.h"
+#include "rb_cairo.h"
+
+static VALUE mGdkPixbufCairo;
+void Init_gdk_pixbuf_cairo(void);
+
+/**
+* pixbuf_cairo_create:
+* @pixbuf: GdkPixbuf that you wish to wrap with cairo context
+*
+* This function will initialize new cairo context with contents of @pixbuf. You
+* can then draw using returned context. When finished drawing, you must call
+* pixbuf_cairo_destroy() or your pixbuf will not be updated with new contents!
+*
+* Return value: New cairo_t context. When you're done with it, call
+* pixbuf_cairo_destroy() to update your pixbuf and free memory.
+*/
+static cairo_surface_t *
+pixbuf_to_surface(GdkPixbuf *pixbuf) {
+    gint width,        /* Width of both pixbuf and surface */
+    height,       /* Height of both pixbuf and surface */
+    p_stride,     /* Pixbuf stride value */
+    p_n_channels, /* RGB -> 3, RGBA -> 4 */
+    s_stride,     /* Surface stride value */
+    j;
+    guchar *p_pixels,     /* Pixbuf's pixel data */
+    *s_pixels;     /* Surface's pixel data */
+    cairo_surface_t *surface;      /* Temporary image surface */
+
+    g_object_ref(G_OBJECT(pixbuf));
+
+    /* Inspect input pixbuf and create compatible cairo surface */
+    g_object_get(G_OBJECT(pixbuf), "width", &width,
+                 "height", &height,
+                 "rowstride", &p_stride,
+                 "n-channels", &p_n_channels,
+                 "pixels", &p_pixels,
+                 NULL);
+    surface = cairo_image_surface_create(p_n_channels == 4 ? CAIRO_FORMAT_ARGB32 : CAIRO_FORMAT_RGB24, width, height);
+    s_stride = cairo_image_surface_get_stride(surface);
+    s_pixels = cairo_image_surface_get_data(surface);
+
+    /* Copy pixel data from pixbuf to surface */
+    for (j = height; j; j--) {
+        guchar *p = p_pixels;
+        guchar *q = s_pixels;
+
+        if (p_n_channels == 3) {
+            guchar *end = p + 3 * width;
+
+            while (p < end) {
+#if G_BYTE_ORDER == G_LITTLE_ENDIAN
+                q[0] = p[2];
+                q[1] = p[1];
+                q[2] = p[0];
+                q[3] = 0xFF;
+#else
+                q[0] = 0xFF;
+              q[1] = p[0];
+              q[2] = p[1];
+              q[3] = p[2];
+#endif
+                p += 3;
+                q += 4;
+            }
+        } else {
+            guchar *end = p + 4 * width;
+            guint t1, t2, t3;
+
+#define MULT(d, c, a, t) G_STMT_START { t = c * a + 0x80; d = ((t >> 8) + t) >> 8; } G_STMT_END
+
+            while (p < end) {
+#if G_BYTE_ORDER == G_LITTLE_ENDIAN
+                MULT(q[0], p[2], p[3], t1);
+                MULT(q[1], p[1], p[3], t2);
+                MULT(q[2], p[0], p[3], t3);
+                q[3] = p[3];
+#else
+                q[0] = p[3];
+              MULT(q[1], p[0], p[3], t1);
+              MULT(q[2], p[1], p[3], t2);
+              MULT(q[3], p[2], p[3], t3);
+#endif
+
+                p += 4;
+                q += 4;
+            }
+
+#undef MULT
+        }
+
+        p_pixels += p_stride;
+        s_pixels += s_stride;
+    }
+    g_object_unref(G_OBJECT(pixbuf));
+
+    cairo_surface_mark_dirty(surface);
+
+    return surface;
+}
+
+/**
+* pixbuf_cairo_destroy:
+* @cr: Cairo context that you wish to destroy
+* @create_new_pixbuf: If TRUE, new pixbuf will be created and returned. If
+*                     FALSE, input pixbuf will be updated in place.
+*
+* This function will destroy cairo context, created with pixbuf_cairo_create().
+*
+* Return value: New or updated GdkPixbuf. You own a new reference on return
+* value, so you need to call g_object_unref() on returned pixbuf when you don't
+* need it anymore.
+*/
+static GdkPixbuf *
+surface_to_pixbuf(cairo_surface_t *surface) {
+    gint width,        /* Width of both pixbuf and surface */
+    height,       /* Height of both pixbuf and surface */
+    p_stride,     /* Pixbuf stride value */
+    p_n_channels, /* RGB -> 3, RGBA -> 4 */
+    s_stride,     /* Surface stride value */
+    j;
+    guchar *p_pixels,     /* Pixbuf's pixel data */
+    *s_pixels;     /* Surface's pixel data */
+    GdkPixbuf *pixbuf;       /* Pixbuf to be returned */
+    cairo_format_t format;  /* cairo surface format */
+
+    format = cairo_image_surface_get_format(surface);
+
+    switch (format) {
+        case CAIRO_FORMAT_ARGB32:
+            p_n_channels = 4;
+            break;
+        case CAIRO_FORMAT_RGB24:
+            p_n_channels = 3;
+            break;
+        default:
+            return (GdkPixbuf *) 0;
+            break;
+    }
+
+    width = cairo_image_surface_get_width(surface);
+    height = cairo_image_surface_get_height(surface);
+    s_stride = cairo_image_surface_get_stride(surface);
+    s_pixels = cairo_image_surface_get_data(surface);
+
+    /* Create pixbuf to be returned */
+    pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, p_n_channels == 4, 8, width, height);
+
+    g_return_val_if_fail(pixbuf != NULL, NULL);
+
+    /* Inspect pixbuf and surface */
+    g_object_get(G_OBJECT(pixbuf),
+                 "width", &width,
+                 "height", &height,
+                 "rowstride", &p_stride,
+                 "n-channels", &p_n_channels,
+                 "pixels", &p_pixels,
+                 NULL);
+
+
+    /* Copy pixel data from surface to pixbuf */
+    for (j = height; j; j--) {
+        guchar *p = p_pixels;
+        guchar *q = s_pixels;
+
+        if (p_n_channels == 3) {
+            guchar *end = p + 3 * width;
+
+            while (p < end) {
+#if G_BYTE_ORDER == G_LITTLE_ENDIAN
+                p[2] = q[0];
+                p[1] = q[1];
+                p[0] = q[2];
+#else
+                p[0] = q[1];
+                p[1] = q[2];
+                p[2] = q[3];
+#endif
+                p += 3;
+                q += 4;
+            }
+        } else {
+            guchar *end = p + 4 * width;
+            guint t1, t2, t3;
+
+#define UNMULT(s_byte, p_byte, a, t) G_STMT_START { \
+t = s_byte * 255 / a;                         \
+p_byte = t; \
+} G_STMT_END
+
+            while (p < end) {
+#if G_BYTE_ORDER == G_LITTLE_ENDIAN
+                UNMULT(q[0], p[2], q[3], t1);
+                UNMULT(q[1], p[1], q[3], t2);
+                UNMULT(q[2], p[0], q[3], t3);
+                p[3] = q[3];
+#else
+                p[3] = q[0];
+                UNMULT(q[1], p[0], q[3], t1);
+                UNMULT(q[2], p[1], q[3], t2);
+                UNMULT(q[3], p[2], q[3], t3);
+#endif
+
+                p += 4;
+                q += 4;
+            }
+
+#undef MULT
+        }
+
+        p_pixels += p_stride;
+        s_pixels += s_stride;
+    }
+
+    /* Return pixbuf */
+    return (pixbuf);
+}
+
+static
+VALUE rb_pixbuf_to_surface(__attribute__((unused)) VALUE _self, VALUE pixbuf) {
+    cairo_surface_t *surface = pixbuf_to_surface(GDK_PIXBUF(RVAL2GOBJ(pixbuf)));
+    return CRSURFACE2RVAL_WITH_DESTROY(surface);
+}
+
+static
+VALUE rb_surface_to_pixbuf(__attribute__((unused)) VALUE _self, VALUE surface) {
+    VALUE obj;
+    GdkPixbuf *pixbuf = surface_to_pixbuf(RVAL2CRSURFACE(surface));
+    if (pixbuf) {
+        obj = GOBJ2RVAL(pixbuf);
+        g_object_unref(pixbuf);
+        return obj;
+    }
+
+    rb_raise(rb_eRuntimeError, "Unable to convert Cairo::ImageSurface to Gdk::Pixbuf");
+
+    return Qnil;
+}
+
+/* Init */
+void
+Init_gdk_pixbuf_cairo(void) {
+    mGdkPixbufCairo = rb_define_module("GdkPixbufCairo");
+    rb_define_singleton_method(mGdkPixbufCairo, "pixbuf_to_surface", rb_pixbuf_to_surface, 1);
+    rb_define_singleton_method(mGdkPixbufCairo, "surface_to_pixbuf", rb_surface_to_pixbuf, 1);
+}

data/ext/morandi_native/extconf.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/GlobalVars
+require 'mkmf'
+
+require 'English'
+require 'rubygems'
+gem 'glib2'
+require 'mkmf-gnome'
+
+def macos?
+  !!(RUBY_PLATFORM =~ /darwin/)
+end
+
+def clang?
+  cc_version = `#{RbConfig.expand('$(CC) --version'.dup)}`
+  cc_version.match?(/clang/i)
+end
+
+# XCode 14 warns if `-Wl,-undefined dynamic_lookup` is specified, and as
+# a result Ruby interpreters compiled under XCode 14 no longer specify
+# this flag by default in DLDFLAGS. Let's specify the list of dynamic symbols
+# here to avoid compilation failures.
+if clang? && macos?
+  dynamic_symbols = %w[
+    _rbgobj_instance_from_ruby_object
+    _rbgobj_ruby_object_from_instance
+  ]
+  dynamic_symbols.each do |sym|
+    $DLDFLAGS << " -Wl,-U,#{sym.strip}"
+  end
+end
+
+%w[rbglib.h rbpango.h].each do |header|
+  Gem.find_files(header).each do |f|
+    $CFLAGS += " '-I#{File.dirname(f)}'"
+  end
+end
+# Look for headers in {gem_root}/ext/{package}
+%w[glib2].each do |package|
+  require package
+  if Gem.loaded_specs[package]
+    $CFLAGS += " -I#{Gem.loaded_specs[package].full_gem_path}/ext/#{package}"
+  else
+    fn = $LOADED_FEATURES.find { |n| n.sub(/[.](so|rb)$/, '') == package }
+    if fn
+      dr = $LOAD_PATH.find { |d| File.exist?(File.join(d, fn)) }
+      pt = File.join(dr, fn) if dr && fn
+    else
+      pt = '??'
+    end
+    warn "require '#{package}' loaded '#{pt}' instead of the gem - trying to continue, but build may fail"
+  end
+end
+$CFLAGS += " -I#{RbConfig::CONFIG['rubyhdrdir']}/ruby" if RbConfig::CONFIG.key?('rubyhdrdir')
+
+$CFLAGS += ' -I.'
+have_func('rb_errinfo')
+PKGConfig.have_package('gdk-pixbuf-2.0') or exit(-1)
+# PKGConfig.have_package('gdk-2.0') or exit(-1)
+
+unless have_header('gdk-pixbuf/gdk-pixbuf.h')
+  paths = Gem.find_files('gdk-pixbuf/gdk-pixbuf.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('gdk-pixbuf/gdk-pixbuf.h') or exit(-1)
+end
+
+unless have_header('rbglib.h')
+  paths = Gem.find_files('rbglib.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('rbglib.h') or exit(-1)
+end
+
+unless have_header('rbgobject.h')
+  paths = Gem.find_files('rbgobject.h')
+  paths.each do |path|
+    $CFLAGS += " '-I#{File.dirname(path)}'"
+  end
+  have_header('rbgobject.h') or exit(-1)
+end
+
+$defs << '-DHAVE_OBJECT_ALLOCATE'
+
+top = File.expand_path("#{File.dirname(__FILE__)}/..") # XXX
+$CFLAGS << ' ' << ['glib/src'].map do |d|
+  "-I#{File.join(top, d)}"
+end.join(' ')
+
+begin
+  srcdir = File.expand_path(File.dirname($PROGRAM_NAME))
+
+  obj_ext = ".#{$OBJEXT}"
+  $libs = $libs.split(/ /).uniq.join(' ')
+  $source_files = Dir.glob(format('%s/*.c', srcdir)).map do |fname|
+    fname[0, srcdir.length + 1] = ''
+    fname
+  end
+  $objs = $source_files.collect do |item|
+    item.gsub(/.c$/, obj_ext)
+  end
+
+  #
+  # create Makefile
+  #
+  $defs << '-DRUBY_MORANDI_NATIVE_COMPILATION'
+  create_makefile('morandi_native', srcdir)
+  raise Interrupt unless FileTest.exist? 'Makefile'
+
+  File.open('Makefile', 'a') do |mfile|
+    $source_files.each do |e|
+      mfile.print("#{e.gsub(/.c$/, obj_ext)}: #{e}\n")
+    end
+  end
+rescue Interrupt
+  print "  [error] #{$ERROR_INFO}\n"
+end
+# rubocop:enable Style/GlobalVars