Sign upLogin

TheCorrespondingSquares/chess-app

View on GitHub
Star
db/migrate/20170529093919_add_reference_to_black_player.rb

Summary

Maintainability
A
0 mins
Test Coverage

Tab detected.
Open

      add_reference :games, :black_player, references: :users, index: true
Severity: Minor
Found in db/migrate/20170529093919_add_reference_to_black_player.rb by rubocop

Missing top-level class documentation comment.
Open

class AddReferenceToBlackPlayer < ActiveRecord::Migration[5.0]
Severity: Minor
Found in db/migrate/20170529093919_add_reference_to_black_player.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 2 (not 1) spaces for indentation.
Open

      add_reference :games, :black_player, references: :users, index: true
Severity: Minor
Found in db/migrate/20170529093919_add_reference_to_black_player.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

Tab detected.
Open

      add_foreign_key :games, :users, column: :black_player_id
Severity: Minor
Found in db/migrate/20170529093919_add_reference_to_black_player.rb by rubocop

There are no issues that match your filters.

Category
Status