Sign upLogin

lujanfernaud/prevy

View on GitHub
Star
app/policies/topic_comment_policy.rb

Summary

Maintainability
A
0 mins
Test Coverage

TopicCommentPolicy has no descriptive comment
Open

class TopicCommentPolicy < ApplicationPolicy
Severity: Minor
Found in app/policies/topic_comment_policy.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

Rename is_group_owner? to group_owner?.
Open

    def is_group_owner?
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Rename is_group_owner_or_moderator? to group_owner_or_moderator?.
Open

    def is_group_owner_or_moderator?
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Inconsistent indentation detected.
Open

    def is_author?
      record.user == user
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def is_group_owner_or_moderator?
      is_group_owner? || group.moderators.include?(user)
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def is_member_or_group_owner?
      is_member? || is_group_owner?
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def group
      record.topic.group
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def is_member?
      group.members.include? user
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Missing top-level class documentation comment.
Open

class TopicCommentPolicy < ApplicationPolicy
Severity: Minor
Found in app/policies/topic_comment_policy.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

Rename is_member? to member?.
Open

    def is_member?
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Inconsistent indentation detected.
Open

    def is_group_owner?
      group.owner == user
    end
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Rename is_member_or_group_owner? to member_or_group_owner?.
Open

    def is_member_or_group_owner?
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Rename is_author? to author?.
Open

    def is_author?
Severity: Minor
Found in app/policies/topic_comment_policy.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

There are no issues that match your filters.

Category
Status