eskimo 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7882c146ce7e288df43b38765be92f216137d746c1efb13cf76b1ac7e1ec13ad
-  data.tar.gz: 1e2bff1433d29f448a74bf39b54b083b6bc79869af86b00c293fefaa09493624
+  metadata.gz: cda13727446ff4b079dfa76a1203d4545739b8a73a635cd515a00072914f889c
+  data.tar.gz: 913d763b28a632677d530e2c8d7d31e2c3c7c363f57b9e63be420a3fd5ebc5cb
 SHA512:
-  metadata.gz: 77d8528c5d5f839c7bbf8daf9bb049fe752c5077b34107e007bdba14b1192723760763750ea4061d2a4e60bf8573c11133ff3d174363d3eadb8f2fe1252eaa11
-  data.tar.gz: 8dfa377b6eb2e05e09eb8e5d70b2a747fc5b9073e5859055145bf66c413e3051239ea55ca9d386936ee5905e1382dd2938140c512aaf4360af9010fb16986a49
+  metadata.gz: eb6ba86cfc76d02e4e82bfc3ea9ea191a6752de8fd569d9f9eda6c155154c402ae05c22f7c8870a192f4b5c918ec6d011bb277f8992983c536d0b74fd2743104
+  data.tar.gz: 1a0739266cd09f9d002272a27968219c89556a24d4412050c73239be6f15ba4aa7ede74e19ca5bdf1ad71c5cfc98a8549bd941d0405149fe95dd46fd4b7d478f

data/lib/eskimo.rb

@@ -11,11 +11,13 @@ 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'

data/lib/eskimo/component.rb

@@ -27,5 +27,11 @@ module Eskimo
     def render(render:, **)
       render[@children]
     end
+
+    protected
+
+    def pastel
+      @pastel ||= Pastel.new
+    end
   end
 end

data/lib/eskimo/components/gutter.rb

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

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

data/lib/eskimo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Eskimo
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/components/gutter_spec.rb

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

data/spec/components/spacer_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::Components::Spacer do
+  it 'inserts newlines between components' do
+    expect(
+      renderer.apply do
+        ESK::Spacer.new([
+          "Hello",
+          "World!"
+        ])
+      end
+    ).to eq("Hello\nWorld!")
+  end
+
+  it 'ignores falsey components' do
+    expect(
+      renderer.apply do
+        ESK::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 { ESK::Spacer.new('') }.to raise_error(ArgumentError,
+      "Spacer works only with an Array of components"
+    )
+  end
+
+  it 'bails if given a block' do
+    expect { ESK::Spacer.new([]) {} }.to raise_error(ArgumentError,
+      "Spacer works only with an Array of components"
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eskimo
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -90,11 +90,13 @@ files:
 - 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
@@ -109,11 +111,13 @@ files:
 - 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
@@ -150,22 +154,24 @@ 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/spec_helper.rb
+- spec/component_spec.rb
 - spec/components/did_you_mean_spec.rb
+- spec/components/strip_left_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/style_spec.rb
+- spec/components/highlight_spec.rb
 - spec/components/either_spec.rb
-- spec/components/strip_left_spec.rb
-- spec/components/truncate_spec.rb
+- spec/components/soft_break_spec.rb
+- spec/components/spacer_spec.rb
 - spec/components/wrap_spec.rb
+- spec/components/gutter_spec.rb
+- spec/components/highlight_column_spec.rb
+- spec/components/truncate_spec.rb
 - spec/components/strip_right_spec.rb
-- spec/components/highlight_spec.rb
+- spec/components/indent_spec.rb
+- spec/components/strip_spec.rb
+- spec/components/truncate_rear_spec.rb
 - spec/support/component_suite.rb
-- spec/spec_helper.rb
 - spec/renderer_spec.rb
-- spec/component_spec.rb