redcarpet-render-html_lazy_img 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30c24e81ba6f811f456f2e27c0813761ecd5c2d81f6fbf6892ba70695f01dfe2
+  data.tar.gz: ef0c763338b19b3eb0172dce93a458754e48723a2411ce39060a649ef9119572
+SHA512:
+  metadata.gz: dd67b066021a77563a9d90cfc070d0d48887d7bf0a8cbed8b3f7d7a08ec552b30d7179f7c99f3420b921ee9c5a23be65fc3177bcae5b45af3840c8b7cf8bf41e
+  data.tar.gz: 52564a06b20d406fdaaafd634235943975a644cfd98db1985ee98c12a6489bb2ab9bd86174f146c11faf2aa765070c29c59ae191f625967fc9b033ddc662ffcc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yusuke1994525@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redcarpet-render-html_lazy_img.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yusuke Nakamura
+
+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,67 @@
+# Redcarpet::Render::HTMLLazyImg
+
+Specify "loading" attribute value to converted HTML from markdown.
+You can choose "lazy", "auto", and "eager" to loading attribite by the custom renderer class in `Redcarpet::Markdown.new`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redcarpet-render-html_lazy_img'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install redcarpet-render-html_lazy_img
+```
+
+## Usage
+
+### loding="lazy"
+```ruby
+markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTMLLazyImg::Lazy)
+markdown.render('![example image](https://example.com/img.png)')
+# => '<p><img loading="lazy" src="https://example.com/img.png" alt="example image" /></p>'
+```
+
+### loding="auto"
+```ruby
+markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTMLLazyImg::Auto)
+markdown.render('![example image](https://example.com/img.png)')
+# => '<p><img loading="auto" src="https://example.com/img.png" alt="example image" /></p>'
+```
+
+### loding="eager"
+```ruby
+markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTMLLazyImg::Eager)
+markdown.render('![example image](https://example.com/img.png)')
+# => '<p><img loading="eager" src="https://example.com/img.png" alt="example image" /></p>'
+```
+
+See also [original document of the vmg/redcarpet](https://github.com/vmg/redcarpet#and-you-can-even-cook-your-own).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/unasuke/redcarpet-render-html_lazy_img. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Redcarpet::Render::HTMLLazyImg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/unasuke/redcarpet-render-html_lazy_img/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redcarpet/render/html_lazy_img"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redcarpet/render/html_lazy_img.rb

@@ -0,0 +1,39 @@
+require 'redcarpet'
+
+module Redcarpet
+  module Render
+    module HTMLLazyImg
+      VERSION = "0.1.0"
+
+      class Base < ::Redcarpet::Render::HTML
+        def image(*)
+          raise NotImplementedError
+        end
+
+        private
+
+        def image_tag_with_loading_attr(loading:, link:, alt_text:)
+          "<img loading=\"#{loading}\" src=\"#{link}\" alt=\"#{alt_text}\" />"
+        end
+      end
+
+      class Lazy < Base
+        def image(link, _title, alt_text)
+          image_tag_with_loading_attr(loading: 'lazy', link: link, alt_text: alt_text)
+        end
+      end
+
+      class Auto < Base
+        def image(link, _title, alt_text)
+          image_tag_with_loading_attr(loading: 'auto', link: link, alt_text: alt_text)
+        end
+      end
+
+      class Eager < Base
+        def image(link, _title, alt_text)
+          image_tag_with_loading_attr(loading: 'eager', link: link, alt_text: alt_text)
+        end
+      end
+    end
+  end
+end

data/redcarpet-render-html_lazy_img.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redcarpet/render/html_lazy_img"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redcarpet-render-html_lazy_img"
+  spec.version       = Redcarpet::Render::HTMLLazyImg::VERSION
+  spec.authors       = ["Yusuke Nakamura"]
+  spec.email         = ["yusuke1994525@gmail.com"]
+
+  spec.summary       = 'Custom renderer of the redcarpet to add loading attribute to <img>.'
+  spec.description   = 'Custom renderer of the redcarpet to add loading attribute to <img>. "lazy", "auto", and "eager" are available.'
+  spec.homepage      = 'https://github.com/unasuke/redcarpet-render-html_lazy_img'
+  spec.license       = 'MIT'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/unasuke/redcarpet-render-html_lazy_img"
+  spec.metadata["changelog_uri"] = "https://github.com/unasuke/redcarpet-render-html_lazy_img/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redcarpet", "~> 3"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: redcarpet-render-html_lazy_img
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Custom renderer of the redcarpet to add loading attribute to <img>. "lazy",
+  "auto", and "eager" are available.
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redcarpet/render/html_lazy_img.rb
+- redcarpet-render-html_lazy_img.gemspec
+homepage: https://github.com/unasuke/redcarpet-render-html_lazy_img
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unasuke/redcarpet-render-html_lazy_img
+  source_code_uri: https://github.com/unasuke/redcarpet-render-html_lazy_img
+  changelog_uri: https://github.com/unasuke/redcarpet-render-html_lazy_img/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Custom renderer of the redcarpet to add loading attribute to <img>.
+test_files: []