class RuboCop::Cop::Lint::ToJSON

This cop checks to make sure `#to_json` includes an optional argument. When overriding `#to_json`, callers may invoke JSON generation via `JSON.generate(your_obj)`. Since `JSON#generate` allows for an optional argument, your method should too.

@example

# bad
def to_json
end

# good
def to_json(*_args)
end

Constants

MSG

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/lint/to_json.rb, line 30
def autocorrect(node)
  lambda do |corrector|
    # The following used `*_args` because `to_json(*args)` has
    # an offense of `Lint/UnusedMethodArgument` cop if `*args`
    # is not used.
    corrector.insert_after(node.loc.name, '(*_args)')
  end
end
on_def(node) click to toggle source
# File lib/rubocop/cop/lint/to_json.rb, line 24
def on_def(node)
  return unless node.method?(:to_json) && node.arguments.empty?

  add_offense(node)
end