eskimo 1.0.0 → 2.0.0

data/spec/components/truncate_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::Components::Truncate do
+  it 'truncates a string from the beginning if it exceeds the length' do
+    expect(
+      renderer.apply do
+        ESK::Truncate.new(width: 5) do
+          ("hello world")
+        end
+      end
+    ).to eq("... world")
+  end
+
+  it 'reserves chars from the width' do
+    expect(
+      renderer.apply do
+        ESK::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
+        ESK::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,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::Components::Wrap do
+  it 'wraps text' do
+    expect(
+      renderer.apply do
+        ESK::Wrap.new(width: 5) do
+          'hello world'
+        end
+      end
+    ).to eq("\nhello \nworld")
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,9 @@ SimpleCov.start do
 end
 
 require 'eskimo'
+require_relative './support/component_suite'
+
+ESK = Eskimo::Components
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -29,6 +32,11 @@ RSpec.configure do |config|
   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 EskimoTest::ComponentSuite, type: :component
 
   Kernel.srand config.seed
 end

data/spec/support/component_suite.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eskimo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -88,12 +88,43 @@ extra_rdoc_files: []
 files:
 - lib/eskimo.rb
 - lib/eskimo/component.rb
-- lib/eskimo/components.rb
+- lib/eskimo/components/did_you_mean.rb
+- lib/eskimo/components/either.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/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/components_spec.rb
+- spec/component_spec.rb
+- spec/components/did_you_mean_spec.rb
+- spec/components/either_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/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
@@ -119,6 +150,22 @@ signing_key:
 specification_version: 4
 summary: Declarative text formatting
 test_files:
+- spec/components/strip_spec.rb
+- spec/components/highlight_column_spec.rb
+- spec/components/truncate_rear_spec.rb
+- spec/components/indent_spec.rb
+- spec/components/did_you_mean_spec.rb
+- spec/components/line_break_spec.rb
+- spec/components/style_spec.rb
+- spec/components/squeeze_spec.rb
+- spec/components/soft_break_spec.rb
+- spec/components/either_spec.rb
+- spec/components/strip_left_spec.rb
+- spec/components/truncate_spec.rb
+- spec/components/wrap_spec.rb
+- spec/components/strip_right_spec.rb
+- spec/components/highlight_spec.rb
+- spec/support/component_suite.rb
 - spec/spec_helper.rb
 - spec/renderer_spec.rb
-- spec/components_spec.rb
+- spec/component_spec.rb

data/lib/eskimo/components.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Eskimo
-  module Components
-    SCREEN_COLUMNS = [TTY::Screen.width, 72].min
-
-    # Indent text from the left.
-    class Indent < Component
-      attr_reader :width
-
-      def initialize(width: 4, &children)
-        @width = width
-        super(&children)
-      end
-
-      def render(**)
-        Strings.pad(super, [0,0,0,width]).rstrip
-      end
-    end
-
-    # Insert a hard line-break (paragraph-like.)
-    class LineBreak
-      def render(**)
-        "\n \n"
-      end
-    end
-
-    # Insert a soft line-break.
-    class SoftBreak
-      def render(**)
-        "\n"
-      end
-    end
-
-    # Strip text of surrounding whitespace.
-    class Strip < Component
-      def render(**)
-        super.strip
-      end
-    end
-
-    # 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(&children)
-      end
-
-      def render(**)
-        pastel.decorate(super, *style)
-      end
-    end
-
-    # Truncate text from the beginning if it exceeds a certain width.
-    #
-    #     ...bar
-    class Truncate < Component
-      attr_reader :maxlen
-
-      def initialize(reserve: 0, width: SCREEN_COLUMNS, &children)
-        @maxlen = [0, width - reserve].max
-
-        super(&children)
-      end
-
-      def render(**)
-        text = super
-
-        if text.length >= maxlen
-          '...' + text[text.length - maxlen - 1 .. -1]
-        else
-          text
-        end
-      end
-    end
-
-    # Truncate text from the rear if it exceeds a certain width.
-    #
-    #     foo...
-    class TruncateRear < Truncate
-      def render(render:, **)
-        text = render[@children]
-
-        if text.length >= maxlen
-          text[0..maxlen - 1] + '...'
-        else
-          text
-        end
-      end
-    end
-
-    # Wrap a block text with newlines at a certain threshold.
-    class Wrap < Component
-      attr_reader :width
-
-      def initialize(width: SCREEN_COLUMNS, &children)
-        @width = width
-        super(&children)
-      end
-
-      def render(**)
-        Strings.wrap(super, width)
-      end
-    end
-  end
-end

data/spec/components_spec.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Eskimo::Renderer do
-  ESK = Eskimo::Components
-
-  describe 'SOFT_BREAK' do
-    it 'inserts a soft linebreak' do
-      expect(
-        subject.apply {
-          [
-            'hello',
-            ESK::SoftBreak.new,
-            'world'
-          ]
-        }
-      ).to eq("hello\nworld")
-    end
-  end
-
-  describe 'BR' do
-    it 'inserts a hard linebreak' do
-      expect(
-        subject.apply {
-          [
-            'hello',
-            ESK::LineBreak.new,
-            'world'
-          ]
-        }
-      ).to eq("hello\n \nworld")
-    end
-  end
-
-  describe 'STYLE' do
-    it 'applies ANSI styling to text' do
-      expect(
-        subject.apply {
-          [
-            ESK::Style.new([:bold, :green]) { 'hai' },
-          ]
-        }
-      ).to eq("\e[1;32mhai\e[0m")
-    end
-
-    it 'accepts a splat' do
-      expect(
-        subject.apply {
-          [
-            ESK::Style.new(:bold, :green) { 'hai' },
-          ]
-        }
-      ).to eq("\e[1;32mhai\e[0m")
-    end
-  end
-
-  describe 'WRAP' do
-    it 'wraps text' do
-      expect(
-        subject.apply do
-          ESK::Wrap.new(width: 5) do
-            'hello world'
-          end
-        end
-      ).to eq("\nhello \nworld")
-    end
-  end
-
-  describe 'INDENT' do
-    it 'indents each line' do
-      expect(
-        subject.apply do
-          ESK::Indent.new(width: 2) do
-            "hello\nworld"
-          end
-        end
-      ).to eq("  hello\n  world")
-    end
-  end
-
-  describe 'STRIP' do
-    it 'strips surrounding whitespace' do
-      expect(
-        subject.apply do
-          ESK::Strip.new do
-            ESK::Indent.new(width: 2) do
-              ("hello world")
-            end
-          end
-        end
-      ).to eq("hello world")
-    end
-  end
-
-  describe 'TRUNCATE' do
-    it 'truncates a string from the beginning if it exceeds the length' do
-      expect(
-        subject.apply do
-          ESK::Truncate.new(width: 5) do
-            ("hello world")
-          end
-        end
-      ).to eq("... world")
-    end
-
-    it 'reserves chars from the width' do
-      expect(
-        subject.apply do
-          ESK::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(
-        subject.apply do
-          ESK::Truncate.new(width: 62, reserve: 5) do
-            ("hello world")
-          end
-        end
-      ).to eq("hello world")
-    end
-  end
-
-  describe 'TruncateRear' do
-    it 'truncates a string from the rear if it exceeds the length' do
-      expect(
-        subject.apply do
-          ESK::TruncateRear.new(width: 5) do
-            "hello world"
-          end
-        end
-      ).to eq("hello...")
-    end
-
-    it 'reserves chars from the width' do
-      expect(
-        subject.apply do
-          ESK::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(
-        subject.apply do
-          ESK::TruncateRear.new(width: 62, reserve: 5) do
-            ("hello world")
-          end
-        end
-      ).to eq("hello world")
-    end
-  end
-end