Sign upLogin

3scale/porta

View on GitHub
Star
lib/developer_portal/lib/liquid/drops/urls.rb

Summary

Maintainability
B
4 hrs
Test Coverage

Class Urls has 33 methods (exceeds 20 allowed). Consider refactoring.
Open

    class Urls < Drops::Base
      allowed_name :urls

      attr_reader :provider
      protected :provider
Severity: Minor
Found in lib/developer_portal/lib/liquid/drops/urls.rb - About 4 hrs to fix

    Liquid::Drops::Urls has at least 33 methods
    Open

        class Urls < Drops::Base
    Severity: Minor
    Found in lib/developer_portal/lib/liquid/drops/urls.rb by reek

    Too Many Methods is a special case of LargeClass.

    Example

    Given this configuration

    TooManyMethods:
  max_methods: 3

    and this code:

    class TooManyMethods
  def one; end
  def two; end
  def three; end
  def four; end
end

    Reek would emit the following warning:

    test.rb -- 1 warning:
  [1]:TooManyMethods has at least 4 methods (TooManyMethods)

    Liquid::Drops::Urls assumes too much for instance variable '@strategy'
    Open

        class Urls < Drops::Base
    Severity: Minor
    Found in lib/developer_portal/lib/liquid/drops/urls.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.

    There are no issues that match your filters.

    Category
    Status