eskimo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5912c4b1987656f45fa2fc0beb17228f1cc967db41c084675774baf24167bb9f
+  data.tar.gz: d8f3d3d02a29fabd13444207a972e3f92e0403d1ff5612d4fc40876e1dc349d6
+SHA512:
+  metadata.gz: fa006a58bbd5ad12d24e52a3401ed14d7ecc8a98cc5e494856dcba95666df4ff3be54eab24902e8167d687f7e6d8daca5e3d33da90ddf67efdce6cc2e87cab01
+  data.tar.gz: 4c249f2b9b14cc4521b516ba78c0f1bbbbf7454600888a4eaab4ce55492f9e51447e48897be98d47c1d639b0a41fc70c2febbed6be955a0d978bcebcd2592f87

data/lib/eskimo.rb

@@ -0,0 +1,10 @@
+require 'pastel'
+require 'strings'
+require 'tty-screen'
+
+require_relative './eskimo/version'
+
+require_relative './eskimo/component'
+require_relative './eskimo/renderer'
+
+require_relative './eskimo/components'

data/lib/eskimo/component.rb

@@ -0,0 +1,31 @@
+# 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)
+      @children = children
+    end
+
+    def render(render:, **)
+      render[@children]
+    end
+  end
+end

data/lib/eskimo/components.rb

@@ -0,0 +1,114 @@
+# 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/lib/eskimo/renderer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Eskimo
+  # Render a component or a list of ones.
+  class Renderer
+    # @param props [Hash]
+    #  Properties to pass to each component being rendered.
+    def initialize(**props)
+      @props = { **props, render: method(:render) }
+    end
+
+    # @param components [Proc]
+    #  A block that returns components to render.
+    def apply(&components)
+      render(components)
+    end
+
+    private
+
+    def render(*components)
+      components.select(&NOT_FALSEY).reduce('') do |buf, component|
+        case component
+        when String
+          buf + component
+        when Array
+          buf + render(*component)
+        when Proc
+          buf + render(component[**@props])
+        else
+          if component.respond_to?(:render)
+            buf + render(component.render(**@props))
+          else
+            bail(component)
+          end
+        end
+      end
+    end
+
+    def bail(component)
+      raise ArgumentError.new(
+        "Eskimo: don't know how to render #{component.class} => #{component}"
+      )
+    end
+
+    NOT_FALSEY = ->(x) { !!x }.freeze
+    private_constant :NOT_FALSEY
+  end
+end

data/lib/eskimo/version.rb

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

data/spec/components_spec.rb

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

data/spec/renderer_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::Renderer do
+  it 'renders nothing' do
+    expect(subject.apply).to eq('')
+  end
+
+  it 'renders a string' do
+    expect(subject.apply { 'hello' }).to eq('hello')
+  end
+
+  it 'renders a proc' do
+    expect(subject.apply { lambda do |**| 'hello' end }).to eq('hello')
+  end
+
+  it 'renders an array of renderables' do
+    expect(subject.apply { ['h','ello'] }).to eq('hello')
+  end
+
+  it 'renders a #render renderable' do
+    class Renderable
+      def render(**)
+        'hello'
+      end
+    end
+
+    expect(subject.apply { Renderable.new }).to eq('hello')
+  end
+
+  it 'ignores falseys' do
+    expect(subject.apply { nil }).to eq('')
+    expect(subject.apply { false }).to eq('')
+    expect(subject.apply { [nil,false] }).to eq('')
+  end
+
+  it 'passes props to renderers' do
+    props = nil
+
+    described_class.new(foo: 'bar').apply {
+      lambda { |injected_props| ''.tap { props = injected_props } }
+    }
+
+    expect(props).to be_a(Hash)
+    expect(props).to include(foo: 'bar')
+  end
+
+  it 'injects a "render" routine for procs' do
+    expect(
+      subject.apply { lambda { |render:, **| render['hello'] } }
+    ).to eq('hello')
+  end
+
+  it 'bails on unrenderable inputs' do
+    expect {
+      subject.apply { :foo }
+    }.to raise_error(ArgumentError,
+      "Eskimo: don't know how to render #{:foo.class} => foo"
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter(%r{/spec/})
+  coverage_dir("#{ENV.fetch('COVERAGE_DIR', 'coverage')}")
+end
+
+require 'eskimo'
+
+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
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: eskimo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ahmad Amireh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-22 00:00:00.000000000 Z
+dependencies:
+- !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.rb
+- lib/eskimo/component.rb
+- lib/eskimo/components.rb
+- lib/eskimo/renderer.rb
+- lib/eskimo/version.rb
+- spec/components_spec.rb
+- spec/renderer_spec.rb
+- spec/spec_helper.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: 2.5.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Declarative text formatting
+test_files:
+- spec/spec_helper.rb
+- spec/renderer_spec.rb
+- spec/components_spec.rb