jekyll-loading-lazy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b52a336938ddae6efa289e04f2f1aca361bb474cefe3f2d4fffd2dad80a467e8
+  data.tar.gz: 0b86f4f49f920d1b6f2768c97ea5097549ef166da3cabccb6ed1873d1b5b973a
+SHA512:
+  metadata.gz: 741975e760fc74b014ac1398f31d3840a811720c10c1264716db7332a103ca0fbd6cd8f821b379f9b9caf1e23e78c20e82885c73d641d74e4d63035353aa7c5e
+  data.tar.gz: 6a0e1f8fe4a400357cb002a41a2ab7e86a6a427d156da1f86ca951ba1729e030fef972ade27107d778693965e920d2e99de12aac952f8ff87c8db279d17e5f33

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Gil Desmarais <jekyll-loading-lazy@desmarais.de> and approved contributors.
+
+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,70 @@
+# jekyll-loading-lazy
+
+This plugin adds `loading="lazy"` to all `img` and `iframe` tags on
+your [Jekyll site](https://jekyllrb.com/). No configuration needed.  
+If a `loading` attribute is already present nothing is changed.
+
+`loading="lazy"` causes images and iframes to load lazily without any JavaScript.
+[Browser support](https://caniuse.com/#feat=loading-lazy-attr) is growing.  
+If a browser does not support the `loading` attribute, it will directly
+(read: _blockingly_) load the resource.
+
+If you like it, be awesome and
+[_buy me a coffee_ ☕️](https://www.buymeacoffee.com/gildesmarais). Thank you!
+
+## Installation
+
+1. Add the following to your site's `Gemfile`:
+
+   ```
+   gem 'jekyll-loading-lazy'
+   ```
+
+2. add the following to your site's `_config.yml`:
+
+   ```yml
+   plugins:
+     - jekyll-loading-lazy
+   ```
+
+   **Note**: if `jekyll --version` is less than `3.5` use:
+
+   ```yml
+   gems:
+     - jekyll-loading-lazy
+   ```
+
+3. In your terminal, execute:
+
+   ```bash
+   bundle
+   ```
+4. (re)start your Jekyll server with:
+
+   ```bash
+   jekyll serve
+   ```
+
+That's basically all there is.
+In case you want to eager load some images/iframes, add `loading="eager"`
+to their tags.
+
+## Contributing
+
+1. [Fork this repository](https://github.com/gildesmarais/jekyll-loading-lazy/fork)
+2. Create your branch (`git checkout -b feat/my-new-feature)
+3. Commit your changes (`git commit -m 'Add cool feature'`)
+4. Push to the branch (git push origin feat/my-new-feature)
+5. Create a new Pull Request
+
+### Testing
+
+```bash
+rake
+```
+
+## Credits
+
+Thanks to @keithmifsud's
+[`jekyll-target-blank`](https://github.com/keithmifsud/jekyll-target-blank)
+whereon this Jekyll plugin largely bases.

data/lib/jekyll-loading-lazy.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "nokogiri"
+
+module Jekyll
+  class LoadingLazy
+    def self.process(content)
+      content.output = process_image_tags(content.output)
+    end
+
+    def self.process?(doc)
+      (doc.is_a?(Jekyll::Page) || doc.write?) && doc.output_ext == ".html" ||
+        doc.permalink&.end_with?("/")
+    end
+
+    def self.process_image_tags(html)
+      content = Nokogiri::HTML::DocumentFragment.parse(html)
+      anchors = content.css("img[src], iframe[src]")
+      anchors.each { |item| item["loading"] = "lazy" unless item["loading"] }
+      content.to_html
+    end
+
+    private_class_method :process_image_tags
+  end
+end
+
+Jekyll::Hooks.register [:pages, :documents], :post_render do |doc|
+  Jekyll::LoadingLazy.process(doc) if Jekyll::LoadingLazy.process?(doc)
+end

data/lib/jekyll-loading-lazy/version.rb

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

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-loading-lazy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gil Desmarais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Loading Lazy automatically adds loading="lazy" to <img> and <iframe>
+  tags on your Jekyll site.
+
+'
+email:
+- jekyll-loading-lazy@desmarais.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/jekyll-loading-lazy.rb
+- lib/jekyll-loading-lazy/version.rb
+homepage: https://github.com/gildesmarais/jekyll-loading-lazy
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/gildesmarais/jekyll-loading-lazy/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Automatically adds loading="lazy" to <img> and <iframe> tags.
+test_files: []