Sign upLogin

grokify/jsondoc-ruby

View on GitHub
Star

Showing 198 of 198 total issues

Use snake_case for method names.
Open

    def sortKeys
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all methods use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
def fooBar; end

# good
def foo_bar; end

Example: EnforcedStyle: camelCase

# bad
def foo_bar; end

# good
def fooBar; end

Use snake_case for variable names.
Open

      yKey = yKey.to_sym if yKey.is_a?(String)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Use snake_case for variable names.
Open

        xxVal = xxVal.to_s unless xxVal.is_a? String
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Use each_key instead of keys.each.
Open

        @dSchema[:properties].keys.each do |yKey|
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for uses of each_key and each_value Hash methods.

Note: If you have an array of two-element arrays, you can put parentheses around the block arguments to indicate that you're not working with a hash, and suppress RuboCop offenses.

Example:

# bad
hash.keys.each { |k| p k }
hash.values.each { |v| p v }
hash.each { |k, _v| p k }
hash.each { |_k, v| p v }

# good
hash.each_key { |k| p k }
hash.each_value { |v| p v }

Redundant return detected.
Open

      return self
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for redundant return expressions.

Example:

def test
  return something
end

def test
  one
  two
  three
  return something
end

It should be extended to handle methods whose body is if/else or a case expression with a default branch.

Use snake_case for variable names.
Open

      yKey = yKey.to_sym if yKey.is_a?(String)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Redundant self detected.
Open

      @dDocument      = self.getDefaultDocument()
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

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

Prefer JSON.parse over JSON.load.
Open

        @dDocument = JSON.load(jDocument)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for the use of JSON class methods which have potential security issues.

Autocorrect is disabled by default because it's potentially dangerous. If using a stream, like JSON.load(open('file')), it will need to call #read manually, like JSON.parse(open('file').read). If reading single values (rather than proper JSON objects), like JSON.load('false'), it will need to pass the quirks_mode: true option, like JSON.parse('false', quirks_mode: true). Other similar issues may apply.

Example:

# always offense
JSON.load("{}")
JSON.restore("{}")

# no offense
JSON.parse("{}")

Use alias instead of alias_method in a class body.
Open

    alias_method :pushAttr, :pushProp
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop enforces the use of either #alias or #alias_method depending on configuration. It also flags uses of alias :symbol rather than alias bareword.

Example: EnforcedStyle: prefer_alias (default)

# bad
alias_method :bar, :foo
alias :bar :foo

# good
alias bar foo

Example: EnforcedStyle: preferaliasmethod

# bad
alias :bar :foo
alias bar foo

# good
alias_method :bar, :foo

Do not use parentheses for method calls with no arguments.
Open

      @dSchema        = dSchema || self.getDefaultSchema()
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for unwanted parentheses in parameterless method calls.

Example:

# bad
object.some_method()

# good
object.some_method

Redundant self detected.
Open

      JSON.dump( self.asHash() )
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

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

Space inside parentheses detected.
Open

      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.key?( yKey )
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

Checks for spaces inside ordinary round parentheses.

Example:

# bad
f( 3)
g = (a + 3 )

# good
f(3)
g = (a + 3)

Use snake_case for method names.
Open

    def loadHash(dValues = nil)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all methods use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
def fooBar; end

# good
def foo_bar; end

Example: EnforcedStyle: camelCase

# bad
def foo_bar; end

# good
def fooBar; end

Use snake_case for variable names.
Open

        aKeys = yKey.split('.') # = yKey.to_s.split('.').map(&:to_sym)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Use snake_case for variable names.
Open

    def pushProp(yKey = nil, xxVal = nil)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Use snake_case for variable names.
Open

    def cpProp(yKeySrc = nil, yKeyDest = nil)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Use snake_case for variable names.
Open

    def fromJson(jDocument = nil)
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop makes sure that all variables use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
fooBar = 1

# good
foo_bar = 1

Example: EnforcedStyle: camelCase

# bad
foo_bar = 1

# good
fooBar = 1

Missing top-level class documentation comment.
Open

class Symbol
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

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

Avoid multi-line ternary operators, use if or unless instead.
Open

      bKeyExists = @dSchema.key?(:properties) \
        && @dSchema[:properties].key?(yKey) ? true : false
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for multi-line ternary op expressions.

Example:

# bad
a = cond ?
  b : c
a = cond ? b :
    c
a = cond ?
    b :
    c

# good
a = cond ? b : c
a =
  if cond
    b
  else
    c
  end

Avoid multi-line ternary operators, use if or unless instead.
Open

        xxVal = (
          @dSchema.key?(:properties)                          \
          && @dSchema[:properties].key?(yKey)                 \
          && @dSchema[:properties][yKey].key?(:description)   \
          && @dSchema[:properties][yKey][:description].length > 0
Severity: Minor
Found in lib/jsondoc/document.rb by rubocop

This cop checks for multi-line ternary op expressions.

Example:

# bad
a = cond ?
  b : c
a = cond ? b :
    c
a = cond ?
    b :
    c

# good
a = cond ? b : c
a =
  if cond
    b
  else
    c
  end
Severity
Category
Status
Source
Language