glebtv-paperclip-meta 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e933c878530c4405e4d21a4cbb1816539a18fcb
+  data.tar.gz: 52c6504e74d44134fb5c1d36e870494a324d7def
+SHA512:
+  metadata.gz: 08fa42b9fc2725705c7320ba6554ccdeb658788377275c9fa6114299c108a39cd8f68d4f1b025c6d21b856eafd5f6d15eb9f54bd0cdc91051e499d3b606e268a
+  data.tar.gz: e53c53955fb89f844b66a6e7e7b1d8a294c1f1c4b5960225154b26be3fd692645a50139e8582b7eea238731c315509f2f43cf7887af74ae2accf7119c35b537a

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+.ruby-version
+Gemfile.lock
+pkg/*
+spec/gemfiles/*.lock
+spec/tmp/*/**

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 2.1.4
+  - 2.0.0
+  - 1.9.3
+  - rbx-2
+gemfile:
+  - spec/gemfiles/Gemfile.paperclip-4
+  - spec/gemfiles/Gemfile.paperclip-3
+install:
+  - bundle install --retry=3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+# See paperclip-meta.gemspec
+gemspec
+
+gem 'paperclip'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tee Parham, Alexey Bondar
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Paperclip Meta 
+
+[![Gem Version](https://badge.fury.io/rb/paperclip-meta.svg)](http://rubygems.org/gems/paperclip-meta)
+[![Build Status](https://travis-ci.org/teeparham/paperclip-meta.svg?branch=master)](https://travis-ci.org/teeparham/paperclip-meta)
+
+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 versions 3.x and 4.x.
+
+### Setup
+
+Add paperclip-meta to Gemfile:
+
+```ruby
+gem 'paperclip-meta'
+```
+
+Create migration to add a *_meta column:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+style: {
+  width:  100,
+  height: 100,
+  size:   42000
+}
+```
+
+This hash will be marshaled and base64 encoded before writing to model attribute.
+
+`height`, `width`, and `image_size` methods are provided:
+
+```ruby
+user.avatar.width(:thumb)
+=> 100
+user.avatar.height(:medium)
+=> 200
+user.avatar.image_size
+=> '60x70'
+```
+
+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:
+
+```sh
+bundle
+rake
+```
+
+Test paperclip 3.x:
+
+```sh
+BUNDLE_GEMFILE=./spec/gemfiles/Gemfile.paperclip-3 bundle
+BUNDLE_GEMFILE=./spec/gemfiles/Gemfile.paperclip-3 rake
+```
+
+Test paperclip 4.x:
+
+```sh
+BUNDLE_GEMFILE=./spec/gemfiles/Gemfile.paperclip-4 bundle
+BUNDLE_GEMFILE=./spec/gemfiles/Gemfile.paperclip-4 rake
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.test_files = %w(spec/**/*_spec.rb)
+  t.verbose = false
+end
+
+task default: :spec

data/lib/glebtv-paperclip-meta.rb

@@ -0,0 +1,2 @@
+require 'paperclip-meta'
+

data/lib/paperclip-meta.rb

@@ -0,0 +1,3 @@
+require 'paperclip-meta/version'
+require 'paperclip-meta/railtie'
+require 'paperclip-meta/attachment'

data/lib/paperclip-meta/attachment.rb

@@ -0,0 +1,96 @@
+module Paperclip
+  module Meta
+    module Attachment
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.alias_method_chain :save, :meta_data
+        base.alias_method_chain :post_process_styles, :meta_data
+        base.alias_method_chain :size, :meta_data
+      end
+
+      module InstanceMethods
+        def save_with_meta_data
+          if @queued_for_delete.any? && @queued_for_write.empty?
+            instance_write(:meta, meta_encode({}))
+          end
+          save_without_meta_data
+        end
+
+        def post_process_styles_with_meta_data(*styles)
+          post_process_styles_without_meta_data(*styles)
+          return unless instance.respond_to?(:"#{name}_meta=")
+
+          meta = populate_meta(@queued_for_write)
+          return if meta == {}
+
+          write_meta(meta)
+        end
+
+        # Use meta info for style if required
+        def size_with_meta_data(style = nil)
+          style ? read_meta(style, :size) : size_without_meta_data
+        end
+
+        def height(style = default_style)
+          read_meta style, :height
+        end
+
+        def width(style = default_style)
+          read_meta style, :width
+        end
+
+        # Return image dimesions ("WxH") for given style name. If style name not given,
+        # return dimesions for default_style.
+        def image_size(style = default_style)
+          "#{width(style)}x#{height(style)}"
+        end
+
+        private
+
+        def populate_meta(queue)
+          meta = {}
+          queue.each do |style, file|
+            begin
+              geo = Geometry.from_file file
+              meta[style] = { width: geo.width.to_i, height: geo.height.to_i, size: file.size }
+            rescue Paperclip::Errors::NotIdentifiedByImageMagickError
+              meta[style] = {}
+            end
+          end
+          meta
+        end
+
+        def write_meta(meta)
+          merge_existing_meta_hash meta
+          instance.send("#{name}_meta=", meta_encode(meta))
+        end
+
+        # Return meta data for given style
+        def read_meta(style, item)
+          if instance.respond_to?(:"#{name}_meta") && instance_read(:meta)
+            if (meta = meta_decode(instance_read(:meta)))
+              meta[style] && meta[style][item]
+            end
+          end
+        end
+
+        # Return encoded metadata as String
+        def meta_encode(meta)
+          Base64.encode64(Marshal.dump(meta))
+        end
+
+        # Return decoded metadata as Object
+        def meta_decode(meta)
+          Marshal.load(Base64.decode64(meta))
+        end
+
+        # Retain existing meta values that will not be recalculated when
+        # reprocessing a subset of styles
+        def merge_existing_meta_hash(meta)
+          return unless (original_meta = instance.send("#{name}_meta"))
+          meta.reverse_merge! meta_decode(original_meta)
+        end
+      end
+    end
+  end
+end

data/lib/paperclip-meta/railtie.rb

@@ -0,0 +1,23 @@
+require 'paperclip-meta'
+
+module Paperclip
+  module Meta
+    
+    if defined? ::Rails::Railtie
+      class Railtie < ::Rails::Railtie
+        initializer :paperclip_meta do
+          ActiveSupport.on_load :active_record do
+            Paperclip::Meta::Railtie.insert
+          end
+        end
+      end
+    end
+
+    class Railtie
+      def self.insert
+        Paperclip::Attachment.send(:include, Paperclip::Meta::Attachment)
+      end
+    end
+
+  end
+end

data/lib/paperclip-meta/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Meta
+    VERSION = "1.2.0"
+  end
+end

data/paperclip-meta.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "paperclip-meta/version"
+
+Gem::Specification.new do |s|
+  s.name          = "glebtv-paperclip-meta"
+  s.version       = Paperclip::Meta::VERSION
+  s.authors       = ["Alexey Bondar", "Tee Parham"]
+  s.email         = ["y8@ya.ru", "tee@neighborland.com"]
+  s.homepage      = "http://github.com/teeparham/paperclip-meta"
+  s.summary       = %q{Add width, height, and size to paperclip images}
+  s.description   = %q{Add width, height and size methods to paperclip images}
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_dependency "paperclip", ">= 3.0.2", "< 5.0"
+
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake", "~> 10.1"
+  s.add_development_dependency "mocha", "~> 1.0"
+  s.add_development_dependency "activerecord", ">= 4.0"
+
+  # sqlite3 1.3.9 does not work with rubinius 2.2.5:
+  # https://github.com/sparklemotion/sqlite3-ruby/issues/122
+  s.add_development_dependency "sqlite3", "1.3.8"
+end

data/spec/attachment_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe "Attachment" do
+  it "saves image geometry for original image" do
+    img = Image.create(small_image: small_image)
+    img.reload
+    geometry = geometry_for(small_path)
+    assert_equal geometry.width, img.small_image.width
+    assert_equal geometry.height, img.small_image.height
+    assert_equal "50x64", img.small_image.image_size
+  end
+
+  it "saves geometry for styles" do
+    img = Image.create(small_image: small_image, big_image: big_image)
+    assert_equal 100, img.big_image.width(:thumb)
+    assert_equal 100, img.big_image.height(:thumb)
+  end
+
+  it "saves original style geometry" do
+    img = Image.create(small_image: small_image)
+    assert_equal 50, img.small_image.width(:original)
+    assert_equal 64, img.small_image.height(:original)
+  end
+
+  it "sets geometry on update" do
+    img = Image.create!
+    img.small_image = small_image
+    img.save
+    geometry = geometry_for(small_path)
+    assert_equal geometry.width, img.small_image.width
+    assert_equal geometry.height, img.small_image.height
+  end
+
+  describe '#size' do
+    before do
+      @image = Image.create(big_image: big_image)
+    end
+
+    it 'should save file size with meta data ' do
+      path = File.join(File.dirname(__FILE__), "tmp/fixtures/tmp/thumb/#{@image.id}.jpg")
+      size = File.stat(path).size
+      assert_equal size, @image.big_image.size(:thumb)
+    end
+
+    it 'should access normal paperclip method when no style passed' do
+      @image.big_image.expects size_without_meta_data: 1234
+      assert_equal 1234, @image.big_image.size
+    end
+
+    it 'should have access to original file size' do
+      assert_equal 37042, @image.big_image.size
+    end
+  end
+
+  it "clears geometry fields when image is destroyed" do
+    img = Image.create(small_image: small_image, big_image: big_image)
+    assert_equal 100, img.big_image.width(:thumb)
+    img.big_image = nil
+    img.save!
+    assert_nil img.big_image.width(:thumb)
+  end
+
+  it "does not save when file is not an image" do
+    img = Image.new
+    img.small_image = not_image
+    refute img.save
+    assert_nil img.small_image.width
+  end
+
+  it "returns nil attributes when file is not an image" do
+    img = ImageWithNoValidation.new
+    img.small_image = not_image
+    img.save!
+    assert_nil img.small_image.width
+    assert_nil img.small_image.height
+  end
+
+  it "preserves metadata when reprocessing a specific style" do
+    img = Image.new
+    img.big_image = big_image
+    img.save!
+    assert_equal 500, img.big_image.width(:large)
+    img.big_image.reprocess!(:thumb)
+    assert_equal 500, img.big_image.width(:large)
+  end
+
+  it "preserves metadata for unprocessed styles" do
+    img = Image.new
+    img.big_image = big_image
+    img.save!
+
+    # set big image meta to fake values for :large & missing :thumb
+    hash = { large: { height: 1, width: 2, size: 3 } }
+    img.update_column(:big_image_meta, img.big_image.send(:meta_encode, hash))
+
+    assert_equal 1, img.big_image.height(:large)
+    assert_equal 2, img.big_image.width(:large)
+    assert_equal 3, img.big_image.size(:large)
+    assert_nil img.big_image.height(:thumb)
+    assert_nil img.big_image.height(:original)
+    img.big_image.reprocess!(:thumb)
+    assert_equal 1, img.big_image.height(:large)
+    assert_equal 2, img.big_image.width(:large)
+    assert_equal 3, img.big_image.size(:large)
+    assert_equal 100, img.big_image.height(:thumb)
+    assert_equal 100, img.big_image.width(:thumb)
+    assert_equal 277, img.big_image.height(:original) # original is always reprocessed
+  end
+
+  it "replaces metadata when attachment changes" do
+    img = Image.new
+    img.big_image = big_image
+    img.save!
+    img.big_image = small_image
+    img.save!
+    assert_equal "50x64", img.big_image.image_size
+    assert_equal "100x100", img.big_image.image_size(:thumb)
+    assert_equal "500x500", img.big_image.image_size(:large)
+  end
+
+  private
+
+  def small_path
+    File.join(File.dirname(__FILE__), 'fixtures', 'small.png')
+  end
+
+  # 50x64
+  def small_image
+    File.open(small_path)
+  end
+
+  def geometry_for(path)
+    Paperclip::Geometry.from_file(path)
+  end
+
+  # 600x277
+  def big_image
+    File.open(File.join(File.dirname(__FILE__), 'fixtures', 'big.jpg'))
+  end
+
+  def not_image
+    File.open(File.join(File.dirname(__FILE__), 'fixtures', 'big.zip'))
+  end
+end

data/spec/gemfiles/Gemfile.paperclip-3

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+platforms :rbx do
+  gem 'json'
+  gem 'rubysl', '~> 2.0'
+end
+
+# See paperclip-meta.gemspec
+gemspec path: '../..'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'minitest', '~> 4.7'
+gem 'paperclip', '~> 3.5'

data/spec/gemfiles/Gemfile.paperclip-4

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+platforms :rbx do
+  gem 'json'
+  gem 'rubysl', '~> 2.0'
+end
+
+# See paperclip-meta.gemspec
+gemspec path: '../..'
+
+gem 'activerecord', '~> 4.1'
+gem 'minitest', '~> 5.3'
+gem 'paperclip', '~> 4.0'

data/spec/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+  create_table :images do |t|
+    t.string  :small_image_file_name
+    t.string  :small_image_content_type
+    t.integer :small_image_updated_at
+    t.integer :small_image_file_size
+    t.string  :small_image_meta
+
+    t.string  :big_image_file_name
+    t.string  :big_image_content_type
+    t.integer :big_image_updated_at
+    t.integer :big_image_file_size
+    t.string  :big_image_meta
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'bundler/setup'
+Bundler.require(:default)
+require 'active_record'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+if ENV["VERBOSE"]
+  ActiveRecord::Base.logger = Logger.new(STDERR)
+else
+  Paperclip.options[:log] = false
+end
+
+load(File.join(File.dirname(__FILE__), 'schema.rb'))
+
+ActiveRecord::Base.send(:include, Paperclip::Glue)
+Paperclip::Meta::Railtie.insert
+
+I18n.enforce_available_locales = true
+
+class Image < ActiveRecord::Base
+  has_attached_file :small_image,
+    storage: :filesystem,
+    path: "./spec/tmp/:style/:id.:extension",
+    url: "./spec/tmp/:style/:id.extension"
+
+  has_attached_file :big_image,
+    storage: :filesystem,
+    path: "./spec/tmp/fixtures/tmp/:style/:id.:extension",
+    url: "./spec/tmp/fixtures/tmp/:style/:id.extension",
+    styles: { thumb: "100x100#", large: "500x500#" }
+
+  # paperclip 4.0 requires a validator
+  validates_attachment_content_type :small_image, content_type: /\Aimage/
+  validates_attachment_content_type :big_image, content_type: /\Aimage/
+end
+
+class ImageWithNoValidation < ActiveRecord::Base
+  self.table_name = :images
+
+  has_attached_file :small_image,
+    storage: :filesystem,
+    path: "./spec/tmp/:style/:id.:extension",
+    url: "./spec/tmp/:style/:id.extension"
+
+  if Paperclip::VERSION >= "4.0"
+    do_not_validate_attachment_file_type :small_image
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: glebtv-paperclip-meta
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Alexey Bondar
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+description: Add width, height and size methods to paperclip images
+email:
+- y8@ya.ru
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/glebtv-paperclip-meta.rb
+- lib/paperclip-meta.rb
+- lib/paperclip-meta/attachment.rb
+- lib/paperclip-meta/railtie.rb
+- lib/paperclip-meta/version.rb
+- paperclip-meta.gemspec
+- spec/attachment_spec.rb
+- spec/fixtures/big.jpg
+- spec/fixtures/big.zip
+- spec/fixtures/small.png
+- spec/gemfiles/Gemfile.paperclip-3
+- spec/gemfiles/Gemfile.paperclip-4
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: http://github.com/teeparham/paperclip-meta
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Add width, height, and size to paperclip images
+test_files:
+- spec/attachment_spec.rb
+- spec/fixtures/big.jpg
+- spec/fixtures/big.zip
+- spec/fixtures/small.png
+- spec/gemfiles/Gemfile.paperclip-3
+- spec/gemfiles/Gemfile.paperclip-4
+- spec/schema.rb
+- spec/spec_helper.rb