camaleon_lazy_loader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99d95927998d9190267e103d225c2bd99afcf333d0b38735bf2367b69eabc3f1
+  data.tar.gz: 6df42f838d97c1c86b88800ad1730b24bf426982be90a68ec867ec1d66fd2d92
+SHA512:
+  metadata.gz: d45e431f0c1c0a6d01393437c8bfa2fc7b7f660e51eba0c0e797baef36440cb19a889bb1dfdcce70df5cc92e2225b4916cafd7418c0a73fcfff9f9839ac89913
+  data.tar.gz: 925c55e4794ac8396497d8c70dbd9d3a8fc7b70be044152f0617849ff555e74a92ddb2cf3b65d05d103e77a05b108dbe255f31957eb45c16ce4a424d6542e670

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Brian Kephart
+
+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,28 @@
+# CamaleonLazyLoader
+This plugin adds a `loading="lazy"` attribute to `<img>` and `<iframe>` tags rendered by [Camaleon CMS](https://github.com/owen2345/camaleon-cms).
+- This attribute will be added to tags on all server-rendered pages.
+- Existing loading attributes will not be overwritten, so you can still set individual tags to `loading="eager"` or `loading="auto"`
+
+## Usage
+Just turn on the plugin in your admin settings.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camaleon_lazy_loader'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+- Fork the repo.
+- Make your changes and add tests as necessary.
+- Run `standardrb` to lint your code.
+- Submit a pull request.
+
+## 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,32 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "CamaleonLazyLoader"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/helpers/plugins/camaleon_lazy_loader/main_helper.rb

@@ -0,0 +1,25 @@
+module Plugins::CamaleonLazyLoader::MainHelper
+  def self.included(klass)
+  end
+
+  def clear_front_cache(_plugin)
+    front_cache_clean
+  end
+
+  def apply_lazy_loading(html)
+    doc = Nokogiri::HTML::DocumentFragment.parse html
+    nodes = doc.css "img, iframe"
+    nodes.each { |node| node["loading"] ||= "lazy" }
+    doc.to_html
+  end
+
+  def camaleon_lazy_loader_front_after_load
+    return if @_plugin_do_cache # Do not process when reading from cache.
+    response.body = apply_lazy_loading response.body
+  end
+
+  def camaleon_lazy_loader_front_cache_writing_cache(args)
+    args[:data] = apply_lazy_loading args[:data] # Save processed HTML to cache.
+    response.body = apply_lazy_loading response.body
+  end
+end

data/config/camaleon_plugin.json

@@ -0,0 +1,14 @@
+{
+  "title": "Camaleon Lazy Loader",
+  "descr": "Adds a browser-native loading=\"lazy\" attribute to images and iframes.",
+  "key": "camaleon_lazy_loader",
+  "helpers": [
+    "Plugins::CamaleonLazyLoader::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["clear_front_cache"],
+    "on_inactive": ["clear_front_cache"],
+    "front_cache_writing_cache": ["camaleon_lazy_loader_front_cache_writing_cache"],
+    "front_after_load": ["camaleon_lazy_loader_front_after_load"]
+  }
+}

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "plugin_routes"
+require "camaleon_cms/engine"

data/lib/camaleon_lazy_loader.rb

@@ -0,0 +1,3 @@
+require "camaleon_lazy_loader/engine"
+
+module CamaleonLazyLoader; end

data/lib/camaleon_lazy_loader/engine.rb

@@ -0,0 +1,4 @@
+module CamaleonLazyLoader
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/camaleon_lazy_loader/version.rb

@@ -0,0 +1,3 @@
+module CamaleonLazyLoader
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: camaleon_lazy_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Kephart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: camaleon_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: standard
+  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'
+description: Adds browser-native loading="lazy" attribute to images and iframes rendered
+  by Camaleon CMS.
+email:
+- briantkephart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/plugins/camaleon_lazy_loader/main_helper.rb
+- config/camaleon_plugin.json
+- config/routes.rb
+- lib/camaleon_lazy_loader.rb
+- lib/camaleon_lazy_loader/engine.rb
+- lib/camaleon_lazy_loader/version.rb
+homepage: https://github.com/brian-kephart/camaleon_lazy_loader
+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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Adds browser-native loading="lazy" attribute to images and iframes rendered
+  by Camaleon CMS.
+test_files: []