markleft 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7629bbb0deff5bdeb11894c8c2dc3a4a55c697cbf3af8402d38d093d5ce2ea75
-  data.tar.gz: e2318355783b9919af483419b660119c7d8e44516f20464e5a41eae4747591a7
+  metadata.gz: 0e39397435aa49f700beb715c4b6217b05d91e2e07285f47ea3975a6a0ff9b42
+  data.tar.gz: 601e1056c30ae08ea786e1ca7b16a68855ee3cc0084bcdbc9361cf52b4ffabf9
 SHA512:
-  metadata.gz: 6acfcf5631696853f694d2efff3e566cf5a00ad8451b29e856c48326bd47b667114dc6191ff307ab0c6b5623f40a71804240d9e3509db79d37eec07b041f0797
-  data.tar.gz: edff09e17f9b2be7501363e247594c34d50f70e2a0dc5ef703690fc20aeac166e343787093fc260bcbcbb485d178a84cbeeaf4108c434d3ca9bdd3a2752761b8
+  metadata.gz: 4fbd7f19a38d74ed7d26149504ab8c0ef3f24ca23d5ae24d5f3e71673b31477a89eec037bc4d601a76d5dc171ed157a0bc61e960b46ebf13fd9ff475a27d4058
+  data.tar.gz: 57026972645b913bc6814f2d061434d0c392a8728d8f0dbf86a8f554230ece2b4c94315d6866ef49f49bae33e2cd58c3dd455b872447b47c60a443af49f4510a

data/.idea/markleft.iml

@@ -12,10 +12,70 @@
     <orderEntry type="jdk" jdkName="ruby-3.2.4-p170" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.6.3, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="cli-ui (v2.3.0, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v2.10.1, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.4, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.25.4, ruby-3.2.4-p170) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parallel (v1.26.3, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.3.7.1, ruby-3.2.4-p170) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="racc (v1.8.1, ruby-3.2.4-p170) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, ruby-3.2.4-p170) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.10.0, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.71.2, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.38.0, ruby-3.2.4-p170) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.13.0, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v3.1.4, ruby-3.2.4-p170) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-emoji (v4.0.4, ruby-3.2.4-p170) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache-v2">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build markleft-0.1.5.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum of markleft-0.1.5.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install markleft-0.1.5.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install markleft-0.1.5.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.5 and build and push markleft-0.1.5.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
+          <RakeTaskImpl id="rubocop">
+            <subtasks>
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (only when it's safe)" fullCommand="rubocop:autocorrect" id="autocorrect" />
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (safe and unsafe)" fullCommand="rubocop:autocorrect_all" id="autocorrect_all" />
+              <RakeTaskImpl description="" fullCommand="rubocop:auto_correct" id="auto_correct" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Run the test suite" fullCommand="test" id="test" />
+          <RakeTaskImpl id="test">
+            <subtasks>
+              <RakeTaskImpl description="Print out the test command" fullCommand="test:cmd" id="cmd" />
+              <RakeTaskImpl description="Show which test files fail when run in isolation" fullCommand="test:isolated" id="isolated" />
+              <RakeTaskImpl description="Run the test suite and report the slowest 25 tests" fullCommand="test:slow" id="slow" />
+              <RakeTaskImpl description="" fullCommand="test:deps" id="deps" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
   </component>
 </module>

data/README.md

@@ -7,19 +7,16 @@
 
 MarkLeft is a powerful and flexible tool designed to extend the capabilities of traditional Markdown-to-HTML compilers. It introduces additional syntax and features to enhance the expressiveness and functionality of Markdown documents.
 
-## Project Structure
+> [!TIP]
+> MarkLeft is a work in progress and is currently under development. Please check back for updates and new features.
+> You are still free to use it and contribute to it.
 
-- `Gemfile` and `Gemfile.lock`: Manage gem dependencies.
-- `markleft-main.rb`: Script for converting Markdown to HTML.
-- `terminal.rb`: TUI for converting Markdown to HTML.
-- `lib/`: Contains the tokenizer, parser, and generator classes.
 
 ## Features
 
-- **Extended Syntax**: Supports additional formatting options such as bold, italics, and more.
-- **Custom Nodes**: Allows the creation of custom nodes to represent different types of content.
-- **Tokenization and Parsing**: Efficiently tokenizes and parses Markdown content into a structured node tree.
-- **Easy Integration**: Can be easily integrated into existing projects and workflows.
+- **Superfast**: MarkLeft is designed to be fast and efficient, processing Markdown files quickly and generating HTML output in an instant.
+- **Extensible**: MarkLeft is highly extensible, allowing users to define custom syntax and features to suit their needs.
+- **Customizable**: MarkLeft provides a range of options and settings to customize the output, including themes, styles, and more.(coming soon)
 
 ## Prerequisites
 
@@ -30,43 +27,44 @@ MarkLeft is a powerful and flexible tool designed to extend the capabilities of
 
 To install MarkLeft, clone the repository and navigate to the project directory:
 
-1. Clone the repository:
-   ```sh
-   git clone https://github.com/yourusername/markdown-to-html.git
-   cd markdown-to-html
-   ```
+#### Gem
 
-2. Install the dependencies:
-   ```sh
-   bundle install
-   ```
+```sh
+gem install markleft
+```
+
+#### Repository
+
+```sh
+git clone git@github.com:greeenboi/markdown-superset-compiler.git
+cd markdown-superset-compiler
+```
 
 ## Running the Converter
 
-### Using `markleft-main.rb`
+#### Using Gem
 
-The `markleft-main.rb` file is a simple script that reads a Markdown file, tokenizes it, parses it, and generates HTML output.
+```shell
+markleft
+```
 
-1. Run the script:
-   ```sh
-   ruby markleft-main.rb
-   ```
+0r 
 
-2. Enter the name of the Markdown file when prompted.
+```shell
+markleft --file <filename>
+```
 
-### Using `terminal.rb` (TUI)
+#### Using `markleft-main.rb`
 
-The `terminal.rb` file provides a Text User Interface (TUI) for selecting and processing Markdown files.
+The `markleft-main.rb` file is a simple script that reads a Markdown file, tokenizes it, parses it, and generates HTML output.
 
 1. Run the script:
    ```sh
-   ruby terminal.rb
+   ruby lib/markleft.rb
    ```
-
+   
 2. Follow the prompts to select a Markdown file and process it.
 
-
-
 ## Example
 
 Given a sample Markdown file `sample.md`:

data/Rakefile

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "minitest/markleft_task"
+require "minitest/test_task"
 
-Minitest::MarkleftTask.create
+Minitest::TestTask.create(:test) do |t|
+  t.test_globs = FileList["test/**/*_test.rb"]
+  t.libs << "test"
+  t.libs << "lib"
+end
 
 require "rubocop/rake_task"
 

data/exe/markleft

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "markleft"
+require_relative '../lib/markleft'

data/lib/markleft/version.rb

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

data/lib/markleft.rb

@@ -3,11 +3,19 @@
 require "cli/ui"
 require "fileutils"
 require_relative "markleft/version"
+require 'optparse'
 
 module Markleft
   # ----------------- Tokenizer Module ----------------- #
   class Tokenizer
     TOKEN_TYPES = [
+      [:heading1, /^# .+/],
+      [:heading2, /^## .+/],
+      [:heading3, /^### .+/],
+      [:heading4, /^#### .+/],
+      [:heading5, /^##### .+/],
+      [:heading6, /^###### .+/],
+      [:strikethrough, /((?<!\s)~~(?!\s)(?:[^~]+?|(?:[^~]*(?:(?:~[^~]*){2})+?)+?)(?<!\s)~~)/],
       [:bold, /((?<!\s)\*\*(?!\s)(?:[^*]+?|(?:[^*]*(?:(?:\*[^*]*){2})+?)+?)(?<!\s)\*\*)/],
       [:italics, /((?<!\s)\*(?!\s)(?:(?:[^**]*(?:(?:\*\*[^**]*){2})+?)+?|[^**]+?)(?<!\s)\*)/],
       [:newline, /(\r\n|\r|\n)/],
@@ -63,6 +71,20 @@ module Markleft
         parse_newline
       when :text
         parse_text
+      when :heading1
+        parse_heading(1)
+      when :heading2
+        parse_heading(2)
+      when :heading3
+        parse_heading(3)
+      when :heading4
+        parse_heading(4)
+      when :heading5
+        parse_heading(5)
+      when :heading6
+        parse_heading(6)
+      when :strikethrough
+        parse_strikethrough
       else
         raise "Unexpected token type: #{@tokens.first.type}"
       end
@@ -83,6 +105,16 @@ module Markleft
       NewlineNode.new
     end
 
+    def parse_heading(level)
+      consume(:"heading#{level}")
+      HeadingNode.new("Heading", level)
+    end
+
+    def parse_strikethrough
+      value = consume(:strikethrough).value
+      StrikethroughNode.new(value)
+    end
+
     def parse_text
       value = consume(:text).value
       TextNode.new(value)
@@ -111,6 +143,10 @@ module Markleft
         generate_newline(node)
       when TextNode
         generate_text(node)
+      when HeadingNode
+        generate_heading(node)
+      when StrikethroughNode
+        generate_strikethrough(node)
       else
         raise "Unexpected node type: #{node.class}"
       end
@@ -128,6 +164,14 @@ module Markleft
       "<br>"
     end
 
+    def generate_heading(node)
+      "<h#{node.level}>#{node.value}</h#{node.level}>"
+    end
+
+    def generate_strikethrough(node)
+      "<del>#{node.value}</del>"
+    end
+
     def generate_text(node)
       node.value
     end
@@ -146,6 +190,8 @@ module Markleft
   ItalicsNode = Struct.new(:value)
   NewlineNode = Struct.new(:value)
   TextNode = Struct.new(:value)
+  HeadingNode = Struct.new(:value, :level)
+  StrikethroughNode = Struct.new(:value)
 
   # ----------------- Main Block ----------------- #
 
@@ -196,12 +242,41 @@ module Markleft
     html_file_name
   end
 
-  CLI::UI::Frame.open("Markdown to HTML Converter") do
+  CLI::UI::Frame.open("Markleft") do
+    puts "Markleft version: #{Markleft::VERSION}"
+    puts "Ruby version: #{RUBY_VERSION}"
+    puts "Developer: Suvan Gowri Shanker"
+    puts "GitHub: https://github.com/greeenboi"
+
+    options = {}
+    OptionParser.new do |opts|
+      opts.banner = <<~BANNER
+        Usage: markleft [options]
+
+        This utility converts Markdown files in the current directory to HTML.
+        It provides an interactive UI to select files unless a file is specified.
+        Use the following flags for quick access:
+
+      BANNER
+      opts.separator ""
+      opts.separator "Examples:"
+      opts.separator "  markleft --file example.md"
+      opts.separator "  markleft --help"
+      opts.separator ""
+      opts.on("--help", "Show help information") do
+        puts opts
+        exit
+      end
+      opts.on("--file FILE", "Specify a markdown file") do |filename|
+        options[:file] = filename
+      end
+    end.parse!
+
     files = list_md_files
     if files.empty?
       puts "No markdown files found in the current directory."
     else
-      selected_file = select_md_file(files)
+      selected_file = options[:file] || select_md_file(files)
       puts "Processing file: #{selected_file}"
       html_content = process_file(selected_file)
       puts "Generated HTML content:"

data/sample.html

@@ -1 +1 @@
-This is a sample <i>*Markdown*</i>file \n<b>**bold**</b>yippee!
+<h1>Heading</h1><h2>Heading</h2><h3>Heading</h3><h4>Heading</h4><h5>Heading</h5><h6>Heading</h6>---<b>**Bold text**</b><i>*Italic text*</i><b>***Bold and italic text***</b><del>~~Strikethrough text~~</del> > Blockquote- Unordered list item 1- Unordered list item 2- Nested unordered list item1. Ordered list item 12. Ordered list item 21. Nested ordered list item`Inline code````ruby<h1>Heading</h1>def hello_worldputs "Hello, world!"end```[Link to GitHub](https://github.com)![Image alt text](https://via.placeholder.com/150)| Header 1 | Header 2 || -------- | -------- || Cell 1   | Cell 2   || Cell 3   | Cell 4   |---- [ ] Task list item 1- [x] Task list item 2---Footnote reference[^1].[^1]: Footnote text.---This is a sample text with a [^2] superscript.[^2]: Superscript text.---<details><summary>Expandable section</summary>This is the content of the expandable section.</details>---

data/sample.md

@@ -1,2 +1,75 @@
-This is a sample *Markdown* file \n
-**bold** yippee!
+# Heading 1
+
+## Heading 2
+
+### Heading 3
+
+#### Heading 4
+
+##### Heading 5
+
+###### Heading 6
+
+---
+
+**Bold text**
+
+*Italic text*
+
+***Bold and italic text***
+
+~~Strikethrough text~~
+
+> Blockquote
+
+- Unordered list item 1
+- Unordered list item 2
+  - Nested unordered list item
+
+1. Ordered list item 1
+2. Ordered list item 2
+   1. Nested ordered list item
+
+`Inline code`
+
+```ruby
+# Code block with syntax highlighting
+def hello_world
+  puts "Hello, world!"
+end
+```
+
+[Link to GitHub](https://github.com)
+
+![Image alt text](https://via.placeholder.com/150)
+
+| Header 1 | Header 2 |
+| -------- | -------- |
+| Cell 1   | Cell 2   |
+| Cell 3   | Cell 4   |
+
+---
+
+- [ ] Task list item 1
+- [x] Task list item 2
+
+---
+
+Footnote reference[^1].
+
+[^1]: Footnote text.
+
+---
+
+This is a sample text with a [^2] superscript.
+
+[^2]: Superscript text.
+
+---
+
+<details>
+  <summary>Expandable section</summary>
+  This is the content of the expandable section.
+</details>
+
+---

data/sig/markleft/generator.rbs

@@ -3,8 +3,11 @@ module Markleft
     def generate: (untyped) -> String
     def generate_all: (Array[untyped]) -> String
     def generate_bold: (untyped) -> String
+
+    def generate_heading: (untyped) -> String
     def generate_italics: (untyped) -> String
     def generate_newline: (untyped) -> String
+    def generate_strikethrough: (untyped) -> String
     def generate_text: (untyped) -> String
   end
 end

data/sig/markleft/parser.rbs

@@ -6,9 +6,12 @@ module Markleft
     def consume: (Symbol) -> untyped
     def parse: -> Array[untyped]
     def parse_bold: -> untyped
+
+    def parse_heading: -> untyped
     def parse_italics: -> untyped
     def parse_newline: -> untyped
     def parse_node: -> untyped
+    def parse_strikethrough: -> untyped
     def parse_text: -> untyped
   end
 end

data/sig/markleft.rbs

@@ -1,7 +1,9 @@
 module Markleft
   BoldNode: untyped
+  HeadingNode: untyped
   ItalicsNode: untyped
   NewlineNode: untyped
+  StrikethroughNode: untyped
   TextNode: untyped
   Token: untyped
   VERSION: String
@@ -10,7 +12,7 @@ module Markleft
   @node_tree: untyped
 
   def self.list_md_files: -> Array[String]
-  def self.select_md_file: (Array[String]) -> String
+  def self.select_md_file: (Array[String]) -> (String | Array[String])
   def self.process_file: (String) -> String
   def self.save_html: (String, String) -> String
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markleft
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - greeenboi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-11 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies: []
 description: MarkLeft is a powerful and flexible tool designed to extend the capabilities
   of traditional Markdown-to-HTML compilers. It introduces additional syntax and features