git_reflow 0.9.0 → 0.9.5

data/README.md

@@ -4,8 +4,8 @@
 </h1>
 
 <p>
-  <a href="https://circleci.com/gh/reenhanced/git-reflow/tree/master" title="current build status">
-    <img alt="Circle CI" src="https://circleci.com/gh/reenhanced/gitreflow.svg?style=svg&circle-token=d94825c17c7e33558dc2a82b37afad7b558e5a12">
+  <a href="https://actions-badge.atrox.dev/reenhanced/gitreflow/goto?ref=master" title="git workflow">
+    <img alt="Git workflow powered by git-reflow"  src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Freenhanced%2Fgitreflow%2Fbadge%3Fref%3Dmaster&style=flat">
   </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.9.0-blue.svg?style=flat">
@@ -443,11 +443,15 @@ If the review is done, it's time to merge. Here's what happens:
 
   In order to streamline delivery you can set the following git config to:
 
-  1. always clean up the feature branch after the PR is merged
+  1. always clean up the remote feature branch after the PR is merged
     ```
-    git config --global --add "reflow.always-cleanup" "true"
+    git config --global --add "reflow.always-cleanup-remote" "true"
     ```
-  2. always deliver without further prompt
+  2. always clean up the local feature branch after the PR is merged
+    ```
+    git config --global --add "reflow.always-cleanup-local" "true"
+    ```
+  3. always deliver without further prompt
     ```
     git config --global --add "reflow.always-deliver" "true"
     ```

data/Rakefile

@@ -1,8 +1,15 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "github_changelog_generator/task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'reenhanced'
+  config.project = 'gitreflow'
+  config.since_tag = 'v0.9.2'
+  config.future_release = 'master'
+end
 
+task :default => :spec

data/Workflow

@@ -0,0 +1,3 @@
+# This file is empty on purpose in case there are any custom workflows configured locally.
+# Eventually we will update it to:
+# use "OpenSourceWorkflow"

data/exe/git-reflow

@@ -9,6 +9,11 @@ if reflow_command.nil? || GitReflow.workflow.commands[reflow_command.to_sym].nil
 elsif ARGV.include? "--help"
   GitReflow.documentation_for_command(reflow_command)
 else
+  trap 'INT' do
+    GitReflow.say "Aborted.", :error
+    exit
+  end
+
   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)

data/git_reflow.gemspec

@@ -1,38 +1,40 @@
+# frozen_string_literal: true
+
 # Ensure we require the local version and not one we might have installed already
-require File.join([File.dirname(__FILE__),'lib','git_reflow/version.rb'])
+require File.join([File.dirname(__FILE__), 'lib', 'git_reflow/version.rb'])
 Gem::Specification.new do |s|
-  s.name             = 'git_reflow'
-  s.version          = GitReflow::VERSION
-  s.license          = 'MIT'
-  s.authors          = ["Valentino Stoll", "Robert Stern", "Nicholas Hance"]
-  s.email            = ["dev@reenhanced.com"]
-  s.homepage         = "http://github.com/reenhanced/gitreflow"
-  s.summary          = "A better git process"
-  s.description      = "Git Reflow manages your git workflow."
-  s.platform         = Gem::Platform::RUBY
-  s.files            = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables      = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.has_rdoc         = true
-  s.bindir           = "exe"
-  s.require_paths    = ["lib"]
-  s.rdoc_options     << '--title' << 'git_reflow' << '-ri'
+  s.name          = 'git_reflow'
+  s.version       = GitReflow::VERSION
+  s.license       = 'MIT'
+  s.authors       = ['Valentino Stoll', 'Robert Stern', 'Nicholas Hance']
+  s.email         = ['dev@reenhanced.com']
+  s.homepage      = 'http://github.com/reenhanced/gitreflow'
+  s.summary       = 'A better git process'
+  s.description   = 'Git Reflow manages your git workflow.'
+  s.platform      = Gem::Platform::RUBY
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.bindir        = 'exe'
+  s.require_paths = ['lib']
+  s.rdoc_options << '--title' << 'git_reflow' << '-ri'
 
-  s.add_development_dependency('appraisal', '2.2.0')
-  s.add_development_dependency('bundler', "~> 1.16")
+  s.add_development_dependency('appraisal', '2.4.0')
   s.add_development_dependency('chronic')
-  s.add_development_dependency('pry-byebug')
-  s.add_development_dependency('rake', "~> 12.3")
+  s.add_development_dependency('github_changelog_generator')
+  s.add_development_dependency('ruby_jard')
+  s.add_development_dependency('rake', '~> 13.0.3')
   s.add_development_dependency('rdoc')
-  s.add_development_dependency('rspec', "~> 3.7.0")
+  s.add_development_dependency('rspec', '~> 3.10')
   s.add_development_dependency('webmock')
-  s.add_development_dependency('wwtd', '1.3.0')
+  s.add_development_dependency('wwtd', '1.4')
 
-  s.add_dependency('colorize', '>= 0.7.0')
+  s.add_dependency('bundler', '>= 1.10.0')
+  s.add_dependency('codenamev_bitbucket_api', '0.4.1')
+  s.add_dependency('colorize', '>= 0.8.1')
+  s.add_dependency('github_api', '0.19')
   s.add_dependency('highline')
   s.add_dependency('httpclient')
-  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'"
 end

data/lib/git_reflow/config.rb

@@ -7,7 +7,14 @@ module GitReflow
 
     module_function
 
-    def get(key, reload: false, all: false, local: false)
+    # Gets the reqested git configuration variable.
+    #
+    # @param [String] key The key to get the value(s) for
+    # @option options [Boolean] :reload (false) whether to reload the value or use a cached value if available
+    # @option options [Boolean] :all (false) whether to return all keys for a multi-valued key
+    # @option options [Boolean] :local (false) whether to get the value specific to the current project
+    # @return the value of the git configuration
+    def get(key, reload: false, all: false, local: false, **_other_options)
       return cached_git_config_value(key) unless reload || cached_git_config_value(key).empty?
 
       local = local ? '--local ' : ''
@@ -19,7 +26,13 @@ module GitReflow
       cache_git_config_key(key, new_value)
     end
 
-    def set(key, value, local: false)
+    # Sets the reqested git configuration variable.
+    #
+    # @param [String] key The key to set the value for
+    # @param [String] value The value to set it to
+    # @option options [Boolean] :local (false) whether to set the value specific to the current project
+    # @return the value of the git configuration
+    def set(key, value, local: false, **_other_options)
       value = value.to_s.strip
       if local
         GitReflow::Sandbox.run "git config --replace-all #{key} \"#{value}\"", loud: false, blocking: false
@@ -28,7 +41,13 @@ module GitReflow
       end
     end
 
-    def unset(key, value: nil, local: false)
+    # Remove values of the reqested git configuration variable.
+    #
+    # @param [String] key The key to remove
+    # @option options [Boolean] :value (nil) The value of the key to remove
+    # @option options [Boolean] :local (false) whether to remove the value specific to the current project
+    # @return the result of running the git command
+    def unset(key, value: nil, local: false, **_other_options)
       value = value.nil? ? '' : "\"#{value}\""
       if local
         GitReflow::Sandbox.run "git config --unset-all #{key} #{value}", loud: false, blocking: false
@@ -37,7 +56,14 @@ module GitReflow
       end
     end
 
-    def add(key, value, local: false, global: false)
+    # Adds a new git configuration variable.
+    #
+    # @param [String] key The new key to set the value for
+    # @param [String] value The value to set it to
+    # @option options [Boolean] :local (false) whether to set the value specific to the current project
+    # @option options [Boolean] :global (false) whether to set the value globaly. if neither local or global is set gitreflow will default to using a configuration file
+    # @return the result of running the git command
+    def add(key, value, local: false, global: false, **_other_options)
       if global
         GitReflow::Sandbox.run "git config --global --add #{key} \"#{value}\"", loud: false, blocking: false
       elsif local

data/lib/git_reflow/git_server/git_hub.rb

@@ -84,56 +84,69 @@ module GitReflow
       end
 
       def authenticate(options = {silent: false})
+        if !options[:user].to_s.empty?
+          self.class.user = options[:user]
+        elsif self.class.user.empty?
+          self.class.user = ask("Please enter your GitHub username: ")
+        end
+
         if connection and self.class.oauth_token.length > 0
-          unless options[:silent]
-            GitReflow.say "Your GitHub account was already setup with: "
-            GitReflow.say "\tUser Name: #{self.class.user}"
-            GitReflow.say "\tEndpoint: #{self.class.api_endpoint}"
-          end
-        else
           begin
-            gh_user     = options[:user] || ask("Please enter your GitHub username: ")
-            gh_password = options[:password] || ask("Please enter your GitHub password (we do NOT store this): ") { |q| q.echo = false }
-
-            @connection = ::Github.new do |config|
-              config.basic_auth = "#{gh_user}:#{gh_password}"
-              config.endpoint   = GitServer::GitHub.api_endpoint
-              config.site       = GitServer::GitHub.site_url
-              config.adapter    = :net_http
+            connection.users.get
+            unless options[:silent]
+              GitReflow.say "Your GitHub account was already setup with: "
+              GitReflow.say "\tUser Name: #{self.class.user}"
+              GitReflow.say "\tEndpoint: #{self.class.api_endpoint}"
             end
+            return connection
+          rescue ::Github::Error::Unauthorized => e
+            GitReflow.logger.debug "[GitHub Error] Current oauth-token is invalid or expired..."
+          end
+        end
 
-            @connection.connection_options = {headers: {"X-GitHub-OTP" => options[:two_factor_auth_code]}} if options[:two_factor_auth_code]
+        begin
+          gh_password = options[:password] || ask("Please enter your GitHub password (we do NOT store this): ") { |q| q.echo = false }
 
-            previous_authorizations = @connection.oauth.all.select {|auth| auth.note == "git-reflow (#{run('hostname', loud: false).strip})" }
-            if previous_authorizations.any?
-              authorization = previous_authorizations.last
-              GitReflow.say "You have previously setup git-reflow on this machine, but we can no longer find the stored token.", :error
-              GitReflow.say "Please visit https://github.com/settings/tokens and delete the token for: git-reflow (#{run('hostname', loud: false).strip})", :notice
-              raise "Setup could not be completed."
-            else
-              authorization = @connection.oauth.create scopes: ['repo'], note: "git-reflow (#{run('hostname', loud: false).strip})"
-            end
+          @connection = ::Github.new do |config|
+            config.basic_auth = "#{self.class.user}:#{gh_password}"
+            config.endpoint   = GitServer::GitHub.api_endpoint
+            config.site       = GitServer::GitHub.site_url
+            config.adapter    = :net_http
+          end
 
-            self.class.oauth_token = authorization.token
+          @connection.connection_options = {headers: {"X-GitHub-OTP" => options[:two_factor_auth_code]}} if options[:two_factor_auth_code]
 
-          rescue ::Github::Error::Unauthorized => e
-            if e.inspect.to_s.include?('two-factor')
-              begin
-                # dummy request to trigger a 2FA SMS since a HTTP GET won't do it
-                @connection.oauth.create scopes: ['repo'], note: "thank Github for not making this straightforward"
-              rescue ::Github::Error::Unauthorized
-              ensure
-                two_factor_code = ask("Please enter your two-factor authentication code: ")
-                self.authenticate options.merge({user: gh_user, password: gh_password, two_factor_auth_code: two_factor_code})
-              end
-            else
-              GitReflow.say "Github Authentication Error: #{e.inspect}", :error
+          previous_authorizations = @connection.oauth.all.select {|auth| auth.note == "git-reflow (#{run('hostname', loud: false).strip})" }
+          if previous_authorizations.any?
+            authorization = previous_authorizations.last
+            GitReflow.say "You have previously setup git-reflow on this machine, but we can no longer find the stored token.", :error
+            GitReflow.say "Please visit https://github.com/settings/tokens and delete the token for: git-reflow (#{run('hostname', loud: false).strip})", :notice
+            raise "Setup could not be completed."
+          else
+            authorization = @connection.oauth.create scopes: ['repo'], note: "git-reflow (#{run('hostname', loud: false).strip})"
+          end
+
+          self.class.oauth_token = authorization.token
+
+        rescue ::Github::Error::Unauthorized => e
+          if e.inspect.to_s.include?('two-factor')
+            begin
+              # dummy request to trigger a 2FA SMS since a HTTP GET won't do it
+              @connection.oauth.create scopes: ['repo'], note: "thank Github for not making this straightforward"
+            rescue ::Github::Error::Unauthorized
+            ensure
+              two_factor_code = ask("Please enter your two-factor authentication code: ")
+              self.authenticate options.merge({user: self.class.user, password: gh_password, two_factor_auth_code: two_factor_code})
             end
-          rescue StandardError => e
-            raise "We were unable to authenticate with Github."
           else
-            GitReflow.say "Your GitHub account was successfully setup!", :success
+            GitReflow.say "Github Authentication Error: #{e.inspect}", :error
+            raise "Setup could not be completed."
           end
+        rescue StandardError => e
+          raise "We were unable to authenticate with Github."
+        else
+          GitReflow.say "Your GitHub account was successfully setup!", :success
+
         end
 
         @connection

data/lib/git_reflow/git_server/git_hub/pull_request.rb

@@ -24,8 +24,18 @@ module GitReflow
             base:  options[:base]))
         end
 
-        def self.find_open(to: 'master', from: GitReflow.git_server.class.current_branch)
-          matching_pull = GitReflow.git_server.connection.pull_requests.all(GitReflow.remote_user, GitReflow.remote_repo_name, base: to, head: "#{GitReflow.remote_user}:#{from}", state: 'open').first
+        def self.find_open(options = {})
+          options[:to] ||= 'master'
+          options[:from] ||= GitReflow.git_server.class.current_branch
+
+          matching_pull = GitReflow.git_server.connection.pull_requests.all(
+            GitReflow.remote_user,
+            GitReflow.remote_repo_name,
+            base: options[:to],
+            head: "#{GitReflow.remote_user}:#{options[:from]}",
+            state: 'open'
+          ).first
+
           if matching_pull
             self.new matching_pull
           end
@@ -147,13 +157,19 @@ module GitReflow
                 GitReflow.run_command_with_label "git pull origin #{self.base_branch_name}"
                 GitReflow.say "Pull request ##{self.number} successfully merged.", :success
 
-                if cleanup_feature_branch?
-                  GitReflow.run_command_with_label "git push origin :#{self.feature_branch_name}"
+                if cleanup_remote_feature_branch?
+                  GitReflow.run_command_with_label "git push origin :#{self.feature_branch_name}", blocking: false
+                else
+                  GitReflow.say "Skipped. Remote feature branch #{self.feature_branch_name} left in tact."
+                end
+
+                if cleanup_local_feature_branch?
                   GitReflow.run_command_with_label "git branch -D #{self.feature_branch_name}"
-                  GitReflow.say "Nice job buddy."
                 else
-                  cleanup_failure_message
+                  GitReflow.say "Skipped. Local feature branch #{self.feature_branch_name} left in tact."
                 end
+
+                GitReflow.say "Nice job buddy."
               else
                 GitReflow.say merge_response.to_s, :deliver_halted
                 GitReflow.say "There were problems commiting your feature... please check the errors above and try again.", :error

data/lib/git_reflow/git_server/pull_request.rb

@@ -178,7 +178,21 @@ module GitReflow
       end
 
       def cleanup_feature_branch?
-        GitReflow::Config.get('reflow.always-cleanup') == "true" || (ask "Would you like to push this branch to your remote repo and cleanup your feature branch? ") =~ /^y/i
+        cleanup_local_feature_branch? || cleanup_remote_feature_branch?
+      end
+
+      def cleanup_local_feature_branch?
+        # backwards compat
+        always_cleanup_local = GitReflow::Config.get('reflow.always-cleanup').to_s
+        always_cleanup_local = GitReflow::Config.get('reflow.always-cleanup-local') if always_cleanup_local.empty?
+        always_cleanup_local == "true" || (ask "Would you like to cleanup your local feature branch? ") =~ /^y/i
+      end
+
+      def cleanup_remote_feature_branch?
+        # backwards compat
+        always_cleanup_remote = GitReflow::Config.get('reflow.always-cleanup').to_s
+        always_cleanup_remote = GitReflow::Config.get('reflow.always-cleanup-remote') if always_cleanup_remote.empty?
+        always_cleanup_remote == "true" || (ask "Would you like to cleanup your remote feature branch? ") =~ /^y/i
       end
 
       def deliver?

data/lib/git_reflow/rspec/command_line_helpers.rb

@@ -7,6 +7,7 @@ module GitReflow
       def stub_command_line
         $commands_ran     = []
         $stubbed_commands = {}
+        $stubbed_runners  = Set.new
         $output           = []
         $says             = []
 
@@ -33,6 +34,7 @@ module GitReflow
       end
 
       def stub_run_for(module_to_stub)
+        $stubbed_runners << module_to_stub
         allow(module_to_stub).to receive(:run) do |command, options|
           options = { loud: true, blocking: true }.merge(options || {})
           $commands_ran << Hashie::Mash.new(command: command, options: options)
@@ -52,24 +54,31 @@ module GitReflow
         $says = []
       end
 
-      def stub_command(command, return_value)
+      def stub_command(command:, return_value: "", options: {})
         $stubbed_commands[command] = return_value
-        allow(GitReflow::Sandbox).to receive(:run).with(command).and_return(return_value)
+        $stubbed_runners.each do |runner|
+          allow(runner).to receive(:run).with(command, options) do |command, options|
+            options = { loud: true, blocking: true }.merge(options || {})
+            $commands_ran << Hashie::Mash.new(command: command, options: options)
+            $stubbed_commands[command] = return_value
+            raise GitReflow::Sandbox::CommandError.new(return_value, "\"#{command}\" failed to run.") if options[:raise]
+          end
+        end
       end
 
       def stub_command_line_inputs_for(module_to_stub, inputs)
         allow(module_to_stub).to receive(:ask) do |terminal, question|
-        return_value = inputs[question]
-        question = ""
-        return_value
+          return_value = inputs[question]
+          question = ""
+          return_value
         end
       end
 
       def stub_command_line_inputs(inputs)
         allow_any_instance_of(HighLine).to receive(:ask) do |terminal, question|
-        return_value = inputs[question]
-        question = ""
-        return_value
+          return_value = inputs[question]
+          question = ""
+          return_value
         end
       end
 

data/lib/git_reflow/sandbox.rb

@@ -12,8 +12,16 @@ module GitReflow
       plain:          :white
     }
 
+    class CommandError < StandardError;
+      attr_reader :output
+      def initialize(output, *args)
+        @output = output
+        super(*args)
+      end
+    end
+
     def run(command, options = {})
-      options = { loud: true, blocking: true }.merge(options)
+      options = { loud: true, blocking: true, raise: false }.merge(options)
 
       GitReflow.logger.debug "Running... #{command}"
 
@@ -22,12 +30,13 @@ module GitReflow
       else
         output = %x{#{command}}
 
-        if options[:blocking] == true && !$?.success?
-          abort "\"#{command}\" failed to run."
-        else
-          puts output if options[:loud] == true
-          output
+        if !$?.success?
+          raise CommandError.new(output, "\"#{command}\" failed to run.") if options[:raise] == true
+          abort "\"#{command}\" failed to run." if options[:blocking] == true
         end
+
+        puts output if options[:loud] == true
+        output
       end
     end