dry-rb/dry-system

View on GitHub

Showing 35 of 35 total issues

Class has too many lines. [239/150]
Open

    class Container
      extend Dry::Configurable
      extend Dry::Container::Mixin
      extend Dry::System::Plugins

Severity: Minor
Found in lib/dry/system/container.rb by rubocop

This cop checks if the length a class exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Class Container has 35 methods (exceeds 20 allowed). Consider refactoring.
Open

    class Container
      extend Dry::Configurable
      extend Dry::Container::Mixin
      extend Dry::System::Plugins

Severity: Minor
Found in lib/dry/system/container.rb - About 4 hrs to fix

    Class Bootable has 23 methods (exceeds 20 allowed). Consider refactoring.
    Open

          class Bootable
            DEFAULT_FINALIZE = proc {}
    
            # @!attribute [r] identifier
            #   @return [Symbol] component's unique identifier
    Severity: Minor
    Found in lib/dry/system/components/bootable.rb - About 2 hrs to fix

      File container.rb has 261 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      require 'pathname'
      
      require 'dry-auto_inject'
      require 'dry-configurable'
      require 'dry-container'
      Severity: Minor
      Found in lib/dry/system/container.rb - About 2 hrs to fix

        Assignment Branch Condition size for load_local_component is too high. [22.8/20]
        Open

                def load_local_component(component, default_namespace_fallback = false, &block)
                  if booter.bootable?(component) || component.file_exists?(load_paths)
                    booter.boot_dependency(component) unless finalized?
        
                    require_component(component) do
        Severity: Minor
        Found in lib/dry/system/container.rb by rubocop

        This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

        Perceived complexity for load_component is too high. [8/7]
        Open

                def load_component(key, &block)
                  return self if registered?(key)
        
                  component(key).tap do |component|
                    if component.boot?
        Severity: Minor
        Found in lib/dry/system/container.rb by rubocop

        This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

        Example:

        def my_method                   # 1
          if cond                       # 1
            case var                    # 2 (0.8 + 4 * 0.2, rounded)
            when 1 then func_one
            when 2 then func_two
            when 3 then func_three
            when 4..10 then func_other
            end
          else                          # 1
            do_something until a && b   # 2
          end                           # ===
        end                             # 7 complexity points

        Perceived complexity for load_local_component is too high. [8/7]
        Open

                def load_local_component(component, default_namespace_fallback = false, &block)
                  if booter.bootable?(component) || component.file_exists?(load_paths)
                    booter.boot_dependency(component) unless finalized?
        
                    require_component(component) do
        Severity: Minor
        Found in lib/dry/system/container.rb by rubocop

        This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

        Example:

        def my_method                   # 1
          if cond                       # 1
            case var                    # 2 (0.8 + 4 * 0.2, rounded)
            when 1 then func_one
            when 2 then func_two
            when 3 then func_three
            when 4..10 then func_other
            end
          else                          # 1
            do_something until a && b   # 2
          end                           # ===
        end                             # 7 complexity points

        Method load_component has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

                def load_component(key, &block)
                  return self if registered?(key)
        
                  component(key).tap do |component|
                    if component.boot?
        Severity: Minor
        Found in lib/dry/system/container.rb - About 1 hr 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

        Method load_local_component has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

                def load_local_component(component, default_namespace_fallback = false, &block)
                  if booter.bootable?(component) || component.file_exists?(load_paths)
                    booter.boot_dependency(component) unless finalized?
        
                    require_component(component) do
        Severity: Minor
        Found in lib/dry/system/container.rb - About 1 hr 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

        Method call has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

              def self.call(file_name)
                {}.tap do |options|
                  File.foreach(file_name) do |line|
                    break unless line =~ VALID_LINE_RE
        
        
        Severity: Minor
        Found in lib/dry/system/magic_comments_parser.rb - About 45 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

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

                def self.init(root, env)
                  env_data = load_files(root, env)
                  attributes = {}
                  errors = {}
        
        
        Severity: Minor
        Found in lib/dry/system/settings.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

        Method with_component has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

              def with_component(id_or_component)
                component =
                  case id_or_component
                  when Symbol
                    require_boot_file(id_or_component) unless components.exists?(id_or_component)
        Severity: Minor
        Found in lib/dry/system/booter.rb - About 25 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

        Avoid multi-line chains of blocks.
        Open

                  }.each { |path|
        Severity: Minor
        Found in lib/dry/system/container.rb by rubocop

        This cop checks for chaining of a block after another block that spans multiple lines.

        Example:

        Thread.list.find_all do |t|
          t.alive?
        end.map do |t|
          t.object_id
        end

        Useless assignment to variable - logger.
        Open

                    config.logger = logger = config.logger_class.new(log_file_path)
        Severity: Minor
        Found in lib/dry/system/plugins/logging.rb by rubocop

        This cop checks for every useless assignment to local variable in every scope. The basic idea for this cop was from the warning of ruby -cw:

        assigned but unused variable - foo

        Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.

        Example:

        # bad
        
        def some_method
          some_var = 1
          do_something
        end

        Example:

        # good
        
        def some_method
          some_var = 1
          do_something(some_var)
        end

        Use match? instead of =~ when MatchData is not used.
        Open

                    break unless line =~ VALID_LINE_RE

        In Ruby 2.4, String#match?, Regexp#match? and Symbol#match? have been added. The methods are faster than match. Because the methods avoid creating a MatchData object or saving backref. So, when MatchData is not used, use match? instead of match.

        Example:

        # bad
        def foo
          if x =~ /re/
            do_something
          end
        end
        
        # bad
        def foo
          if x.match(/re/)
            do_something
          end
        end
        
        # bad
        def foo
          if /re/ === x
            do_something
          end
        end
        
        # good
        def foo
          if x.match?(/re/)
            do_something
          end
        end
        
        # good
        def foo
          if x =~ /re/
            do_something(Regexp.last_match)
          end
        end
        
        # good
        def foo
          if x.match(/re/)
            do_something($~)
          end
        end
        
        # good
        def foo
          if /re/ === x
            do_something($~)
          end
        end

        Method Dry::System::Lifecycle#start is defined at both lib/dry/system/lifecycle.rb:22 and lib/dry/system/lifecycle.rb:85.
        Open

              def start(&block)
        Severity: Minor
        Found in lib/dry/system/lifecycle.rb by rubocop

        This cop checks for duplicated instance (or singleton) method definitions.

        Example:

        # bad
        
        def duplicated
          1
        end
        
        def duplicated
          2
        end

        Example:

        # bad
        
        def duplicated
          1
        end
        
        alias duplicated other_duplicated

        Example:

        # good
        
        def duplicated
          1
        end
        
        def other_duplicated
          2
        end

        When using method_missing, define respond_to_missing?.
        Open

              def method_missing(meth, *args, &block)
                if target.registered?(meth)
                  target[meth]
                elsif container.key?(meth)
                  container[meth]
        Severity: Minor
        Found in lib/dry/system/lifecycle.rb by rubocop

        This cop checks for the presence of method_missing without also defining respond_to_missing? and falling back on super.

        Example:

        #bad
        def method_missing(name, *args)
          # ...
        end
        
        #good
        def respond_to_missing?(name, include_private)
          # ...
        end
        
        def method_missing(name, *args)
          # ...
          super
        end

        Shadowing outer local variable - block.
        Open

                        define_method(meth) do |*args, &block|

        This cop looks for use of the same name as outer local variables for block arguments or block local variables. This is a mimic of the warning "shadowing outer local variable - foo" from ruby -cw.

        Example:

        # bad
        
        def some_method
          foo = 1
        
          2.times do |foo| # shadowing outer `foo`
            do_something(foo)
          end
        end

        Example:

        # good
        
        def some_method
          foo = 1
        
          2.times do |bar|
            do_something(bar)
          end
        end

        Gems should be sorted in an alphabetical order within their section of the Gemfile. Gem ossy should appear before pry-byebug.
        Open

          gem 'ossy', git: 'https://github.com/solnic/ossy.git', branch: 'master'
        Severity: Minor
        Found in Gemfile by rubocop

        Gems should be alphabetically sorted within groups.

        Example:

        # bad
        gem 'rubocop'
        gem 'rspec'
        
        # good
        gem 'rspec'
        gem 'rubocop'
        
        # good
        gem 'rubocop'
        
        gem 'rspec'
        
        # good only if TreatCommentsAsGroupSeparators is true
        # For code quality
        gem 'rubocop'
        # For tests
        gem 'rspec'

        Method Dry::System::Lifecycle#stop is defined at both lib/dry/system/lifecycle.rb:24 and lib/dry/system/lifecycle.rb:90.
        Open

              def stop(&block)
        Severity: Minor
        Found in lib/dry/system/lifecycle.rb by rubocop

        This cop checks for duplicated instance (or singleton) method definitions.

        Example:

        # bad
        
        def duplicated
          1
        end
        
        def duplicated
          2
        end

        Example:

        # bad
        
        def duplicated
          1
        end
        
        alias duplicated other_duplicated

        Example:

        # good
        
        def duplicated
          1
        end
        
        def other_duplicated
          2
        end
        Severity
        Category
        Status
        Source
        Language