123456789_123456789_123456789_123456789_123456789_

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:
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

Examples:

## text mode
# bad
File.open(filename, 'w').write(content)
File.open(filename, 'w') do |f|
  f.write(content)
end

# good
File.write(filename, content)
## binary mode
# bad
File.open(filename, 'wb').write(content)
File.open(filename, 'wb') do |f|
  f.write(content)
end

# good
File.binwrite(filename, content)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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 on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

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 an 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

Instance Method Summary

::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#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

::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 68

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 85

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 52

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)

Yields:

  • (content)
[ GitHub ]

  
# File 'lib/rubocop/cop/style/file_write.rb', line 95

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)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/file_write.rb', line 123

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 128

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 72

def on_send(node)
  evidence(node) do |filename, mode, content, write_node|
    message = format(MSG, write_method: write_method(mode))

    add_offense(write_node, message: 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 108

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 63

def_node_matcher :send_write?, <<~PATTERN
  (send _ :write $_)
PATTERN

#write_method(mode) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/file_write.rb', line 104

def write_method(mode)
  mode.end_with?('b') ? :binwrite : :write
end