Sign upLogin

myfreecomm/billimatic-client-ruby

View on GitHub
Star
lib/billimatic/resources/invoice.rb

Summary

Maintainability
A
0 mins
Test Coverage

Billimatic::Resources::Invoice has no descriptive comment
Open

    class Invoice < InvoiceRule
Severity: Minor
Found in lib/billimatic/resources/invoice.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

Billimatic::Resources::Invoice takes parameters ['contract_id', 'id'] to 4 methods
Open

      def show(id, contract_id:)
        http.get(
          "/contracts/#{contract_id}#{resource_base_path}/#{id}"
        ) do |response|
          respond_with_entity response
Severity: Minor
Found in lib/billimatic/resources/invoice.rb by reek

In general, a Data Clump occurs when the same two or three items frequently appear together in classes and parameter lists, or when a group of instance variable names start or end with similar substrings.

The recurrence of the items often means there is duplicate code spread around to handle them. There may be an abstraction missing from the code, making the system harder to understand.

Example

Given

class Dummy
  def x(y1,y2); end
  def y(y1,y2); end
  def z(y1,y2); end
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [2, 3, 4]:Dummy takes parameters [y1, y2] to 3 methods (DataClump)

A possible way to fix this problem (quoting from Martin Fowler):

The first step is to replace data clumps with objects and use the objects whenever you see them. An immediate benefit is that you'll shrink some parameter lists. The interesting stuff happens as you begin to look for behavior to move into the new objects.

There are no issues that match your filters.

Category
Status