Class: RuboCop::Cop::FormulaAudit::InstallSteps Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Includes:
InstallStepsHelper
Defined in:
rubocops/install_steps.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This cop checks declarative install step usage.

Constant Summary collapse

CONFLICT_MSG =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"`post_install` and `post_install_steps` cannot both be used."
LEGACY_POST_INSTALL_MSG =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"Formulae in official Homebrew taps must use `post_install_steps` instead of `post_install`."
REDUNDANT_SERVICE_PATH_DIRS_MSG =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"`%<block>s` only creates directories created by `brew services`."
EXPLICIT_BASE_MSG =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"Formula install-step paths must specify their base explicitly."
EXPLICIT_BASE_STEP_METHODS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

[:if_path_exists, :unless_path_exists, :mkdir, :mkdir_p, :touch, :remove,
:inreplace, :write, :write_file, :init_data_dir, :set_permissions].freeze
RUN_PATH_KEYWORDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

[:stdin_path, :stdout_path, :chdir].freeze
ABSOLUTE_PATH_TEMPLATE_TOKENS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

%w[
  HOMEBREW_PREFIX HOMEBREW_CELLAR prefix opt_prefix bin sbin lib libexec share pkgshare var etc pkgetc rack
  staged_path appdir caskroom_path temp bash_completion zsh_completion fish_completion pwsh_completion
].freeze
CERTIFICATE_REMOVE_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

'rm(pkgetc/"cert.pem") if (pkgetc/"cert.pem").exist?'
'pkgetc.install_symlink Formula["ca-certificates"].pkgetc/"cert.pem"'
GITHUB_ACTIONS_GUARD_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"return if ENV[\"HOMEBREW_GITHUB_ACTIONS\"]"
MYSQL_FORMULA_CLASS_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

/\AMysql(?:AT\d+)?\z/
MYSQL_DATADIR_METHOD_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"def datadir var/\"mysql\" end"
MYSQL_INITIALISE_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let(
  <<~'RUBY'.gsub(/\s+/, " ").strip.freeze,
  String,
)
MARIADB_INITIALISE_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let(
  <<~'RUBY'.gsub(/\s+/, " ").strip.freeze,
  String,
)
POSTGRESQL_DATADIR_METHOD_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"def postgresql_datadir var/name end"
POSTGRESQL_MARKER_METHOD_SOURCE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"def pg_version_exists? (postgresql_datadir/\"PG_VERSION\").exist? end"
POSTGRESQL_INIT_SOURCE_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

Regexp.new(
  '\Asystem bin/"initdb", "--locale=(C|en_US\\.UTF-8)", "-E", "UTF-8", ' \
  'postgresql_datadir unless pg_version_exists\\?\\z',
).freeze
T.let(
  <<~RUBY.gsub(/\s+/, " ").strip.freeze,
  String,
)
"bin.each_child { |f| (HOMEBREW_PREFIX/\"bin\").install_symlink " \
"f => \"\#{f.basename}-\#{version.major}\" }"

Constants included from InstallStepsHelper

InstallStepsHelper::ALLOWED_STEP_ARGUMENT_NODE_TYPES, InstallStepsHelper::ALLOWED_STEP_METHODS, InstallStepsHelper::BREW_RUBY_STEP_MSG, InstallStepsHelper::CASK_ALLOWED_STEP_METHODS, InstallStepsHelper::COMMAND_STEP_METHODS, InstallStepsHelper::COMPATIBILITY_STEP_KEYWORD_REPLACEMENTS, InstallStepsHelper::COMPATIBILITY_STEP_METHODS, InstallStepsHelper::COMPATIBILITY_STEP_METHOD_REPLACEMENTS, InstallStepsHelper::CONFIG_WRITE_STEP_METHODS, InstallStepsHelper::FILE_PREPARATION_STEP_METHODS, InstallStepsHelper::FORMULA_ACTION_STEP_METHODS, InstallStepsHelper::KEYCHAIN_STEP_METHODS, InstallStepsHelper::LEGACY_STEP_KEYWORD_MSG, InstallStepsHelper::LEGACY_STEP_METHOD_MSG, InstallStepsHelper::LINK_STEP_METHODS, InstallStepsHelper::MACHO_STEP_METHODS, InstallStepsHelper::NOTICE_STEP_METHODS, InstallStepsHelper::OFFICIAL_HOMEBREW_TAP_PATH_REGEX, InstallStepsHelper::PERMISSION_STEP_METHODS, InstallStepsHelper::REBUILD_ACTION_STEP_LINES, InstallStepsHelper::REBUILD_ACTION_STEP_METHODS, InstallStepsHelper::SERVICE_DATA_STEP_METHODS, InstallStepsHelper::SIMPLE_STEP_CONVERSION_MSG, InstallStepsHelper::STEP_BLOCK_MSG, InstallStepsHelper::STEP_SCOPE_METHODS

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods included from InstallStepsHelper

#add_compatibility_step_offenses, #append_install_step_lines, #brew_ruby_step_node, #direct_install_step_nodes, #install_step_block_offense_node, #install_steps_block_source, #normalised_install_step_source, #official_homebrew_tap?, #simple_install_step_lines, #step_block_msg

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #caveats_strings, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #style_exceptions_dir, #tap_style_exception?, #versioned_formula?

Methods included from HelperFunctions

#block_method_called_in_block?, #check_precedence, #class_name, #component_precedes?, descendant_send_nodes, descendant_send_nodes_by_method_name, #end_column, #expression_negated?, #find_all_blocks, #find_block, #find_blocks, #find_const, #find_every_func_call_by_name, #find_every_method_call_by_name, #find_instance_call, #find_instance_method_call, #find_method_calls_by_name, #find_method_def, #find_method_with_args, #find_node_method_by_name, #find_strings, #format_component, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_name, #node_equals?, #offending_node, #parameters, #parameters_passed?, #problem, #regex_match_group, #source_buffer, #start_column, #string_content

Instance Method Details

#audit_formula(formula_nodes) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'rubocops/install_steps.rb', line 85

def audit_formula(formula_nodes)
  return if (body_node = formula_nodes.body_node).nil?

  service_path_dirs = service_path_dirs(find_block(body_node, :service))
  post_install_steps_block = find_block(body_node, :post_install_steps)
  post_install_method = find_method_def(body_node, :post_install)

  if post_install_steps_block && post_install_method
    offending_node(post_install_steps_block)
    problem CONFLICT_MSG
  end

  redundant_post_install_steps = post_install_steps_block.present? &&
                                 redundant_service_path_dirs_block?(post_install_steps_block,
                                                                    service_path_dirs,
                                                                    :post_install_steps)
  audit_step_block(post_install_steps_block) unless redundant_post_install_steps
  add_redundant_service_path_dirs_offense(post_install_steps_block, service_path_dirs, :post_install_steps)
  redundant_post_install = post_install_method.present? &&
                           redundant_service_path_dirs_block?(post_install_method, service_path_dirs,
                                                              :post_install)
  add_redundant_service_path_dirs_offense(post_install_method, service_path_dirs, :post_install)
  return if redundant_post_install

  converted_post_install = autocorrect_post_install_method?(post_install_method, post_install_steps_block,
                                                            body_node, formula_nodes.class_node.const_name)
  # odeprecated: remove the official-tap scope in the next major or minor release.
  return unless official_homebrew_tap?(processed_source.file_path)
  return if post_install_method.nil? || converted_post_install

  add_offense(post_install_method, message: LEGACY_POST_INSTALL_MSG)
end