jekyll-srcset-hook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54aa1448f897d2e33593aa63b890dd225cac028cf902f95a38a1ad878ed13aa8
+  data.tar.gz: 3391cd5b3421fe9265278422bb30e04227bd529c315a2f99807c0421521a6570
+SHA512:
+  metadata.gz: b91d045a1b60f0c6359456c0fd2d6ab597d80214fcab8ffc51e7b54b4f05cc12e47aa645fe7bc556a1846f498a95c876c978e0da338b14f8b89eee7a28a62010
+  data.tar.gz: 69b734c68d77977c841aa833de57dde0484d3ef90876e6fe2aa011c7626ce171deade56f2b4352ae877112c5201b78d0fff6aca73a5b843dc966de78dfeabe5e

data/.prettierignore

@@ -0,0 +1 @@
+*.md

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-10-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 95389546+juicy-g@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-srcset-hook.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jocelyn Gaudette
+
+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,89 @@
+# Jekyll-srcset-hook
+
+A Jekyll plugin to add srcset and sizes attributes to images without Liquid tags.
+
+This plugin is intended to be used with media libraries in the cloud like ImageKit.
+
+For example, it will take images in posts written in Markdown:
+
+```
+![alt text](https://ik.imagekit.io/your_imagekit_id/image.jpg)
+```
+
+And change them to (based on the config in `_config.yml`):
+
+```
+<img src="https://ik.imagekit.io/your_imagekit_id/image.jpg" alt="alt text"
+     srcset="https://ik.imagekit.io/your_imagekit_id/image.jpg?tr=w-300 300w,
+             https://ik.imagekit.io/your_imagekit_id/image.jpg?tr=w-600 600w,
+             https://ik.imagekit.io/your_imagekit_id/image.jpg?tr=w-900 900w"
+     sizes="(max-width: 300px) 100vw, (max-width: 600px) 50vw, (max-width: 900px) 33vw, 900px"
+/>
+```
+
+## Installation
+
+Add gem 'jekyll-srcset-hook' to the `jekyll_plugin` group in your `Gemfile`:
+
+```
+source 'https://rubygems.org'
+
+gem 'jekyll'
+
+group :jekyll_plugins do
+  gem 'jekyll-srcset-hook'
+end
+```
+
+Then run `bundle` to install the gem.
+
+## Configuration
+
+In `_config.yml` add one of the configuration below. By default, `jekyll-srcset-hook` will apply to both posts and pages:
+
+```
+jekyll-srcset-hook:
+    url_endpoint: https://ik.imagekit.io/your_imagekit_id/
+    transformations_widths: ["?tr=w-300 300w", "?tr=w-600 600w", "?tr=w-900 900w"]
+    sizes: "(max-width: 300px) 100vw, (max-width: 600px) 50vw, (max-width: 900px) 33vw, 900px"
+```
+
+Individual configuration for images in posts and pages can be provided independently using the same URL endpoint:
+
+```
+jekyll-srcset-hook:
+    url_endpoint: https://ik.imagekit.io/your_imagekit_id/
+    posts:
+        transformations_widths: ["?tr=w-300 300w", "?tr=w-600 600w", "?tr=w-900 900w"]
+        sizes: "(max-width: 300px) 100vw, (max-width: 600px) 50vw, (max-width: 900px) 33vw, 900px"
+    pages:
+        transformations_widths: ["?tr=w-480 480w", "?tr=w-800 800w"]
+        sizes: "(max-width: 600px) 480px, 800px"
+```
+
+Or with separate endpoints:
+
+```
+jekyll-srcset-hook:
+    posts:
+        url_endpoint: https://ik.imagekit.io/your_imagekit_id1/
+        transformations_widths: ["?tr=w-300 300w", "?tr=w-600 600w", "?tr=w-900 900w"]
+        sizes: "(max-width: 300px) 100vw, (max-width: 600px) 50vw, (max-width: 900px) 33vw, 900px"
+    pages:
+        url_endpoint: https://ik.imagekit.io/your_imagekit_id2/
+        transformations_widths: ["?tr=w-480 480w", "?tr=w-800 800w"]
+        sizes: "(max-width: 600px) 480px, 800px"
+```
+
+## Usage
+
+`jekyll-srcset-hook` will not modify images with the `src` attribute which do not begin with the `url_endpoint` value so
+it can be used with local images or images from other sources.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-srcset-hook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-srcset-hook/blob/main/CODE_OF_CONDUCT.md).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/jekyll-srcset-hook/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module SrcsetHook
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-srcset-hook.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module JekyllSrcsetHook
+  @@config = {}
+
+  def set_config
+    proc do |site|
+      @@config = site.config["jekyll-srcset-hook"]
+
+      if @@config.nil?
+        Jekyll.logger.warn(
+          "WARNING: jekyll-srcset-hook configuration is not present in _config.yml",
+        )
+        next
+      end
+
+      unless @@config["transformations_widths"].nil? && @@config["sizes"].nil?
+        Jekyll::Hooks.register(:posts, :post_render, &modify_post_output)
+        Jekyll::Hooks.register(:pages, :post_render, &modify_page_output)
+      end
+
+      unless @@config["posts"].nil?
+        Jekyll::Hooks.register(:posts, :post_render, &modify_post_output)
+      end
+
+      unless @@config["pages"].nil?
+        Jekyll::Hooks.register(:pages, :post_render, &modify_page_output)
+      end
+    end
+  end
+
+  def modify_post_output
+    proc do |post|
+      # posts are fragments (i.e. no DOCTYPE declaration/<html>...</html>)
+      fragment = Nokogiri::HTML5.fragment(post.content)
+      fragment
+        .xpath(".//img")
+        .each do |image|
+          if image[:src].start_with?(
+               @@config["url_endpoint"] || @@config["posts"]["url_endpoint"],
+             )
+            original_image = image
+            original_image = original_image.to_s.gsub!(">", " />")
+
+            image =
+              process_image(
+                image,
+                @@config["transformations_widths"] ||
+                  @@config["posts"]["transformations_widths"],
+                @@config["sizes"] || @@config["posts"]["sizes"],
+              )
+
+            post.output.gsub!(original_image, image)
+          end
+        end
+    end
+  end
+
+  def modify_page_output
+    proc do |page|
+      doc = Nokogiri.HTML5(page.content)
+      elements = doc.xpath(".//body//img")
+      # for some reason, need to remove last element as it is empty
+      elements.pop
+
+      elements.each do |image|
+        if image[:src].start_with?(
+             @@config["url_endpoint"] || @@config["pages"]["url_endpoint"],
+           )
+          original_image = image
+          original_image = original_image.to_s.gsub!(">", " />")
+
+          image =
+            process_image(
+              image,
+              @@config["transformations_widths"] ||
+                @@config["pages"]["transformations_widths"],
+              @@config["sizes"] || @@config["pages"]["sizes"],
+            )
+
+          page.output.gsub!(original_image, image)
+        end
+      end
+    end
+  end
+
+  def process_image(image, transformations, sizes)
+    srcset_value = ""
+    transformations.each { |t_w| srcset_value += "#{image[:src]}#{t_w}, " }
+    # remove the extra ", " at the end of srcset_value
+    srcset_value.chomp!(", ")
+    # add the attributes to the image
+    image[:srcset] = srcset_value
+    image[:sizes] = sizes
+    image.to_s.gsub!(">", " />")
+  end
+
+  module_function :set_config
+  module_function :modify_post_output
+  module_function :modify_page_output
+  module_function :process_image
+
+  Jekyll::Hooks.register(:site, :after_init, &set_config)
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-srcset-hook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jocelyn Gaudette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.8
+description: 
+email:
+- 95389546+juicy-g@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".prettierignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/jekyll-srcset-hook.rb
+- lib/jekyll-srcset-hook/version.rb
+homepage: https://github.com/juicy-g/jekyll-srcset-hook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/juicy-g/jekyll-srcset-hook
+  source_code_uri: https://github.com/juicy-g/jekyll-srcset-hook
+  changelog_uri: https://github.com/juicy-g/jekyll-srcset-hook/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to add srcset and sizes attributes to images without Liquid
+  tags.
+test_files: []