activestorage-autobots 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 408099118b75915f2050d104ce5e0a967c5ccd8bdb91732f2b616b23dd9fc56c
+  data.tar.gz: 6f8a8078c3a51f9c2c17151027aff180f9fa9b87fb89f57fcb228affb63e0b8c
+SHA512:
+  metadata.gz: bee39d51c6aaf45e772cdb9f3364b3e154bcbfdc91689a4cea6adae504f9e6a818db19f3833ac3e160524394c09ab1ddb31b60d98e6f65a78de27e5532d7ffb5
+  data.tar.gz: 7b6968cdf2325b54c94bb24e45dd27f3796daa15573d7d631c054cb483ce5e26341511997628d9ec2191a9f5751baf0f2cb7261036dc1da5eb676ae48cae12d7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 JetThoughts
+
+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,71 @@
+[![Gem Version](https://badge.fury.io/rb/activestorage-autobots.svg)](https://rubygems.org/gems/activestorage-autobots)
+[![Build](https://github.com/jetthoughts/activestorage-autobots/workflows/Build/badge.svg)](https://github.com/jetthoughts/activestorage-autobots/actions)
+
+# ActiveStorage Autobots (aka ActiveStorage Transformers)
+
+Enables ActiveStorage variants for other file types than images, such as audio or video files, through an API for registering custom transformers similar to previewers. An example `ffmpeg` transformation is provided.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-autobots'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+# lib/active_storage/transformers/ffmpeg_transformer.rb
+
+require 'active_storage/transformers/transformer'
+
+class ActiveStorage::Transformers::FFMPEGTransformer < ActiveStorage::Transformers::Transformer
+  def self.accept?(blob)
+    blob.video? || blob.audio?
+  end
+
+  def transform(input, format:)
+    format ||= File.extname(input.path)
+    options = transformations[:ffmpeg_opts]
+    create_tempfile(ext: format) do |output|
+      system "ffmpeg -y -i #{input.path} #{options} #{output.path}", exception: true
+      yield output
+    end
+  end
+
+  def create_tempfile(ext: '')
+    ext = ".#{ext}" unless ext.blank? || ext.start_with?('.')
+    tempfile = Tempfile.new(['active_storage_transformer_', ext], binmode: true)
+    yield tempfile
+  ensure
+    tempfile.close!
+  end
+end
+```
+
+Update in initializers
+```ruby
+# config/initializers/active_storage.rb
+
+require 'active_storage/transformers/ffmpeg_transformer'
+
+ActiveStorage.transformers << ActiveStorage::Transformers::FFMPEGTransformer
+# => [ ActiveStorage::Transformers::ImageProcessingTransformer, FFMPEGTransformer ]
+```
+
+```html+erb
+<%= audio_tag user.my_audio.variant(ffmpeg_opts: "-af silenceremove=stop_periods=-1:stop_duration=1:stop_threshold=-90dB", format: "mp3") %>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jetthoughts/activestorage-autobots. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_storage/autobots/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails"
+require "rails/railtie"
+
+require "active_storage/autobots"
+
+module ActiveStorage
+  module Autobots
+    class Railtie < Rails::Railtie # :nodoc:
+    end
+  end
+end

data/lib/active_storage/autobots/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module Autobots
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_storage/autobots.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "active_storage"
+require "active_support"
+require "active_support/rails"
+
+module ActiveStorage
+  mattr_accessor :transformers, default: [ActiveStorage::Transformers::ImageProcessingTransformer]
+
+  module Autobots
+    module RepresentableOverride
+      def variable?
+        ActiveStorage.transformers.any? { |klass| klass.accept?(self) }
+      end
+
+    end
+
+    module VariantOverride
+      def process
+        blob.open do |input|
+          variation.transform(blob, input) do |output|
+            service.upload(key, output, content_type: content_type)
+          end
+        end
+      end
+    end
+
+    module VariantWithRecordOverride
+      def transform_blob
+        blob.open do |input|
+          variation.transform(blob, input) do |output|
+            yield io: output, filename: "#{blob.filename.base}.#{variation.format.downcase}",
+              content_type: variation.content_type, service_name: blob.service.name
+          end
+        end
+      end
+    end
+
+    module VariationOverride
+      def transform(blob, file, &block)
+        ActiveSupport::Notifications.instrument("transform.active_storage") do
+          transformer(blob).transform(file, format: format, &block)
+        end
+      end
+
+      private
+
+      def transformer(blob)
+        transformer_class(blob).new(transformations.except(:format))
+      end
+
+      def transformer_class(blob)
+        ActiveStorage.transformers.detect { |klass| klass.accept?(blob) }
+      end
+    end
+
+    module ImageProcessingTransformerOverride
+      def accept?(blob)
+        ActiveStorage.variable_content_types.include?(blob.content_type)
+      end
+    end
+
+    module VideoAnalyzerOverride
+      def accept?(blob)
+        blob.video? || blob.content_type.end_with?("/mp4")
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_storage_blob) do
+  ActiveStorage::Blob::Representable.prepend(ActiveStorage::Autobots::RepresentableOverride)
+  ActiveStorage::Variant.send(:prepend, ActiveStorage::Autobots::VariantOverride)
+  ActiveStorage::VariantWithRecord.send(:prepend, ActiveStorage::Autobots::VariantWithRecordOverride)
+  ActiveStorage::Variation.send(:prepend, ActiveStorage::Autobots::VariationOverride)
+  ActiveStorage::Analyzer::VideoAnalyzer.singleton_class.send(:prepend, ActiveStorage::Autobots::VideoAnalyzerOverride)
+  ActiveStorage::Transformers::ImageProcessingTransformer.send(
+    :extend, ActiveStorage::Autobots::ImageProcessingTransformerOverride
+  )
+end
+
+require "active_storage/autobots/railtie" if defined?(Rails)

data/lib/activestorage-autobots.rb

@@ -0,0 +1 @@
+require "active_storage/autobots"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-autobots
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Keen
+- Sébastien Dubois
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+description: Enables ActiveStorage variants for other file types than images,such
+  as audio or video files, through an API for registering custom transformers similar
+  to previewers.
+email:
+- pftg@jetthoughts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/active_storage/autobots.rb
+- lib/active_storage/autobots/railtie.rb
+- lib/active_storage/autobots/version.rb
+- lib/activestorage-autobots.rb
+homepage: https://github.com/jetthoughts/activestorage-autobots
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Allow to add custom ActiveStorage transformers
+test_files: []