class Nanoc::CLI::StreamCleaners::Abstract

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}

Public Instance Methods

clean(str) click to toggle source

Returns a cleaned version of the given string.

@param [String] str The string to clean

@return [String] The cleaned string

# File lib/nanoc/cli/stream_cleaners/abstract.rb, line 17
def clean(str) # rubocop:disable Lint/UnusedMethodArgument
  raise NotImplementedError, 'Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean'
end