Sign upLogin

grokify/jsondoc-ruby

View on GitHub
Star

Showing 198 of 198 total issues

Class has too many lines. [171/100]
Open

  class Document
    attr_reader :dDocument

    attr_accessor :bIsStrict
    attr_accessor :bUseKeyAsDesc
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

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

Assignment Branch Condition size for getDescArrayForProperties is too high. [23.43/15]
Open

    def getDescArrayForProperties(aCols = nil)
      aVals = []
      return aVals if aCols.nil?
      aCols.each do |yKey|
        yKey = yKey.to_sym if yKey.is_a? String
Severity: Minor
Found in lib/jsondoc/document.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. [15/10]
Open

    def getDescArrayForProperties(aCols = nil)
      aVals = []
      return aVals if aCols.nil?
      aCols.each do |yKey|
        yKey = yKey.to_sym if yKey.is_a? String
Severity: Minor
Found in lib/jsondoc/document.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.

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

    def getPropRecurse(aKeys = [], dDoc = nil)
      yKey = aKeys.shift
      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.key?( yKey )
        return nil
      end
Severity: Minor
Found in lib/jsondoc/document.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.

Cyclomatic complexity for getDescArrayForProperties is too high. [8/6]
Open

    def getDescArrayForProperties(aCols = nil)
      aVals = []
      return aVals if aCols.nil?
      aCols.each do |yKey|
        yKey = yKey.to_sym if yKey.is_a? String
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

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

    def getValArrayForProperties(aCols = nil, xxNil = '')
      aVals = []
      return aVals if aCols.nil?

      if @bUseKeyAsDesc
Severity: Minor
Found in lib/jsondoc/document.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.

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

    def pushProp(yKey = nil, xxVal = nil)
      yKey = yKey.to_sym if yKey.is_a?(String)
      self.validateKey(yKey)

      if @dDocument.key?(yKey)
Severity: Minor
Found in lib/jsondoc/document.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.

Perceived complexity for getDescArrayForProperties is too high. [8/7]
Open

    def getDescArrayForProperties(aCols = nil)
      aVals = []
      return aVals if aCols.nil?
      aCols.each do |yKey|
        yKey = yKey.to_sym if yKey.is_a? String
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method getDescArrayForProperties has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def getDescArrayForProperties(aCols = nil)
      aVals = []
      return aVals if aCols.nil?
      aCols.each do |yKey|
        yKey = yKey.to_sym if yKey.is_a? String
Severity: Minor
Found in lib/jsondoc/document.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 initialize has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
      @dSchema        = dSchema || self.getDefaultSchema()
      @bDefaultifyDoc = bDefaultifyDoc ? true : false
      @bIsStrict      = bIsStrict ? true : false
      @bUseKeyAsDesc  = false
Severity: Minor
Found in lib/jsondoc/document.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 validateKey has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    def validateKey(yKey = nil)
      raise ArgumentError, "E_BAD_KEY__IS_NIL [#{yKey.to_s}]" if yKey.nil?

      return true unless @bIsStrict
Severity: Minor
Found in lib/jsondoc/document.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 initialize has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
Severity: Minor
Found in lib/jsondoc/document.rb - About 35 mins to fix

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

        def getDefaultDocument
      dDocument = {}
      if @bDefaultifyDoc && @dSchema.key?(:properties)
        @dSchema[:properties].keys.each do |yKey|
          dProperty = @dSchema[:properties][yKey]
    Severity: Minor
    Found in lib/jsondoc/document.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 getPropRecurse has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def getPropRecurse(aKeys = [], dDoc = nil)
      yKey = aKeys.shift
      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.key?( yKey )
        return nil
      end
    Severity: Minor
    Found in lib/jsondoc/document.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 getPropSingle has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def getPropSingle(yKey = nil)
      raise ArgumentError, 'E_BAD_KEY__IS_NIL' if yKey.nil?
      yKey = yKey.to_sym if yKey.is_a?(String)
      xxVal = @dDocument.key?(yKey) ? @dDocument[yKey] : nil
      if xxVal.nil? && @bIsStrict
    Severity: Minor
    Found in lib/jsondoc/document.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 pushProp has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def pushProp(yKey = nil, xxVal = nil)
      yKey = yKey.to_sym if yKey.is_a?(String)
      self.validateKey(yKey)

      if @dDocument.key?(yKey)
    Severity: Minor
    Found in lib/jsondoc/document.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 getValArrayForProperties has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def getValArrayForProperties(aCols = nil, xxNil = '')
      aVals = []
      return aVals if aCols.nil?

      if @bUseKeyAsDesc
    Severity: Minor
    Found in lib/jsondoc/document.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

    Avoid the use of Perl-style backrefs.
    Open

    version = $1
    Severity: Minor
    Found in jsondoc.gemspec by rubocop

    This cop looks for uses of Perl-style regexp match backreferences like $1, $2, etc.

    Example:

    # bad
puts $1

# good
puts Regexp.last_match(1)

    Space missing after comma.
    Open

        def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
    Severity: Minor
    Found in lib/jsondoc/document.rb by rubocop

    Checks for comma (,) not followed by some kind of space.

    Example:

    # bad
[1,2]
{ foo:bar,}

# good
[1, 2]
{ foo:bar, }

    Space inside { missing.
    Open

              id: {default: '', description: 'Doc Id', type: 'string'}
    Severity: Minor
    Found in lib/jsondoc/document.rb by rubocop

    Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

    Example: EnforcedStyle: space

    # The `space` style enforces that hash literals have
# surrounding space.

# bad
h = {a: 1, b: 2}

# good
h = { a: 1, b: 2 }

    Example: EnforcedStyle: no_space

    # The `no_space` style enforces that hash literals have
# no surrounding space.

# bad
h = { a: 1, b: 2 }

# good
h = {a: 1, b: 2}

    Example: EnforcedStyle: compact

    # The `compact` style normally requires a space inside
# hash braces, with the exception that successive left
# braces or right braces are collapsed together in nested hashes.

# bad
h = { a: { b: 2 } }

# good
h = { a: { b: 2 }}
    Severity
    Category
    Status
    Source
    Language