kt-paperclip-meta 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bed9b326c596d715bf8cafddbdddd7a470573f1756eac2792d08797af3a8400
+  data.tar.gz: e95ee154e940a9c93e7119fa250fb779e9d28c60238e366f7bdca042bf2ebdfd
+SHA512:
+  metadata.gz: a55114fd5c54d518abbf5479b61aab93bfa2405db457f4172525e9f0a8ac73bb64aceb635bfee80b2c9520a8796b56f27a0eaa82899d0b87aa50d83f8956e3a7
+  data.tar.gz: 8f4b4ff01c4ceba470f38811980921af9dbd224cc7dc5760a09cae8535085b879d4a5316e5e20a202ade1cf9e2c981101074cce2d3fdff97895d533bef55b756

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2014 Tee Parham, Alexey Bondar
+Modifications Copyright (c) 2024 Paul Nicholson
+
+
+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,82 @@
+# 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 version 5.x and 6.x.
+
+Version 2.x works with paperclip version 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`, `image_size` and `aspect_ratio` methods are provided:
+
+```ruby
+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:
+
+```sh
+bundle
+bundle exec rake
+```

data/lib/kt-paperclip-meta.rb

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

data/lib/paperclip-meta/attachment.rb

@@ -0,0 +1,99 @@
+module Paperclip
+  module Meta
+    module Attachment
+      def assign_attributes
+        super
+        assign_meta
+      end
+
+      def save
+        if @queued_for_delete.any? && @queued_for_write.empty?
+          instance_write(:meta, meta_encode({}))
+        end
+        super
+      end
+
+      def post_process_styles(*styles)
+        super(*styles)
+        assign_meta
+      end
+
+      # Use meta info for style if required
+      def size(style = nil)
+        style ? read_meta(style, :size) : super()
+      end
+
+      def height(style = default_style)
+        read_meta style, :height
+      end
+
+      def width(style = default_style)
+        read_meta style, :width
+      end
+
+      def aspect_ratio(style = default_style)
+        width(style).to_f / height(style).to_f
+      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 assign_meta
+        return unless instance.respond_to?(:"#{name}_meta=")
+        meta = populate_meta(@queued_for_write)
+        return if meta == {}
+
+        write_meta(meta)
+      end
+
+      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

data/lib/paperclip-meta/railtie.rb

@@ -0,0 +1,19 @@
+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.prepend Paperclip::Meta::Attachment
+      end
+    end
+  end
+end

data/lib/paperclip-meta/version.rb

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

data/lib/paperclip-meta.rb

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

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: kt-paperclip-meta
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Alexey Bondar
+- Tee Parham
+- Paul Nicholson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kt-paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: kt-delayed_paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Add width, height and size methods to paperclip images
+email:
+- y8@ya.ru
+- tee@neighborland.com
+- paul-rubygems@refactoredtech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/kt-paperclip-meta.rb
+- lib/paperclip-meta.rb
+- lib/paperclip-meta/attachment.rb
+- lib/paperclip-meta/railtie.rb
+- lib/paperclip-meta/version.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: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Add width, height, and size to paperclip images
+test_files: []