jekyll-wikilinks 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb34f22e418709f097d81cbcd13a0917ab903247145bb0db4846a346c0b86f38
-  data.tar.gz: 62bff9a52a5e965a542071a0d577ea3a962c3acd604643d0955de449e924de7a
+  metadata.gz: 19fe7bb2a769e61e5d1d554bdbfd2553d7e8359800d06ed58fb5a77e1ed39e60
+  data.tar.gz: cc5a57fd28b83455523a2e5a67f1f5e9f3a6a2d335e6bc72b55650fc05aa836b
 SHA512:
-  metadata.gz: '087c441fc74aa0da7659bf070eb3c2b079033d8a567002e00603825498afb6ef30d259372e18799506e4fc2b7b3cc3c3501f0a67dd4e559eefd463214ee6a502'
-  data.tar.gz: 8abe1efd8a9b2eecd13b1d83599c09ee29db9e2e943ed097bf49aa000fd1a6caea2c6cedc1bb05fdce6fb4bfa3d1852b01221420e91f647d8aff61b7bce6ac50
+  metadata.gz: 8e24fd21d6c63de04a1e929f0c3cdb5e040643ff2cd1d1cafa4f8f6caf8f067ff96121ee276876f3f43b5f6b63825fe05bc0b2f7dddfd6ceff3f0b92024a8ab0
+  data.tar.gz: 2883023cd22018b3d3b8bc76d5960b98c3e906021488cf3928914b9a16568b69b45e08782a909568a8ab851b806ec182ff89e3be7f14b7d491d6a8e34e209d6e

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

@@ -4,6 +4,7 @@ require_relative "../util/regex"
 module Jekyll
   module WikiLinks
 
+    # todo: move these methods to the 'WikiLink' classes...?
     #
     # this class is responsible for answering any questions
     # related to jekyll markdown documents
@@ -55,6 +56,13 @@ module Jekyll
         return docs[0]
       end
 
+      def get_doc_by_fpath(file_path)
+        Jekyll.logger.error("Jekyll-Wikilinks: Must provide a 'file_path'") if file_path.nil? || file_path.empty?
+        docs = @md_docs.select{ |d| d.relative_path == (file_path + ".md") }
+        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 }
@@ -78,12 +86,15 @@ module Jekyll
 
       # validators
 
-      def file_exists?(filename)
+      def file_exists?(filename, file_path=nil)
         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
+        if file_path.nil?
+          return false if get_doc_by_fname(filename).nil? && get_image_by_fname(filename).nil?
+          return true
+        else
+          return false if get_doc_by_fpath(file_path).nil?
+          return true
+        end
       end
 
       def doc_has_header?(doc, header)

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

@@ -23,46 +23,56 @@ module Jekyll
       end
 
       def populate(doc, wikilink_blocks, wikilink_inlines)
-        # blocks
+        #        #
+        # 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
+            # create
             if target_attr.nil?
               @index[doc.url].attributes << wlbl.linked_fm_data
-            ## append
+            # append
             else
-              target_attr['urls'] += wlbl.urls
+              target_attr['urls'] += wlbl.urls 
             end
+            ## 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
+              # create
               if target_attr.nil?
                 @index[linked_doc.url].attributed << wlbl.context_fm_data
-              ## append
+              # append
               else
                 target_attr['urls'] << doc.url
               end
             end
           else
-            wlbl.filenames.each do |fn|
-              @index[doc.url].missing << fn
-            end
+            #
+            # invalid || empty
+            #
+            @index[doc.url].missing += wlbl.missing_doc_filenames
           end
         end
-        # inlines
+        #         #
+        # 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
+          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

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

@@ -76,6 +76,8 @@ module Jekyll
         end
         # replace text
         return if @wikilink_inlines.nil?
+        # process typed wikilinks first so we don't accidentally 
+        # overwrite them when handling untyped wikilinks
         self.sort_typed_first
         @wikilink_inlines.each do |wikilink|
           doc_content.gsub!(
@@ -125,24 +127,34 @@ module Jekyll
         # markdown file processing
         linked_doc = wikilink.linked_doc
         link_type_txt = wikilink.is_typed? ? " #{$wiki_conf.css_name("typed")} #{wikilink.link_type}" : ""
-        
-        inner_txt = wikilink.label_txt if wikilink.labelled?
         lnk_doc_rel_url = relative_url(linked_doc.url)
-        
-        if (wikilink.level == "file")
-          inner_txt = "#{linked_doc['title'].downcase}" if inner_txt.nil?
+        if wikilink.labelled?
+          inner_txt = wikilink.label_txt
+        elsif linked_doc.data.keys.include?('title')
+          inner_txt = linked_doc.data['title'].downcase
+        # in case there is no 'title' frontmatter attribute 
+        # (i'm seeing deprecation warnings, but there might 
+        #  be bugs caused by not using this...)
+        elsif linked_doc.respond_to?(:title)
+          inner_txt = linked_doc.title.downcase
+        # pages don't have automatically generated titles
+        else
+          inner_txt = Jekyll::Utils.slugify(linked_doc.basename)
+        end
+        # level-specific
+        if (wikilink.level == "file_path" || wikilink.level == "filename")
           return build_html_embed(
-            linked_doc['title'],
+            linked_doc.title,
             linked_doc.content,
             lnk_doc_rel_url
           ) if wikilink.embedded?
         elsif (wikilink.level == "header")
           # from: https://github.com/jekyll/jekyll/blob/6855200ebda6c0e33f487da69e4e02ec3d8286b7/Rakefile#L74
           lnk_doc_rel_url += "\#" + Jekyll::Utils.slugify(wikilink.header_txt)
-          inner_txt = "#{linked_doc['title'].downcase} > #{wikilink.header_txt.downcase}" if inner_txt.nil?
+          inner_txt += " > #{wikilink.header_txt.downcase}" if !wikilink.labelled?
         elsif (wikilink.level == "block")
           lnk_doc_rel_url += "\#" + wikilink.block_id
-          inner_txt = "#{linked_doc['title'].downcase} > ^#{wikilink.block_id}" if inner_txt.nil?
+          inner_txt += " > ^#{wikilink.block_id}" if !wikilink.labelled?
         else
           Jekyll.logger.error("Jekyll-Wikilinks: Invalid wikilink level")
         end

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

@@ -12,7 +12,7 @@ module Jekyll
     SUPPORTED_IMG_FORMATS = Set.new(['.png', '.jpg', '.gif', '.psd', '.svg'])
 
     # wikilink constants
-  	REGEX_LINK_LEFT       = /\[\[/
+    REGEX_LINK_LEFT       = /\[\[/
     REGEX_LINK_RIGHT      = /\]\]/
     REGEX_LINK_EMBED      = /(?<embed>\!)/
     REGEX_LINK_TYPE       = /\s*::\s*/
@@ -22,7 +22,7 @@ module Jekyll
 
     # wikitext usable char requirements
     REGEX_LINK_TYPE_CHARS = /[^\n\s\!\#\^\|\]]+/i
-    REGEX_FILENAME_CHARS  = /[^\\\/:\#\^\|\[\]]+/i
+    REGEX_FILENAME_CHARS  = /[^\\:\#\^\|\[\]]+/i
     REGEX_HEADER_CHARS    = /[^\!\#\^\|\[\]]+/i
     REGEX_BLOCK_ID_CHARS  = /[^\\\/:\!\#\^\|\[\]^\n]+/i
     REGEX_LABEL_CHARS     = /(.+?)(?=\]{2}[^\]])/i

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

@@ -7,7 +7,7 @@ module Jekyll
     # wikilink classes know everything about the original markdown syntax and its semantic meaning
 
     class WikiLinkBlock
-      attr_accessor :link_type, :filenames
+      attr_reader :link_type, :filenames
 
       # parameters ordered by appearance in regex
       def initialize(doc_mngr, context_filename, link_type, bullet_type=nil)
@@ -68,7 +68,7 @@ module Jekyll
       end
 
       def urls
-        # return @filenames.map { |f| @doc_mngr.get_doc_by_fname(f) }
+        # return @filenames.map { |f| @doc_mngr.get_doc_by_fname(f).url }.compact()
         urls = []
         @filenames.each do |f|
           doc = @doc_mngr.get_doc_by_fname(f)
@@ -87,9 +87,10 @@ module Jekyll
       end
 
       def linked_fm_data
+        valid_urls = self.urls.select{ |url| @doc_mngr.get_doc_by_url(url) }
         return {
           'type' => @link_type,
-          'urls' => self.urls,
+          'urls' => valid_urls,
         }
       end
 
@@ -106,6 +107,15 @@ module Jekyll
         return docs
       end
 
+      def missing_doc_filenames
+        missing_doc_fnames = [] 
+        @filenames.each do |f|
+          doc = @doc_mngr.get_doc_by_fname(f)
+          missing_doc_fnames << f if doc.nil?
+        end
+        return missing_doc_fnames
+      end
+
       # descriptor methods
 
       def has_filenames?
@@ -119,29 +129,37 @@ module Jekyll
       # validation methods
 
       def is_valid?
-        return false if !is_typed?
-        return false if !has_filenames?
-        @filenames.each do |f|
-          return false if !@doc_mngr.file_exists?(f)
-        end
+        all_filenames_missing = linked_docs.empty?
+        return false if !is_typed? || !has_filenames? || all_filenames_missing
         return true
       end
     end
 
     class WikiLinkInline
-      attr_accessor :context_filename, :embed, :link_type, :filename, :header_txt, :block_id, :label_txt
+      attr_reader :link_type, :filename, :header_txt, :block_id
 
+      FILE_PATH = "file_path"
       FILENAME = "filename"
       HEADER_TXT = "header_txt"
       BLOCK_ID = "block_id"
 
       # parameters ordered by appearance in regex
-      def initialize(doc_mngr, context_filename, embed, link_type, filename, header_txt, block_id, label_txt)
+      def initialize(doc_mngr, context_filename, embed, link_type, file_string, header_txt, block_id, label_txt)
+        if file_string.include?('/') && file_string[0] == '/'
+          @path_type = "absolute"
+          @file_path ||= file_string[1...] # remove leading '/' to match `jekyll_collection_doc.relative_path`
+          @filename ||= file_string.split('/').last
+        elsif file_string.include?('/') && file_string[0] != '/'
+          Jekyll.logger.error("Jekyll-Wikilinks: Relative file paths are not yet supported, please use absolute file paths that start with '/' for #{file_string}")
+          # todo:
+          # @path_type = "relative"
+        else
+          @filename ||= file_string
+        end
         @doc_mngr ||= doc_mngr
         @context_filename ||= context_filename
         @embed ||= embed
         @link_type ||= link_type
-        @filename ||= filename
         @header_txt ||= header_txt
         @block_id ||= block_id
         @label_txt ||= label_txt
@@ -157,35 +175,45 @@ module Jekyll
       def md_regex
         regex_embed = embedded? ? REGEX_LINK_EMBED : %r{}
         regex_link_type = is_typed? ? %r{#{@link_type}#{REGEX_LINK_TYPE}} : %r{}
-        filename = described?(FILENAME) ? @filename : ""
+        if !@file_path.nil?
+          file_string = described?(FILE_PATH) ? @file_path : ""
+          file_string = '/' + file_string if @path_type == "absolute"
+        else
+          file_string = described?(FILENAME) ? @filename : ""
+        end
         if described?(HEADER_TXT)
           header = %r{#{REGEX_LINK_HEADER}#{@header_txt}}
           block = %r{}
         elsif described?(BLOCK_ID)
           header = %r{}
           block = %r{#{REGEX_LINK_BLOCK}#{@block_id}}
-        elsif !described?(FILENAME)
+        elsif !described?(FILENAME) && !described?(FILE_PATH)
           Jekyll.logger.error("Jekyll-Wikilinks: WikiLinkInline.md_regex error")
         end
         label_ =  labelled? ? %r{#{REGEX_LINK_LABEL}#{label_txt}} : %r{}
-        return %r{#{regex_embed}#{regex_link_type}#{REGEX_LINK_LEFT}#{filename}#{header}#{block}#{label_}#{REGEX_LINK_RIGHT}}
+        return %r{#{regex_embed}#{regex_link_type}#{REGEX_LINK_LEFT}#{file_string}#{header}#{block}#{label_}#{REGEX_LINK_RIGHT}}
       end
 
       def md_str
         embed = embedded? ? "!" : ""
         link_type = is_typed? ? "#{@link_type}::" : ""
-        filename = described?(FILENAME) ? @filename : ""
+        if !@file_path.nil?
+          file_string = described?(FILE_PATH) ? @file_path : ""
+          file_string = '/' + file_string if @path_type == "absolute"
+        else
+          file_string = described?(FILENAME) ? @filename : ""
+        end
         if described?(HEADER_TXT)
           header = "\##{@header_txt}"
           block = ""
         elsif described?(BLOCK_ID)
           header = ""
           block = "\#\^#{@block_id}"
-        elsif !described?(FILENAME)
+        elsif !described?(FILENAME) && !described?(FILE_PATH)
           Jekyll.logger.error("Jekyll-Wikilinks: WikiLinkInline.md_str error")
         end
         label_ = labelled? ? "\|#{@label_txt}" : ""
-        return "#{embed}#{link_type}\[\[#{filename}#{header}#{block}#{label_}\]\]"
+        return "#{embed}#{link_type}\[\[#{file_string}#{header}#{block}#{label_}\]\]"
       end
 
       # 'fm' -> frontmatter
@@ -209,7 +237,11 @@ module Jekyll
       end
 
       def linked_doc
-        return @doc_mngr.get_doc_by_fname(@filename)
+        # by file path
+        return @doc_mngr.get_doc_by_fpath(@file_path) if !@file_path.nil?
+        # by filename
+        return @doc_mngr.get_doc_by_fname(@filename) if @file_path.nil?
+        return nil
       end
 
       def linked_img
@@ -251,6 +283,7 @@ module Jekyll
 
       # this method helps to make the 'WikiLinkInline.level' code read like a clean truth table.
       def described?(chunk)
+        return (!@file_path.nil? && !@file_path.empty?) if chunk == FILE_PATH
         return (!@filename.nil? && !@filename.empty?) if chunk == FILENAME
         return (!@header_txt.nil? && !@header_txt.empty?) if chunk == HEADER_TXT
         return (!@block_id.nil? && !@block_id.empty?) if chunk == BLOCK_ID
@@ -258,16 +291,17 @@ module Jekyll
       end
 
       def level
-        return "file" if described?(FILENAME) && !described?(HEADER_TXT) && !described?(BLOCK_ID)
-        return "header" if described?(FILENAME) && described?(HEADER_TXT) && !described?(BLOCK_ID)
-        return "block" if described?(FILENAME) && !described?(HEADER_TXT) && described?(BLOCK_ID)
+        return "file_path" if described?(FILE_PATH) && described?(FILENAME) && !described?(HEADER_TXT) && !described?(BLOCK_ID)
+        return "filename"  if !described?(FILE_PATH) && described?(FILENAME) && !described?(HEADER_TXT) && !described?(BLOCK_ID)
+        return "header"    if (described?(FILE_PATH) || described?(FILENAME)) && described?(HEADER_TXT) && !described?(BLOCK_ID)
+        return "block"     if (described?(FILE_PATH) || described?(FILENAME)) && !described?(HEADER_TXT) && described?(BLOCK_ID)
         return "invalid"
       end
 
       # validation methods
 
       def is_valid?
-        return false if !@doc_mngr.file_exists?(@filename)
+        return false if !@doc_mngr.file_exists?(@filename, @file_path)
         return false if (self.level == "header") && !@doc_mngr.doc_has_header?(self.linked_doc, @header_txt)
         return false if (self.level == "block") && !@doc_mngr.doc_has_block_id?(self.linked_doc, @block_id)
         return true

data/lib/jekyll-wikilinks/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module WikiLinks
 
-    VERSION = "0.0.9"
+    VERSION = "0.0.12"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-wikilinks
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.3
+        version: 1.13.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.3
+        version: 1.13.3
 description:
 email:
 - manunamz@pm.me