Sign upLogin

dominicsayers/foreplay

View on GitHub
Star

Showing 7 of 7 total issues

Class Step has 23 methods (exceeds 20 allowed). Consider refactoring.
Open

    class Step
      include Foreplay
      attr_reader :host, :step, :instructions

      def initialize(h, s, i)
Severity: Minor
Found in lib/foreplay/engine/step.rb - About 2 hrs to fix

    Method secrets has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

            def secrets
          return @secrets if @secrets

          @secrets = all_secrets[environment]
    Severity: Minor
    Found in lib/foreplay/engine/secrets/location.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 supermerge has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

      def supermerge(other_hash)
    raise "supermerge needs a Hash, not a #{other_hash.class}." unless other_hash.is_a?(Hash)

    new_hash = deep_dup
    Severity: Minor
    Found in lib/foreplay.rb - About 45 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 all_secrets has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

            def all_secrets
          return @all_secrets if @all_secrets
          @all_secrets = url ? YAML.safe_load(raw_secrets, [Date, Symbol, Time], [], true) : {}
        rescue Psych::SyntaxError => e
          log "Exception caught when loading secrets from this location: #{url}"
    Severity: Minor
    Found in lib/foreplay/engine/secrets/location.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 roles_all has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

          def roles_all
        return @roles_all if @roles_all
        @roles_all = YAML.safe_load(File.read(config_file), [Date, Symbol, Time], [], true)

        # This environment
    Severity: Minor
    Found in lib/foreplay/engine/defaults.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

    Pass __FILE__ and __LINE__ to eval method, as they are used by backtraces.
    Open

        gsub(/(<%=\s+([^%]+)\s+%>)/) { |e| eval "_ = #{e.split[1]}" } # rubocop:disable Security/Eval
    Severity: Minor
    Found in lib/foreplay.rb by rubocop

    This cop checks eval method usage. eval can receive source location metadata, that are filename and line number. The metadata is used by backtraces. This cop recommends to pass the metadata to eval method.

    Example:

    # bad
eval <<-RUBY
  def do_something
  end
RUBY

# bad
C.class_eval <<-RUBY
  def do_something
  end
RUBY

# good
eval <<-RUBY, binding, __FILE__, __LINE__ + 1
  def do_something
  end
RUBY

# good
C.class_eval <<-RUBY, __FILE__, __LINE__ + 1
  def do_something
  end
RUBY

    Dependencies should be sorted in an alphabetical order within their section of the gemspec. Dependency activesupport should appear before ssh-shell.
    Open

      s.add_runtime_dependency 'activesupport', '>= 5.2.4.3'
    Severity: Minor
    Found in foreplay.gemspec by rubocop

    Dependencies in the gemspec should be alphabetically sorted.

    Example:

    # bad
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'

# good
spec.add_dependency 'rspec'
spec.add_dependency 'rubocop'

# good
spec.add_dependency 'rubocop'

spec.add_dependency 'rspec'

# bad
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'

# good
spec.add_development_dependency 'rspec'
spec.add_development_dependency 'rubocop'

# good
spec.add_development_dependency 'rubocop'

spec.add_development_dependency 'rspec'

# bad
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'

# good
spec.add_runtime_dependency 'rspec'
spec.add_runtime_dependency 'rubocop'

# good
spec.add_runtime_dependency 'rubocop'

spec.add_runtime_dependency 'rspec'

# good only if TreatCommentsAsGroupSeparators is true
# For code quality
spec.add_dependency 'rubocop'
# For tests
spec.add_dependency 'rspec'
    Severity
    Category
    Status
    Source
    Language