Sign upLogin

3scale/porta

View on GitHub
Star

Showing 5,267 of 5,597 total issues

BackendDeleteServiceTokenWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

  def perform(event_id)
Severity: Minor
Found in app/workers/backend_delete_service_token_worker.rb by reek

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

ProcessNotificationEventWorker::UserNotificationWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

    def perform(user_id, event_id, system_name)
Severity: Minor
Found in app/workers/process_notification_event_worker.rb by reek

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

UserSessionSweeperWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

  def perform(id)
Severity: Minor
Found in app/workers/user_session_sweeper_worker.rb by reek

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

NotificationMailer takes parameters ['event', 'receiver'] to 24 methods
Open

  def application_created(event, receiver)
    @application      = event.application
    @provider_account = event.provider
    @service          = event.service
    @account          = event.account
Severity: Minor
Found in app/mailers/notification_mailer.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.

ThreeScale::OAuth2::ClientBase has missing safe method 'authenticate!'
Open

      def authenticate!(code, request)
Severity: Minor
Found in app/lib/three_scale/oauth2/client_base.rb by reek

A candidate method for the Missing Safe Method smell are methods whose names end with an exclamation mark.

An exclamation mark in method names means (the explanation below is taken from here ):

The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name. So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.

Such a method is called Missing Safe Method if and only if her non-bang version does not exist and this method is reported as a smell.

Example

Given

class C
  def foo; end
  def foo!; end
  def bar!; end
end

Reek would report bar! as Missing Safe Method smell but not foo!.

Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:

class Parent
  def foo; end
end

module Dangerous
  def foo!; end
end

class Son < Parent
  include Dangerous
end

class Daughter < Parent
end

In this example, Reek would not report the Missing Safe Method smell for the method foo of the Dangerous module.

ThreeScale::Rake::RemoveDupUsageLimits#find_dups doesn't depend on instance state (maybe move it to another class?)
Open

      def find_dups(collection)
Severity: Minor
Found in app/lib/three_scale/rake/remove_dup_usage_limits.rb by reek

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

ThreeScale::Swagger::Specification::V10#validate! performs a nil-check
Open

          ops = apis.map{|e| e.nil? ? nil : e["operations"]}.flatten.compact
Severity: Minor
Found in app/lib/three_scale/swagger/specification.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)

EventImportWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

  def perform(attributes)
Severity: Minor
Found in app/workers/event_import_worker.rb by reek

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

ThreeScale::OAuth2::Auth0Client#authenticate_options doesn't depend on instance state (maybe move it to another class?)
Open

      def authenticate_options(request)
Severity: Minor
Found in app/lib/three_scale/oauth2/auth0_client.rb by reek

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

ThreeScale::Rake::RemoveDupUsageLimits has missing safe method 'run!'
Open

      def run!
Severity: Minor
Found in app/lib/three_scale/rake/remove_dup_usage_limits.rb by reek

A candidate method for the Missing Safe Method smell are methods whose names end with an exclamation mark.

An exclamation mark in method names means (the explanation below is taken from here ):

The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name. So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.

Such a method is called Missing Safe Method if and only if her non-bang version does not exist and this method is reported as a smell.

Example

Given

class C
  def foo; end
  def foo!; end
  def bar!; end
end

Reek would report bar! as Missing Safe Method smell but not foo!.

Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:

class Parent
  def foo; end
end

module Dangerous
  def foo!; end
end

class Son < Parent
  include Dangerous
end

class Daughter < Parent
end

In this example, Reek would not report the Missing Safe Method smell for the method foo of the Dangerous module.

ThreeScale::Swagger::Specification::V12 has missing safe method 'validate!'
Open

        def validate!
Severity: Minor
Found in app/lib/three_scale/swagger/specification.rb by reek

A candidate method for the Missing Safe Method smell are methods whose names end with an exclamation mark.

An exclamation mark in method names means (the explanation below is taken from here ):

The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name. So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.

Such a method is called Missing Safe Method if and only if her non-bang version does not exist and this method is reported as a smell.

Example

Given

class C
  def foo; end
  def foo!; end
  def bar!; end
end

Reek would report bar! as Missing Safe Method smell but not foo!.

Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:

class Parent
  def foo; end
end

module Dangerous
  def foo!; end
end

class Son < Parent
  include Dangerous
end

class Daughter < Parent
end

In this example, Reek would not report the Missing Safe Method smell for the method foo of the Dangerous module.

CreateServiceTokenWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

  def perform(event_id)
Severity: Minor
Found in app/workers/create_service_token_worker.rb by reek

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

SignupWorker::SampleDataWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

    def perform(provider_id)
Severity: Minor
Found in app/workers/signup_worker.rb by reek

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

ThreeScale::OAuth2::KeycloakClient#authenticate_options doesn't depend on instance state (maybe move it to another class?)
Open

      def authenticate_options(request)
Severity: Minor
Found in app/lib/three_scale/oauth2/keycloak_client.rb by reek

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

NotificationMailer#hidden_om is a writable attribute
Open

    attr_accessor :event_class, :hidden, :abilities, :hidden_om
Severity: Minor
Found in app/mailers/notification_mailer.rb by reek

A class that publishes a setter for an instance variable invites client classes to become too intimate with its inner workings, and in particular with its representation of state.

The same holds to a lesser extent for getters, but Reek doesn't flag those.

Example

Given:

class Klass
  attr_accessor :dummy
end

Reek would emit the following warning:

reek test.rb

test.rb -- 1 warning:
  [2]:Klass declares the writable attribute dummy (Attribute)

CreateSettingsObjectForAccounts#self.up performs a nil-check
Open

      Settings.create(:account_id => a.id) unless !a.settings.nil?
Severity: Minor
Found in db/migrate/20090206174052_create_settings_object_for_accounts.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)

FindAndDeleteScheduledAccountsWorker#perform doesn't depend on instance state (maybe move it to another class?)
Open

  def perform
Severity: Minor
Found in app/workers/find_and_delete_scheduled_accounts_worker.rb by reek

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

PatternflyInputInput#action performs a nil-check
Open

    return nil if action_html_options.nil?
Severity: Minor
Found in app/inputs/patternfly_input_input.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)

ThreeScale::SSO::Encryptor has missing safe method 'extract!'
Open

      def extract! token
Severity: Minor
Found in app/lib/three_scale/sso.rb by reek

A candidate method for the Missing Safe Method smell are methods whose names end with an exclamation mark.

An exclamation mark in method names means (the explanation below is taken from here ):

The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name. So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.

Such a method is called Missing Safe Method if and only if her non-bang version does not exist and this method is reported as a smell.

Example

Given

class C
  def foo; end
  def foo!; end
  def bar!; end
end

Reek would report bar! as Missing Safe Method smell but not foo!.

Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:

class Parent
  def foo; end
end

module Dangerous
  def foo!; end
end

class Son < Parent
  include Dangerous
end

class Daughter < Parent
end

In this example, Reek would not report the Missing Safe Method smell for the method foo of the Dangerous module.

ThreeScale::XML::Builder has missing safe method 'instruct!'
Open

      def instruct!
Severity: Minor
Found in app/lib/three_scale/xml/builder.rb by reek

A candidate method for the Missing Safe Method smell are methods whose names end with an exclamation mark.

An exclamation mark in method names means (the explanation below is taken from here ):

The ! in method names that end with ! means, “This method is dangerous”—or, more precisely, this method is the “dangerous” version of an otherwise equivalent method, with the same name minus the !. “Danger” is relative; the ! doesn’t mean anything at all unless the method name it’s in corresponds to a similar but bang-less method name. So, for example, gsub! is the dangerous version of gsub. exit! is the dangerous version of exit. flatten! is the dangerous version of flatten. And so forth.

Such a method is called Missing Safe Method if and only if her non-bang version does not exist and this method is reported as a smell.

Example

Given

class C
  def foo; end
  def foo!; end
  def bar!; end
end

Reek would report bar! as Missing Safe Method smell but not foo!.

Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:

class Parent
  def foo; end
end

module Dangerous
  def foo!; end
end

class Son < Parent
  include Dangerous
end

class Daughter < Parent
end

In this example, Reek would not report the Missing Safe Method smell for the method foo of the Dangerous module.

Severity
Category
Status
Source
Language