eskimo 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5912c4b1987656f45fa2fc0beb17228f1cc967db41c084675774baf24167bb9f
-  data.tar.gz: d8f3d3d02a29fabd13444207a972e3f92e0403d1ff5612d4fc40876e1dc349d6
+  metadata.gz: 7882c146ce7e288df43b38765be92f216137d746c1efb13cf76b1ac7e1ec13ad
+  data.tar.gz: 1e2bff1433d29f448a74bf39b54b083b6bc79869af86b00c293fefaa09493624
 SHA512:
-  metadata.gz: fa006a58bbd5ad12d24e52a3401ed14d7ecc8a98cc5e494856dcba95666df4ff3be54eab24902e8167d687f7e6d8daca5e3d33da90ddf67efdce6cc2e87cab01
-  data.tar.gz: 4c249f2b9b14cc4521b516ba78c0f1bbbbf7454600888a4eaab4ce55492f9e51447e48897be98d47c1d639b0a41fc70c2febbed6be955a0d978bcebcd2592f87
+  metadata.gz: 77d8528c5d5f839c7bbf8daf9bb049fe752c5077b34107e007bdba14b1192723760763750ea4061d2a4e60bf8573c11133ff3d174363d3eadb8f2fe1252eaa11
+  data.tar.gz: 8dfa377b6eb2e05e09eb8e5d70b2a747fc5b9073e5859055145bf66c413e3051239ea55ca9d386936ee5905e1382dd2938140c512aaf4360af9010fb16986a49

data/lib/eskimo.rb

@@ -2,9 +2,25 @@ require 'pastel'
 require 'strings'
 require 'tty-screen'
 
-require_relative './eskimo/version'
+require 'eskimo/version'
 
-require_relative './eskimo/component'
-require_relative './eskimo/renderer'
+require 'eskimo/constants'
 
-require_relative './eskimo/components'
+require 'eskimo/component'
+require 'eskimo/renderer'
+
+require 'eskimo/components/did_you_mean'
+require 'eskimo/components/either'
+require 'eskimo/components/highlight'
+require 'eskimo/components/highlight_column'
+require 'eskimo/components/indent'
+require 'eskimo/components/line_break'
+require 'eskimo/components/soft_break'
+require 'eskimo/components/squeeze'
+require 'eskimo/components/strip'
+require 'eskimo/components/strip_left'
+require 'eskimo/components/strip_right'
+require 'eskimo/components/style'
+require 'eskimo/components/truncate'
+require 'eskimo/components/truncate_rear'
+require 'eskimo/components/wrap'

data/lib/eskimo/component.rb

@@ -20,8 +20,8 @@ module Eskimo
   #    `render` prop provided by {Renderer#apply} with the tracked children
   #    which converts them to a String and returns them.
   class Component
-    def initialize(&children)
-      @children = children
+    def initialize(*, **, &children_gen)
+      @children = children_gen
     end
 
     def render(render:, **)

data/lib/eskimo/components/did_you_mean.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # 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 DidYouMean < 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
+  end
+end

data/lib/eskimo/components/either.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # 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 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
+  end
+end

data/lib/eskimo/components/highlight.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # Highlight a substring with ASCII arrows.
+    #
+    #    Highlight.new(pattern: /lol/) do
+    #      "- include: lol://file.yml"
+    #    end
+    #    # => "- include: lol://file.yml"
+    #    #                ^^^
+    #
+    class Highlight < 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
+  end
+end

data/lib/eskimo/components/highlight_column.rb

@@ -0,0 +1,61 @@
+module Eskimo
+  module Components
+    # 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 HighlightColumn < 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
+  end
+end

data/lib/eskimo/components/indent.rb

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

data/lib/eskimo/components/line_break.rb

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

data/lib/eskimo/components/soft_break.rb

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

data/lib/eskimo/components/squeeze.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # 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 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
+  end
+end

data/lib/eskimo/components/strip.rb

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

data/lib/eskimo/components/strip_left.rb

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

data/lib/eskimo/components/strip_right.rb

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

data/lib/eskimo/components/style.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # Style text with colors and custom formatting.
+    #
+    # See [Pastel's documentation][pastel] for the accepted styles.
+    #
+    # [pastel]: https://github.com/piotrmurach/pastel
+    class Style < 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
+  end
+end

data/lib/eskimo/components/truncate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Components
+    # Truncate text from the beginning if it exceeds a certain width.
+    #
+    #     Truncate.new(width: 3) do
+    #       "foo bar"
+    #     end
+    #     # => "... bar"
+    class Truncate < 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
+  end
+end

data/lib/eskimo/components/truncate_rear.rb

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