kithe 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f3d3c39a3bdccd9fc97f8f5e16c94cf12d4926e7ca50cc5e3343406ad3044d3
-  data.tar.gz: 2bd6fc9c175d4ec213e58460fbb95b5c40b49ca1ae5808e77df26932cf60474a
+  metadata.gz: 4a51da44ba82df89dd84f14a9559de8032d2e026ee666d9dba4e9fb41d05b1b0
+  data.tar.gz: feb995557174e9ef7c2fb6689bb352ec2dd227dc4e98a282d1b639e1d8d11393
 SHA512:
-  metadata.gz: 55c9e6eb14e975a46927fa01b4c7a8a67ca1b804ae7662f2e34e7878ee0a3247b944395edf93e311f7c39b640392ddd5b74a3df77381ba5f761e78f883e48dfa
-  data.tar.gz: 730f6f1d20d45d7973d2c340e15889d6f2b56295f70eec8703a1e1b666ba078357b1d1ec2e34fa14ca5575ff17032f52340ffba3070e2b16e3da35012c5e8d9e
+  metadata.gz: 6de9ece27273199672bc007b229b63707fb4470456091a5f166b1913d6affad22d16ecb2c1a32e5a053459b408a227149ff3b2947ed06e00e2e1408ca6cd9cce
+  data.tar.gz: 1004d59f35ce5a4abdd958fa87891b3e51c6da3e8e65f078a16e74cb99b601b471aaacf895fb5f4f2249cb8a728d78542b66fe656865ae235c8fbd7a8aa2ce27

data/app/characterization/kithe/ffprobe_characterization.rb

@@ -22,6 +22,13 @@ module Kithe
   #
   #     ffprobe_results = FfprobeCharacterization.new(url).ffprobe_hash
   #
+  # The class method .characterize_from_uploader can usefully extract a URL if possible
+  # or else execute with a file, such as from a shrine `add_metadata` block.
+  #
+  #     add_metadata do |source_io, **context|
+  #       Kithe::FfprobeCharacterization.characterize_from_uploader(source_io, context)
+  #     end
+  #
   class FfprobeCharacterization
     class_attribute :ffprobe_command, default: "ffprobe"
     class_attribute :ffprobe_timeout, default: 10

data/app/derivative_transformers/kithe/ffmpeg_extract_jpg.rb

@@ -0,0 +1,97 @@
+require 'tty/command'
+
+module Kithe
+  # Creates a JPG screen capture using ffmpeg, by default with the `thumbnail`
+  # filter to choose a representative frame from the first minute or so.
+  #
+  # @example tempfile = FfmpegExtractJpg.new.call(shrine_uploaded_file)
+  # @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)
+  class FfmpegExtractJpg
+    class_attribute :ffmpeg_command, default: "ffmpeg"
+    attr_reader :start_seconds, :frame_sample_size, :width_pixels
+
+    # @param start_seconds [Integer] seek to this point to find thumbnail. If it's
+    #   after the end of the video, you won't get a thumb back though! [Default 0]
+    #
+    # @param frame_sample_size [Integer] argument passed to ffmpeg thumbnail filter,
+    #   how many frames to sample, starting at start_seconds, to choose representative
+    #   thumbnail. If set to false, thumbnail filter won't be used. If this one
+    #   goes past the end of the video, ffmpeg is fine with it. Set to `false` to
+    #   disable use of ffmpeg sample feature, and just use exact frame at start_seconds.
+    #   [Default 900, around 30 seconds at 30 fps]
+    #
+    # @width_pixels [Integer] output thumb at this width. aspect ratio will be
+    #   maintained. Warning, if it's larger than video original, ffmpeg will
+    #   upscale!  If set to nil, thumb will be output at original video
+    #   resolution. [Default nil]
+    def initialize(start_seconds: 0, frame_sample_size: 900, width_pixels: nil)
+      @start_seconds = start_seconds
+      @frame_sample_size = frame_sample_size
+      @width_pixels = width_pixels
+    end
+
+
+
+    # @param input_arg [String,File,Shrine::UploadedFile] local File; String that
+    #   can be URL or local file path; or Shrine::UploadedFile. If Shrine::UploadedFile,
+    #   we'll try to get a URL from it if we can, otherwise use or make a local tempfile.
+    #   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)
+      if input_arg.kind_of?(Shrine::UploadedFile)
+        if input_arg.respond_to?(:url) && input_arg.url&.start_with?(/https?\:/)
+          _call(input_arg.url)
+        else
+          Shrine.with_file(input_arg) do |local_file|
+            _call(local_file.path)
+          end
+        end
+      elsif input_arg.respond_to?(:path)
+        _call(input_arg.path)
+      else
+        _call(input_arg.to_s)
+      end
+    end
+
+    private
+
+    # Internal implementation, after input has already been normalized to an
+    # string that can be an ffmpeg arg.
+    #
+    # @param ffmpeg_source_arg [String] filepath or URL. ffmpeg can take urls, which
+    # can be very efficient.
+    #
+    # @returns Tempfile pointing to a thumbnail
+    def _call(ffmpeg_source_arg)
+      tempfile = Tempfile.new(['temp_deriv', ".jpg"])
+
+      ffmpeg_args = [ffmpeg_command, "-y"]
+      if start_seconds && start_seconds > 0
+        ffmpeg_args.concat ["-ss", start_seconds.to_i]
+      end
+
+      ffmpeg_args.concat ["-i", ffmpeg_source_arg]
+
+      video_filter_parts = []
+      video_filter_parts << "thumbnail=#{frame_sample_size}" if frame_sample_size
+      video_filter_parts << "scale=#{width_pixels}:-1" if width_pixels
+      if video_filter_parts
+        ffmpeg_args.concat ["-vf", video_filter_parts.join(',')]
+      end
+
+      ffmpeg_args.concat ["-frames:v",  "1"]
+
+      ffmpeg_args << tempfile.path
+
+      TTY::Command.new(printer: :null).run(*ffmpeg_args)
+
+      return tempfile
+    rescue StandardError => e
+      tempfile.unlink if tempfile
+      raise e
+    end
+  end
+end

data/app/models/kithe/asset.rb

@@ -43,48 +43,24 @@ class Kithe::Asset < Kithe::Model
   before_promotion :refresh_metadata_before_promotion
   after_promotion :schedule_derivatives
 
-  # A convenience to call file_attacher.create_persisted_derivatives (from :kithe_derivatives)
-  # to create derivatives with conncurrent access safety, with the :kithe_derivatives
-  # processor argument, to create derivatives defined using kithe_derivative_definitions.
+  # Proxies to file_attacher.kithe_create_derivatives to create kithe managed derivatives.
   #
-  # This is designed for use with kithe_derivatives processor, and has options only relevant
-  # to it, although could be expanded to take a processor argument in the future if needed.
+  # This will include any derivatives you created with in the uploader with kithe
+  # Attacher.define_derivative, as well as any derivative processors you opted into
+  # kithe management with `kithe_include_derivatives_processors` in uploader.
   #
-  # Create derivatives for every definition added to uploader/attacher with kithe_derivatives
-  # `define_derivative`. Ordinarily will create a definition for every definition
-  # that has not been marked `default_create: false`.
+  # This is safe for concurrent updates to the underlying model, the derivatives will
+  # be consistent and not left orphaned.
   #
-  # But you can also pass `only` and/or `except` to customize the list of definitions to be created,
-  # possibly including some that are `default_create: false`.
-  #
-  # create_derivatives should be idempotent. If it has failed having only created some derivatives,
-  # you can always just run it again.
-  #
-  # Will normally re-create derivatives (per existing definitions) even if they already exist,
-  # but pass `lazy: false` to skip creating if a derivative with a given key already exists.
-  # This will use the asset `derivatives` association, so if you are doing this in bulk for several
-  # assets, you should eager-load the derivatives association for efficiency.
-  #
-  # ## Avoiding eager-download
-  #
-  # Additionally, this has a feature to 'trick' shrine into not eager downloading
-  # the original before our kithe_derivatives processor has a chance to decide if it
-  # needs to create any derivatives (based on `lazy` arg), making no-op
-  # create_derivatives so much faster and more efficient, which matters when doing
-  # bulk operations say with our rake task.
-  #
-  # kithe_derivatives processor must then do a Shrine.with_file to make sure
-  # it's a local file, when needed.
-  #
-  # See https://github.com/shrinerb/shrine/issues/470
+  # By default it will create all derivatives configured for default generation,
+  # but you can customize by listing derivative keys with :only and :except options,
+  # and with :lazy option which, if true, only executes derivative creation if
+  # a given derivative doesn't already exist.
   #
+  # See more in docs for kithe at
+  # Shrine::Plugins::KitheDerivativeDefinitions::AttacherMethods#kithe_create_derivatives
   def create_derivatives(only: nil, except: nil, lazy: false)
-    source = file
-    return false unless source
-
-    local_files = file_attacher.process_derivatives(:kithe_derivatives, only: only, except: except, lazy: lazy)
-
-    file_attacher.add_persisted_derivatives(local_files)
+    file_attacher.kithe_create_derivatives(only: only, except: except, lazy: lazy)
   end
 
 
@@ -186,7 +162,8 @@ class Kithe::Asset < Kithe::Model
 
   # called by after_promotion hook
   def schedule_derivatives
-    return unless self.file_attacher.kithe_derivative_definitions.present? # no need to schedule if we don't have any
+    # no need to schedule if we don't have any
+    return unless self.file_attacher.kithe_derivative_definitions.present? || self.file_attacher.kithe_include_derivatives_processors.present?
 
     Kithe::TimingPromotionDirective.new(key: :create_derivatives, directives: file_attacher.promotion_directives) do |directive|
       if directive.inline?

data/lib/kithe/version.rb

@@ -1,3 +1,3 @@
 module Kithe
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

data/lib/shrine/plugins/kithe_derivative_definitions.rb

@@ -5,9 +5,25 @@ class Shrine
         # use Rails class_attribute to conveniently have a class-level place
         # to store our derivative definitions that are inheritable and overrideable.
         # We store it on the Attacher class, because that's where shrine
-        # puts derivative processor definitions, so seems appropriate.
+        # puts derivative processor definitions, so seems appropriate. Normally
+        # not touched directly by non-kithe code.
         uploader::Attacher.class_attribute :kithe_derivative_definitions, instance_writer: false, default: []
 
+        # Kithe exersizes lifecycle control over derivatives, normally just the
+        # shrine processor labelled :kithe_derivatives. But you can opt additional shrine
+        # derivative processors into kithe control by listing their labels in this attribute.
+        #
+        # @example
+        #
+        #     class AssetUploader < Kithe::AssetUploader
+        #       Attacher.kithe_include_derivatives_processors += [:my_processor]
+        #       Attacher.derivatives(:my_processor) do |original|
+        #         derivatives
+        #       end
+        #     end
+        #
+        uploader::Attacher.class_attribute :kithe_include_derivatives_processors, instance_writer: false, default: []
+
         # Register our derivative processor, that will create our registered derivatives,
         # with our custom options.
         #
@@ -31,11 +47,12 @@ class Shrine
         #
         # The most basic definition consists of a derivative key, and a ruby block that
         # takes the original file, transforms it, and returns a ruby File or other
-        # (shrine-compatible) IO-like object. It will usually be done inside a custom Asset
-        # class definition.
+        # (shrine-compatible) IO-like object. It will usually be done inside your custom
+        # AssetUploader class definition.
         #
-        #     class Asset < Kithe::Asset
-        #       define_derivative :thumbnail do |original_file|
+        #     class AssetUploader < Kithe::AssetUploader
+        #       Attacher.define_derivative :thumbnail do |original_file|
+        #         someTempFileOrOtherIo
         #       end
         #     end
         #
@@ -52,7 +69,7 @@ class Shrine
         # will be passed in. You can then get the model object from `attacher.record`, or the
         # original file as a `Shrine::UploadedFile` object with `attacher.file`.
         #
-        #     define_derivative :thumbnail do |original_file, attacher:|
+        #     Attacher.define_derivative :thumbnail do |original_file, attacher:|
         #        attacher.record.title, attacher.file.width, attacher.file.content_type # etc
         #     end
         #
@@ -62,7 +79,7 @@ class Shrine
         # remain, and be accessible, where they were created; there is no built-in solution at present
         # for moving them).
         #
-        #     define_derivative :thumbnail, storage_key: :my_thumb_storage do |original| # ...
+        #     Attacher.define_derivative :thumbnail, storage_key: :my_thumb_storage do |original| # ...
         #
         # You can also set `default_create: false` if you want a particular definition not to be
         # included in a no-arg `asset.create_derivatives` that is normally triggered on asset creation.
@@ -101,6 +118,86 @@ class Shrine
           end.freeze
         end
       end
+
+      module AttacherMethods
+
+
+        # Similar to shrine create_derivatives, but with kithe standards:
+        #
+        # * Will call the :kithe_derivatives processor (that handles any define_derivative definitions),
+        #   plus any processors you've configured with kithe_include_derivatives_processors
+        #
+        # * Uses the methods added by :kithe_persisted_derivatives to add derivatives completely
+        #   concurrency-safely, if the model had it's attachment changed concurrently, you
+        #   won't get derivatives attached that belong to old version of original attachment,
+        #   and won't get any leftover "orphaned" derivatives either.
+        #
+        # The :kithe_derivatives processor has additional logic and options for determining
+        # *which* derivative definitions -- created with `define_deriative` will be executed:
+        #
+        # * Ordinarily will create a definition for every definition that has not been marked
+        #  `default_create: false`.
+        #
+        # * But you can also pass `only` and/or `except` to customize the list of definitions to be created,
+        #   possibly including some that are `default_create: false`.
+        #
+        # * Will normally re-create derivatives (per existing definitions) even if they already exist,
+        #   but pass `lazy: false` to skip creating if a derivative with a given key already exists.
+        #   This will use the asset `derivatives` association, so if you are doing this in bulk for several
+        #   assets, you should eager-load the derivatives association for efficiency.
+        #
+        # If you've added any custom processors with `kithe_include_derivatives_processors`, it's
+        # your responsibility to make them respect those options. See #process_kithe_derivative?
+        # helper method.
+        #
+        # create_derivatives should be idempotent. If it has failed having only created some derivatives,
+        # you can always just run it again.
+        #
+        def kithe_create_derivatives(only: nil, except: nil, lazy: false)
+          return false unless file
+
+          local_files = self.process_derivatives(:kithe_derivatives, only: only, except: except, lazy: lazy)
+
+          # include any other configured processors
+          self.kithe_include_derivatives_processors.each do |processor|
+            local_files.merge!(
+              self.process_derivatives(processor.to_sym, only: only, except: except, lazy: lazy)
+            )
+          end
+
+          self.add_persisted_derivatives(local_files)
+        end
+
+        # a helper method that you can use in your own shrine processors to
+        # handle only/except/lazy guarding logic.
+        #
+        # @return [Boolean] should the `key` be processed based on only/except/lazy conditions?
+        #
+        # @param key [Symbol] derivative key to check for guarded processing
+        # @param only [Array<Symbol>] If present, method will only return true if `key` is included in `only`
+        # @param except [Array<Symbol] If present, method will only return true if `key` is NOT included in `except`
+        # @param lazy [Boolean] If true, method will only return true if derivative key is not already present
+        #   in attacher with a value.
+        #
+        def process_kithe_derivative?(key, **options)
+          key = key.to_sym
+          only = options[:only] && Array(options[:only]).map(&:to_sym)
+          except = options[:except] && Array(options[:except]).map(&:to_sym)
+          lazy = !! options[:lazy]
+
+          (only.nil? ? true : only.include?(key)) &&
+          (except.nil? || ! except.include?(key)) &&
+          (!lazy || !derivatives.keys.include?(key))
+        end
+
+        # Convenience to check #process_kithe_derivative? for multiple keys at once,
+        # @return true if any key returns true
+        #
+        # @example process_any_kithe_derivative?([:thumb_mini, :thumb_large], only: [:thumb_large, :thumb_mega], lazy: true)
+        def process_any_kithe_derivative?(keys, **options)
+          keys.any? { |k| process_kithe_derivative?(k, **options) }
+        end
+      end
     end
     register_plugin(:kithe_derivative_definitions, KitheDerivativeDefinitions)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kithe
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -346,6 +346,7 @@ files:
 - Rakefile
 - app/assets/config/kithe_manifest.js
 - app/characterization/kithe/ffprobe_characterization.rb
+- app/derivative_transformers/kithe/ffmpeg_extract_jpg.rb
 - app/derivative_transformers/kithe/ffmpeg_transformer.rb
 - app/derivative_transformers/kithe/vips_cli_image_to_jpeg.rb
 - app/helpers/kithe/form_helper.rb