greenpepper-ruby 0.0.1

data/lib/greenpepper/example/fieldaccessor.rb

@@ -0,0 +1,36 @@
+=begin
+author: Murat Edouard
+date: September 5, 2009
+=end
+
+module GreenPepper
+
+require 'greenpepper/exception/greenpepperexception'
+    
+class InstanceFieldAccessor
+  def access_instance_field(fixture, field_name, value=nil)
+    method = fixture.public_methods.find{
+      |method| method.to_s == field_name
+    }
+    if method.nil?
+      raise ErrorHelper.raise_greenpepper_missing_method(
+        field_name, fixture)
+    else
+      call_accessor fixture.method(field_name), value
+    end
+  end
+end
+
+class ReaderFieldAccessor < InstanceFieldAccessor
+  def call_accessor(method, value)
+    return method.call 
+  end
+end
+
+class WriterFieldAccessor < InstanceFieldAccessor
+  def call_accessor(method, value)
+    method.call value
+  end
+end
+
+end

data/lib/greenpepper/example/freetextexample.rb

@@ -0,0 +1,51 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 13, 2009
+=end
+
+module GreenPepper
+
+require 'greenpepper/example/executionresults'
+require 'greenpepper/example/nameresolver'
+require 'greenpepper/example/examplewithfixture'
+require 'greenpepper/writer/freetextresult'
+
+class FreeTextExample
+  attr_reader :actions, :fixture_name
+
+  def initialize(fixture_name)
+    @fixture_name = fixture_name
+    @actions = []
+  end
+
+  def add_action(action)
+    @actions << action
+  end
+
+  def execute
+    results = FreeTextExecutionResults.new
+    fixture_class = NameResolver.solve_fixture_name(@fixture_name)
+
+    if fixture_class.nil?
+      results.add_result HeaderError.new(@fixture_name, 
+        GreenPepperMissingHeaderError.new)
+      return results
+    end
+
+    results.add_result HeaderSuccess.new(@fixture_name)
+
+    fixture = fixture_class.new
+
+    @actions.each_with_index{ |action, index|
+      begin
+        keyword = fixture.greenpepper_map_action action
+        results.add_result keyword.get_result
+      rescue Exception => e
+        results.add_result ActionError.new(e)
+      end
+    }
+
+    results
+  end
+end
+end

data/lib/greenpepper/example/importexample.rb

@@ -0,0 +1,39 @@
+=begin
+authors: Pascal Ouellet (pas.ouellet@gmail.com)
+date: March 6, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/executionresults'
+require 'greenpepper/writer/htmlresult'
+
+class ImportExample
+  attr_reader :imports
+
+  FIRST_DATA_ROW = 1
+  DATA_COLUMN = 0
+
+  def initialize
+    @imports = Array.new
+  end
+
+  def add(*imports)
+    @imports.concat imports
+  end
+
+  def execute
+    results = HtmlTableExecutionResults.new
+    @imports.each_with_index do |import, index|
+      begin
+        require import
+        results.add index + FIRST_DATA_ROW, DATA_COLUMN, NoExampleResult.new
+      rescue Exception => e
+        e = e.exception "Failed to import #{import}: #{e.exception}"
+        results.add index + FIRST_DATA_ROW, DATA_COLUMN, WriteExceptionExampleResult.new(e, true)
+      end
+    end
+    results
+  end
+end
+
+end #module GreenPepper

data/lib/greenpepper/example/nameresolver.rb

@@ -0,0 +1,69 @@
+=begin
+author: Sebastien Boisclair (SebBoisclair@gmail.com)
+date: March 8, 2009
+=end
+
+require 'greenpepper/example/fieldaccessor'
+require 'accents'
+
+module GreenPepper
+
+module NameResolver
+  def NameResolver.solve_fixture_name(fixture_name)
+    # Remove accents using third party library
+    # Ex. é => e
+    fixture_name = fixture_name.removeaccents
+
+    # Ignore illegal caracters
+    fixture_name = fixture_name.gsub /[^a-zA-Z0-9_\s]/, ""
+    regex = create_regex(fixture_name)
+    fixture_classes = []
+ 
+    Module.constants.each{|constant|
+      if(regex.match(constant))
+        fixture_classes.push(constant) 
+      end
+    }
+    return nil if(fixture_classes.length == 0)
+
+
+    fixture_name_class = fixture_classes.find{|fixture_string|
+      /.*(f|F)ixture$/ === fixture_string
+    }
+
+    if fixture_name_class == nil
+      fixture_name_class = fixture_classes[0]
+    end
+    Object.const_get fixture_name_class
+  end
+        
+  def NameResolver.format_column_name name
+    string = name.strip.downcase.split(' ').join('_')
+  end
+
+  def NameResolver.set_instance_field fixture, field_name, value
+    writer = WriterFieldAccessor.new
+    writer.access_instance_field fixture, field_name + "=", value
+  end
+
+  def NameResolver.get_instance_field fixture, field_name
+    reader = ReaderFieldAccessor.new
+    reader.access_instance_field fixture, field_name
+  end
+
+  private
+
+  def NameResolver.create_regex(fixture_name)
+    fixture_regex = '^'
+    fixture_name = fixture_name.gsub( / |_/, "_?")
+    if lower_word = fixture_name.scan( /[^A-Z]*/)
+      fixture_regex += lower_word[0]
+    end
+    fixture_name.scan(/[A-Z][^A-Z]*/).each{|word|fixture_regex += "_?" + word}
+    
+    fixture_regex +='_?(fixture)?\s*$'
+    Regexp.new fixture_regex, 'i'
+  end
+end # Module NameResolver
+
+end # Module GreenPepper

data/lib/greenpepper/example/ruleforexample.rb

@@ -0,0 +1,117 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: March 9, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/executionresults'
+require 'greenpepper/example/nameresolver'
+require 'greenpepper/example/examplewithfixture'
+require 'greenpepper/example/exampleheader'
+require 'greenpepper/converter'
+require 'greenpepper/exception/greenpepperexception'
+
+class RuleForExample < ExampleWithFixture
+
+  attr_reader :values
+
+  FIRST_DATA_ROW = 2
+
+  def initialize(fixture_name, name_resolver = NameResolver)
+    super fixture_name
+    @values = Array.new
+    @name_resolver = name_resolver
+  end
+
+  def add_header(name)
+    output_header_regex = /\s*(.*)\?\s*\Z/
+    if output_header_regex === name 
+      add_output_header($1)
+    else
+      add_input_header(name)
+    end
+  end
+
+  def add_input_header(name)
+    header = ExampleInputHeader.new(name, @name_resolver)
+    @headers.push header
+    header
+  end
+
+  def add_output_header(name)
+    header = RuleForOutputHeader.new(name, @name_resolver)
+    @headers.push header 
+    header
+  end
+
+  def add_row(values_array)
+    @values.push values_array
+  end
+
+  def do_execute(results, fixture_class)
+    @values.each_index{ |row_index|
+      # We instantiate a fixture every row to reset the object
+      fixture = instantiate_fixture fixture_class
+
+      headers.each_index{ |column_index|
+        header = headers[column_index]
+        string_value = @values[row_index][column_index]
+        value = TypeConverter.instance.auto_convert_string(
+          fixture, header.name, string_value)
+
+        #The output header needs to keep the value of an empty string
+        #instead of nil because it needs to differentiate the nil value
+        #and an ignored cell.
+        if header.class == RuleForOutputHeader &&
+          (string_value == '')
+          value = ''
+        end
+        result = header.execute( value, fixture, string_value)
+        results.add row_index + FIRST_DATA_ROW, column_index,
+          result unless result == nil
+      }
+    }
+    results
+  end
+
+end
+
+class RuleForOutputHeader < ExampleBaseHeader
+
+  def execute(value, fixture, value_format)
+    return NoExampleResult.new if !fixture.respond_to? @formated_name
+
+    begin
+      result = get_result fixture
+    rescue Exception => e
+      if value.is_a? Exception
+        return SuccessExampleResult.new
+      end
+      return WriteExceptionExampleResult.new(e)
+    end
+
+    return SuccessExampleResult.new if value == result
+
+    formated_result = TypeConverter.instance.auto_convert_object(
+      fixture,
+      @name,
+      value_format,
+      result)
+
+    formated_value = TypeConverter.instance.auto_convert_object(
+      fixture,
+      @name,
+      value_format,
+      value)
+
+    return WriteIgnoredExampleResult.new(formated_result) if value == ''
+    return WriteExpectedExampleResult.new(formated_value, formated_result)
+  end
+
+  private
+  def get_result(fixture)
+    fixture.send @formated_name
+  end
+end
+
+end #module GreenPepper

data/lib/greenpepper/example/setupexample.rb

@@ -0,0 +1,79 @@
+=begin
+author: Martin Provencher (martin.provencher@usherbrooke.ca)
+date: March 23, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/nameresolver'
+require 'greenpepper/example/examplewithfixture'
+require 'greenpepper/example/exampleheader'
+require 'greenpepper/converter'
+require 'greenpepper/exception/greenpepperexception'
+
+class SetupExample < ExampleWithFixture
+
+  attr_reader :values
+  FIXTURE_NAME_ROW = 0
+  FIXTURE_NAME_COL = 1
+  FIRST_DATA_ROW = 2
+  HEADER_ROW = 1
+
+  def initialize(fixture_name, name_resolver = NameResolver)
+    super fixture_name
+    @values = Array.new
+    @name_resolver= name_resolver
+  end
+
+  def add_header(name)
+     header = ExampleInputHeader.new(@name_resolver.format_column_name(name),
+       @name_resolver)
+    @headers.push header 
+    header
+  end
+
+  def add_row(values_array)
+    @values.push values_array
+  end
+
+  def do_execute(results, fixture_class)
+    fixture = instantiate_fixture fixture_class
+
+    if !(fixture.respond_to? "enter_row")
+      ex = ErrorHelper.create_greenpepper_missing_method 'enter_row', 
+        fixture_class
+      results.add FIXTURE_NAME_ROW, FIXTURE_NAME_COL, 
+        WriteExceptionExampleResult.new(ex)
+      return results
+    end 
+
+    @values.each_index{ |row_index|
+      headers.each_index{ |column_index|
+        header = headers[column_index]
+        string_value = @values[row_index][column_index]
+        value = TypeConverter.instance.auto_convert_string(
+          fixture, header.name, string_value)
+
+        begin
+          header.execute value, fixture
+        rescue => error
+          result = WriteExceptionExampleResult.new(error)
+          results.add row_index + FIRST_DATA_ROW, column_index, result
+        end
+      }
+      begin
+        result = fixture.enter_row
+        if result
+          result = WriteSucessExampleResult.new true
+        else
+          result = WriteFailExampleResult.new
+        end
+      rescue => error
+        result = WriteExceptionExampleResult.new(error)
+      end
+      results.add row_index + FIRST_DATA_ROW, headers.size, result
+    }
+    results
+  end
+
+end
+end #module GreenPepper

data/lib/greenpepper/example/silentexample.rb

@@ -0,0 +1,14 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 27, 2009
+=end
+module GreenPepper
+
+class SilentExample
+  def execute
+    results = HtmlTableExecutionResults.new
+    results.add(0, 0, IgnoredExampleResult.new)
+    results
+  end
+end
+end

data/lib/greenpepper/example/unknownexample.rb

@@ -0,0 +1,17 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: March 30, 2009
+=end
+
+require 'greenpepper/example/executionresults'
+
+module GreenPepper
+
+class UnknownExample
+  def execute
+    results = HtmlTableExecutionResults.new
+    results.add 0, 0, ErrorExampleResult.new 
+    results
+  end
+end
+end

data/lib/greenpepper/exception/greenpepperexception.rb

@@ -0,0 +1,57 @@
+=begin
+author: Pascal Ouellet (pas.ouellet@gmail.com)
+date: March 17, 2009
+=end
+module GreenPepper
+
+class GreenPepperError < StandardError
+end
+
+class GreenPepperArgumentError < GreenPepperError
+end
+
+class GreenPepperMalformedTableError < GreenPepperError
+end
+
+class GreenPepperLibXmlError < GreenPepperError
+end
+
+class GreenPepperTypeError < GreenPepperError
+end
+
+class GreenPepperSecurityError < GreenPepperError
+end
+
+class GreenPepperMissingMethodError < GreenPepperError
+end
+
+class GreenPepperMissingHeaderError < GreenPepperError
+end
+
+class GreenPepperElementError < GreenPepperError
+end
+
+class GreenPepperFileNotFoundError < GreenPepperError
+end
+
+class GreenPepperRepositoryError < GreenPepperError
+end
+
+class GreenPepperUnknownActionError < GreenPepperError
+end
+
+class GreenPepperNoScenarioInTag < GreenPepperError
+end
+
+module ErrorHelper
+def ErrorHelper.raise_greenpepper_missing_method(func, fixture)
+  raise create_greenpepper_missing_method(func, fixture)
+end
+
+def ErrorHelper.create_greenpepper_missing_method(func, fixture)
+  GreenPepperMissingMethodError.new(
+    "Cannot find method #{func} on fixture #{fixture.class}.")
+end
+end
+
+end #module GreenPepper