Class: Riiif::ImagemagickCommandFactory

Inherits:
Object
  • Object
show all
Defined in:
app/services/riiif/imagemagick_command_factory.rb

Overview

Builds a command to run a transformation using Imagemagick

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, transformation, compression:, sampling_factor:, strip_metadata:) ⇒ ImagemagickCommandFactory

A helper method to instantiate and invoke build

Parameters:

  • path (String) —

    the location of the file

  • transformation (Transformation)
  • compression (Integer) —

    the compression level to use (set 0 for no compression)



24
25
26
27
28
29
30
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 24

def initialize(path, transformation, compression:, sampling_factor:, strip_metadata:)
  @path = path
  @transformation = transformation
  @compression = compression
  @sampling_factor = sampling_factor
  @strip_metadata = strip_metadata
end

Instance Attribute Details

#compression ⇒ Object (readonly)

Returns the value of attribute compression.



32
33
34
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 32

def compression
  @compression
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



32
33
34
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 32

def path
  @path
end

#sampling_factor ⇒ Object (readonly)

Returns the value of attribute sampling_factor.



32
33
34
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 32

def sampling_factor
  @sampling_factor
end

#strip_metadata ⇒ Object (readonly)

Returns the value of attribute strip_metadata.



32
33
34
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 32

def strip_metadata
  @strip_metadata
end

#transformation ⇒ Object (readonly)

Returns the value of attribute transformation.



32
33
34
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 32

def transformation
  @transformation
end

Class Method Details

.build(path, transformation, compression: 85, sampling_factor: '4:2:0', strip_metadata: true) ⇒ String

A helper method to instantiate and invoke build

Parameters:

  • path (String) —

    the location of the file

  • transformation (Transformation)
  • compression (Integer) (defaults to: 85) —

    (85) the compression level to use (set 0 for no compression)

  • sampling_factor (String) (defaults to: '4:2:0') —

    (“4:2:0”) the chroma sample factor (set 0 for no compression)

  • strip_metadata (Boolean) (defaults to: true) —

    (true) do we want to strip EXIF tags?

Returns:

  • (String) —

    a command for running imagemagick to produce the requested output



13
14
15
16
17
18
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 13

def self.build(path, transformation, compression: 85, sampling_factor: '4:2:0', strip_metadata: true)
  new(path, transformation,
      compression: compression,
      sampling_factor: sampling_factor,
      strip_metadata: strip_metadata).build
end

Instance Method Details

#build ⇒ String

Returns a command for running imagemagick to produce the requested output.

Returns:

  • (String) —

    a command for running imagemagick to produce the requested output



35
36
37
 
# File 'app/services/riiif/imagemagick_command_factory.rb', line 35

def build
  [command, crop, size, rotation, colorspace, quality, sampling, metadata, output].join
end