image_processing 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e463ca2dcdc1e674b551a94acdfa2495677dd4fd17a79cbaf351727700cddf6
-  data.tar.gz: 7970e3a7d1d8d70ab3291f7c3e892f1b2ebff9181bb74cc2ff4b1f36f9b39b80
+  metadata.gz: 0e86e76046f3b8e0b9fd36a71d52b158a923c75f33848692de1e199ecb17366f
+  data.tar.gz: 7267f19b5cb3224a61e04be0a0d3b3f17d353750a1a522a11f2912b9ba49b809
 SHA512:
-  metadata.gz: a19939f654334cde66d3ae6c8bb451d1152a1f7e8385507b9649e88b151e99ed6c9005ed861e43c2d9c836327d93699685d74196b92c4b81e38c5d94abe545e5
-  data.tar.gz: 292f1463f86eae88987dcc2dbe8d8e60ec458f9c33c41c1e1349a5dbadea12ba730ffde697158e239e64c28c14d0d14dc0c617ee439fe7380e73f0135dfecfd7
+  metadata.gz: 473958a39a8e760cdb9d352399190f1cdea0dcd915ad729ec740fb7f424dc05041c43fe1085439c0f54763c388b83c2b7dcf32f66cc15caa9dbc0f21c325a166
+  data.tar.gz: ac3cc41432e9dc786035f77c721eb1407c84c6307fccc9d8f01f42ca909618229134411f503eeeb770809f620804468750414e6dc8900c442a46d08d3d02e660

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.12.0 (2020-09-20)
+
+* Add instrumentation support via `#instrumenter` (@janko)
+
 ## 1.11.0 (2020-05-17)
 
 * [minimagick] Handle destination format having no file extension (@janko)

data/README.md

@@ -148,6 +148,34 @@ You can continue reading the API documentation for specific modules:
 See the **[wiki]** for additional "How To" guides for common scenarios. The wiki
 is publicly editable, so you're encouraged to add your own guides.
 
+## Instrumentation
+
+You can register an `#instrumenter` block for a given pipeline, which will wrap
+the pipeline execution, allowing you to record performance metrics.
+
+```rb
+pipeline = ImageProcessing::Vips.instrumenter do |**options, &processing|
+  options[:source]     #=> #<File:...>
+  options[:loader]     #=> { fail: true }
+  options[:saver]      #=> { quality: 85 }
+  options[:format]     #=> "png"
+  options[:operations] #=> [[:resize_to_limit, 500, 500], [:flip, [:horizontal]]]
+  options[:processor]  #=> ImageProcessing::Vips::Processor
+
+  ActiveSupport::Notifications.instrument("process.image_processing", **options) do
+    processing.call # calls the pipeline
+  end
+end
+
+pipeline
+  .source(image)
+  .loader(fail: true)
+  .saver(quality: 85)
+  .convert("png")
+  .resize_to_limit(500, 500)
+  .flip(:horizontal)
+  .call # calls instrumenter
+```
 
 ## Contributing
 

data/lib/image_processing/builder.rb

@@ -9,8 +9,24 @@ module ImageProcessing
     end
 
     # Calls the pipeline to perform the processing from built options.
-    def call!(**options)
-      Pipeline.new(self.options).call(**options)
+    def call!(**call_options)
+      instrument do
+        Pipeline.new(pipeline_options).call(**call_options)
+      end
+    end
+
+    private
+
+    def instrument
+      return yield unless options[:instrumenter]
+
+      result = nil
+      options[:instrumenter].call(**pipeline_options) { result = yield }
+      result
+    end
+
+    def pipeline_options
+      options.reject { |key, _| key == :instrumenter }
     end
   end
 end

data/lib/image_processing/chainable.rb

@@ -21,6 +21,11 @@ module ImageProcessing
       branch saver: options
     end
 
+    # Register instrumentation block that will be called around the pipeline.
+    def instrumenter(&block)
+      branch instrumenter: block
+    end
+
     # Add multiple operations as a hash or an array.
     #
     #   .apply(resize_to_limit: [400, 400], strip: true)
@@ -40,16 +45,6 @@ module ImageProcessing
       end
     end
 
-    # Assume that any unknown method names an operation supported by the
-    # processor. Add a bang ("!") if you want processing to be performed.
-    def method_missing(name, *args, &block)
-      return super if name.to_s.end_with?("?")
-      return send(name.to_s.chomp("!"), *args, &block).call if name.to_s.end_with?("!")
-
-      operation(name, *args, &block)
-    end
-    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
-
     # Add an operation defined by the processor.
     def operation(name, *args, &block)
       branch operations: [[name, args, *block]]
@@ -58,27 +53,41 @@ module ImageProcessing
     # Call the defined processing and get the result. Allows specifying
     # the source file and destination.
     def call(file = nil, destination: nil, **call_options)
-      options = {}
-      options = options.merge(source: file) if file
-      options = options.merge(destination: destination) if destination
+      options = { source: file, destination: destination }.compact
 
       branch(**options).call!(**call_options)
     end
 
     # Creates a new builder object, merging current options with new options.
-    def branch(loader: nil, saver: nil, operations: nil, **other_options)
-      options = respond_to?(:options) ? self.options : DEFAULT_OPTIONS
+    def branch(**new_options)
+      if self.is_a?(Builder)
+        options = self.options
+      else
+        options = DEFAULT_OPTIONS.merge(processor: self::Processor)
+      end
 
-      options = options.merge(loader: options[:loader].merge(loader)) if loader
-      options = options.merge(saver: options[:saver].merge(saver)) if saver
-      options = options.merge(operations: options[:operations] + operations) if operations
-      options = options.merge(processor: self::Processor) unless self.is_a?(Builder)
-      options = options.merge(other_options)
+      options = options.merge(new_options) do |key, old_value, new_value|
+        case key
+        when :loader, :saver then old_value.merge(new_value)
+        when :operations     then old_value + new_value
+        else                      new_value
+        end
+      end
+
+      Builder.new(options.freeze)
+    end
+
+    private
 
-      options.freeze
+    # Assume that any unknown method names an operation supported by the
+    # processor. Add a bang ("!") if you want processing to be performed.
+    def method_missing(name, *args, &block)
+      return super if name.to_s.end_with?("?")
+      return send(name.to_s.chomp("!"), *args, &block).call if name.to_s.end_with?("!")
 
-      Builder.new(options)
+      operation(name, *args, &block)
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
 
     # Empty options which the builder starts with.
     DEFAULT_OPTIONS = {

data/lib/image_processing/version.rb

@@ -1,3 +1,3 @@
 module ImageProcessing
-  VERSION = "1.11.0"
+  VERSION = "1.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_processing
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick