Sha256: aa9b5794186478ab693753cd76cae7c9145d6b1751d8c34b4f6f76f12c7121d3

Contents?: true

Size: 667 Bytes

Versions: 62

Compression:

Stored size: 667 Bytes

Contents

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] s The string to clean
    #
    # @return [String] The cleaned string
    def clean(s) # rubocop:disable Lint/UnusedMethodArgument
      raise NotImplementedError, 'Subclasses of Nanoc::CLI::StreamCleaners::Abstract must implement #clean'
    end
  end
end

Version data entries

62 entries across 62 versions & 1 rubygems

Version Path
nanoc-4.7.9 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.8 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.7 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.6 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.5 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.4 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.3 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.2 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.1 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.7.0 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.6.4 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.6.3 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.6.2 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.6.1 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.6.0 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.5.4 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.5.3 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.5.2 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.5.1 lib/nanoc/cli/stream_cleaners/abstract.rb
nanoc-4.5.0 lib/nanoc/cli/stream_cleaners/abstract.rb