tty-markdown 0.6.0 → 0.7.1

data/lib/tty/markdown/kramdown_ext.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "kramdown/parser/kramdown"
+
+module Kramdown
+  module Parser
+    class KramdownExt < Kramdown::Parser::Kramdown
+      def initialize(source, options)
+        super
+
+        { codeblock_fenced: :codeblock_fenced_ext }.each do |current, replacement|
+          @block_parsers[@block_parsers.index(current)] = replacement
+        end
+      end
+
+      FENCED_CODEBLOCK_START = /^[ ]{0,3}[~`]{3,}/.freeze
+      FENCED_CODEBLOCK_MATCH = /^[ ]{0,3}(([~`]){3,})\s*?((\S+?)(?:\?\S*)?)?\s*?\n(.*?)^[ ]{0,3}\1\2*\s*?\n/m.freeze
+
+      define_parser(:codeblock_fenced_ext, FENCED_CODEBLOCK_START, nil,
+                    "parse_codeblock_fenced")
+    end # KramdownExt
+  end # Parser
+end # TTY

data/lib/tty/markdown/syntax_highlighter.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'pastel'
-require 'rouge'
-require 'tty-color'
+require "pastel"
+require "rouge"
 
 module TTY
   module Markdown
@@ -32,33 +31,38 @@ module TTY
       #
       # @api private
       def guess_lang(code)
-        lang = nil
         start_line = code.lines[0]
         if available_lexers.include?(start_line.strip.downcase)
-          lang = start_line.strip.downcase
+          start_line.strip.downcase
         end
       end
       module_function :guess_lang
 
       # Highlight code snippet
       #
+      # @param [String] code
+      # @param [Integer] mode
+      #   the color mode supported by the terminal
+      # @param [String] lang
+      #   the code snippet language
+      # @param [Boolean] enabled
+      #   whether or not coloring is enabled
+      # @param [Proc] color
+      #   the fallback coloring
+      #
       # @api public
-      def highlight(code, **options)
-        lang = guess_lang(code)
-        mode = options[:mode] || TTY::Color.mode
-        lines = code.dup.lines
-        if options[:fenced].nil?
-          code = lines[1...-1].join + lines[-1].strip
-        end
-
+      def highlight(code, mode: 256, lang: nil, enabled: nil,
+                    color: ->(line) { line })
+        lang = guess_lang(code) if lang.nil?
         lexer = Rouge::Lexer.find_fancy(lang, code) || Rouge::Lexers::PlainText
 
-        if mode >= 256
+        if enabled == false
+          code
+        elsif 256 <= mode
           formatter = Rouge::Formatters::Terminal256.new
           formatter.format(lexer.lex(code))
         else
-          pastel = Pastel.new
-          code.split("\n").map { |line| pastel.yellow(line) }.join("\n")
+          code.lines.map { |line| color.(line.chomp) }.join("\n")
         end
       end
       module_function :highlight

data/lib/tty/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Markdown
-    VERSION = '0.6.0'
+    VERSION = "0.7.1"
   end # TTY
 end # Markdown

data/lib/tty/markdown.rb

@@ -1,114 +1,236 @@
 # frozen_string_literal: true
 
-require 'kramdown'
+require "kramdown/document"
+require "tty-color"
+require "tty-screen"
 
-require_relative 'markdown/parser'
-require_relative 'markdown/version'
+require_relative "markdown/converter"
+require_relative "markdown/version"
+require_relative "markdown/kramdown_ext"
 
 module TTY
+  # Responsible for converting Markdown to the terminal output
+  #
+  # @api public
   module Markdown
     SYMBOLS = {
-      arrow: '»',
-      bullet: '●',
-      bar: '┃',
-      diamond: '◈',
-      pipe: '│',
-      line: '─',
-      hellip: '…',
-      laquo: '«',
-      laquo_space: '« ',
-      raquo: '»',
-      raquo_space: ' »',
-      ndash: '-',
+      arrow: "»",
+      bullet: "●",
+      bar: "┃",
+      diamond: "◈",
+      pipe: "│",
+      line: "─",
+      hellip: "…",
+      laquo: "«",
+      laquo_space: "« ",
+      raquo: "»",
+      raquo_space: " »",
+      ndash: "-",
       mdash: "\u2014",
-      lsquo: '‘',
-      rsquo: '’',
-      ldquo: '“',
-      rdquo: '”',
-      top_left: '┌',
-      top_right: '┐',
-      top_center: '┬',
-      mid_left: '├',
-      mid_right: '┤',
-      mid_center: '┼',
-      bottom_right: '┘',
-      bottom_left: '└',
-      bottom_center: '┴',
+      lsquo: "‘",
+      rsquo: "’",
+      ldquo: "“",
+      rdquo: "”",
+      top_left: "┌",
+      top_right: "┐",
+      top_center: "┬",
+      mid_left: "├",
+      mid_right: "┤",
+      mid_center: "┼",
+      bottom_right: "┘",
+      bottom_left: "└",
+      bottom_center: "┴",
+      paren_left: "(",
+      paren_right: ")",
+      bracket_left: "[",
+      bracket_right: "]",
+      hash: "#",
+      delete: "\u0336"
     }.freeze
 
-    WIN_SYMBOLS = {
-      arrow: '->',
-      bullet: '*',
-      diamond: '*',
-      bar: '│',
-      pipe: '|',
-      line: '─',
-      hellip: '...',
-      laquo: '<<',
-      laquo_space: '<< ',
-      raquo: '>>',
-      raquo_space: ' >>',
-      ndash: '-',
+    ASCII_SYMBOLS = {
+      arrow: "->",
+      bullet: "*",
+      diamond: "*",
+      bar: "│",
+      pipe: "|",
+      line: "-",
+      hellip: "...",
+      laquo: "<<",
+      laquo_space: "<< ",
+      raquo: ">>",
+      raquo_space: " >>",
+      ndash: "-",
       mdash: "--",
-      lsquo: ''',
-      rsquo: ''',
-      ldquo: '"',
-      rdquo: '"',
-      top_left: '+',
-      top_right: '+',
-      top_center: '+',
-      mid_left: '+',
-      mid_right: '+',
-      mid_center: '+',
-      bottom_right: '+',
-      bottom_left: '+',
-      bottom_center: '+'
+      lsquo: "\"",
+      rsquo: "\"",
+      ldquo: "\"",
+      rdquo: "\"",
+      top_left: "+",
+      top_right: "+",
+      top_center: "+",
+      mid_left: "+",
+      mid_right: "+",
+      mid_center: "+",
+      bottom_right: "+",
+      bottom_left: "+",
+      bottom_center: "+",
+      paren_left: "(",
+      paren_right: ")",
+      bracket_left: "[",
+      bracket_right: "]",
+      hash: "#",
+      delete: "\u0336"
     }.freeze
 
     THEME = {
       em: :yellow,
-      header: [:cyan, :bold],
+      header: %i[cyan bold],
       hr: :yellow,
-      link: [:yellow, :underline],
+      link: %i[yellow underline],
       list: :yellow,
-      strong: [:yellow, :bold],
+      strong: %i[yellow bold],
       table: :yellow,
       quote: :yellow,
+      image: :bright_black,
+      note: :yellow,
+      comment: :bright_black
     }.freeze
 
     # Parse a markdown string
     #
-    # @param [Hash] options
-    # @option options [String] :colors
-    #   a number of colors supported
-    # @option options [String] :width
+    # @example
+    #   TTY::Markdown.parse("# Header")
     #
     # @param [String] source
     #   the source with markdown
+    # @param [String, Symbol] color
+    #   the output coloring support out of always, auto or never
+    # @param [Integer] indent
+    #   the converted output indent
+    # @param [Integer] mode
+    #   the number of supported colors
+    # @param [Hash, String, Symbol, nil] symbols
+    #   the converted output symbols
+    # @param [Hash{Symbol => Array, String, Symbol}, nil] theme
+    #   the converted output color theme
+    # @param [Integer] width
+    #   the width at which to wrap content
+    # @param [Hash] doc_opts
+    #   the markdown document parser options
+    #
+    # @return [String]
+    #   the converted terminal output
     #
     # @api public
-    def parse(source, **options)
-      doc = Kramdown::Document.new(source, options)
-      Parser.convert(doc.root, doc.options).join
+    def parse(source,
+              color: :auto,
+              indent: 2,
+              mode: TTY::Color.mode,
+              symbols: {},
+              theme: {},
+              width: TTY::Screen.width,
+              **doc_opts)
+      converter_options = {
+        enabled: color_enabled(color),
+        indent: indent,
+        input: "KramdownExt",
+        mode: mode,
+        symbols: build_symbols(symbols),
+        theme: build_theme(theme),
+        width: width
+      }
+      doc = Kramdown::Document.new(source, converter_options.merge(doc_opts))
+      Converter.convert(doc.root, doc.options).join
     end
     module_function :parse
 
-    # Pase a markdown document
+    # Parse a markdown document
+    #
+    # @example
+    #   TTY::Markdown.parse_file("example.md")
+    #
+    # @param [String] path
+    #   the file path
+    # @param [Hash] options
+    #   the conversion options
+    #
+    # @return [String]
+    #   the converted terminal output
     #
     # @api public
     def parse_file(path, **options)
-      parse(::File.read(path), options)
+      parse(::File.read(path), **options)
     end
     module_function :parse_file
 
-    def symbols
-      @symbols ||= windows? ? WIN_SYMBOLS : SYMBOLS
+    # Convert color option to Pastel option
+    #
+    # @param [String, Symbol] color
+    #   the color option to convert
+    #
+    # @return [Boolean, nil]
+    #
+    # @api private
+    def color_enabled(color)
+      case color.to_s
+      when "always" then true
+      when "never"  then false
+      end
+    end
+    module_function :color_enabled
+    private_class_method :color_enabled
+
+    # Build symbols hash from the provided symbols option
+    #
+    # @param [Hash, String, Symbol, nil] symbols
+    #   the converted output symbols
+    #
+    # @return [Hash{Symbol => String}]
+    #
+    # @api private
+    def build_symbols(symbols)
+      case symbols
+      when String, Symbol
+        select_symbols(symbols)
+      when Hash
+        base_symbols = select_symbols(symbols[:base])
+        base_symbols.merge(symbols[:override].to_h)
+      else
+        SYMBOLS
+      end
     end
-    module_function :symbols
+    module_function :build_symbols
+    private_class_method :build_symbols
 
-    def windows?
-      ::File::ALT_SEPARATOR == "\\"
+    # Select between ASCII or Unicode symbols
+    #
+    # @param [String, Symbol, nil] name
+    #   the symbols name
+    #
+    # @return [Hash{Symbol => String}]
+    #
+    # @api private
+    def select_symbols(name)
+      name.to_s == "ascii" ? ASCII_SYMBOLS : SYMBOLS
+    end
+    module_function :select_symbols
+    private_class_method :select_symbols
+
+    # Build theme hash from the provided theme option
+    #
+    # @param [Hash{Symbol => Array, String, Symbol}, nil] theme
+    #   the converted output theme
+    #
+    # @return [Hash{Symbol => Array<Symbol>}]
+    #
+    # @api private
+    def build_theme(theme)
+      THEME.merge(theme.to_h) do |*, new_style|
+        Array(new_style).map(&:to_sym)
+      end
     end
-    module_function :windows?
+    module_function :build_theme
+    private_class_method :build_theme
   end # Markdown
 end # TTY

data/lib/tty-markdown.rb

@@ -1 +1 @@
-require_relative 'tty/markdown'
+require_relative "tty/markdown"

metadata

@@ -1,113 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: tty-markdown
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-03-30 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: tty-color
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,54 +129,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Convert a markdown text or document into a terminal friendly output.
-email: []
+email:
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- assets/headers.png
-- assets/hr.png
-- assets/link.png
-- assets/list.png
-- assets/quote.png
-- assets/syntax_highlight.png
-- assets/table.png
-- bin/console
-- bin/setup
-- examples/man.rb
-- examples/marked.rb
 - lib/tty-markdown.rb
 - lib/tty/markdown.rb
-- lib/tty/markdown/parser.rb
+- lib/tty/markdown/converter.rb
+- lib/tty/markdown/kramdown_ext.rb
 - lib/tty/markdown/syntax_highlighter.rb
 - lib/tty/markdown/version.rb
-- spec/spec_helper.rb
-- spec/unit/parse/abbrev_spec.rb
-- spec/unit/parse/blockquote_spec.rb
-- spec/unit/parse/codeblock_spec.rb
-- spec/unit/parse/comment_spec.rb
-- spec/unit/parse/emphasis_spec.rb
-- spec/unit/parse/entity_spec.rb
-- spec/unit/parse/header_spec.rb
-- spec/unit/parse/hr_spec.rb
-- spec/unit/parse/link_spec.rb
-- spec/unit/parse/list_spec.rb
-- spec/unit/parse/math_spec.rb
-- spec/unit/parse/paragraph_spec.rb
-- spec/unit/parse/table_spec.rb
-- spec/unit/parse/typography_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-markdown/issues
+  changelog_uri: https://github.com/piotrmurach/tty-markdown/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-markdown
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-markdown
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,8 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Convert a markdown text or document into a terminal friendly output.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/markdown"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here