jekyll-wikilinks 0.0.6 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e65a8cc36608b07333b7fe02a0f37f100117c7ed94d0b2e0fa500520eee6a2aa
-  data.tar.gz: 8d28d1930fedbddfd17d13c431f42043cdfb3333493929f78977d8da122c0647
+  metadata.gz: 9067c4d2ad9673d39b79195cb9bd4ef955e5cccac52702bfdd731c9d0aade4b7
+  data.tar.gz: 9b5a31b067e375100933d101b9bab94b8a1d19e17327ab0306cea6ea83543b18
 SHA512:
-  metadata.gz: bae180a6824ea1a646d9103a0e6701814e1792275ae1037119db819b91fc35a9d01d8fc5c4b64ea8ba689f9b799309fd662ce66e001fd89e1e83eb1114257fba
-  data.tar.gz: d9327ed183e0d9ade35f23633a70f01157b388cdb627de5890d63cfd151a0bf070ddf92313b92ca385f187b360b96fbaaa770b2dfc29cf9a28fc4ffdb45caa57
+  metadata.gz: e3ff8a744de37ca82b01bed3ebeff321c43fa442a923fe9c1a19da6affbc0a54e6bc6f0a9901b86b66b223fe55a7f8277d7594e740d040faa80bfb71cc64e215
+  data.tar.gz: b04df5871d0c527e4d86c3e560205da232b2b1fe48bfe23919c0b400d6888ed373e6b5fffa6a6da687b89620096ef09223e0a691ec1e1dd8c00a533223f124e6

data/lib/jekyll-wikilinks/config.rb

@@ -15,6 +15,7 @@ module Jekyll
       NAME_KEY = "name"
       # names
       ## valid
+      TYPED_KEY = "typed"
       WEB_KEY = "web"
       WIKI_KEY = "wiki"
       ## invalid
@@ -31,26 +32,27 @@ module Jekyll
       def initialize(config)
         @config ||= config
         self.old_config_warn()
-        Jekyll.logger.debug "Excluded jekyll types: ", option(EXCLUDE_KEY) unless disabled?
+        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
+        return "wiki-link"               if name_key == WIKI_KEY
         # invalid
-        return "invalid-wiki-link" if name_key == INV_WIKI_KEY
+        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
+        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
+        return "embed-image-wrapper"     if name_key == EMBED_IMG_WRAPPER_KEY
+        return "embed-image"             if name_key == EMBED_IMG_KEY
       end
 
       def disabled?
@@ -66,6 +68,10 @@ module Jekyll
         return option(EXCLUDE_KEY).include?(type.to_s)
       end
 
+      def excluded_css_names
+        return self.option_css(EXCLUDE_KEY)
+      end
+
       # options
 
       def option(key)
@@ -92,13 +98,13 @@ module Jekyll
 
       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."
+          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 "As of 0.0.5, 'assets_rel_path' is now '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 "As of 0.0.6, 'd3_graph_data' and graph functionality have been moved to the 'jekyll-graph' plugin."
+          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

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

@@ -7,8 +7,22 @@ module Jekyll
     #
     # this class is responsible for answering any questions
     # related to jekyll markdown documents
-    # that are meant to be processed by the wikilinks plugin
+    # 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
 
@@ -22,7 +36,7 @@ module Jekyll
         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.debug("No documents to process.")
+          Jekyll.logger.warn("Jekyll-Wikilinks: No documents to process.")
         end
 
         @static_files ||= site.static_files
@@ -35,43 +49,53 @@ module Jekyll
       end
 
       def get_doc_by_fname(filename)
-        return nil if filename.nil? || @md_docs.size == 0
+        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.size > 1
+        return nil if docs.nil? || docs.empty? || docs.size > 1
         return docs[0]
       end
 
       def get_doc_by_url(url)
-        return nil if url.nil? || @md_docs.size == 0
+        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.size > 1
+        return nil if docs.nil? || docs.empty? || 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
+        doc = self.get_doc_by_fname(filename)
+        return nil if docs.nil?
+        return doc.content
       end
 
       def get_image_by_fname(filename)
-        return nil if filename.nil? || @static_files.size == 0 || !SUPPORTED_IMG_FORMATS.any?{ |ext| ext == File.extname(filename).downcase }
+        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.size > 1
+        return nil if docs.nil? || docs.empty? || docs.size > 1
         return docs[0]
       end
 
-      def self.doc_has_header?(doc, header)
-        return nil if header.nil?
+      # 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.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)
+        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 self.doc_has_block_id?(doc, block_id)
-        return nil if block_id.nil?
+      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)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "jekyll"
 
-# appending to built-in jekyll site object to pass data to jekyll-d3
+# appending to built-in jekyll site object to pass data to jekyll-graph
 
 module Jekyll
 

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

@@ -5,66 +5,74 @@ module Jekyll
 
     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" %}
-      # TODO: if you simply filter links against specific jekyll types, this filter is completely unecessary...
-      #       // looping through backlinks:
-      #       {% assign note_links = site.notes | where: "url", backlink.url | first %}
+      # usage: {% assign note_links = page.links | doc_type: "notes" %}
       def doc_type(links, doc_type)
-        Jekyll.logger.error("'links' should not be nil") if links.nil?
-        return "No doc type given" if doc_type.empty?
+        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')
-            doc = site.documents.select{ |d| d.url == l['url'] && d.type.to_s == doc_type.to_s }
-            if !doc.nil? && doc.size != 1
-              links.delete(l)
+            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|
-              doc = site.documents.select{ |d| d.url == lurl && d.type.to_s == doc_type.to_s }
-              if !doc.nil? && doc.size != 1
-                links['urls'].delete(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.logge.error("In 'doc_type' filter, 'links' do not have 'url' or 'urls'")
+            Jekyll.logger.error("Jekyll-Wikilinks: In 'doc_type' filter, 'links' do not have 'url' or 'urls'")
           end
         end
-        return links.uniq
+        return links_of_type.uniq
       end
 
-      # usage: {% assign author_links = page.links | rel_type = "author" %}
-      def rel_type(links, link_type)
-        Jekyll.logger.error("'links' should not be nil") if links.nil?
-        return "No link type given" if link_type.empty?
+      # 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.keys.include?('url')
-            if l['type'].to_s == link_type.to_s
+          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? && doc.size != 1
-                links.delete(l)
+              if !doc.nil? && docs.size != 1
+                links_of_type << l
               end
-            end
-          elsif l.keys.include?('urls')
-            l['urls'].each do |lurl|
-              docs = site.documents.select{ |d| d.url == lurl }
-              if !doc.nil? && doc.size != 1
-                links['urls'].delete(lurl)
+            # 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
-          else
-            Jekyll.logge.error("In 'rel_type' filter, 'links' do not have 'url' or 'urls'")
           end
         end
-        return links.uniq
+        return links_of_type.uniq
       end
 
     end

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

@@ -6,7 +6,6 @@ require_relative "../patch/doc_manager"
 require_relative "../patch/site"
 require_relative "../util/link_index"
 require_relative "../util/parser"
-require_relative "converter"
 
 module Jekyll
   module WikiLinks
@@ -24,13 +23,14 @@ module Jekyll
         @site.link_index = LinkIndex.new(@site)
 
         @site.doc_mngr.all.each do |doc|
-          @parser.parse(doc.content)
-          @site.link_index.populate_forward(doc, @parser.wikilink_blocks, @parser.wikilink_inlines, @site.doc_mngr.all)
+          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|
-          @site.link_index.populate_backward(doc, @site.doc_mngr.all)
+          # populate frontmatter metadata from (wiki)link index
           @site.link_index.assign_metadata(doc)
         end
       end

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

@@ -10,7 +10,7 @@ module Jekyll
         @baseurl = site.baseurl
         @index = {}
         site.doc_mngr.all.each do |doc|
-          @index[doc.url] = LinksInfo.new()
+          @index[doc.url] = DocLinks.new()
         end
       end
 
@@ -22,80 +22,67 @@ module Jekyll
         doc.data['missing']    = @index[doc.url].missing.uniq
       end
 
-      def populate_forward(doc, wikilink_blocks, wikilink_inlines, md_docs)
-        # attributes - blocks
-        wikilink_blocks.each do |tlbl|
-          urls = []
-          tlbl.list_items.each do |bullet_type, filename|
-            attr_doc = md_docs.detect { |d| File.basename(d.basename, File.extname(d.basename)) == filename }
-            if !attr_doc.nil?
-              urls << attr_doc.url
+      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
-          end
-          if !urls.nil? && !urls.empty?
-            @index[doc.url].attributes << {
-              'type' => tlbl.link_type,
-              'urls' => urls,
-            }
-          else
-            Jekyll.logger.warn("No documents found for urls: #{urls}")
-          end
-        end
-        # forelinks - inlines
-        wikilink_inlines.each do |wlil|
-          link_doc = md_docs.detect { |d| File.basename(d.basename, File.extname(d.basename)) == wlil.filename }
-          if !link_doc.nil?
-            @index[doc.url].forelinks << {
-              'type' => wlil.link_type,
-              'url' => link_doc.url,
-            }
-          end
-        end
-        # ...process missing links
-        doc.content.scan(REGEX_INVALID_WIKI_LINK).each do |m|
-          ltext = m[0]
-          @index[doc.url].missing << ltext
-        end
-      end
-
-      def populate_backward(doc, md_docs)
-        md_docs.each do |doc_to_link|
-          # attributed
-          @index[doc_to_link.url].attributes.each do |al|
-            urls = al['urls'].map { |url| self.remove_baseurl(url) }
-            if urls.include?(doc.url)
-              target_attr = @index[doc.url].attributed.detect { |atr| atr['type'] == al['type']}
-              # add
-              if !target_attr.nil?
-                target_attr['urls'] << doc_to_link.url
-              # create new
+            ## append missing docs
+            @index[doc.url].missing += wlbl.missing_doc_filenames 
+            #
+            # 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
-                urls = @index[doc.url].attributed.detect { |a| a['type'] == al['type'] }
-                @index[doc.url].attributed << {
-                  'type' => al['type'],
-                  'urls' => [ doc_to_link.url ],
-                }
+                target_attr['urls'] << doc.url
               end
             end
+          else
+            #
+            # invalid || empty
+            #
+            @index[doc.url].missing += wlbl.missing_doc_filenames
           end
-          # backlinks
-          @index[doc_to_link.url].forelinks.each do |l|
-            if self.remove_baseurl(l['url']) == doc.url
-              @index[doc.url].backlinks << {
-                'type' => l['type'],
-                'url' => doc_to_link.url,
-              }
-            end
+        end
+        #         #
+        # inlines #
+        #         #
+        wikilink_inlines.each do |wlil|
+          return 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
 
-      def remove_baseurl(url)
-        return url.gsub(@baseurl, '') if !@baseurl.nil?
-        return url
-      end
+      # def remove_baseurl(url)
+      #   return url.gsub(@baseurl, '') if !@baseurl.nil?
+      #   return url
+      # end
 
-      class LinksInfo
+      class DocLinks
         attr_accessor :attributes, :attributed, :backlinks, :forelinks, :missing
 
         def initialize
@@ -103,7 +90,7 @@ module Jekyll
           @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;                [ str ]
+          @missing    = [] # missing forelinks + attributes;   ( built from (missing) filenames )
         end
       end
     end