Module: Lolcommits::CLI::Fatals

Includes:
Lolcommits
Defined in:
lib/lolcommits/cli/fatals.rb

Overview

Helper methods for failing on error conditions in the lolcommits CLI.

Constant Summary

Constants included from Lolcommits

GEM_NAME, VERSION

Class Method Summary collapse

Class Method Details

.die_if_no_valid_ffmpeg_installed! ⇒ Object

Die with an informative error message if ffmpeg is not installed. This is only used for certain functions (such as animation), so only run this when you know the user wants to perform one of them.



52
53
54
55
56
57
 
# File 'lib/lolcommits/cli/fatals.rb', line 52

def self.die_if_no_valid_ffmpeg_installed!
  return if Platform.valid_ffmpeg_installed?

  fatal 'FATAL: ffmpeg does not appear to be properly installed!'
  exit 1
end

.die_if_not_vcs_repo! ⇒ Object

If we are not in a git repo, we can’t do git related things! Die with an informative error message in that case.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/lolcommits/cli/fatals.rb', line 61

def self.die_if_not_vcs_repo!
  debug 'Checking for valid VCS repo'
  current = File.expand_path('.')
  parent = File.dirname(current)
  while current != parent
    return if VCSInfo.repo_root?(current)

    current = parent
    parent = File.dirname(current)
  end
  fatal "You don't appear to be in a directory of a supported vcs project."
  exit 1
end

.die_on_fatal_platform_conditions! ⇒ Object

Check for platform related conditions that could prevent lolcommits from working properly.

Die with an informative error message if any occur.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/lolcommits/cli/fatals.rb', line 16

def self.die_on_fatal_platform_conditions!
  # make sure the capture binaries are in a good state
  if Platform.platform_mac?
    %w(imagesnap videosnap).each do |executable|
      next if File.executable? File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', executable, executable)

      fatal "Couldn't properly execute #{executable} for some reason, " \
            'please file a bug?!'
      exit 1
    end
  elsif Platform.platform_linux?
    unless Platform.command_which('mplayer')
      fatal "Couldn't find mplayer in your PATH!"
      exit 1
    end
  end

  # make sure imagemagick is around and good to go
  unless Platform.valid_imagemagick_installed?
    fatal 'FATAL: ImageMagick does not appear to be properly installed!' \
          '(or version is too old)'
    exit 1
  end

  # check for a error condition with git config affecting ruby-git
  return unless Platform.git_config_color_always?

  fatal 'Due to a bug in the ruby-git library, git config for color.ui ' \
        "cannot be set to 'always'."
  fatal "Try setting it to 'auto' instead!"
  exit 1
end