Sign upLogin

VAGAScom/basquiat

View on GitHub
Star

Showing 73 of 73 total issues

Basquiat::Adapters::RabbitMq::AutoAcknowledge has no descriptive comment
Open

      class AutoAcknowledge < BaseStrategy
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/requeue_strategies/auto_acknowledge.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

Basquiat::Adapters::RabbitMq#publish calls 'options[:publisher]' 2 times
Open

        if options[:publisher][:session_pool]
          session_pool.with { |session| session.publish(event, message, props) }
        else
          session.publish(event, message, props)
        end
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq_adapter.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Basquiat::Base#reload_adapter_from_configuration calls 'Basquiat.configuration' 2 times
Open

      self.adapter = Kernel.const_get(Basquiat.configuration.default_adapter)
      adapter_options Basquiat.configuration.adapter_options
Severity: Minor
Found in lib/basquiat/interfaces/base.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Basquiat::Railtie has no descriptive comment
Open

  class Railtie < ::Rails::Railtie
Severity: Minor
Found in lib/basquiat/rails/railtie.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

Basquiat::Adapters::RabbitMq::DelayedDelivery#extract_event_info calls 'matched.captures' 2 times
Open

          matched && [matched.captures[1], matched.captures[0].to_i] || [key, 500]
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/requeue_strategies/delayed_delivery.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Basquiat::Adapters::RabbitMq::Configuration#initialize calls 'Basquiat.configuration' 2 times
Open

                         name: Basquiat.configuration.queue_name,
                         durable: true,
                         options: {}
                       },
                       exchange: {
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/configuration.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Basquiat::Adapters::RabbitMq::DeadLettering has no descriptive comment
Open

      class DeadLettering < BaseStrategy
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/requeue_strategies/dead_lettering.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

Basquiat::Adapters::RabbitMq#session_pool calls 'options[:publisher]' 2 times
Open

        @session_pool ||= ConnectionPool.new(size: options[:publisher][:session_pool].fetch(:size, 1),
                                             timeout: options[:publisher][:session_pool].fetch(:timeout, 5)) do
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq_adapter.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Basquiat::Errors::SubclassResponsibility has no descriptive comment
Open

    class SubclassResponsibility < NoMethodError
Severity: Minor
Found in lib/basquiat/errors/subclass_responsibility.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

Basquiat::Adapters::Test assumes too much for instance variable '@event_names'
Open

    class Test < Basquiat::Adapters::Base
Severity: Minor
Found in lib/basquiat/adapters/test_adapter.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.

Basquiat::HashRefinements has no descriptive comment
Open

  module HashRefinements
Severity: Minor
Found in lib/basquiat/support/hash_refinements.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

Basquiat::Configuration#exchange_name is a writable attribute
Open

    attr_writer :queue_name, :exchange_name, :logger, :environment
Severity: Minor
Found in lib/basquiat/support/configuration.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)

Basquiat::Adapters::RabbitMq::Message#routing_key is a writable attribute
Open

        attr_writer :routing_key
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/message.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)

Basquiat::Configuration#connection is a writable attribute
Open

    attr_accessor :connection, :rescue_proc
Severity: Minor
Found in lib/basquiat/support/configuration.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)

Basquiat::Configuration#logger is a writable attribute
Open

    attr_writer :queue_name, :exchange_name, :logger, :environment
Severity: Minor
Found in lib/basquiat/support/configuration.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)

Basquiat::Adapters::RabbitMq::Connection#set_failover_opt performs a nil-check
Open

          return default_value if @failover.nil?
Severity: Minor
Found in lib/basquiat/adapters/rabbitmq/connection.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)

Basquiat::Configuration#reload_classes doesn't depend on instance state (maybe move it to another class?)
Open

    def reload_classes
Severity: Minor
Found in lib/basquiat/support/configuration.rb by reek

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

Basquiat::Configuration#environment is a writable attribute
Open

    attr_writer :queue_name, :exchange_name, :logger, :environment
Severity: Minor
Found in lib/basquiat/support/configuration.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)

Basquiat::Configuration#queue_name is a writable attribute
Open

    attr_writer :queue_name, :exchange_name, :logger, :environment
Severity: Minor
Found in lib/basquiat/support/configuration.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)

Basquiat::Configuration#rescue_proc is a writable attribute
Open

    attr_accessor :connection, :rescue_proc
Severity: Minor
Found in lib/basquiat/support/configuration.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)
Severity
Category
Status
Source
Language