Class: Cuporter::FeatureParser::ParserBase

Inherits:
Object
  • Object
show all
Defined in:
lib/cuporter/feature_parser/parser_base.rb

Direct Known Subclasses

NodeParser, TagNodesParser

Constant Summary collapse

TAG_LINE = 
/^\s*(@\w.+)/u
EXAMPLE_LINE = 
/^\s*(\|.*\|)\s*$/u
PY_STRING_LINE = 
/^\s*"""\s*$/u

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file) ⇒ ParserBase

Returns a new instance of ParserBase.



10
11
12
13
14
15
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 10

def initialize(file)
  @file = file
  @current_tags = []
  @lines = File.without_byte_order_mark(@file).split(/\n/)
  @lang  = Language.new(@lines.first)
end

Instance Attribute Details

#lang ⇒ Object (readonly)

Returns the value of attribute lang.



16
17
18
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 16

def lang
  @lang
end

#root=(value) ⇒ Object (writeonly)

Sets the attribute root

Parameters:

  • value —

    the value to set the attribute root to.



17
18
19
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 17

def root=(value)
  @root = value
end

Instance Method Details

#clean_cuke_line(sub_expression) ⇒ Object 



81
82
83
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 81

def clean_cuke_line(sub_expression)
  sub_expression.strip.escape_apostrophe
end

#file_relative_path ⇒ Object 



20
21
22
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 20

def file_relative_path
  @file_relative_path ||= @file.sub(/^.*#{@root}\//,"#{@root}/")
end

#handle_lines ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 37

def handle_lines
  @open_comment_block = false
   
  @lines.each_with_index do |line, i|
    @line_no = i + 1
    next if @open_comment_block && line !~ PY_STRING_LINE
   
    case line
    when PY_STRING_LINE
      # toggle, to declare the multiline comment 'heredoc' open or closed
      @open_comment_block = !@open_comment_block
    when TAG_LINE
      # may be more than one tag line
      @current_tags |= clean_cuke_line($1).split(/\s+/)
    when @lang.feature_line
      @feature = new_feature_node(clean_cuke_line($1), file_relative_path)
      @current_tags = []
    when @lang.scenario_line
      # How do we know when we have read all the lines from a "Scenario Outline:"?
      # One way is when we encounter a "Scenario:"
      close_scenario_outline
   
      handle_scenario_line(clean_cuke_line($1))
      @current_tags = []
    when @lang.scenario_outline_line
      # ... another is when we hit a subsequent "Scenario Outline:"
      close_scenario_outline
   
      @scenario_outline  = new_scenario_outline_node(clean_cuke_line($1))
      @current_tags = []
    when @lang.examples_line
      handle_example_set_line if @example_set
   
      @example_set = new_example_set_node(clean_cuke_line($1))
      @current_tags = []
    when @example_set && EXAMPLE_LINE
      new_example_line(clean_cuke_line($1))
    end
  end
  
  # EOF is the final way that we know we are finished with a "Scenario Outline"
  handle_eof
end

#parse_feature ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/cuporter/feature_parser/parser_base.rb', line 24

def parse_feature
  begin
    handle_lines
  rescue Exception => ex
    raise if ENV['CUPORTER_MODE'] =~ /^test$/i
    Cuporter.log_error(ex, "Error parsing file", "at line #{@line_no}:", @file, 
                       %Q{\n\tIf this file can be run by Cucumber with no Gherkin lexing or parsing errors,
     please submit a bug ticket @ github including: 1) this feature file or its contents, and 2) this stack trace.
                       })
  end
  return @feature
end