beanieboi/ffprober

View on GitHub
lib/ffprober/ffmpeg/exec.rb

Summary

Maintainability
A
0 mins
Test Coverage

Ffprober::Ffmpeg::Exec has no descriptive comment
Open

    class Exec
Severity: Minor
Found in lib/ffprober/ffmpeg/exec.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

Ffprober::Ffmpeg::Exec#ffprobe_version_output calls '@finder.path' 2 times
Open

        @ffprobe_version_output ||= if @finder.path.nil?
                                      ''
                                    else
                                      `#{@finder.path} -version`
Severity: Minor
Found in lib/ffprober/ffmpeg/exec.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Ffprober::Ffmpeg::Exec#ffprobe_version_output performs a nil-check
Open

        @ffprobe_version_output ||= if @finder.path.nil?
Severity: Minor
Found in lib/ffprober/ffmpeg/exec.rb by reek

A NilCheck is a type check. Failures of NilCheck violate the "tell, don't ask" principle.

Additionally, type checks often mask bigger problems in your source code like not using OOP and / or polymorphism when you should.

Example

Given

class Klass
  def nil_checker(argument)
    if argument.nil?
      puts "argument isn't nil!"
    end
  end
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [3]:Klass#nil_checker performs a nil-check. (NilCheck)

There are no issues that match your filters.

Category
Status