tty-markdown-meinac 0.7.2

data/lib/tty/markdown/theme.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+module TTY
+  class Markdown
+    # Responsible for storing the theme configuration
+    #
+    # @api private
+    class Theme
+      # The element to style hash
+      #
+      # @return [Hash{Symbol => Array<Symbol>}]
+      #
+      # @api private
+      ELEMENT_TO_STYLE = {
+        code: %i[yellow],
+        comment: %i[bright_black],
+        delete: %i[red],
+        em: %i[yellow],
+        h1: %i[cyan bold underline],
+        h2: %i[cyan bold],
+        h3: %i[cyan bold],
+        h4: %i[cyan bold],
+        h5: %i[cyan bold],
+        h6: %i[cyan bold],
+        hr: %i[yellow],
+        image: %i[bright_black],
+        link: %i[yellow underline],
+        list: %i[yellow],
+        note: %i[yellow],
+        quote: %i[yellow],
+        strong: %i[yellow bold],
+        table: %i[yellow]
+      }.freeze
+      private_constant :ELEMENT_TO_STYLE
+
+      # Create a {TTY::Markdown::Theme} instance
+      #
+      # @example
+      #   theme = TTY::Markdown::Theme.from({comment: :blue})
+      #
+      # @example
+      #   theme = TTY::Markdown::Theme.from({comment: %i[blue underline]})
+      #
+      # @param [Hash{Symbol => Array<String, Symbol>, String, Symbol}] theme
+      #   the theme configuration
+      #
+      # @return [TTY::Markdown::Theme]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the theme value is invalid
+      #
+      # @api public
+      def self.from(theme)
+        new(validate_names(build_theme(theme)))
+      end
+
+      # Build the theme hash
+      #
+      # @param [Hash{Symbol => Array<String, Symbol>, String, Symbol}] theme
+      #   the theme configuration
+      #
+      # @return [Hash{Symbol => Array<Symbol>}]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the theme value is invalid
+      #
+      # @api private
+      def self.build_theme(theme)
+        raise_value_error(theme) unless theme.respond_to?(:to_h)
+
+        ELEMENT_TO_STYLE.merge(theme.to_h) do |*, new_style|
+          Array(new_style).map(&:to_sym)
+        end
+      end
+      private_class_method :build_theme
+
+      # Validate the elements names
+      #
+      # @param [Hash{Symbol => Array<Symbol>}] value
+      #   the theme value
+      #
+      # @return [Hash{Symbol => Array<Symbol>}]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the element name is invalid
+      #
+      # @api private
+      def self.validate_names(value)
+        unknown_names = value.keys - ELEMENT_TO_STYLE.keys
+        return value if unknown_names.empty?
+
+        raise_name_error(*unknown_names)
+      end
+      private_class_method :validate_names
+
+      # Raise the theme value error
+      #
+      # @param [Object] value
+      #   the theme value
+      #
+      # @return [void]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the theme value is invalid
+      #
+      # @api private
+      def self.raise_value_error(value)
+        raise Error, "invalid theme: #{value.inspect}. " \
+                     "Use the hash with the element name and style."
+      end
+      private_class_method :raise_value_error
+
+      # Raise the element name error
+      #
+      # @param [Array<Symbol>] names
+      #   the elements names
+      #
+      # @return [void]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the element name is invalid
+      #
+      # @api private
+      def self.raise_name_error(*names)
+        raise Error, "invalid theme element name#{"s" if names.size > 1}: " \
+                     "#{names.map(&:inspect).join(", ")}."
+      end
+      private_class_method :raise_name_error
+
+      # Create a {TTY::Markdown::Theme} instance
+      #
+      # @param [Hash{Symbol => Array<Symbol>}] theme
+      #   the theme configuration
+      #
+      # @api private
+      def initialize(theme)
+        @theme = theme
+      end
+      private_class_method :new
+
+      # Fetch styles by element name
+      #
+      # @example
+      #   theme[:comment]
+      #
+      # @param [Symbol] name
+      #   the element name
+      #
+      # @return [Array<Symbol>]
+      #
+      # @api public
+      def [](name)
+        @theme[name]
+      end
+    end # Theme
+  end # Markdown
+end # TTY

data/lib/tty/markdown/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TTY
+  class Markdown
+    VERSION = "0.7.2"
+  end # TTY
+end # Markdown

data/lib/tty/markdown.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require "kramdown/document"
+require "tty-color"
+require "tty-screen"
+
+require_relative "markdown/color"
+require_relative "markdown/converter"
+require_relative "markdown/parser"
+require_relative "markdown/symbols"
+require_relative "markdown/theme"
+require_relative "markdown/version"
+
+module TTY
+  # Responsible for converting Markdown to the terminal output
+  #
+  # @api public
+  class Markdown
+    # The input parser name
+    #
+    # @return [String]
+    #
+    # @api private
+    INPUT_PARSER = "TTYMarkdown"
+    private_constant :INPUT_PARSER
+
+    # Parse Markdown content
+    #
+    # @example
+    #   TTY::Markdown.parse("# TTY Toolkit")
+    #
+    # @example
+    #   TTY::Markdown.parse("# TTY Toolkit", mode: 16)
+    #
+    # @param [String] content
+    #   the Markdown content
+    # @param [Hash] options
+    #   the conversion options
+    #
+    # @return [String]
+    #   the converted terminal output
+    #
+    # @raise [TTY::Markdown::Error]
+    #   when the option value is invalid
+    #
+    # @see #initialize
+    #
+    # @api public
+    def self.parse(content, **options)
+      new(**options).parse(content)
+    end
+
+    # Parse a Markdown file
+    #
+    # @example
+    #   TTY::Markdown.parse_file("example.md")
+    #
+    # @example
+    #   TTY::Markdown.parse_file("example.md", mode: 16)
+    #
+    # @param [String] path
+    #   the Markdown file path
+    # @param [Hash] options
+    #   the conversion options
+    #
+    # @return [String]
+    #   the converted terminal output
+    #
+    # @raise [TTY::Markdown::Error]
+    #   when the option value is invalid
+    #
+    # @see #initialize
+    #
+    # @api public
+    def self.parse_file(path, **options)
+      new(**options).parse_file(path)
+    end
+
+    # Create a {TTY::Markdown} instance
+    #
+    # @example
+    #   tty_markdown = TTY::Markdown.new
+    #
+    # @example
+    #   tty_markdown = TTY::Markdown.new(mode: 16)
+    #
+    # @example
+    #   tty_markdown = TTY::Markdown.new(symbols: :ascii)
+    #
+    # @example
+    #   tty_markdown = TTY::Markdown.new(theme: {link: :blue})
+    #
+    # @param [String, Symbol] color
+    #   the color support out of always, auto or never
+    # @param [Integer] indent
+    #   the output indent
+    # @param [Integer] mode
+    #   the color mode
+    # @param [Hash, String, Symbol, nil] symbols
+    #   the output symbols
+    # @param [Hash{Symbol => Array, String, Symbol}, nil] theme
+    #   the color theme
+    # @param [Integer] width
+    #   the maximum width
+    # @param [Hash] document_options
+    #   the document parser options
+    #
+    # @raise [TTY::Markdown::Error]
+    #   when the option value is invalid
+    #
+    # @api public
+    def initialize(
+      color: :auto,
+      indent: 2,
+      mode: TTY::Color.mode,
+      symbols: {},
+      theme: {},
+      width: TTY::Screen.width,
+      **document_options
+    )
+      @converter_options = {
+        enabled: Color.new(color).to_enabled,
+        indent: indent,
+        input: INPUT_PARSER,
+        mode: mode,
+        symbols: Symbols.from(symbols),
+        theme: Theme.from(theme),
+        width: width
+      }.merge(document_options)
+    end
+
+    # Parse Markdown content
+    #
+    # @example
+    #   tty_markdown.parse("# TTY Toolkit")
+    #
+    # @param [String] content
+    #   the Markdown content
+    #
+    # @return [String]
+    #   the converted terminal output
+    #
+    # @api public
+    def parse(content)
+      document = Kramdown::Document.new(content, @converter_options)
+      Converter.convert(document.root, document.options).join
+    end
+
+    # Parse a Markdown file
+    #
+    # @example
+    #   tty_markdown.parse_file("example.md")
+    #
+    # @param [String] path
+    #   the Markdown file path
+    #
+    # @return [String]
+    #   the converted terminal output
+    #
+    # @api public
+    def parse_file(path)
+      parse(::File.read(path))
+    end
+  end # Markdown
+end # TTY

data/lib/tty-markdown.rb

@@ -0,0 +1 @@
+require_relative "tty/markdown"

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: tty-markdown-meinac
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+platform: ruby
+authors:
+- Piotr Murach
+- Mehmet Emin INAC
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: tty-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Convert a Markdown text or document into a terminal friendly output.
+email:
+- piotr@piotrmurach.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/tty-markdown.rb
+- lib/tty/markdown.rb
+- lib/tty/markdown/color.rb
+- lib/tty/markdown/converter.rb
+- lib/tty/markdown/decorator.rb
+- lib/tty/markdown/error.rb
+- lib/tty/markdown/formatter.rb
+- lib/tty/markdown/highlighter.rb
+- lib/tty/markdown/parser.rb
+- lib/tty/markdown/symbols.rb
+- lib/tty/markdown/theme.rb
+- lib/tty/markdown/version.rb
+homepage: https://ttytoolkit.org
+licenses:
+- MIT
+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
+  funding_uri: https://github.com/sponsors/piotrmurach
+  homepage_uri: https://ttytoolkit.org
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/piotrmurach/tty-markdown
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Convert a Markdown text or document into a terminal friendly output.
+test_files: []