obsidian-parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c404193f58a335e936da522026f3368b2b7c42d99776fd3910d7667c948a8a54
-  data.tar.gz: 3b685ae208f985cba65c573f14fa199ea3a40d9f3d392a0103dbc2710178dab1
+  metadata.gz: 54b2b8b2c841d2c15bf739cc6e2c20a6dea2e29261719104ad1903adbd1a3337
+  data.tar.gz: c51dd21ba256fd8c5f03eb646aee741d45167f0cad79eb7ba715c4c776335205
 SHA512:
-  metadata.gz: 2ab90cafe12e33f2b808f9ad4f4e90617df034ecee71cc1ec5d27b7595767c348f6cad0d52272e3e55b376a902f78b744c080044bc674f981727a1469b6bb08f
-  data.tar.gz: 6028a69c8f9fd5bdc65df4bdd467b2182492613539c4e4ed373137727b831253b7ee2eb6d6a7b9779aa8555b6764bb1f5644846c65f6393fe373b943c6a952ed
+  metadata.gz: 633e3ccd369bc760f316d977aedf485cef4d76bbe28af3f29079a92d5bcb2b92a6a2d529ea0dcf60c09a85bac2c598838ea70ff51b50b60e372ae33652523cae
+  data.tar.gz: 8cac449aa204d036b5e72444afa1235e9dab3cb6b46cd1992d104d6a165775a70171f921c3b3a4064752c5daf08075c20d415a800bc1b6ca6f9c9fcd7c6037b1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-07-24
+
+- Note objects have a `content` attribute. Call `content.generate_html` to generate HTML on demand.
+
 ## [0.1.0] - 2023-07-10
 
 - Initial release: return a tree of notes

data/Gemfile.lock

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

data/README.md

@@ -26,6 +26,13 @@ puts parser.index.directories
 #      Index(title: "Projects", slug: "Projects") ]
 ```
 
+### Generating HTML
+```ruby
+title = note.title
+content = note.content
+content.generate_html
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/obsidian/parser/markdown_converter.rb

@@ -10,6 +10,10 @@ module Obsidian
       _extract_links(document.root)
     end
 
+    def to_html
+      document.to_html
+    end
+
     private
 
     attr_reader :document

data/lib/obsidian/parser/version.rb

@@ -2,6 +2,6 @@
 
 module Obsidian
   class Parser
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/obsidian/parser.rb

@@ -11,12 +11,24 @@ 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 Note
-    def initialize(title, slug, last_modified)
+    def initialize(title, slug, last_modified, content: nil)
       # TODO: check frontmatter for titles as well
       @title = title
       @slug = slug
       @last_modified = last_modified
+      @content = content
     end
 
     def inspect
@@ -26,14 +38,16 @@ module Obsidian
     attr_reader :title
     attr_reader :slug
     attr_reader :last_modified
+    attr_reader :content
   end
 
   class Index
-    def initialize(title = "", slug = "")
+    def initialize(title = "", slug = "", content: nil)
       @title = title
       @slug = slug
       @notes = []
       @directories = {}
+      @content = content
     end
 
     def add_directory(title)
@@ -41,10 +55,10 @@ module Obsidian
       @directories[title] ||= Index.new(title, new_slug)
     end
 
-    def add_note(title, parent_slug, last_modified)
+    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)
+      note = Note.new(title, slug, last_modified, content: content)
 
       directory.notes << note
     end
@@ -60,6 +74,7 @@ module Obsidian
     attr_reader :notes
     attr_reader :title
     attr_reader :slug
+    attr_reader :content
 
     private
 
@@ -77,10 +92,14 @@ module Obsidian
       vault_directory.glob("**/*.md").each do |path|
         dirname, basename = path.relative_path_from(vault_directory).split
 
-        if basename != "index.md" && basename != "."
+        next if basename == "."
+
+        # TODO: handle index.md files
+        if basename != "index.md"
           title = basename.to_s.gsub(/\.md\z/, "")
           parent_slug = dirname.to_s.gsub(/\A\.\/?/, "")
-          @index.add_note(title, parent_slug, path.mtime)
+          content = MarkdownContent.new(path)
+          @index.add_note(title, parent_slug, path.mtime, content: content)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsidian-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mat Moore
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -59,7 +59,6 @@ files:
 - lib/obsidian/parser/markdown_converter.rb
 - lib/obsidian/parser/obsidian_flavored_markdown.rb
 - lib/obsidian/parser/version.rb
-- obsidian-parser.gemspec
 - sig/obsidian/parser.rbs
 homepage:
 licenses:

data/obsidian-parser.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/obsidian/parser/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "obsidian-parser"
-  spec.version = Obsidian::Parser::VERSION
-  spec.authors = ["Mat Moore"]
-  spec.email = ["matmoore@users.noreply.github.com"]
-
-  spec.summary = "Parse notes created with the Obsidian note-taking tool."
-  # spec.description = "TODO: Write a longer description or delete this line."
-
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["source_code_uri"] = "https://github.com/matmoore/obsidian-parser"
-  spec.metadata["changelog_uri"] = "https://github.com/matmoore/obsidian-parser/tree/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "kramdown", "~> 2.4"
-  spec.add_dependency "kramdown-parser-gfm", "~> 1.1"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end