bridgetown-media-transformation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b563489bed535209cf133e79d43c7320dde50f5e66ac757a048f80e66376e333
+  data.tar.gz: d7c05aa74fd1000ce1554af9814fe479018b912f45c6a5b32e69de9f4ef24308
+SHA512:
+  metadata.gz: 7cadb1266b29b48dab3b5e2800d18b7c191bafe9116b5e19f1f7a471a32d130025c15322913d1e21afe8ba07186e9c192f66e4d3ce7cab1a3edf7ab34c093eab
+  data.tar.gz: 0c99eee0642a3b8408bd2bb3bba8b71d2fdbbe6f11960d311774d25d093ab5d60c39eb99aaec06d316bfe82811c8f1d106b7a68f480ff48917eda2b1bf6eac39

data/.gitignore

@@ -0,0 +1,41 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+*~
+
+spec/fixtures/.bmt-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# master
+
+* Use this file to keep track of plugin updates
+
+# 0.1.0 / 2020-05-01
+
+* First version

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,81 @@
+# Bridgetown Media Transformation
+
+A Bridgetown plugin to [fill in the blank]…
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-media-transformation -g bridgetown_plugins
+```
+
+### with VIPS
+
+### with ImageMagick
+
+## Usage
+
+The plugin will…
+
+### Optional configuration options
+
+```yaml
+# bridgetown.config.yml
+
+media_transformation:
+  # Whether to optimize transformed images with image_optim
+  #
+  # Type: Boolean
+  # Optional: true
+  # Default: false
+  optimize: true
+
+  # Whether to progressive scan JPGs
+  #
+  # Type: Boolean
+  # Optional: true
+  # Default: false
+  interlace: true
+
+  # The default transformations
+  #
+  # Type: Hash
+  # Optional: true
+  # Default:
+  #   {
+  #     "webp" => [[640, "640w"], [1024, "1024w"], [1280, "1280w"], [1920, "1920w"], [3840, "2x"]],
+  #     "jpg" => [[640, "640w"], [1024, "1024w"], [1280, "1280w"], [1920, "1920w"], [3840, "2x"]]
+  #   }
+  default_transformations:
+    webp:
+      -
+        - 320
+        - 320w
+      -
+        - 2000
+        - 2000w
+    jpg:
+      -
+        - 320
+        - 320w
+      -
+        - 2000
+        - 2000w
+```
+…
+
+## Testing
+
+* Run `BRIDGETOWN_ENV=test script/test` to run the test suite
+* Or run `BRIDGETOWN_ENV=test script/cibuild` to validate with Rubocop and test with rspec together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bridgetown-media-transformation.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-media-transformation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-media-transformation"
+  spec.version       = BridgetownMediaTransformation::VERSION
+  spec.author        = "Julian Rubisch"
+  spec.email         = "julian@julianrubisch.at"
+  spec.summary       = "Image and video transformation via image_processing and ffmpeg"
+  spec.homepage      = "https://github.com/julianrubisch/bridgetown-media-transformation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^spec/!)
+  spec.require_paths = ["lib"]
+  spec.metadata      = { "yarn-add" => "bridgetown-media-transformation@#{BridgetownMediaTransformation::VERSION}" }
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.15", "< 2.0"
+  spec.add_dependency "image_processing", "~> 1.0"
+  spec.add_dependency "image_optim", "~> 0.27"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/components/bridgetown_media_transformation/layout_help.liquid

@@ -0,0 +1 @@
+<p>Just use <code>layout: bridgetown_media_transformation/layout</code> in your page's front matter.</p>

data/content/bridgetown_media_transformation/example_page.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Example Page
+---
+
+If all goes well, this page will be accessible as [`{{ page.url }}`]({{ page.url }}), and you will see a photo of a train:
+
+![Train on Rails]({{ "/bridgetown_media_transformation/train-on-rails.jpeg" | relative_url }})

data/layouts/bridgetown_media_transformation/layout.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+<p>You can include this layout in your site! 🥳</p>
+
+{% render "bridgetown_media_transformation/layout_help" %}
+
+{{ content }}

data/lib/bridgetown-media-transformation/builder.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "image_processing/mini_magick"
+require "image_processing/vips"
+require "image_optim"
+require "fileutils"
+
+module BridgetownMediaTransformation
+  class Builder < Bridgetown::Builder
+    DEFAULT_TRANSFORMATION_SPECS = {
+      "webp" => [[640, "640w"], [1024, "1024w"], [1280, "1280w"], [1920, "1920w"], [3840, "2x"]],
+      "jpg" => [[640, "640w"], [1024, "1024w"], [1280, "1280w"], [1920, "1920w"], [3840, "2x"]]
+    }
+
+    attr_reader :attributes, :media_transformations
+
+    def build
+      @media_transformations ||= []
+
+      Bridgetown.logger.info "[media-transformation] Interlacing JPEG: #{interlace?}"
+      Bridgetown.logger.info "[media-transformation] Optimizing: #{optimize?}"
+
+      liquid_tag "resp_picture", as_block: true do |attributes, tag|
+        @attributes = attributes.split(",").map(&:strip)
+        src = tag.context["src"]
+        dest = tag.context["dest"]
+        src ||= @attributes.first
+        dest ||= src
+        lazy = kargs.fetch("lazy") { false }
+        transformation_specs = kargs.fetch("transformation_specs") { default_transformation_specs }
+
+        transformation = MediaTransformation.new(dest: dest, src: src, specs: transformation_specs, optimize: optimize?, interlace: interlace?, site: site, builder: self)
+        @media_transformations << transformation
+
+        picture_tag(src: src, dest: dest, file_hash: transformation.file_hash, lazy: lazy, attributes: tag.content, transformation_specs: transformation_specs)
+      end
+
+      unless Bridgetown.environment == "test"
+        hook :site, :post_write do |site|
+          # kick off transformations
+          media_transformations.each { |transformation| transformation.process }
+        end
+      end
+    end
+
+    def picture_tag(src: "", dest: "", file_hash:, lazy: false, attributes:, transformation_specs:)
+      src_filename = "#{file_hash}-#{file_basename(src)}"
+      prefixed_src = "#{File.join(File.dirname(dest), src_filename)}"
+
+      source_elements = transformation_specs.map do |format, spec|
+        srcset = spec.map do |s|
+          scaled_width, srcset_descriptor = s
+          "#{File.join(File.dirname(dest), file_basename(prefixed_src))}-#{scaled_width}.#{format} #{srcset_descriptor}"
+        end.join(", ")
+        "<source #{lazy ? 'data-' : ''}srcset=\"#{srcset}\" type=\"image/#{format}\" />"
+      end
+
+      tag = <<~PICTURE
+        <picture>
+          #{source_elements.join("\n")}
+          <img #{lazy ? 'data-' : ''}src="#{src}" #{attributes}>
+        </picture>
+      PICTURE
+      tag
+    end
+
+    def verbose?
+      options.dig(:verbose) || Bridgetown.environment == "production"
+    end
+    
+    private
+
+    def kargs
+      return {} unless attributes.size > 1
+      
+      json_payload = attributes[1..].join(", ")
+      @kargs = JSON.parse(JSON.parse(json_payload).gsub("'", "\""))
+    end
+
+    def file_basename(path)
+      File.basename(File.join(site.source, path), ".*")
+    end
+
+    def interlace?
+      options.dig(:interlace) || false
+    end
+
+    def optimize?
+      options.dig(:optimize) || false
+    end
+
+    def options
+      config["media_transformation"] || {}
+    end
+
+    def default_transformation_specs
+      options.fetch(:default_transformations) { DEFAULT_TRANSFORMATION_SPECS }
+    end
+  end
+end
+
+BridgetownMediaTransformation::Builder.register

data/lib/bridgetown-media-transformation/media_transformation.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+class MediaTransformation
+  attr_reader :dest, :src, :specs, :optimize, :interlace, :site
+
+  def initialize(dest:, src:, specs:, optimize:, interlace:, site:, builder:)
+    @dest = dest
+    @src = src
+    @specs = specs
+    @optimize = optimize
+    @interlace = interlace
+    @site = site
+    @builder = builder
+  end
+
+  def file_basename(path)
+    File.basename(File.join(site.source, path), ".*")
+  end
+
+  def file_hash
+    Digest::MD5.file(File.join(site.source, src)).hexdigest
+  end
+
+  def process
+    return if src.empty?
+
+    pipeline = ImageProcessing::Vips.source(File.join(site.source, src))
+
+    specs.each do |format, specs|
+      pipeline.convert(format)
+
+      pipeline.saver(interlace: true) if format == "jpg" && interlace
+
+      specs.each do |spec|
+        destination_filename = "#{file_hash}-#{file_basename(src)}"
+        cache_destination = File.join(site.source, "..", ".bmt-cache", "#{File.join(File.dirname(dest), destination_filename)}-#{spec.first}.#{format}")
+        destination = File.join(site.config["destination"], "#{File.join(File.dirname(dest), destination_filename)}-#{spec.first}.#{format}")
+
+        FileUtils.mkdir_p(File.dirname(cache_destination))
+
+        unless File.exist? cache_destination
+          if @builder.verbose?
+            Bridgetown.logger.info "[media-transformation] Generating #{cache_destination}"
+          end
+
+          pipeline
+            .resize_to_fit(spec.first, nil)
+            .call(destination: cache_destination)
+
+          if optimize && Bridgetown.environment == "production"
+            if @builder.verbose?
+              Bridgetown.logger.info "[media-transformation] Optimizing #{cache_destination}"
+            end
+            image_optim = ImageOptim.new
+            image_optim.optimize_image!(cache_destination)
+          end
+        end
+
+        if @builder.verbose?
+          Bridgetown.logger.info "[media-transformation] Copying #{cache_destination} to #{destination}"
+        end
+        FileUtils.mkdir_p(File.dirname(destination))
+        FileUtils.cp(cache_destination, destination)
+      end
+    end
+  end
+end

data/lib/bridgetown-media-transformation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownMediaTransformation
+  VERSION = "0.1.0"
+end

data/lib/bridgetown-media-transformation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-media-transformation/media_transformation"
+require "bridgetown-media-transformation/builder"
+
+Bridgetown::PluginManager.new_source_manifest(
+  origin: BridgetownMediaTransformation,
+  components: File.expand_path("../components", __dir__),
+  content: File.expand_path("../content", __dir__),
+  layouts: File.expand_path("../layouts", __dir__)
+)

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bridgetown-media-transformation",
+  "version": "0.1.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/julianrubisch/bridgetown-media-transformation.git"
+  },
+  "author": "Julian Rubisch <julian@julianrubisch.at>",
+  "homepage": "https://github.com/julianrubisch/bridgetown-media-transformation",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-media-transformation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: image_optim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description:
+email: julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-media-transformation.gemspec
+- components/bridgetown_media_transformation/layout_help.liquid
+- content/bridgetown_media_transformation/example_page.md
+- content/bridgetown_media_transformation/train-on-rails.jpeg
+- layouts/bridgetown_media_transformation/layout.html
+- lib/bridgetown-media-transformation.rb
+- lib/bridgetown-media-transformation/builder.rb
+- lib/bridgetown-media-transformation/media_transformation.rb
+- lib/bridgetown-media-transformation/version.rb
+- package.json
+homepage: https://github.com/julianrubisch/bridgetown-media-transformation
+licenses:
+- MIT
+metadata:
+  yarn-add: bridgetown-media-transformation@0.1.0
+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.2.3
+signing_key:
+specification_version: 4
+summary: Image and video transformation via image_processing and ffmpeg
+test_files: []