tty-markdown 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44486f20a5fb0b3db0de9d760bf88e33a713aa56
-  data.tar.gz: 9c55823506373b0a6d95c38fa1fab6a4b38d2462
+  metadata.gz: 78fdb3db2ddf8fcb253d3f2b7fd48ce85f34db5b
+  data.tar.gz: b4176a98f2e6238a0b9d1d3eb32585610750a4b7
 SHA512:
-  metadata.gz: 6a49d8dc74703dd156ea8646beb251c51dfc0efd0f27ccee0c29b04648c8d7aa671730d607154a3d1fb9ab0c3bf988662565a39f346fcdb95a2b3331a8c73eda
-  data.tar.gz: cab7e9b37d1a281ad5c9419e26881fa56f1420070d141ace550468be373885d637177927d362c537cf91c31f760704f1370a544625e420d8b07f152d357dc3bf
+  metadata.gz: c4ddf759c61068a151a2e07ad973fa0268ea671be2006ce1ae0fbd5d4aca6f823d0d682bd005af1473d75dd88b61fa69ac9ab5cc23576773b79b546b5651c232
+  data.tar.gz: 1fa053194d9f4ad41366a4b592888184668f4ea4be628d9cf57e79a296f60b90baaacbac4a8b5df3ed94b29f3baae29268103e7dc3b8328b5a5ecc7cd8547ee4

data/.travis.yml

@@ -10,6 +10,7 @@ rvm:
   - 2.2.8
   - 2.3.6
   - 2.4.3
+  - 2.5.0
   - ruby-head
   - jruby-9000
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [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
@@ -19,5 +32,6 @@
 
 * Initial implementation and release
 
+[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/README.md

@@ -39,13 +39,17 @@ Or install it yourself as:
 ## Contents
 
 * [1. Usage](#1-usage)
-  * [1.1 List](#11-list)
-  * [1.2 Header](#12-header)
-  * [1.3 Quote](#13-quote)
-  * [1.4 Codeblock](#14-codeblock)
-  * [1.5 Table](#15-table)
+  * [1.1 Header](#11-header)
+  * [1.2 List](#12-list)
+  * [1.3 Link](#13-link)
+  * [1.4 Blockquote](#14-blockquote)
+  * [1.5 Code and Syntax Highlighting](#15-code-and-syntax-highlighting)
+  * [1.6 Table](#16-table)
+  * [1.7 Horizontal Rule](#17-horizontal-rule)
 * [2. Options](#2-options)
-  * [2.1 :theme](#21-theme)
+  * [2.1 :colors](#21-colors)
+  * [2.2 :theme](#22-theme)
+  * [2.3 :width](#23-width)
 
 ## 1. Usage
 
@@ -64,7 +68,30 @@ parsed = TTY::Markdown.parse('example.md')
 puts parsed
 ```
 
-### 1.1 List
+### 1.1 Header
+
+```markdown
+TTY::Markdown
+=============
+
+**tty-markdown** converts markdown document into a terminal friendly output.
+
+## Examples
+
+### Nested list items
+```
+
+and transforming it:
+
+```ruby
+parsed = TTY::Markdown.parse(markdown_string)
+```
+
+`puts parsed` will output:
+
+![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/headers.png)
+
+### 1.2 List
 
 Both numbered and unordered lists are supported. Given a markdown:
 
@@ -86,30 +113,19 @@ parsed = TTY::Markdown.parse(markdown_string)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/list.png)
 
-### 1.2 Header
-
-```markdown
-TTY::Markdown
-=============
-
-**tty-markdown** converts markdown document into a terminal friendly output.
-
-## Examples
-
-### Nested list items
-```
+### 1.3 Link
 
-and transforming it:
+A mardown link:
 
-```ruby
-parsed = TTY::Markdown.parse(markdown_string)
+```markdown
+[I'm an inline-style link](https://www.google.com)
 ```
 
-`puts parsed` will output:
+will be rendered with actual link content next to it:
 
-![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/headers.png)
+![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/link.png)
 
-### 1.3 Quote
+### 1.4 Blockquote
 
 Given a markdown quote:
 
@@ -129,7 +145,7 @@ parsed = TTY::Markdown.parse(markdown_string)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/quote.png)
 
-### 1.4 Codeblock
+### 1.5 Code and Syntax Highlighting
 
 The parser can highlight syntax of many programming languages. Given the markdown codeblock with language specification:
 
@@ -153,7 +169,7 @@ parsed = TTY::Markdown.parse(code_snippet)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/syntax_highlight.png)
 
-### 1.5 Table
+### 1.6 Table
 
 You can transform tables which understand the markdown alignment.
 
@@ -177,21 +193,49 @@ parsed = TTY::Markdown.parse(markdown_string)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/table.png)
 
+### 1.7 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:
+
+![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/hr.png)
+
 ## 2. Options
 
-### 2.1 `:theme`
+### 2.1 `:colors`
+
+By default the `256` colors scheme is used to render code block elements. You can change that by specifying desired number of colors:
+
+```ruby
+TTY::Markdown.pasre(markdown_string, colors: 16)
+```
+
+This feauture may be handy when working in terminals with limited color support. By default, **TTY::Markdown** detects your terminal color mode and adjusts output automatically.
+
+### 2.2 `:theme`
 
 A hash of styles that allows to customize specific elements of the markdown text. By default the following styles are used:
 
 ```ruby
 THEME = {
-  em: :italic,
+  em: :yellow,
   header: [:cyan, :bold],
   hr: :yellow,
-  link: [:blue, :underline],
+  link: [:yellow, :underline],
   list: :yellow,
   strong: [:yellow, :bold],
-  table: :blue,
+  table: :yellow,
   quote: :yellow,
 }
 ```
@@ -202,6 +246,16 @@ In order to provide new styles use `:theme` key:
 TTY::Markdown.parse(markdown_string, theme: { ... })
 ```
 
+### 2.3 `:width`
+
+You can easily control the maximum width of the output by using the `:width` key:
+
+```ruby
+TTY::Markdown.parse(markdown_string, width: 80)
+```
+
+By default the terminal screen width is used.
+
 ## 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.

data/appveyor.yml

@@ -19,3 +19,5 @@ environment:
     - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"

data/examples/marked.rb

@@ -1,6 +1,6 @@
 require_relative '../lib/tty-markdown'
 
 path = File.join(__dir__, 'example.md')
-out = TTY::Markdown.parse_file(path, colors: 256)
+out = TTY::Markdown.parse_file(path, colors: 256, width: 80)
 
 puts out

data/lib/tty/markdown.rb

@@ -66,13 +66,13 @@ module TTY
     }.freeze
 
     THEME = {
-      em: :italic,
+      em: :yellow,
       header: [:cyan, :bold],
       hr: :yellow,
-      link: [:blue, :underline],
+      link: [:yellow, :underline],
       list: :yellow,
       strong: [:yellow, :bold],
-      table: :blue,
+      table: :yellow,
       quote: :yellow,
     }.freeze
 

data/lib/tty/markdown/parser.rb

@@ -18,7 +18,7 @@ module TTY
         @current_indent = 0
         @indent = options.fetch(:indent, 2)
         @pastel = Pastel.new
-        @color_opts = {mode: options[:colors]}
+        @color_opts = { mode: options[:colors] }
         @width = options.fetch(:width) { TTY::Screen.width }
         @theme = options.fetch(:theme) { TTY::Markdown::THEME }
       end
@@ -26,7 +26,7 @@ module TTY
       # Invoke an element conversion
       #
       # @api public
-      def convert(el, opts = {indent: 0, result: []})
+      def convert(el, opts = { indent: 0, result: [] })
         send("convert_#{el.type}", el, opts)
       end
 
@@ -64,6 +64,7 @@ module TTY
       def convert_p(el, opts)
         result_before = @stack.last[1][:result].dup
         indent = ' ' * @current_indent
+
         if opts[:parent].type != :blockquote
           opts[:result] << indent
         end
@@ -88,12 +89,21 @@ module TTY
         end
       end
 
+      # Format current element by inserting prefix for each
+      # quoted line within the allowed screen size.
+      #
+      # @param [Array[String]] result_before
+      # @param [Array[String]] result
+      #
+      # @return [nil]
+      #
+      # @api private
       def format_blockquote(result_before, result)
         indent      = ' ' * @current_indent
         start_index = result_before.size
         max_index   = result.size - 1
         bar_symbol  = TTY::Markdown.symbols[:bar]
-        styles = Array(@theme[:quote])
+        styles      = Array(@theme[:quote])
         prefix      = "#{indent}#{@pastel.decorate(bar_symbol, *styles)}  "
 
         result.map!.with_index do |str, i|
@@ -101,14 +111,15 @@ module TTY
             str.insert(0, prefix)
           end
 
-          if i >= start_index && str.include?("\n")
+          # only modify blockquote element
+          if i >= start_index && str.to_s.include?("\n") # multiline string found
             str.lines.map! do |line|
-              if line != str.lines.last || i < max_index
-                line.insert(-1, prefix)
+              if (line != str.lines.last || i < max_index)
+                line.insert(-1, line.end_with?("\n") ? prefix : "\n" + prefix)
               else
                 line
               end
-            end
+            end.join
           else
             str
           end
@@ -117,19 +128,19 @@ module TTY
 
       def convert_text(el, opts)
         text = el.value
-        opts[:result] << text
+        opts[:result] << Strings.wrap(text, @width)
       end
 
       def convert_strong(el, opts)
         styles = Array(@theme[:strong])
-        opts[:result] <<  @pastel.lookup(*styles)
+        opts[:result] << @pastel.lookup(*styles)
         inner(el, opts)
         opts[:result] << @pastel.lookup(:reset)
       end
 
       def convert_em(el, opts)
         styles = Array(@theme[:em])
-        opts[:result] <<  @pastel.lookup(*styles)
+        opts[:result] << @pastel.lookup(*styles)
         inner(el, opts)
         opts[:result] << @pastel.lookup(:reset)
       end
@@ -143,10 +154,10 @@ module TTY
       end
 
       def convert_codespan(el, opts)
-        raw_code = el.value
+        raw_code = Strings.wrap(el.value, @width)
         highlighted = SyntaxHighliter.highlight(raw_code, @color_opts.merge(opts))
         code = highlighted.split("\n").map.with_index do |line, i|
-                if i == 0 # first line
+                if i.zero? # first line
                   line
                 else
                   line.insert(0, ' ' * @current_indent)
@@ -227,7 +238,7 @@ module TTY
         symbols = TTY::Markdown.symbols
         result = []
         result << symbols[:"#{location}_left"]
-        max_widths(table_data).each.with_index do |width, i|
+        distribute_widths(max_widths(table_data)).each.with_index do |width, i|
           result << symbols[:"#{location}_center"] if i != 0
           result << (symbols[:line] * (width + 2))
         end
@@ -256,13 +267,11 @@ module TTY
       end
 
       def convert_tfoot(el, opts)
-        innert(el, opts)
+        inner(el, opts)
       end
 
       def convert_tr(el, opts)
         indent = ' ' * @current_indent
-        pipe = TTY::Markdown.symbols[:pipe]
-        styles = Array(@theme[:table])
         table_data = opts[:table_data]
 
         if opts[:prev] && opts[:prev].type == :tr
@@ -271,39 +280,95 @@ module TTY
           opts[:result] << "\n"
         end
 
-        opts[:result] << indent + @pastel.decorate("#{pipe} ", *styles)
+        opts[:cells] = []
+
         inner(el, opts)
-        opts[:result] << "\n"
+
+        columns = table_data.first.count
+
+        row = opts[:cells].each_with_index.reduce([]) do |acc, (cell, i)|
+          if cell.size > 1 # multiline
+            cell.each_with_index do |c, j| # zip columns
+              acc[j] = [] if acc[j].nil?
+              acc[j] << c.chomp
+              acc[j] << "\n" if i == (columns - 1)
+            end
+          else
+            acc << cell
+            acc << "\n" if i == (columns - 1)
+          end
+          acc
+        end.join
+
+        opts[:result] << row
       end
 
       def convert_td(el, opts)
-        pipe = TTY::Markdown.symbols[:pipe]
-        styles = Array(@theme[:table])
+        indent = ' ' * @current_indent
+        pipe       = TTY::Markdown.symbols[:pipe]
+        styles     = Array(@theme[:table])
         table_data = opts[:table_data]
-        result = opts[:result]
+        result     = opts[:cells]
+        suffix     = " #{@pastel.decorate(pipe, *styles)} "
         opts[:result] = []
 
         inner(el, opts)
 
-        column = find_column(table_data, opts[:result])
-        width = max_width(table_data, column)
-        alignment = opts[:alignment][column]
-        align_opts = alignment == :default ? {} : {direction: alignment}
-
-        result << Strings.align(opts[:result].join, width, align_opts) <<
-               " #{@pastel.decorate(pipe, *styles)} "
+        row, column = *find_row_column(table_data, opts[:result])
+        cell_widths = distribute_widths(max_widths(table_data))
+        cell_width = cell_widths[column]
+        cell_height = max_height(table_data, row, cell_widths)
+        alignment  = opts[:alignment][column]
+        align_opts = alignment == :default ? {} : { direction: alignment }
+
+        wrapped = Strings.wrap(opts[:result].join, cell_width)
+        aligned = Strings.align(wrapped, cell_width, align_opts)
+        padded = if aligned.lines.size < cell_height
+                   Strings.pad(aligned, [0, 0, cell_height - aligned.lines.size, 0])
+                 else
+                   aligned.dup
+                 end
+
+        result << padded.lines.map do |line|
+          # add pipe to first column
+          (column.zero? ? indent + @pastel.decorate("#{pipe} ", *styles) : '') +
+            (line.end_with?("\n") ? line.insert(-2, suffix) : line << suffix)
+        end
       end
 
-      def find_column(table_data, cell)
-        table_data.each do |row|
+      # Find row and column indexes
+      #
+      # @return [Array[Integer, Integer]]
+      #
+      # @api private
+      def find_row_column(table_data, cell)
+        table_data.each_with_index do |row, row_no|
           row.size.times do |col|
-            return col if row[col] == cell
+            return [row_no, col] if row[col] == cell
           end
         end
       end
 
+      # Calculate maximum cell width for a given column
+      #
+      # @return [Integer]
+      #
+      # @api private
       def max_width(table_data, col)
-        table_data.map { |row| Strings.sanitize(row[col].join).length }.max
+        table_data.map do |row|
+          Strings.sanitize(row[col].join).lines.map(&:length).max
+        end.max
+      end
+
+      # Calculate maximum cell height for a given row
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def max_height(table_data, row, cell_widths)
+        table_data[row].map.with_index do |col, i|
+          Strings.wrap(col.join, cell_widths[i]).lines.size
+        end.max
       end
 
       def max_widths(table_data)
@@ -313,10 +378,24 @@ module TTY
         end
       end
 
+      def distribute_widths(widths)
+        indent = ' ' * @current_indent
+        total_width = widths.reduce(&:+)
+        screen_width = @width - (indent.length + 1) * 2 - (widths.size + 1)
+        return widths if total_width <= screen_width
+
+        extra_width = total_width - screen_width
+
+        widths.map do |w|
+          ratio = w / total_width.to_f
+          w - (extra_width * ratio).floor
+        end
+      end
+
       def convert_hr(el, opts)
         indent = ' ' * @current_indent
         symbols = TTY::Markdown.symbols
-        width = @width - (indent.length+1) * 2
+        width = @width - (indent.length + 1) * 2
         styles = Array(@theme[:hr])
         line = symbols[:diamond] + symbols[:line] * width + symbols[:diamond]
 

data/lib/tty/markdown/version.rb

@@ -1,5 +1,5 @@
 module TTY
   module Markdown
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end # TTY
 end # Markdown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -153,6 +153,8 @@ files:
 - Rakefile
 - appveyor.yml
 - assets/headers.png
+- assets/hr.png
+- assets/link.png
 - assets/list.png
 - assets/quote.png
 - assets/syntax_highlight.png