fun_html 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb896c9f7e8a1f225b04bd5b47b9280158ec76b20ce27dbea4237ef6fe833fb
-  data.tar.gz: f56f5b4f9ad54fb6da2462bff7acfa49ec5f46fa016b88bc05746b3994dfc7b4
+  metadata.gz: 3e5e644d2ee9775409d54d3340ee692e557614bb1e85ef0c290317c0d00e9432
+  data.tar.gz: 4792b3bf1361a392a59221c43a937ce1922108d09b6f799a6c5a74466c41e760
 SHA512:
-  metadata.gz: 3b20b2587d85eeb86fced3a578d0c3742f48d5cdda2d9f638ff53530d43647c509e10d7cbee6179d815a5eb31b49a44d828278e2a3095d8b19c80670a8730ab0
-  data.tar.gz: 85dea75031b3cddeea68f23821c12e1c686b1d40bea8d1386f2ede461ce4db027ffc55a2ef38c34d0da9f4962dcc58df0530a2f38abbbb9e3cbf4f6db1568faf
+  metadata.gz: 808d8bb9950923c28e12b81c39d7be030aa2cf315d73e4b28efe157398aeaaacc349983bb785e167e59c6cad284656f6e310fff215d8022e15eebf89c1f51b81
+  data.tar.gz: a75a3249ea3253801467b1324b6da56c090ca919ea74309a900f80635d7a01dadfeab966844e98a20305a4b3cd0f96621ac929157309df861fddc3e511c424d4

data/lib/fun_html/attribute.rb

@@ -0,0 +1,86 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'spec_attributes'
+require 'erb/escape'
+
+module FunHtml
+  # Attribute generates HTML attributes. It is designed to prevent printing the
+  # same attribute twice. The Template elements expect an Attribute object.
+  #
+  # All attribute values are HTML escaped via ERB::Escape.
+  #
+  # It is typed to only allow the correct types to be passed to the attribute,
+  # if Sorbet is enabled.
+  #
+  # Attributes can be generated via a block, or chained.
+  #
+  # Block
+  #     Attribute.new { _1.id "one" ; _1.klass "big" }
+  #
+  # Chained
+  #     Attribute.new.id("one").klass("big")
+  #
+  # Boolean attributes
+  # Some attributes (async, autoplay, disabled) are boolean.  When true is
+  # passed, the attribute prints, when false, the attribute will be blank.
+  #
+  # Attribute.new.disabled(true) -> " disabled"
+  # Attribute.new.disabled(false) -> " "
+  class Attribute
+    include FunHtml::SpecAttributes
+
+    # only allow nil or objects that respond to `safe_attribute`
+    def self.to_html(attr)
+      attr&.safe_attribute.to_s
+    end
+
+    # create a new Attribute object to create reuseable attributes
+    def initialize(buffer = {}, &block)
+      @__buffer = buffer
+      return unless block
+
+      yield self
+    end
+
+    # Custom data attributes
+    # The data attribute takes a suffix and the string value.
+    # Attribute.new.data('turbo','false') -> ' data-turbo="false"'
+    def data(suffix, value)
+      unless suffix.match?(/\A[a-z-]+\z/)
+        raise ArgumentError,
+              "suffix (#{suffix}) must be lowercase and only contain 'a' to 'z' or hyphens."
+      end
+
+      write(" data-#{suffix}=\"", value)
+    end
+
+    # CSS class name(s) for styling, the name changed to protect the Ruby.
+    def klass(value)
+      write(' class="', value)
+    end
+
+    # Merge another Attribute to create a new, combined, Attribute.
+    def merge(other)
+      self.class.new(@__buffer.merge(other.instance_variable_get(:@__buffer)))
+    end
+
+    # output the attributes as string
+    def safe_attribute
+      @__buffer.values.join
+    end
+
+    private
+
+    def write(name, value)
+      @__buffer[name] = "#{name}#{ERB::Escape.html_escape(value)}\""
+      self
+    end
+
+    # for boolean attributes, determin if to print the attribute or not
+    def write_boolean(name, print)
+      @__buffer[name] = print ? name : ''
+      self
+    end
+  end
+end

data/lib/fun_html/{attribute_definitions.rb → spec_attributes.rb}

@@ -2,7 +2,7 @@
 
 module FunHtml
   # HTML attributes autogenerated, do not edit
-  module AttributeDefinitions
+  module SpecAttributes
     # Specifies file types browser will accept
     def accept(value) = write(' accept="', value)
     # Character encodings used for form submission
@@ -16,13 +16,13 @@ module FunHtml
     # Alternative text for images
     def alt(value) = write(' alt="', value)
     # Script should execute asynchronously
-    def async(value) = write_empty(' async', value)
+    def async(value) = write_boolean(' async', value)
     # Form/input autocompletion
     def autocomplete(value) = write(' autocomplete="', value)
     # Element should be focused on page load
-    def autofocus(value) = write_empty(' autofocus', value)
+    def autofocus(value) = write_boolean(' autofocus', value)
     # Media will start playing automatically
-    def autoplay(value) = write_empty(' autoplay', value)
+    def autoplay(value) = write_boolean(' autoplay', value)
     # Background color of element
     def bgcolor(value) = write(' bgcolor="', value)
     # Border width in pixels
@@ -30,9 +30,7 @@ module FunHtml
     # Character encoding of document
     def charset(value) = write(' charset="', value)
     # Whether checkbox/radio button is selected
-    def checked(value) = write_empty(' checked', value)
-    # CSS class name(s) for styling
-    def klass(value) = write(' class="', value)
+    def checked(value) = write_boolean(' checked', value)
     # Number of columns in textarea
     def cols(value) = write(' cols="', value)
     # Number of columns a cell spans
@@ -42,30 +40,19 @@ module FunHtml
     # Whether content is editable
     def contenteditable(value) = write(' contenteditable="', value)
     # Show media playback controls
-    def controls(value) = write_empty(' controls', value)
+    def controls(value) = write_boolean(' controls', value)
     # Coordinates for image maps
     def coords(value) = write(' coords="', value)
-
-    # Custom data attributes
-    def data(suffix, value)
-      unless suffix.match?(/\A[a-z-]+\z/)
-        raise ArgumentError,
-              "suffix (#{suffix}) must be lowercase and only contain 'a' to 'z' or hyphens."
-      end
-
-      write(" data-#{suffix}=\"", value)
-    end
-
     # Date/time of element content
     def datetime(value) = write(' datetime="', value)
     # Default track for media
-    def default(value) = write_empty(' default', value)
+    def default(value) = write_boolean(' default', value)
     # Script should execute after parsing
-    def defer(value) = write_empty(' defer', value)
+    def defer(value) = write_boolean(' defer', value)
     # Text direction
     def dir(value) = write(' dir="', value)
     # Element is disabled
-    def disabled(value) = write_empty(' disabled', value)
+    def disabled(value) = write_boolean(' disabled', value)
     # Resource should be downloaded
     def download(value) = write(' download="', value)
     # Element can be dragged
@@ -83,7 +70,7 @@ module FunHtml
     # Height of element
     def height(value) = write(' height="', value)
     # Element is not displayed
-    def hidden(value) = write_empty(' hidden', value)
+    def hidden(value) = write_boolean(' hidden', value)
     # Upper range of meter
     def high(value) = write(' high="', value)
     # URL of linked resource
@@ -95,7 +82,7 @@ module FunHtml
     # Subresource integrity hash
     def integrity(value) = write(' integrity="', value)
     # Image is server-side image map
-    def ismap(value) = write_empty(' ismap', value)
+    def ismap(value) = write_boolean(' ismap', value)
     # Type of text track
     def kind(value) = write(' kind="', value)
     # Label for form control/option
@@ -105,7 +92,7 @@ module FunHtml
     # Links input to datalist options
     def list(value) = write(' list="', value)
     # Media will replay when finished
-    def loop(value) = write_empty(' loop', value)
+    def loop(value) = write_boolean(' loop', value)
     # Lower range of meter
     def low(value) = write(' low="', value)
     # Maximum allowed value
@@ -119,15 +106,15 @@ module FunHtml
     # Minimum allowed value
     def min(value) = write(' min="', value)
     # Multiple values can be selected
-    def multiple(value) = write_empty(' multiple', value)
+    def multiple(value) = write_boolean(' multiple', value)
     # Media is muted by default
-    def muted(value) = write_empty(' muted', value)
+    def muted(value) = write_boolean(' muted', value)
     # Name of form control
     def name(value) = write(' name="', value)
     # Form validation is skipped
-    def novalidate(value) = write_empty(' novalidate', value)
+    def novalidate(value) = write_boolean(' novalidate', value)
     # Details element is expanded
-    def open(value) = write_empty(' open', value)
+    def open(value) = write_boolean(' open', value)
     # Optimal value for meter
     def optimum(value) = write(' optimum="', value)
     # Regular expression pattern
@@ -139,23 +126,25 @@ module FunHtml
     # How media should be loaded
     def preload(value) = write(' preload="', value)
     # Input field cannot be modified
-    def readonly(value) = write_empty(' readonly', value)
+    def readonly(value) = write_boolean(' readonly', value)
     # Relationship of linked resource
     def rel(value) = write(' rel="', value)
     # Input must be filled out
-    def required(value) = write_empty(' required', value)
+    def required(value) = write_boolean(' required', value)
     # List is numbered in reverse
-    def reversed(value) = write_empty(' reversed', value)
+    def reversed(value) = write_boolean(' reversed', value)
     # Number of rows in textarea
     def rows(value) = write(' rows="', value)
     # Number of rows a cell spans
     def rowspan(value) = write(' rowspan="', value)
     # Security rules for iframe
     def sandbox(value) = write(' sandbox="', value)
+    # Specifies the number of consecutive columns the <colgroup> element spans. The value must be a positive integer greater than zero. If not present, its default value is 1.
+    def span(value) = write(' span="', value)
     # Cells header element relates to
     def scope(value) = write(' scope="', value)
     # Option is pre-selected
-    def selected(value) = write_empty(' selected', value)
+    def selected(value) = write_boolean(' selected', value)
     # Shape of image map area
     def shape(value) = write(' shape="', value)
     # Size of input/select control
@@ -196,5 +185,70 @@ module FunHtml
     def width(value) = write(' width="', value)
     # How text wraps in textarea
     def wrap(value) = write(' wrap="', value)
+    def onabort(value) = write(' onabort="', value)
+    def onauxclick(value) = write(' onauxclick="', value)
+    def onbeforeinput(value) = write(' onbeforeinput="', value)
+    def onbeforematch(value) = write(' onbeforematch="', value)
+    def onbeforetoggle(value) = write(' onbeforetoggle="', value)
+    def oncancel(value) = write(' oncancel="', value)
+    def oncanplay(value) = write(' oncanplay="', value)
+    def oncanplaythrough(value) = write(' oncanplaythrough="', value)
+    def onchange(value) = write(' onchange="', value)
+    def onclick(value) = write(' onclick="', value)
+    def onclose(value) = write(' onclose="', value)
+    def oncontextlost(value) = write(' oncontextlost="', value)
+    def oncontextmenu(value) = write(' oncontextmenu="', value)
+    def oncontextrestored(value) = write(' oncontextrestored="', value)
+    def oncopy(value) = write(' oncopy="', value)
+    def oncuechange(value) = write(' oncuechange="', value)
+    def oncut(value) = write(' oncut="', value)
+    def ondblclick(value) = write(' ondblclick="', value)
+    def ondrag(value) = write(' ondrag="', value)
+    def ondragend(value) = write(' ondragend="', value)
+    def ondragenter(value) = write(' ondragenter="', value)
+    def ondragleave(value) = write(' ondragleave="', value)
+    def ondragover(value) = write(' ondragover="', value)
+    def ondragstart(value) = write(' ondragstart="', value)
+    def ondrop(value) = write(' ondrop="', value)
+    def ondurationchange(value) = write(' ondurationchange="', value)
+    def onemptied(value) = write(' onemptied="', value)
+    def onended(value) = write(' onended="', value)
+    def onformdata(value) = write(' onformdata="', value)
+    def oninput(value) = write(' oninput="', value)
+    def oninvalid(value) = write(' oninvalid="', value)
+    def onkeydown(value) = write(' onkeydown="', value)
+    def onkeypress(value) = write(' onkeypress="', value)
+    def onkeyup(value) = write(' onkeyup="', value)
+    def onloadeddata(value) = write(' onloadeddata="', value)
+    def onloadedmetadata(value) = write(' onloadedmetadata="', value)
+    def onloadstart(value) = write(' onloadstart="', value)
+    def onmousedown(value) = write(' onmousedown="', value)
+    def onmouseenter(value) = write(' onmouseenter="', value)
+    def onmouseleave(value) = write(' onmouseleave="', value)
+    def onmousemove(value) = write(' onmousemove="', value)
+    def onmouseout(value) = write(' onmouseout="', value)
+    def onmouseover(value) = write(' onmouseover="', value)
+    def onmouseup(value) = write(' onmouseup="', value)
+    def onpaste(value) = write(' onpaste="', value)
+    def onpause(value) = write(' onpause="', value)
+    def onplay(value) = write(' onplay="', value)
+    def onplaying(value) = write(' onplaying="', value)
+    def onprogress(value) = write(' onprogress="', value)
+    def onratechange(value) = write(' onratechange="', value)
+    def onreset(value) = write(' onreset="', value)
+    def onscrollend(value) = write(' onscrollend="', value)
+    def onsecuritypolicyviolation(value) = write(' onsecuritypolicyviolation="', value)
+    def onseeked(value) = write(' onseeked="', value)
+    def onseeking(value) = write(' onseeking="', value)
+    def onselect(value) = write(' onselect="', value)
+    def onslotchange(value) = write(' onslotchange="', value)
+    def onstalled(value) = write(' onstalled="', value)
+    def onsubmit(value) = write(' onsubmit="', value)
+    def onsuspend(value) = write(' onsuspend="', value)
+    def ontimeupdate(value) = write(' ontimeupdate="', value)
+    def ontoggle(value) = write(' ontoggle="', value)
+    def onvolumechange(value) = write(' onvolumechange="', value)
+    def onwaiting(value) = write(' onwaiting="', value)
+    def onwheel(value) = write(' onwheel="', value)
   end
 end

data/lib/fun_html/{node_definitions.rb → spec_elements.rb}

@@ -2,7 +2,7 @@
 
 module FunHtml
   # HTML nodes autogenerated, do not edit
-  module NodeDefinitions
+  module SpecElements
     module HTMLHtmlElement
       def html(attributes = nil, &elements)
         write('<html', '</html>', attributes, &elements)
@@ -24,21 +24,21 @@ module FunHtml
     module HTMLBaseElement
       def base(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<base', '>', attributes)
+        write_void('<base', attributes)
       end
     end
 
     module HTMLLinkElement
       def link(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<link', '>', attributes)
+        write_void('<link', attributes)
       end
     end
 
     module HTMLMetaElement
       def meta(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<meta', '>', attributes)
+        write_void('<meta', attributes)
       end
     end
 
@@ -201,7 +201,7 @@ module FunHtml
 
       def wbr(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<wbr', '>', attributes)
+        write_void('<wbr', attributes)
       end
 
       def summary(attributes = nil, &elements)
@@ -300,7 +300,7 @@ module FunHtml
     module HTMLHRElement
       def hr(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<hr', '>', attributes)
+        write_void('<hr', attributes)
       end
     end
 
@@ -391,7 +391,7 @@ module FunHtml
     module HTMLBRElement
       def br(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<br', '>', attributes)
+        write_void('<br', attributes)
       end
     end
 
@@ -414,14 +414,14 @@ module FunHtml
     module HTMLSourceElement
       def source(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<source', '>', attributes)
+        write_void('<source', attributes)
       end
     end
 
     module HTMLImageElement
       def img(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<img', '>', attributes)
+        write_void('<img', attributes)
       end
     end
 
@@ -434,7 +434,7 @@ module FunHtml
     module HTMLEmbedElement
       def embed(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<embed', '>', attributes)
+        write_void('<embed', attributes)
       end
     end
 
@@ -459,7 +459,7 @@ module FunHtml
     module HTMLTrackElement
       def track(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<track', '>', attributes)
+        write_void('<track', attributes)
       end
     end
 
@@ -472,7 +472,7 @@ module FunHtml
     module HTMLAreaElement
       def area(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<area', '>', attributes)
+        write_void('<area', attributes)
       end
     end
 
@@ -495,7 +495,7 @@ module FunHtml
 
       def col(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<col', '>', attributes)
+        write_void('<col', attributes)
       end
     end
 
@@ -544,7 +544,7 @@ module FunHtml
     module HTMLInputElement
       def input(attributes = nil)
         # no child elements allowed and no closing tag
-        write('<input', '>', attributes)
+        write_void('<input', attributes)
       end
     end
 
@@ -627,9 +627,6 @@ module FunHtml
     end
 
     module HTMLScriptElement
-      def script(attributes = nil, &elements)
-        write('<script', '</script>', attributes, &elements)
-      end
     end
 
     module HTMLTemplateElement

data/lib/fun_html/template.rb

@@ -0,0 +1,104 @@
+# typed: strict
+
+require_relative 'attribute'
+require_relative 'writer'
+require 'erb/escape'
+
+module FunHtml
+  # FunHtml Template will generate typed HTML. Each tag and attribute has a
+  # match method that is typed via Sorbet (which is optional).
+  #
+  # The template is designed to allow subclassing or using `start` to generate
+  # templates without subclassing.
+  #
+  # When subclassing understand that `new` generatings a "buffer". Each time a
+  # tag(div, b, body, etc) is called it will be added to the buffer. Once
+  # `render` is called the buffer is is returned and then cleared.
+  #
+  #     class Example < FunHtml::Template
+  #       def initialize(name)
+  #         super()
+  #         @name = name
+  #       end
+  #
+  #       def view
+  #         doctype
+  #         html do
+  #           body do
+  #             h1 { text @name }
+  #           end
+  #         end
+  #       end
+  #     end
+  #
+  #     puts Example.new('My Example').view.render
+  #     <!DOCTYPE html><html><body><h1>My Example</h1></body></html>
+  #
+  # If you need to create custom tags, create a method that integrates with the
+  # Writer#write method.
+  class Template
+    include FunHtml::Writer
+    include FunHtml::SpecElements::HTMLAllElements
+
+    # To avoid subclassing a template, `start` can be used to yeild and return a Template.
+    #
+    #     html = FunHtml::Template.start do |t|
+    #       t.doctype
+    #       t.html do
+    #         t.body { t.h1 "Body" }
+    #       end
+    #     end
+    #
+    def self.start(&block)
+      obj = new
+      yield obj if block
+      obj
+    end
+
+    # join an array of other templates into this template.
+    def join(templates)
+      templates.each { @__buffer << _1.render }
+      self
+    end
+
+    # text will generate the text node, this is the only way to insert strings into the template.
+    #
+    #     Template.start do |t|
+    #       t.div { t.text  "Hello" }
+    #     end
+    #
+    def text(value)
+      @__buffer << ERB::Escape.html_escape(value)
+      self
+    end
+
+    # generate a comment block
+    def comment(comment_text = nil)
+      write('<!--', '-->', nil, closing_char: '') { text comment_text.to_s }
+    end
+
+    # generate the doctype
+    def doctype
+      @__buffer << '<!DOCTYPE html>'
+      self
+    end
+
+    # generate a script tag. The return the script code to the block.
+    # The code is not escaped.
+    def script(attributes = nil, &block) # rubocop:disable Lint/UnusedMethodArgument
+      body = yield
+      write('<script', '</script>', attributes) { send :unsafe_text, body }
+    end
+
+    # attr is short cut in the template to return a new Attribute
+    #
+    # Template.start { |t| t.div(t.attr.id('my-div'), t.text '...') }
+    def attr(&blk)
+      if blk
+        Attribute.new(&blk)
+      else
+        Attribute.new
+      end
+    end
+  end
+end

data/lib/fun_html/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FunHtml
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/lib/fun_html/writer.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'spec_elements'
+require 'erb/escape'
+
+module FunHtml
+  # Writer collects the rendered elements and attributes into a string.
+  module Writer
+    include Kernel
+
+    def initialize
+      @__buffer = +''
+    end
+
+    # Render produces the HTML string and clears the buffer.
+    def render
+      @__buffer
+    ensure
+      # empty the buffer to prevent double rendering
+      @__buffer = +''
+    end
+
+    private
+
+    # used when the text should not be escaped, see `script`
+    def unsafe_text(value)
+      @__buffer << value
+      self
+    end
+
+    CLOSE = '>'
+    CLOSE_VOID = '/>'
+
+    def write(open, close, attr = nil, closing_char: CLOSE, &block)
+      @__buffer << open << Attribute.to_html(attr)
+
+      @__buffer << closing_char
+      yield self if block
+      @__buffer << close
+
+      self
+    end
+
+    def write_void(open, attr = nil)
+      @__buffer << open << Attribute.to_html(attr) << CLOSE_VOID
+    end
+  end
+end