robertgauld/snmp_table_viewer

View on GitHub
lib/snmp_table_viewer/formatter.rb

Summary

Maintainability
A
0 mins
Test Coverage

Extra empty line detected at class body end.
Open


  end # Formatter base class
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Extra empty line detected at module body beginning.
Open


  # Parent class for formatters. Which take data and headings and output it in a given format.
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cops checks if empty lines around the bodies of modules match the configuration.

Example: EnforcedStyle: empty_lines

# good

module Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

module Foo
  module Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
module Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

module Foo
  def bar
    # ...
  end
end

Line is too long. [81/80]
Open

    # @param headings [Array<String, #to_s>] An array of headings for each column
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

Extra empty line detected at class body beginning.
Open


    # Create a new instance of Formatter.
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Do not place comments on the same line as the end keyword.
Open

  end # Formatter base class
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cop checks for comments put on the same line as some keywords. These keywords are: begin, class, def, end, module.

Note that some comments (such as :nodoc: and rubocop:disable) are allowed.

Example:

# bad
if condition
  statement
end # end if

# bad
class X # comment
  statement
end

# bad
def x; end # comment

# good
if condition
  statement
end

# good
class X # :nodoc:
  y
end

Use 2 (not 4) spaces for indentation.
Open

        @headings = headings
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cops checks for indentation that doesn't use the specified number of spaces.

See also the IndentationConsistency cop which is the companion to this one.

Example:

# bad
class A
 def test
  puts 'hello'
 end
end

# good
class A
  def test
    puts 'hello'
  end
end

Example: IgnoredPatterns: ['^\s*module']

# bad
module A
class B
  def test
  puts 'hello'
  end
end
end

# good
module A
class B
  def test
    puts 'hello'
  end
end
end

Use empty lines between method definitions.
Open

    def has_headings?
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cop checks whether method definitions are separated by one empty line.

NumberOfEmptyLines can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

AllowAdjacentOneLineDefs can be used to configure is adjacent one line methods definitions are an offense

Example:

# bad
def a
end
def b
end

Example:

# good
def a
end

def b
end

Do not place comments on the same line as the end keyword.
Open

end # module SNMPTableViewer
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cop checks for comments put on the same line as some keywords. These keywords are: begin, class, def, end, module.

Note that some comments (such as :nodoc: and rubocop:disable) are allowed.

Example:

# bad
if condition
  statement
end # end if

# bad
class X # comment
  statement
end

# bad
def x; end # comment

# good
if condition
  statement
end

# good
class X # :nodoc:
  y
end

Keep a blank line before and after private.
Open

    private
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

Access modifiers should be surrounded by blank lines.

Example:

# bad
class Foo
  def bar; end
  private
  def baz; end
end

# good
class Foo
  def bar; end

  private

  def baz; end
end

Line is too long. [115/80]
Open

    # Get a two dimensioan array of headings prepended to the data or just the data (if no headings were provided).
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

Extra empty line detected at module body end.
Open


end # module SNMPTableViewer
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cops checks if empty lines around the bodies of modules match the configuration.

Example: EnforcedStyle: empty_lines

# good

module Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

module Foo
  module Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
module Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

module Foo
  def bar
    # ...
  end
end

Line is too long. [94/80]
Open

  # Parent class for formatters. Which take data and headings and output it in a given format.
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

Line is too long. [125/80]
Open

    # @param data [Array<Array<#to_s>>] A two dimensional array containing objects in each cell (at 'address' data[row][col])
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

Rename has_headings? to headings?.
Open

    def has_headings?
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Use !empty? instead of size > 0.
Open

      @headings.is_a?(Array) && @headings.size > 0
Severity: Minor
Found in lib/snmp_table_viewer/formatter.rb by rubocop

This cop checks for numeric comparisons that can be replaced by a predicate method, such as receiver.length == 0, receiver.length > 0, receiver.length != 0, receiver.length < 1 and receiver.size == 0 that can be replaced by receiver.empty? and !receiver.empty.

Example:

# bad
[1, 2, 3].length == 0
0 == "foobar".length
array.length < 1
{a: 1, b: 2}.length != 0
string.length > 0
hash.size > 0

# good
[1, 2, 3].empty?
"foobar".empty?
array.empty?
!{a: 1, b: 2}.empty?
!string.empty?
!hash.empty?

There are no issues that match your filters.

Category
Status