Sign upLogin

pboling/celluloid-io-pg-listener

View on GitHub
Star
lib/celluloid-io-pg-listener/initialization/async_listener.rb

Summary

Maintainability
A
1 hr
Test Coverage

Assignment Branch Condition size for initialize is too high. [21.47/15]
Open

      def initialize(*args)
        hash_arg = args.last.is_a?(Hash) ? args.pop : {}
        warn "[#{self.class}] You have not specified a callback_method, so :unlisten_wrapper will be used." unless hash_arg[:callback_method]
        @callback_method = hash_arg[:callback_method] = hash_arg[:callback_method] || :unlisten_wrapper
        # Doesn't appear to be any other way to make it work with subclassing,
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [14/10]
Open

      def enhance_callback_method
        # The class including CelluloidIOPGListener::Client must define
        #   the method named by @callback_method
        define_singleton_method(@callback_method) do |channel, payload|
          unlisten_wrapper(channel, payload) do
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for initialize is too high. [7/6]
Open

      def initialize(*args)
        hash_arg = args.last.is_a?(Hash) ? args.pop : {}
        warn "[#{self.class}] You have not specified a callback_method, so :unlisten_wrapper will be used." unless hash_arg[:callback_method]
        @callback_method = hash_arg[:callback_method] = hash_arg[:callback_method] || :unlisten_wrapper
        # Doesn't appear to be any other way to make it work with subclassing,
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method initialize has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

      def initialize(*args)
        hash_arg = args.last.is_a?(Hash) ? args.pop : {}
        warn "[#{self.class}] You have not specified a callback_method, so :unlisten_wrapper will be used." unless hash_arg[:callback_method]
        @callback_method = hash_arg[:callback_method] = hash_arg[:callback_method] || :unlisten_wrapper
        # Doesn't appear to be any other way to make it work with subclassing,
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb - About 55 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 enhance_callback_method has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

      def enhance_callback_method
        # The class including CelluloidIOPGListener::Client must define
        #   the method named by @callback_method
        define_singleton_method(@callback_method) do |channel, payload|
          unlisten_wrapper(channel, payload) do
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb - About 55 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

Line is too long. [90/80]
Open

        #   due to the way Celluloid Proxies the class, and hijacks the inheritance chains
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [181/80]
Open

                raise CelluloidIOPGListener::Client::InvalidClient, "Please specify a callback_method with signature (channel, payload) to be called on an instance of #{self.class}"
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Extra empty line detected at module body end.
Open


    end
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

This cops checks if empty lines around the bodies of modules match the configuration.

Example: EnforcedStyle: empty_lines

# good

module Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

module Foo
  module Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
module Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

module Foo
  def bar
    # ...
  end
end

Line is too long. [141/80]
Open

        warn "[#{self.class}] You have not specified a callback_method, so :unlisten_wrapper will be used." unless hash_arg[:callback_method]
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [162/80]
Open

                raise CelluloidIOPGListener::Client::InvalidClient, "#{self.class} does not define a method :#{callback_method} with signature (channel, payload)"
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [112/80]
Open

      #                     Default: :unlisten_wrapper (just to have a guaranteed method with the correct arity)
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [103/80]
Open

        @callback_method = hash_arg[:callback_method] = hash_arg[:callback_method] || :unlisten_wrapper
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [113/80]
Open

        # However, due to the nature of the initialize method we can't tell if we have a legitimate super or not.
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Line is too long. [104/80]
Open

        debug "Listening for notifications on #{dbname}:#{channel} with callback to #{@callback_method}"
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Extra empty line detected at module body beginning.
Open


      # 2nd initialize override invoked
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

This cops checks if empty lines around the bodies of modules match the configuration.

Example: EnforcedStyle: empty_lines

# good

module Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

module Foo
  module Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
module Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

module Foo
  def bar
    # ...
  end
end

Line is too long. [88/80]
Open

      # @callback_method  - Name of the method to be called when notifications are heard
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Missing top-level module documentation comment.
Open

    module AsyncListener
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.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 a guard clause instead of wrapping the code inside a conditional expression.
Open

              if callback_method == :unlisten_wrapper
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.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. [96/80]
Open

        subclassed_client = hash_arg[:subclassed_client] = hash_arg[:subclassed_client] || false
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Favor unless over if for negative conditions.
Open

        super(*args) if !subclassed_client
Severity: Minor
Found in lib/celluloid-io-pg-listener/initialization/async_listener.rb by rubocop

Checks for uses of if with a negated condition. Only ifs without else are considered. There are three different styles:

- both
- prefix
- postfix

Example: EnforcedStyle: both (default)

# enforces `unless` for `prefix` and `postfix` conditionals

# bad

if !foo
  bar
end

# good

unless foo
  bar
end

# bad

bar if !foo

# good

bar unless foo

Example: EnforcedStyle: prefix

# enforces `unless` for just `prefix` conditionals

# bad

if !foo
  bar
end

# good

unless foo
  bar
end

# good

bar if !foo

Example: EnforcedStyle: postfix

# enforces `unless` for just `postfix` conditionals

# bad

bar if !foo

# good

bar unless foo

# good

if !foo
  bar
end

There are no issues that match your filters.

Category
Status