jekyll-lazy-load-image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7712fe91dd0b7ef1babc45a91c5a893a23efa66e00826edc877ecaafc5af6ec7
+  data.tar.gz: e5a6a60c6f15a6ec9004e58a0279a1d4b9ed79724cfa3fb86eddc03701d604dd
+SHA512:
+  metadata.gz: f3ad1ef29a57b6106dbc75c2c8561140f9c4f52a75e62f739188052e680c692bf38e47d777ea7448795e8d5d2b36f7d83483c2e1591a15993b1145b2c36c72b3
+  data.tar.gz: f13a15133e199775a19213471dbfce7270bc57807c127200b42941ed26d2c3ce0b3c75d7b050c713a0afa7b0594f574b38bc9d3946e99d44a8265df21e658542

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,71 @@
+---
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - bin/**/*
+    - exe/**/*
+    - benchmark/**/*
+    - script/**/*
+    - vendor/**/*
+    - tmp/**/*
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 24
+
+Metrics/BlockLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+  IgnoredPatterns:
+    - '\A\s*#'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%q": "{}"
+    "%Q": "{}"
+    "%r": "!!"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+language: ruby
+sudo: false
+cache: bundler
+before_install:
+  - gem update bundler
+script: "bundle exec rake spec"
+rvm:
+  - 2.4.0
+  - 2.4.1
+  - 2.4.2
+  - 2.4.3
+  - 2.4.4
+  - 2.5.0
+  - 2.5.1

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.7.0"
+gem "rubocop", "~> 0.58"
+
+group :test do
+  gem "pry-byebug"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tadayuki Onishi
+
+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,73 @@
+# Jekyll LazyLoadImage [![Build Status](https://travis-ci.org/kenchan0130/jekyll-lazy-load-image.svg?branch=master)](https://travis-ci.org/kenchan0130/jekyll-lazy-load-image)
+
+_Edit img tag optimized lazy load images for your Jekyll site_
+
+## Install
+
+Add `gem 'jekyll-lazy-load-image'` to your site's `Gemfile` and run bundle.
+
+## Usage
+
+### `_config.yml`
+
+Add the following to your site's `_config.yml`:
+
+```yaml
+lazy_load_image:
+  src_attr_name: data-src # [required] You need to specify the attributes to be saved for lazy loading
+  preload_image: /path/to/image # [optional] you can add a data uri or loading image as fallback src
+  class_attr_values: # [optional] if you want to add custom class value, please add values
+    - lazyload
+  ignore_selectors: # [optional] if you want to ignore applying lazy load image, please add selector (css or xpath)
+    - ".ignore-lazy-image-load"
+    - "/*[@class='ignore-lazy-image-load']"
+  additional_attrs: # [optional] if you want to add attributes, please add key value
+    "data-size": auto 
+```
+
+### `_plugins`
+
+Add the following to your site's `_plugins/lazy-load-image.rb`:
+
+```ruby
+Jekyll::LazyLoadImage.execute
+```
+
+#### Change container
+
+If you want to change applying container, please add the following:
+
+```ruby
+Jekyll::LazyLoadImage.configure do |config|
+  config.owners = %i[posts documents]
+end
+
+Jekyll::LazyLoadImage.execute
+```
+
+Default is `:posts` only.
+
+See also: https://jekyllrb.com/docs/plugins/#hooks
+
+### Select lazy load library
+
+Select your favorite library and add your site. For example:
+  - [lazysizes](https://github.com/aFarkas/lazysizes) [Recommend]
+  - [Echo.js](https://github.com/toddmotto/echo)
+  - [TADA](https://github.com/fallroot/tada)
+  
+## Development
+
+- Use `bin/setup` to setup your local development environment.
+- Use `bin/console` to load a local Pry console with the Gem.
+
+## Testing
+
+- `bundle exec rake spec`
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a 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/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll-lazy-load-image"
+
+require "pry"
+Pry.start
+

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/jekyll-lazy-load-image.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-lazy-load-image/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-lazy-load-image"
+  spec.version       = Jekyll::LazyLoadImage::VERSION
+  spec.authors       = ["Tadayuki Onishi"]
+  spec.email         = ["tt.tanishi100@gmail.com"]
+  spec.summary       = "Edit img tag optimized lazy load images for your Jekyll site"
+  spec.homepage      = "https://github.com/kenchan0130/jekyll-lazy-load-image"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r!^(test|spec|features)/!)
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency "jekyll", "~> 3.8"
+  spec.add_dependency "nokogiri", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+end

data/lib/jekyll-lazy-load-image.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "jekyll-lazy-load-image/version"
+require "jekyll/lazy_load_image"

data/lib/jekyll-lazy-load-image/version.rb

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

data/lib/jekyll/lazy_load_image.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll/lazy_load_image/config"
+require "jekyll/lazy_load_image/site_config"
+require "jekyll/lazy_load_image/lazy_hooks"
+require "jekyll/lazy_load_image/translator"
+
+module Jekyll
+  module LazyLoadImage
+    class << self
+      def configure
+        yield(config)
+      end
+
+      def config
+        @config ||= Config.new
+      end
+
+      def execute
+        Jekyll::LazyLoadImage::LazyHooks.run_load_hooks(hook_key)
+      end
+
+      def register_hook
+        Jekyll::LazyLoadImage::LazyHooks.on_load(hook_key) do
+          Jekyll::Hooks.register(config.owners, :post_render) do |post|
+            site_config = Jekyll::LazyLoadImage::SiteConfig.new(
+              post.site.config[Jekyll::LazyLoadImage::SiteConfig::CONFIG_KEY]
+            )
+            auto_lazy_load_image = Jekyll::LazyLoadImage::Translator.new(post.output, site_config)
+            post.output = auto_lazy_load_image.translate
+          end
+        end
+      end
+
+      private
+
+      def hook_key
+        :jekyll_lazy_load_image
+      end
+    end
+  end
+end
+
+Jekyll::LazyLoadImage.register_hook

data/lib/jekyll/lazy_load_image/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LazyLoadImage
+    class Config
+      ALLOWED_JEKYLL_HOOK_CONTAINERS = %i[documents pages posts site].freeze
+      DEFAULT_CONTAINERS = %i[posts].freeze
+
+      def owners
+        @owners || DEFAULT_CONTAINERS
+      end
+
+      def owners=(value)
+        return if value.nil? || value.empty?
+        @owners = Array(value).map(&:to_sym).tap do |owners_prospective|
+          not_allowed_hooks = ALLOWED_JEKYLL_HOOK_CONTAINERS & owners_prospective
+          raise ArgumentError, "The owners option must be #{ALLOWED_JEKYLL_HOOK_CONTAINERS.join(" or ")}." if not_allowed_hooks.size.zero?
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/lazy_load_image/lazy_hooks.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LazyLoadImage
+    module LazyHooks
+      @load_hooks = Hash.new { |h, k| h[k] = [] }
+      @loaded = Hash.new { |h, k| h[k] = [] }
+
+      class << self
+        def on_load(name, options = {}, &block)
+          @loaded[name].each do |base|
+            execute_hook(base, options, block)
+          end
+
+          @load_hooks[name] << [block, options]
+        end
+
+        def run_load_hooks(name, base = Object)
+          @loaded[name] << base
+          @load_hooks[name].each do |hook, options|
+            execute_hook(base, options, hook)
+          end
+        end
+
+        private
+
+        def execute_hook(base, options, block)
+          if options[:yield]
+            block.call(base)
+          else
+            base.instance_eval(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/lazy_load_image/site_config.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LazyLoadImage
+    class SiteConfig
+      CONFIG_KEY = "lazy_load_image"
+
+      def initialize(lazy_load_image_config)
+        @lazy_load_image_config = lazy_load_image_config
+      end
+
+      def additional_attrs
+        config_key = "additional_attrs"
+        @additional_attrs ||= (@lazy_load_image_config&.[](config_key) || {}).tap do |attrs|
+          raise "#{config_key} must be associative array. But passed #{attrs || "nil"}" unless attrs.is_a?(Hash)
+        end
+      end
+
+      def class_attr_values
+        config_key = "class_attr_values"
+        @class_attr_values ||= Array(
+          @lazy_load_image_config&.[](config_key)
+        ).compact
+      end
+
+      def ignore_selectors
+        config_key = "ignore_selectors"
+        @ignore_selectors ||= Array(
+          @lazy_load_image_config&.[](config_key)
+        ).map(&:to_s).reject(&:empty?)
+      end
+
+      def preload_image
+        config_key = "preload_image"
+        @preload_image ||= @lazy_load_image_config&.[](config_key).to_s.strip
+      end
+
+      def src_attr_name
+        config_key = "src_attr_name"
+        @src_attr_name ||= @lazy_load_image_config&.[](config_key).to_s.strip.tap do |name|
+          raise "You must set #{config_key} config attribute of #{CONFIG_KEY}" if name.empty?
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/lazy_load_image/translator.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module Jekyll
+  module LazyLoadImage
+    class Translator
+      def initialize(document, site_config)
+        @document = document
+        @site_config = site_config
+      end
+
+      def translate
+        nokogiri_doc.xpath("//img").each do |node|
+          next if ignore_node?(node)
+          apply_lazy_image_setting(node)
+          inject_class_attr(node)
+          inject_additional_attrs(node)
+        end
+        nokogiri_doc.to_html.gsub(/[\r\n]/, "")
+      end
+
+      private
+
+      def ignore_node?(node)
+        !@site_config.ignore_selectors.empty? && node.matches?(*@site_config.ignore_selectors)
+      end
+
+      def apply_lazy_image_setting(node)
+        node_src_attr = node.attributes["src"]
+        return if node_src_attr.nil?
+
+        src_value = node_src_attr.value
+        if @site_config.preload_image.empty?
+          node.remove_attribute("src")
+        else
+          node.attributes["src"].value = @site_config.preload_image
+        end
+
+        node.set_attribute(@site_config.src_attr_name, src_value)
+      end
+
+      def inject_class_attr(node)
+        class_value = node.attributes["class"]&.value
+        return if class_value.nil? && @site_config.class_attr_values.empty?
+
+        node.set_attribute("class", "") if class_value.nil?
+        node_class_attr = node.attributes["class"]
+        class_array_option = [node_class_attr.value, @site_config.class_attr_values].flatten
+        class_array = class_array_option.reject do |class_name|
+          class_name.nil? || class_name.empty?
+        end
+
+        node_class_attr.value = normalize_class_array(class_array)
+      end
+
+      def inject_additional_attrs(node)
+        @site_config.additional_attrs.each do |key, value|
+          node.set_attribute(key, value)
+        end
+      end
+
+      def nokogiri_doc
+        @nokogiri_doc ||= Nokogiri::HTML(@document)
+      end
+
+      def normalize_class_array(array)
+        array.map(&:strip).uniq.join(" ")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-lazy-load-image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tadayuki Onishi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: 
+email:
+- tt.tanishi100@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-lazy-load-image.gemspec
+- lib/jekyll-lazy-load-image.rb
+- lib/jekyll-lazy-load-image/version.rb
+- lib/jekyll/lazy_load_image.rb
+- lib/jekyll/lazy_load_image/config.rb
+- lib/jekyll/lazy_load_image/lazy_hooks.rb
+- lib/jekyll/lazy_load_image/site_config.rb
+- lib/jekyll/lazy_load_image/translator.rb
+homepage: https://github.com/kenchan0130/jekyll-lazy-load-image
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Edit img tag optimized lazy load images for your Jekyll site
+test_files: []