Sign upLogin

myfreecomm/billimatic-client-ruby

View on GitHub
Star
lib/billimatic/url_helpers.rb

Summary

Maintainability
A
0 mins
Test Coverage

Billimatic::UrlHelpers has no descriptive comment
Open

  class UrlHelpers
Severity: Minor
Found in lib/billimatic/url_helpers.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::UrlHelpers#checkout_url doesn't depend on instance state (maybe move it to another class?)
Open

    def checkout_url(token:)
Severity: Minor
Found in lib/billimatic/url_helpers.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

Billimatic::UrlHelpers#subscription_dashboard_url doesn't depend on instance state (maybe move it to another class?)
Open

    def subscription_dashboard_url(token:)
Severity: Minor
Found in lib/billimatic/url_helpers.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

Billimatic::UrlHelpers#change_plan_url doesn't depend on instance state (maybe move it to another class?)
Open

    def change_plan_url(token:, plan_id:)
Severity: Minor
Found in lib/billimatic/url_helpers.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

There are no issues that match your filters.

Category
Status