tty-markdown-meinac 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '048f174ebf3a7a252c876b74c92f4770c662fffbc1dcaeebfd994e366fb3455c'
+  data.tar.gz: 9990524f7ef5c9152ffc65825e4652847eeae4275b646844694c3aecbdf95a2e
+SHA512:
+  metadata.gz: 6103734b3e3629f3e47cd77f7122a331d16bc56a1e02759bb7dcdb826c442db6b31a21734d69720c149161e6a3880c27c3d383614fa4070b0d6556434355a748
+  data.tar.gz: 263ad5d46256315dac06fc59e7494f4b9c695ecb10d78391295b1e958a33014821ca5d25894cbc5598e29fe6f947045d8d74841f1f44ca03de22ef83e83ec52f

data/CHANGELOG.md

@@ -0,0 +1,157 @@
+# Change log
+
+## unreleased
+
+### Added
+
+* Add the ability to instantiate the `TTY::Markdown`.
+* Add the `code`, `delete`, `h1`, `h2`, `h3`, `h4`, `h5` and `h6` styles
+  configuration to the default theme.
+* Add the ability to format code elements in truecolor.
+
+### Changed
+
+* Change the `TTY::Markdown` instantiation to raise the `TTY::Markdown::Error`
+  when configuring an invalid `color`, `symbols` or `theme` option value.
+* Change the code block conversion to always append a newline.
+* Change the del conversion to replace the `delete` symbol with
+  the theme `delete` style.
+
+### Fixed
+
+* Fix the indentation of multiline paragraphs with formatted elements.
+
+### Removed
+
+* Remove the `header` style from the theme configuration.
+
+## [v0.7.2] - 2023-03-12
+
+### Changed
+
+* Change gemspec to expand supported rouge versions by Ash McKenzie(@ashmckenzie)
+
+## [v0.7.1] - 2022-12-21
+
+### Changed
+
+* Change the symbols option to accept string value
+
+### Fixed
+
+* Fix the theme option to allow overriding specific markdown element styles
+
+## [v0.7.0] - 2020-09-03
+
+### Added
+
+* Add converter for br element by @krage
+* Add configuration of symbols by @krage
+* Add definition list support
+* Add table footer formatting
+* Add formatting of image source location
+* Add footnotes support
+* Add XML comments support
+* Add HTML div/i/em/b/strong/img/a element support
+* Add color configuration setting
+
+### Changed
+
+* Change #new to accept configuration options as keywords
+* Display links with both label and optional title by @krage
+* Display link without the label when label content is same as link target @krage
+* Change hr formatting to be always full width
+* Differentiate between span and block math elements
+* Display abbreviation with its definition
+* Improve performance by calculating table column widths and row heights only once
+* Change to remove mailto: from email links for brevity @krage
+* Change to update kramdown to support versions >= 1.16 and < 3.0
+* Change to update pastel, tty-color & tty-screen dependencies
+* Change HTML del element formatting to strikethrough
+* Rename colors setting to mode
+
+### Fixed
+
+* Fix break line handling by @krage
+* Fix links handling by @krage
+* Fix table formatting of empty cells
+* Fix content wrapping to account for the current indentation
+* Fix header wrapping
+* Fix blockquote formatting of content with emphasised style or apostrophe
+* Fix support for HTML del element
+
+## [v0.6.0] - 2019-03-30
+
+### Added
+
+* Add markdown xml comments conversion
+
+## [v0.5.1] - 2019-02-07
+
+### Fixed
+
+* Fix spaces around inline code quotes collapses inside list items
+
+## [v0.5.0] - 2018-12-13
+
+### Changed
+
+* Change gemspec to load files directly
+* Change to update rouge dependency
+* Change to relax constraints on tty-screen and tty-color
+
+## [v0.4.0] - 2018-06-20
+
+## Fixed
+
+* Fix multiline paragraph indentation by Brett(@suwyn)
+
+## [v0.3.0] - 2018-03-17
+
+### Added
+
+* Add :width option to allow setting maximum display width
+* Add :colors options for specifying rendering colors capabilities
+* Add ability to parse multiline table content
+
+### Changed
+
+* Change color scheme to replace table and links blue with yellow
+
+## Fixed
+
+* Fix issue with multiline blockquote elements raising NoMethodError
+
+## [v0.2.0] - 2018-01-29
+
+### Added
+
+* Add space indented codeblock markdown conversion
+* Add markdown math formula conversion
+* Add markdown typogrpahic symbols conversion
+  by Tanaka Masaki(@T-a-n-a-k-a-M-a-s-a-k-i)
+* Add html entities conversion
+* Add warnings about unsupported conversions for completeness
+
+### Changed
+
+* Change gemspec to require Ruby >= 2.0.0
+
+### Fixed
+
+* Fix smart quotes to correctly encode entities
+
+## [v0.1.0] - 2018-01-24
+
+* Initial implementation and release
+
+[v0.7.2]: https://github.com/piotrmurach/tty-markdown/compare/v0.7.1...v0.7.2
+[v0.7.1]: https://github.com/piotrmurach/tty-markdown/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.6.0...v0.7.0
+[v0.6.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.5.1...v0.6.0
+[v0.5.1]: https://github.com/piotrmurach/tty-markdown/compare/v0.5.0...v0.5.1
+[v0.5.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Piotr Murach (piotrmurach.com)
+
+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,414 @@
+<div align="center">
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit logo" /></a>
+</div>
+
+# TTY::Markdown
+
+[![Gem Version](https://badge.fury.io/rb/tty-markdown.svg)][gem]
+[![Actions CI](https://github.com/piotrmurach/tty-markdown/actions/workflows/ci.yml/badge.svg)][gh_actions_ci]
+[![Build status](https://ci.appveyor.com/api/projects/status/k4vub4koct329ggd?svg=true)][appveyor]
+[![Maintainability](https://qlty.sh/gh/piotrmurach/projects/tty-markdown/maintainability.svg)][qlty]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-markdown/badge.svg)][coverage]
+
+[gem]: https://badge.fury.io/rb/tty-markdown
+[gh_actions_ci]: https://github.com/piotrmurach/tty-markdown/actions/workflows/ci.yml
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-markdown
+[qlty]: https://qlty.sh/gh/piotrmurach/projects/tty-markdown
+[coverage]: https://coveralls.io/github/piotrmurach/tty-markdown
+
+> Convert a Markdown document or text into a terminal friendly output.
+
+**TTY::Markdown** provides a Markdown processing component for the
+[TTY Toolkit](https://github.com/piotrmurach/tty).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tty-markdown"
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install tty-markdown
+```
+
+## Contents
+
+* [1. Usage](#1-usage)
+  * [1.1 Header](#11-header)
+  * [1.2 List](#12-list)
+  * [1.3 Definition List](#13-definition-list)
+  * [1.4 Link](#14-link)
+  * [1.5 Blockquote](#15-blockquote)
+  * [1.6 Code and Syntax Highlighting](#16-code-and-syntax-highlighting)
+  * [1.7 Table](#17-table)
+  * [1.8 Horizontal Rule](#18-horizontal-rule)
+  * [1.9 Footnotes](#19-footnotes)
+* [2. Options](#2-options)
+  * [2.1 :mode](#21-mode)
+  * [2.2 :theme](#22-theme)
+  * [2.3 :width](#23-width)
+  * [2.4 :symbols](#24-symbols)
+  * [2.5 :indent](#25-indent)
+  * [2.6 :color](#26-color)
+* [3. Command line tool](#3-command-line-tool)
+
+## 1. Usage
+
+Using `parse` method, you can transform a Markdown string into a terminal
+formatted content:
+
+```ruby
+parsed = TTY::Markdown.parse("# Hello")
+puts parsed
+# => "\e[36;1mHello\e[0m\n"
+```
+
+The `parse_file` allows you to transform a Markdown document into a terminal
+formatted output:
+
+```ruby
+parsed = TTY::Markdown.parse_file('example.md')
+puts parsed
+```
+
+### 1.1 Header
+
+Parsing the following Markdown headers:
+
+```markdown
+TTY::Markdown
+=============
+
+**tty-markdown** converts markdown document into a terminal friendly output.
+
+## Examples
+
+### Nested list items
+```
+
+The terminal output looks like this:
+
+![Headers example](assets/headers.png)
+
+### 1.2 List
+
+Both numbered and unordered lists are supported. Given a Markdown:
+
+```markdown
+- Item 1
+  - Item 2
+  - Item 3
+    - Item 4
+- Item 5
+```
+
+The parsed output looks like this:
+
+![Unordered list example](assets/list.png)
+
+### 1.3 Definition List
+
+Given a definition list:
+
+```markdown
+Item 1
+: This is the description for Item 1
+
+Item 2
+: This is the description for Item 2
+: This is another description for Item 2
+```
+
+The parsed output looks like this:
+
+![Definition list example](assets/definition-list.png)
+
+### 1.4 Link
+
+A Markdown link:
+
+```markdown
+[An inline-style link](https://ttytoolkit.org)
+
+[An inline-style link with title](https://ttytoolkit.org "TTY Toolkit Homepage")
+```
+
+The link text will be rendered with the link next to it:
+
+![Link example](assets/link.png)
+
+### 1.5 Blockquote
+
+Given a Markdown quote:
+
+```markdown
+> Blockquotes are very handy in email to emulate reply text.
+> This line is part of the same quote.
+> *Oh*, you can put **Markdown** into a blockquote.
+```
+
+The rendered output looks like this:
+
+![Blockquote example](assets/quote.png)
+
+### 1.6 Code and Syntax Highlighting
+
+The parser can highlight syntax of many programming languages.
+
+Given a Markdown codeblock with a language specification:
+
+````markdown
+```ruby
+class Greeter
+  def hello(name)
+    puts "Hello #{name}"
+  end
+end
+```
+````
+
+The terminal output will look like this:
+
+![Code highlighting example](assets/codeblock.png)
+
+### 1.7 Table
+
+You can transform tables which understand the Markdown alignment.
+
+For example, given the following table:
+
+```markdown
+| Tables   |      Are      |  Cool |
+|----------|:-------------:|------:|
+| col 1 is |  left-aligned | $1600 |
+| col 2 is |    centered   |   $12 |
+| col 3 is | right-aligned |    $1 |
+```
+
+Then the terminal output will look like this:
+
+![Table example](assets/table.png)
+
+### 1.8 Horizontal Rule
+
+You can specify a horizontal rule in Markdown:
+
+```markdown
+***
+```
+
+and then transform it:
+
+```ruby
+parsed = TTY::Markdown.parse(markdown_string)
+```
+
+`puts parsed` will output:
+
+![Horizontal rule example](assets/hr.png)
+
+### 1.9 Footnotes
+
+You can create footnote references:
+
+```markdown
+It is not down on any map[^foo]; true places[^bar] never are.
+
+[^foo]: A diagrammatic representation of an area of land or sea.
+[^bar]: A particular position, point, or area in space; a location.
+```
+
+All footnotes will be displayed with a sequential number and rendered in
+the terminal like this:
+
+![Footnotes example](assets/footnotes.png)
+
+## 2. Options
+
+### 2.1 `:mode`
+
+By default the `256` color scheme is used to render code block elements.
+
+Use the `:mode` keyword to specify the maximum number of colors, for example,
+to be `16` ANSI colors:
+
+```ruby
+TTY::Markdown.parse(markdown_string, mode: 16)
+```
+
+This feature may be handy when working in terminals with limited color support.
+
+By default, **TTY::Markdown** detects terminal color mode and adjusts output
+automatically.
+
+### 2.2 `:theme`
+
+Use the `:theme` keyword to change specific Markdown element styles.
+
+For example, to override styles for the `link` and `list` elements do:
+
+```ruby
+TTY::Markdown.parse(markdown_string, theme: {link: :magenta, list: %i[magenta bold]})
+```
+
+Here's a complete list of element names with corresponding styles:
+
+| Name        | 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]`              |
+
+Read the [pastel](https://github.com/piotrmurach/pastel#3-supported-colors)
+documentation for all supported styles.
+
+### 2.3 `:width`
+
+Use the `:width` keyword to control the maximum width of the output:
+
+```ruby
+TTY::Markdown.parse(markdown_string, width: 80)
+```
+
+By default the terminal screen width is used.
+
+### 2.4 `:symbols`
+
+By default, formatted output includes various Unicode symbols. Use the
+`:symbols` keyword to switch to an ASCII set and/or override individual
+symbols.
+
+```ruby
+TTY::Markdown.parse(markdown_string, symbols: :ascii)
+TTY::Markdown.parse(markdown_string, symbols: {base: :ascii})
+TTY::Markdown.parse(markdown_string, symbols: {override: {bullet: "x"}})
+```
+
+Here's a complete list of symbol names with corresponding ASCII and Unicode
+characters:
+
+| Name             | ASCII | Unicode |
+|------------------|-------|---------|
+| `:arrow`         | `->`  | `»`     |
+| `:bar`           | `\|`  | `┃`     |
+| `:bottom_center` | `+`   | `┴`     |
+| `:bottom_left`   | `+`   | `└`     |
+| `:bottom_right`  | `+`   | `┘`     |
+| `:bracket_left`  | `[`   | `[`     |
+| `:bracket_right` | `]`   | `]`     |
+| `:bullet`        | `*`   | `●`     |
+| `:diamond`       | `*`   | `◈`     |
+| `:hash`          | `#`   | `#`     |
+| `:hellip`        | `...` | `…`     |
+| `:laquo`         | `<<`  | `«`     |
+| `:laquo_space`   | `<< ` | `« `    |
+| `:ldquo`         | `"`   | `“`     |
+| `:lsquo`         | `"`   | `‘`     |
+| `:line`          | `-`   | `─`     |
+| `:mdash`         | `-`   | `—`     |
+| `:mid_center`    | `+`   | `┼`     |
+| `:mid_left`      | `+`   | `├`     |
+| `:mid_right`     | `+`   | `┤`     |
+| `:ndash`         | `-`   | `-`     |
+| `:paren_left`    | `(`   | `(`     |
+| `:paren_right`   | `)`   | `)`     |
+| `:pipe`          | `\|`  | `│`     |
+| `:raquo`         | `>>`  | `»`     |
+| `:raquo_space`   | ` >>` | ` »`    |
+| `:rdquo`         | `"`   | `”`     |
+| `:rsquo`         | `"`   | `’`     |
+| `:top_center`    | `+`   | `┬`     |
+| `:top_left`      | `+`   | `┌`     |
+| `:top_right`     | `+`   | `┐`     |
+
+### 2.5 `:indent`
+
+By default, any content apart from the main `h1` header is indented with `2`
+spaces. Use the `:indent` keyword to provide custom indent or no indent at all:
+
+```ruby
+TTY::Markdown.parse(markdown_string, indent: 0)
+```
+
+### 2.6 `:color`
+
+Use the `:color` keyword to control when to apply coloring to various document
+elements. Valid values are `:always`, `:auto` or `:never`. The default `:auto`
+value automatically detects whether to color the output or not.
+
+For example, to always color content regardless of terminal support:
+
+```ruby
+TTY::Markdown.parse(markdown_string, color: :always)
+```
+
+### 3. Command line tool
+
+Install the [tty-markdown-cli](https://github.com/piotrmurach/tty-markdown-cli)
+to use the `tty-markdown` executable in the terminal:
+
+```bash
+$ tty-markdown README.md
+```
+
+## 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 tags, 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/piotrmurach/tty-markdown.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[code of conduct](https://github.com/piotrmurach/tty-markdown/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TTY::Markdown project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/piotrmurach/tty-markdown/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2018 Piotr Murach. See
+[LICENSE.txt](https://github.com/piotrmurach/tty-markdown/blob/master/LICENSE.txt)
+for further details.

data/lib/tty/markdown/color.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "error"
+
+module TTY
+  class Markdown
+    # Responsible for storing the color configuration
+    #
+    # @api private
+    class Color
+      # The always name
+      #
+      # @return [String]
+      #
+      # @api private
+      ALWAYS = "always"
+      private_constant :ALWAYS
+
+      # The auto name
+      #
+      # @return [String]
+      #
+      # @api private
+      AUTO = "auto"
+      private_constant :AUTO
+
+      # The never name
+      #
+      # @return [String]
+      #
+      # @api private
+      NEVER = "never"
+      private_constant :NEVER
+
+      # The allowed modes
+      #
+      # @return [Array<String>]
+      #
+      # @api private
+      MODES = [ALWAYS, AUTO, NEVER].freeze
+      private_constant :MODES
+
+      # Create a {TTY::Markdown::Color} instance
+      #
+      # @example
+      #   color = TTY::Markdown::Color.new(:always)
+      #
+      # @param [String, Symbol] color
+      #   the color configuration
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the color is invalid
+      #
+      # @api public
+      def initialize(color)
+        @color = validate(color)
+      end
+
+      # Convert to the Pastel enabled option
+      #
+      # @example
+      #   color.to_enabled
+      #
+      # @return [Boolean, nil]
+      #
+      # @api public
+      def to_enabled
+        case @color.to_s
+        when ALWAYS then true
+        when NEVER  then false
+        end
+      end
+
+      private
+
+      # Validate the color value
+      #
+      # @param [String, Symbol] value
+      #   the color value
+      #
+      # @return [String, Symbol]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the color value is invalid
+      #
+      # @api private
+      def validate(value)
+        return value if MODES.include?(value.to_s)
+
+        raise_value_error(value)
+      end
+
+      # Raise the color value error
+      #
+      # @param [Object] value
+      #   the color value
+      #
+      # @return [void]
+      #
+      # @raise [TTY::Markdown::Error]
+      #   when the color value is invalid
+      #
+      # @api private
+      def raise_value_error(value)
+        raise Error, "invalid color: #{value.inspect}. Use the " \
+                     ":#{ALWAYS}, :#{AUTO} or :#{NEVER} value."
+      end
+    end # Color
+  end # Markdown
+end # TTY