eskimo-html 3.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78f0e1ede057ea40c6a5835a1d1aee8b446caf229df59053a89047decb2487d0
+  data.tar.gz: ac55cea304a7ce8510aa28665b633f3e116c1fbea79ea48e232fe8fdc4d89f66
+SHA512:
+  metadata.gz: 35671025b2a6edd85559678954aa2096fe8506bd9c95d2c1b7a74b9b736216d429c9020f1fd0f30a06fffad86e4efa423ad88fb58184232eb1c1158a33bd51b4
+  data.tar.gz: 495650ce3a7218112af16f5a1cc47df6b7d479a9f2ec11da083c845392c572dce459c5d23691957a1f7525c1af4c58eb9cd6be3349836956e880340d338c00bf

data/lib/eskimo/html/autogen_tags.rb

@@ -0,0 +1,15 @@
+module Eskimo
+  module HTML
+    AUTOGEN_TAGS = %w[
+      a abbr address area article aside audio b base bdi bdo blockquote body
+      br button canvas caption cite code col colgroup data datalist dd del
+      details dfn dialog div dl dt em embed fieldset figcaption figure footer
+      form h1 h2 h3 h4 h5 h6 head header hgroup hr i iframe img input ins kbd
+      keygen label legend li link main map mark math menu menuitem meta meter
+      nav noscript object ol optgroup option output p param picture pre
+      progress q rb rp rt rtc ruby s samp script section select slot small
+      source span strong style sub summary sup svg table tbody td template
+      textarea tfoot th thead time title tr track u ul var video wbr
+    ]
+  end
+end

data/lib/eskimo/html/component.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Base HTMLElement component which takes a {tag_name}, a set of {attributes},
+# and optionally a set of {children} and turns them into a beautiful -- believe
+# it or not -- HTML tag:
+#
+#     <x-foo <!-- attributes -->>
+#       <!-- children -->
+#     </x-foo>
+#
+# See {ASCII::Component} for how this works under the hood since it's similar.
+class Eskimo::HTML::Component
+  # Mapping of Ruby attribute name to HTML attribute name; some words like
+  # "class" are reserved and are problematic when passed as attributes so this
+  # hash supports a method to rewrite those.
+  ATTRIBUTE_REWRITES = {
+    'className' => 'class'
+  }
+
+  attr_reader :attributes
+  attr_reader :children
+  attr_reader :tag_name
+
+  def initialize(attributes = {}, &children)
+    @attributes = attributes
+    @children = children
+  end
+
+  def render(render:, **)
+    tag_with_attributes = "#{tag_name} #{serialize_attributes}"
+
+    "<#{tag_with_attributes.strip}>#{render[@children]}</#{tag_name}>"
+  end
+
+  private
+
+  def serialize_attributes
+    attributes.map do |(k, v)|
+      k = ATTRIBUTE_REWRITES.fetch(k.to_s, k.to_s)
+
+      case v
+      when true
+        "#{k}=\"#{k}\""
+      when false
+      else
+        "#{k}=\"#{v}\""
+      end
+    end.join(' ')
+  end
+end

data/lib/eskimo/html/components/autogen.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Eskimo::HTML::AUTOGEN_TAGS.each do |tag|
+  eval <<~RUBY
+    class Eskimo::HTML::#{tag.capitalize} < Eskimo::HTML::Component
+      def tag_name
+        "#{tag}"
+      end
+    end
+  RUBY
+end

data/lib/eskimo/html/components/html.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Eskimo::HTML::Html < Eskimo::HTML::Component
+  def initialize(doctype: 'html', **)
+    @doctype = doctype
+    @tag_name = 'html'
+    super
+    @attributes.delete(:doctype)
+  end
+
+  def render(**)
+    if @doctype.to_s.empty?
+      super
+    else
+      "<!DOCTYPE #{@doctype}>\n" + super
+    end
+  end
+end

data/lib/eskimo/html/version.rb

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

data/lib/eskimo/html.rb

@@ -0,0 +1,10 @@
+module Eskimo
+  module HTML
+  end
+end
+
+require 'eskimo/html/version'
+require 'eskimo/html/autogen_tags'
+require 'eskimo/html/component'
+require 'eskimo/html/components/autogen'
+require 'eskimo/html/components/html'

data/spec/component_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::HTML::Component do
+  it 'accepts a block of children' do
+    class CustomComponent < Eskimo::HTML::Component
+      def tag_name
+        'foo'
+      end
+    end
+
+    expect(
+      Eskimo::Core::Renderer.new.apply {
+        CustomComponent.new { 'hello world!' }
+      }
+    ).to eq("<foo>hello world!</foo>")
+  end
+end

data/spec/components/autogen_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::HTML do
+  it 'generates classes for HTML tags' do
+    expect(
+      renderer.apply do
+        Eskimo::HTML::Article.new(className: 'foo') do
+          Eskimo::HTML::P.new do
+            Eskimo::HTML::Span.new { "bar" }
+          end
+        end
+      end
+    ).to eq('<article class="foo"><p><span>bar</span></p></article>')
+  end
+end

data/spec/components/html_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Eskimo::HTML::Html do
+  it 'renders the DOCTYPE' do
+    expect(
+      renderer.apply do
+        Eskimo::HTML::Html.new
+      end
+    ).to eq("<!DOCTYPE html>\n<html></html>")
+  end
+
+  it 'renders without a DOCTYPE' do
+    expect(
+      renderer.apply do
+        Eskimo::HTML::Html.new(doctype: nil)
+      end
+    ).to eq("<html></html>")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter(%r{/spec/})
+  command_name 'eskimo-html'
+  coverage_dir("#{ENV.fetch('COVERAGE_DIR', 'coverage')}")
+end
+
+require 'eskimo/core'
+require 'eskimo/html'
+require_relative './support/component_suite'
+
+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
+  config.define_derived_metadata(file_path: %r{/spec/components/}) do |metadata|
+    metadata[:type] = :component
+  end
+
+  config.include Eskimo::HTML::Test::ComponentSuite, type: :component
+
+  Kernel.srand config.seed
+end

data/spec/support/component_suite.rb

@@ -0,0 +1,11 @@
+module Eskimo
+  module HTML
+    module Test
+      module ComponentSuite
+        def renderer
+          @renderer ||= Eskimo::Core::Renderer.new
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: eskimo-html
+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: eskimo-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: Render HTML using a declarative, extensible API.
+email: ahmad@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eskimo/html.rb
+- lib/eskimo/html/autogen_tags.rb
+- lib/eskimo/html/component.rb
+- lib/eskimo/html/components/autogen.rb
+- lib/eskimo/html/components/html.rb
+- lib/eskimo/html/version.rb
+- spec/component_spec.rb
+- spec/components/autogen_spec.rb
+- spec/components/html_spec.rb
+- spec/spec_helper.rb
+- spec/support/component_suite.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: '0'
+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 HTML formatting
+test_files:
+- spec/spec_helper.rb
+- spec/component_spec.rb
+- spec/components/autogen_spec.rb
+- spec/components/html_spec.rb
+- spec/support/component_suite.rb