gitshowcase/gitshowcase

View on GitHub
app/services/github_project_service.rb

Summary

Maintainability
A
0 mins
Test Coverage

Assignment Branch Condition size for sync is too high. [24.78/15]
Open

  def sync(data = nil)
    raise "Project ##{@project.id} - #{@project.title} does not have a repository to sync" unless @project.repository.present?

    repository = UrlHelper.extract(@project.repository, 'github.com/')
    data = client.repository(repository) if data.nil?

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

Method has too many lines. [13/10]
Open

  def sync(data = nil)
    raise "Project ##{@project.id} - #{@project.title} does not have a repository to sync" unless @project.repository.present?

    repository = UrlHelper.extract(@project.repository, 'github.com/')
    data = client.repository(repository) if data.nil?

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

protected (on line 50) does not make singleton methods protected. Use protected inside a class << self block instead.
Open

  def self.client(user)

This cop checks for private or protected access modifiers which are applied to a singleton method. These access modifiers do not make singleton methods private/protected. private_class_method can be used for that.

Example:

# bad

class C
  private

  def self.method
    puts 'hi'
  end
end

Example:

# good

class C
  def self.method
    puts 'hi'
  end

  private_class_method :method
end

Example:

# good

class C
  class << self
    private

    def method
      puts 'hi'
    end
  end
end

Line is too long. [126/80]
Open

    raise "Project ##{@project.id} - #{@project.title} does not have a repository to sync" unless @project.repository.present?

Line is too long. [99/80]
Open

        project = Project.find_or_initialize_by(user_id: user.id, repository: repository.full_name)

Missing top-level class documentation comment.
Open

class GithubProjectService < ApplicationService

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Redundant self detected.
Open

        self.new(project).sync(repository)

This cop checks for redundant uses of self.

The usage of self is only needed when:

  • Sending a message to same object with zero arguments in presence of a method name clash with an argument or a local variable.

  • Calling an attribute writer to prevent an local variable assignment.

Note, with using explicit self you can only send messages with public or protected scope, you cannot send private messages this way.

Note we allow uses of self with operators because it would be awkward otherwise.

Example:

# bad
def foo(bar)
  self.baz
end

# good
def foo(bar)
  self.bar  # Resolves name clash with the argument.
end

def foo
  bar = 1
  self.bar  # Resolves name clash with the local variable.
end

def foo
  %w[x y z].select do |bar|
    self.bar == bar  # Resolves name clash with argument of the block.
  end
end

Redundant self detected.
Open

    projects.each { |project| self.new(project).sync }

This cop checks for redundant uses of self.

The usage of self is only needed when:

  • Sending a message to same object with zero arguments in presence of a method name clash with an argument or a local variable.

  • Calling an attribute writer to prevent an local variable assignment.

Note, with using explicit self you can only send messages with public or protected scope, you cannot send private messages this way.

Note we allow uses of self with operators because it would be awkward otherwise.

Example:

# bad
def foo(bar)
  self.baz
end

# good
def foo(bar)
  self.bar  # Resolves name clash with the argument.
end

def foo
  bar = 1
  self.bar  # Resolves name clash with the local variable.
end

def foo
  %w[x y z].select do |bar|
    self.bar == bar  # Resolves name clash with argument of the block.
  end
end

There are no issues that match your filters.

Category
Status