gitlabhq/grit

View on GitHub
lib/grit/git-ruby.rb

Summary

Maintainability
D
1 day
Test Coverage

Method tags has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

    def tags(options, prefix)
      refs = []
      already = {}

      orig_prefix = prefix
Severity: Minor
Found in lib/grit/git-ruby.rb - About 3 hrs 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 rev_parse has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    def rev_parse(options, string)
      raise RuntimeError, "invalid string: #{string.inspect}" unless string.is_a?(String)

      # Split ranges, but don't split when specifying a ref:path.
      # Don't split HEAD:some/path/in/repo..txt
Severity: Minor
Found in lib/grit/git-ruby.rb - About 2 hrs 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 refs has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    def refs(options, prefix)
      refs = []
      already = {}
      orig_prefix = prefix
      prefix = File.join @git_dir, prefix
Severity: Minor
Found in lib/grit/git-ruby.rb - About 2 hrs 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 tags has 36 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def tags(options, prefix)
      refs = []
      already = {}

      orig_prefix = prefix
Severity: Minor
Found in lib/grit/git-ruby.rb - About 1 hr to fix

    Method rev_list has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        def rev_list(options, *refs)
          refs = ['master'] if refs.empty?
          options.delete(:skip) if options[:skip].to_i == 0
          allowed_options = [:max_count, :since, :until, :pretty]  # this is all I can do right now
          if ((options.keys - allowed_options).size > 0) || refs.size > 1
    Severity: Minor
    Found in lib/grit/git-ruby.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 refs has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def refs(options, prefix)
          refs = []
          already = {}
          orig_prefix = prefix
          prefix = File.join @git_dir, prefix
    Severity: Minor
    Found in lib/grit/git-ruby.rb - About 1 hr to fix

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

            def looking_for(commit, path = nil)
              tree_sha = ruby_git.get_subtree(rev_parse({}, commit), path)
      
              looking_for = []
              ruby_git.get_object_by_sha1(tree_sha).entry.each do |e|
      Severity: Minor
      Found in lib/grit/git-ruby.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

      Avoid too many return statements within this method.
      Open

                  return m[1].chomp
      Severity: Major
      Found in lib/grit/git-ruby.rb - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

              return method_missing('rev-parse', options, string).chomp
        Severity: Major
        Found in lib/grit/git-ruby.rb - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                return File.read(head).chomp if File.file?(head)
          Severity: Major
          Found in lib/grit/git-ruby.rb - About 30 mins to fix

            Identical blocks of code found in 2 locations. Consider refactoring.
            Open

                  files.each do |ref|
                    next if !File.file?(ref)
            
                    id = File.read(ref).chomp
                    name = ref.sub("#{prefix}/", '')
            Severity: Minor
            Found in lib/grit/git-ruby.rb and 1 other location - About 50 mins to fix
            lib/grit/git-ruby.rb on lines 123..129

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 42.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            Identical blocks of code found in 2 locations. Consider refactoring.
            Open

                  files.each do |ref|
                    next if !File.file?(ref)
                    id = File.read(ref).chomp
                    name = ref.sub("#{prefix}/", '')
                    if !already[name]
            Severity: Minor
            Found in lib/grit/git-ruby.rb and 1 other location - About 50 mins to fix
            lib/grit/git-ruby.rb on lines 159..167

            Duplicated Code

            Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

            Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

            When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

            Tuning

            This issue has a mass of 42.

            We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

            The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

            If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

            See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

            Refactorings

            Further Reading

            There are no issues that match your filters.

            Category
            Status