jekyll-wikilinks 0.0.5 → 0.0.6

data/lib/jekyll-wikilinks.rb

@@ -1,192 +1,50 @@
 # frozen_string_literal: true
 require "jekyll"
 
-require_relative "jekyll-wikilinks/context"
-require_relative "jekyll-wikilinks/doc_manager"
-require_relative "jekyll-wikilinks/link_index"
-require_relative "jekyll-wikilinks/parser"
-
-require_relative "jekyll-wikilinks/filter"
 require_relative "jekyll-wikilinks/version"
 
-Liquid::Template.register_filter(JekyllWikiLinks::TypeFilters)
-
-module JekyllWikiLinks
-  class Generator < Jekyll::Generator
-		attr_accessor :site, :config, :md_docs, :doc_manager, :link_index, :parser, :graph_nodes, :graph_links
-
-		# Use Jekyll's native relative_url filter
-		include Jekyll::Filters::URLFilters
-
-		CONVERTER_CLASS = Jekyll::Converters::Markdown
-		# config
-		CONFIG_KEY = "wikilinks"
-		ENABLED_KEY = "enabled"
-		EXCLUDE_KEY = "exclude"
-		# graph config
-		GRAPH_DATA_KEY = "d3_graph_data"
-		ENABLED_GRAPH_DATA_KEY = "enabled"
-		EXCLUDE_GRAPH_KEY = "exclude"
-		GRAPH_ASSETS_LOCATION_KEY = "assets_rel_path"
-
-    # identify missing links in doc via .invalid-wiki-link class and nested doc-text.
-    REGEX_INVALID_WIKI_LINK = /invalid-wiki-link#{REGEX_NOT_GREEDY}\[\[(#{REGEX_NOT_GREEDY})\]\]/i
-
-		def initialize(config)
-			@config ||= config
-			@testing ||= config['testing'] if config.keys.include?('testing')
-		end
-
-		def generate(site)
-			return if disabled?
-      self.old_config_warn()
-			Jekyll.logger.debug "Excluded jekyll types: ", option(EXCLUDE_KEY)
-			Jekyll.logger.debug "Excluded jekyll types in graph: ", option_graph(EXCLUDE_GRAPH_KEY)
-      
-      # setup site
-			@site = site    
-			@context ||= JekyllWikiLinks::Context.new(site)
-      
-      # setup markdown docs
-			docs = []
-			docs += site.pages if !exclude?(:pages)
-			docs += site.docs_to_write.filter { |d| !exclude?(d.type) }
-			@md_docs = docs.filter {|doc| markdown_extension?(doc.extname) }
-      
-      # setup helper classes
-      @doc_manager = DocManager.new(@md_docs, @site.static_files)
-      @parser = Parser.new(@context, @markdown_converter, @doc_manager)
-      @link_index = LinkIndex.new(@site, @doc_manager)
-      
-      # parse + populate index
-      @md_docs.each do |doc|
-        @parser.parse(doc.content)
-        @link_index.populate_attributes(doc, @parser.typed_link_blocks)
-      end
-      @link_index.process
-      
-      # handle graph data
-			@graph_nodes, @graph_links = [], []
-			@md_docs.each do |doc|
-				if !disabled_graph_data? && !self.excluded_in_graph?(doc.type)
-					self.generate_graph_data(doc) 
-				end
-			end
-			if !disabled_graph_data?
-				self.write_graph_data()
-			end
-		end
-
-		# config helpers
-
-		def disabled?
-			option(ENABLED_KEY) == false
-		end
+# in order of expected execution
 
-		def exclude?(type)
-			return false unless option(EXCLUDE_KEY)
-			return option(EXCLUDE_KEY).include?(type.to_s)
-		end
-
-		def has_custom_assets_path?
-			return !!option_graph(GRAPH_ASSETS_LOCATION_KEY)
-		end
-
-		def markdown_extension?(extension)
-			markdown_converter.matches(extension)
-		end
-
-		def markdown_converter
-			@markdown_converter ||= site.find_converter_instance(CONVERTER_CLASS)
-		end
-
-		def option(key)
-			config[CONFIG_KEY] && config[CONFIG_KEY][key]
-		end
-
-		# graph config helpers
-
-		def disabled_graph_data?
-			option_graph(ENABLED_GRAPH_DATA_KEY) == false
-		end
+# setup config
+require_relative "jekyll-wikilinks/config"
+Jekyll::Hooks.register :site, :after_init do |site|
+  # global '$wiki_conf' to ensure that all local jekyll plugins
+  # are reading from the same configuration
+  # (global var is not ideal, but is DRY)
+  $wiki_conf = Jekyll::WikiLinks::PluginConfig.new(site.config)
+end
 
-		def excluded_in_graph?(type)
-			return false unless option_graph(EXCLUDE_KEY)
-			return option_graph(EXCLUDE_KEY).include?(type.to_s)
-		end
+# setup docs (based on configs)
+require_relative "jekyll-wikilinks/patch/doc_manager"
+Jekyll::Hooks.register :site, :post_read do |site|
+  if !$wiki_conf.disabled?
+    site.doc_mngr = Jekyll::WikiLinks::DocManager.new(site)
+  end
+end
 
-		def option_graph(key)
-			config[GRAPH_DATA_KEY] && config[GRAPH_DATA_KEY][key]
-		end
+# convert
+require_relative "jekyll-wikilinks/plugins/converter"
 
-		# graph helpers
+# generate
+require_relative "jekyll-wikilinks/plugins/generator"
 
-		def generate_graph_data(doc)
-			Jekyll.logger.debug "Processing graph nodes for doc: ", doc.data['title']
-			# missing nodes
-			missing_node_names = doc.content.scan(REGEX_INVALID_WIKI_LINK)
-			if !missing_node_names.nil?
-				missing_node_names.each do |missing_node_name_captures| 
-					missing_node_name = missing_node_name_captures[0]
-					if graph_nodes.none? { |node| node[:id] == missing_node_name }
-						Jekyll.logger.warn "Net-Web node missing: ", missing_node_name
-						Jekyll.logger.warn " in: ", doc.data['slug']  
-						graph_nodes << {
-							id: missing_node_name,
-							url: '',
-							label: missing_node_name,
-						}
-					end
-					graph_links << {
-						source: relative_url(doc.url),
-						target: missing_node_name,
-					}
-				end
-			end
-			# existing nodes
-			graph_nodes << {
-				id: relative_url(doc.url),
-				url: relative_url(doc.url),
-				label: doc.data['title'],
-			}
-			# TODO: this link calculation ends up with duplicates -- re-visit this later.
-			all_links = doc.data['attributed'] + doc.data['backlinks']
-			all_links.each do |link|
-        linked_doc = link['doc']
-				if !excluded_in_graph?(linked_doc.type)
-					graph_links << {
-						source: relative_url(linked_doc.url),
-						target: relative_url(doc.url),
-					}
-				end
-			end
-		end
+# convert fores
+# Jekyll::Hooks.register :documents, :pre_convert do |doc|
+#   Jekyll:WikiLinks::Parser.parse_blocks(doc)
+#   @site.link_index.populate_fores(doc, typed_link_blocks, md_docs)
+# end
 
-		def write_graph_data()
-			assets_path = has_custom_assets_path? ? option_graph(GRAPH_ASSETS_LOCATION_KEY) : "/assets"
-			if !File.directory?(File.join(site.source, assets_path))
-				Jekyll.logger.error "Assets location does not exist, please create required directories for path: ", assets_path
-			end
-			# from: https://github.com/jekyll/jekyll/issues/7195#issuecomment-415696200
-			static_file = Jekyll::StaticFile.new(site, site.source, assets_path, "graph-net-web.json")
-			# TODO: make write file location more flexible -- requiring a write location configuration feels messy...
-			File.write(@site.source + static_file.relative_path, JSON.dump({
-				links: graph_links,
-				nodes: graph_nodes,
-			}))
-			# tests fail without manually adding the static file, but actual site builds seem to do ok
-			# ...although there does seem to be a race condition which causes a rebuild to be necessary in order to detect the graph data file
-			if @testing
-				@site.static_files << static_file if !@site.static_files.include?(static_file)
-			end
-		end
+# convert backs
+# Jekyll::Hooks.register :documents, :pre_convert do |doc|
+#   Jekyll:WikiLinks::Parser.parse_inlines(doc)
+#   @site.link_index.populate_backs(doc, typed_link_blocks, md_docs)
+# end
 
-    # !! deprecated !!
+# generate metadata
+# Jekyll::Hooks.register :documents, :post_convert do |doc|
+#   Jekyll:WikiLinks::Generator.generate(doc)
+# end
 
-    def old_config_warn()
-      if config.include?("wikilinks_collection")
-        Jekyll.logger.warn "As of 0.0.3, 'wikilinks_collection' is no longer used for configs. jekyll-wikilinks will scan all markdown files by default. Check README for details."
-      end
-    end
-	end
-end
+# hook up liquid filters
+require_relative "jekyll-wikilinks/plugins/filter"
+Liquid::Template.register_filter(Jekyll::WikiLinks::TypeFilters)

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wikilinks
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-03 00:00:00.000000000 Z
-dependencies: []
+date: 2021-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.3
 description:
 email:
 - manunamz@pm.me
@@ -18,20 +46,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-wikilinks.rb
-- lib/jekyll-wikilinks/context.rb
-- lib/jekyll-wikilinks/doc_manager.rb
-- lib/jekyll-wikilinks/filter.rb
-- lib/jekyll-wikilinks/jekyll_patch.rb
-- lib/jekyll-wikilinks/link_index.rb
-- lib/jekyll-wikilinks/naming_const.rb
-- lib/jekyll-wikilinks/parser.rb
+- lib/jekyll-wikilinks/config.rb
+- lib/jekyll-wikilinks/patch/context.rb
+- lib/jekyll-wikilinks/patch/doc_manager.rb
+- lib/jekyll-wikilinks/patch/site.rb
+- lib/jekyll-wikilinks/plugins/converter.rb
+- lib/jekyll-wikilinks/plugins/filter.rb
+- lib/jekyll-wikilinks/plugins/generator.rb
+- lib/jekyll-wikilinks/util/link_index.rb
+- lib/jekyll-wikilinks/util/parser.rb
+- lib/jekyll-wikilinks/util/regex.rb
 - lib/jekyll-wikilinks/version.rb
 homepage: https://github.com/manunamz/jekyll-wikilinks
 licenses:
-- MIT
+- GPL3
 metadata:
   homepage_uri: https://github.com/manunamz/jekyll-wikilinks
   source_code_uri: https://github.com/manunamz/jekyll-wikilinks
+  changelog_uri: https://github.com/manunamz/jekyll-wikilinks/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -50,5 +82,5 @@ requirements: []
 rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
-summary: Add jekyll support for [[wikilinks]] (in markdown).
+summary: Add jekyll support for [[wikilinks]] (in markdown files).
 test_files: []

data/lib/jekyll-wikilinks/context.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllWikiLinks
-  class Context
-    attr_reader :site
-
-    def initialize(site)
-      @site = site
-    end
-
-    def registers
-      { :site => site }
-    end
-  end
-end

data/lib/jekyll-wikilinks/doc_manager.rb

@@ -1,68 +0,0 @@
-require_relative "naming_const"
-
-module JekyllWikiLinks
-  class DocManager
-		attr_accessor :md_docs, :static_files
-
-		# kramdown header regexes
-		# atx header: https://github.com/gettalong/kramdown/blob/master/lib/kramdown/parser/kramdown/header.rb#L29
-		REGEX_ATX_HEADER = /^\#{1,6}[\t ]*([^ \t].*)\n/i
-		# setext header: https://github.com/gettalong/kramdown/blob/master/lib/kramdown/parser/kramdown/header.rb#L17
-		REGEX_SETEXT_HEADER = /^ {0,3}([^ \t].*)\n[-=][-=]*[ \t\r\f\v]*\n/i
-		# obsidian-style
-		REGEX_BLOCK = /.*\s\^#{REGEX_BLOCK_ID_TXT}^\n/i
-
-		def initialize(md_docs, static_files)
-			@md_docs ||= md_docs
-			@static_files ||= static_files
-		end
-
-		def all
-			return @md_docs
-		end
-
-		def get_doc_by_fname(filename)
-      return nil if filename.nil? || @md_docs.size == 0
-			docs = @md_docs.select{ |d| File.basename(d.basename, File.extname(d.basename)) == filename }
-			return nil if docs.nil? || docs.size > 1
-			return docs[0]
-		end
-
-		def get_doc_by_url(url)
-      return nil if url.nil? || @md_docs.size == 0
-			docs = @md_docs.select{ |d| d.url == url }
-			return nil if docs.nil? || docs.size > 1
-			return docs[0]
-		end
-
-    def get_doc_content(filename)
-      return nil if filename.nil? || @md_docs.size == 0
-      docs = @md_docs.select{ |d| File.basename(d.basename, File.extname(d.basename)) == filename }
-      return docs[0].content if docs.size == 1
-      return nil
-    end
-
-		# 'bname' -> 'basename' (filename with)
-		def get_image_by_bname(filename)
-			return nil if filename.nil? || @static_files.size == 0 || !SUPPORTED_IMG_FORMATS.any?{ |ext| ext == File.extname(filename).downcase }
-			docs = @static_files.select{ |d| File.basename(d.relative_path) == filename }
-			return nil if docs.nil? || docs.size > 1
-			return docs[0]
-		end
-
-		def self.doc_has_header?(doc, header)
-			return nil if header.nil?
-			# leading + trailing whitespace is ignored when matching headers
-			header_results = doc.content.scan(REGEX_ATX_HEADER).flatten.map { |htxt| htxt.strip } 
-			setext_header_results = doc.content.scan(REGEX_SETEXT_HEADER).flatten.map { |htxt| htxt.strip } 
-			return header_results.include?(header.strip) || setext_header_results.include?(header.strip)
-		end
-
-		def self.doc_has_block_id?(doc, block_id)
-      return nil if block_id.nil?
-			# leading + trailing whitespace is ignored when matching blocks
-			block_id_results = doc.content.scan(REGEX_BLOCK).flatten.map { |bid| bid.strip } 
-			return block_id_results.include?(block_id)
-		end
-  end
-end

data/lib/jekyll-wikilinks/filter.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module JekyllWikiLinks
-  module TypeFilters
-    # 'links' accepts both untyped links, typed links, and attributes; fore and back.
-
-    # usage: {% assign note_links = page.links | doc_type = "notes" %}
-    # "doc_type" is the jekyll type ("pages", "posts", "<collection-name>")
-    def doc_type(links, doc_type)
-      return if links.nil?
-      target_links = []
-      links.each do |l|
-        target_links << l if self.to_string(l['doc'].type) == doc_type.to_str
-      end
-      return target_links.uniq
-    end
-
-    # usage: {% assign author_links = page.links | link_type = "author" %}
-    # "link_type" is the wikilink's type, the string that appears before the link in `link-type::[[wikilink]]`.
-    def link_type(links, link_type)
-      return if links.nil?
-      target_links = []
-      link.each do |l|
-        target_links << l if self.to_string(l['type'].to_str) == link_type.to_str
-      end
-      return target_links.uniq
-    end
-
-    def to_string(type)
-      return type if type.is_a?(String)
-      type = type.to_s
-      begin
-        String(type)
-      rescue ::ArgumentError
-        raise ArgumentError, "invalid type"
-      end
-    end
-  end
-end

data/lib/jekyll-wikilinks/jekyll_patch.rb

@@ -1,24 +0,0 @@
-# TODO: Would be nice to put LinkIndex-related data into real objects as opposed to sticking tons and tons of data into frontmatter...I think...
-
-# modelling off of 'related_posts': https://github.com/jekyll/jekyll/blob/6855200ebda6c0e33f487da69e4e02ec3d8286b7/lib/jekyll/document.rb#L402
-# module LinkLogic
-#   attr_accessor :attributed, :attributes, :backlinks, :forelinks
-
-#   # 'links' 'type' is 'nil' for untyped links.
-#   # 'attributes' are block-level typed forelinks; their 'type' may not be 'nil'.
-#   # 'attributed' are block-level typed backlinks; their 'type' may not be 'nil'.
-#   # [{ 'type': str, 'doc': doc }, ...]
-# end
-
-# module Jekyll
-#   class Page
-#     # it would be nice if these would only exist if the page is guaranteed to be a markdown file.
-#     include LinkLogic
-#   end
-# end
-
-# module Jekyll
-#   class Document
-#     include LinkLogic
-#   end
-# end

data/lib/jekyll-wikilinks/link_index.rb

@@ -1,81 +0,0 @@
-module JekyllWikiLinks
-  class LinkIndex
-    attr_accessor :index
-
-    # Use Jekyll's native relative_url filter
-    include Jekyll::Filters::URLFilters
-
-    REGEX_LINK_TYPE = /<a\sclass="wiki-link(\slink-type\s(?<link-type>([^"]+)))?"\shref="(?<link-url>([^"]+))">/i
-
-    def initialize(site, doc_manager)
-      @context ||= JekyllWikiLinks::Context.new(site)
-      @doc_manager ||= doc_manager
-      @index = {}
-      @doc_manager.all.each do |doc|
-        @index[doc.url] = LinksInfo.new()
-      end
-    end
-
-    def process
-      self.populate_links()
-      # apply index info to each document
-      @doc_manager.all.each do |doc|
-        doc.data['attributed'] = @index[doc.url].attributed
-        doc.data['backlinks'] = @index[doc.url].backlinks
-        doc.data['attributes'] = @index[doc.url].attributes
-        doc.data['forelinks'] = @index[doc.url].forelinks
-      end
-    end
-
-    def populate_attributes(doc, typed_link_blocks)
-      typed_link_blocks.each do |tl|
-        attr_doc = @doc_manager.get_doc_by_fname(tl.filename)
-        @index[doc.url].attributes << {
-          'type' => tl.link_type, 
-          'doc' => attr_doc,
-        }
-        @index[attr_doc.url].attributed << {
-          'type' => tl.link_type,
-          'doc' => doc,
-        }
-      end
-    end
-
-    def populate_links()
-      # for each document...
-      @doc_manager.all.each do |doc|
-        # ...process its forelinks
-        doc.content.scan(REGEX_LINK_TYPE).each do |m|
-          ltype, lurl = m[0], m[1]
-          @index[doc.url].forelinks << {
-            'type' => ltype, 
-            'doc' => @doc_manager.get_doc_by_url(lurl),
-          }
-        end
-        # ...process its backlinks
-        @doc_manager.all.each do |doc_to_backlink|
-          doc_to_backlink.content.scan(REGEX_LINK_TYPE).each do |m|
-            ltype, lurl = m[0], m[1]
-            if lurl == relative_url(doc.url)
-              @index[doc.url].backlinks << {
-                'type' => ltype, 
-                'doc' => doc_to_backlink,
-              }
-            end
-          end
-        end
-      end
-    end
-
-    class LinksInfo
-      attr_accessor :attributed, :attributes, :backlinks, :forelinks
-
-      def initialize
-        @attributed = [] # (block-level typed forelinks)
-        @attributes = [] # (block-level typed backlinks)
-        @backlinks = []
-        @forelinks = []
-      end
-    end
-  end
-end

data/lib/jekyll-wikilinks/naming_const.rb

@@ -1,21 +0,0 @@
-# naming_const.rb
-# regex constants defining supported file types and valid names for files, variables, or text
-# 
-
-module JekyllWikiLinks
-  # TODO: Fix REGEX_NOT_GREEDY
-  # REGEX_NOT_GREEDY = /[^(?!\]\])]+/i
-  # REGEX_NOT_GREEDY = /(?!\]\]).*/i
-  REGEX_NOT_GREEDY = /[^\]]+/i
-  # <variables> only work with 'match' function, not with 'scan' function. :/ 
-  # oh well...they are there for easier debugging...
-  # valid naming conventions                                       # capture indeces for WikiLinks class (0 is 'embed')
-  REGEX_LINK_TYPE_TXT = /(?<link-type-txt>([^\n\s\!\#\^\|\]]+))/i  # 1
-  REGEX_FILENAME = /(?<filename>([^\\\/:\#\^\|\[\]]+))/i           # 2
-  REGEX_HEADER_TXT = /(?<header-txt>([^\!\#\^\|\[\]]+))/i          # 3
-  REGEX_BLOCK_ID_TXT = /(?<block-id>([^\\\/:\!\#\^\|\[\]]+))/i     # 4
-  REGEX_LABEL_TXT = /(?<label-txt>(#{REGEX_NOT_GREEDY}))/i         # 5
-  
-  # from: https://docs.github.com/en/github/managing-files-in-a-repository/working-with-non-code-files/rendering-and-diffing-images
-  SUPPORTED_IMG_FORMATS = Set.new(['.png', '.jpg', '.gif', '.psd', '.svg'])
-end