Class: RuboCop::Cop::Style::FileWrite
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::RangeHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/file_write.rb |
Overview
Favor File.(bin)write
convenience methods.
Note
|
There are different method signatures between File.write (class method)
and File#write (instance method). The following case will be allowed because
static analysis does not know the contents of the splat argument:
|
File.open(filename, 'w') do |f|
f.write(*objects)
end
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/file_write.rb', line 42'Use `File.%<write_method>s`.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/file_write.rb', line 44%i[open].to_set.freeze
-
TRUNCATING_WRITE_MODES =
# File 'lib/rubocop/cop/style/file_write.rb', line 46%w[w wt wb w+ w+t w+b].to_set.freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #block_write?(node)
- #evidence(node)
- #file_open?(node)
- #on_send(node)
- #send_write?(node)
- #file_open_write?(node) {|content| ... } ⇒ Boolean private
- #heredoc?(write_node) ⇒ Boolean private
- #heredoc_range(first_argument) private
- #replacement(mode, filename, content, write_node) private
- #write_method(mode) private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#block_write?(node)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 65
def_node_matcher :block_write?, <<~PATTERN (block _ (args (arg $_)) (send (lvar $_) :write $_)) PATTERN
#evidence(node)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 82
def evidence(node) file_open?(node) do |filename, mode| file_open_write?(node.parent) do |content| yield(filename, mode, content, node.parent) end end end
#file_open?(node)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 49
def_node_matcher :file_open?, <<~PATTERN (send (const {nil? cbase} :File) :open $_ (str $%TRUNCATING_WRITE_MODES) (block-pass (sym :write))? ) PATTERN
#file_open_write?(node) {|content| ... } ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/file_write.rb', line 92
def file_open_write?(node) content = send_write?(node) || block_write?(node) do |block_arg, lvar, write_arg| write_arg if block_arg == lvar end return false if content&.splat_type? yield(content) if content end
#heredoc?(write_node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/file_write.rb', line 120
def heredoc?(write_node) write_node.block_type? && (first_argument = write_node.body.first_argument) && first_argument.respond_to?(:heredoc?) && first_argument.heredoc? end
#heredoc_range(first_argument) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 125
def heredoc_range(first_argument) range_between( first_argument.loc.heredoc_body.begin_pos, first_argument.loc.heredoc_end.end_pos ) end
#on_send(node)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 69
def on_send(node) evidence(node) do |filename, mode, content, write_node| = format(MSG, write_method: write_method(mode)) add_offense(write_node, message: ) do |corrector| range = range_between(node.loc.selector.begin_pos, write_node.source_range.end_pos) replacement = replacement(mode, filename, content, write_node) corrector.replace(range, replacement) end end end
#replacement(mode, filename, content, write_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 105
def replacement(mode, filename, content, write_node) replacement = "#{write_method(mode)}(#{filename.source}, #{content.source})" if heredoc?(write_node) first_argument = write_node.body.first_argument <<~REPLACEMENT.chomp #{replacement} #{heredoc_range(first_argument).source} REPLACEMENT else replacement end end
#send_write?(node)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 60
def_node_matcher :send_write?, <<~PATTERN (send _ :write $_) PATTERN
#write_method(mode) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/file_write.rb', line 101
def write_method(mode) mode.end_with?('b') ? :binwrite : :write end