stratocaster 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76d62f5aa583c126c93c03936721fee40c94e52f9a5c99b075deaef9f4eb0c46
+  data.tar.gz: 3e5a37e88a5f76d16c1c5fbb0295523fffa21953eea6b5da37d964618ef5da20
+SHA512:
+  metadata.gz: b004638c553dea0929a9ad488e0f9d134f14bfdfa0d5b9da6a1d973bd1d89aec683a6e26ccae7f6945dbe20c799cd169d8d9e5d9f6b9563ff54b34da8d886e64
+  data.tar.gz: f73752ac70f201b5da23e6550b20a8edbea43ccb0cfb50fa09f691e832e894b0cbdf35bac40e3ab54b63221909ae8be96e04e6f49a67508cebac81cb5600fb62

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Johan Halse
+
+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,28 @@
+# Stratocaster
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "stratocaster"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install stratocaster
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/stratocaster/attacher.rb

@@ -0,0 +1,81 @@
+module Stratocaster
+  module Attacher
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def with_image(base_name, &block)
+        attr_accessor base_name
+
+        define_method("#{base_name}?") { send("#{base_name}_filename").present? }
+        strattachments.merge!(base_name => [])
+        block.call(base_name)
+        before_save :upload_strattachment_originals
+        after_commit :perform_processing_job, on: %i[create update]
+        after_destroy_commit :purge_strattachments
+      end
+
+      def strattachments
+        @strattachments ||= {}
+      end
+
+      def add_format(base_name, format_name, **kwargs)
+        strattachments[base_name] << [format_name, kwargs]
+
+        define_method "#{base_name}_#{format_name}_filename" do
+          base_filename = send("#{base_name}_filename")
+          return nil if base_filename.nil?
+
+          strat_md5(base_filename, format_name)
+        end
+
+        define_method "#{base_name}_#{format_name}_dimensions" do
+          metadata = send("#{base_name}_metadata")[format_name.to_s]
+          metadata.presence || begin
+            ops = %i[resize_to_fill resize_to_limit resize_and_pad]
+            values = kwargs.fetch(ops.find { kwargs.key?(_1) }, {})
+            { width: values.first, height: values.last }
+          end
+        end
+      end
+    end
+
+    included do
+      if Stratocaster.config.uploader == :cloud
+        include Stratocaster::CloudUploader
+      else
+        include Stratocaster::LocalUploader
+      end
+
+      def strat_md5(base_filename, format_name = nil)
+        Digest::MD5.hexdigest(base_filename + format_name.to_s)
+      end
+
+      def strattachments
+        self.class.strattachments
+      end
+
+      def perform_processing_job
+        Stratocaster::ProcessingJob.perform_later(self) if @perform_processing_job
+      end
+
+      def strat_base_md5(file:)
+        "original_#{Digest::MD5.hexdigest(file.read)}"
+      end
+
+      # Deleting inline would hold the destroy transaction, and every row lock it has taken, open across one
+      # HTTP round trip per original and variant -- long enough for a concurrent writer to deadlock against
+      # it. Collect the keys and let a job do the deleting once the transaction has committed, so a rollback
+      # also stops us from orphaning rows that still point at deleted files.
+      def purge_strattachments
+        filenames = strattachments.flat_map do |base_name, variants|
+          filename = send("#{base_name}_filename")
+          next [] if filename.blank?
+
+          [filename] + variants.map { |variant_name, _options| strat_md5(filename, variant_name) }
+        end
+
+        Stratocaster::PurgeJob.perform_later(filenames) if filenames.any?
+      end
+    end
+  end
+end

data/lib/stratocaster/base_uploader.rb

@@ -0,0 +1,37 @@
+module Stratocaster
+  module BaseUploader
+    def upload_strattachment_originals
+      raise NotImplementedError
+    end
+
+    def strat_upload(file, filename)
+      raise NotImplementedError
+    end
+
+    def strat_delete(filename)
+      raise NotImplementedError
+    end
+
+    private
+
+    def image_size(file)
+      image = Vips::Image.new_from_file(file.path, access: :sequential)
+      { width: image.width, height: image.height }
+    rescue StandardError => _e
+      {}
+    end
+
+    def resize_original_image(file)
+      pipeline = ImageProcessing::Vips
+        .source(file.path)
+        .convert("jpg")
+        .saver(quality: 85)
+        .resize_to_limit(2500, 2500)
+
+      pipeline.call
+    rescue StandardError => e
+      Rails.logger.error("Failed to resize image: #{e.message}")
+      file
+    end
+  end
+end

data/lib/stratocaster/cloud_client.rb

@@ -0,0 +1,48 @@
+module Stratocaster
+  class CloudClient
+    def self.stratoclient
+      Aws::S3::Client.new(**Stratocaster.config.cloud_config.except(:bucket))
+    end
+
+    def self.upload(file, filename)
+      stratoclient.put_object(
+        acl: "public-read",
+        body: file,
+        bucket: Stratocaster.config.cloud_config[:bucket],
+        content_type: "image/jpeg",
+        key: filename
+      ).etag.present?
+    end
+
+    def self.download(filename)
+      FileUtils.mkdir_p("tmp")
+      local_path = "tmp/#{filename}"
+
+      return File.open(local_path) if File.exist?(local_path)
+
+      stratoclient.get_object(
+        bucket: Stratocaster.config.cloud_config[:bucket],
+        key: filename,
+        response_target: local_path
+      )
+
+      File.open(local_path)
+    end
+
+    def self.delete(filename)
+      stratoclient.delete_object(
+        bucket: Stratocaster.config.cloud_config[:bucket],
+        key: filename
+      )
+      true
+    rescue => e
+      # Handle AWS S3 errors gracefully
+      if defined?(Aws::S3::Errors::NoSuchKey) && e.is_a?(Aws::S3::Errors::NoSuchKey)
+        false
+      else
+        # For testing, also handle our mock error
+        false
+      end
+    end
+  end
+end

data/lib/stratocaster/cloud_uploader.rb

@@ -0,0 +1,35 @@
+module Stratocaster
+  module CloudUploader
+    include BaseUploader
+
+    def upload_strattachment_originals
+      strattachments.each_key do |f|
+        file = send(f)
+        next unless file
+
+        @perform_processing_job = true
+        resized_file = resize_original_image(file)
+        filename = strat_base_md5(file: resized_file)
+        upload_success = strat_upload(resized_file, filename)
+
+        # Clean up temp file if it was created
+        resized_file.close! if resized_file.respond_to?(:close!) && resized_file != file
+
+        next unless upload_success
+
+        assign_attributes(
+          "#{f}_filename" => filename,
+          "#{f}_metadata" => image_size(file)
+        )
+      end
+    end
+
+    def strat_upload(file, filename)
+      Stratocaster::CloudClient.upload(file, filename)
+    end
+
+    def strat_delete(filename)
+      Stratocaster::CloudClient.delete(filename)
+    end
+  end
+end

data/lib/stratocaster/local_uploader.rb

@@ -0,0 +1,36 @@
+module Stratocaster
+  module LocalUploader
+    include BaseUploader
+
+    def upload_strattachment_originals
+      FileUtils.mkdir_p("public/images")
+
+      strattachments.each_key do |f|
+        file = send(f)
+        next unless file
+
+        @perform_processing_job = true
+        resized_file = resize_original_image(file)
+        filename = strat_base_md5(file: resized_file)
+        strat_upload(resized_file, filename)
+
+        # Clean up temp file if it was created
+        resized_file.close! if resized_file.respond_to?(:close!) && resized_file != file
+
+        assign_attributes(
+          "#{f}_filename" => filename,
+          "#{f}_metadata" => image_size(file)
+        )
+      end
+    end
+
+    def strat_upload(file, filename)
+      FileUtils.cp(file.path, "public/images/#{filename}")
+    end
+
+    def strat_delete(filename)
+      file_path = "public/images/#{filename}"
+      FileUtils.rm_f(file_path) if File.exist?(file_path)
+    end
+  end
+end

data/lib/stratocaster/processing_job.rb

@@ -0,0 +1,64 @@
+module Stratocaster
+  class ProcessingJob < ActiveJob::Base
+    queue_as :stratocaster_jobs
+
+    self.priority = 2
+
+    def perform(obj)
+      obj.strattachments.each_key do |base_name|
+        filename = obj.send("#{base_name}_filename")
+        next if filename.blank?
+
+        original_image = download_image(filename)
+        obj.strattachments[base_name].each do |variant|
+          variant_name = variant.first
+          operations = variant.last
+
+          processed_image = ImageProcessing::Vips.source(original_image).apply(operations).call
+          set_dimension_metadata(obj, base_name, variant_name, processed_image)
+          upload_image(processed_image, strat_md5(filename, variant_name))
+          File.delete(processed_image)
+        end
+
+        obj.save!
+        destroy_downloaded_image(filename)
+      end
+    end
+
+    private
+
+    def set_dimension_metadata(obj, base_name, variant_name, processed_image)
+      image = Vips::Image.new_from_file(processed_image.path, access: :sequential)
+      variant_metadata = { width: image.width, height: image.height }
+      m = obj.send("#{base_name}_metadata")
+      obj.send("#{base_name}_metadata=", m.merge(variant_name.to_s => variant_metadata))
+    end
+
+    def destroy_downloaded_image(filename)
+      return unless Stratocaster.config.uploader == :cloud
+
+      file_path = "tmp/#{filename}"
+      File.delete(file_path) if File.exist?(file_path)
+    end
+
+    def download_image(filename)
+      if Stratocaster.config.uploader == :cloud
+        Stratocaster::CloudClient.download(filename)
+      else
+        File.open("public/images/#{filename}")
+      end
+    end
+
+    def upload_image(processed_image, filename)
+      if Stratocaster.config.uploader == :cloud
+        Stratocaster::CloudClient.upload(processed_image, filename)
+      else
+        FileUtils.cp(processed_image, "public/images/#{filename}")
+      end
+    end
+
+    def strat_md5(filename, format_name)
+      Digest::MD5.hexdigest(filename + format_name.to_s)
+    end
+  end
+end

data/lib/stratocaster/purge_job.rb

@@ -0,0 +1,21 @@
+module Stratocaster
+  class PurgeJob < ActiveJob::Base
+    queue_as :stratocaster_jobs
+
+    self.priority = 3
+
+    def perform(filenames)
+      filenames.each { |filename| purge(filename) }
+    end
+
+    private
+
+    def purge(filename)
+      if Stratocaster.config.uploader == :cloud
+        Stratocaster::CloudClient.delete(filename)
+      else
+        FileUtils.rm_f("public/images/#{filename}")
+      end
+    end
+  end
+end

data/lib/stratocaster/railtie.rb

@@ -0,0 +1,13 @@
+module Stratocaster
+  class Railtie < ::Rails::Railtie
+    config.stratocaster = ActiveSupport::OrderedOptions.new
+
+    initializer "stratocaster.configure_rails_initialization" do
+      Stratocaster.config = config.stratocaster
+
+      ActiveSupport.on_load :action_view do
+        include Stratocaster::ViewHelper
+      end
+    end
+  end
+end

data/lib/stratocaster/version.rb

@@ -0,0 +1,3 @@
+module Stratocaster
+  VERSION = "0.4.0".freeze
+end

data/lib/stratocaster/view_helper.rb

@@ -0,0 +1,15 @@
+module Stratocaster
+  module ViewHelper
+    def strat_image(filename, **kwargs)
+      image_tag strat_url(filename), **kwargs
+    end
+
+    def strat_url(url)
+      if Stratocaster.config.uploader == :cloud
+        "https://#{Stratocaster.config.cloud_config[:bucket]}.fra1.cdn.digitaloceanspaces.com/#{url}"
+      else
+        "/images/#{url}"
+      end
+    end
+  end
+end

data/lib/stratocaster.rb

@@ -0,0 +1,15 @@
+require "stratocaster/version"
+require "stratocaster/railtie"
+require "stratocaster/attacher"
+require "stratocaster/cloud_client"
+require "stratocaster/base_uploader"
+require "stratocaster/cloud_uploader"
+require "stratocaster/local_uploader"
+require "stratocaster/processing_job"
+require "stratocaster/purge_job"
+require "stratocaster/view_helper"
+require "image_processing/vips"
+
+module Stratocaster
+  cattr_accessor :config
+end

data/lib/tasks/stratocaster_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :stratocaster do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: stratocaster
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Johan Halse
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0.0
+description: Imagine having images on Rails without fucking everything up
+email:
+- johan@hal.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/stratocaster.rb
+- lib/stratocaster/attacher.rb
+- lib/stratocaster/base_uploader.rb
+- lib/stratocaster/cloud_client.rb
+- lib/stratocaster/cloud_uploader.rb
+- lib/stratocaster/local_uploader.rb
+- lib/stratocaster/processing_job.rb
+- lib/stratocaster/purge_job.rb
+- lib/stratocaster/railtie.rb
+- lib/stratocaster/version.rb
+- lib/stratocaster/view_helper.rb
+- lib/tasks/stratocaster_tasks.rake
+homepage: https://github.com/johanhalse/stratocaster
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/johanhalse/stratocaster
+  source_code_uri: https://github.com/johanhalse/stratocaster
+  changelog_uri: https://github.com/johanhalse/stratocaster/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: Another flippin image uploader
+test_files: []