kithe 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5645f9d91b50b696549832f856cbf71513277a60061355fb8a0a222d60a3e9
-  data.tar.gz: ed4b468d9b54650893feec779c392aaaaaff68b39d85e204dc0586f63235d381
+  metadata.gz: f3f74f2e5dc57d427f37635095e328d2dddd1498b86c85e153a126a8145308a5
+  data.tar.gz: 0ba6e1d1b075f3f3da6e9a6f697b354eb3b761dfb2c6e873e14e0e5e5a2782d3
 SHA512:
-  metadata.gz: 4735e34556bad2004975cfef891eb87f597d3a2b7b32c6b8b3a154b1b363ba1c54a353481691215542ecfb02e3b63b212ae3a648e230ef83a1dba56da269285c
-  data.tar.gz: 7b882426a155de5afb191af8accdfa36fa6194c768aff83759823e3d9ffb9d5d66c1a6974c575a91153f30e3797b6a8e9bec59500357a1fa3a460e00440be5c5
+  metadata.gz: 25fcab14c568fee5937de11be81fb534bfcc6329dba65c8d2da64739828af036a7890a497feba71d22ee0ca1b02f8ac270b4c6703d7270bade63b2d7cfb509ac
+  data.tar.gz: 9484fb022d18b0ab20203f368de6b7d65ec4871c57571c1f0b8a34733431bc8414b250ecb5eba3730435d27cf50e248ea27e56252d3e16c010fd5f3f936eeb32

data/README.md

@@ -1,7 +1,8 @@
 # Kithe
 An experiment in shareable tools/components for building a digital collections app in Rails.
 
-[![Build Status](https://github.com/sciencehistory/kithe/workflows/CI/badge.svg?branch=master)](https://github.com/sciencehistory/kithe/actions?query=workflow%3ACI+branch%3Amaster) [![Gem Version](https://badge.fury.io/rb/kithe.svg)](https://badge.fury.io/rb/kithe)
+[![CI](https://github.com/sciencehistory/kithe/actions/workflows/ci.yml/badge.svg)](https://github.com/sciencehistory/kithe/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/kithe.svg)](https://badge.fury.io/rb/kithe)
 
 ## What is kithe?
 

data/app/derivative_transformers/kithe/ffmpeg_extract_jpg.rb

@@ -8,6 +8,10 @@ module Kithe
   # @example tempfile = FfmpegExtractJpg.new.call(url)
   # @example tempfile = FfmpegExtractJpg.new(start_seconds: 60).call(shrine_uploaded_file)
   # @example tempfile = FfmpegExtractJpg.new(start_seconds: 10, width_pixels: 420).call(shrine_uploaded_file)
+  #
+  # @example you can also provide a Hash which will be mutated with metadata relevant to
+  # the derivative created, ffmpeg version and args:
+  #     @example tempfile = FfmpegExtractJpg.new(start_seconds: 10, width_pixels: 420).call(shrine_uploaded_file, add_metadata: my_hash)
   class FfmpegExtractJpg
     class_attribute :ffmpeg_command, default: "ffmpeg"
     attr_reader :start_seconds, :frame_sample_size, :width_pixels
@@ -43,19 +47,19 @@ module Kithe
     #   Most efficient is if we have a remote URL to give ffmpeg, one way or another!
     #
     # @returns [Tempfile] jpg extracted from movie
-    def call(input_arg)
+    def call(input_arg, add_metadata:nil)
       if input_arg.kind_of?(Shrine::UploadedFile)
         if input_arg.respond_to?(:url) && input_arg.url&.start_with?(/https?\:/)
-          _call(input_arg.url)
+          _call(input_arg.url, add_metadata: add_metadata)
         else
           Shrine.with_file(input_arg) do |local_file|
-            _call(local_file.path)
+            _call(local_file.path, add_metadata: add_metadata)
           end
         end
       elsif input_arg.respond_to?(:path)
-        _call(input_arg.path)
+        _call(input_arg.path, add_metadata: add_metadata)
       else
-        _call(input_arg.to_s)
+        _call(input_arg.to_s, add_metadata: add_metadata)
       end
     end
 
@@ -67,14 +71,26 @@ module Kithe
     # @param ffmpeg_source_arg [String] filepath or URL. ffmpeg can take urls, which
     # can be very efficient.
     #
+    # @param add_metadata [Hash], optional, if provided will be filled out with metadata
+    # relevant to the derivative created -- ffmpeg version and args.
+    #
     # @returns Tempfile pointing to a thumbnail
-    def _call(ffmpeg_source_arg)
+    def _call(ffmpeg_source_arg, add_metadata: nil)
       tempfile = Tempfile.new(['temp_deriv', ".jpg"])
 
       ffmpeg_args = produce_ffmpeg_args(input_arg: ffmpeg_source_arg, output_path: tempfile.path)
 
       TTY::Command.new(printer: :null).run(*ffmpeg_args)
 
+      if add_metadata
+        add_metadata[:ffmpeg_command] = ffmpeg_args.join(" ")
+
+        `#{ffmpeg_command} -version` =~ /ffmpeg version (\d+\.\d+.*) Copyright/
+        if $1
+          add_metadata[:ffmpeg_version] = $1
+        end
+      end
+
       return tempfile
     rescue StandardError => e
       tempfile.unlink if tempfile

data/app/derivative_transformers/kithe/ffmpeg_transformer.rb

@@ -39,13 +39,23 @@ module Kithe
     end
 
     # Will raise TTY::Command::ExitError if the ffmpeg returns non-null.
-    def call(original_file)
+    def call(original_file, add_metadata: nil)
       tempfile = Tempfile.new(['temp_deriv', ".#{@output_suffix}"])
       # -y tells ffmpeg to overwrite the abovementioned tempfile (still empty)
       # with the output of ffmpeg.
       ffmpeg_args =  [ffmpeg_command, "-y", "-i", original_file.path]
       ffmpeg_args += transform_arguments + [tempfile.path]
-      TTY::Command.new(printer: :null).run(*ffmpeg_args)
+      out, err = TTY::Command.new(printer: :null).run(*ffmpeg_args)
+
+      if add_metadata
+        add_metadata[:ffmpeg_command] = ffmpeg_args.join(" ")
+
+        `#{ffmpeg_command} -version` =~ /ffmpeg version (\d+\.\d+.*) Copyright/
+        if $1
+          add_metadata[:ffmpeg_version] = $1
+        end
+      end
+
       return tempfile
     end
   end

data/app/derivative_transformers/kithe/vips_cli_image_to_jpeg.rb

@@ -19,8 +19,8 @@ module Kithe
   # built for use with kithe derivatives transformations, eg:
   #
   #     class Asset < KitheAsset
-  #       define_derivative(thumb) do |original_file|
-  #         Kithe::VipsCliImageToJpeg.new(max_width: 100, thumbnail_mode: true).call(original_file)
+  #       Attacher.define_derivative(:thumb) do |original_file, add_metadata:|
+  #         Kithe::VipsCliImageToJpeg.new(max_width: 100, thumbnail_mode: true).call(original_file, add_metadata: add_metadata)
   #       end
   #     end
   #
@@ -28,8 +28,11 @@ module Kithe
   # about ruby memory leaks or the GIL. An alternative that uses vips ruby bindings
   # would also be possible, and might work well, but this is what for us is tried
   # and true.
+  #
+  # Some usage suggestions at https://www.libvips.org/API/current/Using-vipsthumbnail.html
   class VipsCliImageToJpeg
-    class_attribute :srgb_profile_path, default: Kithe::Engine.root.join("lib", "vendor", "icc", "sRGB2014.icc").to_s
+    # vips has a built-in srgb profile, don't need our own anymore.
+    #class_attribute :srgb_profile_path, default: Kithe::Engine.root.join("lib", "vendor", "icc", "sRGB2014.icc").to_s
     class_attribute :vips_thumbnail_command, default: "vipsthumbnail"
     class_attribute :vips_command, default: "vips"
 
@@ -47,7 +50,7 @@ module Kithe
     end
 
     # Will raise TTY::Command::ExitError if the external Vips command returns non-null.
-    def call(original_file)
+    def call(original_file, add_metadata: nil)
       tempfile = Tempfile.new(["kithe_vips_cli_image_to_jpeg", ".jpg"])
 
       vips_args = []
@@ -59,7 +62,7 @@ module Kithe
         # really huge one million pixels so it should not come into play, and
         # we're constraining proportionally by width.
         # https://github.com/jcupitt/libvips/issues/781
-        vips_args.concat [vips_thumbnail_command, original_file.path]
+        vips_args.concat [vips_thumbnail_command, "--version", original_file.path]
         vips_args.concat maybe_profile_normalization_args
         vips_args.concat ["--size", "#{max_width}x65500"]
         vips_args.concat ["-o", "#{tempfile.path}#{vips_jpg_params}"]
@@ -72,7 +75,16 @@ module Kithe
         vips_args.concat ["#{tempfile.path}#{vips_jpg_params}"]
       end
 
-      TTY::Command.new(printer: :null).run(*vips_args)
+      out, err = TTY::Command.new(printer: :null).run(*vips_args)
+
+      if add_metadata
+        add_metadata[:vips_command] = vips_args.join(" ")
+
+        out =~ /vips[ \-](\d+\.\d+\.\d+.*$)/
+        if $1
+          add_metadata[:vips_version] = $1
+        end
+      end
 
       return tempfile
     end
@@ -88,7 +100,7 @@ module Kithe
     def maybe_profile_normalization_args
       return [] unless thumbnail_mode?
 
-      ["--eprofile", srgb_profile_path, "--delete"]
+      ["--export-profile", "srgb"]
     end
 
     # Params to add on to end of JPG output path, as in:
@@ -103,7 +115,7 @@ module Kithe
     # @returns [String]
     def vips_jpg_params
       if thumbnail_mode?
-        "[Q=#{jpeg_q},interlace,optimize_coding,strip]"
+        "[Q=#{jpeg_q},interlace,optimize_coding,keep=none]"
       else
         # could be higher Q for downloads if we want, but we don't right now
         # We do avoid striping metadata, no 'strip' directive.

data/app/models/kithe/asset/derivative_definition.rb

@@ -9,12 +9,32 @@ class Kithe::Asset::DerivativeDefinition
     @proc = proc
   end
 
+  # @return [Hash] add_metadata hash of metadata to add to derivative on storage
   def call(original_file:,attacher:)
+    add_metadata = {}
+    kwargs = {}
+
     if proc_accepts_keyword?(:attacher)
-      proc.call(original_file, attacher: attacher)
+      kwargs[:attacher] = attacher
+    end
+
+    if proc_accepts_keyword?(:add_metadata)
+      kwargs[:add_metadata] = add_metadata
+    end
+
+    return_val = if kwargs.present?
+      proc.call(original_file, **kwargs)
     else
       proc.call(original_file)
     end
+
+    # Save in context to later write to actual stored derivative metadata
+    if add_metadata.present?
+      attacher.context[:add_metadata] ||= {}
+      attacher.context[:add_metadata][key] = add_metadata
+    end
+
+    return_val
   end
 
   # Do content-type restrictions defined for this definition match a given asset?

data/lib/kithe/version.rb

@@ -1,3 +1,3 @@
 module Kithe
-  VERSION = '2.16.0'
+  VERSION = '2.17.0'
 end

data/lib/shrine/plugins/kithe_derivatives.rb

@@ -32,9 +32,13 @@ class Shrine
 
       module InstanceMethods
 
-        # Override to fix "filename" metadata to be something reasonable, regardless
+        # 1. Override to fix "filename" metadata to be something reasonable, regardless
         # of what if anything was the filename of the IO being attached. shrine S3 will
-        # insist on setting a default content-disposition with this filename.
+        # insist on setting a default content-disposition with this filename, so we
+        # can use that.
+        #
+        # 2. Set any specified derivative metadata on derivative. Specified add_metadata
+        # found in context.
         def extract_metadata(io, derivative:nil, **context)
           result = super
 
@@ -43,6 +47,15 @@ class Shrine
             result["filename"] = "#{context[:record].friendlier_id}_#{derivative}.#{extension}"
           end
 
+          # If derivative, add timestamp and any specified extra data
+          if derivative
+            result["created_at"] ||= Time.current.utc.iso8601.to_s
+
+            if (metadata = context.dig(:add_metadata, derivative)).present?
+              result.merge!(metadata.stringify_keys)
+            end
+          end
+
           result
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kithe
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails