git_reflow 0.8.10 → 0.9.0

data/lib/git_reflow/git_server/base.rb

@@ -1,68 +1,68 @@
-require 'git_reflow/config'
-
-module GitReflow
-  class GitServer::Base
-    extend GitHelpers
-
-    @@connection = nil
-
-    def initialize(options)
-      site_url     = self.class.site_url
-      api_endpoint = self.class.api_endpoint
-
-      self.class.site_url     = site_url
-      self.class.api_endpoint = api_endpoint
-
-      authenticate
-    end
-
-    def self.connection
-      raise "#{self.class.to_s}.connection method must be implemented"
-    end
-
-    def self.user
-      raise "#{self.class.to_s}.user method must be implemented"
-    end
-
-    def self.api_endpoint
-      raise "#{self.class.to_s}.api_endpoint method must be implemented"
-    end
-
-    def self.api_endpoint=(api_endpoint, options = {local: false})
-      raise "#{self.class.to_s}.api_endpoint= method must be implemented"
-    end
-
-    def self.site_url
-      raise "#{self.class.to_s}.site_url method must be implemented"
-    end
-
-    def self.site_url=(site_url, options = {local: false})
-      raise "#{self.class.to_s}.site_url= method must be implemented"
-    end
-
-    def self.project_only?
-      GitReflow::Config.get("reflow.local-projects", all: true).include? "#{remote_user}/#{remote_repo_name}"
-    end
-
-    def connection
-      @connection ||= self.class.connection
-    end
-
-    def authenticate
-      raise "#{self.class.to_s}#authenticate method must be implemented"
-    end
-
-    def find_open_pull_request(options)
-      raise "#{self.class.to_s}#find_open_pull_request(options) method must be implemented"
-    end
-
-    def get_build_status sha
-      raise "#{self.class.to_s}#get_build_status(sha) method must be implemented"
-    end
-
-    def colorized_build_description status
-      raise "#{self.class.to_s}#colorized_build_description(status) method must be implemented"
-    end
-
-  end
-end
+require 'git_reflow/config'
+
+module GitReflow
+  class GitServer::Base
+    extend GitHelpers
+
+    @@connection = nil
+
+    def initialize(options)
+      site_url     = self.class.site_url
+      api_endpoint = self.class.api_endpoint
+
+      self.class.site_url     = site_url
+      self.class.api_endpoint = api_endpoint
+
+      authenticate
+    end
+
+    def self.connection
+      raise "#{self.class.to_s}.connection method must be implemented"
+    end
+
+    def self.user
+      raise "#{self.class.to_s}.user method must be implemented"
+    end
+
+    def self.api_endpoint
+      raise "#{self.class.to_s}.api_endpoint method must be implemented"
+    end
+
+    def self.api_endpoint=(api_endpoint, options = {local: false})
+      raise "#{self.class.to_s}.api_endpoint= method must be implemented"
+    end
+
+    def self.site_url
+      raise "#{self.class.to_s}.site_url method must be implemented"
+    end
+
+    def self.site_url=(site_url, options = {local: false})
+      raise "#{self.class.to_s}.site_url= method must be implemented"
+    end
+
+    def self.project_only?
+      GitReflow::Config.get("reflow.local-projects", all: true).include? "#{remote_user}/#{remote_repo_name}"
+    end
+
+    def connection
+      @connection ||= self.class.connection
+    end
+
+    def authenticate
+      raise "#{self.class.to_s}#authenticate method must be implemented"
+    end
+
+    def find_open_pull_request(options)
+      raise "#{self.class.to_s}#find_open_pull_request(options) method must be implemented"
+    end
+
+    def get_build_status sha
+      raise "#{self.class.to_s}#get_build_status(sha) method must be implemented"
+    end
+
+    def colorized_build_description status
+      raise "#{self.class.to_s}#colorized_build_description(status) method must be implemented"
+    end
+
+  end
+end

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

@@ -38,7 +38,7 @@ module GitReflow
 
         def commit_author
           begin
-            username, branch = base.label.split(':')
+            username, _  = base.label.split(':')
             first_commit = GitReflow.git_server.connection.pull_requests.commits(username, GitReflow.git_server.class.remote_repo_name, number.to_s).first
             "#{first_commit.commit.author.name} <#{first_commit.commit.author.email}>".strip
           rescue Github::Error::NotFound
@@ -47,7 +47,7 @@ module GitReflow
         end
 
         def reviewers
-          (comment_authors + pull_request_reviews.map(&:user).map(&:login)).uniq
+          (comment_authors + pull_request_reviews.map(&:user).map(&:login)).uniq - [user.login]
         end
 
         def approvals
@@ -65,7 +65,7 @@ module GitReflow
           comments        = GitReflow.git_server.connection.issues.comments.all        GitReflow.remote_user, GitReflow.remote_repo_name, number: self.number
           review_comments = GitReflow.git_server.connection.pull_requests.comments.all GitReflow.remote_user, GitReflow.remote_repo_name, number: self.number
 
-          review_comments.to_a + comments.to_a
+          (review_comments.to_a + comments.to_a).select { |c| c.user.login != user.login }
         end
 
         def last_comment
@@ -80,7 +80,10 @@ module GitReflow
           if self.class.minimum_approvals.to_i == 0
             super
           else
-            approvals.size >= self.class.minimum_approvals.to_i and !last_comment.match(self.class.approval_regex).nil?
+            approvals.size >= self.class.minimum_approvals.to_i and (
+              last_comment.empty? ||
+              !last_comment.match(self.class.approval_regex).nil?
+            )
           end
         end
 
@@ -93,20 +96,22 @@ module GitReflow
             if deliver?
               GitReflow.say "Merging pull request ##{self.number}: '#{self.title}', from '#{self.feature_branch_name}' into '#{self.base_branch_name}'", :notice
 
+              merge_method       = options[:merge_method] || GitReflow::Config.get("reflow.merge-method")
+              merge_method       = "squash" if "#{merge_method}".length < 1
+              merge_message_file = GitReflow.merge_message_path(merge_method: merge_method)
+
               unless options[:title] || options[:message]
                 # prompts user for commit_title and commit_message
-                squash_merge_message_file = "#{GitReflow.git_root_dir}/.git/SQUASH_MSG"
-
-                File.open(squash_merge_message_file, 'w') do |file|
+                File.open(merge_message_file, 'w') do |file|
                   file.write("#{self.title}\n#{self.commit_message_for_merge}\n")
                 end
 
-                GitReflow.run("#{GitReflow.git_editor_command} #{squash_merge_message_file}", with_system: true)
-                merge_message = File.read(squash_merge_message_file).split(/[\r\n]|\r\n/).map(&:strip)
+                GitReflow.run("#{GitReflow.git_editor_command} #{merge_message_file}", with_system: true)
+                merge_message = File.read(merge_message_file).split(/[\r\n]|\r\n/).map(&:strip)
 
                 title  = merge_message.shift
 
-                File.delete(squash_merge_message_file)
+                File.delete(merge_message_file)
 
                 unless merge_message.empty?
                   merge_message.shift if merge_message.first.empty?
@@ -124,9 +129,6 @@ module GitReflow
 
               options[:body] = "#{options[:message]}\n" if options[:body].nil? and "#{options[:message]}".length > 0
 
-              merge_method   = options[:merge_method] || GitReflow::Config.get("reflow.merge-method")
-              merge_method   = "squash" if "#{merge_method}".length < 1
-
               merge_response = GitReflow::GitServer::GitHub.connection.pull_requests.merge(
                 "#{GitReflow.git_server.class.remote_user}",
                 "#{GitReflow.git_server.class.remote_repo_name}",

data/lib/git_reflow/git_server/pull_request.rb

@@ -158,6 +158,8 @@ module GitReflow
       end
 
       def commit_message_for_merge
+        return GitReflow.merge_commit_template unless GitReflow.merge_commit_template.nil?
+
         message = ""
 
         if "#{self.description}".length > 0
@@ -204,14 +206,14 @@ module GitReflow
           GitReflow.run_command_with_label "git checkout #{self.base_branch_name}"
           GitReflow.run_command_with_label "git pull origin #{self.base_branch_name}"
 
-          case merge_method
+          case merge_method.to_s
           when /squash/i
             GitReflow.run_command_with_label "git merge --squash #{self.feature_branch_name}"
           else
             GitReflow.run_command_with_label "git merge #{self.feature_branch_name}"
           end
 
-          GitReflow.append_to_squashed_commit_message(message) if message.length > 0
+          GitReflow.append_to_merge_commit_message(message) if message.length > 0
 
           if GitReflow.run_command_with_label 'git commit', with_system: true
             GitReflow.say "Pull request ##{self.number} successfully merged.", :success

data/lib/git_reflow/merge_error.rb

@@ -1,9 +1,9 @@
-module GitReflow
-  module GitServer
-    class MergeError < StandardError
-      def initialize(msg="Merge failed")
-        super(msg)
-      end
-    end
-  end
-end
+module GitReflow
+  module GitServer
+    class MergeError < StandardError
+      def initialize(msg="Merge failed")
+        super(msg)
+      end
+    end
+  end
+end

data/lib/git_reflow/rspec/command_line_helpers.rb

@@ -2,8 +2,8 @@ require "highline"
 
 module GitReflow
   module RSpec
+    # @nodoc
     module CommandLineHelpers
-
       def stub_command_line
         $commands_ran     = []
         $stubbed_commands = {}
@@ -57,6 +57,14 @@ module GitReflow
         allow(GitReflow::Sandbox).to receive(:run).with(command).and_return(return_value)
       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
+        end
+      end
+
       def stub_command_line_inputs(inputs)
         allow_any_instance_of(HighLine).to receive(:ask) do |terminal, question|
         return_value = inputs[question]

data/lib/git_reflow/rspec/stub_helpers.rb

@@ -1,13 +1,13 @@
-module GitReflow
-  module RSpec
-    module StubHelpers
-
-      def stub_with_fallback(obj, method)
-        original_method = obj.method(method)
-        allow(obj).to receive(method).with(anything()) { |*args| original_method.call(*args) }
-        return allow(obj).to receive(method)
-      end
-
-    end
-  end
-end
+module GitReflow
+  module RSpec
+    module StubHelpers
+
+      def stub_with_fallback(obj, method)
+        original_method = obj.method(method)
+        allow(obj).to receive(method).with(anything()) { |*args| original_method.call(*args) }
+        return allow(obj).to receive(method)
+      end
+
+    end
+  end
+end

data/lib/git_reflow/rspec/workflow_helpers.rb

@@ -0,0 +1,18 @@
+module GitReflow
+  module RSpec
+    # @nodoc
+    module WorkflowHelpers
+      def use_workflow(path)
+        allow(GitReflow::Workflows::Core).to receive(:load_workflow).and_return(
+          GitReflow::Workflows::Core.load_raw_workflow(File.read(path))
+        )
+      end
+
+      def suppress_loading_of_external_workflows
+        allow(GitReflow::Workflows::Core).to receive(:load__workflow).with("#{GitReflow.git_root_dir}/Workflow").and_return(false)
+        return if GitReflow::Config.get('reflow.workflow').to_s.empty?
+        allow(GitReflow::Workflows::Core).to receive(:load_workflow).with(GitReflow::Config.get('reflow.workflow')).and_return(false)
+      end
+    end
+  end
+end

data/lib/git_reflow/rspec.rb

@@ -1,2 +1,3 @@
 require_relative 'rspec/command_line_helpers'
 require_relative 'rspec/stub_helpers'
+require_relative 'rspec/workflow_helpers'

data/lib/git_reflow/sandbox.rb

@@ -4,6 +4,7 @@ module GitReflow
 
     COLOR_FOR_LABEL = {
       notice:         :yellow,
+      info:           :yellow,
       error:          :red,
       deliver_halted: :red,
       review_halted:  :red,

data/lib/git_reflow/version.rb

@@ -1,3 +1,3 @@
 module GitReflow
-  VERSION = "0.8.10"
+  VERSION = "0.9.0"
 end

data/lib/git_reflow/workflow.rb

@@ -9,20 +9,102 @@ module GitReflow
 
     # @nodoc
     def self.current
-      workflow_file = GitReflow::Config.get('reflow.workflow')
-      if workflow_file.length > 0 and File.exists?(workflow_file)
-        GitReflow.logger.debug "Using workflow: #{workflow_file}"
-        eval(File.read(workflow_file))
-      else
-        GitReflow.logger.debug "Using core workflow..."
-        GitReflow::Workflows::Core
+      return @current unless @current.nil?
+      # First look for a "Workflow" file in the current directory, then check
+      # for a global Workflow file stored in git-reflow git config.
+      loaded_local_workflow  = GitReflow::Workflows::Core.load_workflow "#{GitReflow.git_root_dir}/Workflow"
+      loaded_global_workflow = false
+
+      unless loaded_local_workflow
+        loaded_global_workflow = GitReflow::Workflows::Core.load_workflow GitReflow::Config.get('reflow.workflow')
       end
+
+      @current = GitReflow::Workflows::Core
+    end
+
+    # @nodoc
+    # This is primarily a helper method for tests.  Due to the nature of how the
+    # tests load many different workflows, this helps start fresh and isolate
+    # the scenario at hand.
+    def self.reset!
+      GitReflow.logger.debug "Resetting GitReflow workflow..."
+      current.commands = {}
+      current.callbacks = { before: {}, after: {}}
+      @current = nil
+      # We'll need to reload the core class again in order to clear previously
+      # eval'd content in the context of the class
+      load File.expand_path('../workflows/core.rb', __FILE__)
     end
 
     module ClassMethods
       include GitReflow::Sandbox
       include GitReflow::GitHelpers
 
+      def commands
+        @commands ||= {}
+      end
+
+      def commands=(command_hash)
+        @commands = command_hash
+      end
+
+      def command_docs
+        @command_docs ||= {}
+      end
+
+      def command_docs=(command_doc_hash)
+        @command_docs = command_doc_hash
+      end
+
+      def callbacks
+        @callbacks ||= {
+          before: {},
+          after: {}
+        }
+      end
+
+      def callbacks=(callback_hash)
+        @callbacks = callback_hash
+      end
+
+      # Proxy our Config class so that it's available in workflow files
+      def git_config
+        GitReflow::Config
+      end
+
+      def git_server
+        GitReflow.git_server
+      end
+
+      def logger
+        GitReflow.logger
+      end
+
+      # Loads a pre-defined workflow (FlatMergeWorkflow) from within another
+      # Workflow file
+      #
+      # @param name [String] the name of the Workflow file to use as a basis
+      def use(workflow_name)
+        if workflows.key?(workflow_name)
+          GitReflow.logger.debug "Using Workflow: #{workflow_name}"
+          GitReflow::Workflows::Core.load_workflow(workflows[workflow_name])
+        else
+          GitReflow.logger.error "Tried to use non-existent Workflow: #{workflow_name}"
+        end
+      end
+
+      # Keeps track of available workflows when using `.use(workflow_name)`
+      # Workflow file
+      #
+      # @return [Hash, nil] A hash with [workflow_name, workflow_path] as key/value pairs
+      def workflows
+        return @workflows if @workflows
+        workflow_paths = Dir["#{File.dirname(__FILE__)}/workflows/*Workflow"]
+        @workflows = {}
+        workflow_paths.each { |p| @workflows[File.basename(p)] = p }
+        @workflows
+      end
+
       # Creates a singleton method on the inlcuded class
       #
       # This method will take any number of keyword parameters. If @defaults keyword is provided, and the given
@@ -34,11 +116,24 @@ module GitReflow
       #
       # @yield [a:, b:, c:, ...] Invokes the block with an arbitrary number of keyword arguments
       def command(name, **params, &block)
-        defaults = params[:defaults] || {}
+        params[:flags]     ||= {}
+        params[:switches]  ||= {}
+        params[:arguments] ||= {}
+        defaults           ||= params[:arguments].merge(params[:flags]).merge(params[:switches])
+
+        # Ensure flags and switches use kebab-case
+        kebab_case_keys!(params[:flags])
+        kebab_case_keys!(params[:switches])
+
+        # Register the command with the workflow so that we can properly handle
+        # option parsing from the command line
+        self.commands[name] = params
+        self.command_docs[name] = params
+
         self.define_singleton_method(name) do |**args|
           args_with_defaults = {}
           args.each do |name, value|
-            if "#{value}".length <= 0
+            if "#{value}".length <= 0 && !defaults[name].nil?
               args_with_defaults[name] = defaults[name]
             else
               args_with_defaults[name] = value
@@ -51,9 +146,182 @@ module GitReflow
             end
           end
 
+          GitReflow.logger.debug "callbacks: #{callbacks.inspect}"
+          Array(callbacks[:before][name]).each do |block|
+            GitReflow.logger.debug "(before) callback running for `#{name}` command..."
+            argument_overrides = block.call(**args_with_defaults) || {}
+            args_with_defaults.merge!(argument_overrides) if argument_overrides.is_a?(Hash)
+          end
+
+          GitReflow.logger.debug "Running command `#{name}` with args: #{args_with_defaults.inspect}..."
           block.call(**args_with_defaults)
+
+          Array(callbacks[:after][name]).each do |block|
+            GitReflow.logger.debug "(after) callback running for `#{name}` command..."
+            block.call(**args_with_defaults)
+          end
         end
       end
+
+      # Stores a Proc to be called once the command successfully finishes
+      #
+      # Procs declared with `before` are executed sequentially in the order they are defined in a custom Workflow
+      # file.
+      #
+      # @param name [Symbol] the name of the method to create
+      #
+      # @yield A block to be executed before the given command.  These blocks
+      # are executed in the context of `GitReflow::Workflows::Core`
+      def before(name, &block)
+        name = name.to_sym
+        if commands[name].nil?
+          GitReflow.logger.error "Attempted to register (before) callback for non-existing command: #{name}"
+        else
+          GitReflow.logger.debug "(before) callback registered for: #{name}"
+          callbacks[:before][name] ||= []
+          callbacks[:before][name] << block
+        end
+      end
+
+      # Stores a Proc to be called once the command successfully finishes
+      #
+      # Procs declared with `after` are executed sequentially in the order they are defined in a custom Workflow
+      # file.
+      #
+      # @param name [Symbol] the name of the method to create
+      #
+      # @yield A block to be executed after the given command.  These blocks
+      # are executed in the context of `GitReflow::Workflows::Core`
+      def after(name, &block)
+        name = name.to_sym
+        if commands[name].nil?
+          GitReflow.logger.error "Attempted to register (after) callback for non-existing command: #{name}"
+        else
+          GitReflow.logger.debug "(after) callback registered for: #{name}"
+          callbacks[:after][name] ||= []
+          callbacks[:after][name] << block
+        end
+      end
+
+      # Creates a singleton method on the inlcuded class
+      #
+      # This method updates the help text associated with the provided command.
+      #
+      # @param name [Symbol] the name of the command to add/update help text for
+      # @param defaults [Hash] keyword arguments to provide fallbacks for
+      def command_help(name, summary:, arguments: {}, flags: {}, switches: {},  description: "")
+        command_docs[name] = {
+          summary: summary,
+          description: description,
+          arguments: arguments,
+          flags: kebab_case_keys!(flags),
+          switches: kebab_case_keys!(switches)
+        }
+      end
+
+      # Outputs documentation for the provided command
+      #
+      # @param name [Symbol] the name of the command to output help text for
+      def documentation_for_command(name)
+        name = name.to_sym
+        docs = command_docs[name]
+        if !docs.nil?
+          GitReflow.say "USAGE"
+          GitReflow.say "    git-reflow #{name} [command options] #{docs[:arguments].keys.map {|arg| "[#{arg}]" }.join(' ')}"
+          if docs[:arguments].any?
+            GitReflow.say "ARGUMENTS"
+            docs[:arguments].each do |arg_name, arg_desc|
+              default_text = commands[name][:arguments][arg_name].nil? ? "" : "(default: #{commands[name][:arguments][arg_name]}) "
+              GitReflow.say "    #{arg_name} – #{default_text}#{arg_desc}"
+            end
+          end
+          if docs[:flags].any? || docs[:switches].any?
+            cmd = commands[name.to_sym]
+            GitReflow.say "COMMAND OPTIONS"
+            docs[:flags].each do |flag_name, flag_desc|
+              flag_names = ["-#{flag_name.to_s[0]}", "--#{flag_name}"]
+              flag_default = cmd[:flags][flag_name]
+
+              GitReflow.say "    #{flag_names} – #{!flag_default.nil? ? "(default: #{flag_default})  " : ""}#{flag_desc}"
+            end
+            docs[:switches].each do |switch_name, switch_desc|
+              switch_names = [switch_name.to_s[0], "-#{switch_name}"].map {|s| "-#{s}" }.join(', ')
+              switch_default = cmd[:switches][switch_name]
+
+              GitReflow.say "    #{switch_names} – #{!switch_default.nil? ? "(default: #{switch_default})  " : ""}#{switch_desc}"
+            end
+          end
+        else
+          help
+        end
+      end
+
+      # Outputs documentation for git-reflow
+      def help
+        GitReflow.say "NAME"
+        GitReflow.say "    git-reflow – Git Reflow manages your git workflow."
+        GitReflow.say "VERSION"
+        GitReflow.say "    #{GitReflow::VERSION}"
+        GitReflow.say "USAGE"
+        GitReflow.say "    git-reflow command [command options] [arguments...]"
+        GitReflow.say "COMMANDS"
+        command_docs.each do |command_name, command_doc|
+          GitReflow.say "    #{command_name}\t– #{command_doc[:summary]}"
+        end
+      end
+
+      # Parses ARGV for the provided git-reflow command name
+      #
+      # @param name [Symbol, String] the name of the git-reflow command to parse from ARGV
+      def parse_command_options!(name)
+        name = name.to_sym
+        options = {}
+        docs = command_docs[name]
+        OptionParser.new do |opts|
+          opts.banner = "USAGE:\n  git-reflow #{name} [command options] #{docs[:arguments].keys.map {|arg| "[#{arg}]" }.join(' ')}"
+          opts.separator  ""
+          opts.separator  "COMMAND OPTIONS:" if docs[:flags].any? || docs[:switches].any?
+
+          self.commands[name][:flags].each do |flag_name, flag_default|
+            opts.on("-#{flag_name[0]}", "--#{flag_name} #{flag_name.upcase}", command_docs[name][:flags][flag_name]) do |f|
+              options[kebab_to_underscore(flag_name)] = f || flag_default
+            end
+          end
+
+          self.commands[name][:switches].each do |switch_name, switch_default|
+            opts.on("-#{switch_name[0]}", "--[no-]#{switch_name}", command_docs[name][:switches][switch_name]) do |s|
+              options[kebab_to_underscore(switch_name)] = s || switch_default
+            end
+          end
+        end.parse!
+
+        # Add arguments to optiosn to pass to defined commands
+        commands[name][:arguments].each do |arg_name, arg_default|
+          options[arg_name] = ARGV.shift || arg_default
+        end
+        options
+      rescue OptionParser::InvalidOption
+        documentation_for_command(name)
+        exit 1
+      end
+
+      private
+
+      def kebab_case_keys!(hsh)
+        hsh.keys.each do |key_to_update|
+          hsh[underscore_to_kebab(key_to_update)] = hsh.delete(key_to_update) if key_to_update =~ /_/
+        end
+
+        hsh
+      end
+
+      def kebab_to_underscore(sym_or_string)
+        sym_or_string.to_s.gsub('-', '_').to_sym
+      end
+
+      def underscore_to_kebab(sym_or_string)
+        sym_or_string.to_s.gsub('_', '-').to_sym
+      end
     end
   end
 end