downterm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbe4f92ac149f0ad1ecf96b5107fc0b8a7300cf3
+  data.tar.gz: 64307764bded34852704a7df86054ec4cb3cc0ce
+SHA512:
+  metadata.gz: f2070bfdeb9cdde7477d44d40807ff1f74e4825abd6f21d7a3eb9e974583afa6d074c31c990679bab84b089626acf9f6069132f14e6be338648d88e76e680241
+  data.tar.gz: 521a3db1984a2d3f9711bd9ee4493215757a5bf5fe879086ebd9c014b870d10ce338790960d2067fd1a44b66b24e70da1ccde047f36cfeda9bb726e796427c27

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+/.bundle/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usaidwat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Michael Dippery
+
+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/Rakefile

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'downterm/version'
+
+GEMSPEC = `git ls-files | grep gemspec`.chomp
+GEM     = "downterm-#{Downterm::VERSION}.gem"
+
+desc "Build downterm.gem"
+task :build => :perms do
+  system "gem", "build", GEMSPEC
+end
+
+desc "Ensure correct permissions for downterm.gem"
+task :perms do
+  system "chmod", "-R", "a+rX", *`git ls-files`.chomp.split("\n")
+end
+
+desc "Install downterm.gem"
+task :install => :build do
+  system "gem", "install", GEM
+end
+
+desc "Push gem to RubyGems"
+task :release => :build do
+  system "git", "tag", "-s", "-m", "downterm v#{Downterm::VERSION}", "v#{Downterm::VERSION}"
+  system "gem", "push", GEM
+end
+
+desc "Clean built products"
+task :clean do
+  rm Dir.glob("*.gem"), :verbose => true
+end
+
+task :default => :build

data/downterm.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'downterm/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'downterm'
+  gem.version       = Downterm::VERSION
+  gem.licenses      = ['MIT']
+  gem.authors       = ['Michael Dippery']
+  gem.email         = ['michael@monkey-robot.com']
+  gem.homepage      = 'https://github.com/mdippery/downterm'
+  gem.description   = 'Converts Markdown into text suitable for output to a terminal'
+  gem.summary       = 'Converts Markdown into text suitable for output to a terminal'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_runtime_dependency('highline', '~> 1.7')
+  gem.add_runtime_dependency('rainbow', '~> 2.0')
+  gem.add_runtime_dependency('redcarpet', '~> 3.3')
+
+  gem.add_development_dependency('rspec', '~> 3.3')
+end

data/lib/downterm.rb

@@ -0,0 +1,2 @@
+require 'downterm/render'
+require 'downterm/version'

data/lib/downterm/render.rb

@@ -0,0 +1,119 @@
+require 'highline'
+require 'rainbow'
+require 'redcarpet'
+
+module Downterm
+  module Render
+    class Terminal < Redcarpet::Render::Base
+      def paragraph(text)
+        "#{text}\n\n"
+      end
+
+      def normal_text(text)
+        text
+      end
+
+      def linebreak
+        "\n"
+      end
+
+      def header(text, header_level)
+        "#{'#' * header_level} #{text}\n\n"
+      end
+
+      def entity(text)
+        case text
+        when "&gt;"  then return ">"
+        when "&lt;"  then return "<"
+        when "&amp;" then return "&"
+        else              return text
+        end
+      end
+
+      def emphasis(text)
+        Rainbow(text).underline.to_s
+      end
+
+      def double_emphasis(text)
+        Rainbow(text).bright.to_s
+      end
+
+      def triple_emphasis(text)
+        Rainbow(text).bright.underline.to_s
+      end
+
+      def link(link, link_title, content)
+        "#{Rainbow(content).underline} <#{link}>"
+      end
+
+      def autolink(link, link_type)
+        Rainbow(link).underline.to_s
+      end
+
+      def image(link, title, content)
+        Rainbow(link).underline.to_s
+      end
+
+      def codespan(code)
+        "`#{code}`"
+      end
+
+      def block_code(code, language)
+        code.split("\n").map { |line| "    #{line}"}.join("\n")
+      end
+
+      def block_quote(quote)
+        quote.split("\n").map { |line| "> #{line}" }.join("\n")
+      end
+
+      def block_html(raw_html)
+        raw_html
+      end
+
+      def raw_html(raw_html)
+        raw_html
+      end
+
+      def strikethrough(text)
+        text
+      end
+
+      def superscript(text)
+        if text.length > 1
+          "^(#{text})"
+        else
+          "^#{text}"
+        end
+      end
+
+      def list(contents, list_type)
+        case list_type
+        when :unordered then return contents
+        when :ordered   then return number_list(contents.split("\n")).join("\n")
+        end
+      end
+
+      def list_item(text, list_type)
+        case list_type
+        when :unordered then return "* #{text}"
+        when :ordered   then return "#{text}"
+        end
+      end
+
+      def hrule
+        '-' * HighLine::SystemExtensions.terminal_size[0] + "\n\n"
+      end
+
+      def postprocess(full_document)
+        full_document.rstrip
+      end
+
+      private
+
+      def number_list(items)
+        width = items.count.to_s.length
+        (1..items.count).zip(items).map { |e| sprintf("%*d. %s", width, e[0], e[1]) }
+      end
+    end
+  end
+end

data/lib/downterm/version.rb

@@ -0,0 +1,3 @@
+module Downterm
+  VERSION = "0.1.0"
+end

data/spec/downterm/render_spec.rb

@@ -0,0 +1,286 @@
+require 'spec_helper'
+
+module Downterm
+  module Render
+    describe Terminal do
+      let(:terminal) { Terminal.new }
+      let(:markdown) { Redcarpet::Markdown.new(terminal, :autolink => true,
+                                                         :strikethrough => true,
+                                                         :superscript => true) }
+
+      describe 'emphasized text' do
+        it 'is underlined' do
+          md = 'the word *italicized* is italicized'
+          expected = "the word #{Rainbow("italicized").underline} is italicized"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is underlined when delineated by underscores' do
+          md = 'the word _italicized_ is italicized'
+          expected = "the word #{Rainbow("italicized").underline} is italicized"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is bolded when it is doubly emphasized' do
+          md = 'the word **emphasized** is bolded'
+          expected = "the word #{Rainbow("emphasized").bright} is bolded"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is bolded and underlined when triply emphasized' do
+          md = 'the word ***emphasized*** is emphatic'
+          expected = "the word #{Rainbow("emphasized").bright.underline} is emphatic"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'superscript text' do
+        it 'is rendered verbatim' do
+          md = 'e = mc^2'
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is rendered verbatim even when consisting of multiple characters' do
+          md = 'this gem is really cool^(not)'
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a list' do
+        it 'is rendered verbatim when ordered' do
+          md = [
+            'This is a list:',
+            '',
+            '1. Item 1',
+            '2. Item 2',
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is rendered verbatim when unordered' do
+          md = [
+            'This is a list:',
+            '',
+            '* Item 1',
+            '* Item 2',
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is right-aligned' do
+          md = [
+            'This is a list:',
+            '',
+            '1. Item 1',
+            '2. Item 2',
+            '3. Item 3',
+            '4. Item 4',
+            '5. Item 5',
+            '6. Item 6',
+            '7. Item 7',
+            '8. Item 8',
+            '9. Item 9',
+            '10. Item 10',
+            '11. Item 11',
+          ].join("\n")
+          expected = [
+            'This is a list:',
+            '',
+            ' 1. Item 1',
+            ' 2. Item 2',
+            ' 3. Item 3',
+            ' 4. Item 4',
+            ' 5. Item 5',
+            ' 6. Item 6',
+            ' 7. Item 7',
+            ' 8. Item 8',
+            ' 9. Item 9',
+            '10. Item 10',
+            '11. Item 11',
+          ].join("\n")
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'code' do
+        it 'is rendered verbatim when inline' do
+          md = '`import antigravity`'
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is rendered verbatim when in a block' do
+          md = [
+            %q(This is some code:),
+            %q(),
+            %q(    import antigravity),
+            %q(    puts "I'm using Python!"),
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a horizontal rule' do
+        it 'is rendered as a series of dashes across the terminal' do
+          md = [
+            'This is some text',
+            '',
+            '---',
+            '',
+            'This is some more text',
+          ].join("\n")
+          expected = [
+            'This is some text',
+            '',
+            '-' * HighLine::SystemExtensions.terminal_size[0],
+            '',
+            'This is some more text',
+          ].join("\n")
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a quote' do
+        it 'is rendered verbatim' do
+          md = [
+            'This is a cool quote:',
+            '',
+            '> One, two! One, two! And through and through',
+            '> The vorpal blade went snicker-snack!',
+            '> He left it dead, and with its head',
+            '> He went galumphing back',
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'strikethrough text' do
+        it 'is rendered dimmer than surrounding text' do
+          md = 'today is ~~beautiful~~ grey'
+          expected = "today is beautiful grey"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'an image' do
+        it 'is printed as a link to the image file' do
+          md = '![Michael](http://monkey-robot.com/static/images/michael.png)'
+          expected = "#{Rainbow('http://monkey-robot.com/static/images/michael.png').underline}"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a link' do
+        it 'is formatted when it has a title' do
+          md = 'check out [my blog](http://monkey-robot.com/) please!'
+          expected = "check out #{Rainbow("my blog").underline} <http://monkey-robot.com/> please!"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is formatted when it is created automatically' do
+          md = 'check out http://monkey-robot.com/'
+          expected = "check out #{Rainbow("http://monkey-robot.com/").underline}"
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'an entity' do
+        it 'is converted from &gt; to >' do
+          md = '-&gt; look at this!'
+          expected = '-> look at this!'
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is converted from &lt; to <' do
+          md = 'left &lt;&lt; shift'
+          expected = 'left << shift'
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is converted from &amp; to &' do
+          md = 'i like cake &amp; ice cream'
+          expected = 'i like cake & ice cream'
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'HTML' do
+        it 'is rendered verbatim when in a block' do
+          md = [
+            'This is some HTML:',
+            '',
+            '<div><p><strong>This is HTML!</strong></p></div>',
+            '',
+            "And now we're back to plaintext.",
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+
+        it 'is rendered verbatim when inline' do
+          md = '<strong>This is HTML!</strong>'
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a header' do
+        it 'is rendered verbatim' do
+          md = [
+            "Here's some text",
+            '',
+            '## Header 2',
+            '',
+            'And now a new section',
+          ].join("\n")
+          expected = md
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+
+      describe 'a linebreak' do
+        it 'is rendered as a new line' do
+          md = [
+            'Line 1  ',
+            'Line 2',
+          ].join("\n")
+          expected = [
+            'Line 1',
+            'Line 2',
+          ].join("\n")
+          actual = markdown.render(md)
+          expect(actual).to eq(expected)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'highline'
+require 'rainbow'
+require 'redcarpet'
+require 'downterm'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: downterm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Dippery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Converts Markdown into text suitable for output to a terminal
+email:
+- michael@monkey-robot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- downterm.gemspec
+- lib/downterm.rb
+- lib/downterm/render.rb
+- lib/downterm/version.rb
+- spec/downterm/render_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mdippery/downterm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Converts Markdown into text suitable for output to a terminal
+test_files:
+- spec/downterm/render_spec.rb
+- spec/spec_helper.rb