concordion 0.9.8

data/lib/concordion_test_methods.rb

@@ -0,0 +1,132 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require 'concordion_utility'
+require 'concordion_reader'
+require 'concordion_parser'
+require 'concordion_processor'
+require 'concordion_parse_result'
+require 'concordion_test_case'
+require 'concordion_writer'
+require 'concordion_environment'
+require 'concordion'
+require 'concordion_css_decorator'
+require 'concordion_utility'
+
+
+module ConcordionConfigMethods
+  
+
+  def default_config
+    concordion = ConcordionState.new
+    parser = ConcordionParser.new(ConcordionReader.new, concordion)
+    decorator = ConcordionCSSDecorator.new
+    processor = ConcordionProcessor.new(concordion, decorator)
+    { 
+      :parser => parser,
+      :writer => ConcordionWriter.new(ConcordionEnvironment.output_dir),
+      :concordion => concordion,
+      :decorator => decorator,
+      :processor => processor,
+      :write_goldmaster => false,
+      :css_type => ConcordionEnvironment.css_type
+    }
+  end
+
+  def bind_test_method_to(subclass, config)
+    subclass.class_eval do
+      define_method :test_spec do
+        filename = snake_cased_test_name(subclass.to_s)
+        parse_spec(filename,config)
+        failures = run_spec(filename, config)
+        report_spec(filename,config, failures)
+      end
+    end
+    subclass
+  end
+
+
+end
+
+module ConcordionInternalTestMethods
+  @@EXPECTED_FAILURE_COUNT = 0
+  include ConcordionUtility
+
+  def parse_spec(filename,config)
+    config[:parser].parse(filename)
+    assert_concordion_document(config)
+    if self.class.method_defined?(:css_type)
+      config[:decorator].add_concordion_css_link(config[:parser].root, config[:parser].html, css_type)
+    else
+      config[:decorator].add_concordion_css_link(config[:parser].root, config[:parser].html, config[:css_type])
+    end
+    
+  end
+
+  def run_spec(filename, config)
+    failures = []
+    config[:parser].each_eligible_concordion_element do |elem|
+      failure = config[:processor].process(elem, self)
+      failures << failure unless failure.nil?
+    end
+    failures
+  end
+
+  def report_spec(filename, config, failures)
+    config[:decorator].add_css_file_to_output_dir(config[:writer], config[:css_type])
+
+    writer = config[:writer]
+    if self.class.method_defined?(:rcor_writer)
+      writer = rcor_writer()
+    end
+    
+    outfilename = writer.calculate_filename_and_overwrite(config[:parser].root, filename)
+    assert_no_failures(outfilename, config, failures)
+  end
+
+  def assert_no_failures(outfilename, config, failures)
+    expected = @@EXPECTED_FAILURE_COUNT
+
+    if self.class.method_defined?(:expected_failure_count)
+      expected = expected_failure_count()
+    end
+
+    message = build_message "#{show_failures(failures)}\nWrote output to #{outfilename}.", 
+                            'Actual failure count <?> did not match expected <?>.',
+                            failures.size, expected
+    assert_block message do
+      failures.size == expected
+    end
+  end
+
+  def show_failures(failures)
+    rv = ""
+    failures.each_with_index do |failure, index|
+      rv += "[Error:#{index + 1}] #{failure}\n"
+    end
+    rv
+  end
+
+  def assert_concordion_document(config)
+    assert_equal "http://www.concordion.org/2007/concordion", config[:parser].html.get_attribute("xmlns:concordion")
+  end
+  
+end
+
+module ConcordionTestMethods
+  include ConcordionInternalTestMethods
+  extend  ConcordionConfigMethods
+
+  class << self
+    alias_method :original_included, :included
+  end
+
+  def self.included(cmod)
+    original_included(cmod)
+    conf = default_config
+    cm = class << cmod
+      include ConcordionConfigMethods
+    end
+    
+    bind_test_method_to(cmod, conf)
+  end
+end

data/lib/concordion_utility.rb

@@ -0,0 +1,70 @@
+
+require 'concordion_constants'
+require 'concordion_string_utility'
+
+
+module ConcordionUtility
+  include ConcordionConstants
+  include ConcordionStringUtility
+
+  def instrumentation(attr)
+    attr.split(":")[1]
+  end
+
+  def concordion_arguments(name)
+    return [] unless has_arguments?(name)
+    arg_string = nil
+    if name =~ /\(/
+      name_no_end_paren = name.gsub(")", '')
+      arg_string = name_no_end_paren.split("(")[1]
+    else
+      
+      base = name.strip
+      if base =~ /=/
+        arg_string = nil
+        base = base.split("=")[1].strip
+      end
+      tokens = base.split(" ").compact
+      arg_string = tokens.slice(1, tokens.size - 1).join(" ")
+    end
+    
+    arg_string.split(",").collect { |arg| arg.strip }
+  end
+  def concordion_variable_name(conc_call)
+    if has_property_reference?(conc_call)
+      return conc_call.split(".")[0].strip
+    end
+
+    conc_call.strip
+  end
+
+  def has_property_reference?(conc_call)
+    conc_call =~ /\./
+  end
+
+  def concordion_property_reference(conc_call)
+    if !has_property_reference?(conc_call)
+      return conc_call
+    end
+    idx = conc_call.index(".")
+    conc_call.slice(idx + 1, conc_call.length - idx).strip
+  end
+
+
+
+  def concordion_cmd_attr_exists?(elem)
+    !concordion_cmd_attr_for(elem).nil?
+  end
+
+  def concordion_cmd_attr_for(elem)
+    concordion_command_attributes.each {|attr| 
+      instrumented_value = elem.get_attribute(attr)
+      if !instrumented_value.nil?
+        return attr
+      end
+    }
+    
+    nil
+  end
+
+end

data/lib/concordion_verifier.rb

@@ -0,0 +1,50 @@
+require 'concordion_utility'
+
+class ConcordionVerifier
+  include ConcordionUtility
+
+  @@ROW_REGEXP = /tr:nth\((\d+)\)/
+  attr_accessor :verification_variable
+  def initialize(concordion)
+    @concordion = concordion
+    @verification_variable = nil
+    @last_row = -1
+  end
+
+  def update_if_verify_command(cpr)
+    if cpr.is_verify_command?
+      @verification_variable = cpr.assignment
+    end
+  end
+
+  def update_verifier(idx)
+    return if verification_variable.nil?
+    arr = @concordion.get_variable(verification_variable)
+    index = idx < 1 ? 0 : idx - 1
+
+    value = arr[index]
+    @concordion.set_variable(singular(verification_variable), value)
+  end
+
+  def verification_variable=(value)
+    @verification_variable = value
+
+    unless @verification_variable.nil?
+      update_verifier(0)
+    end
+  end
+  def update_row(elem)
+    on_row = @@ROW_REGEXP.match(elem.css_path)
+    if on_row
+      current_row = on_row.captures[0]
+      if current_row != @last_row
+        update_verifier(current_row.to_i)
+        @last_row = current_row
+      end
+    else
+      @last_row = -1
+    end
+
+  end
+
+end

data/lib/concordion_writer.rb

@@ -0,0 +1,43 @@
+class ConcordionWriter
+  @@DEFAULT = "."
+  def initialize(output_dir = @@DEFAULT)
+    @output_dir = output_dir.nil? ? @@DEFAULT : output_dir
+  end
+
+  def write(data, filename)
+    f = File.new(filename, "w")
+    f.puts data
+    f.close
+  end
+  
+  def output_file_exists?(filename)
+    exists?(base_filename(filename))
+  end
+  
+  def exists?(filename)
+    File.exists?(filename)
+  end
+  
+  def delete_if_exists(filename)
+    if exists?(filename)
+      File.delete(filename)
+    end
+    
+  end
+  
+  def calculate_filename_and_overwrite(data, filename)
+    outfile = output_filename_for(filename)
+    delete_if_exists(outfile)
+    write(data, outfile)
+
+    outfile
+  end
+
+  def base_filename(filename)
+    File.join(@output_dir, filename)
+  end
+  def output_filename_for(name)
+    base_filename(name.sub(".html", "_test_output.html"))
+  end
+
+end

data/lib/goldmaster_test_case.rb

@@ -0,0 +1,55 @@
+require 'concordion_test_case'
+require 'concordion_string_writer'
+
+require 'diff/lcs'
+module FailConditionally
+  def fail_if_write_still_enabled(cs, writer, data, name)
+    if cs.method_defined?(:write_goldmaster!)
+      writer.write(data, name)
+
+      raise RuntimeError.new("Disable write to goldmaster (erase write_goldmaster! in #{cs})")
+    end
+  end
+
+end
+class GoldmasterTestCase < ConcordionTestCase
+  include FailConditionally
+
+  def initialize(suite, conf = {})
+    @writer = ConcordionStringWriter.new
+
+    config = ConcordionTestCase.default_config.merge(conf)
+    @write_goldmaster = config[:write_goldmaster]    
+    super(suite, config)
+  end
+
+  def rcor_writer
+    @writer
+  end
+  def test_spec
+    trivial
+  end
+
+  def writer
+    ConcordionWriter.new
+  end
+
+
+  def teardown
+    fail_if_write_still_enabled(self.class, writer, @writer.data, snake_cased_goldmaster_name(self.class.to_s))
+    
+    unless is_trivial?
+      goldmaster = ConcordionReader.new.read(snake_cased_goldmaster_name(self.class.to_s))
+      assert @writer.data.size > 0
+
+      diffs = Diff::LCS.diff(@writer.data, goldmaster)
+      pos = diffs[0].entries[0].position
+      context_exp = goldmaster.slice(pos - 50, 100)
+      context_act = @writer.data.slice(pos - 50, 100)
+      
+      assert_equal @writer.data, goldmaster, "First difference at #{pos} bytes into goldmaster:\n(#{context_exp}) goldmaster vs\n(#{context_act}) actual"
+    end
+
+  end
+  
+end

data/lib/loader_helper.rb

@@ -0,0 +1,16 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+module LoaderHelper
+  def path_for(filename)
+    return filename if File.exists?(filename)
+    
+    $LOAD_PATH.each do |path|
+      candidate = "#{path}/#{filename}"
+      return candidate if File.exists?(candidate)
+    end
+    raise RuntimeError.new("could not find '#{filename}' on the system load path")
+  end
+end

data/lib/rcor.rb

@@ -0,0 +1,3 @@
+
+
+require 'concordion_test_case'

data/nbproject/private/private.properties

@@ -0,0 +1,4 @@
+file.reference.rcor-lib=C:\\rcor\\lib
+file.reference.rcor-test-lib=C:\\rcor\\test-lib
+file.reference.rcor-tests=C:\\rcor\\tests
+platform.active=Ruby

data/nbproject/private/private.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+</project-private>

data/nbproject/private/rake-d.txt

@@ -0,0 +1,21 @@
+clean=Remove any temporary products.
+clobber=Remove any generated file.
+clobber_package=Remove package products
+clobber_rcov=Remove rcov products for rcov
+clobber_rdoc=Remove rdoc products
+commit_prep=
+default=
+gem=Build the gem file concordion-0.9.8.gem
+html=
+html/index.html=
+package=Build all the packages
+pkg=
+pkg/concordion-0.9.8=
+pkg/concordion-0.9.8.gem=
+pkg/concordion-0.9.8.tgz=
+pkg/concordion-0.9.8.zip=
+rcov=Analyze code coverage with tests
+rdoc=Build the rdoc HTML Files
+repackage=Force a rebuild of the package files
+rerdoc=Force a rebuild of the RDOC files
+test=Run tests

data/nbproject/project.properties

@@ -0,0 +1,11 @@
+file.reference.rcor-lib=lib
+file.reference.rcor-test-lib=test-lib
+file.reference.rcor-tests=tests
+javac.classpath=
+main.file=
+platform.active=Ruby
+ruby.includejava=false
+source.encoding=windows-1252
+src.lib.dir=lib
+src.test-lib.dir=test-lib
+test.tests.dir=tests

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>rcor</name>
+            <source-roots>
+                <root id="src.test-lib.dir"/>
+                <root id="src.lib.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.tests.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/test-lib/single_row_result.rb

@@ -0,0 +1,9 @@
+
+class SingleRowResult
+  attr_accessor :alpha, :beta, :gamma
+  def initialize(args)
+    @alpha = args[0].upcase
+    @beta = args[1].upcase
+    @gamma = args[2].upcase
+  end
+end

data/test-lib/user.rb

@@ -0,0 +1,8 @@
+
+class User
+  attr_accessor :name, :other
+  def initialize(name, other)
+    @name = name
+    @other = other
+  end
+end

data/tests/basic_assert.html

@@ -0,0 +1,5 @@
+<html xmlns:concordion="http://www.concordion.org/2007/concordion">
+    <body>
+        <b concordion:assertEquals="getGreeting()">Hello World!</b>
+    </body>
+</html>

data/tests/basic_assert_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'concordion_test_case'
+
+class BasicAssertTest < ConcordionTestCase
+
+  def getGreeting
+    "Hello World!"
+  end
+end

data/tests/basic_set.html

@@ -0,0 +1,11 @@
+<html xmlns:concordion="http://www.concordion.org/2007/concordion">
+    <body>
+      Here's some text
+        <p concordion:set="#username">Chuck Norris</p>
+        <p concordion:set="#mnks">Monkeys</p>
+        <p concordion:set="#mnks">Monkeys</p>
+
+	<p concordion:assertEquals="greetingFor(#username)">Hello Chuck Norris, you nancy-boy.</p>
+	it should be in the output.
+    </body>
+</html>

data/tests/basic_set_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+require 'concordion_test_case'
+
+class BasicSetTest < ConcordionTestCase
+  def greetingFor(name)
+    "Hello #{name}, you nancy-boy."
+  end
+end

data/tests/basic_text.html

@@ -0,0 +1,14 @@
+<html xmlns:concordion="http://www.concordion.org/2007/concordion">
+    <body>
+        <p concordion:execute="set_name(#TEXT)">No</p>
+	<p concordion:assertEquals="double_down()">NoNo</p>
+        
+	<p concordion:execute="#result = return_arg(#TEXT)">Working Text</p>
+	<p concordion:assertEquals="#result">Working Text</p>
+        
+	<p concordion:execute="#result = concat(#TEXT,#TEXT)">Working Text 2</p>
+	<p concordion:assertEquals="#result">Working Text 2:Working Text 2</p>
+        
+        
+    </body>
+</html>

data/tests/basic_text_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'concordion_test_case'
+
+class BasicTextTest < ConcordionTestCase
+  def set_name(name)
+    @name = name
+  end
+
+  def return_arg(arg)
+    arg
+  end
+  
+  def concat(a,b)
+    raise "second arg nil" if b.nil?
+    raise "first arg nil" if a.nil?
+
+    "#{a}:#{b}"
+  end
+  
+  def double_down
+    "#{@name*2}"
+  end
+end

data/tests/concordion/concordion_css_decorator_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require 'concordion_css_decorator'
+require 'rubygems'
+require 'mocha'
+
+class ConcordionCssDecoratorTest < Test::Unit::TestCase
+  def test_does_not_write_if_file_exists
+    writer = mock("writer")
+    writer.expects(:output_file_exists?).with("concordion.css").once.returns(true)
+    
+    ConcordionCSSDecorator.new.add_css_file_to_output_dir(writer, :link)
+  end
+  
+  def test_writes_if_file_does_not_exist
+    writer = mock("writer")
+    writer.expects(:output_file_exists?).with("concordion.css").once.returns(false)
+    writer.expects(:calculate_filename_and_overwrite).with(anything, "concordion.css").once
+    
+    ConcordionCSSDecorator.new.add_css_file_to_output_dir(writer, :link)
+  end
+
+  def test_does_not_write_if_not_link_eg_inline
+    writer = mock("writer")
+    writer.expects(:output_file_exists?).with("concordion.css").once.returns(false)
+    
+    ConcordionCSSDecorator.new.add_css_file_to_output_dir(writer, :inline)
+  end
+end

data/tests/concordion/concordion_environment_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'concordion_environment'
+
+class ConcordionEnvironmentTest < Test::Unit::TestCase
+  
+  def test_output_dir
+    restore_env do
+      ENV[ConcordionEnvironment.output_dir_key] = nil
+      assert_equal ".", ConcordionEnvironment.output_dir
+      ENV[ConcordionEnvironment.output_dir_key] = "foo/bar"
+      assert_equal "foo/bar", ConcordionEnvironment.output_dir
+    end
+  end
+
+  def test_clean_list
+    restore_env do
+      ENV[ConcordionEnvironment.output_dir_key] = nil
+      assert_equal ["./*_test_output.html", "./concordion.css"], ConcordionEnvironment.clean_list
+      ENV[ConcordionEnvironment.output_dir_key] = "foo/bar"
+      assert_equal ["foo/bar/*_test_output.html", "foo/bar/concordion.css"], ConcordionEnvironment.clean_list
+    end
+
+  end
+
+  def test_css_type_defaults_to_inline
+    restore_env do      
+      ENV[ConcordionEnvironment.css_type_key] = "link"
+      assert_equal :link, ConcordionEnvironment.css_type
+      
+      ENV[ConcordionEnvironment.css_type_key] = nil
+      assert_equal :inline, ConcordionEnvironment.css_type
+
+    end
+
+  end
+
+  def restore_env
+    orig_dir = ENV[ConcordionEnvironment.output_dir_key]
+    orig_type = ENV[ConcordionEnvironment.css_type_key]
+    yield
+    ENV[ConcordionEnvironment.output_dir_key] = orig_dir
+    ENV[ConcordionEnvironment.css_type_key] = orig_type.to_s
+  end
+end

data/tests/concordion/concordion_parse_result_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'concordion_parse_result'
+require 'rubygems'
+require 'mocha'
+class ConcordionParseResultTest < Test::Unit::TestCase
+
+  def test_is_set_command
+    assert ConcordionParseResult.new("set",nil,nil,nil).is_set_command?
+    assert !ConcordionParseResult.new("asdf",nil,nil,nil).is_set_command?
+  end
+
+  def test_is_assert_image_command
+    assert ConcordionParseResult.new("assert_image",nil,nil,nil).is_assert_image_command?
+    assert !ConcordionParseResult.new("set",nil,nil,nil).is_assert_image_command?
+  end
+
+  def test_is_execute_command
+    assert ConcordionParseResult.new("execute",nil,nil,nil).is_execute_command?
+    assert !ConcordionParseResult.new("asdf",nil,nil,nil).is_execute_command?
+  end
+
+  def test_is_verify_command
+    assert ConcordionParseResult.new("verifyrows",nil,nil,nil).is_verify_command?
+    assert !ConcordionParseResult.new("monkeys",nil,nil,nil).is_verify_command?
+  end
+  def test_is_asserttrue_command
+    assert ConcordionParseResult.new("asserttrue",nil,nil,nil).is_assert_true_command?
+    assert !ConcordionParseResult.new("monkeys",nil,nil,nil).is_assert_true_command?
+  end
+
+  def test_image_location
+    tag = mock("tag")
+    tag.expects(:get_attribute).with('src').returns "foo" 
+    assert_equal "foo", ConcordionParseResult.new(nil,nil,nil, tag).image_location
+  end
+  def test_assignment
+    assert_equal "#user", ConcordionParseResult.new("verifyrows","  #user = asdfasdf",nil,nil).assignment
+    assert_equal "#bob",  ConcordionParseResult.new("monkeys","#bob=asdf",nil,nil).assignment
+  end
+  
+  def test_to_s
+    assert_equal "Concordion command[], System under test method[#asdf], Tag Content[] Image Location[]", ConcordionParseResult.new(nil,"#asdf", nil,nil).to_s
+  end
+  def test_needs_dereference
+    assert ConcordionParseResult.new(nil,"#asdf", nil,nil).needs_dereference?
+    assert !ConcordionParseResult.new(nil,"asdf", nil,nil).needs_dereference?
+    assert !ConcordionParseResult.new(nil,"as#df", nil,nil).needs_dereference?
+    assert !ConcordionParseResult.new(nil,"#asdf = foo()", nil,nil).needs_dereference?
+  end
+
+end

data/tests/concordion/concordion_reader_test.rb

@@ -0,0 +1,15 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'concordion_reader'
+
+class ConcordionReaderTest < Test::Unit::TestCase
+  def test_foo
+    assert_raise RuntimeError do
+      ConcordionReader.new.path_for("purple_monkey_dishwasher")
+    end
+  end
+end