git-process-lib 2.0.0

data/lib/git-process/git_logger.rb

@@ -0,0 +1,84 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'logger'
+
+module GitProc
+
+  #
+  # Provides a Logger for Git commands
+  #
+  class GitLogger
+
+    DEBUG = Logger::DEBUG
+    INFO = Logger::INFO
+    WARN = Logger::WARN
+    ERROR = Logger::ERROR
+
+
+    def initialize(log_level = nil, out = STDOUT)
+      if out.nil?
+        @logger = ::Logger.new(RUBY_PLATFORM =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+      else
+        @logger = ::Logger.new(out)
+      end
+      @logger.level = log_level.nil? ? GitLogger::WARN : log_level
+      @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+      @logger.formatter = proc do |_, _, _, msg|
+        "#{msg}\n"
+      end
+    end
+
+
+    def level
+      @logger.level
+    end
+
+
+    def debug(msg = nil, &block)
+      if msg.nil?
+        @logger.debug(&block)
+      else
+        @logger.debug(msg)
+      end
+    end
+
+
+    def info(msg = nil, &block)
+      if msg.nil?
+        @logger.info(&block)
+      else
+        @logger.info(msg)
+      end
+    end
+
+
+    def warn(msg = nil, &block)
+      if msg.nil?
+        @logger.send(:warn, &block)
+      else
+        @logger.send(:warn, msg)
+      end
+    end
+
+
+    def error(msg = nil, &block)
+      if msg.nil?
+        @logger.error(&block)
+      else
+        @logger.error(msg)
+      end
+    end
+
+  end
+
+end

data/lib/git-process/git_merge_error.rb

@@ -0,0 +1,28 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/git_abstract_merge_error_builder'
+
+module GitProc
+
+  class MergeError < GitProcessError
+
+    def initialize(merge_error_message, gitlib)
+      error_builder = GitProc::AbstractMergeErrorBuilder.new(gitlib, merge_error_message, 'git commit')
+      msg = error_builder.build_message
+
+      super(msg)
+    end
+
+  end
+
+end

data/lib/git-process/git_process.rb

@@ -0,0 +1,159 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/git_lib'
+require 'git-process/git_rebase_error'
+require 'git-process/git_merge_error'
+require 'highline/import'
+
+
+module GitProc
+
+  class Process
+
+    # @param [GitLib] gitlib
+    def initialize(gitlib, opts = {})
+      @gitlib = gitlib
+    end
+
+
+    def gitlib
+      @gitlib
+    end
+
+
+    def run
+      begin
+        verify_preconditions
+
+        runner
+      rescue GitProc::GitProcessError => exp
+        puts exp.message
+        exit(-1)
+      ensure
+        cleanup
+      end
+    end
+
+
+    def runner
+      # extension point - does nothing by default
+    end
+
+
+    def workdir
+      gitlib.workdir
+    end
+
+
+    def logger
+      gitlib.logger
+    end
+
+
+    def config
+      gitlib.config
+    end
+
+
+    def master_branch
+      gitlib.config.master_branch
+    end
+
+
+    def remote
+      gitlib.remote
+    end
+
+
+    def verify_preconditions
+      if should_remove_master?
+        if ask_about_removing_master
+          delete_master_branch!
+        end
+      end
+    end
+
+
+    def cleanup
+      # extension point
+    end
+
+
+    def fetch_remote_changes(remote_name = nil)
+      gitlib.fetch_remote_changes(remote_name)
+    end
+
+
+    def is_parked?
+      gitlib.is_parked?
+    end
+
+
+    private
+
+
+    def delete_master_branch!
+      gitlib.branches[config.master_branch].delete!
+    end
+
+
+    def should_remove_master?
+      my_branches = gitlib.branches()
+      gitlib.has_a_remote? and
+          my_branches.include?(config.master_branch) and
+          my_branches.current.name != config.master_branch and
+          !keep_local_integration_branch? and
+          my_branches[config.integration_branch].contains_all_of(config.master_branch)
+    end
+
+
+    def keep_local_integration_branch?
+      keep_local_integration_branch_config_value.to_boolean
+    end
+
+
+    #noinspection RubyInstanceMethodNamingConvention
+    def keep_local_integration_branch_config_value
+      gitlib.config['gitProcess.keepLocalIntegrationBranch']
+    end
+
+
+    def ask_about_removing_master
+      resp = ask("You should remove your obsolete <%= color('local', [:bold]) %> branch, '#{config.master_branch}'. Should I remove it for you? (Yn) ") do |q|
+        q.responses[:not_valid] = 'Please respond with either (y)es or (n)o. Defaults to (y)es.'
+        q.case = :down
+        q.default = 'Y'
+        q.validate = /y|n/i
+      end
+
+      if resp == 'n'
+        say("(You can turn off this message using \"git config gitProcess.keepLocalIntegrationBranch true\").")
+        false
+      else
+        true
+      end
+    end
+
+
+    def proc_rebase(base, opts = {})
+      gitlib.proc_rebase(base, opts)
+    end
+
+
+    def proc_merge(base, opts = {})
+      gitlib.proc_merge(base, opts)
+    end
+
+  end
+
+end

data/lib/git-process/git_process_error.rb

@@ -0,0 +1,18 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module GitProc
+
+  class GitProcessError < RuntimeError
+  end
+
+end

data/lib/git-process/git_process_options.rb

@@ -0,0 +1,101 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'optparse'
+require 'trollop'
+require 'git-process/version'
+
+module GitProc
+
+  module GitProcessOptions
+
+    DEBUG = false
+
+
+    def parse_cli(filename, argv)
+      parser = Trollop::Parser.new
+      parser.version "#{filename} #{GitProc::Version::STRING}"
+
+      #parser.banner "#{summary}\n\n"
+      command_name = filename.sub(/git-/, '')
+      parser.banner "For full documentation, see 'git help #{command_name}'"
+      parser.banner ""
+
+      extend_opts(parser)
+      standard_opts(parser)
+
+      #parser.banner "\n#{description}"
+
+      opts = Trollop::with_standard_exception_handling parser do
+        raise Trollop::HelpNeeded if ARGV.empty? and !empty_argv_ok?
+        parser.parse argv
+      end
+
+      opts[:info] = false if opts[:verbose] || opts[:quiet]
+      opts[:info] = true if opts[:info_given]
+
+      post_parse(opts, argv)
+
+      if DEBUG
+        puts "\n\n#{opts.map { |k, v| "#{k}:#{v}" }.join(', ')}"
+        puts "\nargs: #{argv.join(', ')}"
+      end
+
+      opts
+    end
+
+
+    def standard_opts(parser)
+      parser.opt :info, 'Informational messages; show the major things this is doing', :default => true, :short => :none
+      parser.opt :quiet, 'Quiet messages; only show errors', :short => :q
+      parser.opt :verbose, 'Verbose messages; show lots of details on what this is doing', :short => :v
+      parser.opt :version, "Print version (#{GitProc::Version::STRING}) and exit", :short => :none
+      parser.opt :help, 'Show this message', :short => :h
+
+      parser.conflicts :verbose, :info, :quiet
+    end
+
+
+    def summary
+      'Default summary'
+    end
+
+
+    def usage(filename)
+      "#{filename} [options]"
+    end
+
+
+    def description
+      'Default description'
+    end
+
+
+    def empty_argv_ok?
+      true
+    end
+
+
+    #noinspection RubyUnusedLocalVariable
+    def extend_opts(parser)
+      # extension point - does nothing by default
+    end
+
+
+    #noinspection RubyUnusedLocalVariable
+    def post_parse(opts, argv)
+      # extension point - does nothing by default
+    end
+
+  end
+
+end

data/lib/git-process/git_rebase_error.rb

@@ -0,0 +1,30 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/git_abstract_merge_error_builder'
+
+module GitProc
+
+  class RebaseError < GitProcessError
+    attr_reader :error_builder
+
+
+    def initialize(rebase_error_message, gitlib)
+      @error_builder = GitProc::AbstractMergeErrorBuilder.new(gitlib, rebase_error_message, 'git rebase --continue')
+      msg = error_builder.build_message
+
+      super(msg)
+    end
+
+  end
+
+end

data/lib/git-process/git_remote.rb

@@ -0,0 +1,222 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'git-process/git_config'
+require 'addressable/uri'
+#require 'git-process/git_branches'
+#require 'git-process/git_status'
+#require 'git-process/git_process_error'
+
+
+class String
+
+  def to_boolean
+    return false if self == false || self.nil? || self =~ (/(false|f|no|n|0)$/i)
+    return true if self == true || self =~ (/(true|t|yes|y|1)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+
+end
+
+
+class NilClass
+  def to_boolean
+    false
+  end
+end
+
+
+module GitProc
+
+  #
+  # Git Remote configuration
+  #
+  class GitRemote
+
+    # @param [GitProc::GitConfig] gitconfig
+    def initialize(gitconfig)
+      @gitconfig = gitconfig
+    end
+
+
+    # @return [#info, #warn, #debug, #error]
+    def logger
+      @logger ||= @gitconfig.logger
+    end
+
+
+    # @return [GitProc::GitConfig]
+    def config
+      @gitconfig
+    end
+
+
+    # @deprecated
+    # TODO: Remove
+    def server_name
+      @server_name ||= self.remote_name
+    end
+
+
+    # @return [Boolean] does this have a remote defined?
+    def exists?
+      if @has_remote.nil?
+        @has_remote = (config.gitlib.command(:remote) != '')
+      end
+      logger.debug { "Does a remote exist? #{@has_remote}" }
+      @has_remote
+    end
+
+
+    def repo_name
+      unless @repo_name
+        url = config["remote.#{name}.url"]
+        raise GitProcessError.new("There is no #{name} url set up.") if url.nil? or url.empty?
+        uri = Addressable::URI.parse(url)
+        @repo_name = uri.path.sub(/\.git/, '').sub(/^\//, '')
+      end
+      @repo_name
+    end
+
+
+    def name
+      unless @remote_name
+        @remote_name = config['gitProcess.remoteName']
+        if @remote_name.nil? or @remote_name.empty?
+          remotes = self.remote_names
+          if remotes.empty?
+            @remote_name = nil
+          else
+            @remote_name = remotes[0]
+            raise '!@remote_name.is_a? String' unless @remote_name.is_a? String
+          end
+        end
+        logger.debug { "Using remote name of '#{@remote_name}'" }
+      end
+      @remote_name
+    end
+
+
+    def master_branch_name
+      "#{self.name}/#{config.master_branch}"
+    end
+
+
+    def remote_names
+      remote_str = config.gitlib.command(:remote, [:show])
+      if remote_str.nil? or remote_str.empty?
+        []
+      else
+        remote_str.split(/\n/)
+      end
+    end
+
+
+    #
+    # Expands the git configuration server name to a url.
+    #
+    # Takes into account further expanding an SSH uri that uses SSH aliasing in .ssh/config
+    #
+    # @param [String] server_name the git configuration server name; defaults to 'origin'
+    #
+    # @option opts [String] :ssh_config_file the SSH config file to use; defaults to ~/.ssh/config
+    #
+    # @return the fully expanded URL; never nil
+    #
+    # @raise [GitHubService::NoRemoteRepository] there is not a URL set for the server name
+    # @raise [URI::InvalidURIError] the retrieved URL does not have a schema
+    # @raise [GitHubService::NoRemoteRepository] if could not figure out a host for the retrieved URL
+    # @raise [::ArgumentError] if a server name is not provided
+    def expanded_url(server_name = 'origin', raw_url = nil, opts = {})
+      if raw_url.nil?
+        raise ArgumentError.new('Need server_name') unless server_name
+
+        conf_key = "remote.#{server_name}.url"
+        url = config[conf_key]
+
+        raise GitHubService::NoRemoteRepository.new("There is no value set for '#{conf_key}'") if url.nil? or url.empty?
+      else
+        raise GitHubService::NoRemoteRepository.new("There is no value set for '#{raw_url}'") if raw_url.nil? or raw_url.empty?
+        url = raw_url
+      end
+
+      if /^\S+@/ =~ url
+        url.sub(/^(\S+@\S+?):(.*)$/, "ssh://\\1/\\2")
+      else
+        uri = URI.parse(url)
+        host = uri.host
+        scheme = uri.scheme
+
+        raise URI::InvalidURIError.new("Need a scheme in URI: '#{url}'") unless scheme
+
+        if scheme == 'file'
+          url
+        elsif host.nil?
+          # assume that the 'scheme' is the named configuration in ~/.ssh/config
+          rv = GitRemote.hostname_and_user_from_ssh_config(scheme, opts[:ssh_config_file] ||= "#{ENV['HOME']}/.ssh/config")
+
+          raise GitHubService::NoRemoteRepository.new("Could not determine a host from #{url}") if rv.nil?
+
+          host = rv[0]
+          user = rv[1]
+          url.sub(/^\S+:(\S+)$/, "ssh://#{user}@#{host}/\\1")
+        else
+          url
+        end
+      end
+    end
+
+
+    # @return [void]
+    def add_remote(remote_name, url)
+      config.gitlib.command(:remote, ['add', remote_name, url])
+    end
+
+
+    alias :add :add_remote
+
+
+    #noinspection RubyClassMethodNamingConvention
+    def self.hostname_and_user_from_ssh_config(host_alias, config_file)
+      if File.exists?(config_file)
+        config_lines = File.new(config_file).readlines
+
+        in_host_section = false
+        host_name = nil
+        user_name = nil
+
+        config_lines.each do |line|
+          line.chop!
+          if /^\s*Host\s+#{host_alias}\s*$/ =~ line
+            in_host_section = true
+            next
+          end
+
+          if in_host_section and (/^\s*HostName\s+\S+\s*$/ =~ line)
+            host_name = line.sub(/^\s*HostName\s+(\S+)\s*$/, '\1')
+            break unless user_name.nil?
+          elsif in_host_section and (/^\s*User\s+\S+\s*$/ =~ line)
+            user_name = line.sub(/^\s*User\s+(\S+)\s*$/, '\1')
+            break unless host_name.nil?
+          elsif in_host_section and (/^\s*Host\s+.*$/ =~ line)
+            break
+          end
+        end
+        host_name.nil? ? nil : [host_name, user_name]
+      else
+        nil
+      end
+    end
+
+  end
+
+end