Class: SugarJar::Commands

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/sugarjar/commands.rb

Overview

This is the workhorse of SugarJar. Short of #initialize, all other public methods are “commands”. Anything in private is internal implementation details.

Constant Summary collapse

MAIN_BRANCHES = 
%w{master main}.freeze

Instance Method Summary collapse

Methods included from Util

#hub, #hub_nofail, #in_repo, #repo_root, #which, #which_nofail

Constructor Details

#initialize(options) ⇒ Commands

Returns a new instance of Commands.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/sugarjar/commands.rb', line 17

def initialize(options)
  SugarJar::Log.debug("Commands.initialize options: #{options}")
  @ghuser = options['github_user']
  @ghhost = options['github_host']
  @ignore_dirty = options['ignore_dirty']
  @ignore_prerun_failure = options['ignore_prerun_failure']
  @repo_config = SugarJar::RepoConfig.config
  @color = options['color']
  return if options['no_change']

  set_hub_host if @ghhost
  set_commit_template if @repo_config['commit_template']
end

Instance Method Details

#amend(*args) ⇒ Object 



137
138
139
140
141
 
# File 'lib/sugarjar/commands.rb', line 137

def amend(*args)
  assert_in_repo
  # This cannot use shellout since we need a full terminal for the editor
  exit(system(which('git'), 'commit', '--amend', *args))
end

#bclean(name = nil) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sugarjar/commands.rb', line 45

def bclean(name = nil)
  assert_in_repo
  name ||= current_branch
  if clean_branch(name)
    SugarJar::Log.info("#{name}: #{color('reaped', :green)}")
  else
    die(
      "#{color("Cannot clean #{name}", :red)}! there are unmerged " +
      "commits; use 'git branch -D #{name}' to forcefully delete it.",
    )
  end
end

#bcleanall ⇒ Object 



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
 
# File 'lib/sugarjar/commands.rb', line 58

def bcleanall
  assert_in_repo
  curr = current_branch
  all_branches.each do |branch|
    if MAIN_BRANCHES.include?(branch)
      SugarJar::Log.debug("Skipping #{branch}")
      next
    end

    if clean_branch(branch)
      SugarJar::Log.info("#{branch}: #{color('reaped', :green)}")
    else
      SugarJar::Log.info("#{branch}: skipped")
      SugarJar::Log.debug(
        "There are unmerged commits; use 'git branch -D #{branch}' to " +
        'forcefully delete it)',
      )
    end
  end

  # Return to the branch we were on, or main
  if all_branches.include?(curr)
    hub('checkout', curr)
  else
    checkout_main_branch
  end
end

#binfo ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/sugarjar/commands.rb', line 97

def binfo
  assert_in_repo
  SugarJar::Log.info(hub(
    'log', '--graph', '--oneline', '--decorate', '--boundary',
    "#{tracked_branch}.."
  ).stdout.chomp)
end

#br ⇒ Object 



92
93
94
95
 
# File 'lib/sugarjar/commands.rb', line 92

def br
  assert_in_repo
  SugarJar::Log.info(hub('branch', '-v').stdout.chomp)
end

#co(*args) ⇒ Object 



86
87
88
89
90
 
# File 'lib/sugarjar/commands.rb', line 86

def co(*args)
  assert_in_repo
  s = hub('checkout', *args)
  SugarJar::Log.info(s.stderr + s.stdout.chomp)
end

#feature(name, base = nil) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/sugarjar/commands.rb', line 31

def feature(name, base = nil)
  assert_in_repo
  SugarJar::Log.debug("Feature: #{name}, #{base}")
  die("#{name} already exists!") if all_branches.include?(name)
  base ||= most_main
  base_pieces = base.split('/')
  hub('fetch', base_pieces[0]) if base_pieces.length > 1
  hub('checkout', '-b', name, base)
  SugarJar::Log.info(
    "Created feature branch #{color(name, :green)} based on " +
    color(base, :green),
  )
end

#forcepush(remote = nil, branch = nil) ⇒ Object Also known as: fpush 



241
242
243
244
 
# File 'lib/sugarjar/commands.rb', line 241

def forcepush(remote = nil, branch = nil)
  assert_in_repo
  _smartpush(remote, branch, true)
end

#lint ⇒ Object 



224
225
226
227
 
# File 'lib/sugarjar/commands.rb', line 224

def lint
  assert_in_repo
  exit(1) unless run_check('lint')
end

#qamend(*args) ⇒ Object Also known as: amendq 



143
144
145
146
 
# File 'lib/sugarjar/commands.rb', line 143

def qamend(*args)
  assert_in_repo
  SugarJar::Log.info(hub('commit', '--amend', '--no-edit', *args).stdout)
end

#smartclone(repo, dir = nil, *args) ⇒ Object Also known as: sclone 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/sugarjar/commands.rb', line 172

def smartclone(repo, dir = nil, *args)
  # If the user has specified a hub host, set the environment variable
  # since we don't have a repo to configure yet
  ENV['GITHUB_HOST'] = @ghhost if @ghhost

  reponame = File.basename(repo, '.git')
  dir ||= reponame
  SugarJar::Log.info("Cloning #{reponame}...")
  hub('clone', canonicalize_repo(repo), dir, *args)

  Dir.chdir dir do
    # Now that we have a repo, if we have a hub host set it.
    set_hub_host if @ghhost

    org = extract_org(repo)
    SugarJar::Log.debug("Comparing org #{org} to ghuser #{@ghuser}")
    if org == @ghuser
      puts 'Cloned forked or self-owned repo. Not creating "upstream".'
      return
    end

    s = hub_nofail('fork', '--remote-name=origin')
    if s.error?
      if s.stdout.include?('SAML enforcement')
        SugarJar::Log.info(
          'Forking the repo failed because the repo requires SAML ' +
          "authentication. Full output:\n\n\t#{s.stdout}",
        )
        exit(1)
      else
        # In old versions of hub, it would fail if the upstream fork
        # already existed. If we got an error, but didn't recognize
        # that, we'll assume that's what happened and try to add the
        # remote ourselves.
        SugarJar::Log.info("Fork (#{@ghuser}/#{reponame}) detected.")
        SugarJar::Log.debug(
          'The above is a bit of a lie. "hub" failed to fork and it was ' +
          'not a SAML error, so our best guess is that a fork exists ' +
          'and so we will try to configure it.',
        )
        hub('remote', 'rename', 'origin', 'upstream')
        hub('remote', 'add', 'origin', forked_repo(repo, @ghuser))
      end
    else
      SugarJar::Log.info("Forked #{reponame} to #{@ghuser}")
    end
    SugarJar::Log.info('Remotes "origin" and "upstream" configured.')
  end
end

#smartlog ⇒ Object Also known as: sl

binfo for all branches



106
107
108
109
110
111
112
 
# File 'lib/sugarjar/commands.rb', line 106

def smartlog
  assert_in_repo
  SugarJar::Log.info(hub(
    'log', '--graph', '--oneline', '--decorate', '--boundary',
    '--branches', "#{most_main}.."
  ).stdout.chomp)
end

#smartpullrequest ⇒ Object Also known as: spr, smartpr 



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/sugarjar/commands.rb', line 253

def smartpullrequest
  assert_in_repo
  if dirty?
    SugarJar::Log.warn(
      'Your repo is dirty, so I am not going to create a pull request. ' +
      'You should commit or amend and push it to your remote first.',
    )
    exit(1)
  end
  system(which('hub'), 'pull-request')
end

#smartpush(remote = nil, branch = nil) ⇒ Object Also known as: spush 



234
235
236
237
 
# File 'lib/sugarjar/commands.rb', line 234

def smartpush(remote = nil, branch = nil)
  assert_in_repo
  _smartpush(remote, branch, false)
end

#unit ⇒ Object 



229
230
231
232
 
# File 'lib/sugarjar/commands.rb', line 229

def unit
  assert_in_repo
  exit(1) unless run_check('unit')
end

#up ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/sugarjar/commands.rb', line 116

def up
  assert_in_repo
  # get a copy of our current branch, if rebase fails, we won't
  # be able to determine it without backing out
  curr = current_branch
  result = gitup
  if result['so'].error?
    die(
      "#{color(curr, :red)}: Failed to rebase on " +
      "#{result['base']}. Leaving the repo as-is. You can get out of " +
      'this with a `git rebase --abort`. Output from failed rebase is: ' +
      "\nSTDOUT:\n#{result['so'].stdout.lines.map { |x| "\t#{x}" }.join}" +
      "\nSTDERR:\n#{result['so'].stderr.lines.map { |x| "\t#{x}" }.join}",
    )
  else
    SugarJar::Log.info(
      "#{color(current_branch, :green)} rebased on #{result['base']}",
    )
  end
end

#upall ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/sugarjar/commands.rb', line 150

def upall
  assert_in_repo
  all_branches.each do |branch|
    next if MAIN_BRANCHES.include?(branch)

    hub('checkout', branch)
    result = gitup
    if result['so'].error?
      SugarJar::Log.error(
        "#{color(branch, :red)} failed rebase. Reverting attempt and " +
        'moving to next branch. Try `sj up` manually on that branch.',
      )
      hub('rebase', '--abort')
    else
      SugarJar::Log.info(
        "#{color(branch, :green)} rebased on " +
        color(result['base'], :green).to_s,
      )
    end
  end
end

#version ⇒ Object 



248
249
250
251
 
# File 'lib/sugarjar/commands.rb', line 248

def version
  puts "sugarjar version #{SugarJar::VERSION}"
  puts hub('version').stdout
end