Module: SugarJar::Util

Included in:
Commands, RepoConfig
Defined in:
lib/sugarjar/util.rb

Overview

Some common methods needed by other classes

Instance Method Summary collapse

Instance Method Details

#gh(*args) ⇒ Object 



123
124
125
126
127
 
# File 'lib/sugarjar/util.rb', line 123

def gh(*args)
  s = gh_nofail(*args)
  s.error!
  s
end

#gh_nofail(*args) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/sugarjar/util.rb', line 103

def gh_nofail(*args)
  SugarJar::Log.trace("Running: gh #{args.join(' ')}")
  s = Mixlib::ShellOut.new([which('gh')] + args).run_command
  if s.error? && s.stderr.include?('gh auth')
    SugarJar::Log.info(
      'gh was run but no github token exists. Will run "gh auth login" ' +
      "to force\ngh to authenticate...",
    )
    unless system(which('gh'), 'auth', 'login', '-p', 'ssh')
      SugarJar::Log.fatal(
        'That failed, I will bail out. Hub needs to get a github ' +
        'token. Try running "gh auth login" (will list info about ' +
        'your account) and try this again when that works.',
      )
      exit(1)
    end
  end
  s
end

#git(*args) ⇒ Object 



40
41
42
43
44
 
# File 'lib/sugarjar/util.rb', line 40

def git(*args)
  s = git_nofail(*args)
  s.error!
  s
end

#git_nofail(*args) ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/sugarjar/util.rb', line 31

def git_nofail(*args)
  if %w{diff log grep branch}.include?(args[0]) &&
     args.none? { |x| x.include?('color') }
    args << (@color ? '--color' : '--no-color')
  end
  SugarJar::Log.trace("Running: git #{args.join(' ')}")
  Mixlib::ShellOut.new([which('git')] + args).run_command
end

#hub(*args) ⇒ Object 



97
98
99
100
101
 
# File 'lib/sugarjar/util.rb', line 97

def hub(*args)
  s = hub_nofail(*args)
  s.error!
  s
end

#hub_nofail(*args) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/sugarjar/util.rb', line 46

def hub_nofail(*args)
  # this allows us to use 'hub' stuff that's top-level, but is under
  # repo for this.
  args.delete_at(0) if args[0] == 'repo'
  SugarJar::Log.trace("Running: hub #{args.join(' ')}")
  s = Mixlib::ShellOut.new([which('hub')] + args).run_command
  if s.error?
    # depending on hub version and possibly other things, STDERR
    # is either "Requires authentication" or "Must authenticate"
    case s.stderr
    when /^(Must|Requires) authenticat/
      SugarJar::Log.info(
        'Hub was run but no github token exists. Will run "hub api user" ' +
        "to force\nhub to authenticate...",
      )
      unless system(which('hub'), 'api', 'user')
        SugarJar::Log.fatal(
          'That failed, I will bail out. Hub needs to get a github ' +
          'token. Try running "hub api user" (will list info about ' +
          'your account) and try this again when that works.',
        )
        exit(1)
      end
      SugarJar::Log.info('Re-running original hub command...')
      s = Mixlib::ShellOut.new([which('hub')] + args).run_command
    when /^fatal: could not read Username/, /Anonymous access denied/

      # On http(s) URLs, git may prompt for username/passwd
      SugarJar::Log.info(
        'Hub was run but git prompted for authentication. This probably ' +
        "means you have\nused an http repo URL instead of an ssh one. It " +
        "is recommended you reclone\nusing 'sj sclone' to setup your " +
        "remotes properly. However, in the meantime,\nwe'll go ahead " +
        "and re-run the command in a shell so you can type in the\n" +
        'credentials.',
      )
      unless system(which('hub'), *args)
        SugarJar::Log.fatal(
          'That failed, I will bail out. You can either manually change ' +
          'your remotes, or simply create a fresh clone with ' +
          '"sj smartclone".',
        )
        exit(1)
      end
      SugarJar::Log.info('Re-running original hub command...')
      s = Mixlib::ShellOut.new([which('hub')] + args).run_command
    end
  end
  s
end

#in_repo ⇒ Object 



129
130
131
132
 
# File 'lib/sugarjar/util.rb', line 129

def in_repo
  s = git_nofail('rev-parse', '--is-inside-work-tree')
  !s.error? && s.stdout.strip == 'true'
end

#repo_name ⇒ Object 



138
139
140
 
# File 'lib/sugarjar/util.rb', line 138

def repo_name
  repo_root.split('/').last
end

#repo_root ⇒ Object 



134
135
136
 
# File 'lib/sugarjar/util.rb', line 134

def repo_root
  git('rev-parse', '--show-toplevel').stdout.strip
end

#which(cmd) ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/sugarjar/util.rb', line 23

def which(cmd)
  path = which_nofail(cmd)
  return path if path

  SugarJar::Log.fatal("Could not find #{cmd} in your path")
  exit(1)
end

#which_nofail(cmd) ⇒ Object

Finds the first entry in the path for a binary and checks to make sure it’s not us (i.e. we may be linked to as ‘git’ or ‘hub’, but when we are calling that, we don’t want ourselves.



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/sugarjar/util.rb', line 11

def which_nofail(cmd)
  ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
    p = File.join(dir, cmd)
    # if it exists, and it is executable and is not us...
    if File.exist?(p) && File.executable?(p) &&
       File.basename(File.realpath(p)) != 'sj'
      return p
    end
  end
  false
end