svenfuchs/cl

View on GitHub

Showing 8 of 8 total issues

Class Opt has 46 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Opt < Struct.new(:strs, :opts, :block)
    include Cast, Regex

    OPTS = %i(
      alias default deprecated description downcase eg enum example format
Severity: Minor
Found in lib/cl/opt.rb - About 6 hrs to fix

    Method format has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

            def format
              opts = []
              opts << "alias: #{format_aliases(opt)}" if opt.aliases?
              opts << "requires: #{opt.requires.join(', ')}" if opt.requires?
              opts << "default: #{format_default(opt)}" if opt.default?
    Severity: Minor
    Found in lib/cl/help/format.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 apply has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

          def apply
            error :missing_strs if strs.empty?
            error :wrong_strs if short.size > 1 || long.size > 1
            error :invalid_strs, invalid unless invalid.empty?
            error :unknown_opts, unknown.map(&:inspect).join(', ') unless unknown.empty?
    Severity: Minor
    Found in lib/cl/opt.rb - About 35 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 group has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

            def group(args, cmds = [])
              args.flatten.map(&:to_s).inject([[]]) do |cmds, arg|
                cmd = Cmd.registered?(arg) ? Cmd[arg] : nil
                cmd ? cmds << [cmd] : cmds.last << arg
                cmds.reject(&:empty?)
    Severity: Minor
    Found in lib/cl/runner/multi.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 format has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

            def format
              opts = []
              opts << "type: #{type(obj)}" unless obj.type == :flag
              opts << 'required' if obj.required?
              opts += Opt.new(obj).format if obj.is_a?(Cl::Opt)
    Severity: Minor
    Found in lib/cl/help/format.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 splat has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

          def splat(values)
            args.each.with_index.inject([]) do |group, (arg, ix)|
              count = arg && arg.splat? ? [values.size - args.size + ix + 1] : []
              count = 0 if count.first.to_i < 0
              group << values.shift(*count)
    Severity: Minor
    Found in lib/cl/args.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

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

          def downcase(opts)
            select(&:downcase?).inject(opts) do |opts, opt|
              next opts unless value = opts[opt.name]
              opts.merge(opt.name => value.to_s.downcase)
    Severity: Minor
    Found in lib/cl/opts.rb and 1 other location - About 15 mins to fix
    lib/cl/opts.rb on lines 97..100

    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

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

          def upcase(opts)
            select(&:upcase?).inject(opts) do |opts, opt|
              next opts unless value = opts[opt.name]
              opts.merge(opt.name => value.to_s.upcase)
    Severity: Minor
    Found in lib/cl/opts.rb and 1 other location - About 15 mins to fix
    lib/cl/opts.rb on lines 90..93

    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

    Severity
    Category
    Status
    Source
    Language