payout/announcer

View on GitHub
lib/announcer/publishers/proc_publisher.rb

Summary

Maintainability
A
0 mins
Test Coverage

Line is too long. [87/80]
Open

        raise Errors::InvalidArityError, 'Proc arity must be 1' unless block.arity == 1

Surrounding space missing in default value assignment.
Open

      def new(instance=nil)

Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.

Example:

# bad
def some_method(arg1=:default, arg2=nil, arg3=[])
  # do something...
end

# good
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
  # do something...
end

Missing top-level class documentation comment.
Open

    class ProcPublisher < Publisher

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

Surrounding space missing in default value assignment.
Open

      def initialize(instance=nil, &block)

Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.

Example:

# bad
def some_method(arg1=:default, arg2=nil, arg3=[])
  # do something...
end

# good
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
  # do something...
end

There are no issues that match your filters.

Category
Status