hovancik/BSDSec

Check for usages of not (not or !) called on a method when an inverse of that method can be used instead.

Methods that can be inverted by a not (not or !) should be defined in InverseMethods.

Methods that are inverted by inverting the return of the block that is passed to the method should be defined in InverseBlocks.

Safety:

This cop is unsafe because it cannot be guaranteed that the method and its inverse method are both defined on receiver, and also are actually inverse of each other.

Example:

# bad
!foo.none?
!foo.any? { |f| f.even? }
!foo.blank?
!(foo == bar)
foo.select { |f| !f.even? }
foo.reject { |f| f != 7 }
 
# good
foo.none?
foo.blank?
foo.any? { |f| f.even? }
foo != bar
foo == bar
!!('foo' =~ /^\w+$/)
!(foo.class < Numeric) # Checking class hierarchy is allowed
# Blocks with guard clauses are ignored:
foo.select do |f|
  next if f.zero?
  f != 1
end

Checks the . position in multi-line method calls.

Example: EnforcedStyle: leading (default)

# bad
something.
  method
 
# good
something
  .method

Example: EnforcedStyle: trailing

# bad
something
  .method
 
# good
something.
  method

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks the indentation of the method name part in method calls that span more than one line.

Example: EnforcedStyle: aligned (default)

# bad
while myvariable
.b
  # do something
end
 
# good
while myvariable
      .b
  # do something
end
 
# good
Thing.a
     .b
     .c

Example: EnforcedStyle: indented

# good
while myvariable
  .b
 
  # do something
end

Example: EnforcedStyle: indentedrelativeto_receiver

# good
while myvariable
        .a
        .b
 
  # do something
end
 
# good
myvariable = Thing
               .a
               .b
               .c

Checks the . position in multi-line method calls.

Example: EnforcedStyle: leading (default)

# bad
something.
  method
 
# good
something
  .method

Example: EnforcedStyle: trailing

# bad
something
  .method
 
# good
something.
  method

Identifies places where $stderr.puts can be replaced by warn. The latter has the advantage of easily being disabled by, the -W0 interpreter flag or setting $VERBOSE to nil.

Example:

# bad
$stderr.puts('hello')
 
# good
warn('hello')

Checks the indentation of the method name part in method calls that span more than one line.

Example: EnforcedStyle: aligned (default)

# bad
while myvariable
.b
  # do something
end
 
# good
while myvariable
      .b
  # do something
end
 
# good
Thing.a
     .b
     .c

Example: EnforcedStyle: indented

# good
while myvariable
  .b
 
  # do something
end

Example: EnforcedStyle: indentedrelativeto_receiver

# good
while myvariable
        .a
        .b
 
  # do something
end
 
# good
myvariable = Thing
               .a
               .b
               .c

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks the indentation of the method name part in method calls that span more than one line.

Example: EnforcedStyle: aligned (default)

# bad
while myvariable
.b
  # do something
end
 
# good
while myvariable
      .b
  # do something
end
 
# good
Thing.a
     .b
     .c

Example: EnforcedStyle: indented

# good
while myvariable
  .b
 
  # do something
end

Example: EnforcedStyle: indentedrelativeto_receiver

# good
while myvariable
        .a
        .b
 
  # do something
end
 
# good
myvariable = Thing
               .a
               .b
               .c

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"
 
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'
 
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Checks the . position in multi-line method calls.

Example: EnforcedStyle: leading (default)

# bad
something.
  method
 
# good
something
  .method

Example: EnforcedStyle: trailing

# bad
something
  .method
 
# good
something.
  method

Checks the . position in multi-line method calls.

Example: EnforcedStyle: leading (default)

# bad
something.
  method
 
# good
something
  .method

Example: EnforcedStyle: trailing

# bad
something
  .method
 
# good
something.
  method

Checks the indentation of the method name part in method calls that span more than one line.

Example: EnforcedStyle: aligned (default)

# bad
while myvariable
.b
  # do something
end
 
# good
while myvariable
      .b
  # do something
end
 
# good
Thing.a
     .b
     .c

Example: EnforcedStyle: indented

# good
while myvariable
  .b
 
  # do something
end

Example: EnforcedStyle: indentedrelativeto_receiver

# good
while myvariable
        .a
        .b
 
  # do something
end
 
# good
myvariable = Thing
               .a
               .b
               .c

Helps you transition from mutable string literals to frozen string literals. It will add the # frozen_string_literal: true magic comment to the top of files to enable frozen string literals. Frozen string literals may be default in future Ruby. The comment will be added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.

Note that the cop will accept files where the comment exists but is set to false instead of true.

To require a blank line after this comment, please see Layout/EmptyLineAfterMagicComment cop.

Safety:

This cop's autocorrection is unsafe since any strings mutations will change from being accepted to raising FrozenError, as all strings will become frozen by default, and will need to be manually refactored.

Example: EnforcedStyle: always (default)

# The `always` style will always add the frozen string literal comment
# to a file, regardless of the Ruby version or if `freeze` or `<<` are
# called on a string literal.
# bad
module Bar
  # ...
end
 
# good
# frozen_string_literal: true
 
module Bar
  # ...
end
 
# good
# frozen_string_literal: false
 
module Bar
  # ...
end

Example: EnforcedStyle: never

# The `never` will enforce that the frozen string literal comment does
# not exist in a file.
# bad
# frozen_string_literal: true
 
module Baz
  # ...
end
 
# good
module Baz
  # ...
end

Example: EnforcedStyle: always_true

# The `always_true` style enforces that the frozen string literal
# comment is set to `true`. This is a stricter option than `always`
# and forces projects to use frozen string literals.
# bad
# frozen_string_literal: false
 
module Baz
  # ...
end
 
# bad
module Baz
  # ...
end
 
# good
# frozen_string_literal: true
 
module Bar
  # ...
end

Identifies places where $stderr.puts can be replaced by warn. The latter has the advantage of easily being disabled by, the -W0 interpreter flag or setting $VERBOSE to nil.

Example:

# bad
$stderr.puts('hello')
 
# good
warn('hello')