123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::CommandLiteral

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::ConfigurableEnforcedStyle, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/command_literal.rb

Overview

Enforces using `` or %x around command literals.

Examples:

EnforcedStyle: backticks (default)

# bad
folders = %x(find . -type d).split

# bad
%x(
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
)

# good
folders = `find . -type d`.split

# good
`
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
`

EnforcedStyle: mixed

# bad
folders = %x(find . -type d).split

# bad
`
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
`

# good
folders = `find . -type d`.split

# good
%x(
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
)

EnforcedStyle: percent_x

# bad
folders = `find . -type d`.split

# bad
`
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
`

# good
folders = %x(find . -type d).split

# good
%x(
  ln -s foo.example.yml foo.example
  ln -s bar.example.yml bar.example
)

AllowInnerBackticks: false (default)

# If `false`, the cop will always recommend using `%x` if one or more
# backticks are found in the command string.

# bad
`echo \`ls\``

# good
%x(echo `ls`)

AllowInnerBackticks: true

# good
`echo \`ls\``

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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::ConfigurableEnforcedStyle - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::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, #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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #surrounding_heredoc, #surrounding_percent_array

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Attribute Details

#allow_inner_backticks? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 146



def allow_inner_backticks?
  cop_config['AllowInnerBackticks']
end


  







Instance Method Details



  

    #allowed_backtick_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 122



def allowed_backtick_literal?(node)
  case style
  when :backticks
    !contains_disallowed_backtick?(node)
  when :mixed
    node.single_line? && !contains_disallowed_backtick?(node)
  end
end


  








  

    #allowed_percent_x_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 131



def allowed_percent_x_literal?(node)
  case style
  when :backticks
    contains_disallowed_backtick?(node)
  when :mixed
    node.multiline? || contains_disallowed_backtick?(node)
  when :percent_x
    true
  end
end


  








  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 109



def autocorrect(corrector, node)
  return if contains_backtick?(node)

  replacement = if backtick_literal?(node)
                  ['%x', ''].zip(preferred_delimiter).map(&:join)
                else
                  %w[` `]
                end

  corrector.replace(node.loc.begin, replacement.first)
  corrector.replace(node.loc.end, replacement.last)
end


  








  

    #backtick_literal?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 159



def backtick_literal?(node)
  node.loc.begin.source == '`'
end


  








  

    #check_backtick_literal(node, message)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 97



def check_backtick_literal(node, message)
  return if allowed_backtick_literal?(node)

  add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
end


  








  

    #check_percent_x_literal(node, message)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 103



def check_percent_x_literal(node, message)
  return if allowed_percent_x_literal?(node)

  add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
end


  








  

    #command_delimiter   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 167



def command_delimiter
  preferred_delimiters_config['%x']
end


  








  

    #contains_backtick?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 150



def contains_backtick?(node)
  node_body(node).include?('`')
end


  








  

    #contains_disallowed_backtick?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 142



def contains_disallowed_backtick?(node)
  !allow_inner_backticks? && contains_backtick?(node)
end


  








  

    #default_delimiter   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 171



def default_delimiter
  preferred_delimiters_config['default']
end


  








  

    #node_body(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 154



def node_body(node)
  loc = node.loc
  loc.expression.source[loc.begin.length...-loc.end.length]
end


  








  

    #on_xstr(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 85



def on_xstr(node)
  return if node.heredoc?

  if backtick_literal?(node)
    check_backtick_literal(node, MSG_USE_PERCENT_X)
  else
    check_percent_x_literal(node, MSG_USE_BACKTICKS)
  end
end


  








  

    #preferred_delimiter   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 163



def preferred_delimiter
  (command_delimiter || default_delimiter).chars
end


  








  

    #preferred_delimiters_config   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/command_literal.rb', line 175



def preferred_delimiters_config
  config.for_cop('Style/PercentLiteralDelimiters') ['PreferredDelimiters']
end