git_reflow 0.8.10 → 0.9.4

data/git_reflow.gemspec

@@ -1,39 +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('chronic')
+  s.add_development_dependency('github_changelog_generator')
   s.add_development_dependency('pry-byebug')
-  s.add_development_dependency('rake', "~> 12.3")
+  s.add_development_dependency('rake', '~> 13.0.1')
   s.add_development_dependency('rdoc')
-  s.add_development_dependency('rspec', "~> 3.7.0")
+  s.add_development_dependency('rspec', '~> 3.9')
   s.add_development_dependency('webmock')
-  s.add_development_dependency('wwtd', '1.3.0')
+  s.add_development_dependency('wwtd', '1.4')
 
+  s.add_dependency('bundler', '>= 1.10.0')
+  s.add_dependency('codenamev_bitbucket_api', '0.4.1')
   s.add_dependency('colorize', '>= 0.7.0')
-  s.add_dependency('gli', '2.17.0')
+  s.add_dependency('github_api', '0.19')
   s.add_dependency('highline')
   s.add_dependency('httpclient')
-  s.add_dependency('github_api', '0.15.0')
-  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.rb

@@ -6,13 +6,6 @@ require 'httpclient'
 require 'json'
 require 'colorize'
 
-# XXX: work around logger spam from hashie (required by github api)
-# https://github.com/intridea/hashie/issues/394
-require "hashie"
-require "hashie/logger"
-Hashie.logger = Logger.new(nil)
-
-
 require 'github_api'
 require 'git_reflow/version.rb' unless defined?(GitReflow::VERSION)
 require 'git_reflow/config'
@@ -46,20 +39,16 @@ module GitReflow
     Workflow.current
   end
 
-  def default_editor
-    "#{ENV['EDITOR'] || 'vi'}".freeze
-  end
-
   def git_server
     @git_server ||= GitServer.connect provider: GitReflow::Config.get('reflow.git-server').strip, silent: true
   end
 
-  def respond_to?(method_sym, include_all = false)
-    (workflow and workflow.respond_to?(method_sym, include_all)) || super(method_sym, include_all)
+  def respond_to_missing?(method_sym, include_all = false)
+    (workflow && workflow.respond_to?(method_sym, include_all)) || super(method_sym, include_all)
   end
 
   def method_missing(method_sym, *arguments, &block)
-    if workflow and workflow.respond_to? method_sym
+    if workflow && workflow.respond_to?(method_sym, false)
       workflow.send method_sym, *arguments, &block
     else
       super

data/lib/git_reflow/config.rb

@@ -1,25 +1,39 @@
+# 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"
+
+    module_function
 
-    CONFIG_FILE_PATH = "#{ENV['HOME']}/.gitconfig.reflow".freeze
+    # 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?
 
-    def get(key, reload: false, all: false, local: false)
-      if reload == false and cached_key_value = instance_variable_get(:"@#{key.tr('.-', '_')}")
-        cached_key_value
+      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
+    # 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
       else
@@ -27,8 +41,14 @@ module GitReflow
       end
     end
 
-    def unset(key, value: nil, local: false)
-      value = (value.nil?) ? "" : "\"#{value}\""
+    # 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
       else
@@ -36,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
@@ -45,5 +72,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

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