Sign upLogin

3scale/porta

View on GitHub
Star
app/presenters/buyers/accounts_index_presenter.rb

Summary

Maintainability
A
1 hr
Test Coverage

Method toolbar_props has 32 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  def toolbar_props # rubocop:disable Metrics/MethodLength
    props = {
      totalEntries: total_entries,
      actions: [],
      overflow: [],
Severity: Minor
Found in app/presenters/buyers/accounts_index_presenter.rb - About 1 hr to fix

    Buyers::AccountsIndexPresenter has at least 5 instance variables
    Open

    class Buyers::AccountsIndexPresenter
    Severity: Minor
    Found in app/presenters/buyers/accounts_index_presenter.rb by reek

    Too Many Instance Variables is a special case of LargeClass.

    Example

    Given this configuration

    TooManyInstanceVariables:
  max_instance_variables: 3

    and this code:

    class TooManyInstanceVariables
  def initialize
    @arg_1 = :dummy
    @arg_2 = :dummy
    @arg_3 = :dummy
    @arg_4 = :dummy
  end
end

    Reek would emit the following warning:

    test.rb -- 5 warnings:
  [1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)

    Buyers::AccountsIndexPresenter assumes too much for instance variable '@buyers'
    Open

    class Buyers::AccountsIndexPresenter
    Severity: Minor
    Found in app/presenters/buyers/accounts_index_presenter.rb by reek

    Classes should not assume that instance variables are set or present outside of the current class definition.

    Good:

    class Foo
  def initialize
    @bar = :foo
  end

  def foo?
    @bar == :foo
  end
end

    Good as well:

    class Foo
  def foo?
    bar == :foo
  end

  def bar
    @bar ||= :foo
  end
end

    Bad:

    class Foo
  def go_foo!
    @bar = :foo
  end

  def foo?
    @bar == :foo
  end
end

    Example

    Running Reek on:

    class Dummy
  def test
    @ivar
  end
end

    would report:

    [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar

    Note that this example would trigger this smell warning as well:

    class Parent
  def initialize(omg)
    @omg = omg
  end
end

class Child < Parent
  def foo
    @omg
  end
end

    The way to address the smell warning is that you should create an attr_reader to use @omg in the subclass and not access @omg directly like this:

    class Parent
  attr_reader :omg

  def initialize(omg)
    @omg = omg
  end
end

class Child < Parent
  def foo
    omg
  end
end

    Directly accessing instance variables is considered a smell because it breaks encapsulation and makes it harder to reason about code.

    If you don't want to expose those methods as public API just make them private like this:

    class Parent
  def initialize(omg)
    @omg = omg
  end

  private
  attr_reader :omg
end

class Child < Parent
  def foo
    omg
  end
end

    Current Support in Reek

    An instance variable must:

    • be set in the constructor
    • or be accessed through a method with lazy initialization / memoization.

    If not, Instance Variable Assumption will be reported.

    Buyers::AccountsIndexPresenter assumes too much for instance variable '@raw_buyers'
    Open

    class Buyers::AccountsIndexPresenter
    Severity: Minor
    Found in app/presenters/buyers/accounts_index_presenter.rb by reek

    Classes should not assume that instance variables are set or present outside of the current class definition.

    Good:

    class Foo
  def initialize
    @bar = :foo
  end

  def foo?
    @bar == :foo
  end
end

    Good as well:

    class Foo
  def foo?
    bar == :foo
  end

  def bar
    @bar ||= :foo
  end
end

    Bad:

    class Foo
  def go_foo!
    @bar = :foo
  end

  def foo?
    @bar == :foo
  end
end

    Example

    Running Reek on:

    class Dummy
  def test
    @ivar
  end
end

    would report:

    [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar

    Note that this example would trigger this smell warning as well:

    class Parent
  def initialize(omg)
    @omg = omg
  end
end

class Child < Parent
  def foo
    @omg
  end
end

    The way to address the smell warning is that you should create an attr_reader to use @omg in the subclass and not access @omg directly like this:

    class Parent
  attr_reader :omg

  def initialize(omg)
    @omg = omg
  end
end

class Child < Parent
  def foo
    omg
  end
end

    Directly accessing instance variables is considered a smell because it breaks encapsulation and makes it harder to reason about code.

    If you don't want to expose those methods as public API just make them private like this:

    class Parent
  def initialize(omg)
    @omg = omg
  end

  private
  attr_reader :omg
end

class Child < Parent
  def foo
    omg
  end
end

    Current Support in Reek

    An instance variable must:

    • be set in the constructor
    • or be accessed through a method with lazy initialization / memoization.

    If not, Instance Variable Assumption will be reported.

    Buyers::AccountsIndexPresenter#render_json has the variable name 'a'
    Wontfix

          items: buyers.map { |a| BuyerPresenter.new(a).new_application_data.as_json }.to_json,
    Severity: Minor
    Found in app/presenters/buyers/accounts_index_presenter.rb by reek

    An Uncommunicative Variable Name is a variable name that doesn't communicate its intent well enough.

    Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

    There are no issues that match your filters.

    Category
    Status