Module: ImageProcessing::Chainable
- Included in:
- Builder, MiniMagick, Vips
- Defined in:
- lib/image_processing/chainable.rb
Overview
Implements a chainable interface for building processing options.
Instance Method Summary collapse
-
#apply(operations) ⇒ Object
Add multiple operations as a hash or an array.
-
#branch(**new_options) ⇒ Object
Creates a new builder object, merging current options with new options.
-
#call(file = nil, destination: nil, **call_options) ⇒ Object
Call the defined processing and get the result.
-
#convert(format) ⇒ Object
Specify the output format.
-
#instrumenter(&block) ⇒ Object
Register instrumentation block that will be called around the pipeline.
-
#loader(**options) ⇒ Object
Specify processor options applied when loading the image.
-
#operation(name, *args, &block) ⇒ Object
Add an operation defined by the processor.
-
#saver(**options) ⇒ Object
Specify processor options applied when saving the image.
-
#source(file) ⇒ Object
Specify the source image file.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(name, *args, &block) ⇒ Object (private)
Assume that any unknown method names an operation supported by the processor. Add a bang (“!”) if you want processing to be performed.
86 87 88 89 90 91 |
# File 'lib/image_processing/chainable.rb', line 86 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 |
Instance Method Details
#apply(operations) ⇒ Object
Add multiple operations as a hash or an array.
.apply(resize_to_limit: [400, 400], strip: true)
# or
.apply([[:resize_to_limit, [400, 400]], [:strip, true])
34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/image_processing/chainable.rb', line 34 def apply(operations) operations.inject(self) do |builder, (name, argument)| if argument == true || argument == nil builder.public_send(name) elsif argument.is_a?(Array) builder.public_send(name, *argument) elsif argument.is_a?(Hash) builder.public_send(name, **argument) else builder.public_send(name, argument) end end end |
#branch(**new_options) ⇒ Object
Creates a new builder object, merging current options with new options.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/image_processing/chainable.rb', line 64 def branch(**) if self.is_a?(Builder) = self. else = DEFAULT_OPTIONS.merge(processor: self::Processor) end = .merge() 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(.freeze) end |
#call(file = nil, destination: nil, **call_options) ⇒ Object
Call the defined processing and get the result. Allows specifying the source file and destination.
55 56 57 58 59 60 61 |
# File 'lib/image_processing/chainable.rb', line 55 def call(file = nil, destination: nil, **) = {} [:source] = file if file [:destination] = destination if destination branch(**).call!(**) end |
#convert(format) ⇒ Object
Specify the output format.
10 11 12 |
# File 'lib/image_processing/chainable.rb', line 10 def convert(format) branch format: format end |
#instrumenter(&block) ⇒ Object
Register instrumentation block that will be called around the pipeline.
25 26 27 |
# File 'lib/image_processing/chainable.rb', line 25 def instrumenter(&block) branch instrumenter: block end |
#loader(**options) ⇒ Object
Specify processor options applied when loading the image.
15 16 17 |
# File 'lib/image_processing/chainable.rb', line 15 def loader(**) branch loader: end |
#operation(name, *args, &block) ⇒ Object
Add an operation defined by the processor.
49 50 51 |
# File 'lib/image_processing/chainable.rb', line 49 def operation(name, *args, &block) branch operations: [[name, args, *block]] end |
#saver(**options) ⇒ Object
Specify processor options applied when saving the image.
20 21 22 |
# File 'lib/image_processing/chainable.rb', line 20 def saver(**) branch saver: end |
#source(file) ⇒ Object
Specify the source image file.
5 6 7 |
# File 'lib/image_processing/chainable.rb', line 5 def source(file) branch source: file end |