jekyll-is-hookdown 0.8.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da37ba1fb35409ea8c632c8b1febf8817e2661ceab9274ba2bef23c020147826
+  data.tar.gz: 868079cadc51e00b6d19bedcbc0df7bf1640201259e0117300b5c09e199dd921
+SHA512:
+  metadata.gz: b2c250e14593802d2c3af5cd6d930e565887f59cbd5d19bf2e99e7f50e6ffaa402089053cf1dda892ec04723509192146da477294cd96e16c5ca71aba40e5cd8
+  data.tar.gz: 6fa6ba530ea69d14144718491864d6a995ca0c3835c543c8e2b45b32a2b125943fb3f2ce84dbcef17ab257b52cea33bdf36b43c6d5a6bb9a551e16a33e49d89a

data/LICENSE

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README.md

@@ -0,0 +1,3 @@
+# jekyll-is-hookdown
+
+Hooked Kramdown for Jekyll

data/lib/jekyll-is/hookdown/converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+require_relative 'jekyll_patch'
+
+class Jekyll::Converters::Markdown::Hookdown < Jekyll::Converters::Markdown::KramdownParser
+
+  def convert content
+    document = Kramdown::JekyllDocument.new content, @config
+    page = JekyllIS::Hookdown::current_page
+    case page
+    when Jekyll::Page
+      Jekyll::Hooks::trigger :pages, :post_parse, page, document
+    when Jekyll::Document
+      Jekyll::Hooks::trigger :documents, :post_parse, page, document
+      if page.respond_to?(:collection) && page.collection&.label == 'posts'
+        Jekyll::Hooks::trigger :posts, :post_parse, page, document
+      end
+    else
+      Jekyll::logger.warn JekyllIS::Hookdown::Info::NAME, "Unknown page type: #{ page.inspect }"
+    end
+    html_output = document.to_html
+    if @config['show_warnings']
+      document.warnings.each do |warning|
+        Jekyll::logger.warn 'Kramdown warning:', warning
+      end
+    end
+    html_output
+  end
+
+end

data/lib/jekyll-is/hookdown/extra.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'kramdown'
+
+require_relative 'jekyll_patch'
+
+module JekyllIS::Hookdown
+
+  class << self
+
+    def register_element_hook owner, *elements, priority: Jekyll::Hooks::DEFAULT_PRIORITY, &block
+      if enabled?
+        priority = Jekyll::Hooks::priority_value(priority)
+        owners = owner.is_a?(Enumerable) ? owner.to_set : Set[ owner ]
+        setup_element_hooks
+        obj = { priority: priority, block: block, owners: owners, elements: elements.to_set }
+        idx = @hooks.find_index { priority <= it[:priority] }
+        if idx
+          @hooks.insert idx, obj
+        else
+          @hooks.push obj
+        end
+        block
+      else
+        false
+      end
+    end
+
+    def unregister_element_hook block
+      if @hooks
+        @hooks.reject! { it[:block] == block }
+      end
+    end
+
+    private
+
+    def process_element page, kind, collection, element, parent: nil, index: nil
+      @hooks.reverse_each do |obj|
+        next unless obj[:elements].include?(element.type)
+        next unless obj[:owners].include?(kind) || obj[:owners].include?(collection)
+        block = obj[:block]
+        result = block.call page, element
+        case result
+        when Kramdown::Element
+          element = result
+          parent.children[index] = element if parent && parent.children && index
+        when nil
+          # do nothing
+        when :delete
+          element = nil
+          parent.children[index] = element if parent && parent.children && index
+          break
+        else
+          Jekyll::logger.error JekyllIS::Hookdown::Info::NAME, "Invalid hook response: #{ result.inspect }"
+        end
+      end
+      if element && element.children
+        element.children.each_with_index do |child, idx|
+          process_element page, kind, collection, child, parent: element, index: idx
+        end
+        element.children.compact!
+      end
+      element
+    end
+
+    def setup_element_hooks
+      unless @hooks
+        @hooks = []
+        Jekyll::Hooks.register [ :pages, :documents ], :post_parse do |page, document|
+          kind = case page
+          when Jekyll::Page
+            :pages
+          when Jekyll::Document
+            :documents
+          else
+            nil
+          end
+          collection = if page.respond_to?(:collection)
+            page.collection&.label&.to_sym
+          else
+            nil
+          end
+          process_element page, kind, collection, document.root
+        end
+      end
+    end
+
+  end
+
+end

data/lib/jekyll-is/hookdown/info.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module JekyllIS; end
+
+module JekyllIS::Hookdown; end
+
+module JekyllIS::Hookdown::Info
+
+  NAME     = 'jekyll-is-hookdown'
+  VERSION  = '0.8.0.4'
+  SUMMARY  = 'Hooked Kramdown for Jekyll'
+  LICENSE  = 'LGPL-3.0-or-later'
+  AUTHOR   = 'Ivan Shikhalev'
+  EMAIL    = 'shikhalev@gmail.com'
+  HOMEPAGE = 'https://github.com/jekyll-is/jekyll-is-hookdown'
+  PATH     =  File.expand_path '../../../..', __FILE__
+
+end

data/lib/jekyll-is/hookdown/jekyll_patch.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+require_relative 'info'
+
+module JekyllIS::Hookdown
+
+  class << self
+
+    def apply_patch
+      registry = Jekyll::Hooks.instance_variable_get :@registry
+      [ :pages, :posts, :documents ].each do |owner|
+        registry[owner][:post_parse] ||= [] if registry[owner]
+      end
+    end
+
+    def current_page
+      Thread::current[:hookdown_current_page]
+    end
+
+    def current_page= value
+      Thread::current[:hookdown_current_page] = value
+    end
+
+    def enabled?
+      Jekyll::configuration['markdown'] == 'Hookdown'
+    end
+
+  end
+
+end
+
+if JekyllIS::Hookdown::enabled?
+
+  JekyllIS::Hookdown::apply_patch
+
+  Jekyll::Hooks::register [ :pages, :documents ], :pre_render do |page|
+    JekyllIS::Hookdown::current_page = page
+  end
+
+  Jekyll::Hooks::register [ :pages, :documents ], :post_render do |page|
+    if JekyllIS::Hookdown::current_page == page
+      JekyllIS::Hookdown::current_page = nil
+    else
+      Jekyll::logger.warn JekyllIS::Hookdown::Info::NAME, "Mismatch pages: #{ page.inspect } vs #{ JekyllIS::Hookdown::current_page.inspect }"
+    end
+  end
+
+end

data/lib/jekyll-is/hookdown.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'hookdown/jekyll_patch'
+require_relative 'hookdown/converter'
+require_relative 'hookdown/extra'

data/lib/jekyll-is-hookdown.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'jekyll-is/hookdown'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-is-hookdown
+version: !ruby/object:Gem::Version
+  version: 0.8.0.4
+platform: ruby
+authors:
+- Ivan Shikhalev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Hooked Kramdown for Jekyll.
+email:
+- shikhalev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-is-hookdown.rb
+- lib/jekyll-is/hookdown.rb
+- lib/jekyll-is/hookdown/converter.rb
+- lib/jekyll-is/hookdown/extra.rb
+- lib/jekyll-is/hookdown/info.rb
+- lib/jekyll-is/hookdown/jekyll_patch.rb
+homepage: https://github.com/jekyll-is/jekyll-is-hookdown
+licenses:
+- LGPL-3.0-or-later
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Hooked Kramdown for Jekyll
+test_files: []