fog/fog-azure-rm

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

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.

This cop checks for unused method arguments.

Example:

# bad
 
def some_method(used, unused, _unused_but_allowed)
  puts used
end

Example:

# good
 
def some_method(used, _unused, _unused_but_allowed)
  puts used
end

This cop enforces the consistent usage of %-literal delimiters.

Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

Example:

# Style/PercentLiteralDelimiters:
#   PreferredDelimiters:
#     default: '[]'
#     '%i':    '()'
 
# good
%w[alpha beta] + %i(gamma delta)
 
# bad
%W(alpha #{beta})
 
# bad
%I(alpha beta)

This cop checks for extra/unnecessary whitespace.

Example:

# good if AllowForAlignment is true
name      = "RuboCop"
# Some comment and an empty line
 
website  += "/bbatsov/rubocop" unless cond
puts        "rubocop"          if     debug
 
# bad for any configuration
set_app("RuboCop")
website  = "https://github.com/bbatsov/rubocop"

This cop checks for extra/unnecessary whitespace.

Example:

# good if AllowForAlignment is true
name      = "RuboCop"
# Some comment and an empty line
 
website  += "/bbatsov/rubocop" unless cond
puts        "rubocop"          if     debug
 
# bad for any configuration
set_app("RuboCop")
website  = "https://github.com/bbatsov/rubocop"

This cop checks for rescuing StandardError. There are two supported styles implicit and explicit. This cop will not register an offense if any error other than StandardError is specified.

Example: EnforcedStyle: implicit

# `implicit` will enforce using `rescue` instead of
# `rescue StandardError`.
 
# bad
begin
  foo
rescue StandardError
  bar
end
 
# good
begin
  foo
rescue
  bar
end
 
# good
begin
  foo
rescue OtherError
  bar
end
 
# good
begin
  foo
rescue StandardError, SecurityError
  bar
end

Example: EnforcedStyle: explicit (default)

# `explicit` will enforce using `rescue StandardError`
# instead of `rescue`.
 
# bad
begin
  foo
rescue
  bar
end
 
# good
begin
  foo
rescue StandardError
  bar
end
 
# good
begin
  foo
rescue OtherError
  bar
end
 
# good
begin
  foo
rescue StandardError, SecurityError
  bar
end

This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions to go on a single line (compact style), but it can be configured to enforce the end to go on its own line (expanded style).

Note: A method definition is not considered empty if it contains comments.

Example: EnforcedStyle: compact (default)

# bad
def foo(bar)
end
 
def self.foo(bar)
end
 
# good
def foo(bar); end
 
def foo(bar)
  # baz
end
 
def self.foo(bar); end

Example: EnforcedStyle: expanded

# bad
def foo(bar); end
 
def self.foo(bar); end
 
# good
def foo(bar)
end
 
def self.foo(bar)
end

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("{}")

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("{}")

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("{}")

This cop checks for extra/unnecessary whitespace.

Example:

# good if AllowForAlignment is true
name      = "RuboCop"
# Some comment and an empty line
 
website  += "/bbatsov/rubocop" unless cond
puts        "rubocop"          if     debug
 
# bad for any configuration
set_app("RuboCop")
website  = "https://github.com/bbatsov/rubocop"

This cop checks for unused method arguments.

Example:

# bad
 
def some_method(used, unused, _unused_but_allowed)
  puts used
end

Example:

# good
 
def some_method(used, _unused, _unused_but_allowed)
  puts used
end