sambauers/capistrano-committed

View on GitHub
lib/capistrano/committed/output.rb

Summary

Maintainability
A
3 hrs
Test Coverage
A
100%

Assignment Branch Condition size for issue_links is too high. [26.31/15]
Open

      def issue_links
        return unless context.current[:info]
        case context.current[:type]
        when :commit
          return unless context.current[:info][:commit]
Severity: Minor
Found in lib/capistrano/committed/output.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

Class Output has 22 methods (exceeds 20 allowed). Consider refactoring.
Open

    class Output < Mustache
      @@template_format = 'txt'

      self.template_path = format('%<dir>s/output', dir: File.dirname(__FILE__))
      self.template_file = format('%<dir>s/output/output_%<format>s.mustache', dir: File.dirname(__FILE__), format: @@template_format)
Severity: Minor
Found in lib/capistrano/committed/output.rb - About 2 hrs to fix

    Assignment Branch Condition size for release_header is too high. [20.1/15]
    Open

          def release_header
            case context.current[:release]
            when :next
              t('committed.output.next_release')
            when :previous
    Severity: Minor
    Found in lib/capistrano/committed/output.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

    Assignment Branch Condition size for item_lines is too high. [19.52/15]
    Open

          def item_lines
            return unless context.current[:info]
            case context.current[:type]
            when :commit
              message = context.current[:info][:commit][:message]
    Severity: Minor
    Found in lib/capistrano/committed/output.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

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

          def release_header
            case context.current[:release]
            when :next
              t('committed.output.next_release')
            when :previous
    Severity: Minor
    Found in lib/capistrano/committed/output.rb by rubocop

    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.

    Assignment Branch Condition size for item_title is too high. [16.28/15]
    Open

          def item_title
            return unless context.current[:info]
            case context.current[:type]
            when :commit
              t('committed.output.commit_sha',
    Severity: Minor
    Found in lib/capistrano/committed/output.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

    Assignment Branch Condition size for item_created_by is too high. [16.28/15]
    Open

          def item_created_by
            return unless context.current[:info]
            case context.current[:type]
            when :commit
              format_created_by('committed.output.committed_by', context.current[:info][:committer])
    Severity: Minor
    Found in lib/capistrano/committed/output.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

    Assignment Branch Condition size for item_link is too high. [15.3/15]
    Open

          def item_link
            return unless context.current[:info]
            case context.current[:type]
            when :commit, :pull_request
              return unless context.current[:info][:html_url]
    Severity: Minor
    Found in lib/capistrano/committed/output.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

    Assignment Branch Condition size for commits is too high. [15.3/15]
    Open

          def commits
            return unless context.current[:type] == :pull_request
            return unless context.current[:commits]
            return if context.current[:commits].empty?
            context.current[:commits].flatten
    Severity: Minor
    Found in lib/capistrano/committed/output.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

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

          def issue_links
            return unless context.current[:info]
            case context.current[:type]
            when :commit
              return unless context.current[:info][:commit]
    Severity: Minor
    Found in lib/capistrano/committed/output.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

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

          def item_link
            return unless context.current[:info]
            case context.current[:type]
            when :commit, :pull_request
              return unless context.current[:info][:html_url]
    Severity: Minor
    Found in lib/capistrano/committed/output.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

    Missing magic comment # frozen_string_literal: true.
    Open

    require 'mustache'
    Severity: Minor
    Found in lib/capistrano/committed/output.rb by rubocop

    This cop is designed to help upgrade to Ruby 3.0. It will add the comment # frozen_string_literal: true to the top of files to enable frozen string literals. Frozen string literals may be default in Ruby 3.0. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

    Example: EnforcedStyle: when_needed (default)

    # The `when_needed` style will add the frozen string literal comment
    # to files only when the `TargetRubyVersion` is set to 2.3+.
    # bad
    module Foo
      # ...
    end
    
    # good
    # frozen_string_literal: true
    
    module Foo
      # ...
    end

    Example: EnforcedStyle: always

    # The `always` style will always add the frozen string literal comment
    # to a file, regardless of the Ruby version or if `freeze` or `<<` are
    # called on a string literal.
    # bad
    module Bar
      # ...
    end
    
    # good
    # frozen_string_literal: true
    
    module Bar
      # ...
    end

    Example: EnforcedStyle: never

    # The `never` will enforce that the frozen string literal comment does
    # not exist in a file.
    # bad
    # frozen_string_literal: true
    
    module Baz
      # ...
    end
    
    # good
    module Baz
      # ...
    end

    Replace class var @@template_format with a class instance var.
    Open

          @@template_format = 'txt'
    Severity: Minor
    Found in lib/capistrano/committed/output.rb by rubocop

    This cop checks for uses of class variables. Offenses are signaled only on assignment to class variables to reduce the number of offenses that would be reported.

    Replace class var @@template_format with a class instance var.
    Open

            @@template_format = format if set_template_format
    Severity: Minor
    Found in lib/capistrano/committed/output.rb by rubocop

    This cop checks for uses of class variables. Offenses are signaled only on assignment to class variables to reduce the number of offenses that would be reported.

    There are no issues that match your filters.

    Category
    Status