jekyll-wikilinks 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f6d8e47bdeb17eba9c47c70c35ed2622fe27ab4b6280fa1838d6c69f24723b9
-  data.tar.gz: bfb12748858bd1c810b5613e1c2f516e64d65772082a680e24b3c796f37b6e80
+  metadata.gz: eb34f22e418709f097d81cbcd13a0917ab903247145bb0db4846a346c0b86f38
+  data.tar.gz: 62bff9a52a5e965a542071a0d577ea3a962c3acd604643d0955de449e924de7a
 SHA512:
-  metadata.gz: 0e6483f4844cc0b0d8fd43be71040bce438b5357972e2139660ca1979a2b42843af2355577a46dc0f119902e281fb244b4fc53d8db7f8a3760889073be08db36
-  data.tar.gz: 0af4216fa1fae8dbc086e785663d5ab4884afe83924c3b8fe5ef0ccb98fffa508dfc767b9c057b1dfec17efba36e3202eb494751ac53731209130c2108e43454
+  metadata.gz: '087c441fc74aa0da7659bf070eb3c2b079033d8a567002e00603825498afb6ef30d259372e18799506e4fc2b7b3cc3c3501f0a67dd4e559eefd463214ee6a502'
+  data.tar.gz: 8abe1efd8a9b2eecd13b1d83599c09ee29db9e2e943ed097bf49aa000fd1a6caea2c6cedc1bb05fdce6fb4bfa3d1852b01221420e91f647d8aff61b7bce6ac50

data/lib/jekyll-wikilinks/config.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+require "jekyll"
+
+module Jekyll
+  module WikiLinks
+
+    class PluginConfig
+
+      ATTR_KEY = "attributes"
+      CONFIG_KEY = "wikilinks"
+      ENABLED_KEY = "enabled"
+      EXCLUDE_KEY = "exclude"
+      # css-related
+      CSS_KEY = "css"
+      NAME_KEY = "name"
+      # names
+      ## valid
+      TYPED_KEY = "typed"
+      WEB_KEY = "web"
+      WIKI_KEY = "wiki"
+      ## invalid
+      INV_WIKI_KEY = "invalid_wiki"
+      # INV_WEB_KEY = "invalid_web"
+      ## embed
+      EMBED_WRAPPER_KEY = "embed_wrapper"
+      EMBED_TITLE_KEY = "embed_title"
+      EMBED_CONTENT_KEY = "embed_content"
+      EMBED_LINK_KEY = "embed_wiki_link"
+      EMBED_IMG_WRAPPER_KEY = "embed_image_wrapper"
+      EMBED_IMG_KEY = "embed_image"
+
+      def initialize(config)
+        @config ||= config
+        self.old_config_warn()
+        Jekyll.logger.debug("Jekyll-Wikilinks: Excluded jekyll types: #{option(EXCLUDE_KEY)}") unless disabled?
+      end
+
+      # util
+
+      def css_name(name_key)
+        return option_css_name(name_key) if option_css_name(name_key)
+        return "typed"                   if name_key == TYPED_KEY
+        # valid
+        return "wiki-link"               if name_key == WIKI_KEY
+        # invalid
+        return "invalid-wiki-link"       if name_key == INV_WIKI_KEY
+        # return "invalid-web-link" if name_key == INV_WEB_KEY
+        # embeds
+        return "embed-wrapper"           if name_key == EMBED_WRAPPER_KEY
+        return "embed-title"             if name_key == EMBED_TITLE_KEY
+        return "embed-content"           if name_key == EMBED_CONTENT_KEY
+        return "embed-wiki-link"         if name_key == EMBED_LINK_KEY
+        # img
+        return "embed-image-wrapper"     if name_key == EMBED_IMG_WRAPPER_KEY
+        return "embed-image"             if name_key == EMBED_IMG_KEY
+      end
+
+      def disabled?
+        option(ENABLED_KEY) == false
+      end
+
+      def disabled_attributes?
+        option_attributes(ENABLED_KEY) == false
+      end
+
+      def exclude?(type)
+        return false unless option(EXCLUDE_KEY)
+        return option(EXCLUDE_KEY).include?(type.to_s)
+      end
+
+      def excluded_css_names
+        return self.option_css(EXCLUDE_KEY)
+      end
+
+      # options
+
+      def option(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][key]
+      end
+
+      def option_attributes(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][ATTR_KEY] && @config[CONFIG_KEY][ATTR_KEY][key]
+      end
+
+      def option_css(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][CSS_KEY] && @config[CONFIG_KEY][CSS_KEY][key]
+      end
+
+      def option_css_name(key)
+        option_css(NAME_KEY) && @config[CONFIG_KEY][CSS_KEY][NAME_KEY][key]
+      end
+
+      # !! deprecated !!
+
+      def option_exist?(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY].include?(key)
+      end
+
+      def old_config_warn()
+        if @config.include?("wikilinks_collection")
+          Jekyll.logger.warn("Jekyll-Wikilinks: 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
+        if option_exist?("assets_rel_path")
+          Jekyll.logger.warn("Jekyll-Wikilinks: As of 0.0.5, 'assets_rel_path' is now 'path'.")
+        end
+        if @config.include?("d3_graph_data")
+          Jekyll.logger.warn("Jekyll-Wikilinks: As of 0.0.6, 'd3_graph_data' and graph functionality have been moved to the 'jekyll-graph' plugin.")
+        end
+      end
+    end
+
+  end
+end

data/lib/jekyll-wikilinks/patch/context.rb

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

data/lib/jekyll-wikilinks/patch/doc_manager.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require_relative "../util/regex"
+
+module Jekyll
+  module WikiLinks
+
+    #
+    # this class is responsible for answering any questions
+    # related to jekyll markdown documents
+    # that are meant to be processed by the wikilinks plugin.
+    #
+    # the following methods are specifically to address two things:
+    #  1. ruby's 'find' / 'detect' function does not throw errors if 
+    #     there are multiple matches. fail fast, i want to know if there
+    #     are duplicates. 
+    #     (not using sets because i don't want to clobber existing documents)
+    #  2. handle all jekyll documents in one place. i don't want to
+    #     have to filter all documents for target markdown documents 
+    #     every time i need to check if a file exists.
+    # 
+    # there is probably a better way to do this...i would prefer to have
+    # a plugin-wide function that just wraps all of this and can be called
+    # from anywhere in the plugin...but ruby is not a functional language...
+    # gotta have classes...
+    # 
+    class DocManager
+      CONVERTER_CLASS = Jekyll::Converters::Markdown
+
+      def initialize(site)
+        return if $wiki_conf.disabled?
+
+        markdown_converter = site.find_converter_instance(CONVERTER_CLASS)
+        # filter docs based on configs
+        docs = []
+        docs += site.pages if !$wiki_conf.exclude?(:pages)
+        docs += site.docs_to_write.filter { |d| !$wiki_conf.exclude?(d.type) }
+        @md_docs = docs.filter { |doc| markdown_converter.matches(doc.extname) }
+        if @md_docs.nil? || @md_docs.empty?
+          Jekyll.logger.warn("Jekyll-Wikilinks: No documents to process.")
+        end
+
+        @static_files ||= site.static_files
+      end
+
+      # accessors
+
+      def all
+        return @md_docs
+      end
+
+      def get_doc_by_fname(filename)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'filename'") if filename.nil? || filename.empty?
+        docs = @md_docs.select{ |d| File.basename(d.basename, File.extname(d.basename)) == filename }
+        return nil if docs.nil? || docs.empty? || docs.size > 1
+        return docs[0]
+      end
+
+      def get_doc_by_url(url)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'url'") if url.nil? || url.empty?
+        docs = @md_docs.select{ |d| d.url == url }
+        return nil if docs.nil? || docs.empty? || docs.size > 1
+        return docs[0]
+      end
+
+      def get_doc_content(filename)
+        doc = self.get_doc_by_fname(filename)
+        return nil if docs.nil?
+        return doc.content
+      end
+
+      def get_image_by_fname(filename)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'filename'") if filename.nil? || filename.empty?
+        return nil if @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.empty? || docs.size > 1
+        return docs[0]
+      end
+
+      # validators
+
+      def file_exists?(filename)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'filename'") if filename.nil? || filename.empty?
+        docs = @md_docs.select{ |d| File.basename(d.basename, File.extname(d.basename)) == filename }
+        docs += @static_files.select{ |d| File.basename(d.relative_path) == filename }
+        return false if docs.nil? || docs.empty? || docs.size > 1
+        return true
+      end
+
+      def doc_has_header?(doc, header)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'header'") if header.nil? || header.empty?
+        # leading + trailing whitespace is ignored when matching headers
+        header_results = doc.content.scan(REGEX_ATX_HEADER).flatten.map { |htxt| htxt.downcase.strip }
+        setext_header_results = doc.content.scan(REGEX_SETEXT_HEADER).flatten.map { |htxt| htxt.downcase.strip }
+        return header_results.include?(header.downcase.strip) || setext_header_results.include?(header.downcase.strip)
+      end
+
+      def doc_has_block_id?(doc, block_id)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'block_id'") if block_id.nil? || block_id.empty?
+        # 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
+end

data/lib/jekyll-wikilinks/patch/site.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require "jekyll"
+
+# appending to built-in jekyll site object to pass data to jekyll-graph
+
+module Jekyll
+
+  class Site
+    attr_accessor :doc_mngr, :link_index, :wiki_parser
+  end
+
+end

data/lib/jekyll-wikilinks/plugins/converter.rb

@@ -0,0 +1,53 @@
+require "jekyll"
+require "nokogiri"
+
+module Jekyll
+  module WikiLinks
+
+    class WebLinkConverter < Jekyll::Converter
+      priority :low
+
+      # config
+      CSS_KEY = "css"
+      CONFIG_KEY = "wikilinks"
+      EXCLUDE_KEY = "exclude"
+      # link types
+      # WEB_KEY = "web"
+      # WIKIL_KEY = "wiki"
+      # INVALID_KEY = "invalid"
+      # WIKI_EMBED_KEY = "wiki_embed"
+
+      def matches(ext)
+        ext =~ /^\.md$/i
+      end
+
+      def output_ext(ext)
+        ".html"
+      end
+
+      # add 'web-link' css class to links that aren't
+      # - wikilinks
+      # - contain an excluded css class
+      def convert(content)
+        excluded_classes = option_css(EXCLUDE_KEY)
+        if excluded_classes.nil? || excluded_classes.empty?
+          css_def = "a:not(.#{$wiki_conf.css_name("wiki")}):not(.#{$wiki_conf.css_name("embed_wiki_link")})"
+        else
+          css_def = "a:not(.#{$wiki_conf.css_name("wiki")}):not(.#{$wiki_conf.css_name("embed_wiki_link")}):not(.#{excluded_classes.join("):not(.")})"
+        end
+        parsed_content = Nokogiri::HTML::fragment(content)
+        parsed_content.css(css_def).each do |link|
+          link.add_class('web-link')
+        end
+        content = parsed_content.to_html
+      end
+
+      # config helpers
+
+      def option_css(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][CSS_KEY] && @config[CONFIG_KEY][CSS_KEY][key]
+      end
+    end
+
+  end
+end

data/lib/jekyll-wikilinks/plugins/filter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module WikiLinks
+
+    module TypeFilters
+      # 'links' accepts untyped links, typed links, and attributes; fore and back.
+      # why: these filters are useful when you want to list backlinks of certain type(s) and don't want type mismatches to display as "missing"
+
+      # usage: {% assign note_links = page.links | doc_type: "notes" %}
+      def doc_type(links, doc_type)
+        Jekyll.logger.error("Jekyll-Wikilinks: 'links' invalid") if links.nil?
+        Jekyll.logger.error("Jekyll-Wikilinks: 'doc_type' invalid") if doc_type.nil? || doc_type.empty?
+        return [] if links.empty?
+
+        site = @context.registers[:site]
+
+        links_of_type = []
+        links.each do |l|
+          # links
+          if l.keys.include?('url')
+            docs = site.documents.select{ |d| d.url == l['url'] && d.type.to_s == doc_type.to_s }
+            if !docs.nil? && docs.size == 1
+              links_of_type << l
+            end
+          # attributes
+          elsif l.keys.include?('urls')
+            l['urls'].each do |lurl|
+              docs = site.documents.select{ |d| d.url == lurl && d.type.to_s == doc_type.to_s }
+              if !docs.nil? && docs.size == 1
+                links_of_type << l
+              end
+            end
+          else
+            Jekyll.logger.error("Jekyll-Wikilinks: In 'doc_type' filter, 'links' do not have 'url' or 'urls'")
+          end
+        end
+        return links_of_type.uniq
+      end
+
+      # usage: {% assign author_links = page.links | link_type: "author" %}
+      def link_type(links, link_type)
+        Jekyll.logger.error("Jekyll-Wikilinks: 'links' invalid") if links.nil?
+        Jekyll.logger.error("Jekyll-Wikilinks: 'link_type' invalid") if link_type.nil?
+        return [] if links.empty?
+
+        site = @context.registers[:site]
+
+        links_of_type = []
+        links.each do |l|
+          if l['type'].to_s == link_type.to_s
+            # links
+            if l.keys.include?('url')
+              docs = site.documents.select{ |d| d.url == l['url'] }
+              if !doc.nil? && docs.size != 1
+                links_of_type << l
+              end
+            # attributes
+            elsif l.keys.include?('urls')
+              all_docs_exist = true
+              l['urls'].each do |lurl|
+                docs = site.documents.select{ |d| d.url == lurl }
+                if !docs.nil? && docs.size != 1
+                  all_docs_exist = false
+                end
+              end
+              if all_docs_exist
+                links_of_type << l
+              end
+            else
+              Jekyll.logge.error("Jekyll-Wikilinks: In 'link_type' filter, 'links' do not have 'url' or 'urls'")
+            end
+          end
+        end
+        return links_of_type.uniq
+      end
+
+    end
+
+  end
+end

data/lib/jekyll-wikilinks/plugins/generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "jekyll"
+
+require_relative "../patch/context"
+require_relative "../patch/doc_manager"
+require_relative "../patch/site"
+require_relative "../util/link_index"
+require_relative "../util/parser"
+
+module Jekyll
+  module WikiLinks
+
+    class Generator < Jekyll::Generator
+
+      def generate(site)
+        return if $wiki_conf.disabled?
+
+        @site ||= site
+        @context ||= Jekyll::WikiLinks::Context.new(site)
+
+        # setup helper classes
+        @parser = Parser.new(@site)
+        @site.link_index = LinkIndex.new(@site)
+
+        @site.doc_mngr.all.each do |doc|
+          filename = File.basename(doc.basename, File.extname(doc.basename))
+          @parser.parse(filename, doc.content)
+          @site.link_index.populate(doc, @parser.wikilink_blocks, @parser.wikilink_inlines)
+        end
+        # wait until all docs are processed before assigning backward facing metadata,
+        # this ensures all attributed/backlinks are collected for assignment
+        @site.doc_mngr.all.each do |doc|
+          # populate frontmatter metadata from (wiki)link index
+          @site.link_index.assign_metadata(doc)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/jekyll-wikilinks/util/link_index.rb

@@ -0,0 +1,89 @@
+require_relative 'regex'
+
+module Jekyll
+  module WikiLinks
+
+    class LinkIndex
+      attr_reader :index
+
+      def initialize(site)
+        @baseurl = site.baseurl
+        @index = {}
+        site.doc_mngr.all.each do |doc|
+          @index[doc.url] = DocLinks.new()
+        end
+      end
+
+      def assign_metadata(doc)
+        doc.data['attributed'] = @index[doc.url].attributed.uniq
+        doc.data['attributes'] = @index[doc.url].attributes.uniq
+        doc.data['backlinks']  = @index[doc.url].backlinks.uniq
+        doc.data['forelinks']  = @index[doc.url].forelinks.uniq
+        doc.data['missing']    = @index[doc.url].missing.uniq
+      end
+
+      def populate(doc, wikilink_blocks, wikilink_inlines)
+        # blocks
+        wikilink_blocks.each do |wlbl|
+          if wlbl.is_valid?
+            # attributes
+            target_attr = @index[doc.url].attributes.detect { |atr| atr['type'] == wlbl.link_type }
+            ## create
+            if target_attr.nil?
+              @index[doc.url].attributes << wlbl.linked_fm_data
+            ## append
+            else
+              target_attr['urls'] += wlbl.urls
+            end
+            # attributed
+            wlbl.linked_docs.each do |linked_doc|
+              target_attr = @index[linked_doc.url].attributed.detect { |atr| atr['type'] == wlbl.link_type }
+              ## create
+              if target_attr.nil?
+                @index[linked_doc.url].attributed << wlbl.context_fm_data
+              ## append
+              else
+                target_attr['urls'] << doc.url
+              end
+            end
+          else
+            wlbl.filenames.each do |fn|
+              @index[doc.url].missing << fn
+            end
+          end
+        end
+        # inlines
+        wikilink_inlines.each do |wlil|
+          if !wlil.is_img?
+            if wlil.is_valid?
+              # forelink
+              @index[doc.url].forelinks << wlil.linked_fm_data
+              # backlink
+              @index[wlil.linked_doc.url].backlinks << wlil.context_fm_data
+            else
+              @index[doc.url].missing << wlil.filename
+            end
+          end
+        end
+      end
+
+      # def remove_baseurl(url)
+      #   return url.gsub(@baseurl, '') if !@baseurl.nil?
+      #   return url
+      # end
+
+      class DocLinks
+        attr_accessor :attributes, :attributed, :backlinks, :forelinks, :missing
+
+        def initialize
+          @attributed = [] # block typed backlinks;            { 'type' => str, 'urls' => [ str ] }
+          @attributes = [] # block typed forelinks;            { 'type' => str, 'urls' => [ str ] }
+          @backlinks  = [] # inline typed and basic backlinks; { 'type' => str, 'url'  => str }
+          @forelinks  = [] # inline typed and basic forelinks; { 'type' => str, 'url'  => str }
+          @missing    = [] # missing forelinks + attributes;   ( built from (missing) filenames )
+        end
+      end
+    end
+
+  end
+end