protos-markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d4499ceae5e6f824d04bd43384a5b59ff7b45c0b452064147e92c80e399b0a8
+  data.tar.gz: 9682d3c772d9693dc3fbd4cb0d1906c9c8e70333f584139a680cb214daf15d84
+SHA512:
+  metadata.gz: 1a671f9021664a20db7495331fa99e711d9adbb02c9cea2c833b1806517c7f56a3a4662c5b16d2ef2d04e8ba4263f2cc1815f3cb36881ec37a3f5e00cba9822e
+  data.tar.gz: ac9acd00942037b64467b160adc04336672d8f428edb1848fad1870132972497ec8de967b8fef180bafb476ce4a6ef7a07c667cf58944e78e8c49de1c506ebd9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-inhouse
+
+inherit_gem:
+  rubocop-inhouse:
+    - config/default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+
+Naming/FileName:
+  Exclude:
+    - lib/protos-markdown.rb

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-03
+
+- Initial release
+- Adds markdown parsing through AST generated by Markly
+- Adds support for tables

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nolan J Tait
+
+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,83 @@
+# Protos Markdown
+
+Markdown component built with [Protos](https://github.com/inhouse-work/protos).
+
+This is a fork of [phlex-markdown](https://github.com/phlex-ruby/phlex-markdown).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add protos-markdown
+
+If bundler is not being used to manage dependencies, install the gem by
+executing:
+
+    $ gem install protos-markdown
+
+## Usage
+
+This library lets you define your own component and override elements, including
+using the standard protos conventions:
+
+```ruby
+class Markdown < Protos::Markdown
+  def h1 = super(class: css[:title])
+  def ul = super(class: "ml-4 pt-2")
+
+  private
+
+  def theme
+    {
+      title: "font-bold text-xl"
+    }
+  end
+end
+```
+
+Rendering the component outputs our custom css:
+
+```ruby
+content = <<~MD
+  # Hello World
+
+  - A
+  - B
+  - C
+MD
+
+output = Markdown.new(content).call
+```
+
+Which outputs the following html:
+
+```html
+<h1 class="font-bold text-xl">Hello World</h1>
+<ul class="ml-4 pt-2">
+  <li>A</li>
+  <li>B</li>
+  <li>C</li>
+</ul>
+```
+
+## 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/inhouse-work/protos-markdown.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/SECURITY.md

@@ -0,0 +1,6 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you found a possible security vulnerability in `protos-markdown`, please email
+nolanjtait@gmail.com

data/lib/protos/markdown/ast.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Protos
+  class Markdown < ::Protos::Component
+    class AST
+      class Node < SimpleDelegator
+        def accept(visitor)
+          visitor.send(:"visit_#{type}", self)
+        end
+
+        def each(&block)
+          return enum_for(:each) unless block
+
+          super do |child|
+            yield Node.new(child)
+          end
+        end
+      end
+
+      def self.parse(content)
+        Markly
+          .parse(content, flags: Markly::GITHUB_PRE_LANG, extensions: [:table])
+          .then { |node| new(Node.new(node)) }
+      end
+
+      def initialize(root)
+        @root = root
+      end
+
+      def accept(visitor)
+        @root.each do |node|
+          Node.new(node).accept(visitor)
+        end
+      end
+    end
+  end
+end

data/lib/protos/markdown/table.rb

@@ -0,0 +1,55 @@
+module Protos
+  class Markdown
+    class Table < Protos::Table
+      option :inside_header, default: -> { false }, reader: false
+
+      def visit_table(node)
+        visit_children(node)
+      end
+
+      def visit_table_header(node)
+        @inside_header = true
+
+        header do
+          visit_children(node)
+        end
+      end
+
+      def visit_table_cell(node)
+        if @inside_header
+          head { visit_children(node) }
+        else
+          cell { visit_children(node) }
+        end
+      end
+
+      def visit_text(node)
+        plain(node.string_content)
+      end
+
+      def visit_table_row(node)
+        @inside_header = false
+
+        row do
+          visit_children(node)
+        end
+      end
+
+      def visit_code(node)
+        code { node.string_content }
+      end
+
+      def visit_strong(node)
+        strong { visit_children(node) }
+      end
+
+      private
+
+      def visit_children(node)
+        node.each do |child|
+          child.accept(self)
+        end
+      end
+    end
+  end
+end

data/lib/protos/markdown.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "protos"
+require "markly"
+require "rouge"
+require "delegate"
+
+require_relative "markdown/ast"
+require_relative "markdown/table"
+
+module Protos
+  class Markdown < ::Protos::Component # rubocop:disable Metrics/ClassLength
+    param :content, reader: false
+    option :sanitize, default: -> { true }, reader: false
+
+    def view_template
+      return unless root
+
+      root.accept(self)
+    end
+
+    def visit_document(_node)
+      # Do nothing
+    end
+
+    def visit_table(node)
+      render Markdown::Table.new do |table|
+        node.accept(table)
+      end
+    end
+
+    def visit_softbreak(_node)
+      whitespace
+    end
+
+    def visit_text(node)
+      plain(node.string_content)
+    end
+
+    def visit_header(node)
+      case node.header_level
+      in 1 then h1 { visit_children(node) }
+      in 2 then h2 { visit_children(node) }
+      in 3 then h3 { visit_children(node) }
+      in 4 then h4 { visit_children(node) }
+      in 5 then h5 { visit_children(node) }
+      in 6 then h6 { visit_children(node) }
+      end
+    end
+
+    def visit_paragraph(node)
+      grandparent = node.parent&.parent
+
+      if grandparent&.type == :list && grandparent&.list_tight
+        visit_children(node)
+      else
+        p { visit_children(node) }
+      end
+    end
+
+    def visit_link(node)
+      a(href: node.url, title: node.title) { visit_children(node) }
+    end
+
+    def visit_image(node)
+      img(
+        src: node.url,
+        alt: node.each.first.string_content,
+        title: node.title
+      )
+    end
+
+    def visit_emph(node)
+      em { visit_children(node) }
+    end
+
+    def visit_strong(node)
+      strong { visit_children(node) }
+    end
+
+    def visit_list(node)
+      case node.list_type
+      when :ordered_list then ol { visit_children(node) }
+      when :bullet_list then ul { visit_children(node) }
+      end
+    end
+
+    def visit_list_item(node)
+      li { visit_children(node) }
+    end
+
+    def visit_code(node)
+      inline_code do |**attributes|
+        code(**attributes) { plain(node.string_content) }
+      end
+    end
+
+    def visit_code_block(node)
+      code_block(node.string_content, node.fence_info) do |**attributes|
+        pre(**attributes) do
+          code(class: "highlight language-#{node.fence_info}") do
+            unsafe_raw lex(node.string_content, node.fence_info)
+          end
+        end
+      end
+    end
+
+    def visit_hrule(_node)
+      hr
+    end
+
+    def visit_blockquote(node)
+      blockquote { visit_children(node) }
+    end
+
+    def visit_html(node)
+      return if @sanitize
+
+      unsafe_raw(node.string_content)
+    end
+
+    def visit_inline_html(node)
+      return if @sanitize
+
+      unsafe_raw(node.string_content)
+    end
+
+    private
+
+    def root
+      AST.parse(@content)
+    end
+
+    def formatter
+      @formatter ||= Rouge::Formatters::HTML.new
+    end
+
+    def lex(source, language)
+      lexer = Rouge::Lexer.find(language)
+      return source if lexer.nil?
+
+      formatter.format(lexer.lex(source))
+    end
+
+    def inline_code(**attributes)
+      yield(**attributes)
+    end
+
+    def code_block(code, language, **attributes) # rubocop:disable Lint/UnusedMethodArgument, Metrics/ParameterLists
+      yield(**attributes)
+    end
+
+    def visit_children(node)
+      node.each { |child| child.accept(self) }
+    end
+  end
+end

data/lib/protos-markdown.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "protos/markdown"

data/protos-markdown.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "protos-markdown"
+  spec.version = "0.1.0"
+  spec.authors = ["Nolan Tait"]
+  spec.email = ["nolanjtait@gmail.com"]
+
+  spec.summary = "A markdown renderer with Phlex and Protos"
+  spec.description = "A markdown renderer with Phlex and Protos"
+  spec.homepage = "https://github.com/inhouse-work/protos-markdown"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata["funding_uri"] = spec.homepage
+
+  # 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|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "markly", "~> 0.7"
+  spec.add_dependency "protos", ">= 0.4"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: protos-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nolan Tait
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: markly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: protos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: A markdown renderer with Phlex and Protos
+email:
+- nolanjtait@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- SECURITY.md
+- lib/protos-markdown.rb
+- lib/protos/markdown.rb
+- lib/protos/markdown/ast.rb
+- lib/protos/markdown/table.rb
+- protos-markdown.gemspec
+homepage: https://github.com/inhouse-work/protos-markdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/inhouse-work/protos-markdown
+  source_code_uri: https://github.com/inhouse-work/protos-markdown
+  changelog_uri: https://github.com/inhouse-work/protos-markdown
+  funding_uri: https://github.com/inhouse-work/protos-markdown
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: A markdown renderer with Phlex and Protos
+test_files: []