shrine-thumbhash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56d67f222347d85c3a9a72603effe992cbbf5538fa7aeaf1e63d06859c06064c
+  data.tar.gz: 7d808dd14643b00720a42b6c49bdc5aea910902135d4005c92a601e46c89789d
+SHA512:
+  metadata.gz: f5b3fff17ba9bd77a9fa1755018a2a219b0dc87a32e7d868dd468bad3890b90695a7a5985265971fe0598378b792d60d0c4f5ca8911bd2b71e88360442d3498d
+  data.tar.gz: fbc81b2d279f6c169e85fa99b7338fe449fac80e78fc1d55e9d7e609bf3af7168240cf83e7c04c7f5c4509c25ae8dd73f94a7a196146783ab48ff4c0902c7a7f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 15
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shrine-thumbhash.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "ruby-vips", "~> 2.0"
+
+gem "shrine", ENV["SHRINE_VERSION"] unless ENV["SHRINE_VERSION"].nil?

data/README.md

@@ -0,0 +1,72 @@
+# Shrine::Thumbhash
+
+Shrine plugin for generate Thumbhash from image attachments.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add shrine-thumbhash
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install shrine-thumbhash
+
+## Requirements
+- [ruby-vips gem](https://rubygems.org/gems/ruby-vips) (default or when you specify `:ruby_vips` to image_loader option)
+
+## Usage
+
+```ruby
+require "shrine"
+require "shrine/storage/memory"
+require "shrine/plugins/thumbhash"
+
+Shrine.plugin :thumbhash
+Shrine.storages[:store] = Shrine::Storage::Memory.new
+uploader = Shrine.new(:store)
+
+image = File.open("path/to/image.jpg", binmode: true)
+uploaded_file = uploader.upload(image)
+
+uploaded_file.thumbhash
+# => Base64 encoded thumbhash such as "YJqGPQw7sFlslqhFafSE+Q6oJ1h2iHB2Rw=="
+uploaded_file.thumbhash_urlsafe
+# => URLsafe Base64 encoded thumbhash such as "YJqGPQw7sFlslqhFafSE-Q6oJ1h2iHB2Rw=="
+```
+
+## Options
+
+### padding
+When specify false, thumbhash will be without padding.
+
+Default: true
+```ruby
+Shrine.plugin :thumbhash, padding: false
+ ... # omit
+uploaded_file.thumbhash
+# => Base64 encoded thumbhash without padding such as "YJqGPQw7sFlslqhFafSE+Q6oJ1h2iHB2Rw"
+uploaded_file.thumbhash_urlsafe
+# => URLsafe Base64 encoded thumbhash without padding such as "YJqGPQw7sFlslqhFafSE-Q6oJ1h2iHB2Rw"
+```
+
+### image_loader
+A ruby object be used for loading and resizeing image.  
+When you choose from our implementations, you can specify them by Symbol.
+
+- `:ruby_vips`
+
+Default: :ruby_vips
+
+If you want to use something other than our implementations, you can implement it yourself.  
+See `lib/shrine/plugins/image_loader/ruby_vips.rb`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/takayamaki/shrine-thumbhash.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/shrine/plugins/image.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Shrine # :nodoc:
+  module Plugins # :nodoc:
+    module Thumbhash # :nodoc:
+      class Image # :nodoc:
+        attr_reader :width, :height, :pixels
+
+        def initialize(width, height, pixels)
+          @width = width
+          @height = height
+          @pixels = pixels
+        end
+      end
+    end
+  end
+end

data/lib/shrine/plugins/image_loader/ruby_vips.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "../image"
+require "ruby-vips"
+
+class Shrine # :nodoc:
+  module Plugins # :nodoc:
+    module Thumbhash # :nodoc:
+      module ImageLoader # :nodoc:
+        module RubyVips # :nodoc:
+          def self.call(io)
+            image = load_image(io)
+            image = resize_image(image)
+            Thumbhash::Image.new(
+              image.width,
+              image.height,
+              repack_pixels_to_flattened_rgba_array(image)
+            )
+          end
+
+          def self.load_image(io)
+            src = ::Vips::Source.new_from_descriptor(io.fileno)
+            ::Vips::Image.new_from_source(src, "")
+          end
+
+          def self.resize_image(image)
+            return image if image.width <= 100 && image.height <= 100
+
+            scale_factor = [100.fdiv(image.width), 100.fdiv(image.height)].min
+            image.resize(scale_factor)
+          end
+
+          def self.repack_pixels_to_flattened_rgba_array(image)
+            case image.bands
+            when 3
+              image.to_enum.flat_map { |line| line.flat_map { |rgb| rgb.push(255) } }
+            when 4
+              image.to_enum.flat_map(&:flatten)
+            else
+              raise "Unexpected bands: #{image.bands}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shrine/plugins/thumbhash/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Shrine
+  module Plugins
+    module Thumbhash
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/shrine/plugins/thumbhash.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "shrine"
+require "thumbhash"
+
+class Shrine # :nodoc:
+  module Plugins # :nodoc:
+    module Thumbhash # :nodoc:
+      DEFAULT_OPTIONS = {
+        padding: true,
+        image_loader: :ruby_vips
+      }.freeze
+
+      def self.configure(uploader, **opts)
+        uploader.opts[:thumbhash] ||= DEFAULT_OPTIONS.dup
+        uploader.opts[:thumbhash].merge!(opts)
+        configure_image_loader(uploader.opts[:thumbhash]) if uploader.opts[:thumbhash][:image_loader_class].nil?
+      end
+
+      def self.configure_image_loader(opts)
+        return unless opts[:image_loader] == :ruby_vips
+
+        require_relative "image_loader/ruby_vips"
+        opts[:image_loader] = Shrine::Plugins::Thumbhash::ImageLoader::RubyVips
+      end
+
+      module ClassMethods # :nodoc:
+        def generate_thumbhash(io)
+          image = opts[:thumbhash][:image_loader].call(io)
+
+          ::ThumbHash.rgba_to_thumb_hash(
+            image.width,
+            image.height,
+            image.pixels
+          )
+        end
+      end
+
+      module InstanceMethods # :nodoc:
+        def extract_metadata(io, **options)
+          thumbhash = self.class.generate_thumbhash(io)
+          super.merge!(encode_thumbhash_as_base64(thumbhash))
+        end
+
+        private
+
+        def encode_thumbhash_as_base64(thumbhash)
+          if self.class.opts[:thumbhash][:padding]
+            {
+              "thumbhash" => Base64.strict_encode64(thumbhash),
+              "thumbhash_urlsafe" => Base64.urlsafe_encode64(thumbhash)
+            }
+          else
+            {
+              "thumbhash" => Base64.strict_encode64(thumbhash).gsub!("=", ""),
+              "thumbhash_urlsafe" => Base64.urlsafe_encode64(thumbhash, padding: false)
+            }
+          end
+        end
+      end
+
+      module FileMethods # :nodoc:
+        def thumbhash
+          metadata["thumbhash"]
+        end
+
+        def thumbhash_urlsafe
+          metadata["thumbhash_urlsafe"]
+        end
+      end
+    end
+
+    register_plugin(:thumbhash, Thumbhash)
+  end
+end

data/shrine-thumbhash.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/shrine/plugins/thumbhash/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "shrine-thumbhash"
+  spec.version = Shrine::Plugins::Thumbhash::VERSION
+  spec.authors = ["takayamaki / fusagiko"]
+  spec.email = ["24884114+takayamaki@users.noreply.github.com"]
+
+  spec.summary = "Shrine plugin for generate Thumbhash from image attachments"
+  spec.homepage = "https://github.com/takayamaki/shrine-thumbhash"
+  spec.required_ruby_version = ">= 2.6"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/takayamaki/shrine-thumbhash"
+  spec.metadata["changelog_uri"] = "https://github.com/takayamaki/shrine-thumbhash/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "shrine", "~> 3.0"
+  spec.add_dependency "thumbhash", "~> 0.0.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/sig/shrine/plugins/thumbhash.rbs

@@ -0,0 +1,8 @@
+class Shrine
+  module Plugins
+    module Thumbhash
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: shrine-thumbhash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- takayamaki / fusagiko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thumbhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: 
+email:
+- 24884114+takayamaki@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/shrine/plugins/image.rb
+- lib/shrine/plugins/image_loader/ruby_vips.rb
+- lib/shrine/plugins/thumbhash.rb
+- lib/shrine/plugins/thumbhash/version.rb
+- shrine-thumbhash.gemspec
+- sig/shrine/plugins/thumbhash.rbs
+homepage: https://github.com/takayamaki/shrine-thumbhash
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/takayamaki/shrine-thumbhash
+  source_code_uri: https://github.com/takayamaki/shrine-thumbhash
+  changelog_uri: https://github.com/takayamaki/shrine-thumbhash/releases
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Shrine plugin for generate Thumbhash from image attachments
+test_files: []