Sign upLogin

skcc321/dumpman

View on GitHub
Star
lib/dumpman/fetcher.rb

Summary

Maintainability
A
0 mins
Test Coverage
F
37%

Dumpman::Fetcher has no descriptive comment
Open

  class Fetcher < OpenStruct
Severity: Minor
Found in lib/dumpman/fetcher.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

Redundant self detected.
Open

      instance = self.new(attrs: connection.attrs)
Severity: Minor
Found in lib/dumpman/fetcher.rb by rubocop

This cop checks for redundant uses of self.

The usage of self is only needed when:

  • Sending a message to same object with zero arguments in presence of a method name clash with an argument or a local variable.

  • Calling an attribute writer to prevent an local variable assignment.

Note, with using explicit self you can only send messages with public or protected scope, you cannot send private messages this way.

Note we allow uses of self with operators because it would be awkward otherwise.

Example:

# bad
def foo(bar)
  self.baz
end

# good
def foo(bar)
  self.bar  # Resolves name clash with the argument.
end

def foo
  bar = 1
  self.bar  # Resolves name clash with the local variable.
end

def foo
  %w[x y z].select do |bar|
    self.bar == bar  # Resolves name clash with argument of the block.
  end
end

Inconsistent indentation detected.
Open

      def fetcher_class
        case attrs[:fetch_strategy]
        when :docker then Dumpman::Fetchers::Docker
        when :direct then Dumpman::Fetchers::Direct
        else
Severity: Minor
Found in lib/dumpman/fetcher.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 Fetcher < OpenStruct
Severity: Minor
Found in lib/dumpman/fetcher.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

Shadowing outer local variable - connection.
Open

      connection = Dumpman.connections.find do |connection|
Severity: Minor
Found in lib/dumpman/fetcher.rb by rubocop

This cop looks for use of the same name as outer local variables for block arguments or block local variables. This is a mimic of the warning "shadowing outer local variable - foo" from ruby -cw.

Example:

# bad

def some_method
  foo = 1

  2.times do |foo| # shadowing outer `foo`
    do_something(foo)
  end
end

Example:

# good

def some_method
  foo = 1

  2.times do |bar|
    do_something(bar)
  end
end

There are no issues that match your filters.

Category
Status