eskimo-html 3.0.0.pre.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e296637f454ce72ec9339abf7b8f97b548532fb981b2353abe9207f0368754
-  data.tar.gz: d7e7d8a01d127e659f2fed601fd5154145d11ffb91fe9ebbcbd76212e8a4fadc
+  metadata.gz: e3da3bcd4b6a606c81328723f6ed9583f2e45d89aa97d8ffec6f637206efb408
+  data.tar.gz: 4912406ac8530106b8c1d05e01a52c020fd11a264a150abc82979b76581c5d27
 SHA512:
-  metadata.gz: 0ea26664becbbab824135ac9e03b78d3d8d8d9482daf96c4e78a46fc67d6ca95638f7adb7280ec8ffb66fa28dceddc142b41e6ddd410080dda9b0684349474d3
-  data.tar.gz: cb2ad2cbf060bb8d1f577bf6a7a0aebdb00036676773d6bd22c8862b49ed51ca3226d350245bc53c951b32fdde30ea2513d6ef951a8c9f682ffac0f7f053e938
+  metadata.gz: 68cb96c975983998f40e00d037170804d1ae677e9a0f7b057f2f3cc03b520350083124c9fbd58c52be31b23a0d652a67d2680792c3ba3e159011a5484b4c0bd8
+  data.tar.gz: 3854b9bdbed8821e07a2a74df1c760db55acfe3e768ae615920652dcc646f1fa5ae37106729e4d6f903d29fa511f8d88ccc08a5d064df11a15a679199a3487bb

data/lib/eskimo/html/builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Eskimo
+  module HTML
+    class Builder
+      def self.method_missing(method, *params, &block)
+        return super unless Eskimo::HTML.valid_tagname?(method.to_s)
+
+        attrs, children = case params.count
+        when 0
+          [nil, nil]
+        when 1
+          if params[0].is_a?(Hash)
+            [attrs, nil]
+          else
+            [nil, Proc.new { params[0] }]
+          end
+        when 2
+          [params[0], Proc.new { params[1] }]
+        end
+
+        Eskimo::HTML::Component.tag(method.to_s, attrs, &children)
+      end
+    end
+  end
+end

data/lib/eskimo/html/component.rb

@@ -2,8 +2,8 @@
 
 module Eskimo::HTML
   # 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:
+  # and optionally a set of {children} and turns them into a beautiful --
+  # believe it or not -- HTML tag:
   #
   #     <x-foo <!-- attributes -->>
   #       <!-- children -->
@@ -11,6 +11,8 @@ module Eskimo::HTML
   #
   # See {ASCII::Component} for how this works under the hood since it's similar.
   class Component
+    BLANK_ATTRIBUTES = {}.freeze
+
     # 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.
@@ -21,20 +23,46 @@ module Eskimo::HTML
     attr_reader :attributes
     attr_reader :children
     attr_reader :tag_name
+    attr_reader :void
+
+    def self.tag(tag_name, attrs, &children)
+      new(attrs, &children).tap do |component|
+        component.instance_variable_set(:@tag_name, tag_name)
+        component.instance_variable_set(:@void, Eskimo::HTML::VOID_TAGS.include?(tag_name))
+      end
+    end
 
-    def initialize(attributes = {}, &children)
-      @attributes = attributes
+    def self.define!(tag_name)
+      eval <<~RUBY
+        class Eskimo::HTML::#{tag_name.capitalize} < Eskimo::HTML::Component
+          def tag_name
+            "#{tag_name}".freeze
+          end
+
+          def void
+            @void = Eskimo::HTML::VOID_TAGS.include?(tag_name) if @void.nil?
+            @void
+          end
+        end
+      RUBY
+    end
+
+    def initialize(attributes = nil, &children)
+      @attributes = attributes || BLANK_ATTRIBUTES
       @children = children
     end
 
     def render(render:, **)
-      tag_with_attributes = "#{tag_name} #{serialize_attributes}"
+      safe_tag_name = Eskimo::HTML::Util.xml_name_escape(tag_name)
+      tag_with_attributes = "#{safe_tag_name} #{serialize_attributes}".strip
 
-      "<#{tag_with_attributes.strip}>#{render[@children]}</#{tag_name}>"
+      if void
+        "<#{tag_with_attributes} />"
+      else
+        "<#{tag_with_attributes}>#{render[@children]}</#{safe_tag_name}>"
+      end
     end
 
-    private
-
     def serialize_attributes
       attributes.map do |(k, v)|
         k = ATTRIBUTE_REWRITES.fetch(k.to_s, k.to_s)
@@ -44,9 +72,12 @@ module Eskimo::HTML
           "#{k}=\"#{k}\""
         when false
         else
-          "#{k}=\"#{v}\""
+          "#{k}=\"#{ERB::Util.html_escape(v)}\""
         end
       end.join(' ')
     end
+
+    private :serialize_attributes
+    private_constant :BLANK_ATTRIBUTES
   end
 end

data/lib/eskimo/html/util.rb

@@ -0,0 +1,31 @@
+module Eskimo
+  module HTML
+    module Util
+      TAG_NAME_START_CODEPOINTS	=	"@:A-Z_a-z\u{C0}-\u{D6}\u{D8}-\u{F6}\u{F8}-\u{2FF}\u{370}-\u{37D}\u{37F}-\u{1FFF}" \
+        "\u{200C}-\u{200D}\u{2070}-\u{218F}\u{2C00}-\u{2FEF}\u{3001}-\u{D7FF}\u{F900}-\u{FDCF}" \
+        "\u{FDF0}-\u{FFFD}\u{10000}-\u{EFFFF}"
+      TAG_NAME_REPLACEMENT_CHAR	=	"_"
+      TAG_NAME_FOLLOWING_CODEPOINTS	=	"#{TAG_NAME_START_CODEPOINTS}\\-.0-9\u{B7}\u{0300}-\u{036F}\u{203F}-\u{2040}"
+      INVALID_TAG_NAME_FOLLOWING_REGEXP	=	/[^#{TAG_NAME_FOLLOWING_CODEPOINTS}]/
+      INVALID_TAG_NAME_START_REGEXP	=	/[^#{TAG_NAME_START_CODEPOINTS}]/
+      SAFE_XML_TAG_NAME_REGEXP	=	/\A[#{TAG_NAME_START_CODEPOINTS}][#{TAG_NAME_FOLLOWING_CODEPOINTS}]*\z/
+
+      # ref: <https://api.rubyonrails.org/classes/ERB/Util.html#method-c-xml_name_escape>
+      def self.xml_name_escape(name)
+        name = name.to_s
+        return "" if name.nil? || name == ''
+        return name if name.match?(SAFE_XML_TAG_NAME_REGEXP)
+
+        starting_char = name[0]
+        starting_char.gsub!(INVALID_TAG_NAME_START_REGEXP, TAG_NAME_REPLACEMENT_CHAR)
+
+        return starting_char if name.size == 1
+
+        following_chars = name[1..-1]
+        following_chars.gsub!(INVALID_TAG_NAME_FOLLOWING_REGEXP, TAG_NAME_REPLACEMENT_CHAR)
+
+        starting_char << following_chars
+      end
+    end
+  end
+end

data/lib/eskimo/html/version.rb

@@ -2,6 +2,6 @@
 
 module Eskimo
   module HTML
-    VERSION = '3.0.0.pre.3'
+    VERSION = '4.0.0'
   end
 end

data/lib/eskimo/html.rb

@@ -1,10 +1,50 @@
+require 'eskimo/html/version'
+require 'eskimo/html/util'
+require 'eskimo/html/component'
+require 'eskimo/html/builder'
+
 module Eskimo
   module HTML
+    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 html 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
+    ]
+
+    # ref: <https://developer.mozilla.org/en-US/docs/Glossary/Void_element>
+    VOID_TAGS = %w[
+      area base br col embed hr img input link meta param source track wbr
+    ]
+
+    def self.valid_tagname?(tagname)
+      TAGS.include?(tagname) || tagname == 'html'
+    end
   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'
+(Eskimo::HTML::TAGS - %w[ html ]).each do |tag_name|
+  Eskimo::HTML::Component.define!(tag_name)
+end
+
+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

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: eskimo-html
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.3
+  version: 4.0.0
 platform: ruby
 authors:
 - Ahmad Amireh
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 1980-01-02 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.0.0.pre.3
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.pre.3
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,10 +72,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eskimo/html.rb
-- lib/eskimo/html/autogen_tags.rb
+- lib/eskimo/html/builder.rb
 - lib/eskimo/html/component.rb
-- lib/eskimo/html/components/autogen.rb
-- lib/eskimo/html/components/html.rb
+- lib/eskimo/html/util.rb
 - lib/eskimo/html/version.rb
 - spec/component_spec.rb
 - spec/components/autogen_spec.rb
@@ -73,7 +85,6 @@ homepage: https://github.com/amireh/eskimo
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -84,18 +95,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.8
 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/spec_helper.rb
 - spec/support/component_suite.rb

data/lib/eskimo/html/autogen_tags.rb

@@ -1,15 +0,0 @@
-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/components/autogen.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'eskimo/html/autogen_tags'
-
-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

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