jekyll-wikilinks 0.0.3 → 0.0.7

data/lib/jekyll-wikilinks.rb

@@ -1,271 +1,50 @@
 # frozen_string_literal: true
 require "jekyll"
-require_relative "jekyll-wikilinks/context"
-require_relative "jekyll-wikilinks/filter"
-require_relative "jekyll-wikilinks/version"
-
-
-module JekyllWikiLinks
-	class Generator < Jekyll::Generator
-		attr_accessor :site, :config, :md_docs, :graph_nodes, :graph_links
-
-		# 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
+require_relative "jekyll-wikilinks/version"
 
-	end
-end
+# in order of expected execution
+
+# 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
+
+# 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
+
+# convert
+require_relative "jekyll-wikilinks/plugins/converter"
+
+# generate
+require_relative "jekyll-wikilinks/plugins/generator"
+
+# 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
+
+# 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
+
+# generate metadata
+# Jekyll::Hooks.register :documents, :post_convert do |doc|
+#   Jekyll:WikiLinks::Generator.generate(doc)
+# end
+
+# hook up liquid filters
+require_relative "jekyll-wikilinks/plugins/filter"
+Liquid::Template.register_filter(Jekyll::WikiLinks::TypeFilters)

metadata

@@ -1,32 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wikilinks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
-- shorty25h0r7
+- manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-01 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:
-- short2thingz@gmail.com
+- manunamz@pm.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-wikilinks.rb
-- lib/jekyll-wikilinks/context.rb
-- lib/jekyll-wikilinks/filter.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/shorty25h0r7/jekyll-wikilinks
+homepage: https://github.com/manunamz/jekyll-wikilinks
 licenses:
-- MIT
+- GPL3
 metadata:
-  homepage_uri: https://github.com/shorty25h0r7/jekyll-wikilinks
-  source_code_uri: https://github.com/shorty25h0r7/jekyll-wikilinks
+  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:
@@ -42,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
-summary: Add 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/filter.rb

@@ -1,28 +0,0 @@
-# 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)