cucumber-cucumber-expressions 16.1.2 → 17.0.2

data/lib/cucumber/cucumber_expressions/ast.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module CucumberExpressions
     ESCAPE_CHARACTER = '\\'
@@ -8,55 +10,31 @@ module Cucumber
     END_OPTIONAL_CHARACTER = ')'
 
     class Node
-      def initialize(type, nodes, token, start, _end)
-        if nodes.nil? && token.nil?
-          raise 'Either nodes or token must be defined'
-        end
+      attr_reader :type, :nodes, :token, :start, :end
+
+      def initialize(type, nodes, token, start, ending)
+        raise 'Either nodes or token must be defined' if nodes.nil? && token.nil?
+
         @type = type
         @nodes = nodes
         @token = token
         @start = start
-        @end = _end
-      end
-
-      def type
-        @type
-      end
-
-      def nodes
-        @nodes
-      end
-
-      def token
-        @token
-      end
-
-      def start
-        @start
-      end
-
-      def end
-        @end
+        @end = ending
       end
 
       def text
-        if @token.nil?
-          return @nodes.map { |value| value.text }.join('')
-        end
+        return @nodes.map { |value| value.text }.join('') if @token.nil?
+
         @token
       end
 
       def to_hash
         hash = Hash.new
-        hash["type"] = @type
-        unless @nodes.nil?
-          hash["nodes"] = @nodes.map { |node| node.to_hash }
-        end
-        unless @token.nil?
-          hash["token"] = @token
-        end
-        hash["start"] = @start
-        hash["end"] = @end
+        hash['type'] = @type
+        hash['nodes'] = @nodes.map { |node| node.to_hash } unless @nodes.nil?
+        hash['token'] = @token unless @token.nil?
+        hash['start'] = @start
+        hash['end'] = @end
         hash
       end
     end
@@ -70,26 +48,11 @@ module Cucumber
       EXPRESSION = 'EXPRESSION_NODE'
     end
 
-
     class Token
-      def initialize(type, text, start, _end)
-        @type, @text, @start, @end = type, text, start, _end
-      end
+      attr_reader :type, :text, :start, :end
 
-      def type
-        @type
-      end
-
-      def text
-        @text
-      end
-
-      def start
-        @start
-      end
-
-      def end
-        @end
+      def initialize(type, text, start, ending)
+        @type, @text, @start, @end = type, text, start, ending
       end
 
       def self.is_escape_character(codepoint)
@@ -102,6 +65,7 @@ module Cucumber
           # TODO: Unicode whitespace?
           return true
         end
+
         case c
         when ESCAPE_CHARACTER
           true
@@ -126,6 +90,7 @@ module Cucumber
           # TODO: Unicode whitespace?
           return TokenType::WHITE_SPACE
         end
+
         case c
         when ALTERNATION_CHARACTER
           TokenType::ALTERNATION
@@ -178,10 +143,10 @@ module Cucumber
 
       def to_hash
         {
-            "type" => @type,
-            "text" => @text,
-            "start" => @start,
-            "end" => @end
+          'type' => @type,
+          'text' => @text,
+          'start' => @start,
+          'end' => @end
         }
       end
     end

data/lib/cucumber/cucumber_expressions/combinatorial_generated_expression_factory.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require('cucumber/cucumber_expressions/generated_expression')
 
 module Cucumber
   module CucumberExpressions
-
     class CombinatorialGeneratedExpressionFactory
       def initialize(expression_template, parameter_type_combinations)
         @expression_template = expression_template
@@ -19,9 +20,7 @@ module Cucumber
       MAX_EXPRESSIONS = 256
 
       def generate_permutations(generated_expressions, depth, current_parameter_types)
-        if generated_expressions.length >= MAX_EXPRESSIONS
-          return
-        end
+        return if generated_expressions.length >= MAX_EXPRESSIONS
 
         if depth == @parameter_type_combinations.length
           generated_expression = GeneratedExpression.new(@expression_template, current_parameter_types)
@@ -31,19 +30,13 @@ module Cucumber
 
         (0...@parameter_type_combinations[depth].length).each do |i|
           # Avoid recursion if no elements can be added.
-          if generated_expressions.length >= MAX_EXPRESSIONS
-            return
-          end
+          break if generated_expressions.length >= MAX_EXPRESSIONS
+
           new_current_parameter_types = current_parameter_types.dup # clone
           new_current_parameter_types.push(@parameter_type_combinations[depth][i])
-          generate_permutations(
-              generated_expressions,
-              depth + 1,
-              new_current_parameter_types
-          )
+          generate_permutations(generated_expressions, depth + 1, new_current_parameter_types)
         end
       end
     end
-
   end
 end

data/lib/cucumber/cucumber_expressions/cucumber_expression.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/cucumber_expressions/argument'
 require 'cucumber/cucumber_expressions/tree_regexp'
 require 'cucumber/cucumber_expressions/errors'
@@ -6,8 +8,7 @@ require 'cucumber/cucumber_expressions/cucumber_expression_parser'
 module Cucumber
   module CucumberExpressions
     class CucumberExpression
-
-      ESCAPE_PATTERN = /([\\^\[({$.|?*+})\]])/
+      ESCAPE_PATTERN = /([\\^\[({$.|?*+})\]])/.freeze
 
       def initialize(expression, parameter_type_registry)
         @expression = expression
@@ -62,9 +63,9 @@ module Cucumber
       end
 
       def rewrite_optional(node)
-        assert_no_parameters(node) { |astNode| raise ParameterIsNotAllowedInOptional.new(astNode, @expression) }
-        assert_no_optionals(node) { |astNode| raise OptionalIsNotAllowedInOptional.new(astNode, @expression) }
-        assert_not_empty(node) { |astNode| raise OptionalMayNotBeEmpty.new(astNode, @expression) }
+        assert_no_parameters(node) { |ast_node| raise ParameterIsNotAllowedInOptional.new(ast_node, @expression) }
+        assert_no_optionals(node) { |ast_node| raise OptionalIsNotAllowedInOptional.new(ast_node, @expression) }
+        assert_not_empty(node) { |ast_node| raise OptionalMayNotBeEmpty.new(ast_node, @expression) }
         regex = node.nodes.map { |n| rewrite_to_regex(n) }.join('')
         "(?:#{regex})?"
       end
@@ -72,30 +73,27 @@ module Cucumber
       def rewrite_alternation(node)
         # Make sure the alternative parts aren't empty and don't contain parameter types
         node.nodes.each { |alternative|
-          if alternative.nodes.length == 0
-            raise AlternativeMayNotBeEmpty.new(alternative, @expression)
-          end
-          assert_not_empty(alternative) { |astNode| raise AlternativeMayNotExclusivelyContainOptionals.new(astNode, @expression) }
+          raise AlternativeMayNotBeEmpty.new(alternative, @expression) if alternative.nodes.length == 0
+
+          assert_not_empty(alternative) { |ast_node| raise AlternativeMayNotExclusivelyContainOptionals.new(ast_node, @expression) }
         }
         regex = node.nodes.map { |n| rewrite_to_regex(n) }.join('|')
         "(?:#{regex})"
       end
 
       def rewrite_alternative(node)
-        node.nodes.map { |lastNode| rewrite_to_regex(lastNode) }.join('')
+        node.nodes.map { |last_node| rewrite_to_regex(last_node) }.join('')
       end
 
       def rewrite_parameter(node)
         name = node.text
         parameter_type = @parameter_type_registry.lookup_by_type_name(name)
-        if parameter_type.nil?
-          raise UndefinedParameterTypeError.new(node, @expression, name)
-        end
+        raise UndefinedParameterTypeError.new(node, @expression, name) if parameter_type.nil?
+
         @parameter_types.push(parameter_type)
         regexps = parameter_type.regexps
-        if regexps.length == 1
-          return "(#{regexps[0]})"
-        end
+        return "(#{regexps[0]})" if regexps.length == 1
+
         "((?:#{regexps.join(')|(?:')}))"
       end
 
@@ -105,17 +103,17 @@ module Cucumber
       end
 
       def assert_not_empty(node, &raise_error)
-        text_nodes = node.nodes.select { |astNode| NodeType::TEXT == astNode.type }
+        text_nodes = node.nodes.select { |ast_node| NodeType::TEXT == ast_node.type }
         raise_error.call(node) if text_nodes.length == 0
       end
 
       def assert_no_parameters(node, &raise_error)
-        nodes = node.nodes.select { |astNode| NodeType::PARAMETER == astNode.type }
+        nodes = node.nodes.select { |ast_node| NodeType::PARAMETER == ast_node.type }
         raise_error.call(nodes[0]) if nodes.length > 0
       end
 
       def assert_no_optionals(node, &raise_error)
-        nodes = node.nodes.select { |astNode| NodeType::OPTIONAL == astNode.type }
+        nodes = node.nodes.select { |ast_node| NodeType::OPTIONAL == ast_node.type }
         raise_error.call(nodes[0]) if nodes.length > 0
       end
     end

data/lib/cucumber/cucumber_expressions/cucumber_expression_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/cucumber_expressions/parameter_type_matcher'
 require 'cucumber/cucumber_expressions/generated_expression'
 require 'cucumber/cucumber_expressions/combinatorial_generated_expression_factory'
@@ -12,16 +14,14 @@ module Cucumber
       def generate_expressions(text)
         parameter_type_combinations = []
         parameter_type_matchers = create_parameter_type_matchers(text)
-        expression_template = ""
+        expression_template = +''
         pos = 0
 
         loop do
           matching_parameter_type_matchers = []
           parameter_type_matchers.each do |parameter_type_matcher|
             advanced_parameter_type_matcher = parameter_type_matcher.advance_to(pos)
-            if advanced_parameter_type_matcher.find
-              matching_parameter_type_matchers.push(advanced_parameter_type_matcher)
-            end
+            matching_parameter_type_matchers.push(advanced_parameter_type_matcher) if advanced_parameter_type_matcher.find
           end
 
           if matching_parameter_type_matchers.any?
@@ -39,16 +39,14 @@ module Cucumber
             # Users are most likely to want these, so they should be listed at the top.
             parameter_types = []
             best_parameter_type_matchers.each do |parameter_type_matcher|
-              unless parameter_types.include?(parameter_type_matcher.parameter_type)
-                parameter_types.push(parameter_type_matcher.parameter_type)
-              end
+              parameter_types.push(parameter_type_matcher.parameter_type) unless parameter_types.include?(parameter_type_matcher.parameter_type)
             end
             parameter_types.sort!
 
             parameter_type_combinations.push(parameter_types)
 
             expression_template += escape(text.slice(pos...best_parameter_type_matcher.start))
-            expression_template += "{%s}"
+            expression_template += '{%s}'
 
             pos = best_parameter_type_matcher.start + best_parameter_type_matcher.group.length
           else
@@ -66,14 +64,12 @@ module Cucumber
         ).generate_expressions
       end
 
-    private
+      private
 
       def create_parameter_type_matchers(text)
         parameter_matchers = []
         @parameter_type_registry.parameter_types.each do |parameter_type|
-          if parameter_type.use_for_snippets?
-            parameter_matchers += create_parameter_type_matchers2(parameter_type, text)
-          end
+          parameter_matchers += create_parameter_type_matchers2(parameter_type, text) if parameter_type.use_for_snippets
         end
         parameter_matchers
       end
@@ -88,9 +84,9 @@ module Cucumber
 
       def escape(s)
         s.gsub(/%/, '%%')
-        .gsub(/\(/, '\\(')
-        .gsub(/{/, '\\{')
-        .gsub(/\//, '\\/')
+         .gsub(/\(/, '\\(')
+         .gsub(/{/, '\\{')
+         .gsub(/\//, '\\/')
       end
     end
   end

data/lib/cucumber/cucumber_expressions/cucumber_expression_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/cucumber_expressions/ast'
 require 'cucumber/cucumber_expressions/errors'
 require 'cucumber/cucumber_expressions/cucumber_expression_tokenizer'
@@ -11,16 +13,16 @@ module Cucumber
           token = tokens[current]
           case token.type
           when TokenType::WHITE_SPACE, TokenType::TEXT, TokenType::END_PARAMETER, TokenType::END_OPTIONAL
-            return 1, [Node.new(NodeType::TEXT, nil, token.text, token.start, token.end)]
+            return [1, [Node.new(NodeType::TEXT, nil, token.text, token.start, token.end)]]
           when TokenType::ALTERNATION
             raise AlternationNotAllowedInOptional.new(expression, token)
           when TokenType::BEGIN_PARAMETER, TokenType::START_OF_LINE, TokenType::END_OF_LINE, TokenType::BEGIN_OPTIONAL
           else
             # If configured correctly this will never happen
-            return 0, nil
+            return [0, nil]
           end
           # If configured correctly this will never happen
-          return 0, nil
+          return [0, nil]
         end
 
         # name := whitespace | .
@@ -28,51 +30,40 @@ module Cucumber
           token = tokens[current]
           case token.type
           when TokenType::WHITE_SPACE, TokenType::TEXT
-            return 1, [Node.new(NodeType::TEXT, nil, token.text, token.start, token.end)]
+            return [1, [Node.new(NodeType::TEXT, nil, token.text, token.start, token.end)]]
           when TokenType::BEGIN_PARAMETER, TokenType::END_PARAMETER, TokenType::BEGIN_OPTIONAL, TokenType::END_OPTIONAL, TokenType::ALTERNATION
             raise InvalidParameterTypeNameInNode.new(expression, token)
           when TokenType::START_OF_LINE, TokenType::END_OF_LINE
             # If configured correctly this will never happen
-            return 0, nil
+            return [0, nil]
           else
             # If configured correctly this will never happen
-            return 0, nil
+            return [0, nil]
           end
         end
 
         # parameter := '{' + name* + '}'
-        parse_parameter = parse_between(
-            NodeType::PARAMETER,
-            TokenType::BEGIN_PARAMETER,
-            TokenType::END_PARAMETER,
-            [parse_name]
-        )
+        parse_parameter = parse_between(NodeType::PARAMETER, TokenType::BEGIN_PARAMETER, TokenType::END_PARAMETER, [parse_name])
 
         # optional := '(' + option* + ')'
         # option := optional | parameter | text
         optional_sub_parsers = []
-        parse_optional = parse_between(
-            NodeType::OPTIONAL,
-            TokenType::BEGIN_OPTIONAL,
-            TokenType::END_OPTIONAL,
-            optional_sub_parsers
-        )
+        parse_optional = parse_between(NodeType::OPTIONAL, TokenType::BEGIN_OPTIONAL, TokenType::END_OPTIONAL, optional_sub_parsers)
         optional_sub_parsers << parse_optional << parse_parameter << parse_text
 
         # alternation := alternative* + ( '/' + alternative* )+
         parse_alternative_separator = lambda do |_, tokens, current|
-          unless looking_at(tokens, current, TokenType::ALTERNATION)
-            return 0, nil
-          end
+          return [0, nil] unless looking_at(tokens, current, TokenType::ALTERNATION)
+
           token = tokens[current]
-          return 1, [Node.new(NodeType::ALTERNATIVE, nil, token.text, token.start, token.end)]
+          return [1, [Node.new(NodeType::ALTERNATIVE, nil, token.text, token.start, token.end)]]
         end
 
         alternative_parsers = [
-            parse_alternative_separator,
-            parse_optional,
-            parse_parameter,
-            parse_text,
+          parse_alternative_separator,
+          parse_optional,
+          parse_parameter,
+          parse_text,
         ]
 
         # alternation := (?<=left-boundary) + alternative* + ( '/' + alternative* )+ + (?=right-boundary)
@@ -81,30 +72,26 @@ module Cucumber
         # alternative: = optional | parameter | text
         parse_alternation = lambda do |expr, tokens, current|
           previous = current - 1
-          unless looking_at_any(tokens, previous, [TokenType::START_OF_LINE, TokenType::WHITE_SPACE, TokenType::END_PARAMETER])
-            return 0, nil
-          end
+          return [0, nil] unless looking_at_any(tokens, previous, [TokenType::START_OF_LINE, TokenType::WHITE_SPACE, TokenType::END_PARAMETER])
 
           consumed, ast = parse_tokens_until(expr, alternative_parsers, tokens, current, [TokenType::WHITE_SPACE, TokenType::END_OF_LINE, TokenType::BEGIN_PARAMETER])
           sub_current = current + consumed
-          unless ast.map { |astNode| astNode.type }.include? NodeType::ALTERNATIVE
-            return 0, nil
-          end
+          return [0, nil] unless ast.map { |ast_node| ast_node.type }.include? NodeType::ALTERNATIVE
 
           start = tokens[current].start
           _end = tokens[sub_current].start
           # Does not consume right hand boundary token
-          return consumed, [Node.new(NodeType::ALTERNATION, split_alternatives(start, _end, ast), nil, start, _end)]
+          return [consumed, [Node.new(NodeType::ALTERNATION, split_alternatives(start, _end, ast), nil, start, _end)]]
         end
 
         #
         # cucumber-expression :=  ( alternation | optional | parameter | text )*
         #
         parse_cucumber_expression = parse_between(
-            NodeType::EXPRESSION,
-            TokenType::START_OF_LINE,
-            TokenType::END_OF_LINE,
-            [parse_alternation, parse_optional, parse_parameter, parse_text]
+          NodeType::EXPRESSION,
+          TokenType::START_OF_LINE,
+          TokenType::END_OF_LINE,
+          [parse_alternation, parse_optional, parse_parameter, parse_text]
         )
 
         tokenizer = CucumberExpressionTokenizer.new
@@ -117,30 +104,28 @@ module Cucumber
 
       def parse_between(type, begin_token, end_token, parsers)
         lambda do |expression, tokens, current|
-          unless looking_at(tokens, current, begin_token)
-            return 0, nil
-          end
+          return [0, nil] unless looking_at(tokens, current, begin_token)
+
           sub_current = current + 1
           consumed, ast = parse_tokens_until(expression, parsers, tokens, sub_current, [end_token, TokenType::END_OF_LINE])
           sub_current += consumed
 
           # endToken not found
-          unless looking_at(tokens, sub_current, end_token)
-            raise MissingEndToken.new(expression, begin_token, end_token, tokens[current])
-          end
+          raise MissingEndToken.new(expression, begin_token, end_token, tokens[current]) unless looking_at(tokens, sub_current, end_token)
+
           # consumes endToken
           start = tokens[current].start
           _end = tokens[sub_current].end
           consumed = sub_current + 1 - current
           ast = [Node.new(type, ast, nil, start, _end)]
-          return consumed, ast
+          return [consumed, ast]
         end
       end
 
       def parse_token(expression, parsers, tokens, start_at)
         parsers.each do |parser|
           consumed, ast = parser.call(expression, tokens, start_at)
-          return consumed, ast unless consumed == 0
+          return [consumed, ast] unless consumed == 0
         end
         # If configured correctly this will never happen
         raise 'No eligible parsers for ' + tokens
@@ -151,15 +136,15 @@ module Cucumber
         size = tokens.length
         ast = []
         while current < size do
-          if looking_at_any(tokens, current, end_tokens)
-            break
-          end
+          break if looking_at_any(tokens, current, end_tokens)
+
           consumed, sub_ast = parse_token(expression, parsers, tokens, current)
           if consumed == 0
             # If configured correctly this will never happen
             # Keep to avoid infinite loops
             raise 'No eligible parsers for ' + tokens
           end
+
           current += consumed
           ast += sub_ast
         end
@@ -176,9 +161,8 @@ module Cucumber
           # Keep for completeness
           return token == TokenType::START_OF_LINE
         end
-        if at >= tokens.length
-          return token == TokenType::END_OF_LINE
-        end
+        return token == TokenType::END_OF_LINE if at >= tokens.length
+
         tokens[at].type == token
       end
 
@@ -186,7 +170,7 @@ module Cucumber
         separators = []
         alternatives = []
         alternative = []
-        alternation.each { |n|
+        alternation.each do |n|
           if NodeType::ALTERNATIVE == n.type
             separators.push(n)
             alternatives.push(alternative)
@@ -194,7 +178,7 @@ module Cucumber
           else
             alternative.push(n)
           end
-        }
+        end
         alternatives.push(alternative)
         create_alternative_nodes(start, _end, separators, alternatives)
       end

data/lib/cucumber/cucumber_expressions/cucumber_expression_tokenizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/cucumber_expressions/ast'
 require 'cucumber/cucumber_expressions/errors'
 
@@ -15,9 +17,7 @@ module Cucumber
 
         codepoints = expression.codepoints
 
-        if codepoints.empty?
-          tokens.push(Token.new(TokenType::START_OF_LINE, '', 0, 0))
-        end
+        tokens.push(Token.new(TokenType::START_OF_LINE, '', 0, 0)) if codepoints.empty?
 
         codepoints.each do |codepoint|
           if !treat_as_text && Token.is_escape_character(codepoint)
@@ -63,10 +63,10 @@ module Cucumber
 
         consumed_index = @buffer_start_index + @buffer.length + escape_tokens
         t = Token.new(
-            token_type,
-            @buffer.map { |codepoint| codepoint.chr(Encoding::UTF_8) }.join(''),
-            @buffer_start_index,
-            consumed_index
+          token_type,
+          @buffer.map { |codepoint| codepoint.chr(Encoding::UTF_8) }.join(''),
+          @buffer_start_index,
+          consumed_index
         )
         @buffer = []
         @buffer_start_index = consumed_index
@@ -74,21 +74,16 @@ module Cucumber
       end
 
       def token_type_of(codepoint, treat_as_text)
-        unless treat_as_text
-          return Token.type_of(codepoint)
-        end
-        if Token.can_escape(codepoint)
-          return TokenType::TEXT
-        end
-        raise CantEscape.new(
-            @expression,
-            @buffer_start_index + @buffer.length + @escaped
-        )
+        return Token.type_of(codepoint) unless treat_as_text
+
+        return TokenType::TEXT if Token.can_escape(codepoint)
+
+        raise CantEscape.new(@expression, @buffer_start_index + @buffer.length + @escaped)
       end
 
       def should_create_new_token?(previous_token_type, current_token_type)
         current_token_type != previous_token_type ||
-            (current_token_type != TokenType::WHITE_SPACE && current_token_type != TokenType::TEXT)
+          (current_token_type != TokenType::WHITE_SPACE && current_token_type != TokenType::TEXT)
       end
     end
   end