livetext 0.9.27 → 0.9.32

data/plugin/bootstrap_menu.rb

@@ -0,0 +1,140 @@
+# https://getbootstrap.com/docs/5.1/components/navs-tabs/#base-nav
+
+require 'json'
+
+def api_out(indent_level, content)
+  api.out "#{(" " * (indent_level * indent_size))}#{content}"
+end
+
+def indent_size; 2; end
+
+def menu(indent_level: 0, &block)
+  api_out indent_level, "<ul class='nav'>"
+  read_to_end_of_block(root_indent_level: indent_level)
+  yield
+  api_out indent_level, "</ul>"
+end
+
+def menu_dropdown(title, indent_level: 0, &block)
+  api_out indent_level, '<li class="nav-item dropdown">'
+  api_out indent_level, "  <a class='nav-link dropdown-toggle' data-bs-toggle='dropdown' href='#' role='button' aria-expanded='false'"
+  api_out indent_level, "    #{title}"
+  api_out indent_level, '  </a>'
+
+  api_out indent_level, '  <ul class="dropdown-menu">'
+  yield
+  api_out indent_level, '  </ul>'
+
+  api_out indent_level, '</li>'
+end
+
+def menu_link(title, href, active: false, indent_level: 0)
+  # Work out if it's possible to determine active state or not
+  api_out indent_level, "<a class='nav-link #{"active" if active}' aria-current='page' href='#{href}'"
+  api_out indent_level, "  #{title}"
+  api_out indent_level, '</a>'
+end
+
+def menu_dropdown_link(title, href, active: false, indent_level: 0)
+  # Work out if it's possible to determine active state or not
+  api_out indent_level, "<a class='dropdown-item #{"active" if active}' href='#{href}'"
+  api_out indent_level, "  #{title}"
+  api_out indent_level, '</a>'
+end
+
+def next_line
+  nextline
+end
+
+def peek_next_line
+  peek_nextline
+end
+
+def line_indent_level(line)
+  indent_level = (line.size - line.lstrip.size) / indent_size.to_f
+  raise "Unbalanced Indenting: Expecting #{indent_size} indents" if indent_level.to_i != indent_level
+  indent_level = indent_level.to_i
+end
+
+def line_command(line)
+  base_line = line.strip
+
+  base_command = base_line.split.first
+
+  if base_command.start_with?(".")
+    return base_command.gsub(".")
+  else
+    raise "Command Expected: #{base_line}"
+  end
+end
+
+def line_attributes_array(line)
+  line_attributes = line.strip.split("", 2).last
+  api.out 0, line_attributes.inspect
+
+  attributes_parsed = JSON.parse(line_attributes)
+  attributes_parsed.is_a?(String) ? [attributes_parsed] : attributes_parsed
+end
+
+def read_to_end_of_block(root_indent_level: 0)
+  expected_indent_level = root_indent_level + 1
+  loop do
+    peeked_line = peek_next_line
+    return if peeked_line.nil? # End of File
+    unless peeked_line.strip.size > 0 # Blank line
+      next_line
+      next
+    end
+
+    line_indent_level = line_indent_level(peeked_line)
+
+    if expected_indent_level != line_indent_level
+      raise "Unexpected Indent Level: Is #{line_indent_level} expected #{expected_indent_level}:\n#{peeked_line}"
+    end
+
+    return if root_indent_level >= line_indent_level # End of Block
+
+    line = next_line # Actually move to the next line
+
+    send(line_command(line), *line_attributes_array(line)) do
+      # This block doesn't run if command doesn't accept a block
+      read_to_end_of_block(root_indent_level: line_indent_level)
+    end
+  end
+end
+
+# Loop should be something like:
+# read `.menu` and log current indent level
+# => send(:menu) do
+#  # Read until indent is
+# end
+
+def simple_test
+  menu do
+    menu_link "Home", "http://fake.com/home"
+    menu_dropdown("Blog") do
+      menu_dropdown_link("Home", "http://fake.com/blog")
+    end
+    menu_link "About", "http://fake.com/about"
+  end
+  # This should have the same output as:
+  # .menu
+  #   .menu_link
+  #   .menu_dropdown ["Blog"]
+  #     .menu_dropdown_link ["Home", "http://fake.com/blog"]
+  #   .menu_link ["About", "http://fake.com/about"]
+  # or this if we end up sticking with .end
+  # .menu
+  #   .menu_link
+  #   .menu_dropdown "Blog"
+  #     .menu_dropdown_link ["Home", "http://fake.com/blog"]
+  #   .end
+  #   .menu_link ["About", "http://fake.com/about"]
+  # .end
+
+
+  # Really this should probably just re-use Rails ActionView to avoid a ton of duplicate code
+  # This would allow us to leverage all the Rails HTML generation logic.
+  # Downside of that is that it does break the paradigm a bit in that blocks with errors won't partially render
+  # it does however also means we would get sanitization and such for free
+end

data/plugin/misc/navbar.rb

@@ -0,0 +1,162 @@
+
+private def get_href_title(line)
+  *title, href = line[1..-1].split(@space)
+  if href[0] == "@"
+    blank = true
+    href = href[1..-1]
+  else
+    blank = false
+  end
+  title = title.join(@space)
+  [href, title, blank]
+end
+
+private def add_root(url)
+  return url if url =~ /^http/     # already has http[s]
+  return url unless @root          # no root defined
+  range1 = 0..-1
+  range1 = 0..-2 if @root[-1] == "/"
+  root = @root[range1] 
+  range2 = 0..-1
+  range2 = 1..-1 if url[0] == "/"
+  url = url[range2]
+  root + "/" + url
+end
+
+private def get_brand
+  peek = @enum.peek
+  arg = peek[6..-1]
+  href, item, blank = get_href_title(arg)
+  # doesn't honor @root... and blank is unused here
+  if item =~ /\.(jpg|png|gif)$/i
+    item = "<img src='#{item}'></img>" 
+  end
+  details = {class: "navbar-brand mr-auto", href: add_root(href)}
+  @brand = html.tag(:a, **details, cdata: item)
+end
+
+private def slash_tags
+  @root = @brand = nil
+  @classes = "navbar-light bg-light"
+  loop do   # /brand /root ...
+    peek = @enum.peek
+    break if peek[0] != '/'
+    case
+      when peek.start_with?("/brand ")
+        get_brand
+      when peek.start_with?("/root ")
+        @root = peek[6..-1]
+      when peek.start_with?("/classes ")
+        @classes = peek[9..-1]
+    end
+    line = @enum.next
+  end
+end
+
+private def handle_children
+  value = ""
+  loop do
+    if @enum.peek.start_with?(@space)   # it's a child
+      line = @enum.next
+      href, title, blank = get_href_title(line)
+      details = {class: "dropdown-item", href: add_root(href)}
+      details[:target] = "_blank" if blank
+      link = html.tag(:a, **details, cdata: title)
+      str = html.tag(:li, cdata: link)
+      value << str + "\n"
+    else
+      break
+    end
+  end
+  api.out value
+end
+
+private def no_children(href, title)
+  html.li(class: "nav-item") do 
+    api.out html.tag(:a, class: "nav-link", href: add_root(href), cdata: title)
+  end
+end
+
+private def has_children(href, title)
+  css = "nav-item dropdown"
+  html.li(class: css) do
+    details = {class: "nav-link dropdown-toggle", href: "#", id: "navbarDropdown", 
+               role: "button", :"data-bs-toggle" => "dropdown", :"aria-expanded" => "false"}
+    @dropdowns += 1
+    api.out html.tag(:a, **details, cdata: title)
+    details = {class: "dropdown-menu", :"aria-labelledby" => "navbarDropdown"}
+    html.ul(**details) do  # children...
+      handle_children
+    end
+  end
+end
+
+private def handle_body
+  @dropdowns = 1
+  loop do
+    line = @enum.next
+    href, title, blank = get_href_title(line)
+    case line[0]
+    when "-"
+      no_children(href, title)
+    when "="
+      has_children(href, title)
+    end
+  end
+end
+
+def bootstrap
+  api.out <<~HTML
+  <head>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" 
+     rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" 
+     crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" 
+     integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" 
+     crossorigin="anonymous">
+    </script>
+  </head>
+  HTML
+end
+
+private def toggler
+  details = {class: "navbar-toggler", type: "button", "data-bs-toggle": "collapse", 
+             "data-bs-target": "#navbarSupportedContent", 
+             "aria-controls": "navbarSupportedContent", "aria-expanded": "false", 
+             "aria-label": "Toggle navigation"}
+  str = html.tag(:button, **details, cdata: '<span class="navbar-toggler-icon"></span>')
+  api.out str
+end
+
+private def branding
+  return if @brand.empty? || @brand.nil?
+  api.out @brand
+end
+
+def html
+  @html
+end
+
+def navbar
+  @html = HTML.new(api)
+  # bootstrap
+  @space = " "
+  @enum = api.body.each
+  slash_tags
+
+  css = "navbar navbar-expand-md " + @classes
+  html.nav(class: css) do
+    html.div(class: "container-fluid") do 
+      toggler
+      branding
+      content = {class: "collapse navbar-collapse", id: "navbarSupportedContent"}
+      html.div(**content) do
+        css = "navbar-nav me-auto mb-2 mb-md-0"
+        html.ul(class: css) do
+          handle_body
+        end
+      end
+    end
+  end
+end
+

data/test/extra/README.txt

@@ -0,0 +1,149 @@
+The testgen.rb tool takes a .txt and generates a corresponding file
+of MiniTest code.
+
+   $ ruby testgen.rb variables.txt    # produces variables.rb
+
+The tests here include:
+
+   variables.txt     Variable expansion
+   functions.txt     Function call evaluation
+   single.txt        Single sigil (see Formatting below)
+   double.txt        Double sigil (see Formatting below)
+   bracketed.txt     Bracketed sigil (see Formatting below)
+
+
+Variables:
+----------
+
+1. A variable begins with a $ and is followed by an alpha; periods may
+   be embedded, but each separate piece must "look like" an identifier
+
+      $x          yes
+      $xyz        yes
+      $xyz.abc    yes
+      $x123       yes
+      $x.123      no
+      $345        no
+      
+2. Rather than causing an error, invalid variables are rendered "as-is"
+   as soon as possible:
+      " $ "   => " $ "
+      " $5 "  => " $5 "
+      "...$"  => "...$"  (end of line)
+
+3. Actual variables may be user-defined or predefined. The latter usually
+   begin with a capital. This is only a convention so far, nothing that is
+   enforced.
+
+4. The $ may be escaped as needed. This is problematic.
+
+5. An unknown variable will not raise an error, but will be replaced with 
+   a warning string.
+
+
+Functions:
+----------
+
+1. A function looks like a variable name, but it has two $ in front. 
+
+2. If followed by space, comma, end of line, or similar delimiter, it is 
+   called with no parameter.
+
+3. Note that a function name may contain periods, but may not end with
+   one. "$$func." is parsed as a function call (with no parameter) plus a 
+   period.
+
+4. Use a colon to pass a single parameter delimited by a space or end of line.
+   Colon at end of line is valid but probably pointless.
+   
+5. Use brackets to pass a single parameter that contains spaces. The bracketed 
+   parameter may be terminated by end of line instead of right bracket.
+
+6. Only one parameter (a string) may be passed, but the function may parse it
+   however it needs to.
+
+7. There is no enforcement of a parameter being "present or absent" except what
+   the function itself may enforce.
+
+8. An unknown function will not raise an error, but will be replaced with a warning 
+   string.
+
+
+Formatting:
+-----------
+
+1. My formatting notation would be considered quirky by many people.
+   The sigils or markers are:
+     * bold   
+     _ underscore  
+     ` code/teletype  
+     ~ strikethrough
+
+1. A single sigil is recognized basically at beginning of line or after a space.
+    my_func_name   No italics here
+    M*A*S*H        No boldface here
+
+2. A single sigil is terminated by a space or end of line.
+
+3. A single sigil "by itself" is rendered as-is (asterisk, underscore, whatever).
+
+4. An escaped single sigil is rendered as-is. (This is problematic.)
+
+5. A double sigil is recognized at start of line or after a space
+
+6. A double sigil is terminated by a space OR a comma OR a period. (The comma
+   and period cases seem very common to me; they are the whole justification
+   for the double sigil.) End of line also terminates it.
+
+7. A double sigil by itself is rendered as-is.
+
+8. A bracketed sigil is in general a sigil followed by:  [ data ]
+
+9. An empty bracketed sigil simply "goes away"
+   " *[] "  => "  "
+
+10. End of line can terminate instead of right bracket -- but it may still be empty
+    and therefore go away.
+
+11. NOTE: These tests use only asterisks (bold), but the logic "should" be the same
+    for all sigils.
+
+
+
+Order of evaluation, etc.:
+--------------------------
+
+1. This logic is always a compromise between syntax and the code that parses it.
+   I prefer simplicity whenever possible, though it may introduce complexity in
+   other situations. I believe that the acceptable complexity of a workaround
+   depends on how commonplace the situation is and how onerous the workaround is.
+   These are both highly subjective.
+
+2. For example: Note that the simple formatting sigils may not be nested. However,
+   there are functions like $$bits provided (with the silly mnemonic "bold, italic,
+   teletype, strikthrough"). Every combination is provided (e.g., $$bi, $$bt).
+
+3. Note also: Formatting is only intra-line; it doesn't span lines. If you need to
+   work around this, use a heredoc or make your own .def for this.
+
+4. Finally: HTML or CSS may be inserted at will (possibly with some escaping). This
+   can be inline or "a file at a time" via such commands as .copy and .include
+
+5. For these reasons: Parsing is naive and simple. Variables are parsed first. 
+
+6. Next, function calls are parsed. I said variables are parsed first; this implies 
+   that a variable can be embedded in a function parameter. But be aware these are 
+   "naive" substitutions (like C macros).
+       .set alpha = "some value"
+       Calling $$myfunc:$alpha         (means: Calling $$myfunc:some value)
+       Better to say $$myfunc[$alpha]  (means: Better to say $$myfunc[some value]
+
+7. Formatting is handled last. The four sigils (* _ ` ~) and their three modes 
+   (single, double, bracketed) make 12 passes necessary for formatting. As this is 
+   always single-line, it has not been observed to cause a delay so far.
+
+8. The call api.format(line) essentially expands variables, calls functions, and
+   finally does simple formatting. See classes Expansion and Formatter.
+
+9. User code (e.g. inside a .def) may also call expand_variables, expand_functions,
+   and Formatter.format separately.

data/test/extra/bracketed.rb

@@ -0,0 +1,121 @@
+require 'minitest/autorun'
+
+require 'livetext'
+
+# Just another testing class. Chill.
+
+class TestingLivetextBracketed < MiniTest::Test
+
+  def setup
+    @live = Livetext.new
+  end
+
+  def check_match(exp, actual)
+    if exp.is_a? Regexp
+      assert_match(exp, actual, "actual does not match expected")
+    else
+      assert_equal(exp, actual, "actual != expected")
+    end
+  end
+
+  def test_bracketed_001_single_bracketed_item   
+    # Single bracketed item
+    # No special initialization
+    src = "*[abc]"
+    exp = "<b>abc</b>"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_002_end_of_line_can_replace_bracket   
+    # End of line can replace bracket
+    # No special initialization
+    src = "*[abc"
+    exp = "<b>abc</b>"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_003_end_of_line_can_replace_bracket_again   
+    # End of line can replace bracket again
+    # No special initialization
+    src = "abc *[d"
+    exp = "abc <b>d</b>"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_004_missing_right_bracket_ignored_at_eol_if_empty   
+    # Missing right bracket ignored at eol if empty
+    # No special initialization
+    src = "abc*["
+    exp = "abc*["
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_005_two_simple_bracketed_items   
+    # Two simple bracketed items
+    # No special initialization
+    src = "*[A], *[B], C"
+    exp = "<b>A</b>, <b>B</b>, C"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_006_simple_bracketed_item   
+    # Simple bracketed item
+    # No special initialization
+    src = "Just a *[test]..."
+    exp = "Just a <b>test</b>..."
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_007_bracketed_item_with_space   
+    # Bracketed item with space
+    # No special initialization
+    src = "A *[simple test]"
+    exp = "A <b>simple test</b>"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_008_empty_bracketed_item_results_in_null   
+    # Empty bracketed item results in null
+    # No special initialization
+    src = " *[] "
+    exp = "  "
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_009_bracketed_item_with_space_again   
+    # Bracketed item with space again
+    # No special initialization
+    src = "*[ab c] d"
+    exp = "<b>ab c</b> d"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_010_two_bracketed_items_with_spaces   
+    # Two bracketed items with spaces
+    # No special initialization
+    src = "*[a b] *[c d]"
+    exp = "<b>a b</b> <b>c d</b>"
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+  def test_bracketed_011_solitary_item_missing_right_bracket_ignored_at_eol_if_empty   
+    # Solitary item, missing right bracket ignored at eol if empty
+    # No special initialization
+    src = "*["
+    exp = ""
+    actual = @live.api.format(src)
+    check_match(exp, actual)
+  end
+ 
+
+end

data/test/extra/bracketed.txt

@@ -0,0 +1,44 @@
+Single bracketed item
+"*[abc]"
+"<b>abc</b>"
+--------------------------------
+End of line can replace bracket
+"*[abc"
+"<b>abc</b>"
+--------------------------------
+End of line can replace bracket again
+"abc *[d"
+"abc <b>d</b>"
+--------------------------------
+Missing right bracket ignored at eol if empty
+"abc*["
+"abc*["
+--------------------------------
+Two simple bracketed items
+"*[A], *[B], C"
+"<b>A</b>, <b>B</b>, C"
+--------------------------------
+Simple bracketed item
+"Just a *[test]..."
+"Just a <b>test</b>..."
+--------------------------------
+Bracketed item with space
+"A *[simple test]"
+"A <b>simple test</b>"
+--------------------------------
+Empty bracketed item results in null
+" *[] "
+"  "
+--------------------------------
+Bracketed item with space again
+"*[ab c] d"
+"<b>ab c</b> d"
+--------------------------------
+Two bracketed items with spaces
+"*[a b] *[c d]"
+"<b>a b</b> <b>c d</b>"
+--------------------------------
+Solitary item, missing right bracket ignored at eol if empty
+"*["
+""
+--------------------------------