Sign upLogin

nesquena/gitdocs

View on GitHub
Star
lib/gitdocs/repository/committer.rb

Summary

Maintainability
A
15 mins
Test Coverage

Assignment Branch Condition size for commit is too high. [17.15/15]
Open

      def commit
        # Do this first to allow the message file to be deleted, if it exists.
        message = read_and_delete_commit_message_file

        mark_empty_directories
Severity: Minor
Found in lib/gitdocs/repository/committer.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

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

          Find.prune if File.basename(path) == '.git'
          if File.directory?(path) && Dir.entries(path).count == 2
            FileUtils.touch(File.join(path, '.gitignore'))
          end
Severity: Minor
Found in lib/gitdocs/repository/committer.rb and 1 other location - About 15 mins to fix
lib/gitdocs/repository.rb on lines 342..345

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

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

Favor a normal unless-statement over a modifier clause in a multiline statement.
Open

        return(
          'Auto-commit from gitdocs'
        ) unless File.exist?(@commit_message_path)
Severity: Minor
Found in lib/gitdocs/repository/committer.rb by rubocop

Checks for uses of if/unless modifiers with multiple-lines bodies.

Example:

# bad
{
  result: 'this should not happen'
} unless cond

# good
{ result: 'ok' } if cond

Unnecessary utf-8 encoding comment.
Open

# -*- encoding : utf-8 -*-
Severity: Minor
Found in lib/gitdocs/repository/committer.rb by rubocop

Add an empty line after magic comments.
Open

module Gitdocs
Severity: Minor
Found in lib/gitdocs/repository/committer.rb by rubocop

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

There are no issues that match your filters.

Category
Status