gitee_pack 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dc9ed0c8ed8560299b51e8792849c5477af73ce272bb8fdf5e27d74d43d255b
-  data.tar.gz: 1b5032fc834a56aa302171135abc5ab12c72e92a066b31f702c3867b6b18b9d0
+  metadata.gz: c9adbed7bd55f10620212932db594690e1bd2b7c4629abaa53dcd24a0f180c9a
+  data.tar.gz: 6de7ad9b25d042db6dde002a8ec8030cae8632ab5c82d765c9e5ec7a8cb54d21
 SHA512:
-  metadata.gz: e013edb21e086b032ff9749882480deea8ae1b208ee942e5ba5afeb40e4f9ab7097edb25371972b2b684ba3162fb6a9e3d67ab101ac6d6371a191441275d07b5
-  data.tar.gz: dccd5c9885eefa3200459f772721d4c63174d5107b3a16e07ba937b5a832db85673e402f39ee5153e0c57fa92c1b5a4956c745a188e316bec404c55f7a85218e
+  metadata.gz: 995bd5a5b776510047cc125aedda46c17778b28fcd1832e838ea227eb6d2c1e4995df8d2d078f8dd7c336c6d2deb09737918deac87d1238ca80e0f7429bb8705
+  data.tar.gz: ffb05ca566555eca10fc14321dcadc64d4091541d3875cc899b44bb78cdba85a8454cb9df86fa057c456595286fee45c6984022b3acc668e404ea994fc43971b

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/README.md

@@ -1,6 +1,7 @@
 # GiteePack
 
-一个GiteePremium增量打包工具
+一个 GiteePremium 增量打包工具
+
 
 ## 安装
 
@@ -8,19 +9,20 @@
 $ gem install gitee_pack
 ```
 
+
 ## 使用
 
 ### 打包
 
-在gitee-premium目录执行：
+在 gitee-premium 目录执行：
 
 ```shell
-$ gitee_pack [base] [head]
+$ gitee_pack BASE HEAD
 ```
 
-base: Commit提交的SHA值作为对比起点
+BASE: Commit提交的SHA值作为对比起点
 
-head: Commit提交的SHA值作为对比终点
+HEAD: Commit提交的SHA值作为对比终点
 
 示例：
 
@@ -30,25 +32,99 @@ $ gitee_pack a9b6296 6ac0f97
 
 执行后会在当前目录下生成一个增量文件的升级包，例如 upgrade-20200430
 
-### 部署
+升级包目录结构说明：
 
-先备份原有文件
+```
+upgrade-20200430
+├── commit.txt         // 记录 base、head 的 CommitID
+├── diff.txt           // 记录 base 和 head 之间的所有改动文件名称
+├── delete.txt         // 记录 base 和 head 之间被删除的文件名称
+├── run.log            // 打包时的运行日志
+├── files              // 用于存放代码文件的目录
+└── update.sh          // 部署脚本，更新代码时使用
+```
+
+### 更多选项
+
+```
+$ gitee_pack --help
+Usage: gitee_pack BASE HEAD [options]
+
+Specific options:
+        --skip-compile-asset         Skip compile asset.
+        --skip-compile-webpack       Skip compile webpack.
+        --skip-package-gem           Skip package gem.
+    -h, --help                       Show this message.
+    -v, --version                    Show version info.
+```
+
+`--skip-compile-asset`   当有 asset 文件改动时，跳过 asset 资源文件编译
+
+`--skip-compile-webpack` 当有 vue 文件改动时，跳过 npm 资源文件编译
+
+`--skip-package-gem`     当有 gem 改动时，跳过 gem 打包
+
+### 错误值
+
+执行 gitee_pack 命令，错误值解释如下
+
+- `100` vue 资源文件编译失败
+- `101` asset 资源文件编译失败
+- `102` gem 打包失败
+- `200` 升级包不完整
+
+### 部署
 
-在升级包中执行update.sh脚本，一键自动部署
+在升级包中执行 update.sh 脚本，一键自动部署
 
 ```shell
 $ cd upgrade-20200430
-$ ./update.sh [gitee-path]
+$ ./update.sh GITEE_PATH
 ```
 
-gitee-path: gitee-premium的绝对路径
+GITEE_PATH: gitee-premium 的绝对路径
 
 示例
 
 ```shell
-$ ./update.sh /home/gite/gitee-premium/gitee
+$ ./update.sh /home/git/gitee-premium/gitee
 ```
 
+
+## 版本变更
+
+### v1.5.0
+
+- feat: 支持打包完成后，检测包的完整性
+- feat: 支持跳过编译流程打包
+- feat: 支持新增、修改、删除 Gem 时自动打包
+- feat: 支持记录打包日志到升级包中
+- fix: 修复打包过程中失败，以非 0 值推出程序
+
+### v1.4.0
+
+- feat: 支持部署备份代码时过滤 tmp 目录（感谢@彭超越大佬）
+
+### v1.3.0
+
+- feat: 支持检测 asset 文件改动并自动编译及打包
+
+### v1.2.0
+
+- feat: 支持部署时代码备份功能
+- feat: 打包时记录 Commit 信息
+- fix: 修复部署脚本 Bug
+
+### v1.1.0
+
+- feat: 支持通过脚本自动化部署改动文件
+
+### v1.0.0
+
+- feat: 支持代码文件打包
+- feat: 支持检测 webpack 文件改动并自动编译及打包
+
+
 ## 常见问题
 
 1. 执行 `git status`、`git diff` 等命令，中文名文件显示为乱码，导致中文名文件无法打包成功。
@@ -56,14 +132,3 @@ $ ./update.sh /home/gite/gitee-premium/gitee
 ```shell
 $ git config --global core.quotepath false
 ```
-
-## TODO
-
-- 支持gem打包
-- 源码中记录版本信息功能
-- ~~支持代码文件打包~~
-- ~~支持webpacks打包~~
-- ~~支持部署备份功能~~
-- ~~支持assets打包~~
-- ~~支持中文文件名打包~~
-- ~~支持备份代码过滤tmp目录~~

data/bin/gitee_pack

@@ -2,19 +2,10 @@
 
 require 'gitee_pack'
 
-HELP_CMD = ['-v', '-h', '--help'].freeze
-
-if HELP_CMD.include?(ARGV[0])
-  GiteePack.logger.debug "Usage: #{File.basename($0)} [base] [head]"
-  GiteePack.logger.debug "Version: #{GiteePack::VERSION}"
-  exit 0
-end
-
-
 base, head = ARGV[0], ARGV[1]
 
 start_at = Time.now
-GiteePack.execute(base, head)
+GiteePack.execute(base, head, { ARGV: ARGV })
 end_at = Time.now
 
 GiteePack.logger.success "Complete! cost time: #{end_at - start_at} seconds."

data/exe/update.sh

@@ -14,15 +14,6 @@ if [ $FINAL = '/' ]; then
   GITEE_PATH=${GITEE_PATH%?}
 fi
 
-# Check path
-APP_PATH=$GITEE_PATH/app
-CONFIG_APTH=$GITEE_PATH/config
-DB_APTH=$GITEE_PATH/db
-if [ ! -d $APP_PATH ] || [ ! -d $CONFIG_PATH ] || [ ! -d $DB_PATH ]; then
-  printf "\033[31mERROR: $GITEE_PATH is not the gitee-path.\033[0m\n"
-  exit 1
-fi
-
 # Backup
 BACKUP_DIR="$(dirname $GITEE_PATH)/backup/`date "+%Y%m%d%H%M%S"`/$(basename $GITEE_PATH)"
 echo mkdir -p $BACKUP_DIR
@@ -51,6 +42,13 @@ if [ -d files/public/assets  ] && [ -d $ASSET_PATH  ]; then
   echo rm -rf $ASSET_PATH
 fi
 
+# Delete bundle cache dir
+BUNDLE_CACHE_PATH=$GITEE_PATH/vendor/cache
+if [ -d files/vendor/cache  ] && [ -d $BUNDLE_CACHE_PATH  ]; then
+  rm -rf $BUNDLE_CACHE_PATH
+  echo rm -rf $BUNDLE_CACHE_PATH
+fi
+
 # Delete files with delete.txt
 DELETE_FILE=delete.txt
 if [ -f $DELETE_FILE ]; then

data/lib/gitee_pack.rb

@@ -6,13 +6,16 @@ require 'gitee_pack/folder'
 require 'gitee_pack/filer'
 require 'gitee_pack/precompile'
 require 'gitee_pack/logger'
+require 'gitee_pack/verifier'
+require 'gitee_pack/status'
+require 'gitee_pack/parser'
 require 'gitee_pack/worker'
 
 module GiteePack
   class CmdError < StandardError; end
 
   def self.execute(base, head, options = {})
-    Worker.new(base, head).execute
+    Worker.new(base, head, options).execute
   end
 
   def self.logger

data/lib/gitee_pack/diff.rb

@@ -1,10 +1,10 @@
 module GiteePack
   class Diff
-    attr_reader :empty_folders, :delete_files, :cp_files, :webpack_files, :asset_files
+    attr_reader :empty_folders, :delete_files, :cp_files,
+                :webpack_files, :asset_files, :gem_files
 
     IGNORE_FILES = [
       'config/gitee.yml',
-      'config/gitee.yml.example',
       'config/database.yml',
       'config/startup.yml',
       'app/assets/javascripts/webpack/webide'
@@ -18,6 +18,7 @@ module GiteePack
       @cp_files      = []
       @webpack_files = []
       @asset_files   = []
+      @gem_files     = []
 
       init_list_by_files
     end
@@ -44,6 +45,10 @@ module GiteePack
       !asset_files.empty?
     end
 
+    def has_gem_file?
+      !gem_files.empty?
+    end
+
     private
 
     def init_list_by_files
@@ -65,6 +70,8 @@ module GiteePack
           @webpack_files << file
         elsif file.start_with?('app/assets')
           @asset_files << file
+        elsif file.start_with?('Gemfile')
+          @gem_files << file
         end
 
         if Dir.exist?(file)

data/lib/gitee_pack/filer.rb

@@ -3,31 +3,40 @@ module GiteePack
     class << self
       def cp_diff_files(files)
         files.each do |file|
-          dirname = File.join(Folder.upgrade_files_dir, File.dirname(file))
-          FileUtils.mkdir_p dirname
-          FileUtils.cp file, dirname
-          GiteePack.logger.debug "cp #{file} #{dirname}"
+          from = file
+          to   = File.join(Folder.upgrade_files_dir, File.dirname(file))
+          cp_file from, to
         end
       end
 
       def cp_webpack_files
-        dirname = File.join(Folder.upgrade_files_dir, 'public/webpacks')
-        FileUtils.mkdir_p dirname
-        FileUtils.cp_r 'public/webpacks/.', dirname
-        GiteePack.logger.debug "cp -r public/webpacks/. #{dirname}"
+        from = File.join(Folder.webpacks_dir, '.')
+        to   = File.join(Folder.upgrade_files_dir, Folder.webpacks_dir)
+        cp_file from, to
       end
 
       def cp_asset_files
-        dirname = File.join(Folder.upgrade_files_dir, 'public/assets')
-        FileUtils.mkdir_p dirname
-        FileUtils.cp_r 'public/assets/.', dirname
-        GiteePack.logger.debug "cp -r public/assets/. #{dirname}"
+        from = File.join(Folder.assets_dir, '.')
+        to   = File.join(Folder.upgrade_files_dir, Folder.assets_dir)
+        cp_file from, to
+      end
+
+      def cp_gems
+        from = File.join(Folder.bundle_cache_dir, '.')
+        to   = File.join(Folder.upgrade_files_dir, Folder.bundle_cache_dir)
+        cp_file from, to
       end
 
       def cp_update_file
-        filepath = File.join(File.expand_path('../../../', __FILE__), 'exe/update.sh')
-        FileUtils.cp filepath, Folder.upgrade_dir
-        GiteePack.logger.debug "cp #{filepath} #{Folder.upgrade_dir}"
+        from = File.join(File.expand_path('../../../', __FILE__), 'exe/update.sh')
+        to   =  Folder.upgrade_dir
+        cp_file from, to
+      end
+
+      def cp_file(from, to)
+        FileUtils.mkdir_p to
+        GiteePack.logger.debug "cp -r #{from} #{to}"
+        FileUtils.cp_r from, to
       end
 
       def g_file(path, content = [])
@@ -47,6 +56,10 @@ module GiteePack
       def g_commit_file(content = [])
         g_file(File.join(Folder.upgrade_dir, 'commit.txt'), content)
       end
+
+      def g_log_file(content= [])
+        g_file(File.join(Folder.upgrade_dir, 'run.log'), content)
+      end
     end
   end
 end

data/lib/gitee_pack/folder.rb

@@ -24,6 +24,18 @@ module GiteePack
           GiteePack.logger.debug "rm -rf #{dir}"
         end
       end
+
+      def webpacks_dir
+        'public/webpacks/'
+      end
+
+      def assets_dir
+        'public/assets/'
+      end
+
+      def bundle_cache_dir
+        'vendor/cache/'
+      end
     end
   end
 end

data/lib/gitee_pack/logger.rb

@@ -1,23 +1,40 @@
 module GiteePack
   class Logger
+    attr_accessor :history
+
+    def initialize
+      @history = []
+    end
+
     def debug(content)
-      puts content
+      logging content
     end
 
     def info(content)
-      puts "\033[36m#{content}\033[0m"
+      logging "\033[36m#{content}\033[0m"
     end
 
     def warn(content)
-      puts "\033[33m#{content}\033[0m"
+      logging "\033[33m#{content}\033[0m"
     end
 
     def error(content)
-      puts "\033[31m#{content}\033[0m"
+      logging "\033[31m#{content}\033[0m"
     end
 
     def success(content)
-      puts "\033[32m#{content}\033[0m"
+      logging "\033[32m#{content}\033[0m"
+    end
+
+    private
+
+    def logging(content)
+      set_history content
+      puts content
+    end
+
+    def set_history(content)
+      @history << content
     end
   end
 end

data/lib/gitee_pack/parser.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+
+module GiteePack
+  class Parser
+    def execute(args)
+      options = default_options
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: gitee_pack BASE HEAD [options]'
+
+        opts.separator ''
+        opts.separator 'Specific options:'
+
+        opts.on('--skip-compile-asset', 'Skip compile asset.') do
+          options[:skip_asset_compile] = true
+        end
+
+        opts.on('--skip-compile-webpack', 'Skip compile webpack.') do
+          options[:skip_webpack_compile] = true
+        end
+
+        opts.on('--skip-package-gem', 'Skip package gem.') do
+          options[:skip_gem_compile] = true
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message.') do
+          GiteePack.logger.debug opts
+          exit
+        end
+
+        opts.on_tail('-v', '--version', 'Show version info.') do
+          GiteePack.logger.debug "Version: #{GiteePack::VERSION}"
+          exit
+        end
+      end.parse!(args)
+
+      options
+    end
+
+    private
+
+    def default_options
+      {
+        skip_asset_compile:   false,
+        skip_webpack_compile: false,
+        skip_gem_compile:     false
+      }
+    end
+  end
+end

data/lib/gitee_pack/precompile.rb

@@ -2,15 +2,27 @@ module GiteePack
   class Precompile
     class << self
       def with_webpack
-        Folder.rm_dir('public/webpacks')
-        GiteePack.logger.info 'webpack files is compiling, please wait ...'
-        `npm run build-vendor && npm run f-build`
+        GiteePack.logger.info '[Compiling] webpack files is compiling, please wait ...'
+        Folder.rm_dir(Folder.webpacks_dir)
+        cmd = 'npm run build-vendor && npm run f-build'
+        GiteePack.logger.debug cmd
+        `#{cmd}`
       end
 
       def with_asset
-        Folder.rm_dir('public/assets')
-        GiteePack.logger.info 'asset files is compiling, please wait ...'
-        `bundle exec rake assets:precompile:all RAILS_ENV=production RAILS_GROUPS=assets`
+        GiteePack.logger.info '[Compiling] asset files is compiling, please wait ...'
+        Folder.rm_dir(Folder.assets_dir)
+        cmd = 'RAILS_ENV=production bundle exec rake assets:precompile'
+        GiteePack.logger.debug cmd
+        `#{cmd}`
+      end
+
+      def with_gem
+        GiteePack.logger.info '[Compiling] gems is compiling, please wait ...'
+        Folder.rm_dir(Folder.bundle_cache_dir)
+        cmd = 'bundle package --all'
+        GiteePack.logger.debug cmd
+        `#{cmd}`
       end
     end
   end

data/lib/gitee_pack/status.rb

@@ -0,0 +1,14 @@
+module GiteePack
+  class Status
+    ERR_COMPILE_WEBPACK = 100
+    ERR_COMPILE_ASSET   = 101
+    ERR_COMPILE_GEM     = 102
+    ERR_VERIFY_PACKAGE  = 200
+
+    class << self
+      def success?(status_code)
+        (!status_code.nil?) && (status_code.to_i.eql? 0)
+      end
+    end
+  end
+end

data/lib/gitee_pack/verifier.rb

@@ -0,0 +1,21 @@
+module GiteePack
+  class Verifier
+    def execute(from, to)
+      result = system "diff -r #{from} #{to} > /dev/null 2>&1"
+      message = get_message(result, from)
+      [result, message]
+    end
+
+    private
+
+    def get_message(result, file_path)
+      msg = if result
+              "\033[32m[OK]\033[0m"
+            else
+              "\033[31m[FAILED]\033[0m"
+            end
+
+      "#{file_path}\t#{msg}"
+    end
+  end
+end

data/lib/gitee_pack/version.rb

@@ -1,3 +1,3 @@
 module GiteePack
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/gitee_pack/worker.rb

@@ -1,37 +1,141 @@
 module GiteePack
   class Worker
-    def initialize(base, head)
-      @base = base
-      @head = head
-      @diff = Diff.new(@base, @head)
+    def initialize(base, head, options = {})
+      @options = Parser.new.execute(options[:ARGV])
+      @base    = base
+      @head    = head
+      @diff    = Diff.new(@base, @head)
+      @errors  = []
     end
 
     def execute
       Folder.mkdir_upgrade
       Filer.cp_diff_files(@diff.cp_files)
 
-      if @diff.has_webpack_file?
+      compile_webpack_files_and_cp
+      compile_asset_files_and_cp
+      compile_gems_and_cp
+
+      Filer.g_diff_file(@diff.diff_files_with_status)
+      Filer.g_delete_file(@diff.delete_files)
+      Filer.g_commit_file(["old: #{@base}", "new: #{@head}"])
+      Filer.cp_update_file
+
+      puts_empty_folders
+      puts_deleted_files
+
+      verify_upgrade_package
+
+      Filer.g_log_file GiteePack.logger.history
+    end
+
+    private
+
+    def compile_webpack_files_and_cp
+      if process_webpack?
         Precompile.with_webpack
+        unless Status.success?($?)
+          Filer.g_log_file GiteePack.logger.history
+          exit Status::ERR_COMPILE_WEBPACK
+        end
+
         Filer.cp_webpack_files
       end
+    end
 
-      if @diff.has_asset_file?
+    def compile_asset_files_and_cp
+      if process_asset?
         Precompile.with_asset
+        unless Status.success?($?)
+          Filer.g_log_file GiteePack.logger.history
+          exit Status::ERR_COMPILE_ASSET
+        end
+
         Filer.cp_asset_files
       end
+    end
 
-      Filer.g_diff_file(@diff.diff_files_with_status)
-      Filer.g_delete_file(@diff.delete_files)
-      Filer.g_commit_file(["old: #{@base}", "new: #{@head}"])
-      Filer.cp_update_file
+    def compile_gems_and_cp
+      if process_gem?
+        Precompile.with_gem
+        unless Status.success?($?)
+          Filer.g_log_file GiteePack.logger.history
+          exit Status::ERR_COMPILE_GEM
+        end
 
-      puts_empty_folders
-      puts_delete_files
+        Filer.cp_gems
+      end
     end
 
-    private
+    def verify_upgrade_package
+      GiteePack.logger.info '[Verifying] package is verifying, please wait ...'
+
+      verify_digest_with_cp_files
+      verify_digest_with_webpacks_dir
+      verify_digest_with_assets_dir
+      verify_digest_with_gems_dir
+
+      unless @errors.empty?
+        Filer.g_log_file GiteePack.logger.history
+        exit Status::ERR_VERIFY_PACKAGE
+      end
+    end
+
+    def verify_digest_with_cp_files
+      @diff.cp_files.each do |file|
+        from = File.join(Folder.upgrade_files_dir, file)
+        to = file
+        verify_files from, to
+      end
+    end
+
+    def verify_digest_with_webpacks_dir
+      if process_webpack?
+        from = File.join(Folder.upgrade_files_dir, Folder.webpacks_dir)
+        to = Folder.webpacks_dir
+        verify_files from, to
+      end
+    end
+
+    def verify_digest_with_assets_dir
+      if process_asset?
+        from = File.join(Folder.upgrade_files_dir, Folder.assets_dir)
+        to = Folder.assets_dir
+        verify_files from, to
+      end
+    end
+
+    def verify_digest_with_gems_dir
+      if process_gem?
+        from = File.join(Folder.upgrade_files_dir, Folder.bundle_cache_dir)
+        to = Folder.bundle_cache_dir
+        verify_files from, to
+      end
+    end
+
+    def verify_files(from, to)
+      result, message = Verifier.new.execute(from, to)
+      GiteePack.logger.debug message
+      set_errors(result, message) unless result
+    end
+
+    def process_webpack?
+      !@options[:skip_webpack_compile] && @diff.has_webpack_file?
+    end
+
+    def process_asset?
+      !@options[:skip_asset_compile] && @diff.has_asset_file?
+    end
+
+    def process_gem?
+      !@options[:skip_gem_compile] && @diff.has_gem_file?
+    end
+
+    def set_errors(result, message)
+      @errors << { result: result, message: message }
+    end
 
-    def puts_delete_files
+    def puts_deleted_files
       unless @diff.delete_files.empty?
         GiteePack.logger.warn "\nDelete Files:"
         GiteePack.logger.warn "#{@diff.delete_files.join("\n")}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitee_pack
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - jk-sun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -31,7 +31,10 @@ files:
 - lib/gitee_pack/filer.rb
 - lib/gitee_pack/folder.rb
 - lib/gitee_pack/logger.rb
+- lib/gitee_pack/parser.rb
 - lib/gitee_pack/precompile.rb
+- lib/gitee_pack/status.rb
+- lib/gitee_pack/verifier.rb
 - lib/gitee_pack/version.rb
 - lib/gitee_pack/worker.rb
 homepage: https://github.com/JK-Sun/gitee_pack