diml 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e688225588d8e5239464efa0873e93b07be46ac97dcfece27d93f9754a0210f
-  data.tar.gz: 5f7fd51e1eac09ee9b35178733cf61ffd20a3c2419a08780ae8e312ce18dcbca
+  metadata.gz: 23c58059fc446032dddbbda976bab077dd3abad4767f344e010f73958eda0ec1
+  data.tar.gz: 64384b3c993c53cce0150197708152f9b28b6940181aee0e22d3f41cc0c369fb
 SHA512:
-  metadata.gz: 2de69226a26a89556b7e31080fe661e17b969605fca5cea38f11a58157b471f6bba1c2e5900b1d7fd1533600ca656c61cfc600a356daf39d536ac093c1ced669
-  data.tar.gz: 0432da9d0f971c2d4f8216a7520e202956ec88e9ec6df2fe6cab8f40e40e2a57511c486ab42e4b8dfe7926a7106346666e3cdb5bc8aebb208852e4537dc004d3
+  metadata.gz: 4ccaf1cf6a0c94aec38ebc72e70a622c96d545115edc6c9edd51a7231fa2fde09735f7a796a603f70c355646536a4fb3668c47003da2b5053618b02e885820b4
+  data.tar.gz: fdd0d44e7b5f7cc893c5dee140e679898f587e2859b9cfa26d01d80e907ad28e8eb228f7346a924b18a96b273327c24ed8b8926e45f449b21750b9aa125573a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diml (0.1.0)
+    diml (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +10,7 @@ GEM
     coderay (1.1.3)
     json (2.6.2)
     method_source (1.0.0)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -40,6 +41,7 @@ PLATFORMS
 
 DEPENDENCIES
   diml!
+  minitest
   pry
   rake (~> 13.0)
   rubocop (~> 1.21)

data/Makefile

@@ -6,6 +6,9 @@ console:
 setup:
 	@bundle exec bin/setup
 
+build:
+	@bundle exec rake build
+
 install:
 	@bundle exec rake install
 

data/diml.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["aquaflamingo"]
   spec.email = ["16901597+aquaflamingo@users.noreply.github.com"]
 
-  spec.summary = "Sum"
-  spec.description = "Desc"
+  spec.summary = "Convert a diml document to markdown"
+  spec.description = "A diml document provides a simple markup format for dictating notes in a way to preserve formatting for transformation to a presentable format (e.g. markdown)"
   spec.homepage = "https://github.com/aquaflamingo/diml"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/examples/parse_md.rb

@@ -28,7 +28,12 @@ OptionParser.new do |parser|
 end.parse!
 
 def diml_to_md(input)
-  doc = Diml::Document.load(input)
+  begin
+    doc = Diml::Document.load(input)
+  rescue => e
+    puts "failed to parse: #{e.message}"
+    exit 1
+  end
 
   formatter = Diml::Formatter.new(doc, :markdown)
 

data/lib/diml/document/parser.rb

@@ -4,100 +4,113 @@ require_relative "../elements/factory.rb"
 require_relative "../elements/section"
 require_relative "../elements/point"
 require_relative "../elements/heading"
+require_relative "../error"
 
 # Basic document parser
 module Diml
-class Parser
-  def initialize(raw_content)
-    @raw_content = raw_content
-  end
-
-  # Parses the raw content for a DIML document into
-  # the internal representation.
-  def parse
-    basic_tokens = @raw_content.split(";")
-
-    # Create new Content Tree
-    ctree = ContentTree.new
-    ctree.content = Root.new("")
-    ctree.root!
-
-    tree = build_tree(ctree, basic_tokens)
 
-    # Return the root not the last value
-    t = tree
-    t = t.parent until t.root?
-    t
-  end
-
-  private
-
-  # Recursive content tree builder
-  def build_tree(ctree, tokens)
-    # Basic case: if there are no nestable tokens
-    return ctree if tokens.empty?
+  # 
+  # Parser is responsible for converted raw content into a DiML document tree
+  #
+  class Parser
+    def initialize(raw_content)
+      @raw_content = raw_content
+    end
 
-    # Pull first element from the start of the array
-    next_token = tokens.first.strip
-    tokens = tokens.drop(1)
+    # Parses the raw content for a DIML document into
+    # the internal representation.
+    def parse
+      basic_tokens = @raw_content.split(";")
 
-    # Create a new element
-    element = Factory.new_element(next_token)
+      # Create new Content Tree
+      ctree = ContentTree.new
+      ctree.content = Root.new("")
+      ctree.root!
 
-    case element.class.name
-    when Section.name
-      if ctree.root?
-        # Sections can only belong as children to the root. 
-        child = add_to_tree(ctree, element)
-      else 
-        # Continue to traverse upwards until you find the root
-        ancestor = ctree.parent
-        ancestor = ancestor.parent until ancestor.root?
+      tree = build_tree(ctree, basic_tokens)
 
-        # Ancestor is root. Insert this section.
-        child = add_to_tree(ancestor, element)
-      end
+      # Return the root not the last value
+      t = tree
+      t = t.parent until t.root?
+      t
+    end
 
-      build_tree(child, tokens)
-    when Heading.name
-      if ctree.content.instance_of? Section
-        # Headings can only belong to sections
-        child = add_to_tree(ctree, element)
-      else
-        ancestor = ctree.parent
-        ancestor = ancestor.parent until ancestor.content.instance_of? Section
-
-        # Ancestor is root. Insert this section.
-        child = add_to_tree(ancestor, element)
+    private
+
+    # Recursive content tree builder
+    def build_tree(ctree, tokens)
+      # Basic case: if there are no nestable tokens
+      return ctree if tokens.empty?
+
+      # Pull first element from the start of the array
+      next_token = tokens.first.strip
+      tokens = tokens.drop(1)
+
+      # Create a new element
+      element = Factory.new_element(next_token)
+
+      case element.class.name
+      when Section.name
+        if ctree.root?
+          # Sections can only belong as children to the root. 
+          child = add_to_tree(ctree, element)
+        else 
+          # Continue to traverse upwards until you find the root
+          ancestor = ctree.parent
+          ancestor = ancestor.parent until ancestor.root?
+
+          # Ancestor is root. Insert this section.
+          child = add_to_tree(ancestor, element)
+        end
+
+        build_tree(child, tokens)
+      when Heading.name
+        if ctree.content.instance_of? Section
+          # Headings can only belong to sections
+          child = add_to_tree(ctree, element)
+        else
+          begin
+            ancestor = ctree.parent
+            ancestor = ancestor.parent until ancestor.content.instance_of? Section
+          rescue => e
+            raise DocumentError.new("invalid diml document: heading must be child of section")
+          end
+         
+          # Ancestor is root. Insert this section.
+          child = add_to_tree(ancestor, element)
+        end
+
+        build_tree(child, tokens)
+      when Point.name
+        if ctree.content.instance_of? Heading
+          # Headings can only belong to sections
+          child = add_to_tree(ctree, element)
+        else
+          begin
+            ancestor = ctree.parent
+            ancestor = ancestor.parent until ancestor.content.instance_of? Heading
+          rescue => e
+            raise DocumentError.new("invalid diml document: point must be child of heading")
+          end
+
+          # Ancestor is root. Insert this section.
+          child = add_to_tree(ancestor, element)
+        end
+
+        build_tree(child, tokens)
       end
 
-      build_tree(child, tokens)
-    when Point.name
-      if ctree.content.instance_of? Heading
-        # Headings can only belong to sections
-        child = add_to_tree(ctree, element)
-      else
-        ancestor = ctree.parent
-        ancestor = ancestor.parent until ancestor.content.instance_of? Heading
-
-        # Ancestor is root. Insert this section.
-        child = add_to_tree(ancestor, element)
-      end
-      
-      build_tree(child, tokens)
+      ctree
     end
 
-    ctree
-  end
+    # Helper method to create and add a new element to a content tree
+    def add_to_tree(tree, child_element)
+      child = ContentTree.new
+      child.parent = tree
+      child.content = child_element
+      tree.add_child(child)
 
-  # Helper method to create and add a new element to a content tree
-  def add_to_tree(tree, child_element)
-    child = ContentTree.new
-    child.parent = tree
-    child.content = child_element
-    tree.add_child(child)
-
-    child
+      child
+    end
   end
 end
-end

data/lib/diml/error.rb

@@ -0,0 +1,3 @@
+module Diml
+  class DocumentError < StandardError; end
+end

data/lib/diml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diml
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,7 +24,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Desc
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A diml document provides a simple markup format for dictating notes in
+  a way to preserve formatting for transformation to a presentable format (e.g. markdown)
 email:
 - 16901597+aquaflamingo@users.noreply.github.com
 executables:
@@ -61,6 +76,7 @@ files:
 - lib/diml/elements/point.rb
 - lib/diml/elements/root.rb
 - lib/diml/elements/section.rb
+- lib/diml/error.rb
 - lib/diml/format/formatter.rb
 - lib/diml/format/markdown.rb
 - lib/diml/version.rb
@@ -90,5 +106,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Sum
+summary: Convert a diml document to markdown
 test_files: []