Module: GitReflow::GitHelpers

Includes:
Sandbox
Included in:
GitReflow, GitReflow::GitServer::Base, GitReflow::GitServer::GitHub, Workflow::ClassMethods
Defined in:
lib/git_reflow/git_helpers.rb

Overview

Includes many helper methods for common tasks within a git repository.

Constant Summary

Constants included from Sandbox

Sandbox::COLOR_FOR_LABEL

Instance Method Summary collapse

Methods included from Sandbox

#run, #run_command_with_label, #say

Instance Method Details

#append_to_merge_commit_message(message = '', merge_method: "squash") ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/git_reflow/git_helpers.rb', line 117

def append_to_merge_commit_message(message = '', merge_method: "squash")
  tmp_merge_message_path  = "#{git_root_dir}/.git/tmp_merge_msg"
  dest_merge_message_path = merge_message_path(merge_method: merge_method)

  run "touch #{tmp_merge_message_path}"

  File.open(tmp_merge_message_path, "w") do |file_content|
    file_content.puts message
    if File.exists? dest_merge_message_path
      File.foreach(dest_merge_message_path) do |line|
        file_content.puts line
      end
    end
  end

  run "mv #{tmp_merge_message_path} #{dest_merge_message_path}"
end

#current_branch ⇒ Object 



47
48
49
 
# File 'lib/git_reflow/git_helpers.rb', line 47

def current_branch
  run("git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'", loud: false).strip
end

#default_base_branch ⇒ Object 



41
42
43
44
45
 
# File 'lib/git_reflow/git_helpers.rb', line 41

def default_base_branch
  base_branch_name = GitReflow::Config.get('reflow.base-branch')
  return 'master' if base_branch_name.empty?
  base_branch_name
end

#default_editor ⇒ Object 



11
12
13
 
# File 'lib/git_reflow/git_helpers.rb', line 11

def default_editor
  ENV['EDITOR'] || 'vi'
end

#fetch_destination(destination_branch) ⇒ Object 



94
95
96
 
# File 'lib/git_reflow/git_helpers.rb', line 94

def fetch_destination(destination_branch)
  run_command_with_label "git fetch origin #{destination_branch}"
end

#get_first_commit_message ⇒ Object 



79
80
81
 
# File 'lib/git_reflow/git_helpers.rb', line 79

def get_first_commit_message
  run('git log --pretty=format:"%s" --no-merges -n 1', loud: false).strip
end

#git_editor_command ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/git_reflow/git_helpers.rb', line 22

def git_editor_command
  git_editor = GitReflow::Config.get('core.editor')
  if !git_editor.empty?
    git_editor
  else
    default_editor
  end
end

#git_root_dir ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/git_reflow/git_helpers.rb', line 15

def git_root_dir
  return @git_root_dir unless @git_root_dir.to_s.empty?
  return @git_root_dir = Dir.pwd if Dir.exists?("#{Dir.pwd}/.git")

  @git_root_dir = run('git rev-parse --show-toplevel', loud: false).strip
end

#merge_commit_template ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/git_reflow/git_helpers.rb', line 66

def merge_commit_template
  custom_template = GitReflow::Config.get('templates.merge-commit')
  filenames_to_try = %w[.github/MERGE_COMMIT_TEMPLATE.md
                        .github/MERGE_COMMIT_TEMPLATE
                        MERGE_COMMIT_TEMPLATE.md
                        MERGE_COMMIT_TEMPLATE].map do |file|
    "#{git_root_dir}/#{file}"
  end
  filenames_to_try.unshift(custom_template) unless custom_template.empty?

  parse_first_matching_template_file(filenames_to_try)
end

#merge_message_path(merge_method: nil) ⇒ Object 



135
136
137
138
139
140
141
142
143
 
# File 'lib/git_reflow/git_helpers.rb', line 135

def merge_message_path(merge_method: nil)
  merge_method = merge_method || GitReflow::Config.get("reflow.merge-method")
  merge_method = "squash" if "#{merge_method}".length < 1
  if merge_method =~ /squash/i
    "#{git_root_dir}/.git/SQUASH_MSG"
  else
    "#{git_root_dir}/.git/MERGE_MSG"
  end
end

#pull_request_template ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/git_reflow/git_helpers.rb', line 51

def pull_request_template
  custom_template = GitReflow::Config.get('templates.pull-request')
  filenames_to_try = %w[
    .github/PULL_REQUEST_TEMPLATE.md
    .github/PULL_REQUEST_TEMPLATE
    PULL_REQUEST_TEMPLATE.md
    PULL_REQUEST_TEMPLATE
  ].map do |file|
    "#{git_root_dir}/#{file}"
  end
  filenames_to_try.unshift(custom_template) unless custom_template.empty?

  parse_first_matching_template_file(filenames_to_try)
end

#push_current_branch(options = {}) ⇒ Object 



83
84
85
86
 
# File 'lib/git_reflow/git_helpers.rb', line 83

def push_current_branch(options = {})
  remote = options[:remote] || 'origin'
  run_command_with_label "git push #{remote} #{current_branch}"
end

#remote_repo_name ⇒ Object 



36
37
38
39
 
# File 'lib/git_reflow/git_helpers.rb', line 36

def remote_repo_name
  return '' if GitReflow::Config.get('remote.origin.url').empty?
  extract_remote_user_and_repo_from_remote_url(GitReflow::Config.get('remote.origin.url'))[:repo]
end

#remote_user ⇒ Object 



31
32
33
34
 
# File 'lib/git_reflow/git_helpers.rb', line 31

def remote_user
  return '' if GitReflow::Config.get('remote.origin.url').empty?
  extract_remote_user_and_repo_from_remote_url(GitReflow::Config.get('remote.origin.url'))[:user]
end

#update_current_branch(options = {}) ⇒ Object 



88
89
90
91
92
 
# File 'lib/git_reflow/git_helpers.rb', line 88

def update_current_branch(options = {})
  remote = options[:remote] || 'origin'
  run_command_with_label "git pull #{remote} #{current_branch}"
  push_current_branch(options)
end

#update_destination(destination_branch, options = {}) ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/git_reflow/git_helpers.rb', line 98

def update_destination(destination_branch, options = {})
  origin_branch = current_branch
  remote = options[:remote] || 'origin'
  run_command_with_label "git checkout #{destination_branch}"
  run_command_with_label "git pull #{remote} #{destination_branch}"
  run_command_with_label "git checkout #{origin_branch}"
end

#update_feature_branch(options = {}) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/git_reflow/git_helpers.rb', line 106

def update_feature_branch(options = {})
  base_branch = options[:base]
  remote = options[:remote]
  update_destination(base_branch, options) 

  # update feature branch in case there are multiple authors and remote changes
  run_command_with_label "git pull origin #{current_branch}"
  # rebase on base branch
  run_command_with_label "git merge #{base_branch}"
end