tty-markdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 372c2535e3de00b3681eded48af2d9fef7b1c99d
-  data.tar.gz: 75ab67563718dc7d68d17b6738b699ac59e3cee7
+  metadata.gz: 44486f20a5fb0b3db0de9d760bf88e33a713aa56
+  data.tar.gz: 9c55823506373b0a6d95c38fa1fab6a4b38d2462
 SHA512:
-  metadata.gz: a104de05f2d5cbfc3384663d2272d1b16bbd9c8bd2692548be8efd6174651ceb7af9616903b9e2b6f322c7bff6f34672ec9673a46513d5ba38cf2fc7e195d578
-  data.tar.gz: 696a9c610c87f79422b4b4aee4a0f4648d12396a7b94f3109708217a388c95a086fa7bd992553d026a9b985065c41a1c6116e7e6bd5d357fd4b5bc96b76f705a
+  metadata.gz: 6a49d8dc74703dd156ea8646beb251c51dfc0efd0f27ccee0c29b04648c8d7aa671730d607154a3d1fb9ab0c3bf988662565a39f346fcdb95a2b3331a8c73eda
+  data.tar.gz: cab7e9b37d1a281ad5c9419e26881fa56f1420070d141ace550468be373885d637177927d362c537cf91c31f760704f1370a544625e420d8b07f152d357dc3bf

data/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Change log
 
+## [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 completness
+
+### 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.1.0]: https://github.com/piotrmurach/tty-reader/compare/v0.1.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

@@ -15,7 +15,7 @@
 [coverage]: https://coveralls.io/github/piotrmurach/tty-markdown
 [inchpages]: http://inch-ci.org/github/piotrmurach/tty-markdown
 
-> Convert a markdown documet or text into a terminal friendly output.
+> Convert a markdown document or text into a terminal friendly output.
 
 
 **TTY::Markdown** provides independent markdown processing component for [TTY](https://github.com/piotrmurach/tty) toolkit.
@@ -109,7 +109,7 @@ parsed = TTY::Markdown.parse(markdown_string)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/headers.png)
 
-### Quote
+### 1.3 Quote
 
 Given a markdown quote:
 
@@ -129,7 +129,7 @@ parsed = TTY::Markdown.parse(markdown_string)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/quote.png)
 
-### Codeblock
+### 1.4 Codeblock
 
 The parser can highlight syntax of many programming languages. Given the markdown codeblock with language specification:
 
@@ -153,7 +153,7 @@ parsed = TTY::Markdown.parse(code_snippet)
 
 ![Code highlight](https://cdn.rawgit.com/piotrmurach/tty-markdown/master/assets/syntax_highlight.png)
 
-### Table
+### 1.5 Table
 
 You can transform tables which understand the markdown alignment.
 

data/examples/man.md

@@ -0,0 +1,17 @@
+# name(1) - description
+
+## SYNOPSIS
+
+`name` \[`OPTIONS`\] *arguments*...
+
+### DESCRIPTION
+
+Paragraph describing what the tool does.
+
+### OPTIONS
+
+* A
+* list
+* of
+* available
+* options

data/examples/man.rb

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

data/lib/tty/markdown.rb

@@ -14,6 +14,17 @@ module TTY
       diamond: '◈',
       pipe: '│',
       line: '─',
+      hellip: '…',
+      laquo: '«',
+      laquo_space: '« ',
+      raquo: '»',
+      raquo_space: ' »',
+      ndash: '-',
+      mdash: "\u2014",
+      lsquo: '‘',
+      rsquo: '’',
+      ldquo: '“',
+      rdquo: '”',
       top_left: '┌',
       top_right: '┐',
       top_center: '┬',
@@ -22,8 +33,8 @@ module TTY
       mid_center: '┼',
       bottom_right: '┘',
       bottom_left: '└',
-      bottom_center: '┴'
-    }
+      bottom_center: '┴',
+    }.freeze
 
     WIN_SYMBOLS = {
       arrow: '->',
@@ -32,6 +43,17 @@ module TTY
       bar: '│',
       pipe: '|',
       line: '─',
+      hellip: '...',
+      laquo: '<<',
+      laquo_space: '<< ',
+      raquo: '>>',
+      raquo_space: ' >>',
+      ndash: '-',
+      mdash: "--",
+      lsquo: ''',
+      rsquo: ''',
+      ldquo: '"',
+      rdquo: '"',
       top_left: '+',
       top_right: '+',
       top_center: '+',
@@ -41,7 +63,7 @@ module TTY
       bottom_right: '+',
       bottom_left: '+',
       bottom_center: '+'
-    }
+    }.freeze
 
     THEME = {
       em: :italic,
@@ -52,7 +74,7 @@ module TTY
       strong: [:yellow, :bold],
       table: :blue,
       quote: :yellow,
-    }
+    }.freeze
 
     # Parse a markdown string
     #

data/lib/tty/markdown/parser.rb

@@ -139,12 +139,12 @@ module TTY
       end
 
       def convert_smart_quote(el, opts)
-        inner(el, opts)
+        opts[:result] << TTY::Markdown.symbols[el.value]
       end
 
       def convert_codespan(el, opts)
         raw_code = el.value
-        highlighted = SyntaxHighliter.highlight(raw_code, @color_opts)
+        highlighted = SyntaxHighliter.highlight(raw_code, @color_opts.merge(opts))
         code = highlighted.split("\n").map.with_index do |line, i|
                 if i == 0 # first line
                   line
@@ -155,6 +155,11 @@ module TTY
         opts[:result] << code.join("\n")
       end
 
+      def convert_codeblock(el, opts)
+        opts[:fenced] = false
+        convert_codespan(el, opts)
+      end
+
       def convert_blockquote(el, opts)
         inner(el, opts)
       end
@@ -337,6 +342,32 @@ module TTY
         end
       end
 
+      def convert_math(el, opts)
+        if opts[:prev] && opts[:prev].type == :blank
+          indent = ' ' * @current_indent
+          opts[:result] << indent
+        end
+        convert_codespan(el, opts)
+        opts[:result] << "\n"
+      end
+
+      def convert_abbreviation(el, opts)
+        opts[:result] << el.value
+      end
+
+      def convert_typographic_sym(el, opts)
+        opts[:result] << TTY::Markdown.symbols[el.value]
+      end
+
+      def convert_entity(el, opts)
+        opts[:result] << unicode_char(el.value.code_point)
+      end
+
+      # Convert codepoint to UTF-8 representation
+      def unicode_char(codepoint)
+        [codepoint].pack('U*')
+      end
+
       def convert_footnote(*)
         warning("Footnotes are not supported")
       end
@@ -348,6 +379,10 @@ module TTY
       def convert_img(*)
         warning("Images are not supported")
       end
+
+      def convert_html_element(*)
+        warning("HTML elements are not supported")
+      end
     end # Parser
   end # Markdown
 end # TTY

data/lib/tty/markdown/syntax_highlighter.rb

@@ -47,7 +47,9 @@ module TTY
         lang = guess_lang(code)
         mode = options[:mode] || TTY::Color.mode
         lines = code.dup.lines
-        code = lines[1...-1].join + lines[-1].strip
+        if options[:fenced].nil?
+          code = lines[1...-1].join + lines[-1].strip
+        end
 
         lexer = Rouge::Lexer.find_fancy(lang, code) || Rouge::Lexers::PlainText
 

data/lib/tty/markdown/version.rb

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

data/tty-markdown.gemspec

@@ -20,12 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency "kramdown",   '~> 1.16.2'
   spec.add_dependency "pastel",     '~> 0.7.2'
   spec.add_dependency "rouge",      '~> 3.1.0'
   spec.add_dependency "strings",    '~> 0.1.0'
   spec.add_dependency "tty-color",  '~> 0.4.2'
-  spec.add_dependency "tty-screen", '~> 0.6.2'
+  spec.add_dependency "tty-screen", '~> 0.6.4'
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +160,8 @@ files:
 - bin/console
 - bin/setup
 - examples/example.md
+- examples/man.md
+- examples/man.rb
 - examples/marked.rb
 - lib/tty-markdown.rb
 - lib/tty/markdown.rb
@@ -182,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="