testml 0.0.1 → 0.0.2

data/.gemspec

@@ -2,7 +2,7 @@
 
 GemSpec = Gem::Specification.new do |gem|
   gem.name = 'testml'
-  gem.version = '0.0.1'
+  gem.version = '0.0.2'
   gem.license = 'MIT'
   gem.required_ruby_version = '>= 1.9.1'
 
@@ -15,4 +15,6 @@ TestML is an Acmeist testing framework.
   gem.homepage = 'http://testml.org'
 
   gem.files = `git ls-files`.lines.map{|l|l.chomp}
+
+  gem.add_dependency 'pegex', '>= 0.0.3'
 end

data/CHANGELOG.yaml

@@ -1,3 +1,6 @@
+- version: 0.0.2
+  date:    Sat Apr 20 07:04:55 CST 2013
+  changes: Major refactoring release
 - version: 0.0.1
-  date:    Wed Dec 19 17:30:18 PST 2012
+  date:    Tue Dec 18 19:54:09 PST 2012
   changes: First release

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright © 2012 Ingy döt Net
+Copyright © 2013 Ingy döt Net
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the ‘Software’), to deal in

data/README.rdoc

@@ -1,16 +1,41 @@
 = testml - TestML for Ruby
 
-TestML is an Acmeist Unit Test language/framework.
+TestML is an Acmeist unit test language/framework.
 
 = Synopsis
 
+In a file called +test/mytest.rb+:
+
     require 'testml'
 
-= Status
+    TestML.new.testml = <<'.'
+    Plan = 4;
+
+    *x.add(*y) == *sum;
+    *x.mult(*y) == *pruduct;
+
+    === Test one
+    --- x: 42
+    --- y: 43
+    --- sum: 85
+    --- product: 1806
+    .
+
+= Description
+
+Coming soon...
+
+= TestML::Test API
+
+Coming soon...
+
+= About TestML
+
+TestML subclasses Test::Unit, so it Just Works with your other test code/files
+and with +rake test+.
 
-TestML has not yet been ported to Ruby. It will be soon. Use 'testml-lite' for
-now.
+All you need to do is create a new TestML object in a test file.
 
 = Copyright
 
-Copyright (c) 2012 Ingy döt Net. See LICENSE for further details.
+Copyright (c) 2012, 2013 Ingy döt Net. See LICENSE for further details.

data/Rakefile

@@ -11,6 +11,12 @@ DevNull = '2>/dev/null'
 require 'rake'
 require 'rake/testtask'
 require 'rake/clean'
+if File.exists? 'test/testml.yaml'
+  if File.exists? 'lib/rake/testml.rb'
+    $:.unshift "#{Dir.getwd}/lib"
+  end
+  require 'rake/testml'
+end
 
 task :default => 'help'
 
@@ -18,9 +24,12 @@ CLEAN.include GemDir, GemFile, 'data.tar.gz', 'metadata.gz'
 
 desc 'Run the tests'
 task :test do
+  load '.env' if File.exists? '.env'
   Rake::TestTask.new do |t|
     t.verbose = true
-    t.test_files = FileList['test/*.rb']
+    t.test_files = ENV['DEV_TEST_FILES'] &&
+      FileList[ENV['DEV_TEST_FILES'].split] ||
+      FileList['test/**/*.rb'].sort
   end
 end
 

data/ToDo

@@ -0,0 +1,56 @@
+- Constants inside modules
+- Pretty print ruby data structure
+- Find current test file
+
+
+- Code review
++ rake testml takes yaml file argument
+
++ Check irc
++ Turn testml-lite into testml
++ Eliminate explicit.rb and plan.rb
++ Combine testml.tml and testml-lite.tml
++ Port TestML::Runtime(.pm) to ruby
+  - Make test pass using real testml runtime
+- Make all tests pass
+
+
+
++ fix 1 == 1
++ move TestML::Compiler to a class
++ move TestML::Runtime to a class
++ testml.plan = 5
++ ~~ Match should use index, not regex
++ testml.blocks = [...]
++ testml.require_or_skip 'x', 'y', 'z'
++ make require_or_skip not exit
++ TestML::Test constructor can take hash or block or nothing
++ rake/testml/lite
+  + use test/testml.yaml
+  + copy tml files from source repo
+  + generate .rb files from templates
++ Eliminate global $TestMLError
+
+- Support Point as first-class function
+- Support Set, Get and Del
+x Support surrogate TestML Function as Ruby function
+- Add Label support
+
+
+
+- Make a headless TestML::Test object
+
+- make work with pegex-rb
+- make a pegex-tml
+
+- write doc
+  - look at rdoc and yard
+- release to rubygems
+
+- port to perl
+- port to python
+- port to perl6
+
+
+== Ideas
+- test-converage-rb

data/lib/rake/testml.rb

@@ -0,0 +1,14 @@
+##
+# Usage:
+#   rake testml
+#   rake testml ./test/mytestmlconf.yaml
+#
+# This rake task syncs your local testml setup with a testml repository and
+# creates any needed shim test files.
+
+require 'testml/setup'
+
+desc 'Update TestML files.'
+task :testml do
+  TestML::Setup.new.setup(ARGV[1])
+end

data/lib/testml.rb

@@ -1,3 +1,47 @@
-module TestML
-  fail "testml has not been ported to Ruby yet. Try 'testml-lite'"
+class TestML
+  VERSION = '0.0.2'
+
+  attr_accessor :runtime
+  attr_accessor :compiler
+  attr_accessor :bridge
+  attr_accessor :library
+  attr_accessor :testml
+
+  def initialize attributes={}
+    attributes.each { |k,v| self.send "#{k}=", v }
+    yield self if block_given?
+  end
+
+  def run(*args)
+    set_default_classes
+    @runtime.new(
+      compiler: @compiler,
+      bridge: @bridge,
+      library: @library,
+      testml: @testml,
+    ).run(*args)
+  end
+
+  def set_default_classes
+    if not @runtime
+      require 'testml/runtime/unit'
+      @runtime = TestML::Runtime::Unit
+    end
+    if not @compiler
+      require 'testml/compiler/pegex'
+      @compiler = TestML::Compiler::Pegex
+    end
+    if not @bridge
+      require 'testml/bridge'
+      @bridge = TestML::Bridge
+    end
+    if not @library
+      require 'testml/library/standard'
+      require 'testml/library/debug'
+      @library = [
+        TestML::Library::Standard,
+        TestML::Library::Debug,
+      ]
+    end
+  end
 end

data/lib/testml/bridge.rb

@@ -0,0 +1,5 @@
+class TestML::Bridge
+  def runtime
+    $TestMLRuntimeSingleton
+  end
+end

data/lib/testml/compiler.rb

@@ -0,0 +1,106 @@
+require 'testml/runtime'
+
+class TestML::Compiler
+
+  attr_accessor :code
+  attr_accessor :data
+  attr_accessor :text
+  attr_accessor :directives
+  attr_accessor :function
+
+  def compile(input)
+    preprocess(input, 'top')
+    compile_code
+    compile_data
+
+    if @directives['DumpAST']
+      XXX @function
+    end
+
+    @function.namespace ||= {}
+    @function.namespace['TestML'] = @directives['TestML']
+
+    @function.outer = TestML::Function.new
+    return @function
+  end
+
+  def preprocess(input, top=nil)
+    parts = input.split /^((?:\%\w+.*|\#.*|\ *)\n)/
+    input = ''
+
+    @directives = {
+      'TestML' => nil,
+      'DataMarker' => nil,
+      'BlockMarker' => '===',
+      'PointMarker' => '---',
+    }
+
+    order_error = false
+    parts.each do |part|
+      next if part.empty?
+      if part =~ /^(\#.*|\ *)\n/
+        input << "\n"
+        next
+      end
+      if part =~ /^%(\w+)\s*(.*?)\s*\n/
+        directive, value = $1, $2
+        input << "\n"
+        if directive == 'TestML'
+          fail "Invalid TestML directive" \
+            unless value =~ /^\d+\.\d+\.\d+$/
+          fail "More than one TestML directive found" \
+            if @directives['TestML']
+          @directives['TestML'] = TestML::Str.new(value)
+          next
+        end
+        order_error = true unless @directives['TestML']
+        if directive == 'Include'
+          runtime = $TestMLRuntimeSingleton \
+            or fail "Can't process Include. No runtime available"
+          include_ = self.class.new
+          include_.preprocess(runtime.read_testml_file(value))
+          input << include_.text
+          @directives['DataMarker'] =
+            include_.directives['DataMarker']
+          @directives['BlockMarker'] =
+            include_.directives['BlockMarker']
+          @directives['PointMarker'] =
+            include_.directives['PointMarker']
+          fail "Can't define %TestML in an Included file" \
+            if include_.directives['TestML']
+        elsif directive =~ /^(DataMarker|BlockMarker|PointMarker)$/
+          @directives[directive] = value
+        elsif directive =~ /^(DebugPegex|DumpAST)$/
+          value = true if value.empty?
+          @directives[directive] = value
+        else
+          fail "Unknown TestML directive '$#{directive}'"
+        end
+      else
+        order_error = true if !input.empty? and !@directives['TestML']
+        input << part
+      end
+    end
+
+    if top
+      fail "No TestML directive found" \
+        unless @directives['TestML']
+      fail "%TestML directive must be the first (non-comment) statement" \
+        if order_error
+
+      @directives['DataMarker'] ||= @directives['BlockMarker']
+      if split = input.index("\n#{@directives['DataMarker']}")
+        @code = input[0..(split)]
+        @data = input[(split + 1)..-1]
+      else
+        @code = input
+        @data = ''
+      end
+
+      @code.gsub! /^\\(\\*[\%\#])/, '\1'
+      @data.gsub! /^\\(\\*[\%\#])/, '\1'
+    else
+      @text = input
+    end
+  end
+end

data/lib/testml/compiler/lite.rb

@@ -0,0 +1,194 @@
+require 'testml/compiler'
+
+class TestML::Compiler::Lite < TestML::Compiler
+  require 'testml/runtime'
+
+  attr_accessor :input
+  attr_accessor :points
+  attr_accessor :tokens
+  attr_accessor :function
+
+  WS = %r!\s+!
+  ANY = %r!.!
+  STAR = %r!\*!
+  NUM = %r!-?[0-9]+!
+  WORD = %r!\w+!
+  HASH = %r!#!
+  EQ = %r!=!
+  TILDE = %r!~!
+  LP = %r!\(!
+  RP = %r!\)!
+  DOT = %r!\.!
+  COMMA = %r!,!
+  SEMI = %r!;!
+  SSTR = %r!'(?:[^']*)'!
+  DSTR = %r!"(?:[^"]*)"!
+  ENDING = %r!(?:#{RP}|#{COMMA}|#{SEMI})!
+
+  POINT = %r!#{STAR}#{WORD}!
+  QSTR = %r!(?:#{SSTR}|#{DSTR})!
+  COMP = %r!(?:#{EQ}#{EQ}|#{TILDE}#{TILDE})!
+  OPER = %r!(?:#{COMP}|#{EQ})!
+  PUNCT = %r!(?:#{LP}|#{RP}|#{DOT}|#{COMMA}|#{SEMI})!
+
+  TOKENS = %r!(?:#{POINT}|#{NUM}|#{WORD}|#{QSTR}|#{PUNCT}|#{OPER})!
+
+  def compile_code
+    @function = TestML::Function.new
+    while not @code.empty? do
+      @code.sub! /^(.*)(\r\n|\n|)/, ''
+      @line = $1
+      tokenize
+      next if done
+      parse_assignment ||
+      parse_assertion ||
+      fail_()
+    end
+  end
+
+  def tokenize
+    @tokens = []
+    while not @line.empty? do
+      next if @line.sub!(/^#{WS}/, '')
+      next if @line.sub!(/^#{HASH}#{ANY}*/, '')
+      if @line.sub!(/^(#{TOKENS})/, '')
+        @tokens.push $1
+      else
+        fail_("Failed to get token here: '#{@line}'")
+      end
+    end
+  end
+
+  def parse_assignment
+    return unless peek(2) == '='
+    var, op = pop(2)
+    expr = parse_expression
+    pop if !done and peek == ';'
+    fail_() unless done
+    @function.statements.push TestML::Assignment.new(var, expr)
+    return true
+  end
+
+  def parse_assertion
+    return unless @tokens.grep /^#{COMP}$/
+    @points = []
+    left = parse_expression
+    token = pop
+    op =
+      token == '==' ? 'EQ' :
+      token == '~~' ? 'HAS' :
+      fail_
+    right = parse_expression
+    pop if !done and peek == ';'
+    fail_ unless done
+
+    @function.statements.push TestML::Statement.new(
+      left,
+      TestML::Assertion.new(
+        op,
+        right,
+      ),
+      points.empty? ? nil : points
+    )
+    return true
+  end
+
+  def parse_expression
+    calls = []
+    while !done and peek !~ /^(#{ENDING}|#{COMP})$/ do
+      token = pop
+      if token =~ /^#{NUM}$/
+        calls.push TestML::Num.new(token.to_i)
+      elsif token =~ /^#{QSTR}$/
+        str = token[1..-2]
+        calls.push TestML::Str.new(str)
+      elsif token =~ /^#{WORD}$/
+        call = TestML::Call.new(token)
+        if !done and peek == '('
+          call.args = parse_args
+        end
+        calls.push call
+      elsif token =~ /^#{POINT}$/
+        token =~ /(#{WORD})/ or fail
+        points.push $1
+        calls.push TestML::Point.new($1)
+      else
+        fail_("Unknown token '#{token}'")
+      end
+      if !done and peek == '.'
+        pop
+      end
+    end
+
+    return calls.size == 1 \
+      ? calls[0]
+      : TestML::Expression.new(calls)
+  end
+
+  def parse_args
+    pop == '(' or fail
+    args = []
+    while peek != ')' do
+      args.push parse_expression
+      pop if peek == ','
+    end
+    pop
+    return args
+  end
+
+  def compile_data
+    input = @data
+    input.gsub! /^#.*\n/, "\n"
+    input.gsub! /^\\/, ''
+    blocks = input.split(/(^===.*?(?=^===|\z))/m).select{|el|!el.empty?}
+    blocks.each{|block| block.sub! /\n+\z/, "\n"}
+
+    data = []
+    blocks.each do |string_block|
+      block = TestML::Block.new
+      string_block.gsub! /\A===\ +(.*?)\ *\n/, '' or
+        fail "No block label! #{string_block}"
+      block.label = $1
+      while !string_block.empty? do
+        next if string_block.sub! /\A\n+/, ''
+        key, value = nil, nil
+        if string_block.gsub!(/\A---\ +(\w+):\ +(.*)\n/, '') or
+           string_block.gsub!(/\A---\ +(\w+)\n(.*?)(?=^---|\z)/m, '')
+          key, value = $1, $2
+        else
+          fail "Failed to parse TestML string:\n#{string_block}"
+        end
+        block.points ||= {}
+        block.points[key] = value
+
+        if key =~ /^(ONLY|SKIP|LAST)$/
+          block.points[key] = true
+        end
+      end
+      data.push block
+    end
+    @function.data = data unless data.empty?
+  end
+
+  def done
+    tokens.empty?
+  end
+
+  def peek(index=1)
+    fail if index > @tokens.size
+    @tokens[index - 1]
+  end
+
+  def pop(count=1)
+    fail if count > @tokens.size
+    array = @tokens.slice! 0..(count-1)
+    count > 1 ? array : array[0]
+  end
+
+  def fail_(message=nil)
+    text = "Failed to compile TestML document.\n"
+    text << "Reason: #{message}\n" if message
+    text << "\nCode section of failure:\n#{@line}\n#{@code}\n"
+    fail text
+  end
+end