Sign upLogin

awesome-print/awesome_print

View on GitHub
Star

Showing 387 of 387 total issues

Line is too long. [81/80]
Open

        return name_and_args[0].map(&:size).max, name_and_args[1].map(&:size).max
Severity: Minor
Found in lib/awesome_print/formatters/array_formatter.rb by rubocop

Favor format over String#%.
Open

        str << ":0x%08x" % (object.__id__ * 2) if options[:object_id]
Severity: Minor
Found in lib/awesome_print/formatters/object_formatter.rb by rubocop

This cop enforces the use of a single string formatting utility. Valid options include Kernel#format, Kernel#sprintf and String#%.

The detection of String#% cannot be implemented in a reliable manner for all cases, so only two scenarios are considered - if the first argument is a string literal and if the second argument is an array literal.

Example: EnforcedStyle: format(default)

# bad
puts sprintf('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts format('%10s', 'hoge')

Example: EnforcedStyle: sprintf

# bad
puts format('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts sprintf('%10s', 'hoge')

Example: EnforcedStyle: percent

# bad
puts format('%10s', 'hoge')
puts sprintf('%10s', 'hoge')

# good
puts '%10s' % 'hoge'

Avoid the use of Perl-style backrefs.
Open

              key.sub!($1, colorize($1, :variable))
Severity: Minor
Found in lib/awesome_print/formatters/object_formatter.rb by rubocop

This cop looks for uses of Perl-style regexp match backreferences like $1, $2, etc.

Example:

# bad
puts $1

# good
puts Regexp.last_match(1)

Missing top-level class documentation comment.
Open

    class DirFormatter < BaseFormatter
Severity: Minor
Found in lib/awesome_print/formatters/dir_formatter.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Indent when as deep as case.
Open

              when :block      then "&#{name}"
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

This cop checks how the whens of a case expression are indented in relation to its case or end keyword.

It will register a separate offense for each misaligned when.

Example:

# If Layout/EndAlignment is set to keyword style (default)
# *case* and *end* should always be aligned to same depth,
# and therefore *when* should always be aligned to both -
# regardless of configuration.

# bad for all styles
case n
  when 0
    x * 2
  else
    y / 3
end

# good for all styles
case n
when 0
  x * 2
else
  y / 3
end

Example: EnforcedStyle: case (default)

# if EndAlignment is set to other style such as
# start_of_line (as shown below), then *when* alignment
# configuration does have an effect.

# bad
a = case n
when 0
  x * 2
else
  y / 3
end

# good
a = case n
    when 0
      x * 2
    else
      y / 3
end

Example: EnforcedStyle: end

# bad
a = case n
    when 0
      x * 2
    else
      y / 3
end

# good
a = case n
when 0
  x * 2
else
  y / 3
end

Missing top-level class documentation comment.
Open

    class BaseFormatter
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Use % instead of %Q.
Open

          "#<#{awesome_instance}\n#{data.join(%Q/,\n/)}\n#{outdent}>"
Severity: Minor
Found in lib/awesome_print/formatters/struct_formatter.rb by rubocop

This cop checks if usage of %() or %Q() matches configuration.

Example: EnforcedStyle: bare_percent (default)

# bad
%Q(He said: "#{greeting}")
%q{She said: 'Hi'}

# good
%(He said: "#{greeting}")
%{She said: 'Hi'}

Example: EnforcedStyle: percent_q

# bad
%|He said: "#{greeting}"|
%/She said: 'Hi'/

# good
%Q|He said: "#{greeting}"|
%q/She said: 'Hi'/

Favor format over String#%.
Open

        "#{struct.class.superclass}:#{struct.class}:0x%08x" % (struct.__id__ * 2)
Severity: Minor
Found in lib/awesome_print/formatters/struct_formatter.rb by rubocop

This cop enforces the use of a single string formatting utility. Valid options include Kernel#format, Kernel#sprintf and String#%.

The detection of String#% cannot be implemented in a reliable manner for all cases, so only two scenarios are considered - if the first argument is a string literal and if the second argument is an array literal.

Example: EnforcedStyle: format(default)

# bad
puts sprintf('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts format('%10s', 'hoge')

Example: EnforcedStyle: sprintf

# bad
puts format('%10s', 'hoge')
puts '%10s' % 'hoge'

# good
puts sprintf('%10s', 'hoge')

Example: EnforcedStyle: percent

# bad
puts format('%10s', 'hoge')
puts sprintf('%10s', 'hoge')

# good
puts '%10s' % 'hoge'

Extra blank line detected.
Open


      def method_tuple(method)
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

This cops checks for two or more consecutive blank lines.

Example:

# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method

# good
some_method
# one empty line
some_method

Line is too long. [86/80]
Open

          # Calculate how many elements to be displayed above and below the separator.
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

Extra empty line detected at class body beginning.
Open


      attr_reader :file, :inspector, :options
Severity: Minor
Found in lib/awesome_print/formatters/file_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

end at 23, 10 is not aligned with if at 19, 21.
Open

          end
Severity: Minor
Found in lib/awesome_print/formatters/struct_formatter.rb by rubocop

This cop checks whether the end keywords are aligned properly.

Three modes are supported through the EnforcedStyleAlignWith configuration parameter:

If it's set to keyword (which is the default), the end shall be aligned with the start of the keyword (if, class, etc.).

If it's set to variable the end shall be aligned with the left-hand-side of the variable assignment, if there is one.

If it's set to start_of_line, the end shall be aligned with the start of the line where the matching keyword appears.

Example: EnforcedStyleAlignWith: keyword (default)

# bad

variable = if true
    end

# good

variable = if true
           end

Example: EnforcedStyleAlignWith: variable

# bad

variable = if true
    end

# good

variable = if true
end

Example: EnforcedStyleAlignWith: startofline

# bad

variable = if true
    end

# good

puts(if true
end)

Avoid the use of Perl-style backrefs.
Open

              key.sub!($1, colorize($1, :variable))
Severity: Minor
Found in lib/awesome_print/formatters/struct_formatter.rb by rubocop

This cop looks for uses of Perl-style regexp match backreferences like $1, $2, etc.

Example:

# bad
puts $1

# good
puts Regexp.last_match(1)

Extra empty line detected at class body beginning.
Open


      attr_reader :method, :inspector, :options
Severity: Minor
Found in lib/awesome_print/formatters/method_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

Missing top-level class documentation comment.
Open

    class ArrayFormatter < BaseFormatter
Severity: Minor
Found in lib/awesome_print/formatters/array_formatter.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Do not use unless with else. Rewrite these with the positive case first.
Open

        data = unless should_be_limited?
                 generate_printable_array
               else
                 limited(generate_printable_array, width(array))
               end
Severity: Minor
Found in lib/awesome_print/formatters/array_formatter.rb by rubocop

This cop looks for unless expressions with else clauses.

Example:

# bad
unless foo_bar.nil?
  # do something...
else
  # do a different thing...
end

# good
if foo_bar.present?
  # do something...
else
  # do a different thing...
end

Line is too long. [85/80]
Open

      #------------------------------------------------------------------------------
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

Line is too long. [96/80]
Open

                         "#{indent}#{data[head].strip} .. #{data[data.length - tail - 1].strip}"
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

Line is too long. [98/80]
Open

            klass.sub!($1, '')                    # Yes, strip the fields leaving class name only.
Severity: Minor
Found in lib/awesome_print/formatters/base_formatter.rb by rubocop

Missing top-level class documentation comment.
Open

    class StructFormatter < BaseFormatter
Severity: Minor
Found in lib/awesome_print/formatters/struct_formatter.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end
Severity
Category
Status
Source
Language