Sign upLogin

leonardofalk/audited_async

View on GitHub
Star
lib/audited_async.rb

Summary

Maintainability
A
0 mins
Test Coverage

Audited::Auditor::AuditedInstanceMethods#perform_async_audit is controlled by argument 'changes'
Open

                               audited_changes: (changes || audited_attributes).to_json,
Severity: Minor
Found in lib/audited_async.rb by reek

Control Parameter is a special case of Control Couple

Example

A simple example would be the "quoted" parameter in the following method:

def write(quoted)
  if quoted
    write_quoted @value
  else
    write_unquoted @value
  end
end

Fixing those problems is out of the scope of this document but an easy solution could be to remove the "write" method alltogether and to move the calls to "writequoted" / "writeunquoted" in the initial caller of "write".

Audited::Auditor::AuditedInstanceMethods#perform_async_audit calls 'AuditedAsync.config' 2 times
Open

    AuditedAsync.config
                .job
                .set(AuditedAsync.config.job_options)
Severity: Minor
Found in lib/audited_async.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.

AuditedAsync has no descriptive comment
Open

module AuditedAsync
Severity: Minor
Found in lib/audited_async.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

Audited::Auditor::ClassMethods has no descriptive comment
Open

module Audited::Auditor::ClassMethods
Severity: Minor
Found in lib/audited_async.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

Audited::Auditor::AuditedInstanceMethods#perform_async_audit calls 'self.class' 2 times
Open

                .perform_later class_name: self.class.name,
                               record_id: send(self.class.primary_key.to_sym),
Severity: Minor
Found in lib/audited_async.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.

Audited::Auditor::AuditedInstanceMethods#audited_async_enabled? calls 'self.class' 2 times
Open

    self.class.auditing_enabled && self.class.audited_async_enabled?
Severity: Minor
Found in lib/audited_async.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.

Audited::Auditor::AuditedInstanceMethods has no descriptive comment
Open

module Audited::Auditor::AuditedInstanceMethods
Severity: Minor
Found in lib/audited_async.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

There are no issues that match your filters.

Category
Status