greenpepper-ruby 0.0.1

data/lib/greenpepper/executionunit.rb

@@ -0,0 +1,39 @@
+=begin
+author: Pascal Ouellet (pas.ouellet@gmail.com)
+        Sebastien Boisclair (sebboisclair@gmail.com)
+date: October 24, 2009
+=end
+
+module GreenPepper
+class ExecutionUnit
+  attr_accessor :content, # Raw HTML content 
+                :context, # Context of extraction of the content
+                :example, # Example that can be executed
+                :result   # Result of the execution
+
+  def initialize(content, context, example = nil, result = nil)
+    @content = content
+    @context = context
+    @example = example
+    @result = result
+  end
+
+  def execute
+    @result = example.execute
+  end
+
+  def self.result_list(execution_units)
+    result_list = []
+
+    execution_units.each {|ex_unit| result_list << ex_unit.result}
+    result_list
+  end
+  
+  def self.content_list(execution_units)
+    contents = []
+
+    execution_units.each {|ex_unit| contents << ex_unit.content}
+    contents
+  end
+end
+end

data/lib/greenpepper/factory/collectionexamplefactory.rb

@@ -0,0 +1,59 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com) 
+date: March 30, 2009
+=end
+
+module GreenPepper
+
+require 'greenpepper/example/collectionexample'
+require 'greenpepper/factory/examplefactory'
+
+class CollectionExampleFactory < ExampleFactory
+  def create_example(table)
+    ex = do_create_example table[0][1] 
+    table[1].each{|header| ex.add_header header}
+    table[2..-1].each{|row| ex.add_row row}
+    ex
+  end
+end
+
+class ListOfExampleFactory < CollectionExampleFactory
+  def support?(table)
+    /^\s*List\s*Of\s*$/i === table[0][0]
+  end
+
+  def do_create_example(fixture_name)
+    ListOfExample.new fixture_name
+  end
+end
+
+class SetOfExampleFactory < CollectionExampleFactory
+  def support?(table)
+    /^\s*set\s*Of\s*$/i === table[0][0]
+  end
+
+  def do_create_example(fixture_name)
+    SetOfExample.new fixture_name
+  end
+end
+
+class SubsetOfExampleFactory < CollectionExampleFactory
+  def support?(table)
+    /^\s*subset\s*Of\s*$/i === table[0][0]
+  end
+
+  def do_create_example(fixture_name)
+    SubsetOfExample.new fixture_name
+  end
+end
+
+class SupersetOfExampleFactory < CollectionExampleFactory
+  def support?(table)
+    /^\s*superset\s*Of\s*$/i === table[0][0]
+  end
+
+  def do_create_example(fixture_name)
+    SupersetOfExample.new fixture_name
+  end
+end
+end

data/lib/greenpepper/factory/dowithexamplefactory.rb

@@ -0,0 +1,71 @@
+=begin
+author: Steven Denis (denis.steven@gmail.com)
+date: March 23, 2009
+=end
+
+module GreenPepper
+
+require 'greenpepper/example/dowithexample'
+require 'greenpepper/factory/examplefactory'
+
+class DoWithExampleFactory < ExampleFactory
+  def create_example(table)
+    return nil unless support? table
+
+    # fixture name in cell 0,1
+    example = create_example_factory table[0][1]
+
+    # data in next rows
+    table[1..-1].each {|row| 
+      execute_dowith_line row, example
+    }
+    return example
+  end
+
+  def support?(table)
+    /^\s*do\s*with\s*$/i === table[0][0]
+  end
+
+  def last_table?(table)
+    /^\s*end\s*$/i === table[-1][0]
+  end
+
+  protected
+  def create_example_factory(name)
+    DoWithExample.new(name)
+  end
+
+  def execute_dowith_line(row, example)
+    case row[0]
+      when /^\s*check\s*$/i
+        function, params = parse_row row[1..-2]
+        example.add_check function, row.length-1, row[-1], *params 
+      when /^\s*accept\s*$/i
+        function, params = parse_row row[1..-1]
+        example.add_accept function, 0, *params 
+      when /^\s*reject\s*$/i
+        function, params = parse_row row[1..-1]
+        example.add_reject function, 0, *params 
+      when /^\s*end\s*$/i
+        # Do Nothing
+      else
+        function, params = parse_row row
+        example.add_function_call function, 0, *params
+    end
+  end
+
+  def parse_row(row)
+    function = ""
+    params = []
+
+    row.each_index{|cell_index|
+      if cell_index % 2 == 0
+        function += " " + row[cell_index]
+      else
+        params.push row[cell_index]
+      end  
+    }
+    return function, params
+  end
+end
+end #module GreenPepper

data/lib/greenpepper/factory/examplefactory.rb

@@ -0,0 +1,14 @@
+=begin
+author: Steven Denis (denis.steven@gmail.com)
+    Simon Mathieu (simon.math@gmail.com)
+date: March 25, 2009
+=end
+
+module GreenPepper
+
+class ExampleFactory
+  def last_table?(table)
+    true
+  end
+end
+end

data/lib/greenpepper/factory/freetextexamplefactory.rb

@@ -0,0 +1,29 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 30, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/freetextexample'
+require 'greenpepper/factory/examplefactory'
+
+class FreeTextExampleFactory
+  def push_content(scenario)
+    @scenario = scenario
+  end
+
+  def need_more_content?
+    @scenario ? false : true
+  end
+
+  def build_example
+    example = FreeTextExample.new @scenario.fixture_name
+    @scenario.lines.each{ |line|
+      example.add_action line.strip
+    }
+    @scenario = nil
+    example
+  end
+end
+
+end

data/lib/greenpepper/factory/htmlexamplefactory.rb

@@ -0,0 +1,49 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 29, 2009 
+=end
+
+module GreenPepper
+
+require 'greenpepper/factory/unknownexamplefactory'
+require 'greenpepper/executionunit'
+require 'greenpepper/context/htmlcontext'
+
+class HtmlExampleFactory
+  def initialize(factories = [])
+    @factories = factories
+    @table_included = false
+    @current_table = 0
+    @current_factory = nil
+    @more_table = nil
+    @content = nil
+  end
+
+  def push_content(table)
+    if @table_included == false
+      @more_table = true
+      @table_included = true
+      @current_factory = @factories.find{ |f| f.support? table }
+      @current_factory = UnknownExampleFactory.new if @current_factory.nil?
+      @content = Table.new
+    end
+    
+    @content.merge_with table
+    @current_table += 1
+    if @current_factory.last_table?(table)
+      @more_table = false
+    end
+    @content
+  end
+
+  def need_more_content?
+    return @more_table
+  end
+
+  def build_example
+      ex = @current_factory.create_example(@content)
+      @table_included = false
+      ex
+  end
+end
+end

data/lib/greenpepper/factory/importexamplefactory.rb

@@ -0,0 +1,27 @@
+=begin
+author: Pascal Ouellet (pas.ouellet@gmail.com)
+date: March 9, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/importexample'
+require 'greenpepper/factory/examplefactory'
+
+class ImportExampleFactory < ExampleFactory
+  def support?(table)
+    /^\s*import\s*$/i === table[0][0]
+  end
+
+  def create_example(table)
+    return nil unless support? table
+     
+    text_regex = /\A\s*([^\s]*)\s*\Z/
+    example = ImportExample.new
+    table[1..-1].each do |row|
+      text_regex === row[0]
+      example.add $1
+    end
+    return example
+  end
+end
+end #module GreenPepper

data/lib/greenpepper/factory/ruleforexamplefactory.rb

@@ -0,0 +1,46 @@
+=begin
+author: Edouard Murat
+    Pascal Ouellet (pas.ouellet@gmail.com)
+date: March 5, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/ruleforexample'
+require 'greenpepper/factory/examplefactory'
+
+class RuleForExampleFactory < ExampleFactory
+  def create_example(table)
+    return nil unless support? table
+
+    output_header_regex = /\s*(.*)\?\s*\Z/
+
+    # fixture name in cell 0,1
+    example = RuleForExample.new table[0][1]
+
+    # fixture argument in row 0 with symbol/value pair
+    args_cells_size = table[0][2..-1].size
+    2.step(args_cells_size, 2) do |i|
+      example.add_fixture_argument table[0][i + 1]
+    end
+
+    # headers in row 1
+    table[1].each do |header|
+      example.add_header header
+    end
+
+    # data in next rows
+    table[2..-1].each_with_index {|row, index| 
+      example.add_row row
+      if row.size != table[1].size
+        message = "Missing at least one cell on line #{index+1}: Header has #{table[1].size} cells while current row has #{row.size}"
+        raise GreenPepperMalformedTableError.new(message) 
+      end
+    }
+    return example
+  end
+
+  def support?(table)
+    /^\s*rule\s*for\s*$/i === table[0][0]
+  end
+end
+end #module GreenPepper

data/lib/greenpepper/factory/setupexamplefactory.rb

@@ -0,0 +1,31 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com) 
+date: March 23, 2009
+=end
+module GreenPepper
+
+require 'greenpepper/example/setupexample'
+require 'greenpepper/factory/examplefactory'
+require 'greenpepper/example/nameresolver'
+
+class SetupExampleFactory < ExampleFactory
+  def create_example(table)
+    return nil unless support? table
+    example = SetupExample.new table[0][1], NameResolver 
+
+    table[1].each{ |header| 
+      example.add_header header
+    }
+
+    table[2..-1].each{ |values|
+      example.add_row values
+    }
+
+    example
+  end
+
+  def support?(table)
+    /^\s*setup\s*$/i === table[0][0] 
+  end
+end
+end

data/lib/greenpepper/factory/silentexamplefactory.rb

@@ -0,0 +1,21 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 27, 2009
+=end
+
+module GreenPepper
+
+require 'greenpepper/example/silentexample'
+require 'greenpepper/factory/examplefactory'
+
+class SilentExampleFactory < ExampleFactory
+  def create_example(table)
+    SilentExample.new
+  end
+
+  def support?(table)
+    /^\s*silent\s*$/i === table[0][0]
+  end
+end
+end
+

data/lib/greenpepper/factory/unknownexamplefactory.rb

@@ -0,0 +1,16 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 29, 2009 
+=end
+
+module GreenPepper
+
+require 'greenpepper/example/unknownexample'
+require 'greenpepper/factory/examplefactory'
+
+class UnknownExampleFactory < ExampleFactory
+  def create_example(table)
+    UnknownExample.new
+  end
+end
+end

data/lib/greenpepper/freetext.rb

@@ -0,0 +1,164 @@
+=begin
+author: Simon Mathieu (simon.math@gmail.com)
+date: September 12, 2009
+=end
+
+require 'greenpepper/exception/greenpepperexception'
+require 'greenpepper/converter'
+
+module GreenPepper
+module FreeText
+  def self.included(base)
+    # In ruby 1.8.x, class variables scopes are a little too permisive. 
+    # This prevents us from reusing the same name for for all 
+    # actions. So we define a variable with a unique name to avoid a variable 
+    # clash.
+    base.send :class_variable_set, "@@gp_actions_#{base}", []
+
+    base.class_eval {
+      def self.actions
+        self.send :class_variable_get, "@@gp_actions_#{self}"
+      end
+
+      def self.add_action(action)
+        actions << action
+      end
+
+      def self.GivenVanilla(regex, &block) 
+        self.add_action GivenKeyword.new(regex, block, false) 
+      end
+
+      def self.Given(regex, &block) 
+        self.add_action GivenKeyword.new(regex, block, true) 
+      end
+
+      def self.WhenVanilla(regex, &block) 
+        self.add_action WhenKeyword.new(regex, block, false) 
+      end
+
+      def self.When(regex, &block) 
+        self.add_action WhenKeyword.new(regex, block, true) 
+      end
+
+      def self.AskVanilla(regex, &block)
+        self.add_action AskKeyword.new(regex, block, false)
+      end
+
+      def self.Ask(regex, &block)
+        self.add_action AskKeyword.new(regex, block, true)
+      end
+
+      def self.CheckVanilla(regex, &block)
+        self.add_action CheckKeyword.new(regex, block, false)
+      end
+
+      def self.Check(regex, &block)
+        self.add_action CheckKeyword.new(regex, block, true)
+      end
+
+      def self.ThenVanilla(regex, &block)
+        self.add_action ThenKeyword.new(regex, block, false)
+      end
+
+      def self.Then(regex, &block)
+        self.add_action ThenKeyword.new(regex, block, true)
+      end
+    }
+  end
+  
+  # Maps the specified action to the correct block of code and executes it.
+  def greenpepper_map_action(action)
+    actions = self.class.send(:class_variable_get, "@@gp_actions_#{self.class}")
+    actions.each{ |keyword| 
+      if keyword.match?(action)
+        args = keyword.args(action)
+
+        call_method(keyword, args)
+        return keyword
+      end
+    }
+    raise GreenPepperUnknownActionError.new action
+  end
+
+  def call_method(keyword, args)
+    # Set the gp_current_method to be the block so we can call it
+    # as an instance method and not as a class method.
+    self.class.send :define_method, "gp_current_method", keyword.block
+    keyword.result = gp_current_method(*args)
+  end
+end
+
+class FreeTextKeyword
+  attr_reader :block, :regex
+  attr_accessor :result
+
+  def initialize(regex, block, convert)
+    raise ArgumentError.new unless regex.is_a? Regexp
+    raise ArgumentError.new unless block.is_a? Proc
+    @regex, @block, @convert = regex, block, convert
+  end
+
+  def match?(action)
+    @regex === action
+  end
+
+  def args(action)
+    args = @regex.match(action)[1..-1]
+
+    args.collect!{ |arg|
+      TypeConverter.instance.convert_string(arg) 
+    } if @convert
+
+    args
+  end
+
+end
+
+class GivenKeyword < FreeTextKeyword
+  def get_result
+    GivenSuccess.new
+  end
+end
+
+class WhenKeyword < FreeTextKeyword
+  def get_result
+    WhenSuccess.new
+  end
+end
+
+class AskKeyword < FreeTextKeyword
+  def get_result
+    AskSuccess.new @result
+  end
+end
+
+class CheckKeyword < FreeTextKeyword
+  def get_result
+    @result == true ? CheckSuccess.new : CheckFailure.new
+  end
+end
+
+class ThenKeyword < FreeTextKeyword
+  alias_method :old_args, :args
+  def args(action)
+    args = old_args(action)
+    @args = args.collect{ |x| Expectation.new x }
+  end
+
+  def get_result
+    ThenResults.new @regex, @args
+  end
+end
+
+class Expectation
+  attr_reader :expected
+  attr_accessor :received
+  def initialize(expected)
+    @expected = expected
+  end
+
+  def check_result
+    @expected == @received
+  end
+end
+end