teeparham / paperclip-meta

Adds width, height, and size to paperclip images.
MIT License
158 stars 97 forks source link
images paperclip rails ruby

Paperclip Meta

Gem Version Build Status

Add width, height, and size to paperclip images.

Paperclip Meta gets image dimensions after post_process_styles using paperclip's Geometry.from_file.

Paperclip Meta works with paperclip version 5.x and 6.x.

Version 2.x works with paperclip version 4.x.

Setup

Add paperclip-meta to Gemfile:

gem 'paperclip-meta'

Create migration to add a *_meta column:

class AddAvatarMetaToUsers < ActiveRecord::Migration
  def change
    add_column :users, :avatar_meta, :text
  end
end

Rebuild all thumbnails to populate the meta column if you already have some attachments.

Now you can grab the size from the paperclip attachment:

image_tag user.avatar.url, size: user.avatar.image_size
image_tag user.avatar.url(:medium), size: user.avatar.image_size(:medium)
image_tag user.avatar.url(:thumb), size: user.avatar.image_size(:thumb)

Internals

The meta column is simple hash:

style: {
  width:  100,
  height: 100,
  size:   42000
}

This hash will be marshaled and base64 encoded before writing to model attribute.

height, width, image_size and aspect_ratio methods are provided:

user.avatar.width(:thumb)
=> 100
user.avatar.height(:medium)
=> 200
user.avatar.image_size
=> '60x70'
user.avatar.aspect_ratio
=> 1.5

You can pass the image style to these methods. If a style is not passed, the default style will be used.

Alternatives

https://github.com/thoughtbot/paperclip/wiki/Extracting-image-dimensions

Development

Test:

bundle
bundle exec rake