m-git 2.5.4

data/lib/m-git/foundation/loger.rb

@@ -0,0 +1,129 @@
+#coding=utf-8
+
+require 'logger'
+require 'fileutils'
+module MGit
+
+  # 日志模块配置
+  class Loger
+
+    MGIT_LOG_FILE_NAME = 'mgit.log'
+
+    #
+    # 配置Log模块
+    #
+    # @param root [String] 工程根目录
+    #
+    def self.config(root)
+      # 是否开启log
+      begin
+        log_enable = MGit::MGitConfig.query_with_key(root, :logenable)
+      rescue MGitClass::Error => e
+        log_enable = TRUE
+      end
+      MGit::Loger.set_log_enable(log_enable)
+
+      # 配置log路径
+      log_dir = File.join(root, MGit::Constants::PROJECT_DIR[:log_dir])
+      FileUtils.mkdir_p(log_dir) if !Dir.exist?(log_dir)
+      file_path = File.join(log_dir, MGIT_LOG_FILE_NAME)
+      MGit::Loger.set_log_file(file_path)
+
+      # 配置log的level
+      begin
+        log_level = MGit::MGitConfig.query_with_key(root, :loglevel)
+      rescue MGitClass::Error => e
+        log_level = 1
+      end
+      MGit::Loger.set_log_level(log_level)
+
+    end
+
+  end
+
+
+  # 日志模块
+  class Loger
+    DEFAULT_SHIFT_SIZE = 1048576  #每个文件1M
+    DEFAULT_SHIFT_AGE = 10 # 保留10个文件
+    DEFAULT_LOG_FILE = "./mgit.log"
+
+    #
+    # 设置mgit log是否开启 默认开启
+    #
+    # @param log_enable [Boolean] 是否开启log日志
+    #
+    def self.set_log_enable(log_enable)
+      @log_enable = log_enable
+    end
+
+    #
+    # 设置mgit log的打印等级
+    #
+    # @param level [Enumerable]: Logger::DEBUG | Logger::INFO | Logger::ERROR | Logger::FATAL
+    #
+    def self.set_log_level(level)
+      self.logger.level = level
+    end
+
+    #
+    # 设置mgit log的文件名， 默认路径在工作区的 .mgit/logs/mgit.log
+    #
+    def self.set_log_file(file_path)
+      @log_file = file_path
+    end
+
+    #
+    # 打印 DEBUG类型的log
+    #
+    def self.debug(message)
+      self.logger.debug(message) if @log_enable
+    end
+
+    #
+    # 打印 DEBUG类型的log
+    #
+    def self.info(message)
+      self.logger.info(message) if @log_enable
+    end
+
+    #
+    # 打印 WARN类型的log
+    #
+    def self.warn(message)
+      self.logger.warn(message) if @log_enable
+    end
+
+    #
+    # 打印 ERROR类型的log
+    #
+    def self.error(message)
+      self.logger.error(message) if @log_enable
+    end
+
+    #
+    # 打印 FATAL类型的log
+    #
+    def self.fatal(message)
+      self.logger.fatal(message) if @log_enable
+    end
+
+    private
+    def self.logger
+      unless @logger
+        @log_enable ||= TRUE
+        @log_level ||= Logger::INFO
+        @log_file ||= DEFAULT_LOG_FILE
+        @logger = Logger.new(@log_file, shift_age = DEFAULT_SHIFT_AGE, shift_size = DEFAULT_SHIFT_SIZE)
+        @logger.level = @log_level
+        @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+        @logger.formatter = proc do | severity, datetime, progname, msg|
+          "#{datetime} - #{severity} - : #{msg}\n"
+        end
+      end
+      @logger
+    end
+
+  end
+
+end

data/lib/m-git/foundation/mgit_config.rb

@@ -0,0 +1,222 @@
+#coding=utf-8
+
+require_relative 'utils'
+
+module MGit
+  class MGitConfig
+
+    CONFIG_KEY = {
+        :managegit  => {
+            :info     => '是否将.git实体托管给MGit，托管后仓库内的.git目录是软链 (true/false)',
+            :type     => 'Boolean',
+            :default  => true
+        },
+        :maxconcurrentcount => {
+            :info     => 'MGit操作的最大并发数? (Integer)',
+            :type     => 'Integer',
+            :default  => MGit::Utils.logical_cpu_num
+        },
+        :syncworkspace => {
+            :info     => '是否按照配置表同步工作区? (true/false)',
+            :type     => 'Boolean',
+            :default  => true
+        },
+        :savecache => {
+            :info     => '同步工作区时回收的仓库是否保留到缓存中? (true/false)',
+            :type     => 'Boolean',
+            :default  => false
+        },
+        :logenable => {
+            :info     => '是否开启日志打印，操作日志会收集到.mgit/log目录下? (true/false)',
+            :type     => 'Boolean',
+            :default  => true
+        },
+        :loglevel => {
+            :info     => '日志的打印级别, DEBUG = 0, INFO = 1, WARN = 2, ERROR = 3, FATAL = 4',
+            :type     => 'Integer',
+            :default  => 1
+        }
+    }
+
+    class << self
+
+      # 查询配置
+      #
+      # @param root [String] 工程根目录
+      #
+      # @raise [MGit::Error] 异常错误
+      #
+      def query(root)
+        config, error = __load_file(root)
+        if !error.nil?
+          raise Error.new(error)
+          return
+        elsif block_given?
+          # 如果文件存在但无内容，此时读取到的数据类型是FalseClass，此处统一规范化
+          config = {} if !config.is_a?(Hash)
+          yield(config)
+        end
+      end
+
+      # Description of #query_with_key
+      #
+      # @param root [String] 工程根目录
+      #
+      # @param key_symbol [Symbol] 符号key值
+      #
+      # @return [Object] 配置值
+      #
+      # @raise [MGit::Error] 异常错误
+      def query_with_key(root, key_symbol)
+        query(root) { |config|
+          if !config[key_symbol.to_s].nil?
+            return config[key_symbol.to_s]
+          elsif !CONFIG_KEY[key_symbol].nil?
+            return CONFIG_KEY[key_symbol][:default]
+          else
+            return nil
+          end
+        }
+      end
+
+      # 更新配置
+      #
+      # @param root [String] 工程根目录
+      #
+      # @raise [MGit::Error] 异常错误
+      #
+      def update(root)
+        # 加载配置
+        config, error = __load_file(root)
+        if !error.nil?
+          raise Error.new(error)
+          return
+        end
+
+        # 如果文件存在但无内容，此时读取到的数据类型是FalseClass，此处统一规范化
+        config = {} if !config.is_a?(Hash)
+
+        # 更新
+        yield(config) if block_given?
+
+        # 更新完后校验格式
+        if !config.is_a?(Hash)
+          raise Error.new("工具配置更新数据格式错误，更新失败！")
+          return
+        end
+
+        # 写回配置
+        error = write_to_file(root, config)
+        if !error.nil?
+          raise Error.new(error)
+          return
+        end
+      end
+
+      # 列出所有配置
+      #
+      # @param root [String] 工程根目录
+      #
+      def dump_config(root)
+        query(root) { |config|
+          CONFIG_KEY.each_with_index { |(key, value_dict), index|
+            line = "#{Output.blue_message("[#{value_dict[:info]}]")}\n#{key.to_s}: "
+            set_value = config[key.to_s]
+            if !set_value.nil?
+              line += "#{set_value}\n\n"
+            else
+              line += "#{value_dict[:default]}\n\n"
+            end
+            puts line
+          }
+        }
+      end
+
+      # 验证一个value的值是否符合key的类型
+      #
+      # @param root [String] 工程根目录
+      #
+      # @param key [String] 字符串key值
+      #
+      # @param value [String] 字符串格式的值
+      #
+      # @return [Object] key值对应的合法类型value值
+      #
+      def to_suitable_value_for_key(root, key, value)
+        return unless CONFIG_KEY.keys.include?(key.to_sym)
+        return nil if !value.is_a?(String)
+
+        key_dict = CONFIG_KEY[key.to_sym]
+        set_value = nil
+
+        # 是否是数字
+        if key_dict[:type] == 'Integer' && value.to_i.to_s == value
+          set_value = value.to_i
+
+          # 是否是true
+        elsif key_dict[:type] == 'Boolean' && value.to_s.downcase == 'true'
+          set_value = true
+
+          # 是否是false
+        elsif key_dict[:type] == 'Boolean' && value.to_s.downcase == 'false'
+          set_value = false
+
+          # 是否是其他字符串
+        elsif key_dict[:type] == 'String' && value.is_a?(String)
+          set_value = value
+        end
+
+        set_value
+      end
+
+      private
+
+      # 加载mgit配置文件
+      #
+      # @param root [String] 工程根目录
+      #
+      # @return [(Hash, Boolean)] (配置内容，错误信息)
+      #
+      def __load_file(root)
+        config_path = File.join(root, Constants::MGIT_CONFIG_PATH)
+        if File.exists?(config_path)
+          begin
+            return YAML.load_file(config_path), nil
+          rescue => e
+            return nil, "工具配置文件\"#{File.basename(config_path)}\"读取失败，原因：\n#{e.message}"
+          end
+        end
+
+        [nil, nil]
+      end
+
+      # 将配置写回文件
+      #
+      # @param root [String] 工程根目录
+      #
+      # @param content [Hash] 新配置
+      #
+      # @return [String] 错误信息
+      #
+      def write_to_file(root, content)
+        config_path = File.join(root, Constants::MGIT_CONFIG_PATH)
+        begin
+          FileUtils.rm_f(config_path) if File.exist?(config_path)
+
+          dir_name = File.dirname(config_path)
+          FileUtils.mkdir_p(dir_name) if !Dir.exist?(dir_name)
+
+          file = File.new(config_path, 'w')
+          if !file.nil?
+            file.write(content.to_yaml)
+            file.close
+          end
+          return nil
+        rescue => e
+          return "工具配置文件\"#{File.basename(config_path)}\"写入失败，原因：\n#{e.message}"
+        end
+      end
+    end
+
+  end
+end

data/lib/m-git/foundation/operation_progress_manager.rb

@@ -0,0 +1,139 @@
+#coding=utf-8
+
+module MGit
+  # 本类用于缓存/加载操作中间态
+  class OperationProgressContext
+
+    # 现场信息关键字段
+    CONTEXT_CMD = 'cmd'
+    CONTEXT_OPTS = 'opts'
+    CONTEXT_BRANCH = 'branch'
+    CONTEXT_REPOS = 'repos'
+    CONTEXT_OTHER = 'other'
+
+    attr_accessor :type     # String: 本次进入中间态的操作类型，可自定义，如'merge_in_progress','rebase_in_progress'等。该字段用于索引缓存的中间态信息，需要唯一。
+    attr_accessor :cmd      # String: 本次执行指令，如'merge'，'checkout'等
+    attr_accessor :opts     # String: 本次执行参数，如'--no-ff'，'--ff'等
+    attr_accessor :branch   # String: 仓库当前分支
+    attr_accessor :repos    # [String]: 本次执行哪些仓库的名称数组
+    attr_accessor :other    # Object: 其他信息，可自定义
+
+    def initialize(type)
+      self.type = type
+      self.other = {}
+    end
+
+    # 将中间态对象序列化为Hash
+    def serialize
+      return {
+          CONTEXT_CMD         => self.cmd,
+          CONTEXT_OPTS        => self.opts,
+          CONTEXT_BRANCH      => self.branch,
+          CONTEXT_REPOS       => self.repos,
+          CONTEXT_OTHER       => self.other
+      }
+    end
+
+    # 反序列化
+    #
+    # @param dict [Hash] 中间态Hash
+    #
+    def deserialize(dict)
+      self.cmd = dict[CONTEXT_CMD]
+      self.opts = dict[CONTEXT_OPTS]
+      self.branch = dict[CONTEXT_BRANCH]
+      self.repos = dict[CONTEXT_REPOS]
+      self.other = dict[CONTEXT_OTHER]
+    end
+
+    # 校验中间态是否合法，仓库可缺省，若缺省则表示所有仓库
+    #
+    # @return [Boolean] 是否合法
+    #
+    def validate?
+      return !self.cmd.nil? && !self.opts.nil? && !self.branch.nil?
+    end
+  end
+
+  class OperationProgressManager
+
+    PROGRESS_TYPE = {
+        :merge  =>  'merge_in_progress',
+        :rebase =>  'rebase_in_progress',
+        :pull   =>  'pull_in_progress'
+    }.freeze
+
+    class << self
+
+      # 进入中间态
+      #
+      # @param root [String] 多仓库根目录
+      #
+      # @param context [OperationProgressContext] 中间态对象
+      #
+      def trap_into_progress(root, context)
+        begin
+          MGitConfig.update(root) { |config|
+            config[context.type] = context.serialize
+          }
+        rescue Error => e
+          Output.puts_fail_message(e.msg)
+        end
+      end
+
+      # 删除中间态
+      #
+      # @param root [String] 多仓库根目录
+      #
+      # @param type [String] 自定义Key值，用于索引中间态信息
+      #
+      def remove_progress(root, type)
+        begin
+          MGitConfig.update(root) { |config|
+            config.delete(type)
+          }
+        rescue Error => e
+          Output.puts_fail_message(e.msg)
+        end
+      end
+
+      # 是否处于中间态中
+      def is_in_progress?(root, type)
+        is_in_progress = false
+        begin
+          MGitConfig.query(root) { |config|
+            is_in_progress = !config[type].nil?
+          }
+        rescue Error => e
+          Output.puts_fail_message(e.msg)
+        end
+        return is_in_progress
+      end
+
+      # 加载中间态上下文
+      #
+      # @param root [String] 多仓库根目录
+      #
+      # @param type [String] 自定义Key值，用于索引中间态信息
+      #
+      # @return [OperationProgressContext，String] 中间态对象；错误信息
+      #
+      def load_context(root, type)
+        context = nil
+        error = nil
+        begin
+          MGitConfig.query(root) { |config|
+            dict = config[type]
+            context = OperationProgressContext.new(type)
+            context.deserialize(dict)
+          }
+        rescue Error => e
+          Output.puts_fail_message(e.msg)
+          error = e.msg
+        end
+        return context, error
+      end
+
+    end
+  end
+end