Sha256: c859f146f6a857873c4d62ba37eebd06286f065023b6da2c2fe7d657083ca50d
Contents?: true
Size: 966 Bytes
Versions: 6758
Compression:
Stored size: 966 Bytes
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# 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(_opts)
# end
#
class ToJSON < Cop
MSG = ' `#to_json` requires an optional argument to be parsable ' \
'via JSON.generate(obj).'.freeze
def on_def(node)
return unless node.method?(:to_json) && node.arguments.empty?
add_offense(node)
end
def autocorrect(node)
lambda do |corrector|
corrector.insert_after(node.loc.name, '(_opts)')
end
end
end
end
end
end
Version data entries
6,758 entries across 6,754 versions & 23 rubygems