obsidian-parser 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8337e7963b9236dcf2e06bcdbe81c44002546ca23b5c30451c3b9b218c7da4
-  data.tar.gz: a69df6022fe82cfd016c56a1445c1b5fb23acca02ecd0521c6b455df58df3679
+  metadata.gz: 37cfdc15ab5d67c4ac5972db19df269b71a20c516bc43bc9014daccdf42879eb
+  data.tar.gz: ed67a9489d6e3ed05df0b72d14773b5674945ae993b51386e76634023629de74
 SHA512:
-  metadata.gz: 2b898a0bfabe2aea32d357452b513078bb768be34f5607f07d1c4cbe05d5f9513b8a7c0cdc978995706621964cea01adbe88faf3213c4ff53bb2512b9f42927c
-  data.tar.gz: 63697c74da15ee1b4c5897706fdaf6e0ed4b87cea7dfcf1ecc97d2e9c0317d06ed8f6ed821debf6ea23a5f2ca33ccbee3e02271f2328f67c68f121cc86d9292a
+  metadata.gz: 1b39d82790d769bda1434db80434715715c9be20b9fae0fd9f9c51147354e9f8adb46062b3500ff07d1084d3435ab764fc7f27a22481dfc48447ef0524802cec
+  data.tar.gz: acd7d36cac25c162da92a939e132033afd2b4585af490c188505295b9d51134a3073b47fc8e457777a984facec6884230c6b5e2188554be1a56a0a26f8ceec8e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.5.4] - 2023-08-02
+- Fix page getting clobbered when wikilinks point to non-existent pages.
+- Expand `[[foo/index]]` wiklinks to `[foo](foo)`.
+
+## [0.5.3] - 2023-08-01
+- Support non-fully qualified titles when parsing wikilink syntax.
+- Autolink raw URLs.
+
 ## [0.5.2] - 2023-07-30
 - Fix handling of `index.md` at the root level.
 

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "standard", "~> 1.3"
+
+gem "pry"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    obsidian-parser (0.5.2)
+    obsidian-parser (0.5.4)
       kramdown (~> 2.4)
       kramdown-parser-gfm (~> 1.1)
 
@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
     json (2.6.3)
     kramdown (2.4.0)
@@ -17,10 +18,14 @@ GEM
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    method_source (1.0.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -74,6 +79,7 @@ PLATFORMS
 
 DEPENDENCIES
   obsidian-parser!
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   standard (~> 1.3)

data/lib/obsidian/parser/markdown_content.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Obsidian
+  class MarkdownContent
+    def initialize(path, root)
+      @path = path
+      @root = root
+    end
+
+    def generate_html
+      markdown = @path.read
+      Obsidian::ObsidianFlavoredMarkdown.parse(markdown, root: @root).to_html
+    end
+  end
+end

data/lib/obsidian/parser/obsidian_flavored_markdown.rb

@@ -17,23 +17,57 @@ module Obsidian
       \]\]
     }x
 
+    # Match URLs
+    # Pattern based on https://gist.github.com/dperini/729294
+    LONE_URL = %r{
+      (?<!\S) # not preceeded by a non-whitespace character
+      https?:// # Protocol
+      (?:\S+(?::\S*)?@)? # basic auth
+      (?![-_]) # Not followed by a dash or underscore
+      (?:[-\w\u00a1-\uffff]{0,63}[^-_]\.)+ # host and domain names
+      (?:[a-z\u00a1-\uffff]{2,}\.?) # top level domain
+      (?::\\d{2,5})? # Port number
+      (?:[/?#]\\S*)? # Resource path
+      (?!\S) # not followed by a non-whitespace character
+    }x
+
+    # Workaround for lack of auto-linking in Kramdown.
+    # Note: this breaks for URLs included in code blocks.
+    def self.auto_link(markdown_text)
+      markdown_text.gsub(LONE_URL) do |s|
+        "<#{s}>" # Kramdown-specific markup
+      end
+    end
+
     # Convert Obsidian-flavored-markdown syntax to something parseable
     # (i.e. with Github-flavored-markdown syntax)
-    def self.normalize(markdown_text)
+    def self.expand_wikilinks(markdown_text, root:)
       markdown_text.gsub(WIKILINK_SYNTAX) do |s|
         text = $~[:text]
         target = $~[:target]
         fragment = $~[:fragment]
-        display_text = text.nil? ? target.split("/").last : text
-        href = fragment.nil? ? target : "#{target}##{fragment}"
+        page = root.find_in_tree(target)
 
-        "[#{display_text}](#{href})"
+        if page.nil?
+          text.nil? ? target.split("/").last : text
+        else
+          display_text = text.nil? ? page.slug.split("/").last : text
+          href = fragment.nil? ? page.slug : "#{page.slug}##{fragment}"
+
+          "[#{display_text}](#{href})"
+        end
       end
     end
 
-    # Parse links from obsidian-flavored-markdown text
-    def self.parse(markdown_text)
-      document = Kramdown::Document.new(normalize(markdown_text), input: "GFM")
+    def self.normalize(markdown_text, root: nil)
+      auto_linked = auto_link(markdown_text)
+      return auto_linked if root.nil?
+
+      expand_wikilinks(auto_link(markdown_text), root: root)
+    end
+
+    def self.parse(markdown_text, root: nil)
+      document = Kramdown::Document.new(normalize(markdown_text, root: root), input: "GFM")
       Obsidian::ParsedMarkdownDocument.new(document)
     end
   end

data/lib/obsidian/parser/page.rb

@@ -103,16 +103,18 @@ module Obsidian
     # If there is an exact match, we should always return that
     # Otherwise, if we can skip over some anscestors and get a
     # match, then return the first, shortest match.
+    # If a query slug contains `/index` we ignore it and treat it
+    # the same as `/`
     def find_in_tree(query_slug)
       # Exact match
       return self if slug == query_slug
 
       # Partial match
-      query_parts = query_slug.split("/")
+      query_parts = query_slug.split("/").reject { |part| part == "index" }
       length = query_parts.size
       slug_parts = slug.split("/")
 
-      if slug_parts.length > length
+      if slug_parts.length >= length
         if slug_parts.slice(-length, length) == query_parts
           return self
         end

data/lib/obsidian/parser/version.rb

@@ -2,6 +2,6 @@
 
 module Obsidian
   class Parser
-    VERSION = "0.5.2"
+    VERSION = "0.5.4"
   end
 end

data/lib/obsidian/parser.rb

@@ -4,6 +4,7 @@ require_relative "parser/version"
 require_relative "parser/parsed_markdown_document"
 require_relative "parser/obsidian_flavored_markdown"
 require_relative "parser/page"
+require_relative "parser/markdown_content"
 
 require "forwardable"
 
@@ -14,17 +15,6 @@ module Obsidian
     (parent_slug == "") ? title : "#{parent_slug}/#{title}"
   end
 
-  class MarkdownContent
-    def initialize(path)
-      @path = path
-    end
-
-    def generate_html
-      markdown = @path.read
-      Obsidian::ObsidianFlavoredMarkdown.parse(markdown).to_html
-    end
-  end
-
   class Parser
     attr_reader :index
 
@@ -49,7 +39,7 @@ module Obsidian
         @index.add_page(
           slug,
           last_modified: path.mtime,
-          content: MarkdownContent.new(path)
+          content: MarkdownContent.new(path, @index)
         )
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsidian-parser
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Mat Moore
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-30 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -56,6 +56,7 @@ files:
 - README.md
 - Rakefile
 - lib/obsidian/parser.rb
+- lib/obsidian/parser/markdown_content.rb
 - lib/obsidian/parser/obsidian_flavored_markdown.rb
 - lib/obsidian/parser/page.rb
 - lib/obsidian/parser/parsed_markdown_document.rb