jekyll-lazy-load-image 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7712fe91dd0b7ef1babc45a91c5a893a23efa66e00826edc877ecaafc5af6ec7
-  data.tar.gz: e5a6a60c6f15a6ec9004e58a0279a1d4b9ed79724cfa3fb86eddc03701d604dd
+  metadata.gz: b3172715c60eea86ceb441ac1b14426f5fac9acd625f6312fc46b82d7da993ca
+  data.tar.gz: 77ae96b69eb3262d3317a16d40dad04cbf5fe98ef1e043c9a7e47bf1877e5870
 SHA512:
-  metadata.gz: f3ad1ef29a57b6106dbc75c2c8561140f9c4f52a75e62f739188052e680c692bf38e47d777ea7448795e8d5d2b36f7d83483c2e1591a15993b1145b2c36c72b3
-  data.tar.gz: f13a15133e199775a19213471dbfce7270bc57807c127200b42941ed26d2c3ce0b3c75d7b050c713a0afa7b0594f574b38bc9d3946e99d44a8265df21e658542
+  metadata.gz: 1e10e503b85382c46eceaa9b13433e08a7246a5b199f6d467c6a0ad00050bb531e802a3daddfa0cdb0f389bd358865f3d128e1d8973724a48a358ccaa67dbc8a
+  data.tar.gz: 5eb99b095c9db8722a8ae31f96b350f8cf91ccbb281a532cfb2599cf10ca88d8e42015bb6ad4967478e6ac5d07875bfb17dab7492910ccb29db2037df3fe7ad5

data/.travis.yml

@@ -4,7 +4,9 @@ sudo: false
 cache: bundler
 before_install:
   - gem update bundler
-script: "bundle exec rake spec"
+script:
+  - bundle exec rubocop
+  - bundle exec rake spec
 rvm:
   - 2.4.0
   - 2.4.1

data/README.md

@@ -2,11 +2,16 @@
 
 _Edit img tag optimized lazy load images for your Jekyll site_
 
-## Install
+## Usage
+### `Gemfile`
 
-Add `gem 'jekyll-lazy-load-image'` to your site's `Gemfile` and run bundle.
+Add the following to your site's `Gemfile`:
 
-## Usage
+```ruby
+gem 'jekyll-lazy-load-image', require: 'jekyll-lazy-load-image/auto-execution'
+```
+
+and run bundle.
 
 ### `_config.yml`
 
@@ -25,37 +30,41 @@ lazy_load_image:
     "data-size": auto 
 ```
 
-### `_plugins`
+### 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)
+  
+## Custom
+### Customize container
+
+You can change applying jekyll hook container.
+This library is `:posts` by default.
 
-Add the following to your site's `_plugins/lazy-load-image.rb`:
+See also: https://jekyllrb.com/docs/plugins/#hooks
+
+#### `Gemfile`
+
+Add the following to your site's `Gemfile`:
 
 ```ruby
-Jekyll::LazyLoadImage.execute
+gem 'jekyll-lazy-load-image'
 ```
 
-#### Change container
+#### `_plugins`
 
-If you want to change applying container, please add the following:
+Add the following to your site's `_plugins`, for example create `_plugins/lazy-load-image.rb`:
 
 ```ruby
-Jekyll::LazyLoadImage.configure do |config|
+JekyllLazyLoadImage.configure do |config|
   config.owners = %i[posts documents]
 end
 
-Jekyll::LazyLoadImage.execute
+JekyllLazyLoadImage.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.

data/jekyll-lazy-load-image.gemspec

@@ -6,7 +6,7 @@ require "jekyll-lazy-load-image/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-lazy-load-image"
-  spec.version       = Jekyll::LazyLoadImage::VERSION
+  spec.version       = JekyllLazyLoadImage::VERSION
   spec.authors       = ["Tadayuki Onishi"]
   spec.email         = ["tt.tanishi100@gmail.com"]
   spec.summary       = "Edit img tag optimized lazy load images for your Jekyll site"

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

@@ -1,4 +1,32 @@
 # frozen_string_literal: true
 
+require "jekyll"
+
 require "jekyll-lazy-load-image/version"
-require "jekyll/lazy_load_image"
+require "jekyll-lazy-load-image/config"
+require "jekyll-lazy-load-image/site-config"
+require "jekyll-lazy-load-image/translator"
+
+module JekyllLazyLoadImage
+  HOOK_KEY = :jekyll_lazy_load_image
+
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def execute
+      Jekyll::Hooks.register(config.owners, :post_render) do |post|
+        site_config = JekyllLazyLoadImage::SiteConfig.new(
+          post.site.config[JekyllLazyLoadImage::SiteConfig::CONFIG_KEY]
+        )
+        auto_lazy_load_image = JekyllLazyLoadImage::Translator.new(post.output, site_config)
+        post.output = auto_lazy_load_image.translate
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "jekyll-lazy-load-image"
+
+JekyllLazyLoadImage.execute

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JekyllLazyLoadImage
+  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

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module JekyllLazyLoadImage
+  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

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module JekyllLazyLoadImage
+  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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-lazy-load-image
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tadayuki Onishi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-28 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -71,12 +71,11 @@ files:
 - bin/setup
 - jekyll-lazy-load-image.gemspec
 - lib/jekyll-lazy-load-image.rb
+- lib/jekyll-lazy-load-image/auto-execution.rb
+- lib/jekyll-lazy-load-image/config.rb
+- lib/jekyll-lazy-load-image/site-config.rb
+- lib/jekyll-lazy-load-image/translator.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

data/lib/jekyll/lazy_load_image.rb

@@ -1,45 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-# 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

@@ -1,46 +0,0 @@
-# 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

@@ -1,72 +0,0 @@
-# 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