eskimo-ascii 3.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b68fb7c3d713145484543bb2e096e01327e510e9055e7349b9f1e0449415915e
+  data.tar.gz: 5475bd6c450f2fc8038578b9b26a1cf3d3020ef38141c0e644c6cfe6ad3c8315
+SHA512:
+  metadata.gz: 0d786f05a438ab22fe52a457fc95095cd6612badcdc0506b6101a14a214470ff7ff18967786bd51fdfb685e7df3be4ca39a0dcceb50122ac9961451b19986fd3
+  data.tar.gz: 870c65a3904e4456a64c0f1f9df061af84a02b8b5052b6db6df8b80cd308e34c4408a77b7da3672cec54a89874cf8535b401742a4417127d19ed89c55ae2f324

data/lib/eskimo/ascii.rb

@@ -0,0 +1,34 @@
+module Eskimo
+  module ASCII
+  end
+end
+
+begin
+  require 'did_you_mean'
+rescue LoadError
+end
+
+require 'pastel'
+require 'strings'
+require 'tty-screen'
+
+require 'eskimo/ascii/version'
+require 'eskimo/ascii/constants'
+require 'eskimo/ascii/component'
+require 'eskimo/ascii/components/did_you_mean'
+require 'eskimo/ascii/components/either'
+require 'eskimo/ascii/components/gutter'
+require 'eskimo/ascii/components/highlight'
+require 'eskimo/ascii/components/highlight_column'
+require 'eskimo/ascii/components/indent'
+require 'eskimo/ascii/components/line_break'
+require 'eskimo/ascii/components/soft_break'
+require 'eskimo/ascii/components/spacer'
+require 'eskimo/ascii/components/squeeze'
+require 'eskimo/ascii/components/strip'
+require 'eskimo/ascii/components/strip_left'
+require 'eskimo/ascii/components/strip_right'
+require 'eskimo/ascii/components/style'
+require 'eskimo/ascii/components/truncate'
+require 'eskimo/ascii/components/truncate_rear'
+require 'eskimo/ascii/components/wrap'

data/lib/eskimo/ascii/component.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# A base component class that renders child components defined in a block into
+# a String for further formatting.
+#
+#     class MyComponent < Eskimo::ASCII::Component
+#       def render(**)
+#         text = super
+#         text.is_a?(String) # => true
+#       end
+#     end
+#
+# Use of this class is optional. What's happening under the hood is:
+#
+# 1. Component maintains a reference to the Proc passed to {#initialize}. That
+#    Proc can potentially return a list of child components to render.
+#
+# 2. {Component#render} (called via "super" from sub-classes) invokes the
+#    `render` prop provided by {Core::Renderer#apply} with the tracked children
+#    which converts them to a String and returns them.
+class Eskimo::ASCII::Component
+  def initialize(*, **, &children_gen)
+    @children = children_gen
+  end
+
+  def render(render:, **)
+    render[@children]
+  end
+
+  protected
+
+  def pastel
+    @pastel ||= Pastel.new
+  end
+end

data/lib/eskimo/ascii/components/did_you_mean.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Present the user with the closest possible correction, if any.
+#
+#     DidYouMean.new(dictionary: [ 'abc', 'bca' ], item: 'abd')
+#     # => "hint: Did you mean? abc"
+#
+#     DidYouMean.new(dictionary: [ 'abc', 'bca' ], item: 'asdfasdf')
+#     # => ""
+#
+# See https://github.com/yuki24/did_you_mean#using-the-didyoumeanspellchecker
+class Eskimo::ASCII::DidYouMean < Eskimo::ASCII::Component
+  attr_reader :corrections, :separator
+
+  def initialize(dictionary:, item:, separator: " or ", &children)
+    @corrections = ::DidYouMean::SpellChecker.new(
+      dictionary: dictionary
+    ).correct(item)
+
+    @separator = separator
+
+    super
+  end
+
+  def render(**)
+    if corrections.any?
+      "Did you mean? #{corrections.join(separator)}"
+    end
+  end
+end

data/lib/eskimo/ascii/components/either.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Render a fallback component in case the first one evaluates to an empty
+# String.
+#
+#     Either.new(->(**) { false }, "Fallback here")
+#     # => "Fallback here"
+#
+#     Either.new(->(**) { "Hi!" }, "Fallback here")
+#     # => "Hi!"
+#
+class Eskimo::ASCII::Either
+  attr_reader :children
+
+  def initialize(primary, fallback)
+    @children = [ primary, fallback ]
+  end
+
+  def render(render:, **)
+    for child in children do
+      rendered = render[child]
+
+      return rendered unless rendered.empty?
+    end
+  end
+end

data/lib/eskimo/ascii/components/gutter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Prepend each line with a character or symbol.
+#
+#     Gutter.new(char: '| ') do
+#       [ "Hello", "\n", "World!" ]
+#     end
+#     # => "| Hello"
+#     #    "| World!"
+class Eskimo::ASCII::Gutter < Eskimo::ASCII::Component
+  attr_reader :char, :spacing
+
+  def initialize(char:, spacing: 0, &children)
+    @char = char
+    @spacing = spacing
+
+    super
+  end
+
+  def render(**)
+    spacer = Array.new(spacing, char)
+
+    [
+      *spacer,
+      super.lines.map { |s| s.prepend(char) }.join,
+      *spacer
+    ].join("\n")
+  end
+end

data/lib/eskimo/ascii/components/highlight.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Highlight a substring with ASCII arrows.
+#
+#    Highlight.new(pattern: /lol/) do
+#      "- include: lol://file.yml"
+#    end
+#    # => "- include: lol://file.yml"
+#    #                ^^^
+#
+class Eskimo::ASCII::Highlight < Eskimo::ASCII::Component
+  attr_reader :pastel, :pattern, :style
+
+  def initialize(pattern:, style: [:red, :bold, :underline], &children)
+    @pastel = Pastel.new
+    @pattern = pattern
+    @style = style
+
+    super(&children)
+  end
+
+  def render(**)
+    super.sub(pattern) do |substring|
+      pastel.decorate(substring, *style)
+    end
+  end
+end

data/lib/eskimo/ascii/components/highlight_column.rb

@@ -0,0 +1,57 @@
+# Highlight a particular character of a string with an ASCII arrow.
+#
+#     HighlightColumn.new(line: 0, column: 14) do
+#       "- include: lol://wut.yml"
+#     end
+#     => "- include: lol://wut.yml"
+#        "              ^         "
+#        "              here      "
+class Eskimo::ASCII::HighlightColumn < Eskimo::ASCII::Component
+  def initialize(
+    column:,
+    line:,
+    markers: ['^', 'here'],
+    style: [:bold, :red],
+    &children
+  )
+    pastel = Pastel.new
+
+    @colorize = ->(str) { pastel.decorate(str, *style) }
+    @column = column
+    @line = line
+    @marker_padding = ' ' * @column
+    @markers = markers
+
+    super
+  end
+
+  def render(**)
+    lines = super.lines
+    line = lines[@line]
+
+    unless line.nil? || line[@column].nil?
+      lines[@line] = transform_line!(line, @column, &@colorize)
+    end
+
+    lines.join
+  end
+
+  protected
+
+  def create_markers()
+    buf = ''
+
+    for marker in @markers do
+      buf << @marker_padding + @colorize[marker] + "\n"
+    end
+
+    buf
+  end
+
+  def transform_line!(line, column, &fn)
+    line[column] = fn[line[column]]
+    line << "\n" unless line.end_with?("\n")
+    line << create_markers
+    line
+  end
+end

data/lib/eskimo/ascii/components/indent.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Indent text from the left.
+#
+#     Indent.new(width: 8) do
+#       [ "Hello", SoftBreak.new, "World!" ]
+#     end
+#     # => "        Hello"
+#     #    "        World!"
+class Eskimo::ASCII::Indent < Eskimo::ASCII::Component
+  attr_reader :width
+
+  def initialize(width: 4, &children)
+    @width = width
+    super
+  end
+
+  def render(**)
+    Strings.pad(super, [0,0,0,width])
+  end
+end

data/lib/eskimo/ascii/components/line_break.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Insert a paragraph-like line-break.
+#
+#     [ "Hello", LineBreak.new, "World!" ]
+#     # => "Hello"
+#     #    ""
+#     #    ""
+#     #    "World!"
+class Eskimo::ASCII::LineBreak
+  def render(**)
+    "\n \n"
+  end
+end

data/lib/eskimo/ascii/components/soft_break.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Insert a soft line-break.
+#
+#     [ "Hello", SoftBreak.new, "World!" ]
+#     # => "Hello"
+#     #    "World!"
+class Eskimo::ASCII::SoftBreak
+  def render(**)
+    "\n"
+  end
+end

data/lib/eskimo/ascii/components/spacer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Space consecutive components with soft breaks.
+#
+#     Spacer.new([
+#       "Hello",
+#       "World!"
+#     ])
+#     # => "Hello"
+#     #    "World!"
+#
+# The soft breaks for each conditional component will be preserved only
+# if they do render some content.
+class Eskimo::ASCII::Spacer
+  def initialize(children)
+    if !children.is_a?(Array) || block_given?
+      raise ArgumentError.new("Spacer works only with an Array of components")
+    end
+
+    @children = children
+  end
+
+  def render(**props)
+    rendered = @children.map(&props[:render])
+
+    without_blanks = rendered.reject(&:empty?)
+    without_blanks.join("\n")
+  end
+end

data/lib/eskimo/ascii/components/squeeze.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Squeeze immediate consecutive soft breaks.
+#
+#     Squeeze.new do
+#       [
+#         SoftBreak.new,
+#         ConditionalComponent.new,
+#
+#         SoftBreak.new,
+#         false && SomeOtherComponent.new,
+#
+#         SoftBreak.new,
+#         'hello',
+#       ]
+#      end
+#      # => ""
+#      #    "hello"
+#
+# The soft breaks for each conditional component will be preserved only
+# if they do render some content.
+class Eskimo::ASCII::Squeeze
+  def initialize(children)
+    if !children.is_a?(Array) || block_given?
+      raise ArgumentError.new("Squeeze works only with an Array of components")
+    end
+
+    @children = children
+  end
+
+  def render(**props)
+    rendered = @children.map(&props[:render])
+
+    without_blanks = rendered.reject(&:empty?)
+    without_blanks.reject.with_index do |element, index|
+      element == "\n" && without_blanks[index+1] == "\n"
+    end
+  end
+end

data/lib/eskimo/ascii/components/strip.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Remove surrounding whitespace.
+#
+#     Strip.new { "  hello world  " }
+#     # => "hello world"
+class Eskimo::ASCII::Strip < Eskimo::ASCII::Component
+  def render(**)
+    super.strip
+  end
+end

data/lib/eskimo/ascii/components/strip_left.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Remove whitespace from the beginning.
+#
+#     StripLeft.new { "  hello world  " }
+#     # => "hello world  "
+class Eskimo::ASCII::StripLeft < Eskimo::ASCII::Component
+  def render(**)
+    super.lstrip
+  end
+end

data/lib/eskimo/ascii/components/strip_right.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Remove whitespace from the end.
+#
+#     StripRight.new { "  hello world  " }
+#     # => "  hello world"
+class Eskimo::ASCII::StripRight < Eskimo::ASCII::Component
+  def render(**)
+    super.rstrip
+  end
+end

data/lib/eskimo/ascii/components/style.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Style text with colors and custom formatting.
+#
+# See [Pastel's documentation][pastel] for the accepted styles.
+#
+# [pastel]: https://github.com/piotrmurach/pastel
+class Eskimo::ASCII::Style < Eskimo::ASCII::Component
+  attr_reader :pastel, :style
+
+  def initialize(*style, &children)
+    @style = style.flatten
+    @pastel = Pastel.new
+
+    super
+  end
+
+  def render(**)
+    pastel.decorate(super, *style)
+  end
+end

data/lib/eskimo/ascii/components/truncate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Truncate text from the beginning if it exceeds a certain width.
+#
+#     Truncate.new(width: 3) do
+#       "foo bar"
+#     end
+#     # => "... bar"
+class Eskimo::ASCII::Truncate < Eskimo::ASCII::Component
+  attr_reader :maxlen
+
+  def initialize(reserve: 0, width: Constants::SCREEN_COLUMNS, &children)
+    @maxlen = [0, width - reserve].max
+
+    super
+  end
+
+  def render(**)
+    text = super
+
+    if text.length >= maxlen
+      '...' + text[text.length - maxlen - 1 .. -1]
+    else
+      text
+    end
+  end
+end

data/lib/eskimo/ascii/components/truncate_rear.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eskimo/ascii/components/truncate'
+
+# Truncate text from the rear if it exceeds a certain width.
+#
+#     TruncateRear.new(width: 3) do
+#       "foo bar"
+#     end
+#     # => "foo..."
+class Eskimo::ASCII::TruncateRear < Eskimo::ASCII::Truncate
+  def render(render:, **)
+    text = render[@children]
+
+    if text.length >= maxlen
+      text[0..maxlen - 1] + '...'
+    else
+      text
+    end
+  end
+end

data/lib/eskimo/ascii/components/wrap.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Wrap a block text with newlines at a certain threshold.
+#
+#     Wrap.new(width: 3) do
+#       "foobar"
+#     end
+#     # => "foo"
+#     #    "bar"
+#
+module Eskimo::ASCII
+  class Wrap < Component
+    attr_reader :width
+
+    def initialize(width: Constants::SCREEN_COLUMNS, &children)
+      @width = width
+      super
+    end
+
+    def render(**)
+      Strings.wrap(super, width)
+    end
+  end
+end

data/lib/eskimo/ascii/constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Eskimo::ASCII::Constants
+  SCREEN_COLUMNS = [TTY::Screen.width, 72].min
+end

data/lib/eskimo/ascii/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module ASCII
+    VERSION = '3.0.0.pre.1'
+  end
+end

data/spec/component_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Component do
+  it 'accepts a block of children' do
+    expect(
+      Eskimo::Core::Renderer.new.apply {
+        Eskimo::ASCII::Component.new { ['hello', "\n", 'world!'] }
+      }
+    ).to eq("hello\nworld!")
+  end
+end

data/spec/components/did_you_mean_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::DidYouMean do
+  it 'renders a suggestion' do
+    expect(
+      renderer.apply {
+        described_class.new(dictionary: [ 'abc', 'bca' ], item: 'abd')
+      }
+    ).to eq("Did you mean? abc")
+  end
+
+  it 'renders nothing if no suggestions were found' do
+    expect(
+      renderer.apply {
+        described_class.new(dictionary: [ 'abc', 'bca' ], item: 'asdf')
+      }
+    ).to eq("")
+  end
+end

data/spec/components/either_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Either do
+  it 'renders the primary component' do
+    expect(
+      renderer.apply {
+        described_class.new(->(**) { false }, "Fallback here")
+      }
+    ).to eq("Fallback here")
+  end
+
+  it 'renders the fallback if the primary does not' do
+    expect(
+      renderer.apply {
+        described_class.new(->(**) { "Hi!" }, "Fallback here")
+      }
+    ).to eq("Hi!")
+  end
+end

data/spec/components/gutter_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Gutter do
+  it 'prepends each line with the character' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Gutter.new(char: '| ') do
+          "hello\nworld"
+        end
+      end
+    ).to eq("| hello\n| world")
+  end
+
+  it 'inserts surrounding whitespace' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Gutter.new(char: '| ', spacing: 2) do
+          "hello\nworld"
+        end
+      end
+    ).to eq("| \n| \n| hello\n| world\n| \n| ")
+  end
+end

data/spec/components/highlight_column_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::HighlightColumn do
+  it 'highlights the character' do
+    style = [ :bold, :red ]
+
+    expect(
+      renderer.apply {
+        described_class.new(column: 1, line: 1, style: style) { "number:\nfour" }
+      }
+    ).to include("f#{pastel.decorate('o', *style)}ur")
+  end
+
+  it 'highlights the first character' do
+    style = [ :bold, :red ]
+
+    expect(
+      renderer.apply {
+        described_class.new(column: 0, line: 0, style: style) { "four" }
+      }
+    ).to include("#{pastel.decorate('f', *style)}our")
+  end
+
+  it 'highlights the last character' do
+    style = [ :bold, :red ]
+
+    expect(
+      renderer.apply {
+        described_class.new(column: 3, line: 0, style: style) { "four" }
+      }
+    ).to include("fou#{pastel.decorate('r', *style)}")
+  end
+
+  it 'highlights nothing' do
+    expect(
+      renderer.apply {
+        described_class.new(column: 1234, line: 0) { "four" }
+      }
+    ).to eq("four")
+
+    expect(
+      renderer.apply {
+        described_class.new(column: 0, line: 1234) { "four" }
+      }
+    ).to eq("four")
+  end
+
+  it 'inserts the arrow' do
+    expect(
+      strip_styles(
+        renderer.apply {
+          described_class.new(column: 1, line: 0) { "four" }
+        }
+      )
+    ).to eq(
+      "four"  + "\n" +
+      " ^"    + "\n" +
+      " here" + "\n"
+    )
+  end
+end

data/spec/components/highlight_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Highlight do
+  it 'styles a substring' do
+    style = [ :bold, :red ]
+
+    expect(
+      renderer.apply {
+        described_class.new(pattern: /ou/, style: style) { 'four' }
+      }
+    ).to eq("f#{Pastel.new.decorate('ou', *style)}r")
+  end
+
+  it 'is a no-op if no match' do
+    input = 'four'
+
+    expect(
+      renderer.apply {
+        described_class.new(pattern: /asdf/) { input }
+      }
+    ).to eq(input)
+  end
+end

data/spec/components/indent_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Indent do
+  it 'indents each line' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Indent.new(width: 2) do
+          "hello\nworld"
+        end
+      end
+    ).to eq("  hello\n  world")
+  end
+end

data/spec/components/line_break_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::LineBreak do
+  it 'inserts a hard linebreak' do
+    expect(
+      renderer.apply {
+        [
+          'hello',
+          Eskimo::ASCII::LineBreak.new,
+          'world'
+        ]
+      }
+    ).to eq("hello\n \nworld")
+  end
+end

data/spec/components/soft_break_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::SoftBreak do
+  it 'inserts a soft linebreak' do
+    expect(
+      renderer.apply {
+        [
+          'hello',
+          Eskimo::ASCII::SoftBreak.new,
+          'world'
+        ]
+      }
+    ).to eq("hello\nworld")
+  end
+end

data/spec/components/spacer_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Spacer do
+  it 'inserts newlines between components' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Spacer.new([
+          "Hello",
+          "World!"
+        ])
+      end
+    ).to eq("Hello\nWorld!")
+  end
+
+  it 'ignores falsey components' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Spacer.new([
+          "Hello",
+          false && 'hi',
+          false && 'ho',
+          "World!",
+          false && 'yup'
+        ])
+      end
+    ).to eq("Hello\nWorld!")
+  end
+
+  it 'bails if not given an array of children' do
+    expect { Eskimo::ASCII::Spacer.new('') }.to raise_error(ArgumentError,
+      "Spacer works only with an Array of components"
+    )
+  end
+
+  it 'bails if given a block' do
+    expect { Eskimo::ASCII::Spacer.new([]) {} }.to raise_error(ArgumentError,
+      "Spacer works only with an Array of components"
+    )
+  end
+end

data/spec/components/squeeze_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Squeeze do
+  it 'swallows consecutive newlines' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Squeeze.new([
+          Eskimo::ASCII::SoftBreak.new,
+          false && '1',
+
+          Eskimo::ASCII::SoftBreak.new,
+          false && '2',
+
+          Eskimo::ASCII::SoftBreak.new,
+          '3',
+
+          Eskimo::ASCII::SoftBreak.new,
+          '4',
+        ])
+      end
+    ).to eq("\n3\n4")
+  end
+
+  it 'does not swallow consecutive newlines in inner children' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Squeeze.new([
+          Eskimo::ASCII::Indent.new(width: 0) do
+            [
+              Eskimo::ASCII::SoftBreak.new,
+              false && '1',
+
+              Eskimo::ASCII::SoftBreak.new,
+              false && '2',
+
+              Eskimo::ASCII::SoftBreak.new,
+              '3',
+
+              Eskimo::ASCII::SoftBreak.new,
+              '4',
+            ]
+          end
+        ])
+      end
+    ).to eq("\n\n\n3\n4")
+  end
+
+  it 'bails if not given an array of children' do
+    expect { Eskimo::ASCII::Squeeze.new('') }.to raise_error(ArgumentError,
+      "Squeeze works only with an Array of components"
+    )
+  end
+
+  it 'bails if given a block' do
+    expect { Eskimo::ASCII::Squeeze.new([]) {} }.to raise_error(ArgumentError,
+      "Squeeze works only with an Array of components"
+    )
+  end
+end

data/spec/components/strip_left_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::StripLeft do
+  it 'strips whitespace from the head' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::StripLeft.new do
+          "  hello world  "
+        end
+      end
+    ).to eq("hello world  ")
+  end
+end

data/spec/components/strip_right_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::StripRight do
+  it 'strips whitespace from the rear' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::StripRight.new do
+          "  hello world  "
+        end
+      end
+    ).to eq("  hello world")
+  end
+end

data/spec/components/strip_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Strip do
+  it 'strips surrounding whitespace' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Strip.new do
+          "  hello world  "
+        end
+      end
+    ).to eq("hello world")
+  end
+end

data/spec/components/style_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Style do
+  it 'applies ANSI styling to text' do
+    expect(
+      renderer.apply {
+        [
+          Eskimo::ASCII::Style.new([:bold, :green]) { 'hai' },
+        ]
+      }
+    ).to eq("\e[1;32mhai\e[0m")
+  end
+
+  it 'accepts a splat' do
+    expect(
+      renderer.apply {
+        [
+          Eskimo::ASCII::Style.new(:bold, :green) { 'hai' },
+        ]
+      }
+    ).to eq("\e[1;32mhai\e[0m")
+  end
+end

data/spec/components/truncate_rear_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::TruncateRear do
+  it 'truncates a string from the rear if it exceeds the length' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::TruncateRear.new(width: 5) do
+          "hello world"
+        end
+      end
+    ).to eq("hello...")
+  end
+
+  it 'reserves chars from the width' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::TruncateRear.new(width: 10, reserve: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("hello...")
+  end
+
+  it 'is a no-op if text fits' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::TruncateRear.new(width: 62, reserve: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("hello world")
+  end
+end

data/spec/components/truncate_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Truncate do
+  it 'truncates a string from the beginning if it exceeds the length' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Truncate.new(width: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("... world")
+  end
+
+  it 'reserves chars from the width' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Truncate.new(width: 10, reserve: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("... world")
+  end
+
+  it 'is a no-op if text fits' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Truncate.new(width: 62, reserve: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("hello world")
+  end
+end

data/spec/components/wrap_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::ASCII::Wrap do
+  it 'wraps text' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Wrap.new(width: 5) do
+          'hello world'
+        end
+      end
+    ).to eq("\nhello \nworld")
+  end
+
+  it 'defaults to the screen width' do
+    expect(
+      renderer.apply do
+        Eskimo::ASCII::Wrap.new do
+          'hello world'
+        end
+      end
+    ).to eq("hello world")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter(%r{/spec/})
+  coverage_dir("#{ENV.fetch('COVERAGE_DIR', 'coverage')}")
+end
+
+require 'eskimo/core'
+require 'eskimo/ascii'
+require_relative './support/component_suite'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+  config.define_derived_metadata(file_path: %r{/spec/components/}) do |metadata|
+    metadata[:type] = :component
+  end
+
+  config.include EskimoASCIITest::ComponentSuite, type: :component
+
+  Kernel.srand config.seed
+end

data/spec/support/component_suite.rb

@@ -0,0 +1,15 @@
+module EskimoASCIITest
+  module ComponentSuite
+    def renderer
+      @renderer ||= Eskimo::Core::Renderer.new
+    end
+
+    def strip_styles(string)
+      pastel.strip(string)
+    end
+
+    def pastel
+      @pastel ||= Pastel.new
+    end
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: eskimo-ascii
+version: !ruby/object:Gem::Version
+  version: 3.0.0.pre.1
+platform: ruby
+authors:
+- Ahmad Amireh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eskimo-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Format text for humans using a declarative, extensible API.
+email: ahmad@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eskimo/ascii.rb
+- lib/eskimo/ascii/component.rb
+- lib/eskimo/ascii/components/did_you_mean.rb
+- lib/eskimo/ascii/components/either.rb
+- lib/eskimo/ascii/components/gutter.rb
+- lib/eskimo/ascii/components/highlight.rb
+- lib/eskimo/ascii/components/highlight_column.rb
+- lib/eskimo/ascii/components/indent.rb
+- lib/eskimo/ascii/components/line_break.rb
+- lib/eskimo/ascii/components/soft_break.rb
+- lib/eskimo/ascii/components/spacer.rb
+- lib/eskimo/ascii/components/squeeze.rb
+- lib/eskimo/ascii/components/strip.rb
+- lib/eskimo/ascii/components/strip_left.rb
+- lib/eskimo/ascii/components/strip_right.rb
+- lib/eskimo/ascii/components/style.rb
+- lib/eskimo/ascii/components/truncate.rb
+- lib/eskimo/ascii/components/truncate_rear.rb
+- lib/eskimo/ascii/components/wrap.rb
+- lib/eskimo/ascii/constants.rb
+- lib/eskimo/ascii/version.rb
+- spec/component_spec.rb
+- spec/components/did_you_mean_spec.rb
+- spec/components/either_spec.rb
+- spec/components/gutter_spec.rb
+- spec/components/highlight_column_spec.rb
+- spec/components/highlight_spec.rb
+- spec/components/indent_spec.rb
+- spec/components/line_break_spec.rb
+- spec/components/soft_break_spec.rb
+- spec/components/spacer_spec.rb
+- spec/components/squeeze_spec.rb
+- spec/components/strip_left_spec.rb
+- spec/components/strip_right_spec.rb
+- spec/components/strip_spec.rb
+- spec/components/style_spec.rb
+- spec/components/truncate_rear_spec.rb
+- spec/components/truncate_spec.rb
+- spec/components/wrap_spec.rb
+- spec/spec_helper.rb
+- spec/support/component_suite.rb
+homepage: https://github.com/amireh/eskimo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Declarative text formatting
+test_files:
+- spec/spec_helper.rb
+- spec/component_spec.rb
+- spec/components/strip_spec.rb
+- spec/components/soft_break_spec.rb
+- spec/components/did_you_mean_spec.rb
+- spec/components/truncate_rear_spec.rb
+- spec/components/wrap_spec.rb
+- spec/components/strip_left_spec.rb
+- spec/components/squeeze_spec.rb
+- spec/components/either_spec.rb
+- spec/components/style_spec.rb
+- spec/components/indent_spec.rb
+- spec/components/highlight_column_spec.rb
+- spec/components/strip_right_spec.rb
+- spec/components/gutter_spec.rb
+- spec/components/truncate_spec.rb
+- spec/components/line_break_spec.rb
+- spec/components/spacer_spec.rb
+- spec/components/highlight_spec.rb
+- spec/support/component_suite.rb