Sha256: 7cb3978ac3cd56c292a1dadad2464f4d340f40fd33ff3d3ba4252820eb154769
Contents?: true
Size: 1.64 KB
Versions: 60
Compression:
Stored size: 1.64 KB
Contents
Encoding
========
Registered encoders change the format of data, e.g. a jpeg image to a png image.
You can register as many encoders as you like.
Let's say we have a Dragonfly app
app = Dragonfly[:images]
and an image object (actually a {Dragonfly::Job Job} object)...
image = app.fetch('some/uid')
...OR a Dragonfly model accessor...
image = @album.cover_image
We can encode it to any format registered with the encoder.
Lazy evaluation
---------------
gif_image = image.encode(:gif)
doesn't actually do anything until you call something on the returned {Dragonfly::Job Job} object, like `url`, `data`, etc.
Bang method
-----------
image.encode!(:gif)
modifies the image object itself, rather than returning a new object.
ImageMagick Encoder
-------------------
See {file:ImageMagick}.
Custom Encoders
---------------
To register a custom encoder, for e.g. pdf format:
app.encoder.add do |temp_object, format|
throw :unable_to_handle unless format == :pdf
# use temp_object.data, temp_object.path, temp_object.file, etc.
SomeLibrary.convert_to_pdf(temp_object.data)
# return a String, Pathname, File or Tempfile
end
pdf_image = image.encode(:pdf)
If `:unable_to_handle` is thrown, the next most recently registered encoder is used, and so on.
Alternatively you can create a class like the ImageMagick one above, which implements the method `encode`, and register this.
class MyEncoder
def encode(temp_object, format, *args)
SomeLib.encode(temp_object.data, format, *args)
end
end
app.encoder.register(MyEncoder)
pdf_image = image.encode(:pdf, :some => :args)
Version data entries
60 entries across 60 versions & 3 rubygems