eskimo 2.2.0 → 3.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d629a2f286509a9570b4c8ec88f6d66e9847b22b72819cbb26adf6a630b2d2f
-  data.tar.gz: d0c95754c2fd8ef5f1da4eef9cb6414cd39dfd6aa84106ccbd6f97ada48ffdb4
+  metadata.gz: 63db1249016831d72313af0aefc2649668c5ac0d770e24d5631104128e2c0f7e
+  data.tar.gz: 14029a203ed7add511824bcbd7292fa21d2ff866974681bd3b9b3af25de9d8f3
 SHA512:
-  metadata.gz: 9240085b1d7706cefb64ec44554c200c3332cf4c02564ca32a3f76d2c99e6cc05590f2808c81e2c0741b69e09d3b33d5294ade803dcb3c459dd493f4c968a8cb
-  data.tar.gz: ca2e5206b063d907d55432ba5549aeaba4841750ce1d34fa638d0fb490cb96b72ab7481e5c5436375865fa5afc030b3729b4e5f644928e0f4a70bb36f30da18d
+  metadata.gz: 4046ddc0ddd132b3b9d27e896006191eb3aa6f007d31358ee0c78bcd6dbffe62b56b1a5e227031cf537dfc3862d82e4d3d2dc3344246ef65eb71e312021ca973
+  data.tar.gz: a4e31cbdc4a850ae81c3e23c7db6c8ccca07ddd768715a3e74349630748b19ef43f99b63fcb107ad1d7e3eda85e69e0c987a189130cd2abcd0a04e7867807489

data/lib/eskimo.rb

@@ -1,29 +1,2 @@
-require 'did_you_mean'
-require 'pastel'
-require 'strings'
-require 'tty-screen'
-
-require 'eskimo/version'
-
-require 'eskimo/constants'
-
-require 'eskimo/component'
-require 'eskimo/renderer'
-
-require 'eskimo/components/did_you_mean'
-require 'eskimo/components/either'
-require 'eskimo/components/gutter'
-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/spacer'
-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'
+require 'eskimo/core'
+require 'eskimo/ascii'

data/lib/eskimo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eskimo
-  VERSION = '2.2.0'
+  VERSION = '3.0.0.pre.1'
 end

metadata

@@ -1,71 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: eskimo
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0.pre.1
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: did_you_mean
+  name: eskimo-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: pastel
+  name: eskimo-ascii
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 3.0.0
   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'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,48 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eskimo.rb
-- lib/eskimo/component.rb
-- lib/eskimo/components/did_you_mean.rb
-- lib/eskimo/components/either.rb
-- lib/eskimo/components/gutter.rb
-- lib/eskimo/components/highlight.rb
-- lib/eskimo/components/highlight_column.rb
-- lib/eskimo/components/indent.rb
-- lib/eskimo/components/line_break.rb
-- lib/eskimo/components/soft_break.rb
-- lib/eskimo/components/spacer.rb
-- lib/eskimo/components/squeeze.rb
-- lib/eskimo/components/strip.rb
-- lib/eskimo/components/strip_left.rb
-- lib/eskimo/components/strip_right.rb
-- lib/eskimo/components/style.rb
-- lib/eskimo/components/truncate.rb
-- lib/eskimo/components/truncate_rear.rb
-- lib/eskimo/components/wrap.rb
-- lib/eskimo/constants.rb
-- lib/eskimo/renderer.rb
 - lib/eskimo/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/renderer_spec.rb
-- spec/spec_helper.rb
-- spec/support/component_suite.rb
 homepage: https://github.com/amireh/eskimo
 licenses:
 - MIT
@@ -155,37 +86,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.1
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Declarative text formatting
-test_files:
-- spec/component_spec.rb
-- spec/renderer_spec.rb
-- spec/components/style_spec.rb
-- spec/components/strip_spec.rb
-- spec/components/gutter_spec.rb
-- spec/components/truncate_spec.rb
-- spec/components/line_break_spec.rb
-- spec/components/squeeze_spec.rb
-- spec/components/strip_left_spec.rb
-- spec/components/highlight_spec.rb
-- spec/components/strip_right_spec.rb
-- spec/components/highlight_column_spec.rb
-- spec/components/either_spec.rb
-- spec/components/truncate_rear_spec.rb
-- spec/components/did_you_mean_spec.rb
-- spec/components/wrap_spec.rb
-- spec/components/spacer_spec.rb
-- spec/components/indent_spec.rb
-- spec/components/soft_break_spec.rb
-- spec/spec_helper.rb
-- spec/support/component_suite.rb
+test_files: []

data/lib/eskimo/component.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Eskimo
-  # A base component class that renders child components defined in a block into
-  # a String for further formatting.
-  #
-  #     class MyComponent < Eskimo::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 {Renderer#apply} with the tracked children
-  #    which converts them to a String and returns them.
-  class Component
-    def initialize(*, **, &children_gen)
-      @children = children_gen
-    end
-
-    def render(render:, **)
-      render[@children]
-    end
-
-    protected
-
-    def pastel
-      @pastel ||= Pastel.new
-    end
-  end
-end

data/lib/eskimo/components/did_you_mean.rb

@@ -1,34 +0,0 @@
-# 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

@@ -1,30 +0,0 @@
-# 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/gutter.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Eskimo
-  module Components
-    # Prepend each line with a character or symbol.
-    #
-    #     Gutter.new(char: '| ') do
-    #       [ "Hello", "\n", "World!" ]
-    #     end
-    #     # => "| Hello"
-    #     #    "| World!"
-    class Gutter < 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
-  end
-end

data/lib/eskimo/components/highlight.rb

@@ -1,31 +0,0 @@
-# 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

@@ -1,61 +0,0 @@
-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