Sign upLogin

rikai/Showbot

View on GitHub
Star
lib/cinch/plugins/uptime.rb

Summary

Maintainability
A
0 mins
Test Coverage

Cinch::Plugins::Uptime has no descriptive comment
Open

    class Uptime
Severity: Minor
Found in lib/cinch/plugins/uptime.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Cinch::Plugins::Uptime#command_uptime has the parameter name 'm'
Open

      def command_uptime(m)
Severity: Minor
Found in lib/cinch/plugins/uptime.rb by reek

An Uncommunicative Parameter Name is a parameter name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
Open

      match /uptime/i,  :method => :command_uptime  # !uptime
Severity: Minor
Found in lib/cinch/plugins/uptime.rb by rubocop

This cop checks for ambiguous regexp literals in the first argument of a method invocation without parentheses.

Example:

# bad

# This is interpreted as a method invocation with a regexp literal,
# but it could possibly be `/` method invocations.
# (i.e. `do_something./(pattern)./(i)`)
do_something /pattern/i

Example:

# good

# With parentheses, there's no ambiguity.
do_something(/pattern/i)

There are no issues that match your filters.

Category
Status