livetext 0.9.21 → 0.9.25

data/plugin/pyggish.rb

@@ -1,44 +1,44 @@
 require 'rouge'
 
-  def self.pyg_change(code, klass, style)
-    color = style[0..6]
-    modifier = style[8]
-    mod_open = modifier ? "<#{modifier}>" : ""
-    mod_close = modifier ? "</#{modifier}>" : ""
-    rx = /<span class="#{klass}">(?<cname>[^<]+?)<\/span>/
-    loop do
-      md = rx.match(code)
-      break if md.nil?
-      str = md[:cname]
-      result = code.sub!(rx, "<font color=#{color}>#{mod_open}#{str}#{mod_close}</font>")
-      break if result.nil?
-    end
+# FIXME This whole file has a weird vibe. It has dead code and 
+# also exposes methods that are not dot commands...
+
+def self.pyg_change(code, klass, style)
+  color = style[0..6]
+  modifier = style[8]
+  mod_open = modifier ? "<#{modifier}>" : ""
+  mod_close = modifier ? "</#{modifier}>" : ""
+  rx = /<span class="#{klass}">(?<cname>[^<]+?)<\/span>/
+  loop do
+    md = rx.match(code)
+    break if md.nil?
+    str = md[:cname]
+    result = code.sub!(rx, "<font color=#{color}>#{mod_open}#{str}#{mod_close}</font>")
+    break if result.nil?
   end
+end
 
-  def self._codebar_color(lexer)
-    color = case lexer
-      when :elixir
-        "#fc88fc"
-      when :ruby
-        "#fc8888"
-      else
-        raise "Unknown lexer"
-    end
+def self._codebar_color(lexer)
+  color = case lexer
+    when :elixir
+      "#fc88fc"
+    when :ruby
+      "#fc8888"
+    else
+      raise "Unknown lexer"
   end
+end
 
-  def self.pyg_finalize(code, lexer=:elixir)
-    Styles.each_pair {|klass, style| pyg_change(code, klass, style) }
-File.open("debug-pf1", "w") {|f| f.puts code }
-    code.sub!(/<pre>/, "<pre>\n")
-    code.gsub!(/<span class="[np]">/, "")
-    code.gsub!(/<\/span>/, "")
+def self.pyg_finalize(code, lexer=:elixir)
+  Styles.each_pair {|klass, style| pyg_change(code, klass, style) }
+  code.sub!(/<pre>/, "<pre>\n")
+  code.gsub!(/<span class="[np]">/, "")
+  code.gsub!(/<\/span>/, "")
     color = _codebar_color(lexer)
     code.sub!(/<td class="linenos"/, "<td width=2%></td><td width=5% bgcolor=#{color}")
     code.gsub!(/<td/, "<td valign=top ")
     code.gsub!(/ class="[^"]*?"/, "")    # Get rid of remaining Pygments CSS
-File.open("debug-pf2", "w") {|f| f.puts code }
     lines = code.split("\n")
-#   lines.each {|line| line << "\n" }
     n1 = lines.index {|x| x =~ /<pre>/ }
     n2 = lines.index {|x| x =~ /<\/pre>/ }
     # FIXME ?
@@ -47,157 +47,126 @@ File.open("debug-pf2", "w") {|f| f.puts code }
     lines[n1].sub!(/ 1$/, "  1 ")
     (n1+1).upto(n2) {|n| lines[n].replace(" " + lines[n] + " ") }
     code = lines.join("\n")
-File.open("debug-pf3", "w") {|f| f.puts code }
     code
   end
 
-
-def _process_code(text)
-File.open("debug-pc1", "w") {|f| f.puts text }
-  lines = text.split("\n")
-  lines = lines.select {|x| x !~ /##~ omit/ }
-  @refs = {}
-  lines.each.with_index do |line, i|
-    if line =~ /##~ ref/
-      frag, name = line.split(/ *##~ ref/)
-      @refs[name.strip] = i
-      line.replace(frag)
+  def _process_code(text)
+    lines = text.split("\n")
+    lines = lines.select {|x| x !~ /##~ omit/ }
+    @refs = {}
+    lines.each.with_index do |line, i|
+      if line =~ /##~ ref/
+        frag, name = line.split(/ *##~ ref/)
+        @refs[name.strip] = i
+        line.replace(frag)
+      end
     end
+    lines.map! {|line| "  " + line }
+    text2 = lines.join("\n")
+    text.replace(text2)
   end
-  lines.map! {|line| "  " + line }
-  text2 = lines.join("\n")
-File.open("debug-pc2", "w") {|f| f.puts text2 }
-  text.replace(text2)
-end
-
-def _colorize(code, lexer=:elixir)
-  text = ::Pygments.highlight(code, lexer: lexer, options: {linenos: "table"})
-  _debug "--- in _colorize: text = #{text.inspect}"
-  text2 = PygmentFix.pyg_finalize(text, lexer)
-  result = "<!-- colorized code -->\n" + text2
-  result
-end
 
-def _colorize!(code, lexer=:elixir)
-  text = ::Pygments.highlight(code, lexer: lexer, options: {})
-  _debug "--- in _colorize!: text = #{text.inspect}"
-  text2 = PygmentFix.pyg_finalize(text, lexer)
-  result = "<!-- colorized code -->\n" + text2
-  result
-end
-
-def OLD_ruby
-  file = @_args.first 
-  if file.nil?
-    code = "# Ruby code\n"
-    _body {|line| code << line + "\n" }
-  else
-    code = "# Ruby code\n\n" + ::File.read(file)
+  def _colorize(code, lexer=:elixir)
+    text = ::Pygments.highlight(code, lexer: lexer, options: {linenos: "table"})
+    _debug "--- in _colorize: text = #{text.inspect}"
+    text2 = PygmentFix.pyg_finalize(text, lexer)
+    result = "<!-- colorized code -->\n" + text2
+    result
   end
 
-  _process_code(code)
-  html = _colorize(code, :ruby)
-  _out "\n#{html}\n "
-end
-
-def OLD_elixir
-  file = @_args.first 
-  if file.nil?
-    code = ""
-    _body {|line| code << line + "\n" }
-  else
-    code = ::File.read(file)
+  def _colorize!(code, lexer=:elixir)
+    text = ::Pygments.highlight(code, lexer: lexer, options: {})
+    _debug "--- in _colorize!: text = #{text.inspect}"
+    text2 = PygmentFix.pyg_finalize(text, lexer)
+    result = "<!-- colorized code -->\n" + text2
+    result
   end
 
-  _process_code(code)
-  html = _colorize(code, :elixir)
-  _out "\n#{html}\n "
-end
-
-def fragment
-  lang = @_args.empty? ? :elixir : @_args.first.to_sym   # ruby or elixir
-  @_args = []
-  send(lang)
-  _out "\n"
-end
-
-def code       # FIXME ?
-  text = ""   
-  _body {|line| _out "    " + line }
-end
+  def fragment
+    lang = api.args.empty? ? :elixir : api.args.first.to_sym   # ruby or elixir
+    api.args = []
+  # TTY.puts "\n#{self.inspect}"
+    send(lang)
+    api.out "\n"
+  end
 
-def mono
-  _out "<pre>"
-  _body {|line| _out "    " + line }
-  _out "</pre>"
-end
+  def code       # FIXME ?
+    text = ""   
+    api.body {|line| api.out "    " + line }
+  end
 
-def create_code_styles
-  dir = @_outdir || "."
-  theme, back = "Github", "white"
-  css = Rouge::Themes.const_get(theme).render(scope: '.rb_highlight')
-  added = <<~CSS
-    .rb_highlight { 
-    font-family: 'Monaco', 'Andale Mono', 'Lucida Grande', 'Courier', 'Lucida Console', 'Courier New', monospace;
-    white-space: pre; 
-    background-color: #{back} 
-    }
-  CSS
-
-  css.gsub!(/{\n/, "{\n  font-family: courier;")
-  css = added + "\n" + css
-  # STDERR.puts "Writing #{theme} theme to ruby.css"
-  File.write("#{dir}/ruby.css", css)
-
-  css = Rouge::Themes.const_get(theme).render(scope: '.ex_highlight')
-  added = added.sub(/rb/, "ex")
-  css.gsub!(/{\n/, "{\n  font-family: courier;")
-  css = added + "\n" + css 
-  # STDERR.puts "Writing #{theme} theme to elixir.css"
-  File.write("#{dir}/elixir.css", css)
-end
+  def mono
+    api.out "<pre>"
+    api.body {|line| api.out "    " + line }
+    api.out "</pre>"
+  end
 
+  def create_code_styles
+    dir = @_outdir || "."
+    theme, back = "Github", "white"
+    css = Rouge::Themes.const_get(theme).render(scope: '.rb_highlight')
+    added = <<~CSS
+      .rb_highlight { 
+      font-family: 'Monaco', 'Andale Mono', 'Lucida Grande', 'Courier', 'Lucida Console', 'Courier New', monospace;
+      white-space: pre; 
+      background-color: #{back} 
+      }
+    CSS
+
+    css.gsub!(/{\n/, "{\n  font-family: courier;")
+    css = added + "\n" + css
+    # STDERR.puts "Writing #{theme} theme to ruby.css"
+    File.write("#{dir}/ruby.css", css)
+
+    css = Rouge::Themes.const_get(theme).render(scope: '.ex_highlight')
+    added = added.sub(/rb/, "ex")
+    css.gsub!(/{\n/, "{\n  font-family: courier;")
+    css = added + "\n" + css 
+    # STDERR.puts "Writing #{theme} theme to elixir.css"
+    File.write("#{dir}/elixir.css", css)
+  end
 
-def format_ruby(source, theme = "Github", back = "black")
-  # theme/back not used now
-  formatter = Rouge::Formatters::HTML.new
-  lexer = Rouge::Lexers::Ruby.new
-  body = formatter.format(lexer.lex(source))
-  text = "<div class=rb_highlight>#{body}</div>"
-  text
-end
 
-def format_elixir(source, theme = "Github", back = "black")
-  # theme/back not used now
-  formatter = Rouge::Formatters::HTML.new
-  lexer = Rouge::Lexers::Elixir.new
-  body = formatter.format(lexer.lex(source))
-  text = "<div class=ex_highlight>#{body}</div>"
-  text
-end
+  def format_ruby(source, theme = "Github", back = "black")
+    # theme/back not used now
+    formatter = Rouge::Formatters::HTML.new
+    lexer = Rouge::Lexers::Ruby.new
+    body = formatter.format(lexer.lex(source))
+    text = "<div class=rb_highlight>#{body}</div>"
+    text
+  end
 
-def ruby
-  file = @_args.first 
-  if file.nil?
-    code = "  # Ruby code\n\n"
-    _body {|line| code << "  " + line + "\n" }
-  else
-    code = "# Ruby code\n\n" + ::File.read(file)
+  def format_elixir(source, theme = "Github", back = "black")
+    # theme/back not used now
+    formatter = Rouge::Formatters::HTML.new
+    lexer = Rouge::Lexers::Elixir.new
+    body = formatter.format(lexer.lex(source))
+    text = "<div class=ex_highlight>#{body}</div>"
+    text
   end
 
-  html = format_ruby(code)
-  _out html
-end
+  def ruby
+    file = api.args.first 
+    if file.nil?
+      code = "  # Ruby code\n\n"
+      api.body {|line| code << "  " + line + "\n" }
+    else
+      code = "# Ruby code\n\n" + ::File.read(file)
+    end
 
-def elixir
-  file = @_args.first 
-  if file.nil?
-    code = ""
-    _body {|line| code << "  " + line + "\n" }
-  else
-    code = ::File.read(file)
+    html = format_ruby(code)
+    api.out html
   end
 
-  html = format_elixir(code)
-  _out html
+  def elixir
+    file = api.args.first 
+    if file.nil?
+      code = ""
+      api.body {|line| code << "  " + line + "\n" }
+    else
+      code = ::File.read(file)
+    end
+
+    html = format_elixir(code)
+    api.out html
 end

data/plugin/tutorial.rb

@@ -2,22 +2,22 @@ require 'cgi'
 
 def title(args = nil, body = nil)
   h1
-  _optional_blank_line
+  api.optional_blank_line
 end
 
 def section(args = nil, body = nil)
   h3
-  _optional_blank_line
+  api.optional_blank_line
 end
 
 def code(args = nil, body = nil)
   first = true  # dumb hack! fixes blank space
-  _body do |line| 
+  api.body do |line| 
     tag, first = "<pre>", false if first
-    _out "#{tag}   #{::CGI.escape_html(line)}"   # indentation
+    api.out "#{tag}   #{::CGI.escape_html(line)}"   # indentation
   end
-  _out "</pre>"
-  _optional_blank_line
+  api.out "</pre>"
+  api.optional_blank_line
 end
 
 def rx(str)
@@ -25,14 +25,14 @@ def rx(str)
 end
 
 def inout(args = nil, body = nil)
-  src, out = _args
+  src, out = api.args
   t1 = ::File.readlines(src) rescue (abort "t1 = #{src}")
   t2 = ::File.readlines(out) rescue (abort "t2 = #{out}")
   # To pacify markdown for README (FIXME later)
   t1 = t1.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
   t2 = t2.map {|x| " " + x.sub(/ +$/,"").gsub(/_/, "\\_") }.join
 
-  _out <<-HTML
+  api.out <<-HTML
     <table width=80% cellpadding=4>
     <tr>
       <td width=50%><b>Input</b></td>
@@ -48,17 +48,16 @@ def inout(args = nil, body = nil)
     </tr>
     </table>
   HTML
-  _optional_blank_line
+  api.optional_blank_line
 end
 
 def put_table(src, exp)
-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
 
-  _out <<-HTML
+  api.out <<-HTML
     <font size=+1>
     <table width=80% cellpadding=4>
     <tr>
@@ -79,11 +78,11 @@ STDERR.puts "put_table: #{[src, exp].inspect}"
 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>"
+  name = api.args.first
+  api.out "\n<font size=+1><b>Test: </font><font size=+2><tt>#{name}</tt></font></b></h3><br>"
   src, exp = "test/snapshots/#{name}/source.lt3", "test/snapshots/#{name}/expected-output.txt"
-  @_args = [src, exp]   # Better way to do this??
+  api.args = [src, exp]   # Better way to do this??
   put_table(src, exp)
-  _out "<br>"
-  _optional_blank_line
+  api.out "<br>"
+  api.optional_blank_line
 end

data/test/all.rb

@@ -1,3 +1,9 @@
+require 'simplecov'            # These two lines must go first
+SimpleCov.start  do
+  puts "SimpleCov: Snapshots"
+  enable_coverage :branch
+  add_filter "/test/"
+end
 
 require_relative 'unit/all'
 require_relative 'snapshots'             # snapshots

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

@@ -1,5 +1,7 @@
 abc
 123
 xyz
+<p>
+
 xyzzy
 123

data/test/snapshots/def_method/source.lt3

@@ -2,10 +2,12 @@
 abc
 123
 .def foobar     # yet another experimental comment
-::STDERR.puts "This is the"
-::STDERR.puts "foobar method"
+  ::STDERR.puts "This is the"
+  ::STDERR.puts "foobar method"
+  true
 .end
 xyz
 .foobar     # and still another
+
 xyzzy
 123

data/test/snapshots/error_inc_line_num/OUT

@@ -0,0 +1,17 @@
+This is my 
+source file
+which includes file2 here:
+  This is file2
+  which has an error
+  about an unknown command
+  in line 5
+This is my 
+source file
+which includes file2 here:
+  This is file2
+  which has an error
+  about an unknown command
+  in line 5
+<p>
+
+  And this is file2 line 7.

data/test/snapshots/error_inc_line_num/README.txt

@@ -0,0 +1,20 @@
+---- File: source.lt3
+
+This is my 
+source file
+which includes file2 here:
+.include file2.lt3
+
+And here we are
+back in the
+original file.
+
+--- File: file2.lt3
+
+  This is file2
+  which has an error
+  about an unknown command
+  in line 5
+.foobar
+
+  And this is file2 line 7.

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

@@ -5,9 +5,3 @@ which includes file2 here:
   which has an error
   about an unknown command
   in line 5
-<p>
-
-  And this is file2 line 7.
-And here we are
-back in the
-original file.

data/test/snapshots/error_inc_line_num/match-error.txt

@@ -1 +1 @@
-1 /Name 'foobar' is unknown/
+1 /Error: name 'foobar' is unknown/

data/test/snapshots/error_line_num/match-error.txt

@@ -1 +1 @@
-1 /Name 'foobar' is unknown/
+1 /Error: name 'foobar' is unknown/

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

@@ -2,4 +2,3 @@ Blah
 blah
 <p>
 
-

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

@@ -0,0 +1,4 @@
+Names such as 'class'
+are not permitted here...
+<p>
+

data/test/snapshots/error_name_not_permitted/match-error.txt

@@ -1 +1 @@
- 1  /Disallowed/
+ 1  /name 'class' is invalid/

data/test/snapshots/error_no_such_copy/duh

@@ -0,0 +1,26 @@
+####  
+self = 
+  #<Processor:0x00007fd5ec14d290 
+  @parent=#<Livetext:0x00007fd5ec14d358 
+        @source=nil, 
+        @_mixins=[], 
+        @_imports=[], 
+        @_outdir=".", 
+        @no_puts=false, 
+        @body="Make sure a\nnonexistent file with .copy\ngives an error.\n<p>\n\n", 
+        @main=#<Processor:0x00007fd5ec14d290 ...>, 
+              @indentation=[0], 
+              @_vars={"User"=>"Hal", :User=>"Hal", "Version"=>"0.9.24", :Version=>"0.9.24", 
+                      "File"=>"source.lt3", :File=>"source.lt3", 
+                      "FileDir"=>"/Users/Hal/Dropbox/topx/git/livetext/test/snapshots/error_no_such_copy", 
+                      :FileDir=>"/Users/Hal/Dropbox/topx/git/livetext/test/snapshots/error_no_such_copy"}, 
+            @backtrace=true>, 
+            @_nopass=false, 
+            @_nopara=false, 
+            @output=#<IO:<STDOUT>>, 
+            @sources=[[#<Enumerator: ["Make sure a", "nonexistent file with .copy", "gives an error.", "\n", ".copy nosuchfile.txt\n", "\n", "Nothing to\n", "see here.\n"]:each>, "source.lt3", 5]], 
+  @indentation=nil, 
+  @_mixins=[], 
+  @_imports=[], 
+  @_data="nosuchfile.txt", 
+  @_args=["nosuchfile.txt"]>

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

@@ -2,3 +2,4 @@ Make sure a
 nonexistent file with .copy
 gives an error.
 <p>
+

data/test/snapshots/error_no_such_copy/match-error.txt

@@ -1 +1 @@
- 1 /file nosuchfile.txt not found/
+ 1 /file 'nosuchfile.txt' not found/

data/test/snapshots/error_no_such_copy/mystery.txt

@@ -0,0 +1,36 @@
+livetext:78:in `parse_command_line'
+livetext:78:in `loop'
+livetext:92:in `block in parse_command_line'
+helpers.rb:72:in `process_file'
+helpers.rb:72:in `loop'
+helpers.rb:75:in `block in process_file'
+helpers.rb:95:in `process_line'
+helpers.rb:124:in `handle_dotcmd'
+standard.rb:273:in `copy': Error: file 'nosuchfile.txt' not found (FileNotFound)
+
+
+parse_command_line
+process_file
+process_line
+handle_dotcmd
+copy
+
+
+
+
+livetext "main"     rescue unexpected
+process_file        ret Bool, print warning, rescue unex, no raise 
+process_line        ret Bool, no rescue, no raise   
+handle_dotcmd       ret Bool, no rescue, 2 custom exceptions
+copy                ret Bool, rescue only unexpected
+check_file_exists   returns Boolean, no rescue, no raise
+
+
+METHOD                RETURNS             RESCUE              RAISES              OTHER
+-------------------   -----------------   -----------------   -----------------   -----------------   
+parse_command_line    nothing             only unexpected            
+process_file
+process_line
+handle_dotcmd
+copy
+

data/test/snapshots/error_no_such_inc/match-error.txt

@@ -1 +1 @@
- 1 /file nosuchinc.lt3 not found/
+ 1 /file 'nosuchinc.lt3' not found/

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

@@ -3,3 +3,4 @@ we give an error
 when a mixin does not
 exist:
 <p>
+

data/test/snapshots/error_no_such_mixin/match-error.txt

@@ -1 +1 @@
-1 /No such mixin 'nosuchthing'/
+1 /file 'nosuchthing' not found/

data/test/snapshots/error_no_such_mixin/source.lt3

@@ -1,4 +1,4 @@
-Test that 
+Test that
 we give an error
 when a mixin does not
 exist:

data/test/snapshots/example_alpha/source.lt3

@@ -1,7 +1,7 @@
 .def alpha
-   text = _body.to_a.join(" ")
+   text = api.body.to_a.join(" ")
    words = text.split.sort
-   words.each {|w| _out "    #{w}" }
+   words.each {|w| api.out "    #{w}" }
 .end
 Here is an alphabetized list:
 

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

@@ -7,6 +7,4 @@ fishmonger     fusillade      glyph
 gryphon        halcyon        manicotti      
 mataeotechny   pareidolia     quark          
 zootrope       zymurgy        
-<p>
-
 And that is all.

data/test/snapshots/example_alpha2/source.lt3

@@ -1,15 +1,16 @@
 .def alpha
-   cols = _args.first
+   cols = api.args.first
    cols = "1" if cols == ""
    cols = cols.to_i
    raise "Columns must be 1-5" unless cols.between?(1,5)
-   text = _body.join("\n")
+   text = api.body.join("\n")
    text.gsub!(/\n/, " ")
    words = text.split.sort
    words.each_slice(cols) do |row| 
-     row.each {|w| _out! '%-15s' % w }
-     _out
+     row.each {|w| api.out! '%-15s' % w }
+     api.out
    end
+   api.optional_blank_line
 .end
 Here is an alphabetized list: