dry-rb/dry-initializer

View on GitHub
lib/dry/initializer/config.rb

Summary

Maintainability
A
1 hr
Test Coverage
B
89%

Method add_definition has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def add_definition(option, name, type, block, **opts)
Severity: Minor
Found in lib/dry/initializer/config.rb - About 35 mins to fix

    Method public_attributes has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def public_attributes(instance)
          definitions.values.each_with_object({}) do |item, obj|
            key = item.target
            next unless instance.respond_to? key
            val = instance.send(key)
    Severity: Minor
    Found in lib/dry/initializer/config.rb - About 35 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Use nested module/class definitions instead of compact style.
    Open

    module Dry::Initializer
    Severity: Minor
    Found in lib/dry/initializer/config.rb by rubocop

    This cop checks the style of children definitions at classes and modules. Basically there are two different styles:

    Example: EnforcedStyle: nested (default)

    # good
    # have each child on its own line
    class Foo
      class Bar
      end
    end

    Example: EnforcedStyle: compact

    # good
    # combine definitions as much as possible
    class Foo::Bar
    end

    The compact style is only forced for classes/modules with one child.

    Missing magic comment # frozen_string_literal: true.
    Open

    module Dry::Initializer
    Severity: Minor
    Found in lib/dry/initializer/config.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 `<

    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

    Do not use prefix _ for a variable that is used.
    Open

            __dry_initializer__ = self
    Severity: Minor
    Found in lib/dry/initializer/config.rb by rubocop

    This cop checks for underscore-prefixed variables that are actually used.

    Example:

    # bad
    
    [1, 2, 3].each do |_num|
      do_something(_num)
    end

    Example:

    # good
    
    [1, 2, 3].each do |num|
      do_something(num)
    end

    Example:

    # good
    
    [1, 2, 3].each do |_num|
      do_something # not using `_num`
    end

    Prefer single-quoted strings when you don't need string interpolation or special symbols.
    Open

          line  =  line.gsub("__dry_initializer_options__", "options")
    Severity: Minor
    Found in lib/dry/initializer/config.rb by rubocop

    Checks if uses of quotes match the configured preference.

    Example: EnforcedStyle: single_quotes (default)

    # bad
    "No special symbols"
    "No string interpolation"
    "Just text"
    
    # good
    'No special symbols'
    'No string interpolation'
    'Just text'
    "Wait! What's #{this}!"

    Example: EnforcedStyle: double_quotes

    # bad
    'Just some text'
    'No special chars or interpolation'
    
    # good
    "Just some text"
    "No special chars or interpolation"
    "Every string in #{project} uses double_quotes"

    Prefer single-quoted strings when you don't need string interpolation or special symbols.
    Open

          line  =  line.gsub("__dry_initializer_options__", "options")
    Severity: Minor
    Found in lib/dry/initializer/config.rb by rubocop

    Checks if uses of quotes match the configured preference.

    Example: EnforcedStyle: single_quotes (default)

    # bad
    "No special symbols"
    "No string interpolation"
    "Just text"
    
    # good
    'No special symbols'
    'No string interpolation'
    'Just text'
    "Wait! What's #{this}!"

    Example: EnforcedStyle: double_quotes

    # bad
    'Just some text'
    'No special chars or interpolation'
    
    # good
    "Just some text"
    "No special chars or interpolation"
    "Every string in #{project} uses double_quotes"

    There are no issues that match your filters.

    Category
    Status