nesquena/gitdocs

View on GitHub
test/unit/repository_committer_test.rb

Summary

Maintainability
A
1 hr
Test Coverage

Block has too many lines. [85/25]
Open

describe Gitdocs::Repository::Committer do
  before do
    FileUtils.rm_rf('tmp/unit')
    GitFactory.init(:local)
  end

This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.

Block has too many lines. [46/25]
Open

  describe '#commit' do
    subject { committer.commit }

    before { Gitdocs.stubs(:log_debug) }

This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.

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

        describe 'side effects' do
          before { subject }
          it { GitInspector.file_exist?(:local, 'directory/.gitignore').must_equal true }
          it { GitInspector.commit_count(:local).must_equal 1 }
          it { GitInspector.last_message(:local).must_equal "Auto-commit from gitdocs\n" }
Severity: Minor
Found in test/unit/repository_committer_test.rb and 1 other location - About 35 mins to fix
test/unit/repository_committer_test.rb on lines 80..85

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 36.

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

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

        describe 'side effects' do
          before { subject }
          it { GitInspector.file_exist?(:local, 'directory/.gitignore').must_equal true }
          it { GitInspector.commit_count(:local).must_equal 3 }
          it { GitInspector.last_message(:local).must_equal "Auto-commit from gitdocs\n" }
Severity: Minor
Found in test/unit/repository_committer_test.rb and 1 other location - About 35 mins to fix
test/unit/repository_committer_test.rb on lines 51..56

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 36.

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

Add an empty line after magic comments.
Open

require File.expand_path('../test_helper', __FILE__)

Checks for a newline after the final magic comment.

Example:

# good
# frozen_string_literal: true

# Some documentation for Person
class Person
  # Some code
end

# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Unnecessary utf-8 encoding comment.
Open

# -*- encoding : utf-8 -*-

There are no issues that match your filters.

Category
Status