livetext 0.9.20 → 0.9.21

data/bin/livetext

@@ -82,8 +82,6 @@ loop do
     when "-i", "--install"
       lib = ARGV.shift
       system("cp #{lib} #{Livetext::Path}/../plugin/")
-#   when /-.*/
-#     raise "Unknown argument '#{arg}'"
     when Object
       x.process_file(arg, true)  # , @backtrace)
   end

data/imports/markdown.rb

@@ -9,12 +9,12 @@ module Markdown
   SimpleFormats[:s] = %w[<strike> </strike>]
 
 
-  def h1(args = nil, body = nil); _out "# #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end       # atx style for now
-  def h2(args = nil, body = nil); _out "## #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-  def h3(args = nil, body = nil); _out "### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-  def h4(args = nil, body = nil); _out "#### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-  def h5(args = nil, body = nil); _out "##### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-  def h6(args = nil, body = nil); _out "###### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
+  def h1(args = nil, body = nil); _out "# #{Livetext.interpolate(@_data)}"; _optional_blank_line end       # atx style for now
+  def h2(args = nil, body = nil); _out "## #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h3(args = nil, body = nil); _out "### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h4(args = nil, body = nil); _out "#### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h5(args = nil, body = nil); _out "##### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h6(args = nil, body = nil); _out "###### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
 
   def title(args = nil, body = nil)
     h1

data/imports/markdown_importable.rb

@@ -3,44 +3,43 @@
 
 require_relative '../lib/livetext/importable'
 
-  class MarkdownImportable < LiveText::Importable
-
-    SimpleFormats[:b] = %w[* *]
-    SimpleFormats[:i] = %w[_ _]
-    SimpleFormats[:t] = %w[` `]
-    SimpleFormats[:s] = %w[<strike> </strike>]
-
-    def h1; _out "# #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end       # atx style for now
-    def h2; _out "## #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-    def h3; _out "### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-    def h4; _out "#### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-    def h5; _out "##### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-    def h6; _out "###### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-
-    def title
-      h1
-    end
+class MarkdownImportable < LiveText::Importable
+
+  SimpleFormats[:b] = %w[* *]
+  SimpleFormats[:i] = %w[_ _]
+  SimpleFormats[:t] = %w[` `]
+  SimpleFormats[:s] = %w[<strike> </strike>]
+
+  def h1; _out "# #{Livetext.interpolate(@_data)}"; _optional_blank_line end       # atx style for now
+  def h2; _out "## #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h3; _out "### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h4; _out "#### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h5; _out "##### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+  def h6; _out "###### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+
+  def title
+    h1
+  end
 
-    def section
-      h3
-    end
+  def section
+    h3
+  end
 
-    def bq   # block quote
-      _body {|line| _out "> #{line}" }
-    end
+  def bq   # block quote
+    _body {|line| _out "> #{line}" }
+  end
 
-    def list
-      _body {|line| _out " * #{line}" }
-    end
+  def list
+    _body {|line| _out " * #{line}" }
+  end
 
-    def olist   # Doesn't handle paragraphs yet
-      n = 0
-      _body do |line|
-        n += 1
-        _out "#{n}. #{_format(line)}"
-      end
+  def olist   # Doesn't handle paragraphs yet
+    n = 0
+    _body do |line|
+      n += 1
+      _out "#{n}. #{_format(line)}"
     end
-
-    alias nlist olist
   end
+
+  alias nlist olist
 end

data/imports/tutorial.rb

@@ -85,7 +85,7 @@ module Tutorial
   def testcase(args = nil, body = nil)
     name = _args.first
     _out "\n<font size=+1><b>Test: </font><font size=+2><tt>#{name}</tt></font></b></h3><br>"
-    src, exp = "test/data/#{name}/source.lt3", "test/data/#{name}/expected-output.txt"
+    src, exp = "test/snapshots/#{name}/source.lt3", "test/snapshots/#{name}/expected-output.txt"
     @_args = [src, exp]   # Better way to do this??
     put_table(src, exp)
     _out "<br>"

data/lib/cmdargs.rb

@@ -4,44 +4,53 @@ require_relative 'livetext'
   Weird concepts to understand here...
 
     1. A Livetext dot-command (flush left) usually looks like:
-       .foobar
+         .foobar
+
     2. A dot-command (left-indented) usually looks like:
-           $.foobar
+         $.foobar
+
     3. More generally, it may have any number of parameters (0, 1, ...)
-       .redirect somefile.txt append
+         .redirect somefile.txt append
+
     4. Variables and functions *can* appear (rare in practice??)
-       .redirect somefile$my_suffix $$my_mode
+         .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 spaces
+       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? 
 
-    7. Some commands have NO body while others have an OPTIONAL or REQUIRED body
+    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 PERMITS a body
+       c. Assume .cmd3 definition REQUIRES a body
           .cmd3   # REQUIRES a body/.end  
           . stuff...
           .end
-    8. Inside a body:
-    8a. Leading dot has no special meaning (though the associated method may parse it!)
-    8b. BUG? Currently leading dot is a comment INSIDE a body?
-    8a. No leading char is special (though the associated method may parse it!)
-    8a. No trailing #-comments (though the associated method may parse it!)
-    8c. ?? We should or shouldn't look for variables/functions? or make it an option?
-    8d. .end may naturally not be used (but see .raw where it may)
-    9. the args accessor is a simple array of strings
 
+    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
 
@@ -64,11 +73,11 @@ class Livetext::CmdData
     @nargs = nargs       # not really "needed"
     check_num_args(nargs)
     
-    # @varfunc = _var_func_parse(data.dup)
+    # @varfunc = Livetext.interpolate(data.dup)
   end
 
   def check_num_args(num)
-    num_range = /(\d{0,2})(\.\.)(\d{0,2})/
+    num_range = /(\d{0,2})(\.\.)(\d{0,2})/   # Not "really" right...
     min, max = 0, 9999
     md = num_range.match(@nargs).to_a
     bad_args = nil

data/lib/formatline.rb

@@ -52,7 +52,7 @@ class FormatLine < StringParser
           marker peek
           add peek
         when LF
-          break if @i >= line.size - 1
+          break if eos?  # @i >= line.size - 1
         when nil
           break
         else
@@ -117,11 +117,11 @@ class FormatLine < StringParser
           if [:colon, :brackets].include? arg[0] 
             arg = gen.next  # for real
             param = arg[1]
-            param = FormatLine.var_func_parse(param)
+            param = Livetext.interpolate(param)
           end
           @out << funcall(val, param)
         when :b, :i, :t, :s
-          val = FormatLine.var_func_parse(val)
+          val = Livetext.interpolate(val)
           @out << embed(sym, val)
       else
         add_token :str
@@ -199,7 +199,7 @@ class FormatLine < StringParser
     str = Null.dup
     grab
     loop do
-      break if eos?   # peek.nil?
+      break if peek.nil?   # eos?
       str << peek
       break if terminate?(NoAlphaDot, next!)
       grab

data/lib/helpers.rb

@@ -4,6 +4,9 @@ module Helpers
   Space = " "
   Sigil = "." # Can't change yet
 
+  ESCAPING = { "'" => ''', '&' => '&', '"' => '"',
+               '<' => '&lt;', '>' => '&gt;' }
+
   def escape_html(string)
     enc = string.encoding
     unless enc.ascii_compatible?
@@ -12,12 +15,12 @@ module Helpers
         enc = Encoding::Converter.asciicompat_encoding(enc)
         string = enc ? string.encode(enc) : string.b
       end
-      table = Hash[TABLE_FOR_ESCAPE_HTML__.map {|pair|pair.map {|s|s.encode(enc)}}]
+      table = Hash[ESCAPING.map {|pair|pair.map {|s|s.encode(enc)}}]
       string = string.gsub(/#{"['&\"<>]".encode(enc)}/, table)
       string.encode!(origenc) if origenc
       return string
     end
-    string.gsub(/['&\"<>]/, TABLE_FOR_ESCAPE_HTML__)
+    string.gsub(/['&\"<>]/, ESCAPING)
   end
 
   def find_file(name, ext=".rb")
@@ -61,7 +64,7 @@ module Helpers
     @body
   end
 
-  def process_line(line)  # FIXME inefficient?
+  def process_line(line)
     nomarkup = true
     case line  # must apply these in order
       when Comment
@@ -90,6 +93,29 @@ module Helpers
         raise EndWithoutOpening()
       when @main.respond_to?(name)
         result = @main.send(name)
+
+        # NOTE: The above line is where the magic happens!
+        # A name like 'foobar' results in an invocation of 
+        # @main.foobar (where @main is a Processor, and any
+        # new methods (e.g. from a mixin) are added to @main
+        # 
+        # So all the functionality from _args and _raw_args
+        # and _data (among others?) will be encapsulated in
+        # 'some' kind of PORO which handles access to all 
+        # these things as well as the 'body' between the
+        # command and its corresponding .end
+        # 
+        # The 'body' functionality is so commonly used, I plan
+        # to pass it in separately as needed (even though the
+        # args object should make it available also).
+        # 
+        # Every method corresponding to a dot commmand will 
+        # get args and body passed in as needed. Every one of
+        # the signatures already has (args = nil, body = nil)
+        # but nothing is being passed in that way yet.
+        #
+        # Refer to lib/cmdargs.rb for more! This is *strictly*
+        # experimental and a "work in progress."
     else
       puts @body  # earlier correct output, not flushed yet
       raise "Name '#{name}' is unknown"
@@ -105,8 +131,8 @@ module Helpers
     name, data = line.split(" ", 2)
     name = name[1..-1]  # chop off sigil
     name = "dot_" + name if %w[include def].include?(name)
-    @main.data = data
     @main.check_disallowed(name)
+    @main.data = data
     name
   end
 

data/lib/livetext.rb

@@ -1,7 +1,7 @@
 # Class Livetext skeleton (top level).
 
 class Livetext
-  VERSION = "0.9.20"
+  VERSION = "0.9.21"
   Path  = File.expand_path(File.join(File.dirname(__FILE__)))
 
   module Handler

data/lib/parser/general.rb

@@ -27,7 +27,7 @@ class Livetext::ParseGeneral < StringParser
     lines.each do |line|
       next if line.strip.empty?
       var, value = line.split(" ", 2)
-      val = FormatLine.var_func_parse(value)
+      val = Livetext.interpolate(value)
       var = prefix + "." + var if prefix
       pairs << [var, value]
     end

data/lib/parser/set.rb

@@ -31,8 +31,8 @@ class Livetext::ParseSet < StringParser
     pairs = []
     char = nil
     loop do
-      break if eos?   # end of string
       char = skip_spaces
+      break if eos?   # end of string
       raise "Expected alpha to start var name" unless char =~ /[a-z]/i
       pairs << assignment
       char = skip_spaces
@@ -56,7 +56,7 @@ class Livetext::ParseSet < StringParser
     var = get_var
     skip_equal
     value = get_value
-    value = FormatLine.var_func_parse(value)    # FIXME broken now?
+    value = Livetext.interpolate(value)
     pair = [var, value]
     pair
   end

data/lib/parser/string.rb

@@ -15,12 +15,13 @@ class StringParser
     return nil if @eos
     char = @line[@i]
     @i += 1
-    @eos = true if @i > @len
+    check_eos
     char
   end
 
   def ungrab
-    @i -= 1    # FIXME what about eos...?
+    @i -= 1
+    check_eos
   end
 
   def next!
@@ -32,12 +33,7 @@ class StringParser
     @line[@i-1]
   end
 
-  def last?
-    @i > @len - 1
-  end
-
   def eos?
-    @eos = true if last? # duh?
     @eos
   end
 
@@ -52,11 +48,16 @@ class StringParser
       char = peek
       break if eos?
       break if char != " "
-      grab
+      char = grab
     end
     char
   end
 
+  private
+
+  def check_eos
+    @eos = @i >= @len
+  end
 end
 
 =begin

data/lib/processor.rb

@@ -2,6 +2,10 @@
 
 class Livetext
 
+  def self.interpolate(str)
+    FormatLine.var_func_parse(str)
+  end
+
   # Class Processor does the actual work of processing input.
 
   class Processor
@@ -11,17 +15,21 @@ class Livetext
     include Livetext::Standard
     include Livetext::UserAPI
 
-    Disallowed = %i[ !  !=  !~  <=>  ==  ===   =~         __binding__   __id__    __send__   class
-                     clone      define_singleton_method   display       dup      enum_for    eql?       
-                     equal?     extend      freeze        frozen?       hash     inspect     instance_eval          
-                     instance_exec          instance_of?  instance_variable_defined?         
-                     instance_variable_get  instance_variable_set       instance_variables   is_a?          
-                     kind_of?               method        methods       nil?                 object_id          
-                     pretty_inspect         private_methods             protected_methods    public_method          
-                     public_methods         public_send                 remove_instance_variable          
-                     respond_to?            send          singleton_class                    singleton_method          
-                     singleton_methods      taint         tainted?      tap                  to_enum          
-                     to_s                   trust         untaint       untrust              untrusted?]
+    Disallowed = 
+       %i[ __binding__        __id__            __send__          class
+           clone              display           dup               enum_for
+           eql?               equal?            extend            freeze
+           frozen?            hash              inspect           instance_eval   
+           instance_exec      instance_of?      is_a?             kind_of?
+           method             methods           nil?              object_id          
+           pretty_inspect     private_methods   protected_methods public_method
+           public_methods     public_send       respond_to?       send
+           singleton_class    singleton_method  singleton_methods taint
+           tainted?           tap               to_enum           to_s
+           trust              untaint           untrust           untrusted?
+           define_singleton_method              instance_variable_defined?
+           instance_variable_get                instance_variable_set
+           remove_instance_variable             instance_variables ]
 
     def initialize(parent, output = nil)
       @parent = parent

data/lib/standard.rb

@@ -187,7 +187,7 @@ module Livetext::Standard
     text = _body.join("\n")
     rhs = ""
     text.each_line do |line|
-      str = FormatLine.var_func_parse(line.chomp)
+      str = Livetext.interpolate(line.chomp)
       rhs << str + "<br>"
     end
     indent = @parent.indentation.last

data/lib/userapi.rb

@@ -114,9 +114,9 @@ module Livetext::UserAPI
   end
 
   def _format(line)
-    return "" if line == "\n"
+    return "" if line == "\n" || line.nil?
     line2 = FormatLine.parse!(line)
-    line.replace(line2) unless line.nil?
+    line.replace(line2)
     line
   end
 

data/plugin/markdown.rb

@@ -8,12 +8,12 @@ SimpleFormats[:t] = %w[` `]
 SimpleFormats[:s] = %w[<strike> </strike>]
 
 
-def h1(args = nil, body = nil); _out "# #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end       # atx style for now
-def h2(args = nil, body = nil); _out "## #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-def h3(args = nil, body = nil); _out "### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-def h4(args = nil, body = nil); _out "#### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-def h5(args = nil, body = nil); _out "##### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
-def h6(args = nil, body = nil); _out "###### #{FormatLine.var_func_parse(@_data)}"; _optional_blank_line end
+def h1(args = nil, body = nil); _out "# #{Livetext.interpolate(@_data)}"; _optional_blank_line end       # atx style for now
+def h2(args = nil, body = nil); _out "## #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+def h3(args = nil, body = nil); _out "### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+def h4(args = nil, body = nil); _out "#### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+def h5(args = nil, body = nil); _out "##### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
+def h6(args = nil, body = nil); _out "###### #{Livetext.interpolate(@_data)}"; _optional_blank_line end
 
 def title(args = nil, body = nil)
   h1

data/plugin/tutorial.rb

@@ -52,8 +52,9 @@ def inout(args = nil, body = nil)
 end
 
 def put_table(src, exp)
-  t1 = ::File.readlines(src) rescue (abort "t1 = #{src}")
-  t2 = ::File.readlines(exp) rescue (abort "t2 = #{out}")
+STDERR.puts "put_table: #{[src, exp].inspect}"
+  t1 = ::File.readlines(src) rescue (abort "Fail - src = #{src}  t1 = #{src}")
+  t2 = ::File.readlines(exp) rescue (abort "Fail - src = #{exp}  t2 = #{out}")
   t1 = t1.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
   t2 = t2.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
 
@@ -80,7 +81,7 @@ end
 def testcase(args = nil, body = nil)
   name = _args.first
   _out "\n<font size=+1><b>Test: </font><font size=+2><tt>#{name}</tt></font></b></h3><br>"
-  src, exp = "test/data/#{name}/source.lt3", "test/data/#{name}/expected-output.txt"
+  src, exp = "test/snapshots/#{name}/source.lt3", "test/snapshots/#{name}/expected-output.txt"
   @_args = [src, exp]   # Better way to do this??
   put_table(src, exp)
   _out "<br>"

data/test/snapshots/subset.txt

@@ -0,0 +1,84 @@
+# This file specifies which snapshots will/won't be run.
+
+# Blank lines and comments are ignored.
+# Other lines:  name_of_snapshot and any comments here are ignored (no # needed)
+
+# You can start by uncommenting one of these:
+# Default INCLUDE all
+# Default EXCLUDE all
+# If you use neither, INCLUDE is the default (but explicit is better)
+
+# If you include all, you can specify exclusions with an x:
+# x  my_test_name           # this is a comment
+
+# Likewise if you EXCLUDE all, you can specify inclusions with an i:
+# i  some_other_test        # this is a comment
+
+# The i and x (to include/exclude) must be the first token on
+#   the line (preceding the test name)
+
+# Note that QUIT (on a line by itself) will stop processing the file
+
+x  error_no_such_inc        # Output BEFORE error doesn't get passed through ("leading" output)
+x  error_no_such_copy       # ^ Same behavior as  error_no_such_inc
+x  error_no_such_mixin      # ^ Same behavior as error_missing_end
+x  error_invalid_name       # ^ Same behavior as error_no_such_inc
+x  error_missing_end        # Output is duplicated somehow. Look for: puts @body or puts @main.body
+x  error_inc_line_num       # Forgot what's wrong here
+
+# Dummy command .icanhaz works like .mixin or .import
+
+x  icanhaz                  # "Leading" output doesn't get generated (same as error_no_such_inc)
+   icanhaz2                 # works?
+
+# Others (usually passing):
+
+# import/include/mixin, others...
+
+   simple_copy              #                    
+x  simple_import            # not working yet (but *could* sub in .icanhaz)
+   simple_include           #                            
+   simple_mixin             #                            
+                     
+# raw input                     
+                     
+   single_raw_line          #  
+   raw_lines                #  
+   raw_text_block           #  
+   copy_is_raw              #  
+                     
+# comments                     
+                     
+   block_comment            #                              
+   comments_ignored_1       #  
+                     
+# variables and heredocs                     
+                     
+   predef_vars              #  
+   simple_vars              #  
+   more_complex_vars        #  
+   table_with_heredocs      #  
+
+# testing def
+
+   def_method               #  
+                     
+# intraline formatting
+
+   basic_formatting         #  
+
+# Errors
+
+   error_line_num           #  
+   error_mismatched_end     #  
+   error_name_not_permitted #  
+
+# functions
+
+   functions                #  
+
+# More/misc...                     
+                     
+   example_alpha            #  
+   example_alpha2           #  
+   hello_world              #