Sign upLogin

uptech/togls

View on GitHub
Star
lib/togls/rule_type_registry.rb

Summary

Maintainability
A
0 mins
Test Coverage

Missing magic comment # frozen_string_literal: true.
Open

module Togls
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

This cop is designed to help upgrade to Ruby 3.0. It will add the comment # frozen_string_literal: true to the top of files to enable frozen string literals. Frozen string literals may be default in Ruby 3.0. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

Example: EnforcedStyle: when_needed (default)

# The `when_needed` style will add the frozen string literal comment
# to files only when the `TargetRubyVersion` is set to 2.3+.
# bad
module Foo
  # ...
end

# good
# frozen_string_literal: true

module Foo
  # ...
end

Example: EnforcedStyle: always

# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
  # ...
end

# good
# frozen_string_literal: true

module Bar
  # ...
end

Example: EnforcedStyle: never

# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true

module Baz
  # ...
end

# good
module Baz
  # ...
end

Line is too long. [104/80]
Open

        raise RuleTypeAlreadyDefined, "Rule Type identified by '#{type_id}' has already been registered"
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

Line is too long. [99/80]
Open

        raise RuleTypeAlreadyDefined, "Rule Type with class '#{klass}' has already been registered"
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

Use a guard clause instead of wrapping the code inside a conditional expression.
Open

      if @rule_type_repository.include_klass?(klass)
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

Use a guard clause instead of wrapping the code inside a conditional expression

Example:

# bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

Use a guard clause instead of wrapping the code inside a conditional expression.
Open

      if @rule_type_repository.include?(type_id)
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

Use a guard clause instead of wrapping the code inside a conditional expression

Example:

# bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

Missing top-level class documentation comment.
Open

  class RuleTypeRegistry
Severity: Minor
Found in lib/togls/rule_type_registry.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

There are no issues that match your filters.

Category
Status