livetext 0.9.09 → 0.9.14

data/test/formatting-tests.rb

@@ -0,0 +1,35 @@
+require 'minitest/autorun'
+
+require_relative '../lib/livetext'
+
+# Just another testing class. Chill.
+
+class TestingLivetext < MiniTest::Test
+
+  TestLines = []
+
+  items = []
+  formatting_tests = File.open("formatting-tests.txt")
+  loop do 
+    4.times { items << formatting_tests.gets.chomp }
+    # Blank line terminates each "stanza"
+    raise "Oops? #{items.inspect}" unless items.last.empty?
+    TestLines << items
+    break if formatting_tests.eof?
+  end
+
+  TestLines.each.with_index do |item, num|
+    msg, src, exp, blank = *item
+    define_method("test_formatting_#{num}") do
+      actual = FormatLine.parse!(src)
+      # FIXME could simplify assert logic?
+      if exp[0] == "/" # regex!   FIXME doesn't honor %r[...]
+        exp = Regexp.compile(exp[1..-2])   # skip slashes
+        assert_match(exp, actual, msg)
+      else
+        assert_equal(exp, actual, msg)
+      end
+    end
+  end
+end
+

data/test/formatting.rb

@@ -1,13 +1,6 @@
-def minitest?
-  require 'minitest/autorun'
-end
-
-abort "minitest gem is not installed" unless minitest?
-
-
-$LOAD_PATH << "./lib"
+require 'minitest/autorun'
 
-require 'livetext'
+require_relative '../lib/livetext'
 
 class TestingLivetext < MiniTest::Test
 

data/test/snapshots/OMIT.txt

@@ -0,0 +1,10 @@
+# Comments are ignored.
+# Other lines:  name_of_snapshot and any comments here are ignored (no # needed)
+# fake_test_name      Use # to un-omit   ;)
+error_no_such_inc     Output BEFORE error doesn't get passed through
+error_no_such_copy    ^ Same behavior as  error_no_such_inc
+simple_mixin          Mixin doesn't work?? But no error... maybe _def isn't working.
+error_missing_end     Output is duplicated somehow. Look for: puts @body or puts @main.body
+error_no_such_mixin   ^ Same behavior as error_missing_end
+error_line_num        Same behavior as error_missing_end
+error_invalid_name    ^ Same behavior as  error_no_such_inc

data/test/{data → snapshots}/error_inc_line_num/expected-output.txt

@@ -5,3 +5,9 @@ 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

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

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

@@ -0,0 +1 @@
+ 1 /Error: Illegal name 'to_s'/

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

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

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

@@ -0,0 +1 @@
+1 /Error: found .end with no opening command/

data/test/{data → snapshots}/error_missing_end/expected-output.txt

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

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

@@ -0,0 +1 @@
+1 /Error: Expected .end, found end of file/

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

@@ -0,0 +1 @@
+ 1  /Disallowed/

data/test/{data → snapshots}/error_no_such_copy/expected-output.txt

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

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

@@ -0,0 +1 @@
+ 1 /Error: file nosuchfile.txt not found/

data/test/{data → snapshots}/error_no_such_copy/source.lt3

@@ -1,3 +1,4 @@
+.debug
 Make sure a
 nonexistent file with .copy
 gives an error.

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

@@ -0,0 +1 @@
+ 1 /Error: file nosuchinc.lt3 not found/

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

@@ -0,0 +1,5 @@
+Test that
+we give an error
+when a mixin does not
+exist:
+<p>

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

@@ -0,0 +1 @@
+1 /No such mixin 'nosuchthing'/

data/test/{data/lines.txt → snapshots/formatting-tests.txt}

@@ -118,3 +118,7 @@ Doubled underscore, midline
 This is __doubled, it seems
 This is <i>doubled</i>, it seems
 
+Underscore inside parens
+This is (_italicized and parenthesized)
+This is (<i>italicized</i> and parenthesized)
+

data/test/snapshots/predef_vars/match-output.txt

@@ -0,0 +1,6 @@
+ 1  Here we go...
+ 2  File = source.lt3
+ 3  /FileDir = .*.test.snapshots.predef_vars/
+ 4  /User = [A-Za-z][A-Za-z0-9]*/
+ 5  /Version = 0\.\d{1,2}\.\d{1,2}/
+ 6  NoSuchVar = [NoSuchVar is undefined]

data/test/snapshots/predef_vars/source.lt3

@@ -0,0 +1,6 @@
+Here we go...
+File = $File
+FileDir = $FileDir
+User = $User
+Version = $Version
+NoSuchVar = $NoSuchVar

data/test/snapshots.rb

@@ -0,0 +1,168 @@
+require 'minitest/autorun'
+
+require_relative '../lib/livetext'
+
+=begin
+Snapshots...
+
+NOTE that the external_files method has been replaced by the Snapshot class.
+
+You can add any ordinary test method above. But so far, most of these tests simply 
+call Snapshot.new
+
+It works this way: 
+  - If the test (caller) method is test_my_silly_feature, then we will
+    look for a directory called snapshots/my_silly_feature
+  - In here, there must be a source.lt3
+  - ...and also either expected-output.txt OR match-output.txt (not both)
+  - ...and also either expected-error.txt OR match-error.txt (not both)
+  - Technically, any existing file can be empty
+  - The expected-* files are "literal" data
+      * compared byte-for-byte
+      * watch spaces and bad regexes, etc. #duh
+      * each of these files corresponds to a single assertion 
+  - A match-* file has two entries per line: 
+      * a ONE-BASED line number (in actual-* file)
+      * a String OR a Regexp (to match against that line)
+      * If there is nonsense here, it currently isn't caught
+      * each of these files MAY correspond to many assertions 
+  - We run livetext on the source and compare actual vs expected (stdout, stderr)
+  - The error output gets checked first (expected or match), THEN standard output
+  - Of course, both must compare correctly for the test to pass
+=end
+
+
+# Just a testing class. Chill.
+
+class TestingLivetext < MiniTest::Test
+
+  class Snapshot
+    SOURCE = "source.lt3"
+    # Will now keep "actual" output in same dir?
+    ACTUAL_OUT, ACTUAL_ERR = "actual-output.txt", "actual-error.txt"
+    EXP_OUT,    EXP_ERR    = "expected-output.txt", "expected-error.txt"
+    MATCH_OUT,  MATCH_ERR  =  "match-output.txt", "match-error.txt"
+
+    def initialize(base, assertion = nil)
+      @assertion = assertion
+      @base = base
+      @errors = false
+      Dir.chdir(base) do
+        @literal_out = File.exist?(EXP_OUT)
+        @literal_err = File.exist?(EXP_ERR)
+        @match_out = File.exist?(MATCH_OUT)
+        @match_err = File.exist?(MATCH_ERR)
+      end
+      bad_files = (@literal_out && @match_out) || (@literal_err && @match_err)
+      raise "Inconsistent structure for #@base" if bad_files
+    end
+
+    def check_matches(actual, control)
+      controls = File.readlines(control).map(&:chomp)
+      lines = File.readlines(actual).map(&:chomp)
+      lines.unshift("DUMMY LINE")   # 1-based index! (for when I'm editing)
+      controls.each do |line|
+        line_num, item = line.split(" ", 2)
+        item = Regexp.new(item[1..-2]) if item[0] == "/"  # Hmm, string can't start with /...
+        line_num = line_num.to_i
+        info = "Expected line #{line_num} of #{actual.inspect} to match #{item.inspect} (was: #{lines[line_num].inspect})"
+        good = item === lines[line_num]
+        @errors = true unless good
+        @assertion.call item === lines[line_num], info   # string or regex
+      end
+    end
+
+    def sdiff(f1, f2, out)
+      File.open(out, "w") {|file| file.puts "#{'%-60s'% 'ACTUAL'}| #{'%-60s'% 'EXPECTED'}" }
+      system("/usr/bin/sdiff -t -w 121 #{f1} #{f2} >>#{out}")
+    end
+
+    def check_stdout
+      if @literal_out
+        actual, expected = File.read(ACTUAL_OUT), File.read(EXP_OUT)
+        same = actual == expected
+        @errors = true if not same
+        file = "out-sdiff.txt"
+        sdiff(ACTUAL_OUT, EXP_OUT, file)
+        @assertion.call same, "Discrepancy in STDOUT - see #{file} in test/snapshots/#@base"
+      else
+        check_matches(ACTUAL_OUT, MATCH_OUT)
+      end
+    end
+
+    def check_stderr
+      if @literal_err
+        actual, expected = File.read(ACTUAL_ERR), File.read(EXP_ERR)
+        same = actual == expected
+        @errors = true if not same
+        file = "err-sdiff.txt"
+        sdiff(ACTUAL_ERR, EXP_ERR, file)
+        @assertion.call same, "Discrepancy in STDERR - see #{file} in test/snapshots/#@base"
+      else
+        check_matches(ACTUAL_ERR, MATCH_ERR)
+      end
+    end
+
+    def cleanup
+      return if @errors
+      system("rm -f #{ACTUAL_OUT} #{ACTUAL_ERR} *sdiff.txt")
+    end
+
+    def filter  # TODO move subset/omit logic here??
+    end
+
+    def run
+      @errors = false   # oops, need to reset
+      Dir.chdir(@base) do
+        cmd = "../../../bin/livetext #{SOURCE} >#{ACTUAL_OUT} 2>#{ACTUAL_ERR}"
+        system(cmd)
+        check_stdout
+        check_stderr
+        cleanup
+      end
+    end
+  end
+
+  TTY = File.open("/dev/tty","w")
+
+  cmdline = ARGV.first == "cmdline"   # FIXME remove??
+  if cmdline
+    dir = "../"
+    Dir.chdir `livetext --path`.chomp.chomp
+  else
+    dir = ""
+  end
+
+  Data = "#{dir}test/snapshots"
+  Dir.chdir(Data)
+
+  TestDirs = Dir.entries(".").reject {|fname| ! File.directory?(fname) } - %w[. ..]
+
+  selected = File.readlines("subset.txt").map(&:chomp)
+
+  omitfile = "OMIT.txt"
+  omitted  = File.readlines(omitfile).map(&:chomp)
+  omitted.reject! {|line| line.start_with?("#") }
+  omit_names = omitted.map {|line| line.split.first }
+  STDERR.puts
+  STDERR.puts "  >>> Warning: Omitting #{omitted.size} snapshot tests:\n " 
+  indented = " "*7
+  omitted.each do |line| 
+    STDERR.print indented 
+    name, info = line.split(" ", 2)
+    STDERR.printf "%-20s  %s\n", name, info
+  end
+  STDERR.puts
+
+  wanted   = selected.empty? ? TestDirs : selected
+
+  Subset = wanted - omit_names
+
+  Subset.each do |tdir|
+    define_method("test_#{tdir}") do
+      myproc = Proc.new {|bool, info| assert bool, info }
+      this = Snapshot.new(tdir, myproc)
+      this.run
+    end
+  end
+end

data/test/testlines.rb

@@ -1,5 +1,5 @@
-require 'livetext'
-require 'formatline'
+require '../lib/livetext'
+require '../lib/formatline'
 
   def red(str)
     "" + str + ""
@@ -8,20 +8,30 @@ require 'formatline'
 input = ARGV.first || "test/data/lines.txt"
 data = File.readlines(input)
 
-data.each_slice(4) do |lines|
+pass = fail = 0
+data.each_slice(4).with_index do |lines, i|
   title, input, expected, blank = *lines
+  lnum = i*4 + 1
   input.chomp!
   expected.chomp!
   expected = eval(expected) if expected[0] == "/"
   
-  puts "-----------------------------"
-  print "Test:      #{title}"
 
   actual = FormatLine.parse!(input)
-  next if expected === actual
+  if expected === actual
+    pass += 1
+#   puts "PASS:      #{title}"
+    next
+  end
 
-  puts "Input:     #{input}"
+  fail += 1
+  puts "----------------------------- (line #{lnum})"
+  puts "Test:  #{title}"
+  puts "Input: #{input}"
   puts "  #{red('FAIL Expected: ')} #{expected.inspect}"
   puts "  #{red('     Actual  : ')} #{actual.inspect}"
   puts 
 end
+
+puts
+puts "#{pass} passes   #{fail} fails"

data/test/unit/all.rb

@@ -0,0 +1,3 @@
+
+require_relative 'standard'
+require_relative 'parser'      # nested

data/test/unit/html.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+
+require '../../lib/livetext'
+
+class TestingLivetext < MiniTest::Test
+  include Livetext::Standard
+  include Livetext::UserAPI
+
+  # Some of these methods being tested "really" belong elsewhere?
+  # Same is probably true of the methods that are testing them.
+
+  def test_wrapped
+    cdata = "nothing much"
+    assert_equal wrapped(cdata, :b),     "<b>#{cdata}</b>"
+    assert_equal wrapped(cdata, :b, :i), "<b><i>#{cdata}</i></b>"
+
+    assert_equal wrapped(cdata, :table, :tr, :td),
+                          "<table><tr><td>#{cdata}</td></tr></table>"
+  end
+
+  def test_wrapped_bang
+    cdata = "nothing much"
+    assert_equal wrapped!(cdata, :td, valign: :top), 
+                     "<td valign='top'>#{cdata}</td>"
+    assert_equal wrapped!(cdata, :img, src: "foo.jpg"),
+                    "<img src='foo.jpg'>#{cdata}</img>"
+    assert_equal wrapped!(cdata, :a, style: 'text-decoration: none', 
+                     href: 'foo.com'),
+                     "<a style='text-decoration: none' href='foo.com'>#{cdata}</a>"
+  end
+
+  def xtest_wrap
+    # bogus!
+    wrap(:ul) { 2.times {|i| _out i } }
+    puts @body
+  end
+
+end

data/test/unit/parser/all.rb

@@ -0,0 +1,3 @@
+
+require_relative '../standard'
+require_relative '../parser'      # nested