Sign upLogin

Xzanth/pugbot

View on GitHub
Star

Showing 27 of 27 total issues

Class BotPlugin has 30 methods (exceeds 20 allowed). Consider refactoring.
Open

  class BotPlugin
    # Set up variables, called when the bot first connects to irc. Start an
    # array of names to not pmsg back.
    # @return [void]
    def initialize(*args)
Severity: Minor
Found in lib/pugbot/handlers.rb - About 3 hrs to fix

    Method finish has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        def finish(m, arg1, arg2)
      user = m.user
      if arg1.nil?
        game = @queue_list.find_game_playing(m.user)
        return user.notice FINISH_NOT_INGAME if game.nil?
    Severity: Minor
    Found in lib/pugbot/handlers.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method remove has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def remove(m, name, arg)
      queue = @queue_list.find_queue_by_arg(arg)
      user = User(name)
      return m.user.notice ACCESS_DENIED unless m.channel.opped?(m.user)
      return m.user.notice USERS_NOT_FOUND if user.nil?
    Severity: Minor
    Found in lib/pugbot/handlers.rb - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method del has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def del(m, arg)
      queue = @queue_list.find_queue_by_arg(arg)
      user = m.user
      return user.notice YOU_ARE_PLAYING if playing?(user)
      return del_from_all(m, user) if arg.nil? || arg == "all"
    Severity: Minor
    Found in lib/pugbot/handlers.rb - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Block has too many lines. [26/25]
    Open

    Gem::Specification.new do |gem|
  gem.name          = "pugbot"
  gem.version       = PugBot::VERSION
  gem.authors       = ["Xzanth"]
  gem.description   = "Pug bot as cinch plugin"
    Severity: Minor
    Found in pugbot.gemspec by rubocop

    This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.

    Method from_hash has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def from_hash(hash)
      @queues = []
      hash.each do |q|
        queue = new_queue(q["queue_name"], q["max_players"])
        q["players"].each do |p|
    Severity: Minor
    Found in lib/pugbot/queue_list.rb - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method add has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def add(m, arg)
      queue = @queue_list.find_queue_by_arg(arg)
      user = m.user
      if /.+otenet.gr/ =~ user.host
        @xtremecount += 1
    Severity: Minor
    Found in lib/pugbot/handlers.rb - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Use a guard clause instead of wrapping the code inside a conditional expression.
    Open

          if @users.length >= @max
    Severity: Minor
    Found in lib/pugbot/queue.rb by rubocop

    Use a guard clause instead of wrapping the code inside a conditional expression

    Example:

    # bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

    Line is too long. [89/80]
    Open

    gem "cinch-commands", git: "git://github.com/Xzanth/cinch-commands.git", branch: "master"
    Severity: Minor
    Found in Gemfile by rubocop

    Missing top-level class documentation comment.
    Open

          class CinchHttpServer
    Severity: Minor
    Found in lib/pugbot/web.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

    Dependencies should be sorted in an alphabetical order within their section of the gemspec. Dependency cinch-http_server should appear before cinch-identify.
    Open

      gem.add_dependency("cinch-http_server", "~> 0.0")
    Severity: Minor
    Found in pugbot.gemspec by rubocop

    Dependencies in the gemspec should be alphabetically sorted.

    Example:

    # bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'

# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'

# good
spec.add_dependency 'rubocop'

spec.add_dependency 'rspec'

# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'

# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'

# good
spec.add_development_dependency 'rubocop'

spec.add_development_dependency 'rspec'

# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'

# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'

# good
spec.add_runtime_dependency 'rubocop'

spec.add_runtime_dependency 'rspec'

# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'

    Use a guard clause instead of wrapping the code inside a conditional expression.
    Open

          unless queue.games.empty?
    Severity: Minor
    Found in lib/pugbot/handlers.rb by rubocop

    Use a guard clause instead of wrapping the code inside a conditional expression

    Example:

    # bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

    Line is too long. [95/80]
    Open

    gem "cinch-http_server", git: "git://github.com/Xzanth/cinch-http_server.git", branch: "master"
    Severity: Minor
    Found in Gemfile by rubocop

    Dependencies should be sorted in an alphabetical order within their section of the gemspec. Dependency cinch-commands should appear before cinch-http_server.
    Open

      gem.add_dependency("cinch-commands", "~> 0.1")
    Severity: Minor
    Found in pugbot.gemspec by rubocop

    Dependencies in the gemspec should be alphabetically sorted.

    Example:

    # bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'

# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'

# good
spec.add_dependency 'rubocop'

spec.add_dependency 'rspec'

# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'

# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'

# good
spec.add_development_dependency 'rubocop'

spec.add_development_dependency 'rspec'

# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'

# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'

# good
spec.add_runtime_dependency 'rubocop'

spec.add_runtime_dependency 'rspec'

# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'

    Use each_key instead of keys.each.
    Open

          @channel.users.keys.each do |u|
    Severity: Minor
    Found in lib/pugbot/handlers.rb by rubocop

    This cop checks for uses of each_key and each_value Hash methods.

    Note: If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you're not working with a hash, and suppress RuboCop offenses.

    Example:

    # bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }
hash.each { |k, _v| p k }
hash.each { |_k, v| p v }

# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }

    Favor a normal unless-statement over a modifier clause in a multiline statement.
    Open

          account = PugBot::Storage::User.first(nick: nick,
                                            authed: false) unless authed?
    Severity: Minor
    Found in lib/pugbot/cinch/user.rb by rubocop

    Checks for uses of if/unless modifiers with multiple-lines bodies.

    Example:

    # bad
{
  result: 'this should not happen'
} unless cond

# good
{ result: 'ok' } if cond

    Missing top-level class documentation comment.
    Open

      class Bot
    Severity: Minor
    Found in lib/pugbot/cinch/bot.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

    Missing top-level class documentation comment.
    Open

      class WebPlugin
    Severity: Minor
    Found in lib/pugbot/web.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

    Favor a normal if-statement over a modifier clause in a multiline statement.
    Open

          account = PugBot::Storage::User.create(authed: true,
                                             auth:   authname,
                                             nick:   authname) if authed?
    Severity: Minor
    Found in lib/pugbot/cinch/user.rb by rubocop

    Checks for uses of if/unless modifiers with multiple-lines bodies.

    Example:

    # bad
{
  result: 'this should not happen'
} unless cond

# good
{ result: 'ok' } if cond

    Dependencies should be sorted in an alphabetical order within their section of the gemspec. Dependency rspec should appear before yard.
    Open

      gem.add_development_dependency "rspec"
    Severity: Minor
    Found in pugbot.gemspec by rubocop

    Dependencies in the gemspec should be alphabetically sorted.

    Example:

    # bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'

# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'

# good
spec.add_dependency 'rubocop'

spec.add_dependency 'rspec'

# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'

# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'

# good
spec.add_development_dependency 'rubocop'

spec.add_development_dependency 'rspec'

# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'

# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'

# good
spec.add_runtime_dependency 'rubocop'

spec.add_runtime_dependency 'rspec'

# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'
    Severity
    Category
    Status
    Source
    Language