Sha256: d29d6bc65506205a32ed0bab73eeaae542602772819eea367b1b39701f51a4b4
Contents?: true
Size: 702 Bytes
Versions: 28
Compression:
Stored size: 702 Bytes
Contents
# frozen_string_literal: true
module Nanoc::CLI::StreamCleaners
# Superclass for all stream cleaners. Stream cleaners have a single method,
# {#clean}, that takes a string and returns a cleaned string. Stream cleaners
# can have state, so they can act as a FSM.
#
# @abstract Subclasses must implement {#clean}
#
# @api private
class Abstract
# Returns a cleaned version of the given string.
#
# @param [String] str The string to clean
#
# @return [String] The cleaned string
def clean(str) # rubocop:disable Lint/UnusedMethodArgument
raise NotImplementedError, 'Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean'
end
end
end
Version data entries
28 entries across 28 versions & 1 rubygems