rcor 0.8.1

data/Rakefile.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'lib/concordion_environment'
+
+CLEAN.include(ConcordionEnvironment.clean_list)
+
+Rake::TestTask.new do |t|
+  t.libs << "test-lib"
+  t.libs << "tests"
+  t.test_files = FileList['tests/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:clean, :test] 
+
+PKG_FILES = FileList['**/*'].exclude(/_test_output\.html$/)
+PKG_VERSION = '0.8.1'                     
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Ruby based concordion"
+  s.name = 'rcor'
+  s.version = PKG_VERSION
+  s.author = 'Ben Goodspeed'
+  s.email = 'b.goodspeed@gmail.com'
+  s.add_dependency('hpricot', '>= 0.6')
+  s.requirements << 'hpricot HTML parser'
+  s.require_path = 'lib'
+  s.autorequire = 'rake'
+  s.files = PKG_FILES
+end
+
+Rake::GemPackageTask.new(spec) { |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+}

data/lib/concordion.rb

@@ -0,0 +1,66 @@
+require 'concordion_utility'
+require 'concordion_invocation_string_builder'
+require 'concordion_lookahead_handler'
+require 'concordion_verifier'
+require 'concordion_invoker'
+require 'concordion_binder'
+
+class Concordion
+  include ConcordionUtility
+
+  @@TEXT_VAR = "#TEXT"
+  def self.TEXT_VAR
+    @@TEXT_VAR
+  end
+  attr_reader :verification_variable, :verifier, :invocation_builder
+
+  def initialize
+    @memory = {}
+    @invocation_builder = ConcordionInvocationStringBuilder.new(self)
+    @lookahead_handler = ConcordionLookaheadHandler.new
+    @verifier = ConcordionVerifier.new(self)
+    @invoker = ConcordionInvoker.new(self)
+    @binder = ConcordionBinder.new(self)
+    set_variable(@@TEXT_VAR, @@TEXT_VAR)
+  end
+  def set_variable(variable, value)
+    @memory[variable] = value
+  end
+
+  def get_variable(variable)
+    @memory[variable]
+  end
+  
+  def build_invocation_string(conc_call, content)
+    @invocation_builder.build_invocation_string(conc_call,content)
+  end
+
+  def dereference(conc_call)
+    var_name = concordion_variable_name(conc_call)
+    var = get_variable(var_name)
+
+    if !has_property_reference?(conc_call)
+      return var
+    end
+
+    var.send(concordion_property_reference(conc_call))
+  end
+
+
+  def evaluate(cpr, test_context, processor)
+    @lookahead_handler.handle_lookahead(cpr, test_context, processor)
+
+    return { :result => true } if @binder.bind_if_set_command(cpr) 
+
+    @verifier.update_if_verify_command(cpr)
+
+    sut_rv = @invoker.invoke_sut(cpr, test_context)
+    @binder.handle_assignment(cpr, sut_rv)
+    conc_rv = @invoker.invoke_concordion(cpr, sut_rv)
+    
+    conc_rv
+  end
+
+
+
+end

data/lib/concordion_binder.rb

@@ -0,0 +1,24 @@
+require 'concordion_utility'
+
+class ConcordionBinder
+  include ConcordionUtility
+
+  def initialize(concordion)
+    @concordion = concordion
+  end
+  def bind_if_set_command(cpr)
+    if cpr.is_set_command?
+      @concordion.set_variable(cpr.system_under_test, cpr.content)
+      true
+    else
+      false
+    end
+  end
+
+  def handle_assignment(cpr, sut_rv)
+    if has_assignment?(cpr.system_under_test)
+      @concordion.set_variable(concordion_assignment(cpr.system_under_test), sut_rv)
+    end
+  end
+
+end

data/lib/concordion_constants.rb

@@ -0,0 +1,13 @@
+module ConcordionConstants
+
+  def concordion_command_attributes
+    ["assertequals", "set", "execute", "verifyrows", "asserttrue"].collect do
+        |cmd| "concordion:#{cmd}"
+    end
+  end
+
+  def supported?(tagname)
+    ['p', 'span', 'b', 'th', 'tr', 'div'].include?(tagname.downcase)
+  end
+
+end

data/lib/concordion_css.rb

@@ -0,0 +1,172 @@
+ 
+
+module ConcordionCSS
+  def self.css_filename
+    "concordion.css"
+  end
+
+  def self.css_string
+    css = <<-eoscss
+* {
+  font-family: Arial;
+}
+body {
+  padding: 32px;
+}
+pre {
+  padding: 6px 28px 6px 28px;
+  background-color: #E8EEF7;
+}
+pre, pre *, code, kbd {
+  font-family: Courier New, Courier;
+  font-size: 10pt;
+}
+h1, h1 * {
+  font-size: 24pt;
+}
+p, td, th, li, .breadcrumbs {
+  font-size: 10pt;
+}
+p, li {
+  line-height: 140%;
+}
+table {
+  border-collapse: collapse;
+  empty-cells: show;
+  margin: 8px 0px 8px 0px;
+}
+th, td {
+  border: 1px solid black;
+  padding: 3px;
+}
+td {
+  background-color: white;
+  vertical-align: top;
+}
+th {
+  background-color: #C3D9FF;
+}
+li {
+  margin-top: 6px;
+  margin-bottom: 6px;
+}
+
+
+.example {
+  padding: 2px 12px 6px 12px;
+  border: 1px solid #C3D9FF;
+  margin: 6px 0px 28px 0px;
+  background-color: #F5F9FD;
+}
+.example h3 {
+  margin-top: 8px;
+  margin-bottom: 8px;
+  font-size: 12pt;
+}
+
+p.success {
+  padding: 2px;
+}
+.concordion_success, .concordion_success * {
+  background-color: #afa !important;
+}
+.success pre {
+  background-color: #bbffbb;
+}
+.concordion_failure, .concordion_failure * {
+  background-color: #ffb0b0;
+  padding: 1px;
+}
+.concordion_failure .expected {
+  text-decoration: line-through;
+  color: #bb5050;
+}
+
+ins {
+  text-decoration: none;
+}
+
+.exceptionMessage {
+  background-color: #fdd;
+  font-family: Courier New, Courier, Monospace;
+  font-size: 10pt;
+  display: block;
+  font-weight: normal;
+  padding: 4px;
+  text-decoration: none !important;
+}
+.stackTrace, .stackTrace * {
+  font-weight: normal;
+}
+.stackTrace {
+  display: none;
+  padding: 1px 4px 4px 4px;
+  background-color: #fdd;
+  border-top: 1px dotted black;
+}
+.stackTraceExceptionMessage {
+  display: block;
+  font-family: Courier New, Courier, Monospace;
+  font-size: 8pt;
+  white-space: wrap;
+  padding: 1px 0px 1px 0px;
+}
+.stackTraceEntry {
+  white-space: nowrap;
+  font-family: Courier New, Courier, Monospace;
+  display: block;
+  font-size: 8pt;
+  padding: 1px 0px 1px 32px;
+}
+.stackTraceButton {
+  font-size: 8pt;
+  margin: 2px 8px 2px 0px;
+  font-weight: normal;
+  font-family: Arial;
+}
+
+.special {
+  font-style: italic;
+}
+.missing, .missing * {
+  background-color: #ff9999;
+}
+.surplus, .surplus * {
+  background-color: #ff9999;
+}
+.footer {
+  text-align: right;
+  margin-top: 40px;
+  font-size: 8pt;
+  width: 100%;
+  color: #999;
+}
+.footer .testTime {
+  padding: 2px 10px 0px 0px;
+}
+
+.idea {
+  font-size: 9pt;
+  color: #888;
+  font-style: italic;
+}
+.tight li {
+  margin-top: 1px;
+  margin-bottom: 1px;
+}
+.commentary {
+  float: right;
+  width: 200px;
+  background-color: #ffffd0;
+  padding:8px;
+  border: 3px solid #eeeeb0;
+  margin: 10px 0px 10px 10px;
+}
+.commentary, .commentary * {
+  font-size: 8pt;
+}
+  eoscss
+  
+  css.strip  
+  end
+end

data/lib/concordion_css_decorator.rb

@@ -0,0 +1,52 @@
+require 'concordion_css'
+
+class ConcordionCSSDecorator
+  def add_concordion_css_link(root, html, type)
+    if html.at("head").nil?
+      root.search("html").prepend('<head></head>')
+    end
+    #TODO add an environment variable for this?
+    if type == :link
+      link_to_css(html)
+    else
+      inline_css(html)
+    end
+  end
+  
+  def append_to_head(html, s)
+    html.search("head").append(s)
+  end
+  def link_to_css(html)
+    append_to_head(html, "<link rel='stylesheet' type='text/css' href='#{css_filename}' />")
+  end
+  
+    
+  def inline_css(html)
+    append_to_head(html, "<style type='text/css'>#{css}</style>")
+  end
+  
+  def css
+    ConcordionCSS.css_string
+  end
+  
+  def css_filename
+    ConcordionCSS.css_filename
+  end
+
+  def add_css_file_to_output_dir(writer, type)
+    if !writer.output_file_exists?(css_filename) && type == :link
+      writer.calculate_filename_and_overwrite(css, css_filename)
+    end
+  end
+  
+  def decorate_tag(rv, tag) 
+    if rv[:result]
+      tag[:class] = 'concordion_success'
+      return 0
+    end
+
+    tag[:class] = 'concordion_failure'
+    tag.inner_html += " expected but received #{rv[:actual]}"
+    1
+  end
+end

data/lib/concordion_environment.rb

@@ -0,0 +1,28 @@
+
+class ConcordionEnvironment
+  def self.output_dir_key
+    'RCOR_OUTPUT_DIR'
+  end
+  
+  def self.css_type_key
+    'RCOR_CSS_TYPE'
+  end
+  
+  def self.with_dir(str)
+    File.join(output_dir, str)
+  end
+  def self.clean_list
+    [with_dir("*_test_output.html"), with_dir("concordion.css")] #TODO is this safe to delete? what if the user overwrites this file?
+  end
+
+  #TODO dry this up
+  def self.css_type
+    type = ENV[css_type_key] 
+    type.nil? ? :inline : type.to_sym
+  end
+  
+  def self.output_dir
+    dir = ENV[output_dir_key] 
+    dir.nil? ? "." : dir
+  end
+end

data/lib/concordion_instrumenter.rb

@@ -0,0 +1,30 @@
+
+class ConcordionInstrumenter
+  @@TH_CSS_QUERY_REGEXP = /tr:nth\(\d+\) > th:nth\((\d+)\)$/
+  @@TH_CSS_SINGLE_REGEXP = /tr:nth\(\d+\) > th$/
+
+  def instrument_from_headers(elem, attr, root)
+    header = @@TH_CSS_QUERY_REGEXP.match(elem.css_path)
+    if header
+      instrument_column(elem, attr, header.captures, @@TH_CSS_QUERY_REGEXP, root)
+      return true
+    end
+
+    single_header = @@TH_CSS_SINGLE_REGEXP.match(elem.css_path)
+    if single_header
+      instrument_column(elem, attr, 0, @@TH_CSS_SINGLE_REGEXP, root)
+      return true
+    end
+
+    false
+  end
+
+  def instrument_column(elem, attr, column_number, regex, root)
+    trimmed = elem.css_path.sub(regex, '')
+    td_css_query = trimmed + "tr > td:nth(#{column_number})"
+    
+    value = elem.get_attribute(attr)
+    root.search(td_css_query).set(attr, value)
+  end
+
+end

data/lib/concordion_invocation_string_builder.rb

@@ -0,0 +1,24 @@
+require 'concordion_utility'
+
+
+class ConcordionInvocationStringBuilder
+  include ConcordionUtility
+  def initialize(concordion)
+    @concordion = concordion
+  end
+  
+  def build_invocation_string(conc_call, content)
+    base = "self.send('#{concordion_method_name(conc_call)}'"
+    if has_arguments?(conc_call)
+      arg_vars = concordion_arguments(conc_call)
+      arg_values = arg_vars.collect {|var| "'#{@concordion.get_variable(var)}'" }
+      
+      args = arg_values.join(", ")
+      base += ", " + args
+    end
+
+    rv = base + ")"
+
+    rv.gsub(Concordion.TEXT_VAR, content)
+  end
+end