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

Inherits:
Cop
  • Object
show all
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.

Examples:

# bad

# A file which has a shebang line as its first line is not
# granted execute permission.

#!/usr/bin/env ruby
puts 'hello, world'

# good

# A file which has a shebang line as its first line is
# granted execute permission.

#!/usr/bin/env ruby
puts 'hello, world'

# good

# A file which has not a shebang line as its first line is not
# granted execute permission.

puts 'hello, world'

Constant Summary collapse

MSG =
"Script file %<file>s doesn't have execute permission."
SHEBANG =
'#!'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, 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


48
49
50
51
52
# File 'lib/rubocop/cop/lint/script_permission.rb', line 48

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

#investigate(processed_source) ⇒ Object


37
38
39
40
41
42
43
44
45
46
# File 'lib/rubocop/cop/lint/script_permission.rb', line 37

def investigate(processed_source)
  return if @options.key?(:stdin)
  return if Platform.windows?
  return unless processed_source.start_with?(SHEBANG)
  return if executable?(processed_source)

  comment = processed_source.comments[0]
  message = format_message_from(processed_source)
  add_offense(comment, message: message)
end