class Apipie::Generator::Swagger::WarningWriter

Public Class Methods

new() click to toggle source
# File lib/apipie/generator/swagger/warning_writer.rb, line 4
def initialize
  @issued_warnings = []
end

Public Instance Methods

clear!() click to toggle source
# File lib/apipie/generator/swagger/warning_writer.rb, line 21
def clear!
  @issued_warnings = []

  self
end
issued_warnings?() click to toggle source
# File lib/apipie/generator/swagger/warning_writer.rb, line 17
def issued_warnings?
  @issued_warnings.count > 0
end
warn(warning) click to toggle source

@param [Apipie::Generator::Swagger::Warning] warning

# File lib/apipie/generator/swagger/warning_writer.rb, line 9
def warn(warning)
  return if muted_warning?(warning)

  warning.warn

  @issued_warnings << warning.id
end

Private Instance Methods

muted_warning?(warning) click to toggle source

@param [Apipie::Generator::Swagger::Warning] warning

@return [TrueClass, FalseClass]

# File lib/apipie/generator/swagger/warning_writer.rb, line 32
def muted_warning?(warning)
  @issued_warnings.include?(warning.id) ||
    suppressed_warning?(warning.code) ||
    suppress_warnings?
end
suppress_warnings?() click to toggle source

@return [TrueClass, FalseClass]

# File lib/apipie/generator/swagger/warning_writer.rb, line 46
def suppress_warnings?
  suppress_warnings_config == true
end
suppress_warnings_config() click to toggle source

@return [FalseClass, TrueClass, Array]

# File lib/apipie/generator/swagger/warning_writer.rb, line 51
def suppress_warnings_config
  Apipie.configuration.generator.swagger.suppress_warnings
end
suppressed_warning?(warning_number) click to toggle source

@param [Integer] warning_number

@return [TrueClass, FalseClass]

# File lib/apipie/generator/swagger/warning_writer.rb, line 41
def suppressed_warning?(warning_number)
  suppress_warnings_config.is_a?(Array) && suppress_warnings_config.include?(warning_number)
end