livetext 0.9.11 → 0.9.17

data/test/snapshots/clusion.txt

@@ -0,0 +1,70 @@
+# 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)
+
+# i to include, x to exclude
+
+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
+
+# Others (usually passing):
+
+# import/include/mixin, others...
+
+   simple_copy              #                      
+   simple_import            #                                            
+   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              #                                            

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

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

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

@@ -0,0 +1 @@
+ 1 /name 'to_s' is invalid/

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

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

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

@@ -4,5 +4,3 @@ without something
 beginning a block:
 <p>
 
-foo bar
-baz

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

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

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

@@ -0,0 +1 @@
+1 /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,8 +2,3 @@ Make sure a
 nonexistent file with .copy
 gives an error.
 <p>
-
-<p>
-
-Nothing to
-see here.

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

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

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

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

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

@@ -3,7 +3,3 @@ a nonexistent include
 will give an error.
 <p>
 
-<p>
-
-Nothing to
-see here.

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

@@ -0,0 +1 @@
+ 1 /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/snapshots/icanhaz/expected-output.txt

@@ -0,0 +1,5 @@
+Test fake command .icanhaz:
+we give an error
+when a .rb does not
+exist:
+<p>

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

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

data/test/snapshots/icanhaz/simple_import.rb

@@ -0,0 +1,5 @@
+module SimpleImport
+  def hello_world
+    _out "Hello, world."
+  end
+end

data/test/snapshots/icanhaz/source.lt3

@@ -0,0 +1,10 @@
+Test fake command .icanhaz:
+we give an error
+when a .rb does not
+exist:
+
+.icanhaz nonexistent
+
+We shouldn't
+reach this point
+in the file.

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

@@ -0,0 +1,6 @@
+Testing fake command .icanhaz:
+<p>
+
+Now call a method:
+Hello, world.
+That's all.

data/test/snapshots/icanhaz2/simple_canhaz.rb

@@ -0,0 +1,5 @@
+module SimpleImport
+  def hello_world
+    _out "Hello, world."
+  end
+end

data/test/snapshots/icanhaz2/source.lt3

@@ -0,0 +1,6 @@
+Testing fake command .icanhaz:
+
+.icanhaz simple_canhaz
+Now call a method:
+.hello_world
+That's all.

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/simple_import/expected-output.txt

@@ -0,0 +1,7 @@
+Here I am
+testing a simple import
+<p>
+
+Now call a method:
+Hello, world.
+That's all.

data/test/snapshots/simple_import/simple_import.rb

@@ -0,0 +1,5 @@
+module SimpleImport
+  def hello_world
+    _out "Hello, world."
+  end
+end

data/test/snapshots/simple_import/source.lt3

@@ -0,0 +1,7 @@
+Here I am
+testing a simple import
+.mixin simple_import
+
+Now call a method:
+.hello_world
+That's all.

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

@@ -1,5 +1,4 @@
 Here I am
-.debug
 trying to 
 include
 .include simplefile.inc

data/test/snapshots.rb

@@ -0,0 +1,177 @@
+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) ||
+                  (! @literal_out && ! @match_out)
+      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_stderr
+        check_stdout
+        cleanup
+      end
+    end
+  end
+
+  def self.get_dir   # FIXME - uh what?
+    cmdline = ARGV.first == "cmdline"   # FIXME remove??
+    if cmdline
+      dir = "../"
+      Dir.chdir `livetext --path`.chomp.chomp
+    else
+      dir = ""
+    end
+  end
+
+  TTY = File.open("/dev/tty","w")
+
+  args = ARGV - ["cmdline"]
+
+  dir = self.get_dir
+
+  Data = "#{dir}test/snapshots"
+  Dir.chdir(Data)
+
+  TestDirs = Dir.entries(".").reject {|fname| ! File.directory?(fname) } - %w[. ..]
+
+  if args.empty?
+    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
+  else
+    Subset = args
+  end
+
+
+  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 + ""

data/test/unit/all.rb

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