obsidian-parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c404193f58a335e936da522026f3368b2b7c42d99776fd3910d7667c948a8a54
+  data.tar.gz: 3b685ae208f985cba65c573f14fa199ea3a40d9f3d392a0103dbc2710178dab1
+SHA512:
+  metadata.gz: 2ab90cafe12e33f2b808f9ad4f4e90617df034ecee71cc1ec5d27b7595767c348f6cad0d52272e3e55b376a902f78b744c080044bc674f981727a1469b6bb08f
+  data.tar.gz: 6028a69c8f9fd5bdc65df4bdd467b2182492613539c4e4ed373137727b831253b7ee2eb6d6a7b9779aa8555b6764bb1f5644846c65f6393fe373b943c6a952ed

data/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: local
+    hooks:
+    -   id: standardrb
+        name: bundle exec rake standard:fix
+        entry: bundle exec rake standard:fix
+        language: system
+        pass_filenames: false
+-   repo: local
+    hooks:
+    -   id: rspec
+        name: bundle exec rspec
+        entry: bundle exec rspec
+        language: system
+        pass_filenames: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-10
+
+- Initial release: return a tree of notes

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in obsidian-parser.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    obsidian-parser (0.1.0)
+      kramdown (~> 2.4)
+      kramdown-parser-gfm (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.30.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.18.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  obsidian-parser!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mat Moore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Obsidian::Parser
+
+A (work in progress) gem to parse notes created with the Obsidian note-taking tool.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add obsidian-parser
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install obsidian-parser
+
+## Usage
+WARNING: This API is not yet finalized.
+
+```ruby
+parser = Obsidian::Parser.new(Pathname.new("/path/to/vault"))
+
+puts parser.index.notes
+# -> [ Note(title: "README", slug: "README") ]
+
+puts parser.index.directories
+# -> [ Index(title: "Drafts", slug: "Drafts"),
+#      Index(title: "Projects", slug: "Projects") ]
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/matmoore/obsidian-parser.
+
+## Resources and similar projects
+
+- [Obsidian link formats](https://help.obsidian.md/Linking+notes+and+files/Internal+links)
+- [Obisidian metadata format](https://help.obsidian.md/Editing+and+formatting/Metadata)
+- [Obsidian flavored markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown)
+- [Is there a parser/renderer reference spec? (No)](https://forum.obsidian.md/t/is-there-a-parser-renderer-reference-spec/29504/4)
+- [Obsidian-Markdown-Parser](https://github.com/danymat/Obsidian-Markdown-Parser) (Python)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/obsidian/parser/markdown_converter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Obsidian
+  class MarkdownConverter
+    def initialize(document)
+      @document = document
+    end
+
+    def extract_links
+      _extract_links(document.root)
+    end
+
+    private
+
+    attr_reader :document
+
+    def _extract_links(element)
+      if element.type == :a
+        [[element.attr["href"], _extract_text_content(element)]]
+      elsif !element.children.empty?
+        element.children.flat_map { |child| _extract_links(child) }
+      else
+        []
+      end
+    end
+
+    def _extract_text_content(element)
+      if element.type == :text
+        element.value
+      elsif !element.children.empty?
+        element.children.map { |child| _extract_text_content(child) }.join
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/obsidian/parser/obsidian_flavored_markdown.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "kramdown"
+require "kramdown-parser-gfm"
+
+module Obsidian
+  module ObsidianFlavoredMarkdown
+    WIKILINK_SYNTAX = %r{
+      \[\[
+      (?<target>[^\]\#|]*) # link target
+      (?:
+        \#(?<fragment>[^|\]]*) # optional heading fragment
+      )?
+      (?:
+        \|(?<text>[^\]]*) # optional link display text
+      )?
+      \]\]
+    }x
+
+    # Convert Obsidian-flavored-markdown syntax to something parseable
+    # (i.e. with Github-flavored-markdown syntax)
+    def self.normalize(markdown_text)
+      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}"
+
+        "[#{display_text}](#{href})"
+      end
+    end
+
+    # 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)
+    end
+  end
+end

data/lib/obsidian/parser/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Obsidian
+  class Parser
+    VERSION = "0.1.0"
+  end
+end

data/lib/obsidian/parser.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "parser/version"
+require_relative "parser/markdown_converter"
+require_relative "parser/obsidian_flavored_markdown"
+
+module Obsidian
+  class Error < StandardError; end
+
+  def self.build_slug(title, parent_slug)
+    (parent_slug == "") ? title : "#{parent_slug}/#{title}"
+  end
+
+  class Note
+    def initialize(title, slug, last_modified)
+      # TODO: check frontmatter for titles as well
+      @title = title
+      @slug = slug
+      @last_modified = last_modified
+    end
+
+    def inspect
+      "Note(title: #{title.inspect}, slug: #{slug.inspect})"
+    end
+
+    attr_reader :title
+    attr_reader :slug
+    attr_reader :last_modified
+  end
+
+  class Index
+    def initialize(title = "", slug = "")
+      @title = title
+      @slug = slug
+      @notes = []
+      @directories = {}
+    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)
+      slug = Obsidian.build_slug(title, parent_slug)
+      directory = nested_directory(parent_slug.split("/"))
+      note = Note.new(title, slug, last_modified)
+
+      directory.notes << 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
+
+    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("", "")
+
+      vault_directory.glob("**/*.md").each do |path|
+        dirname, basename = path.relative_path_from(vault_directory).split
+
+        if basename != "index.md" && basename != "."
+          title = basename.to_s.gsub(/\.md\z/, "")
+          parent_slug = dirname.to_s.gsub(/\A\.\/?/, "")
+          @index.add_note(title, parent_slug, path.mtime)
+        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)
+      end
+
+      index.notes.sort_by(&:title).each do |note|
+        block.call(note, level)
+      end
+    end
+
+    def table_of_contents
+      result = []
+      walk_tree(index) { |note, level| result << [note, level] }
+      result
+    end
+  end
+end

data/obsidian-parser.gemspec

@@ -0,0 +1,39 @@
+# 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

data/sig/obsidian/parser.rbs

@@ -0,0 +1,6 @@
+module Obsidian
+  module Parser
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: obsidian-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mat Moore
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description:
+email:
+- matmoore@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".pre-commit-config.yaml"
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/obsidian/parser.rb
+- 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:
+- MIT
+metadata:
+  source_code_uri: https://github.com/matmoore/obsidian-parser
+  changelog_uri: https://github.com/matmoore/obsidian-parser/tree/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Parse notes created with the Obsidian note-taking tool.
+test_files: []