markleft 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7629bbb0deff5bdeb11894c8c2dc3a4a55c697cbf3af8402d38d093d5ce2ea75
+  data.tar.gz: e2318355783b9919af483419b660119c7d8e44516f20464e5a41eae4747591a7
+SHA512:
+  metadata.gz: 6acfcf5631696853f694d2efff3e566cf5a00ad8451b29e856c48326bd47b667114dc6191ff307ab0c6b5623f40a71804240d9e3509db79d37eec07b041f0797
+  data.tar.gz: edff09e17f9b2be7501363e247594c34d50f70e2a0dc5ef703690fc20aeac166e343787093fc260bcbcbb485d178a84cbeeaf4108c434d3ca9bdd3a2752761b8

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/markleft.iml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <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="parallel (v1.26.3, 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="ruby-progressbar (v1.13.0, ruby-3.2.4-p170) [gem]" level="application" />
+  </component>
+</module>

data/.idea/material_theme_project_new.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MaterialThemeProjectNewConfig">
+    <option name="metadata">
+      <MTProjectMetadataState>
+        <option name="migrated" value="true" />
+        <option name="pristineConfig" value="false" />
+        <option name="userId" value="1c3d9eb4:1904b29008d:-7ffe" />
+      </MTProjectMetadataState>
+    </option>
+  </component>
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/markleft.iml" filepath="$PROJECT_DIR$/.idea/markleft.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 greeenboi
+
+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,91 @@
+# MarkLeft: A Superset to Markdown-to-HTML Compilers
+
+![image](https://github.com/user-attachments/assets/b73b1753-8b48-4036-a0e3-8b1fba47d223)
+
+
+## Overview
+
+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
+
+- `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.
+
+## Prerequisites
+
+- Ruby >~ 3.2.4
+- Bundler =2.6.3
+
+## Installation
+
+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
+   ```
+
+2. Install the dependencies:
+   ```sh
+   bundle install
+   ```
+
+## Running the Converter
+
+### Using `markleft-main.rb`
+
+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 markleft-main.rb
+   ```
+
+2. Enter the name of the Markdown file when prompted.
+
+### Using `terminal.rb` (TUI)
+
+The `terminal.rb` file provides a Text User Interface (TUI) for selecting and processing Markdown files.
+
+1. Run the script:
+   ```sh
+   ruby terminal.rb
+   ```
+
+2. Follow the prompts to select a Markdown file and process it.
+
+
+
+## Example
+
+Given a sample Markdown file `sample.md`:
+
+```markdown
+This is a sample *Markdown* file
+**bold** yippee!
+```
+
+## Contributing
+
+We welcome contributions to enhance MarkLeft. Please fork the repository and submit pull requests with your improvements.
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+## Contact
+
+For any questions or feedback, please contact [contact@suvangs.tech](mailto:contact@suvangs.tech).
+
+---

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/markleft_task"
+
+Minitest::MarkleftTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/markleft

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "markleft"

data/lib/markleft/version.rb

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

data/lib/markleft.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "cli/ui"
+require "fileutils"
+require_relative "markleft/version"
+
+module Markleft
+  # ----------------- Tokenizer Module ----------------- #
+  class Tokenizer
+    TOKEN_TYPES = [
+      [:bold, /((?<!\s)\*\*(?!\s)(?:[^*]+?|(?:[^*]*(?:(?:\*[^*]*){2})+?)+?)(?<!\s)\*\*)/],
+      [:italics, /((?<!\s)\*(?!\s)(?:(?:[^**]*(?:(?:\*\*[^**]*){2})+?)+?|[^**]+?)(?<!\s)\*)/],
+      [:newline, /(\r\n|\r|\n)/],
+      [:text, /[^*\n\r]+/]
+    ].freeze
+
+    def initialize(markleft)
+      @code = markleft
+    end
+
+    def tokenize
+      tokens = []
+      until @code.empty?
+        tokens << tokenize_one_token
+        @code = @code.strip
+      end
+      tokens
+    end
+
+    def tokenize_one_token
+      TOKEN_TYPES.each do |type, re|
+        re = /\A(#{re})/
+        next unless @code =~ re
+
+        value = ::Regexp.last_match(1)
+        @code = @code[value.length..]
+        return Token.new(type, value)
+      end
+      raise "Unexpected character #{@code.inspect}"
+    end
+  end
+
+  # ----------------- Parser Module ----------------- #
+
+  class Parser
+    def initialize(tokens)
+      @tokens = tokens
+    end
+
+    def parse
+      nodes = []
+      nodes << parse_node until @tokens.empty?
+      nodes
+    end
+
+    def parse_node
+      case @tokens.first.type
+      when :bold
+        parse_bold
+      when :italics
+        parse_italics
+      when :newline
+        parse_newline
+      when :text
+        parse_text
+      else
+        raise "Unexpected token type: #{@tokens.first.type}"
+      end
+    end
+
+    def parse_bold
+      value = consume(:bold).value
+      BoldNode.new(value)
+    end
+
+    def parse_italics
+      value = consume(:italics).value
+      ItalicsNode.new(value)
+    end
+
+    def parse_newline
+      consume(:newline)
+      NewlineNode.new
+    end
+
+    def parse_text
+      value = consume(:text).value
+      TextNode.new(value)
+    end
+
+    def consume(expected_type)
+      token = @tokens.shift
+      unless token.type == expected_type
+        raise "Expected token type #{expected_type.inspect} but got #{token.type.inspect}"
+      end
+
+      token
+    end
+  end
+
+  # ----------------- Code Generator Module ----------------- #
+
+  class Generator
+    def generate(node)
+      case node
+      when BoldNode
+        generate_bold(node)
+      when ItalicsNode
+        generate_italics(node)
+      when NewlineNode
+        generate_newline(node)
+      when TextNode
+        generate_text(node)
+      else
+        raise "Unexpected node type: #{node.class}"
+      end
+    end
+
+    def generate_bold(node)
+      "<b>#{node.value}</b>"
+    end
+
+    def generate_italics(node)
+      "<i>#{node.value}</i>"
+    end
+
+    def generate_newline(_node)
+      "<br>"
+    end
+
+    def generate_text(node)
+      node.value
+    end
+
+    def generate_all(nodes)
+      nodes.map { |node| generate(node) }.join
+    end
+  end
+
+  # ----------------- Error handler ----------------- #
+  class Error < StandardError; end
+  # ----------------- Nodes ----------------- #
+
+  Token = Struct.new(:type, :value)
+  BoldNode = Struct.new(:value)
+  ItalicsNode = Struct.new(:value)
+  NewlineNode = Struct.new(:value)
+  TextNode = Struct.new(:value)
+
+  # ----------------- Main Block ----------------- #
+
+  CLI::UI::StdoutRouter.enable
+
+  def self.list_md_files
+    Dir.glob("*.md")
+  end
+
+  def self.select_md_file(files)
+    CLI::UI::Prompt.ask("Select a markdown file to process:") do |handler|
+      files.each do |file|
+        handler.option(file) { file }
+      end
+    end
+  end
+
+  def self.process_file(file_name)
+    myfile = File.read(file_name)
+    html_content = nil
+
+    CLI::UI::SpinGroup.new do |spin_group|
+      spin_group.add("Tokenizing") do |spinner|
+        tokenizer = Tokenizer.new(myfile)
+        @tokens = tokenizer.tokenize
+        spinner.update_title("Tokenizing complete")
+      end
+
+      spin_group.add("Parsing") do |spinner|
+        parser = Parser.new(@tokens)
+        @node_tree = parser.parse
+        spinner.update_title("Parsing complete")
+      end
+
+      spin_group.add("Generating HTML") do |spinner|
+        generator = Generator.new.generate_all(@node_tree)
+        html_content = generator
+        spinner.update_title("HTML generation complete")
+      end
+    end.wait
+
+    html_content
+  end
+
+  def self.save_html(file_name, content)
+    html_file_name = file_name.sub(/\.md$/, ".html")
+    File.write(html_file_name, content)
+    html_file_name
+  end
+
+  CLI::UI::Frame.open("Markdown to HTML Converter") do
+    files = list_md_files
+    if files.empty?
+      puts "No markdown files found in the current directory."
+    else
+      selected_file = select_md_file(files)
+      puts "Processing file: #{selected_file}"
+      html_content = process_file(selected_file)
+      puts "Generated HTML content:"
+      puts html_content
+      saved_file = save_html(selected_file, html_content)
+      puts "HTML content saved to: #{saved_file}"
+    end
+  end
+end

data/sample.html

@@ -0,0 +1 @@
+This is a sample <i>*Markdown*</i>file \n<b>**bold**</b>yippee!

data/sample.md

@@ -0,0 +1,2 @@
+This is a sample *Markdown* file \n
+**bold** yippee!

data/sig/markleft/generator.rbs

@@ -0,0 +1,10 @@
+module Markleft
+  class Generator
+    def generate: (untyped) -> String
+    def generate_all: (Array[untyped]) -> String
+    def generate_bold: (untyped) -> String
+    def generate_italics: (untyped) -> String
+    def generate_newline: (untyped) -> String
+    def generate_text: (untyped) -> String
+  end
+end

data/sig/markleft/parser.rbs

@@ -0,0 +1,14 @@
+module Markleft
+  class Parser
+    @tokens: Array[untyped]
+
+    def initialize: (Array[untyped]) -> void
+    def consume: (Symbol) -> untyped
+    def parse: -> Array[untyped]
+    def parse_bold: -> untyped
+    def parse_italics: -> untyped
+    def parse_newline: -> untyped
+    def parse_node: -> untyped
+    def parse_text: -> untyped
+  end
+end

data/sig/markleft/tokenizer.rbs

@@ -0,0 +1,12 @@
+module Markleft
+
+  class Tokenizer
+    TOKEN_TYPES: Array[[Symbol, Regexp]]
+
+    @code: String
+
+    def initialize: (String) -> void
+    def tokenize: -> Array[untyped]
+    def tokenize_one_token: -> untyped
+  end
+end

data/sig/markleft.rbs

@@ -0,0 +1,16 @@
+module Markleft
+  BoldNode: untyped
+  ItalicsNode: untyped
+  NewlineNode: untyped
+  TextNode: untyped
+  Token: untyped
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  @tokens: untyped
+  @node_tree: untyped
+
+  def self.list_md_files: -> Array[String]
+  def self.select_md_file: (Array[String]) -> String
+  def self.process_file: (String) -> String
+  def self.save_html: (String, String) -> String
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: markleft
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- greeenboi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-11 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
+  to enhance the expressiveness and functionality of Markdown documents.
+email:
+- suvan.gowrishanker.204@gmail.com
+executables:
+- markleft
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/markleft.iml"
+- ".idea/material_theme_project_new.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/markleft
+- lib/markleft.rb
+- lib/markleft/version.rb
+- sample.html
+- sample.md
+- sig/markleft.rbs
+- sig/markleft/generator.rbs
+- sig/markleft/parser.rbs
+- sig/markleft/tokenizer.rbs
+homepage: https://github.com/greeenboi/markdown-superset-compiler/tree/master
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/greeenboi/markdown-superset-compiler/tree/master
+  github_repo: ssh://github.com/greeenboi/markdown-superset-compiler
+  source_code_uri: https://github.com/greeenboi/markdown-superset-compiler/tree/master
+  changelog_uri: https://github.com/greeenboi/markdown-superset-compiler/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: TUI built on ruby to compile gh-flavor and more markdown to html for the
+  web to render
+test_files: []