jekyll-wikilinks 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaacfcf7a6de57c6c9d002a59c332521c0883cafafc0d724b6df45bee5be3053
-  data.tar.gz: adebf54d3556e767e8c96c5d083b7dd444b9ba5747b86be28f6724b59aca9881
+  metadata.gz: 5221a2c4f1d84db636f09d707f0d55891b17be4e35946d1bad55ed743083fde1
+  data.tar.gz: c5b64c09bab070d24a6a1e4af2461e3f09b996211cb4fdff89bd2d624ca4d0b5
 SHA512:
-  metadata.gz: afc278ad86c5cae713715435216b4514d28b81d62132394ed7703eefa17794171197ddaeeb306cecef5aa111e511c14d3923fe2e5404ba4a4064305bc1f53746
-  data.tar.gz: 1357f4c985b87fc762020001acc3eed0cb6a7e900e89127690606749a6b9063349d6ed75c36a133be964256993ba0e2ea081dc88a1bc58ceb0c2ac737a131ab9
+  metadata.gz: 6732b84944cbe73c21c87bb43dbdf9006929c2110c9980507e1739df270098a8aa1f6c0f80998160189440b5bb7f5df52193cdd0af4b41c7e1e6e6d825379517
+  data.tar.gz: 1718789738c86cdb00094070a470758c60f248af37c6e0c70b34701bc5c331fdc480f64e01a04350ddd4ac6859c59d808e6afa800bb1400357987229c4671330

data/lib/jekyll-wikilinks.rb

@@ -1,68 +1,271 @@
 # frozen_string_literal: true
 require "jekyll"
+require_relative "jekyll-wikilinks/context"
+require_relative "jekyll-wikilinks/filter"
 require_relative "jekyll-wikilinks/version"
 
-# can't use converters because it does not have access to jekyll's 'site' 
-# object -- which we need to build a element's href attribute.
-class JekyllWikilinks < Jekyll::Generator
 
-	def generate(site)
-		wikilinks_collection = site.config["wikilinks_collection"]
-		wikilinks_collection = "notes" if wikilinks_collection.nil? || wikilinks_collection.empty?
-		all_notes = site.collections[wikilinks_collection].docs
-		# i like the idea, but the solution style isn't robust enough yet...
-		# all_pages = site.pages
-		all_docs = all_notes # + all_pages
-		link_extension = !!site.config["use_html_extension"] ? '.html' : ''
+module JekyllWikiLinks
+	class Generator < Jekyll::Generator
+		attr_accessor :site, :config, :md_docs, :graph_nodes, :graph_links
 
-		all_docs.each do |cur_note|
-		parse_wiki_links(site, all_docs, cur_note, link_extension)
+		# Use Jekyll's native relative_url filter
+		include Jekyll::Filters::URLFilters
+
+		CONFIG_KEY = "wikilinks"
+		CONVERTER_CLASS = Jekyll::Converters::Markdown
+		ENABLED_KEY = "enabled"
+		ENABLED_GRAPH_DATA_KEY = "enabled"
+		EXCLUDE_KEY = "exclude"
+		EXCLUDE_GRAPH_KEY = "exclude"
+		GRAPH_DATA_KEY = "d3_graph_data"
+
+		def initialize(config)
+			@config = config
+		end
+
+		def generate(site)
+			return if disabled?
+			Jekyll.logger.debug "Excluded jekyll types: ", option(EXCLUDE_KEY)
+			Jekyll.logger.debug "Excluded jekyll types in graph: ", option_graph(EXCLUDE_GRAPH_KEY)
+
+			@site = site    
+			@context = context
+
+			documents = []
+			documents += site.pages if !exclude?(:pages)
+			included_docs = site.docs_to_write.filter { |d| !exclude?(d.type) }
+			documents += included_docs
+			@md_docs = documents.select {|doc| markdown_extension?(doc.extname) }
+
+			old_config_warn()
+
+			# build links
+			md_docs.each do |document|
+				parse_wiki_links(document)
+			end
+
+			# backlinks data handling
+			@graph_nodes, @graph_links = [], []
+			md_docs.each do |document|
+				document.data['backlinks'] = get_backlinks(document)
+				if !disabled_graph_data? && !exclude_graph?(document.type)
+					generate_graph_data(document) 
+				end
+			end
+
+			if !disabled_graph_data?
+				write_graph_data()
+			end
+		end
+
+		def old_config_warn()
+			if config.include?("wikilinks_collection")
+				Jekyll.logger.warn "Deprecated: 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: https://shorty25h0r7.github.io/jekyll-wikilinks/"
+			end
+		end
+
+		def parse_wiki_links(note)
+			# Convert all Wiki/Roam-style double-bracket link syntax to plain HTML
+			# anchor tag elements (<a>) with "wiki-link" CSS class
+			md_docs.each do |note_potentially_linked_to|
+				title_from_filename = File.basename(
+					note_potentially_linked_to.basename,
+					File.extname(note_potentially_linked_to.basename)
+				)
+				
+				note_url = relative_url(note_potentially_linked_to.url) if note_potentially_linked_to&.url
+
+				# Replace double-bracketed links using note title
+				# [[feline.cats]]
+				regex_wl, cap_gr = regex_wiki_link(title_from_filename)
+				render_txt = note_potentially_linked_to.data['title'].downcase
+				note.content = note.content.gsub(
+					regex_wl,
+					"<a class='wiki-link' href='#{note_url}'>#{render_txt}</a>"
+				)
+
+				# Replace double-bracketed links with alias (right)
+				# [[feline.cats|this is a link to the note about cats]]
+				regex_wl, cap_gr = regex_wiki_link_w_alias_right(title_from_filename)
+				note.content = note.content.gsub(
+					regex_wl,
+					"<a class='wiki-link' href='#{note_url}'>#{cap_gr}</a>"
+				)
+
+				# Replace double-bracketed links with alias (left)
+				# [[this is a link to the note about cats|feline.cats]]
+				regex_wl, cap_gr = regex_wiki_link_w_alias_left(title_from_filename)
+				note.content = note.content.gsub(
+					regex_wl,
+					"<a class='wiki-link' href='#{note_url}'>#{cap_gr}</a>"
+				)
+			end
+
+			# At this point, all remaining double-bracket-wrapped words are
+			# pointing to non-existing pages, so let's turn them into disabled
+			# links by greying them out and changing the cursor
+			# vanilla wiki-links
+			regex_wl, cap_gr = regex_wiki_link()
+			note.content = note.content.gsub(
+				regex_wl,
+				"<span title='There is no note that matches this link.' class='invalid-wiki-link'>[[#{cap_gr}]]</span>"
+			)
+			# aliases -- both kinds
+			regex_wl, cap_gr = regex_wiki_link_w_alias()      
+			note.content = note.content.gsub(
+				regex_wl,
+				"<span title='There is no note that matches this link.' class='invalid-wiki-link'>[[#{cap_gr}]]</span>"
+			)
+		end
+
+		def get_backlinks(doc)
+			backlinks = []
+			md_docs.each do |backlinked_doc|
+				if backlinked_doc.content.include?(doc.url)
+					backlinks << backlinked_doc
+				end
+			end
+			return backlinks
+		end
+
+		def invalid_wiki_links(doc)
+			regex, _ = regex_invalid_wiki_link()
+			return doc.content.scan(regex)[0]
+		end
+
+		def generate_graph_data(doc)
+			Jekyll.logger.debug "Processing graph nodes for doc: ", doc.data['title']
+			# missing nodes
+			missing_node_names = invalid_wiki_links(doc)
+			if !missing_node_names.nil?
+				missing_node_names.each do |missing_node_name| 
+					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'],
+			}
+			get_backlinks(doc).each do |b|
+				if !exclude_graph?(b.type)
+					graph_links << {
+						source: relative_url(b.url),
+						target: relative_url(doc.url),
+					}
+				end
+			end
+		end
+
+		def write_graph_data()
+			# from: https://github.com/jekyll/jekyll/issues/7195#issuecomment-415696200
+			static_file = Jekyll::StaticFile.new(site, site.source, "/assets", "graph-net-web.json")
+			File.write(@site.source + static_file.relative_path, JSON.dump({
+				links: graph_links,
+				nodes: graph_nodes,
+			}))
+		end
+
+		def context
+			@context ||= JekyllWikiLinks::Context.new(site)
+		end
+
+
+		def exclude?(type)
+			return false unless option(EXCLUDE_KEY)
+			return option(EXCLUDE_KEY).include?(type.to_s)
+		end
+
+		def exclude_graph?(type)
+			return false unless option_graph(EXCLUDE_KEY)
+			return option_graph(EXCLUDE_KEY).include?(type.to_s)
+		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
+
+		def option_graph(key)
+			config[GRAPH_DATA_KEY] && config[GRAPH_DATA_KEY][key]
+		end
+
+		def disabled?
+			option(ENABLED_KEY) == false
+		end
+
+		def disabled_graph_data?
+			option_graph(ENABLED_GRAPH_DATA_KEY) == false
+		end
+
+		# regex
+		# returns two items: regex and a target capture group (text to be rendered)
+		# using functions instead of constants because of the need to access 'wiki_link_text'
+		#   -- esp. when aliasing.
+
+		def regex_invalid_wiki_link()
+			# identify missing links in note via .invalid-wiki-link class and nested note-name.
+			regex = /invalid-wiki-link[^\]]+\[\[([^\]]+)\]\]/i
+			cap_gr = "\\1" # this is mostly just to remain consistent with other regex functions
+			return regex, cap_gr
+		end
+
+		def regex_wiki_link(wiki_link_text='')
+			if wiki_link_text.empty?
+				regex = /(\[\[)([^\|\]]+)(\]\])/i
+				cap_gr = "\\2" 
+				return regex, cap_gr
+			else 
+				regex = /\[\[#{wiki_link_text}\]\]/i
+				cap_gr = wiki_link_text
+				return regex, cap_gr
+			end
+		end
+
+		def regex_wiki_link_w_alias()
+			regex = /(\[\[)([^\]\|]+)(\|)([^\]]+)(\]\])/i
+			cap_gr = "\\2|\\4"
+			return regex, cap_gr 
+		end
+
+		def regex_wiki_link_w_alias_left(wiki_link_text)
+			raise ArgumentError.new(
+				"Expected a value for 'wiki_link_text'"
+			) if wiki_link_text.nil?
+			regex = /(\[\[)([^\]\|]+)(\|)(#{wiki_link_text})(\]\])/i
+			cap_gr = "\\2"
+			return regex, cap_gr
+		end
+
+		def regex_wiki_link_w_alias_right(wiki_link_text)
+			raise ArgumentError.new(
+				"Expected a value for 'wiki_link_text'"
+			) if wiki_link_text.nil?
+			regex = /(\[\[)(#{wiki_link_text})(\|)([^\]]+)(\]\])/i
+			cap_gr = "\\4"
+			return regex, cap_gr
 		end
-	end
 
-	def parse_wiki_links(site, all_notes, note, link_extension)
-	  # some regex taken from vscode-markdown-notes: https://github.com/kortina/vscode-markdown-notes/blob/master/syntaxes/notes.tmLanguage.json   
-	  # Convert all Wiki/Roam-style double-bracket link syntax to plain HTML
-	  # anchor tag elements (<a>) with "internal-link" CSS class
-	  all_notes.each do |note_potentially_linked_to|
-	    namespace_from_filename = File.basename(
-	      note_potentially_linked_to.basename,
-	      File.extname(note_potentially_linked_to.basename)
-	    )
-
-	    # Replace double-bracketed links using note title
-	    # [[feline.cats]]
-	    # ⬜️ vscode-markdown-notes version: (\[\[)([^\|\]]+)(\]\])
-	    note.content = note.content.gsub(
-	      /\[\[#{namespace_from_filename}\]\]/i,
-	      "<a class='wiki-link' href='#{site.baseurl}#{note_potentially_linked_to.data['permalink']}#{link_extension}'>#{note_potentially_linked_to.data['title'].downcase}</a>"
-	    )
-
-	    # Replace double-bracketed links with alias (right)
-	    # [[feline.cats|this is a link to the note about cats]]
-	    # ✅ vscode-markdown-notes version: (\[\[)([^\]\|]+)(\|)([^\]]+)(\]\])
-	    note.content = note.content.gsub(
-	      /(\[\[)(#{namespace_from_filename})(\|)([^\]]+)(\]\])/i,
-	      "<a class='wiki-link' href='#{site.baseurl}#{note_potentially_linked_to.data['permalink']}#{link_extension}'>\\4</a>"
-	    )
-
-	    # Replace double-bracketed links with alias (left)
-	    # [[this is a link to the note about cats|feline.cats]]
-	    # ✅ vscode-markdown-notes version: (\[\[)([^\]\|]+)(\|)([^\]]+)(\]\])
-	    note.content = note.content.gsub(
-	      /(\[\[)([^\]\|]+)(\|)(#{namespace_from_filename})(\]\])/i,
-	      "<a class='wiki-link' href='#{site.baseurl}#{note_potentially_linked_to.data['permalink']}#{link_extension}'>\\2</a>"
-	    )
-	  end
-
-	  # At this point, all remaining double-bracket-wrapped words are
-	  # pointing to non-existing pages, so let's turn them into disabled
-	  # links by greying them out and changing the cursor
-	  note.content = note.content.gsub(
-	    /\[\[(.*)\]\]/i, # match on the remaining double-bracket links
-	    <<~HTML.chomp    # replace with this HTML (\\1 is what was inside the brackets)
-	      <span title='There is no note that matches this link.' class='invalid-wiki-link'>[[\\1]]</span>
-	    HTML
-	  )
 	end
-end
+end

data/lib/jekyll-wikilinks/context.rb

@@ -0,0 +1,15 @@
+# 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/filter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module JekyllWikiLinks
+  module BackLinkTypeFilters
+    # usage:
+    # {% assign note_backlinks = page.backlinks | backlink_type = "notes" %}
+    def backlink_type(backlinks, type)
+      return if backlinks.nil?
+      target_backlinks = []
+      backlinks.each do |bl|
+        target_backlinks << bl if self.to_string(bl.type) == type
+      end
+      return target_backlinks
+    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
+
+Liquid::Template.register_filter(JekyllWikiLinks::BackLinkTypeFilters)

data/lib/jekyll-wikilinks/version.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-module Jekyll
-  module Wikilinks
-    VERSION = "0.0.2"
-  end
-end
+module JekyllWikiLinks
+  VERSION = "0.0.3"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wikilinks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - shorty25h0r7
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -18,6 +18,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-wikilinks.rb
+- lib/jekyll-wikilinks/context.rb
+- lib/jekyll-wikilinks/filter.rb
 - lib/jekyll-wikilinks/version.rb
 homepage: https://github.com/shorty25h0r7/jekyll-wikilinks
 licenses: