Sign upLogin

rikai/Showbot

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

Summary

Maintainability
A
0 mins
Test Coverage

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

    class Twitter
Severity: Minor
Found in lib/cinch/plugins/twitter.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::Twitter#command_last_status calls 'm.user' 2 times
Open

          m.user.send "Sorry, #{user} is not a user I know."
          return
        end

        last_status = @client.last_status_for(user) || "Sorry, I don't know #{user}'s last status."
Severity: Minor
Found in lib/cinch/plugins/twitter.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Cinch::Plugins::Twitter#on_connect has unused parameter 'm'
Open

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

Unused Parameter refers to methods with parameters that are unused in scope of the method.

Having unused parameters in a method is code smell because leaving dead code in a method can never improve the method and it makes the code confusing to read.

Example

Given:

class Klass
  def unused_parameters(x,y,z)
    puts x,y # but not z
  end
end

Reek would emit the following warning:

[2]:Klass#unused_parameters has unused parameter 'z' (UnusedParameters)

Cinch::Plugins::Twitter#on_connect has the parameter name 'm'
Open

      def on_connect(m)
Severity: Minor
Found in lib/cinch/plugins/twitter.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.

Cinch::Plugins::Twitter#command_last_status_list has the parameter name 'm'
Open

      def command_last_status_list(m)
Severity: Minor
Found in lib/cinch/plugins/twitter.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.

Cinch::Plugins::Twitter#command_last_status has the parameter name 'm'
Open

      def command_last_status(m, user)
Severity: Minor
Found in lib/cinch/plugins/twitter.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.

Unused method argument - m. If it's necessary, use _ or _m as an argument name to indicate that it won't be used. You can also write as on_connect(*) if you want the method to accept any arguments but don't care about them.
Open

      def on_connect(m)
Severity: Minor
Found in lib/cinch/plugins/twitter.rb by rubocop

This cop checks for unused method arguments.

Example:

# bad

def some_method(used, unused, _unused_but_allowed)
  puts used
end

Example:

# good

def some_method(used, _unused, _unused_but_allowed)
  puts used
end

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 /last_status$/i,        :method => :command_last_status_list
Severity: Minor
Found in lib/cinch/plugins/twitter.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)

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 /last_status\s+(.*)/i,  :method => :command_last_status
Severity: Minor
Found in lib/cinch/plugins/twitter.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