obsidian-parser 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 347ae1e2c1152ccae4ae2ad6a19c4477ae07a8dca77dcfd73d1e31da823cf5f6
-  data.tar.gz: 4d2257fd34be583429baf260e3136ca6cdf6cdb4d66fbd592abc396e81a32dfa
+  metadata.gz: 10a282bce512c7d763d89eed0aedff250e6721cad6e0849af3821dd897e8d819
+  data.tar.gz: d3271c30ab0f7094b6273b0e8f86b33ec2280729fe757958b61459cc0bca5447
 SHA512:
-  metadata.gz: 99cfb58610e351574d4ca83faa28b90117ae63a2d219151f005d87e365ee80704d44759c2610cd6bf9b8301fec0ffeb4245d112231fa9ace90202283ad094758
-  data.tar.gz: a032cb2063e781db38c5ecafbe13f047d36e16cb5d71cf4c6b8558e40a6867d20b510a25aabbfe2201f5ce45a80a0ca7c729f1c5bd3e78f8030f01be812f61ac
+  metadata.gz: 69cdd0c2c4c6ceb085c9e861d18be91ce3f6b237445f26720bf1787da8448c7ab459c24b4a717d51d1001c7ab9f09b143cb296d28dfee075a869dad9aed10467
+  data.tar.gz: 9511deca5d2844548218b5a7841912b89469b036db63ad3c879c0e246453bf527cb37c732fc3df4e22dfcba4ea5f24e53340dc8572ac0c9372146ee14fb95805

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-07-30
+- Fix ordering of `Page#children` so that index pages come first.
+- Fix handling of `index.md` documents so that the slug reflects the directory path.
+
+## [0.4.0] - 2023-07-30
+- Unify `Note` and `Index` classes into `Page`. This is a breaking API change. `Parser#notes is replaced by Parse#pages`. Call `Page#is_index?`to distinguish between directory derived pages and documents.
+- Remove `Parser#table_of_contents` and `Parser#walk_tree`.
+- Add `Page#find_in_tree` to recursively search for a page with a matching slug.
+- Rename `Obsidian::MarkdownConverter` to `Obsidian::ParsedMarkdownDocument`
+
 ## [0.3.0] - 2023-07-27
 
-- Note objects have a `parent` attribute.
+- `Note` objects have a `parent` attribute.
 
 ## [0.2.0] - 2023-07-24
 
-- Note objects have a `content` attribute. Call `content.generate_html` to generate HTML on demand.
+- `Note` objects have a `content` attribute. Call `content.generate_html` to generate HTML on demand.
 
 ## [0.1.0] - 2023-07-10
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    obsidian-parser (0.3.0)
+    obsidian-parser (0.5.0)
       kramdown (~> 2.4)
       kramdown-parser-gfm (~> 1.1)
 

data/lib/obsidian/parser/obsidian_flavored_markdown.rb

@@ -34,7 +34,7 @@ module Obsidian
     # Parse links from obsidian-flavored-markdown text
     def self.parse(markdown_text)
       document = Kramdown::Document.new(normalize(markdown_text), input: "GFM")
-      Obsidian::MarkdownConverter.new(document)
+      Obsidian::ParsedMarkdownDocument.new(document)
     end
   end
 end

data/lib/obsidian/parser/page.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Obsidian
+  # A page in the vault corresponding to either a markdown document,
+  # or a directory containing other documents.
+  #
+  # If a directory contains an index.md, that is used as the content of
+  # the directory page; otherwise content will be nil.
+  class Page
+    def self.create_root
+      Page.new(title: "", slug: "")
+    end
+
+    def initialize(title:, slug:, last_modified: nil, content: nil, parent: nil)
+      # TODO: check frontmatter for titles as well
+      @title = title
+      @slug = slug
+      @last_modified = last_modified
+      @content = content
+      @parent = parent
+      @children = {}
+    end
+
+    def is_index?
+      !children.empty?
+    end
+
+    def inspect
+      "Page(title: #{title.inspect}, slug: #{slug.inspect})"
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        !slug.nil? &&
+        slug == other&.slug
+    end
+
+    alias_method :eql?, :==
+
+    def hash
+      slug.hash
+    end
+
+    # Add a note to the tree based on its slug.
+    # Call this method on the root page.
+    # When calling this method, you must ensure that anscestor pages
+    # are added before their descendents.
+    def add_page(slug, last_modified: nil, content: nil)
+      path_components = slug.split("/")
+      raise ArgumentError, "Expecting non-empty slug" if path_components.empty?
+
+      title = path_components.pop
+
+      parent = path_components.reduce(self) do |index, anscestor_title|
+        anscestor_slug = Obsidian.build_slug(anscestor_title, index.slug)
+        index.get_or_create_child(slug: anscestor_slug, title: anscestor_title)
+      end
+
+      parent.get_or_create_child(
+        title: title,
+        slug: slug,
+        last_modified: last_modified,
+        content: content
+      ).tap do |page|
+        page.update_content(content: content, last_modified: last_modified)
+      end
+    end
+
+    def get_or_create_child(title:, slug:, last_modified: nil, content: nil)
+      # TODO: validate slug matches the current page slug
+
+      @children[title] ||= Page.new(
+        slug: slug,
+        title: title,
+        last_modified: last_modified,
+        content: content,
+        parent: self
+      )
+    end
+
+    def update_content(content:, last_modified:)
+      @content ||= content
+      @last_modified ||= last_modified
+    end
+
+    def children
+      @children.values.sort_by { |c| [c.is_index? ? 0 : 1, c.title] }
+    end
+
+    def walk_tree(&block)
+      children.each do |page|
+        block.call(page)
+        page.walk_tree(&block)
+      end
+    end
+
+    # Return the page that matches a slug.
+    # 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.
+    def find_in_tree(query_slug)
+      # Exact match
+      return self if slug == query_slug
+
+      # Partial match
+      query_parts = query_slug.split("/")
+      length = query_parts.size
+      slug_parts = slug.split("/")
+
+      if slug_parts.length > length
+        if slug_parts.slice(-length, length) == query_parts
+          return self
+        end
+      end
+
+      # Recurse
+      children.each do |child|
+        result = child.find_in_tree(query_slug)
+        return result unless result.nil?
+      end
+
+      nil
+    end
+
+    attr_reader :title
+    attr_reader :slug
+    attr_reader :last_modified
+    attr_reader :content
+    attr_reader :parent
+  end
+end

data/lib/obsidian/parser/{markdown_converter.rb → parsed_markdown_document.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Obsidian
-  class MarkdownConverter
+  class ParsedMarkdownDocument
     def initialize(document)
       @document = document
     end

data/lib/obsidian/parser/version.rb

@@ -2,6 +2,6 @@
 
 module Obsidian
   class Parser
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/obsidian/parser.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "parser/version"
-require_relative "parser/markdown_converter"
+require_relative "parser/parsed_markdown_document"
 require_relative "parser/obsidian_flavored_markdown"
+require_relative "parser/page"
+
+require "forwardable"
 
 module Obsidian
   class Error < StandardError; end
@@ -22,112 +25,40 @@ module Obsidian
     end
   end
 
-  class Note
-    def initialize(title, slug, last_modified, content: nil, parent: nil)
-      # TODO: check frontmatter for titles as well
-      @title = title
-      @slug = slug
-      @last_modified = last_modified
-      @content = content
-      @parent = parent
-    end
-
-    def inspect
-      "Note(title: #{title.inspect}, slug: #{slug.inspect})"
-    end
-
-    attr_reader :title
-    attr_reader :slug
-    attr_reader :last_modified
-    attr_reader :content
-    attr_reader :parent
-  end
-
-  class Index
-    def initialize(title = "", slug = "", content: nil)
-      @title = title
-      @slug = slug
-      @notes = []
-      @directories = {}
-      @content = content
-    end
-
-    def add_directory(title)
-      new_slug = Obsidian.build_slug(title, slug)
-      @directories[title] ||= Index.new(title, new_slug)
-    end
-
-    def add_note(title, parent_slug, last_modified, content: nil)
-      slug = Obsidian.build_slug(title, parent_slug)
-      directory = nested_directory(parent_slug.split("/"))
-      note = Note.new(title, slug, last_modified, content: content, parent: directory)
-
-      directory.notes << note
-
-      note
-    end
-
-    def inspect
-      "Index(title: #{title.inspect}, slug: #{slug.inspect})"
-    end
-
-    def directories
-      @directories.values
-    end
-
-    attr_reader :notes
-    attr_reader :title
-    attr_reader :slug
-    attr_reader :content
-
-    private
-
-    def nested_directory(path_components)
-      path_components.reduce(self) { |index, subdirectory| index.add_directory(subdirectory) }
-    end
-  end
-
   class Parser
     attr_reader :index
 
     def initialize(vault_directory)
-      @index = Index.new("", "")
+      @index = Obsidian::Page.create_root
 
       vault_directory.glob("**/*.md").each do |path|
         dirname, basename = path.relative_path_from(vault_directory).split
 
         next if basename == "."
 
-        # TODO: handle index.md files
-        if basename != "index.md"
+        # Remove the path component "." from the start of the dirname
+        parent_slug = dirname.to_s.gsub(/\A\.\/?/, "")
+
+        if basename.to_s == "index.md"
+          slug = parent_slug.to_s.gsub(/\.md\z/, "")
+        else
           title = basename.to_s.gsub(/\.md\z/, "")
-          parent_slug = dirname.to_s.gsub(/\A\.\/?/, "")
-          content = MarkdownContent.new(path)
-          @index.add_note(title, parent_slug, path.mtime, content: content)
+          slug = Obsidian.build_slug(title, parent_slug)
         end
-      end
-
-      # TODO: capture links between notes
-    end
 
-    def notes
-      table_of_contents.map(&:first)
-    end
-
-    def walk_tree(index, level = 0, &block)
-      index.directories.sort_by(&:title).each do |note|
-        block.call(note, level)
-        walk_tree(note, level + 1, &block)
+        @index.add_page(
+          slug,
+          last_modified: path.mtime,
+          content: MarkdownContent.new(path)
+        )
       end
 
-      index.notes.sort_by(&:title).each do |note|
-        block.call(note, level)
-      end
+      # TODO: capture links between notes
     end
 
-    def table_of_contents
+    def pages
       result = []
-      walk_tree(index) { |note, level| result << [note, level] }
+      index.walk_tree { |page| result << page }
       result
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsidian-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mat Moore
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -56,8 +56,9 @@ files:
 - README.md
 - Rakefile
 - lib/obsidian/parser.rb
-- lib/obsidian/parser/markdown_converter.rb
 - lib/obsidian/parser/obsidian_flavored_markdown.rb
+- lib/obsidian/parser/page.rb
+- lib/obsidian/parser/parsed_markdown_document.rb
 - lib/obsidian/parser/version.rb
 - sig/obsidian/parser.rbs
 homepage: