eskimo-core 3.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3955c3e689986abaa0de22b261c49a26a3b00af0c5632cfadfddcb41fe84db8
+  data.tar.gz: 9ca28e3abcb1d2465d997994cf6fa9177377d163067affef5983a172848fdabe
+SHA512:
+  metadata.gz: ec6ac5e1d883fb4b6beb3560a3626743efe9f7f01a6d1f96211b26701b00face6c9bc31cb6364558a2f0ddf2a5f4d4fc7f03e56aaf5d90cea959debbb99171ca
+  data.tar.gz: 13a20463fac542d3043aef17ea9f3688ec5297846dda310ed1532cb2cb24efa0c510ff707e9ec0616fe2bc2e71ebfd574023952497dd75706d755d5ca7e563e6

data/lib/eskimo/core/renderer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Core
+    # 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)
+        buf = +''
+
+        for component in components do
+          if component.is_a?(String)
+            buf << component
+          elsif component.is_a?(Array)
+            buf << render(*component)
+          elsif component.is_a?(Proc)
+            buf << render(component[**@props])
+          elsif component.respond_to?(:render)
+            buf << render(component.render(**@props))
+          elsif component
+            bail(component)
+          end
+        end
+
+        buf
+      end
+
+      def bail(component)
+        raise ArgumentError.new(
+          "Eskimo: don't know how to render #{component.class} => #{component}"
+        )
+      end
+    end
+  end
+end

data/lib/eskimo/core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module Core
+    VERSION = '3.0.0.pre.1'
+  end
+end

data/lib/eskimo/core.rb

@@ -0,0 +1,2 @@
+require 'eskimo/core/renderer'
+require 'eskimo/core/version'

data/spec/renderer_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::Core::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,35 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter(%r{/spec/})
+  coverage_dir("#{ENV.fetch('COVERAGE_DIR', 'coverage')}")
+  command_name 'eskimo-core'
+end
+
+require 'eskimo/core'
+
+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,78 @@
+--- !ruby/object:Gem::Specification
+name: eskimo-core
+version: !ruby/object:Gem::Version
+  version: 3.0.0.pre.1
+platform: ruby
+authors:
+- Ahmad Amireh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
+dependencies:
+- !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/core.rb
+- lib/eskimo/core/renderer.rb
+- lib/eskimo/core/version.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.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+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