class RuboCop::Cop::Lint::ScriptPermission
This cop checks if a file which has a shebang line as its first line is granted execute permission.
@example
# 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'
Constants
- MSG
- SHEBANG
Public Instance Methods
autocorrect(node)
click to toggle source
# 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)
click to toggle source
# 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
Private Instance Methods
executable?(processed_source)
click to toggle source
# File lib/rubocop/cop/lint/script_permission.rb, line 56 def executable?(processed_source) # Returns true if stat is executable or if the operating system # doesn't distinguish executable files from nonexecutable files. # See at: https://github.com/ruby/ruby/blob/ruby_2_4/file.c#L5362 File.stat(processed_source.file_path).executable? end
format_message_from(processed_source)
click to toggle source
# File lib/rubocop/cop/lint/script_permission.rb, line 63 def format_message_from(processed_source) basename = File.basename(processed_source.file_path) format(MSG, file: basename) end