tty-markdown 0.3.0 → 0.7.0

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module TTY
   module Markdown
-    VERSION = '0.3.0'.freeze
+    VERSION = "0.7.0"
   end # TTY
 end # Markdown

metadata

@@ -1,183 +1,162 @@
 --- !ruby/object:Gem::Specification
 name: tty-markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2020-09-03 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.1.0
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: strings
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: tty-color
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: tty-screen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
-- !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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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: []
+email:
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- 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/example.md
-- examples/man.md
-- 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
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-markdown.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+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:
@@ -193,8 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Convert a markdown text or document into a terminal friendly output.

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/Gemfile.lock
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,23 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-before_install: "gem update bundler"
-script: "bundle exec rake ci"
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.8
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - ruby-head
-  - jruby-9000
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-  fast_finish: true
-branches:
-  only: master

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/