git_reflow 0.8.10 → 0.9.0

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    git_reflow (0.8.10)
+    git_reflow (0.9.0)
       colorize (>= 0.7.0)
-      github_api (= 0.15.0)
-      gli (= 2.17.0)
+      github_api (= 0.18.2)
       highline
       httpclient
       reenhanced_bitbucket_api (= 0.3.2)
@@ -30,30 +29,27 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.9.2)
       faraday (>= 0.7.4, < 0.10)
-    github_api (0.15.0)
-      addressable (~> 2.4.0)
+    github_api (0.18.2)
+      addressable (~> 2.4)
       descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      mime-types (>= 1.16, < 3.0)
+      faraday (~> 0.8)
+      hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    gli (2.17.0)
     hashdiff (0.3.7)
-    hashie (3.5.7)
-    highline (1.7.10)
+    hashie (3.6.0)
+    highline (2.0.0)
     httpclient (2.8.3)
-    jwt (1.5.6)
+    jwt (2.1.0)
     method_source (0.9.0)
-    mime-types (2.99.3)
     mini_portile2 (2.3.0)
     multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
@@ -63,7 +59,7 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    rack (2.0.4)
+    rack (2.0.6)
     rake (12.3.1)
     rdoc (6.0.3)
     reenhanced_bitbucket_api (0.3.2)
@@ -112,4 +108,4 @@ DEPENDENCIES
   wwtd (= 1.3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.1

data/LICENSE

@@ -1,20 +1,20 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 Reenhanced L.L.C.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2014 Reenhanced L.L.C.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -8,7 +8,7 @@
     <img alt="Circle CI" src="https://circleci.com/gh/reenhanced/gitreflow.svg?style=svg&circle-token=d94825c17c7e33558dc2a82b37afad7b558e5a12">
   </a>
   <a href="https://github.com/reenhanced/gitreflow" title="git workflow">
-    <img alt="Git workflow powered by git-reflow"  src="https://img.shields.io/badge/git--reflow-v0.8.10-blue.svg?style=flat">
+    <img alt="Git workflow powered by git-reflow"  src="https://img.shields.io/badge/git--reflow-v0.9.0-blue.svg?style=flat">
   </a>
   <a href="http://inch-ci.org/github/reenhanced/gitreflow" title="documentation coverage">
     <img src="http://inch-ci.org/github/reenhanced/gitreflow.svg?branch=master&style=shields" alt="Git-Reflow Documentation" />
@@ -117,7 +117,7 @@ This sets up a feature branch remotely and brings a local copy to your machine.
 
 `git reflow start` takes in the name of the new branch name that you want to create your feature on.
 In addition, it takes in an optional flag of a _base-branch_ name (`--base`). If you don't pass in this parameter,
-then it defaults to "master". The base branch name is the base branch that you want to base your feature off of.
+then it will look up the `reflow.base-branch` git configuration or default to "master". The base branch name is the base branch that you want to base your feature off of.
 This ensures that every time you start a new base branch, it will be based off of your latest remote base.
 
     git reflow start nh-branch-name --base base-branch-name
@@ -137,6 +137,9 @@ git reflow refresh -r <remote-location> -b <base-branch>
 
 You pass in the name of the remote to fetch from and the name of the **base-branch** that you would like to merge into your **feature-branch**. The **remote-location** defaults to `origin` and the base-branch defaults to `master`. This command also takes in remote and branch name as flag options.
 
+> **Note:** If no `base-branch` argument is provided, then we'll look for a `reflow.base-branch` git
+> configuration and fallback to `master` as the default.
+
 ### Reviewing your work
 ![git reflow review](http://reenhanced.com/reflow/git-reflow-review.gif)
 ```
@@ -150,9 +153,11 @@ We assume you know what you're doing, so if you need something different, do it
 
 After making commits to your branch, run `review`. Didn't push it up? No problem, we'll do it for you.
 ```
-git reflow review -t <title> -m <message>
+git reflow review -t <title> -m <message> <base-branch>
 ```
-> **Note:** `-t` and `-m` are optional.
+> **Note:** `-t` and `-m` are optional, as is the `base-branch` argument. If no
+> base-branch is provided, then we'll look for a `reflow.base-branch` git
+> configuration and fallback to `master` as the default.
 
 If you do not pass the title or message options to the review command, you will be given an editor to write your PR request commit message, similar to `git commit`. The first line is the title, the rest is the body.
 
@@ -202,9 +207,12 @@ If not, create it and print "Pull request created at http://pull-url/". If so, p
 ### Checking your branch status
 ![git reflow status](http://reenhanced.com/reflow/git-reflow-status.gif)
 ```
-git reflow status
+git reflow status <base-branch>
 ```
 
+> **Note:** If no `base-branch` is provided, then we'll look for a `reflow.base-branch` git
+> configuration and fallback to `master` as the default.
+
 Sometimes you start working on a branch and can't get back to it for a while. It happens. Use +status+ to check on the status of your work.
 
 ```
@@ -226,10 +234,13 @@ to find out where your pull request is at. But in case you want to take a look,
 ### Delivering approved code
 ![git-reflow deliver](http://reenhanced.com/reflow/git-reflow-deliver.gif)
 ```
-git reflow deliver
+git reflow deliver <base-branch>
 ```
 
-> **Note:** This documentation is for the process for the github "remote" merge process via the github_api.
+> **Note:** If no `base-branch` argument is provided, then we'll look for a `reflow.base-branch` git
+> configuration and fallback to `master` as the default.
+
+> **Also:** This documentation is for the process for the github "remote" merge process via the github_api.
   For the bitbucket standard or github manual process (used when the user applies -f force flag to the "remote" merge via the github_api), please go to section B.
 
 
@@ -443,6 +454,15 @@ If the review is done, it's time to merge. Here's what happens:
 
   See our [Advanced Usage](https://github.com/reenhanced/gitreflow/wiki/Full-List-of-Configuration-Options) for more ways you can customize your workflow.
 
+## Customization
+
+Git-reflow's default process isn't meant to fit every team, which is why we've introduced [Custom Workflows](https://github.com/reenhanced/gitreflow/wiki/Custom-Workflows). With a custom workflow, you can:
+
+* Add hooks to be run before, or after any command
+* Use one of our pre-configured workflows as a basis for your own
+* Override any of the default commands
+* Create new commands
+
 ---
 
 ## Contributing

data/Rakefile

@@ -1,8 +1,8 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/console

@@ -1,7 +1,7 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "git_reflow"
-
-require "irb"
-IRB.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "git_reflow"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -1,6 +1,6 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/circle.yml

@@ -7,12 +7,12 @@ dependencies:
     - >
       case $CIRCLE_NODE_INDEX in
        0)
-         rvm-exec 2.3.7 gem install bundler
-         rvm-exec 2.3.7 bash -c "bundle check --path=vendor/bundle_2.1 || bundle install --path=vendor/bundle_2.2"
+         rvm-exec 2.3.8 gem install bundler
+         rvm-exec 2.3.8 bash -c "bundle check --path=vendor/bundle_2.3 || bundle install --path=vendor/bundle_2.3"
          ;;
        1)
-         rvm-exec 2.4.4 gem install bundler
-         rvm-exec 2.4.4 bash -c "bundle check --path=vendor/bundle_2.2 || bundle install --path=vendor/bundle_2.3"
+         rvm-exec 2.4.5 gem install bundler
+         rvm-exec 2.4.5 bash -c "bundle check --path=vendor/bundle_2.4 || bundle install --path=vendor/bundle_2.4"
          ;;
        2)
          rvm-exec ruby-head gem install bundler
@@ -22,5 +22,5 @@ dependencies:
 
 test:
   override:
-    - case $CIRCLE_NODE_INDEX in 0) rvm-exec 2.3.7 bundle exec rake ;; 1) rvm-exec 2.4.4 bundle exec rake ;; 2) rvm-exec ruby-head bundle exec rake ;; esac:
+    - case $CIRCLE_NODE_INDEX in 0) rvm-exec 2.3.8 bundle exec rake ;; 1) rvm-exec 2.4.5 bundle exec rake ;; 2) rvm-exec ruby-head bundle exec rake ;; esac:
         parallel: true

data/exe/git-reflow

@@ -1,36 +1,15 @@
 #!/usr/bin/env ruby
 $: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
 require 'rubygems'
-require 'gli'
 require 'git_reflow'
 
-include GLI::App
-
-program_desc 'Git Reflow manages your git workflow.'
-
-version GitReflow::VERSION
-
-commands_from 'git_reflow/commands'
-
-pre do |global,command,options,args|
-  # Pre logic here
-  # Return true to proceed; false to abourt and not call the
-  # chosen command
-  # Use skips_pre before a command to skip this block
-  # on that command only
-  true
+reflow_command = ARGV.shift
+if reflow_command.nil? || GitReflow.workflow.commands[reflow_command.to_sym].nil?
+  GitReflow.help
+elsif ARGV.include? "--help"
+  GitReflow.documentation_for_command(reflow_command)
+else
+  command_options = GitReflow.parse_command_options!(reflow_command)
+  GitReflow.logger.debug "Running command `#{reflow_command}` with options: #{command_options.inspect}"
+  GitReflow.public_send(reflow_command.to_sym, command_options)
 end
-
-post do |global,command,options,args|
-  # Post logic here
-  # Use skips_post before a command to skip this
-  # block on that command only
-end
-
-on_error do |exception|
-  # Error logic here
-  # return false to skip default error handling
-  true
-end
-
-exit run(ARGV)

data/git_reflow.gemspec

@@ -29,10 +29,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency('wwtd', '1.3.0')
 
   s.add_dependency('colorize', '>= 0.7.0')
-  s.add_dependency('gli', '2.17.0')
   s.add_dependency('highline')
   s.add_dependency('httpclient')
-  s.add_dependency('github_api', '0.15.0')
+  s.add_dependency('github_api', '0.18.2')
   s.add_dependency('reenhanced_bitbucket_api', '0.3.2')
 
   s.post_install_message = "You need to setup your GitHub OAuth token\nPlease run 'git-reflow setup'"

data/lib/git_reflow/config.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module GitReflow
+  # This is a utility module for getting and setting git-config variables.
   module Config
-    extend self
+    CONFIG_FILE_PATH = "#{ENV['HOME']}/.gitconfig.reflow"
 
-    CONFIG_FILE_PATH = "#{ENV['HOME']}/.gitconfig.reflow".freeze
+    module_function
 
     def get(key, reload: false, all: false, local: false)
-      if reload == false and cached_key_value = instance_variable_get(:"@#{key.tr('.-', '_')}")
-        cached_key_value
+      return cached_git_config_value(key) unless reload || cached_git_config_value(key).empty?
+
+      local = local ? '--local ' : ''
+      if all
+        new_value = GitReflow::Sandbox.run("git config #{local}--get-all #{key}", loud: false, blocking: false)
       else
-        local = local ? '--local ' : ''
-        if all
-          new_value = GitReflow::Sandbox.run("git config #{local}--get-all #{key}", loud: false, blocking: false)
-        else
-          new_value = GitReflow::Sandbox.run("git config #{local}--get #{key}", loud: false, blocking: false)
-        end
-        instance_variable_set(:"@#{key.tr('.-', '_')}", new_value.strip)
+        new_value = GitReflow::Sandbox.run("git config #{local}--get #{key}", loud: false, blocking: false)
       end
+      cache_git_config_key(key, new_value)
     end
 
     def set(key, value, local: false)
-      value = "#{value}".strip
+      value = value.to_s.strip
       if local
         GitReflow::Sandbox.run "git config --replace-all #{key} \"#{value}\"", loud: false, blocking: false
       else
@@ -28,7 +29,7 @@ module GitReflow
     end
 
     def unset(key, value: nil, local: false)
-      value = (value.nil?) ? "" : "\"#{value}\""
+      value = value.nil? ? '' : "\"#{value}\""
       if local
         GitReflow::Sandbox.run "git config --unset-all #{key} #{value}", loud: false, blocking: false
       else
@@ -45,5 +46,13 @@ module GitReflow
         GitReflow::Sandbox.run "git config -f #{CONFIG_FILE_PATH} --add #{key} \"#{value}\"", loud: false, blocking: false
       end
     end
+
+    def cached_git_config_value(key)
+      instance_variable_get(:"@#{key.tr('.-', '_')}").to_s
+    end
+
+    def cache_git_config_key(key, value)
+      instance_variable_set(:"@#{key.tr('.-', '_')}", value.to_s.strip)
+    end
   end
 end

data/lib/git_reflow/git_helpers.rb

@@ -1,51 +1,71 @@
+# frozen_string_literal: true
+
 require 'git_reflow/config'
 require 'git_reflow/sandbox'
 
 module GitReflow
+  # Includes many helper methods for common tasks within a git repository.
   module GitHelpers
     include Sandbox
 
+    def default_editor
+      ENV['EDITOR'] || 'vi'
+    end
+
     def git_root_dir
-      return @git_root_dir if "#{@git_root_dir}".length > 0
+      return @git_root_dir unless @git_root_dir.to_s.empty?
       @git_root_dir = run('git rev-parse --show-toplevel', loud: false).strip
     end
 
     def git_editor_command
-      git_editor = "#{GitReflow::Config.get('core.editor')}"
-      if git_editor.length > 0
+      git_editor = GitReflow::Config.get('core.editor')
+      if !git_editor.empty?
         git_editor
       else
-        GitReflow.default_editor
+        default_editor
       end
     end
 
     def remote_user
-      return "" unless "#{GitReflow::Config.get('remote.origin.url')}".length > 0
+      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
 
     def remote_repo_name
-      return "" unless "#{GitReflow::Config.get('remote.origin.url')}".length > 0
+      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
 
+    def default_base_branch
+      base_branch_name = GitReflow::Config.get('reflow.base-branch')
+      return 'master' if base_branch_name.empty?
+      base_branch_name
+    end
+
     def current_branch
       run("git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'", loud: false).strip
     end
 
     def pull_request_template
-      filenames_to_try = %w( .github/PULL_REQUEST_TEMPLATE.md
-                             .github/PULL_REQUEST_TEMPLATE
-                             PULL_REQUEST_TEMPLATE.md
-                             PULL_REQUEST_TEMPLATE ).map do |file|
+      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
 
-      filename = filenames_to_try.detect do |file|
-        File.exist? file
+      parse_first_matching_template_file(filenames_to_try)
+    end
+
+    def merge_commit_template
+      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
 
-      File.read filename if filename
+      parse_first_matching_template_file(filenames_to_try)
     end
 
     def get_first_commit_message
@@ -53,12 +73,12 @@ module GitReflow
     end
 
     def push_current_branch(options = {})
-      remote = options[:remote] || "origin"
+      remote = options[:remote] || 'origin'
       run_command_with_label "git push #{remote} #{current_branch}"
     end
 
     def update_current_branch(options = {})
-      remote = options[:remote] || "origin"
+      remote = options[:remote] || 'origin'
       run_command_with_label "git pull #{remote} #{current_branch}"
       push_current_branch(options)
     end
@@ -86,23 +106,50 @@ module GitReflow
       run_command_with_label "git merge #{base_branch}"
     end
 
-    def append_to_squashed_commit_message(message = '')
-      tmp_squash_message_path = "#{git_root_dir}/.git/tmp_squash_msg"
-      squash_message_path     = "#{git_root_dir}/.git/SQUASH_MSG"
-      File.open(tmp_squash_message_path, "w") do |file_content|
+    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?(squash_message_path)
-          File.foreach(squash_message_path) do |line|
+        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_squash_message_path} #{squash_message_path}"
+      run "mv #{tmp_merge_message_path} #{dest_merge_message_path}"
+    end
+
+    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
 
     private
 
+    def parse_first_matching_template_file(template_file_names)
+      filename = template_file_names.detect do |file|
+        File.exist? file
+      end
+
+      # Thanks to @Shalmezad for contribuiting the template `gsub` snippet :-)
+      # https://github.com/reenhanced/gitreflow/issues/51#issuecomment-253535093
+      if filename
+        template_content = File.read filename
+        template_content.gsub!(/\{\{([a-zA-Z_]+[a-zA-Z0-9_]*)\}\}/) { GitReflow.public_send($1) }
+        template_content
+      end
+    end
+
     def extract_remote_user_and_repo_from_remote_url(remote_url)
       result = { user: '', repo: '' }
       return result unless "#{remote_url}".length > 0