Sign upLogin

3scale/porta

View on GitHub
Star

Showing 5,267 of 5,597 total issues

Pdf::Report#pdf is a writable attribute
Open

    attr_accessor :account, :period, :pdf, :service, :report
Severity: Minor
Found in app/lib/pdf/report.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)

Pdf::Report#traffic_graph_first_data_point doesn't depend on instance state (maybe move it to another class?)
Open

    def traffic_graph_first_data_point(xml)
Severity: Minor
Found in app/lib/pdf/report.rb by reek

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

ThreeScale::Address#errors is a writable attribute
Open

  attr_accessor :errors
Severity: Minor
Found in app/lib/three_scale/address.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)

ThreeScale::Analytics::UserClassifier#is_guest? performs a nil-check
Open

        @user.username.nil? || @user.email.nil?
Severity: Minor
Found in app/lib/three_scale/analytics/user_classifier.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::Analytics::UserTracking#flush doesn't depend on instance state (maybe move it to another class?)
Open

      def flush
Severity: Minor
Found in app/lib/three_scale/analytics/user_tracking.rb by reek

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

Pdf::Finance::InvoiceReportData#total_invoice_label performs a nil-check
Open

    if @invoice.vat_rate.nil?
Severity: Minor
Found in app/lib/pdf/finance/invoice_report_data.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)

Pdf::Report#service is a writable attribute
Open

    attr_accessor :account, :period, :pdf, :service, :report
Severity: Minor
Found in app/lib/pdf/report.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)

Pdf::Report#traffic_graph_style_background doesn't depend on instance state (maybe move it to another class?)
Open

    def traffic_graph_style_background(css)
Severity: Minor
Found in app/lib/pdf/report.rb by reek

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

SimpleLayout has missing safe method 'import_images!'
Open

  def import_images!
Severity: Minor
Found in app/lib/simple_layout.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.

Stats::KeyHelpers#encode_key doesn't depend on instance state (maybe move it to another class?)
Open

    def encode_key(key)
Severity: Minor
Found in app/lib/stats/key_helpers.rb by reek

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

Switches::SwitchDenied has missing safe method 'show!'
Open

    def show!
Severity: Minor
Found in app/lib/switches.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.

Stats::Base#extract_metric performs a nil-check
Open

      if metric.nil?
Severity: Minor
Found in app/lib/stats/base.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)

Stats::Views::UsageHack::StorageCache#cache is a writable attribute
Open

    attr_accessor :cache
Severity: Minor
Found in app/lib/stats/views/usage_hack.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)

Stats::Views::Csv::Metrics#collection performs a nil-check
Open

          unless @data[:metrics].nil?
Severity: Minor
Found in app/lib/stats/views/csv/metrics.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)

Pdf::Report#traffic_graph_style_guide_lines doesn't depend on instance state (maybe move it to another class?)
Open

    def traffic_graph_style_guide_lines(css)
Severity: Minor
Found in app/lib/pdf/report.rb by reek

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

SimpleLayout has missing safe method 'create_builtin_pages_and_partials!'
Open

  def create_builtin_pages_and_partials!
Severity: Minor
Found in app/lib/simple_layout.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.

DeprecationWarning#deprecation_horizon is a writable attribute
Open

  attr_accessor :message, :gem_name, :deprecation_horizon
Severity: Minor
Found in app/lib/system/error_reporting.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)

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

    def logger
Severity: Minor
Found in app/lib/three_scale/benchmark.rb by reek

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

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

    def user_tracking(user, **options)
Severity: Minor
Found in app/lib/three_scale/analytics.rb by reek

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

ThreeScale::Swagger::Specification::V20 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.

Severity
Category
Status
Source
Language