livetext 0.9.46 → 0.9.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05c23cb9790ecbd684af4888ff8237bcf0aa792462bb1da1d183d18b786ab462
-  data.tar.gz: c0adc17493388b920557b09029213ab558fa43df3c6a7c23dce75d54c38fc298
+  metadata.gz: c1f67c2785b935c3c940db118d04f6613e186df48b4473659e14c69089e23a35
+  data.tar.gz: 6b08485471ca1c9aa2d44a83d9e5670f876999e70f3c20e975caa8fb3aadc2ac
 SHA512:
-  metadata.gz: a8717d55d1775c6947b79f008d6a01a64b5e3c084e936b79f7faa243b7776233734fb3e56518ac249faf95bf5b86cbfcde006b50e449762b6bb96788b8c84ec0
-  data.tar.gz: d552b53c1b82e5b650d65a9e49e45bdf80447ecc0a4af0a290e9d6415979ef71dd3c4da35ca6b1cacff42c062c4e7896613ce05175b0040147e00a349c8ecb3d
+  metadata.gz: 1becbb55d5267f754ee0c3dacc3c894fc6814aefd71386aaf0bc3f77f4dbefe76554d42ca78ade718e027b96874616219582dfcb0a4295eae10aac12bff11481
+  data.tar.gz: f169d21ca5e99b17869e10836fe4b4ae39cc5a239408562d95a3928e89b954f42184b2b51c8603e9d7570f3578acd81761417c56be7217942c7f4a8624089e8c

data/lib/livetext/errors.rb

@@ -10,16 +10,19 @@
   end
 
   def checkpoint(msg = nil)
+    return unless ENV['LIVETEXT_DEBUG'] == "true"
     file, line, meth = whence(1)
     display(file, line, meth, msg)
   end
 
   def checkpoint?(msg = nil)        # with sleep 3
+    return unless ENV['LIVETEXT_DEBUG'] == "true"
     file, line, meth = whence(1)
     display(file, line, meth, msg)
   end
 
   def checkpoint!(msg = nil)        # with pause
+    return unless ENV['LIVETEXT_DEBUG'] == "true"
     file, line, meth = whence(1)
     display(file, line, meth, msg)
     print "::: Pause..."
@@ -71,6 +74,3 @@ make_exception(:ExpectedDotEnd,    "Error: expected .end but found end of file")
 make_exception(:ExpectedAlphaNum,  "Error: expected an alphanumeric but foun '%1'")   # parser/set.rb
 make_exception(:ExpectedCommaEOS,  "Error: expected comma or end of string")          # parser/set.rb
 
-
-
-

data/lib/livetext/expansion.rb

@@ -8,7 +8,7 @@ class Livetext::Expansion
   Lbrack = "\\["
   Colon  = ":"
 
-  def initialize(instance)
+  def initialize(instance)   # Livetext::Expansion
     @live = instance
   end
 

data/lib/livetext/formatter.rb

@@ -1,14 +1,6 @@
 module Formatter
 
-## Hmmm...
-# 
-#  Double:  b, i, t, s
-#  Single:  bits
-#  Brackt:  bits
-# 
-
-
-  def self.format(str)
+  def self.format(str)    # FIXME - unneeded?
     str = str.chomp
     s2 = Double.process(str.chomp)
     s3 = Bracketed.process(s2)
@@ -16,8 +8,15 @@ module Formatter
     s4
   end
   
+  ## Hmmm...
+  # 
+  #  Double:  b, i, t, s
+  #  Single:  bits
+  #  Brackt:  bits
+  # 
+
   class Delimited
-    def initialize(str, marker, tag)
+    def initialize(str, marker, tag)    # Delimited
       @str, @marker, @tag = str.dup, marker, tag
       @buffer = ""
       @cdata  = ""
@@ -170,7 +169,7 @@ module Formatter
   end
 
   class Double < Delimited
-    def initialize(str, sigil, tag)
+    def initialize(str, sigil, tag)    # Double
       super
       # Convention: marker is "**", sigil is "*"
       @marker = sigil + sigil
@@ -183,7 +182,7 @@ module Formatter
   end
 
   class Bracketed < Delimited
-    def initialize(str, sigil, tag)
+    def initialize(str, sigil, tag)   # Bracketed
       super
       # Convention: marker is "*[", sigil is "*"
       @marker = sigil + "["

data/lib/livetext/functions.rb

@@ -19,7 +19,7 @@ class Livetext::Functions
     "\b"
   end
 
-# FIXME Function parameters need to be fixed...
+  # FIXME Function parameters need to be fixed...
 
   def isqrt(param = nil)      # "integer square root" - Just for testing
     arg = num = param         #  Takes any number

data/lib/livetext/handler/import.rb

@@ -9,7 +9,7 @@ class Livetext::Handler::Import
 
   attr_reader :file
 
-  def initialize(name)
+  def initialize(name)     # Livetext::Handler::Import
     @name = name
     @file = find_file(name)
   end

data/lib/livetext/handler/mixin.rb

@@ -9,7 +9,7 @@ class Livetext::Handler::Mixin
 
   attr_reader :file
 
-  def initialize(name, parent)
+  def initialize(name, parent)     # Livetext::Handler::Mixin
     @name = name
     @file = find_file(name, ".rb", "plugin")
     parent.graceful_error FileNotFound(name) if @file.nil?

data/lib/livetext/helpers.rb

@@ -2,9 +2,7 @@
 require_relative 'global_helpers'
 require_relative 'expansion'
 
-
 module Livetext::Helpers
-
   Space = " "
   Sigil = "." # Can't change yet
 
@@ -75,6 +73,7 @@ module Livetext::Helpers
 ## FIXME process_file[!] should call process[_text] ?
 
   def process_file(fname, btrace=false)
+checkpoint "fname = #{fname.inspect}"
     unless File.exist?(fname)
       api.dump
       raise FileNotFound(fname) 
@@ -127,6 +126,7 @@ module Livetext::Helpers
     api.data = data0.dup   # should permit _ in function names at least
     args0 = data0.split
     api.args = args0.dup
+checkpoint "name = #{name} args = #{args0.inspect}"
     retval = @main.send(name)  # , *args)      # was 125
     retval
   rescue => err
@@ -258,14 +258,6 @@ module Livetext::Helpers
     api.setvar(:File, file)
   end
 
-#   def dump(file = nil)   # not a dot command!
-#     file ||= ::STDOUT
-#     TTY.puts "--- Writing body (#{@body.size} bytes)" if @body
-#     file.puts @body
-#   rescue => err
-#     TTY.puts "#dump had an error: #{err.inspect}"
-#   end
-
   def graceful_error(err, msg = nil)
     api.dump
     STDERR.puts msg if msg

data/lib/livetext/html.rb

@@ -1,39 +1,6 @@
+class HTML    # FIXME - better as Livetext::HTML ?
 
-# module HTMLHelper
-# 
-#   def wrapped(str, *tags)   # helper
-#     open, close = open_close_tags(*tags)
-#     open + str + close
-#   end
-# 
-#   def wrapped!(str, tag, **extras)    # helper
-#     open, close = open_close_tags(tag)
-#     extras.each_pair do |name, value|
-#       open.sub!(">", " #{name}='#{value}'>")
-#     end
-#     open + str + close
-#   end
-# 
-#   def wrap(*tags)     # helper
-#     open, close = open_close_tags(*tags)
-#     api.out open
-#     yield
-#     api.out close
-#   end
-# 
-#   def open_close_tags(*tags)
-#     open, close = "", ""
-#     tags.each do |tag|
-#       open << "<#{tag}>"
-#       close.prepend("</#{tag}>")
-#     end
-#     [open, close]
-#   end
-# end
-
-class HTML
-
-  def initialize(api)
+  def initialize(api)   # HTML
     raise "API is nil!" unless api
     @api = api
     @indent = 0

data/lib/livetext/more.rb

@@ -5,10 +5,10 @@ class Livetext
 
   include Helpers
 
-  class Variables
+  class Variables      # FIXME - split out into file as Livetext::Variables
     attr_reader :vars
 
-    def initialize(hash = {})
+    def initialize(hash = {})   # Livetext::Variables
       @vars = {}
       hash.each_pair do |k, v| 
         sym = k.to_sym
@@ -98,7 +98,7 @@ class Livetext
     @save_location = where  # delegate
   end
 
-  def initialize(output = ::STDOUT)
+  def initialize(output = ::STDOUT)  # Livetext
     @source = nil
     @_mixins = []
     @_imports = []
@@ -123,8 +123,6 @@ class Livetext
     end
     call.each {|cmd| obj.main.send(cmd[1..-1]) }  # ignores leading dot, no param
     obj.api.setvars(vars)
-# puts "------ init: obj = "
-# p obj
     obj
   end
 

data/lib/livetext/parser/general.rb

@@ -6,7 +6,7 @@ make_exception(:ExpectedString,   "Error: expected a string")
 
 class Livetext::ParseGeneral < StringParser
 
-  def initialize(str)
+  def initialize(str)    # Livetext::ParseGeneral
     super
   end
 

data/lib/livetext/parser/set.rb

@@ -10,7 +10,7 @@ class Livetext::ParseSet < StringParser
     self.new(str).parse
   end
 
-  def initialize(line)
+  def initialize(line)   # Livetext::ParseSet
     super
   end
 

data/lib/livetext/parser/string.rb

@@ -2,7 +2,7 @@ class StringParser
 
   attr_reader :line, :eos, :i, :len
 
-  def initialize(line)
+  def initialize(line)   # StringParser
     raise NilValue if line.nil?
     raise ExpectedString unless String === line
     @line = line

data/lib/livetext/paths.rb

@@ -1,4 +1,4 @@
-# Reopening for paths... do differently?
+# Reopening for paths... do differently?  FIXME
 
 class Livetext
   def self.get_path(dir = "")

data/lib/livetext/processor.rb

@@ -23,7 +23,7 @@ class Processor
 
   attr_reader :parent, :sources
 
-  def initialize(parent, output = nil)
+  def initialize(parent, output = nil)   # Processor
     @parent = parent || self
     # STDERR.puts "PARENT.api = #{parent.api.inspect}"
     @parent.api ||= Livetext::UserAPI.new(@parent)
@@ -85,6 +85,4 @@ class Processor
     @sources.pop
     nil
   end
-
-
 end

data/lib/livetext/standard.rb

@@ -1,4 +1,3 @@
-
 require 'pathname'   # For _seek - remove later??
 
 require_relative 'parser'   # nested requires
@@ -9,7 +8,6 @@ make_exception(:ExpectedOnOff,    "Error: expected 'on' or 'off'")
 make_exception(:DisallowedName,   "Error: name '%1' is invalid")
 make_exception(:FileNotFound,     "Error: file '%1' not found")
 
-
 # Module Standard comprises most of the standard or "common" methods.
 
 module Livetext::Standard
@@ -74,6 +72,8 @@ module Livetext::Standard
     return true
   end
 
+  # FIXME - move these to a single universal place in code
+
   def h1(args = nil, body = nil); api.out html.tag(:h1, cdata: api.data); return true; end
   def h2(args = nil, body = nil); api.out html.tag(:h2, cdata: api.data); return true; end
   def h3(args = nil, body = nil); api.out html.tag(:h3, cdata: api.data); return true; end
@@ -258,7 +258,7 @@ module Livetext::Standard
   def dot_include(args = nil, body = nil)   # dot command
     file = api.expand_variables(api.args.first)  # allows for variables
     check_file_exists(file)
-# checkpoint "====== self.methods = #{self.methods.sort.inspect}"
+checkpoint 
     @parent.process_file(file)
     api.optional_blank_line
   end

data/lib/livetext/userapi.rb

@@ -4,8 +4,7 @@ require_relative 'html'
 # Encapsulate the UserAPI as a class
 
 class Livetext::UserAPI
-
-  include ::Livetext::Standard
+  include ::Livetext::Standard    # FIXME - feels wonky?
 
   KBD = File.new("/dev/tty", "r")
   TTY = File.new("/dev/tty", "w")
@@ -14,7 +13,7 @@ class Livetext::UserAPI
 
   attr_accessor :data, :args
 
-  def initialize(live)
+  def initialize(live)  # Livetext::UserAPI
     @live = live
     @vars = live.vars
     @html = HTML.new(self)
@@ -45,7 +44,7 @@ class Livetext::UserAPI
 # checkpoint "DATA = #{file.inspect}"
     api.data = file
     api.args = [file]
-    api.dot_include
+    dot_include
   end
 
   def expand_variables(str)
@@ -215,6 +214,5 @@ class Livetext::UserAPI
   def debug(*args)
     TTY.puts *args if @live.debug
   end
-
 end
 

data/lib/livetext/version.rb

@@ -2,5 +2,5 @@
 # Defining VERSION
 
 class Livetext
-  VERSION = "0.9.46"
+  VERSION = "0.9.47"
 end

data/lib/livetext.rb

@@ -1,6 +1,8 @@
 
 require_relative 'livetext/skeleton'
 require_relative 'livetext/version'
+require_relative 'livetext/helpers'
+require_relative 'livetext/more'
 require_relative 'livetext/paths'
 
 require_relative 'livetext/reopen'
@@ -11,8 +13,6 @@ require_relative 'livetext/functions'
 require_relative 'livetext/userapi'
 require_relative 'livetext/formatter'
 require_relative 'livetext/processor'
-require_relative 'livetext/helpers'
-require_relative 'livetext/more'
 
 require_relative 'livetext/handler'
 

data/test/snapshots/table_with_heredocs/expected-output.txt

@@ -5,11 +5,19 @@ Testing heredocs (used in a table)
 
 <center><table width=90% cellpadding=5>
 <tr>
-  <td valign=top>This is <br>only <br>a test.<br></td>
-  <td valign=top>This is <br>just <br>some <br>random text.<br></td>
+  <td valign=top>This is <br><br>
+only <br><br>
+a test.<br></td>
+  <td valign=top>This is <br><br>
+just <br><br>
+some <br><br>
+random text.<br></td>
 </tr>
 <tr>
-  <td valign=top>And so<br>is this.<br></td>
-  <td valign=top>This is <br>row 2<br>col 2<br></td>
+  <td valign=top>And so<br><br>
+is this.<br></td>
+  <td valign=top>This is <br><br>
+row 2<br><br>
+col 2<br></td>
 </tr>
 </table></center>

data/test/snapshots/table_with_heredocs/old-exp-out.txt

@@ -0,0 +1,15 @@
+Testing heredocs (used in a table)
+<p>
+
+<br>
+
+<center><table width=90% cellpadding=5>
+<tr>
+  <td valign=top>This is <br>only <br>a test.<br></td>
+  <td valign=top>This is <br>just <br>some <br>random text.<br></td>
+</tr>
+<tr>
+  <td valign=top>And so<br>is this.<br></td>
+  <td valign=top>This is <br>row 2<br>col 2<br></td>
+</tr>
+</table></center>

data/test/snapshots.rb

@@ -132,7 +132,7 @@ class TestingLivetext < MiniTest::Test
       @included - @excluded
     end
 
-    def initialize(base, assertion = nil)
+    def initialize(base, assertion = nil)    # Testing::Livetext
       @assertion = assertion
       @base = base
       @errors = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livetext
 version: !ruby/object:Gem::Version
-  version: 0.9.46
+  version: 0.9.47
 platform: ruby
 authors:
 - Hal Fulton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies: []
 description: A smart text processor extensible in Ruby
 email: rubyhacker@gmail.com
@@ -26,7 +26,6 @@ files:
 - imports/markdown.rb
 - imports/pyggish.rb
 - imports/tutorial.rb
-- lib/cmdargs.rb
 - lib/livetext.rb
 - lib/livetext/errors.rb
 - lib/livetext/expansion.rb
@@ -186,6 +185,7 @@ files:
 - test/snapshots/subset.txt
 - test/snapshots/table_with_heredocs/expected-error.txt
 - test/snapshots/table_with_heredocs/expected-output.txt
+- test/snapshots/table_with_heredocs/old-exp-out.txt
 - test/snapshots/table_with_heredocs/source.lt3
 - test/snapshots/var_into_func/expected-error.txt
 - test/snapshots/var_into_func/expected-output.txt

data/lib/cmdargs.rb

@@ -1,106 +0,0 @@
-
-require_relative 'livetext'
-
-=begin
-  Weird concepts to understand here...
-
-    1. A Livetext dot-command (flush left) usually looks like:
-         .foobar
-
-    2. A dot-command (left-indented) usually looks like:
-         $.foobar
-
-    3. More generally, it may have any number of parameters (0, 1, ...)
-         .redirect somefile.txt append
-
-    4. Variables and functions *can* appear (rare in practice??)
-         .redirect somefile$my_suffix $$my_mode
-
-    5. A trailing # comment may appear 
-       a. Stripped... saved in #raw ? #data ? #comment ? elsewhere?
-       b. NOT the "dot" as a comment!
-
-    6. .foobar  # This here is a comment
-
-    7. #data accessor returns all data on the .foo line...
-       a. ...After the initial space
-       b. ...Including later spaces
-       c. Including comment??
-       d. .foo This is  o n l y   a test.
-          # #data returns: "This is  o n l y   a test."
-       e. What about formatting???
-       f. What about: comments? variables? functions? 
-
-    8. Some commands have NO body while others have an OPTIONAL or REQUIRED body
-       a. Assume .cmd1 definition forbids a body (then a body is an error)
-          .cmd1   # may NOT have a body
-       b. Assume .cmd2 definition PERMITS a body
-          .cmd2   # may or MAY NOT have body/.end  
-       c. Assume .cmd3 definition REQUIRES a body
-          .cmd3   # REQUIRES a body/.end  
-          . stuff...
-          .end
-
-    9. Inside a body:
-       a. Leading dot has no special meaning (though the associated method may parse it!)
-       b. BUG? Currently leading dot is a comment INSIDE a body?
-       c. No leading char is special (though the associated method may parse it!)
-       d. No trailing #-comments (though the associated method may parse it!)
-       e. ?? We should or shouldn't look for variables/functions? or make it an option?
-       f. .end may naturally not be used (but see .raw where it may)
-
-   10. The args accessor is a simple array of strings
-       a. there is also raw_args (without variables/functions, etc.)
-       b. Much of this HAS NOT been thought through yet!      
-
-=end
-
-class Livetext::CmdData
-
-  attr_reader :data, :args, :nargs, :arity, :comment, :raw  # , ...?
-
-  def initialize(data, body: false, arity: :N)   # FIXME maybe just add **options ??
-    # arity:  (num)   fixed number 0 or more
-    #        :N       arbitrary number
-    #        n1..n2   range
-    # body:  true => this command has a body + .end
-    # how raw is raw?
-    #   remove comment - always/sometimes/never?
-    #   interpolate - always/sometimes/never?
-    #   interpolate inside body??
-    @data = data.dup     # comment? vars? funcs?
-    @raw  = data.dup     # comment? vars? funcs?
-    @args  = data.split  # simple array
-    @nargs = nargs       # not really "needed"
-    check_num_args(nargs)
-    # @varfunc = Livetext.interpolate(data.dup)
-  end
-
-  def check_num_args(num)
-    num_range = /(\d{0,2})(\.\.)(\d{0,2})/   # Not "really" right...
-    min, max = 0, 9999
-    mdata = num_range.match(@nargs).to_a
-    bad_args = nil
-    case 
-      when @nargs == ":N"          # arbitrary
-        # max already set
-      when mdata[2] == ".."           # range: 4..6 1.. ..4
-        vmin, vmax = mdata.values_at(1, 2)
-        min = Integer(vmin) unless vmin.empty?
-        max = Integer(vmax) unless vmax.empty?
-        min, max = Integer(min), Integer(max)
-      when %r[^\d+$] =~ num
-        min = max = Integer(num)  # can raise error
-      else
-        raise "Invalid value or range '#{num.inspect}'"
-    end
-
-    bad_args = @args.size.between?(min, max)
-    raise "Expected #{num} args but found #{@args.size}!" if bad_args
-  end
-
-  def strip_comments(str)
-    str.sub!(/ # .*/, "")
-  end
-
-end