Module: Overcommit::Utils

Defined in:
lib/overcommit/utils.rb,
lib/overcommit/utils/file_utils.rb,
lib/overcommit/utils/messages_utils.rb

Overview

Utility functions for general use.

Defined Under Namespace

Modules: FileUtils, MessagesUtils Classes: Version

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.log ⇒ Overcommit::Logger

Returns logger with which to send debug output.

Returns:



30
31
32
 
# File 'lib/overcommit/utils.rb', line 30

def log
  @log
end

Class Method Details

.broken_symlink?(file) ⇒ true, false

Returns whether a file is a broken symlink.

Returns:

  • (true, false) 


259
260
261
262
263
 
# File 'lib/overcommit/utils.rb', line 259

def broken_symlink?(file)
  # JRuby's implementation of File.exist? returns true for broken
  # symlinks, so we need use File.size?
  Overcommit::Utils::FileUtils.symlink?(file) && File.size?(file).nil?
end

.camel_case(str) ⇒ Object

Converts a string containing underscores/hyphens/spaces into CamelCase.



93
94
95
 
# File 'lib/overcommit/utils.rb', line 93

def camel_case(str)
  str.split(/_|-| /).map { |part| part.sub(/^\w/, &:upcase) }.join
end

.convert_glob_to_absolute(glob) ⇒ String

Convert a glob pattern to an absolute path glob pattern rooted from the repository root directory.

Parameters:

  • glob (String)

Returns:

  • (String) 


270
271
272
 
# File 'lib/overcommit/utils.rb', line 270

def convert_glob_to_absolute(glob)
  File.join(repo_root, glob)
end

.execute(initial_args, options = {}) ⇒ Overcommit::Subprocess::Result

Execute a command in a subprocess, capturing exit status and output from both standard and error streams.

This is intended to provide a centralized place to perform any checks or filtering of the command before executing it.

The args option provides a convenient way of splitting up long argument lists which would otherwise exceed the maximum command line length of the OS. It will break up the list into chunks and run the command with the same prefix initial_args, finally combining the output together at the end.

This requires that the external command you are running can have its work split up in this way and still produce the same resultant output when outputs of the individual commands are concatenated back together.

Parameters:

  • initial_args (Array<String>)
  • options (Hash) (defaults to: {})

Options Hash (options):

  • :args (Array<String>) —

    long list of arguments to split up

Returns:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/overcommit/utils.rb', line 166

def execute(initial_args, options = {})
  if initial_args.include?('|')
    raise Overcommit::Exceptions::InvalidCommandArgs,
          'Cannot pipe commands with the `execute` helper'
  end

  result =
    if (splittable_args = options.fetch(:args, [])).any?
      debug(initial_args.join(' ') + " ... (#{splittable_args.length} splittable args)")
      Overcommit::CommandSplitter.execute(initial_args, options)
    else
      debug(initial_args.join(' '))
      Overcommit::Subprocess.spawn(initial_args, options)
    end

  debug("EXIT STATUS: #{result.status}")
  debug("STDOUT: #{result.stdout.inspect}")
  debug("STDERR: #{result.stderr.inspect}")

  result
end

.execute_in_background(args) ⇒ ChildProcess

Execute a command in a subprocess, returning immediately.

This provides a convenient way to execute long-running processes for which we do not need to know the result.

Parameters:

  • args (Array<String>)

Returns:

  • (ChildProcess) —

    detached process spawned in the background



195
196
197
198
199
200
201
202
203
 
# File 'lib/overcommit/utils.rb', line 195

def execute_in_background(args)
  if args.include?('|')
    raise Overcommit::Exceptions::InvalidCommandArgs,
          'Cannot pipe commands with the `execute_in_background` helper'
  end

  debug("Spawning background task: #{args.join(' ')}")
  Subprocess.spawn_detached(args)
end

.git_dir ⇒ String

Returns an absolute path to the .git directory for a repo.

Returns:

  • (String) 


59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/overcommit/utils.rb', line 59

def git_dir
  @git_dir ||=
    begin
      result = execute(%w[git rev-parse --git-common-dir])
      unless result.success?
        raise Overcommit::Exceptions::InvalidGitRepo,
              'Unable to determine location of GIT_DIR. ' \
              'Not a recognizable Git repository!'
      end
      File.expand_path(result.stdout.chomp("\n"), Dir.pwd)
    end
end

.in_path?(cmd) ⇒ true, false

Returns whether a command can be found given the current environment path.

Parameters:

  • cmd (String)

Returns:

  • (true, false) —

    whether a command can be found given the current environment path.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/overcommit/utils.rb', line 115

def in_path?(cmd)
  # ENV['PATH'] doesn't include the repo root, but that is a valid
  # location for executables, so we want to add it to the list of places
  # we are checking for the executable.
  paths = [repo_root] + ENV['PATH'].split(File::PATH_SEPARATOR)
  exts  = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
  paths.each do |path|
    exts.each do |ext|
      cmd_with_ext = cmd.upcase.end_with?(ext.upcase) ? cmd : "#{cmd}#{ext}"
      full_path = File.join(path, cmd_with_ext)
      return true if File.executable?(full_path)
    end
  end
  false
end

.matches_path?(pattern, path) ⇒ Boolean

Return whether a pattern matches the given path.

Parameters:

  • pattern (String)
  • path (String)

Returns:

  • (Boolean) 


278
279
280
281
282
283
284
 
# File 'lib/overcommit/utils.rb', line 278

def matches_path?(pattern, path)
  File.fnmatch?(
    pattern, path,
    File::FNM_PATHNAME | # Wildcard doesn't match separator
    File::FNM_DOTMATCH   # Wildcards match dotfiles
  )
end

.parent_command ⇒ Object

Return the parent command that triggered this hook run



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/overcommit/utils.rb', line 132

def parent_command
  if OS.windows?
    `wmic process where ProcessId=#{Process.ppid} get CommandLine /FORMAT:VALUE`.
      strip.
      slice(/(?<=CommandLine=).+/)
  elsif OS.cygwin?
    # Cygwin's `ps` command behaves differently than the traditional
    # Linux version, but a comparable `procps` is provided to compensate.
    `procps -ocommand= -p #{Process.ppid}`.chomp
  else
    `ps -ocommand= -p #{Process.ppid}`.chomp
  end
end

.processor_count ⇒ Object

Return the number of processors used by the OS for process scheduling.

See Also:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/overcommit/utils.rb', line 208

def processor_count # rubocop:disable all
  @processor_count ||=
    begin
      if Overcommit::OS.windows?
        require 'win32ole'
        result = WIN32OLE.connect('winmgmts://').ExecQuery(
          'select NumberOfLogicalProcessors from Win32_Processor'
        )
        result.to_enum.collect(&:NumberOfLogicalProcessors).reduce(:+)
      elsif File.readable?('/proc/cpuinfo')
        IO.read('/proc/cpuinfo').scan(/^processor/).size
      elsif File.executable?('/usr/bin/hwprefs')
        IO.popen('/usr/bin/hwprefs thread_count').read.to_i
      elsif File.executable?('/usr/sbin/psrinfo')
        IO.popen('/usr/sbin/psrinfo').read.scan(/^.*on-*line/).size
      elsif File.executable?('/usr/sbin/ioscan')
        IO.popen('/usr/sbin/ioscan -kC processor') do |out|
          out.read.scan(/^.*processor/).size
        end
      elsif File.executable?('/usr/sbin/pmcycles')
        IO.popen('/usr/sbin/pmcycles -m').read.count("\n")
      elsif File.executable?('/usr/sbin/lsdev')
        IO.popen('/usr/sbin/lsdev -Cc processor -S 1').read.count("\n")
      elsif File.executable?('/usr/sbin/sysctl')
        IO.popen('/usr/sbin/sysctl -n hw.ncpu').read.to_i
      elsif File.executable?('/sbin/sysctl')
        IO.popen('/sbin/sysctl -n hw.ncpu').read.to_i
      else
        # Unknown platform; assume 1 processor
        1
      end
    end
end

.repo_root ⇒ String

Returns an absolute path to the root of the repository.

We do this ourselves rather than call ‘git rev-parse –show-toplevel` to solve an issue where the .git directory might not actually be valid in tests.

Returns:

  • (String) 


43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/overcommit/utils.rb', line 43

def repo_root
  @repo_root ||=
    begin
      result = execute(%w[git rev-parse --show-toplevel])
      unless result.success?
        raise Overcommit::Exceptions::InvalidGitRepo,
              'Unable to determine location of GIT_DIR. ' \
              'Not a recognizable Git repository!'
      end
      result.stdout.chomp("\n")
    end
end

.script_path(script) ⇒ Object 



32
33
34
 
# File 'lib/overcommit/utils.rb', line 32

def script_path(script)
  File.join(Overcommit::HOME, 'libexec', script)
end

.snake_case(str) ⇒ Object

Shamelessly stolen from: stackoverflow.com/questions/1509915/converting-camel-case-to-underscore-case-in-ruby



84
85
86
87
88
89
90
 
# File 'lib/overcommit/utils.rb', line 84

def snake_case(str)
  str.gsub(/::/, '/').
      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
      gsub(/([a-z\d])([A-Z])/, '\1_\2').
      tr('-', '_').
      downcase
end

.strip_color_codes(text) ⇒ String

Remove ANSI escape sequences from a string.

This is useful for stripping colorized output from external tools.

Parameters:

  • text (String)

Returns:

  • (String) 


78
79
80
 
# File 'lib/overcommit/utils.rb', line 78

def strip_color_codes(text)
  text.gsub(/\e\[(\d+)(;\d+)*m/, '')
end

.supported_hook_type_classes ⇒ Object

Returns a list of supported hook classes (PreCommit, CommitMsg, etc.)



106
107
108
109
110
 
# File 'lib/overcommit/utils.rb', line 106

def supported_hook_type_classes
  supported_hook_types.map do |file|
    file.split('-').map(&:capitalize).join
  end
end

.supported_hook_types ⇒ Object

Returns a list of supported hook types (pre-commit, commit-msg, etc.)



98
99
100
101
102
103
 
# File 'lib/overcommit/utils.rb', line 98

def supported_hook_types
  Dir[File.join(HOOK_DIRECTORY, '*')].
    select { |file| File.directory?(file) }.
    reject { |file| File.basename(file) == 'shared' }.
    map { |file| File.basename(file).tr('_', '-') }
end

.with_environment(env) ⇒ Object

Calls a block of code with a modified set of environment variables, restoring them once the code has executed.



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/overcommit/utils.rb', line 244

def with_environment(env)
  old_env = {}
  env.each do |var, value|
    old_env[var] = ENV[var.to_s]
    ENV[var.to_s] = value
  end

  yield
ensure
  old_env.each { |var, value| ENV[var.to_s] = value }
end