Class: RuboCop::Cop::Lint::ToJSON

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/to_json.rb

Overview

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.

Examples:

# bad
def to_json
end

# good
def to_json(_opts)
end

Constant Summary collapse

MSG = 
' `#to_json` requires an optional argument to be parsable ' \
'via JSON.generate(obj).'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



30
31
32
33
34
 
# File 'lib/rubocop/cop/lint/to_json.rb', line 30

def autocorrect(node)
  lambda do |corrector|
    corrector.insert_after(node.loc.name, '(_opts)')
  end
end

#on_def(node) ⇒ Object 



24
25
26
27
28
 
# 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