Contents

# frozen_string_literal: true
require 'delegate'
module Cucumber
  module Core
    module Test
      # Represents an inline argument in a step. Example:
      #
      #   Given the message
      #     """
      #     I like
      #     Cucumber sandwich
      #     """
      #
      # The text between the pair of <tt>"""</tt> is stored inside a DocString,
      # which is yielded to the StepDefinition block as the last argument.
      #
      # The StepDefinition can then access the String via the #to_s method. In the
      # example above, that would return: <tt>"I like\nCucumber sandwich"</tt>
      #
      # Note how the indentation from the source is stripped away.
      #
      class DocString < SimpleDelegator
        include HasLocation

        attr_reader :content_type, :content

        def initialize(content, content_type, location)
          @content = content
          @content_type = content_type
          @location = location
          super @content
        end

        def describe_to(visitor, *args)
          visitor.doc_string(self, *args)
        end

        def data_table?
          false
        end

        def doc_string?
          true
        end

        def map
          raise ArgumentError, "No block given" unless block_given?
          new_content = yield content
          self.class.new(new_content, content_type, location)
        end

        def to_step_definition_arg
          self
        end

        def ==(other)
          if other.respond_to?(:content_type)
            return false unless content_type == other.content_type
          end
          if other.respond_to?(:to_str)
            return content == other.to_str
          end
          false
        end

        def inspect
          [
            %{#<#{self.class} (#{location})},
            %{  """#{content_type}},
            %{  #{@content}},
            %{  """>}
          ].join("\n")
        end

      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
cucumber-core-5.0.2	lib/cucumber/core/test/doc_string.rb
cucumber-core-5.0.1	lib/cucumber/core/test/doc_string.rb
cucumber-core-5.0.0	lib/cucumber/core/test/doc_string.rb
cucumber-core-4.0.0	lib/cucumber/core/test/doc_string.rb