Class: RuboCop::Cop::Lint::ScriptPermission

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Lint::ScriptPermission

Defined in:

lib/rubocop/cop/lint/script_permission.rb

Overview

This cop checks if a file which has a shebang line as its first line is granted execute permission.

Constant Summary

MSG =

"Script file %s doesn't have execute permission.".freeze

SHEBANG =

'#!'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #investigate(processed_source) ⇒ Object

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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, 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

# File 'lib/rubocop/cop/lint/script_permission.rb', line 22

def autocorrect(node)
  lambda do |_corrector|
    FileUtils.chmod('+x', node.loc.expression.source_buffer.name)
  end
end

#investigate(processed_source) ⇒ Object

# File 'lib/rubocop/cop/lint/script_permission.rb', line 12

def investigate(processed_source)
  return if @options.key?(:stdin)
  return if Platform.windows?
  return unless start_with_shebang?(processed_source)
  return if executable?(processed_source)
  comment = processed_source.comments[0]
  message = format_message_from(processed_source)
  add_offense(comment, message: message)
end