m-git 2.5.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 061c41a63ff3870becb7688fd0006b85c57423d3fd909e6dde81df7756f3dc3b
+  data.tar.gz: d9da7bf09c24160ef38953892306ac3fa659400fe1742c59a621b0d6f1c6be10
+SHA512:
+  metadata.gz: 57cef37878e9c37fe761717385a83c5237dcec0ab14057ab3013eae05ee353426031556888420322c621051d8331e6c522d65119439b61b2f260f0a3a6f0eb5f
+  data.tar.gz: 710a2e9b7de9b273b4ddd40a8e8d3d3a252e2cbd97a94bb6b66b3aeea91b21c1afc9388efd63f8102a42e986188c46a5b97f2b9bce70327461455ca3a594c72c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Baidu, Inc. All Rights Reserved.
+
+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

@@ -0,0 +1,85 @@
+# MGit
+
+MGit是一款ruby封装的基于Git的多仓库管理工具，可以高效的、同时的对多个Git仓库执行Git命令。
+适合于在多个仓库中进行关联开发的项目，提高git操作的效率，避免逐个执行Git命令带来的误操作风险。
+
+- **易用的命令**
+封装Git命令，命令和参数均由Git衍生而来，会使用Git就可以成本低上手MGit。
+
+- **直观高效的执行命令**
+提供图表化的结果展示，开发者可以快速查看命令在多个仓库的执行结果；
+多线程并发执行多仓库命令，通过仓库缓存机制提高仓库的拉取效率；
+
+- **安全的执行命令**
+在执行命令前对多仓库状态进行安全检查：分支是否异常，工作区是否未提交代码等；
+对.git进行托管与Git工作区分类，避免误删丢失改动或提交；
+执行存在风险的操作时，会给与风险操作提示，避免误操作；
+
+- **方便扩展**
+支持加载ruby-gem包作为插件，gem包名格式 `m-git-${suffix}`和`mgit-${suffix}`
+快速的扩展MGit的命令，增加自定义命令，扩展已有命令的功能；
+提供类似`git hook`的 hook点，方便开发者实现自定义逻辑；
+
+## 快速开始
+  #### 1、安装MGit工具
+
+环境要求：
+
+- 系统：支持 macOS、Ubuntu，暂时不支持 window-
+- Ruby版本: >= 2.3.7
+
+```ruby
+$ gem install m-git
+```
+
+#### 2、初始化多仓库 
+
+初始化多仓库使用 `mgit init` 命令;
+
+类似于 Git 从远程 clone 新仓库, 会将多个仓库 clone 到本地;
+
+下面通过一个demo体验一下MGit命令：
+
+```ruby
+# 2.1 建议在一个新文件夹中拉取demo
+$ mgit init -g https://github.com/baidu/m-git.git
+
+# 2.2 体验一下mgit命令
+$ mgit -l                 显示所有migt管理的仓库
+$ mgit branch --compact   查看多仓库的分支
+$ mgit status             产看仓库分支超前/落后情况
+```
+
+
+
+#### 3、进一步了解MGit
+
+[常用命令](docs/use/common-commands.md)
+
+[manifest文件介绍](docs/config/manifest.md)
+
+[配置多仓库](docs/config/config-env.md) 
+
+[了解更多](docs/references.md)
+
+
+## 测试
+
+单测在MGit仓库内的test文件夹下
+新建单测文件，必须以‘test_’开头,
+执行单测：rake （如果报错尝试执行 bundle install）
+
+
+## 如何贡献
+
+欢迎开发者向MGit贡献代码。如果您开发了新功能或发现了bug，欢迎给我们提交PR。
+
+代码贡献要求：
+1. 功能和实现应该具有通用性, 不是为了解决某个具体业务而定制的代码逻辑
+2. 代码质量高，符合Ruby编码规范
+3. 需要补充对应的单测case
+
+issues贡献： 如在使用中遇到问题，请在 https://github.com/baidu/m-git/issues 新建 issues 反馈问题。
+
+
+

data/lib/m-git.rb

@@ -0,0 +1,66 @@
+
+$:.unshift __dir__
+
+require 'open3'
+require 'fileutils'
+require 'json'
+require 'digest'
+require 'pathname'
+require 'uri'
+require 'yaml'
+require 'securerandom'
+
+require 'colored2'
+require 'peach'
+require 'tty-pager'
+
+require 'm-git/foundation'
+require 'm-git/output/output'
+module MGit
+  include MGit::Foundation
+end
+
+require 'm-git/argv'
+require 'm-git/hooks_manager'
+require 'm-git/command_manager'
+require 'm-git/base_command'
+require 'm-git/error'
+require 'm-git/repo'
+require 'm-git/manifest'
+require 'm-git/template'
+require 'm-git/version'
+require 'm-git/workspace'
+
+# 对外其他ruby脚本调用接口
+require 'm-git/open_api'
+
+# load plugin
+require 'm-git/plugin_manager'
+
+
+module MGit
+  # 加载插件
+  PluginManager.setup
+
+  module_function
+  # input
+  def run(raw_argv)
+    # 处理不带子命令或带全局参数的输入，如果带全局参数，目前版本对后续附加的子命令不处理。
+    raw_argv.unshift('self') if (raw_argv.first.nil? || (raw_argv.first =~ /-/) == 0)
+    need_verbose = raw_argv.delete('--verbose') || $__VERBOSE__ || false
+    argv = ARGV::Parser.parse(raw_argv)
+
+    begin
+      # 特殊处理'base'
+      cmd_class = CommandManager[argv.cmd]
+      Foundation.help!("调用非法指令\"#{argv.cmd}\"") if cmd_class.nil?
+      cmd_class.new(argv).run
+    rescue => e
+      Output.puts_fail_message("执行该指令时发生异常：#{argv.cmd}")
+      Output.puts_fail_message("异常信息：#{e.message}")
+      Output.puts_fail_message("异常位置：#{e.backtrace.join("\n")}") if need_verbose
+      exit
+    end
+  end
+end
+

data/lib/m-git/argv.rb

@@ -0,0 +1,170 @@
+#coding=utf-8
+
+module MGit
+
+  # 参数处理类
+  class ARGV
+
+    require 'm-git/argv/opt'
+    require 'm-git/argv/opt_list'
+    require 'm-git/argv/parser'
+
+    # 指令名，如："mgit checkout -b branch_name"的"checkout"
+    attr_reader :cmd
+
+    # 所有参数，如："mgit checkout -b branch_name"的"checkout -b branch_name"
+    attr_reader :pure_opts
+
+    # 完整指令，如："mgit checkout -b branch_name"
+    attr_reader :absolute_cmd
+
+    # 本次传入的mgit指令中自定义的部分，如："mgit checkout -b branch_name --mrepo boxapp BBAAccount --command test"的"[[--mrepo boxapp BBAAccount],[--command test]]"
+    attr_reader :raw_opts
+
+    # 本次传入的mgit指令中git透传的部分，如："mgit checkout -b branch_name --mrepo boxapp BBAAccount"的"[[-b branch_name]]"
+    # has define method git_opts
+
+    # 所有已注册的参数列表
+    attr_reader :opt_list
+
+    def initialize(cmd, pure_opts, absolute_cmd, raw_opts)
+      @cmd = cmd
+      @pure_opts = pure_opts
+      @absolute_cmd = absolute_cmd
+      @raw_opts = raw_opts
+      @git_opts = []
+    end
+
+    def register_opts(opts)
+      return if opts.nil?
+      @opt_list = OptList.new(opts)
+    end
+
+    # 注册解析指令
+    def resolve!
+      @raw_opts.each { |raw_opt|
+        next if @opt_list.did_register_opt?(raw_opt.first)
+        @git_opts.push(raw_opt)
+      }
+
+      @raw_opts -= @git_opts
+
+      __resolve_git_opts
+      __resolve_raw_opts
+    end
+
+    # 更新指令值
+    # @!attribute [Array / String / true / false] value
+    #
+    def update_opt(key, value, priority:nil, info:nil)
+      return unless @opt_list.did_register_opt?(key)
+      opt = @opt_list.registered_opt(key)
+      case opt.value_type
+      when Array
+        opt.value = Array(value)
+      when String
+        opt.value = value.is_a?(Array) ? value.first.to_s : value.to_s
+      else # boolean
+        opt.value = value
+      end
+
+      opt.priority = priority if !priority.nil?
+      opt.info = info if info.is_a?(String)
+    end
+
+    # 获取某个option
+    def opt(key)
+      @opt_list.opt(key)
+    end
+
+    # 获取某个option的描述信息
+    def info(key)
+      return '' unless @opt_list.did_register_opt?(key)
+      @opt_list.registered_opt(key)&.info
+    end
+
+    # 获取原生git指令（非自定义的指令）
+    #
+    # @param raw [Boolean] default: true，true：用空格拼接成一个字符串返回。false：直接返回数组，如‘-k k1 k2’ -> 【'-k','k1','k2'】
+    #
+    # @return [Type] description_of_returned_object
+    #
+    def git_opts(raw: true)
+      return @git_opts unless raw
+      opts = []
+      @git_opts.each { |e_arr|
+        opts += e_arr
+      }
+      opts.join(' ')
+    end
+
+    # 遍历本次调用中传入过值（或有默认值）的选项，未传入值且无默认值则不遍历
+    def enumerate_valid_opts
+      @opt_list.opts_ordered_by_priority.each { |opt|
+        next unless @opt_list.did_set_opt?(opt.key)
+        yield(opt) if block_given?
+      }
+    end
+
+    # 判断一个字符串是否是option（以'--'或'-'开头）
+    def is_option?(opt_str)
+      (opt_str =~ /-/) == 0 || (opt_str =~ /--/) == 0
+    end
+
+    # 输出本次指令的具体值信息，调试时使用
+    def show_detail
+      @opt_list.opts.each { |opt|
+        puts '======='
+        puts "key:#{opt.key}"
+        puts "value:#{opt.value}"
+        puts "info:#{opt.info}"
+        puts "\n"
+      }
+    end
+
+    # 输出参数说明信息
+    def show_info
+      @opt_list.opts.each { |opt|
+        short_key = "#{opt.short_key}, " if !opt.short_key.nil?
+        puts "\n"
+        puts Output.blue_message("[#{short_key}#{opt.key}]")
+        puts "#{opt.info}"
+      }
+    end
+
+    private
+
+    def __resolve_git_opts
+      # 统一将值用双引号括起来，避免空格和特殊字符等引起错误
+      @git_opts.each { |e_arr|
+        next unless is_option?(e_arr.first)
+        e_arr.map!.with_index { |e, i|
+          # 如果是 -- / - 开始的option，则增加"" 避免特殊字符的错误，eg： --yoo=ajsdaf  => --yoo="ajsdaf"
+          # 如果是 repo1 repo2 这样的option，则不作处理，eg： yoo ajsdaf => yoo ajsdaf
+          e = "\"#{e}\"" if !is_option?(e) && i > 0
+          e
+        }
+      }
+    end
+
+    def __resolve_raw_opts
+      @raw_opts.each { |raw_opt|
+        key = raw_opt.first
+        opt = @opt_list.registered_opt(key)
+
+        case opt.value_type
+        when :boolean
+          raise "参数#{key}格式错误，禁止传入参数值！(用法：#{key})" if raw_opt.count != 1
+          opt.value = true
+        when :string
+          raise "参数#{key}格式错误，只能传入一个参数值！(用法：#{key} xxx)" if raw_opt.count != 2
+          opt.value = raw_opt.last.to_s
+        when :array
+          raise "参数#{key}格式错误，至少传入一个参数值！(用法：#{key} xxx xxx ...)" if raw_opt.count < 2
+          opt.value = raw_opt[1..-1]
+        end
+      }
+    end
+  end
+
+end

data/lib/m-git/argv/opt.rb

@@ -0,0 +1,38 @@
+#coding=utf-8
+
+module MGit
+
+  class ARGV
+    # 单个选项, 如‘--k1=v1 --k2 v2 v3 --flag’
+    # '--k1=v1'     key: '--k1', value: 'v1'
+    # '--k2 v2 v3'  key: '--k2', value: ['v2', 'v3']
+    # '--flag'      key: '--flag', value: true
+    class Opt
+      attr_reader   :key
+      attr_accessor :value
+      attr_accessor :short_key        # 短参数格式，如’--command’对应的‘-c’
+      attr_accessor :priority         # 参数解析优先级
+      attr_accessor :info             # 参数说明
+
+      # @!attribute value值类型
+      # :array  :string  :boolean
+      attr_accessor :value_type
+
+      def initialize(key, default:nil, short_key:nil, priority:-1, info:nil, type: :array)
+        raise("初始化Opt选项必须有key") if key.nil?
+        @key, @value, @short_key, @priority, @info = key, default, short_key, priority, info
+        @value_type = type
+      end
+
+      def empty?
+        value.nil? || value == '' || value == [] || value == false
+      end
+
+      def validate?
+        return false if empty?
+        value.is_a?(value_type)
+      end
+    end
+  end
+
+end

data/lib/m-git/argv/opt_list.rb

@@ -0,0 +1,71 @@
+#coding=utf-8
+
+module MGit
+  class ARGV
+    # 参数对象列表
+    class OptList
+
+      # [Array<ARGV::Opt>] 参数对象数组
+      attr_accessor :opts
+
+      # attr_reader :valid_opts
+
+      def initialize(opts)
+        @opts = opts
+      end
+
+      def valid_opts
+        @opts.select { |e| !e.empty? }
+      end
+
+      # 获取某个参数对象
+      #
+      # @param key [String] 参数名，如‘--key’
+      #
+      # @return [ARGV::Opt] 参数对象，若参数未设置过则返回nil
+      #
+      def opt(key)
+        valid_opts.find { |e| (e.key == key || e.short_key == key) }
+      end
+      alias_method :opt_with, :opt
+
+      # 判断参数是否设置过值
+      #
+      # @return [Boolean] 参数是否设置过值
+      #
+      def did_set_opt?(key)
+        !opt(key).nil?
+      end
+
+      ## all opts ###
+
+      # 返回某个注册过的参数对象
+      #
+      # @param key [String] 参数名，如‘--key’
+      #
+      # @return [ARGV::Opt] 参数对象，无论参数是否设置过，只要注册过就返回
+      #
+      def registered_opt(key)
+        @opts.find { |e| (e.key == key || e.short_key == key) }
+      end
+
+      # 判断参数是否注册过
+      #
+      # @return [Boolean] 参数是否注册过
+      #
+      def did_register_opt?(key)
+        !registered_opt(key).nil?
+      end
+
+      # 将参数根据优先级排序（逆序）后返回
+      #
+      # @return [Array<ARGV::Opt>] 包含参数对象的数组
+      #
+      def opts_ordered_by_priority
+        # 按照优先级进行降序排序
+        opts.sort_by { |e| e.priority }.reverse
+      end
+    end
+  end
+
+end