big_keeper 0.7.0 → 0.7.1

data/lib/big_keeper/util/bigkeeper_parser.rb

@@ -1,3 +1,5 @@
+require 'big_keeper/util/logger'
+
 # Bigkeeper module
 module BigKeeper
   def self.version(name)
@@ -33,6 +35,9 @@ module BigKeeper
 
     def self.parse(bigkeeper)
       if @@config.empty?
+
+        Logger.error("Can't find a Bigkeeper file in current directory.") if !BigkeeperParser.definitely_exists?(bigkeeper)
+
         content = File.read bigkeeper
         content.gsub!(/version\s/, 'BigKeeper::version ')
         content.gsub!(/user\s/, 'BigKeeper::user ')
@@ -45,6 +50,13 @@ module BigKeeper
       end
     end
 
+    def self.definitely_exists? path
+      folder = File.dirname path
+      filename = File.basename path
+      # Unlike Ruby IO, ls, and find -f, this technique will fail to locate the file if the case is wrong:
+      not %x( find "#{folder}" -name "#{filename}" ).empty?
+    end
+
     def self.parse_version(name)
       @@config[:version] = name
     end
@@ -75,7 +87,7 @@ module BigKeeper
       elsif params[:git]
         parse_modules_pod(name, params)
       else
-        raise %(There should be ':path =>' or ':git =>' for pod #{name})
+        Logger.error(%(There should be ':path =>' or ':git =>' for pod #{name}))
       end
     end
 
@@ -118,7 +130,11 @@ module BigKeeper
     end
 
     def self.sourcemodule_path
-      @@config[:source].join(",").reverse.chop.reverse
+      if @@config[:source] == nil
+        return ""
+      else
+        @@config[:source].join(",").reverse.chop.reverse
+      end
     end
 
     def self.module_full_path(home_path, user_name, module_name)
@@ -155,7 +171,7 @@ module BigKeeper
 
     def self.verify_modules(modules)
       modules.each do |item|
-        raise "Can not find module #{item} in Bigkeeper file" unless @@config[:modules][item]
+        Logger.error("Can not find module #{item} in Bigkeeper file") unless @@config[:modules][item]
       end
     end
 

data/lib/big_keeper/util/git_operator.rb

@@ -1,3 +1,5 @@
+require 'big_keeper/util/logger'
+
 module BigKeeper
   # Operator for got
   class GitOperator
@@ -37,23 +39,23 @@ module BigKeeper
       has_branch
     end
 
-    def git_checkout(path, branch_name)
+    def checkout(path, branch_name)
       Dir.chdir(path) do
         IO.popen("git checkout #{branch_name}") do |io|
           io.each do |line|
-            raise "Checkout #{branch_name} failed." if line.include? 'error'
+            Logger.error("Checkout #{branch_name} failed.") if line.include? 'error'
           end
         end
       end
     end
 
-    def git_fetch(path)
+    def fetch(path)
       Dir.chdir(path) do
         `git fetch origin`
       end
     end
 
-    def git_rebase(path, branch_name)
+    def rebase(path, branch_name)
       Dir.chdir(path) do
         `git rebase origin/#{branch_name}`
       end
@@ -72,18 +74,12 @@ module BigKeeper
       end
     end
 
-    def first_push(path, branch_name)
+    def push_to_remote(path, branch_name)
       Dir.chdir(path) do
         `git push -u origin #{branch_name}`
       end
     end
 
-    def push(path)
-      Dir.chdir(path) do
-        p `git push`
-      end
-    end
-
     def pull(path)
       Dir.chdir(path) do
         p `git pull`
@@ -111,9 +107,20 @@ module BigKeeper
       has_changes
     end
 
-    def del(path, branch_name)
+    def dicard(path)
+      Dir.chdir(path) do
+        `git checkout . && git clean -xdf`
+      end
+    end
+
+    def del_local(path, branch_name)
       Dir.chdir(path) do
         p `git branch -D #{branch_name}`
+      end
+    end
+
+    def del_remote(path, branch_name)
+      Dir.chdir(path) do
         p `git push origin --delete #{branch_name}`
       end
     end

data/lib/big_keeper/version.rb

@@ -1,3 +1,3 @@
 module BigKeeper
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/lib/big_keeper.rb

@@ -7,14 +7,15 @@ require 'big_keeper/util/git_operator'
 
 require 'big_keeper/model/gitflow_type'
 
-require 'big_keeper/command/feature&hotfix/feature_start'
-require 'big_keeper/command/feature&hotfix/feature_finish'
-require 'big_keeper/command/feature&hotfix/feature_switch'
-require 'big_keeper/command/feature&hotfix/feature_update'
-require 'big_keeper/command/feature&hotfix/feature_pull'
-require 'big_keeper/command/feature&hotfix/feature_push'
-require 'big_keeper/command/release/release_home'
-require 'big_keeper/command/release/release_module'
+require 'big_keeper/command/feature&hotfix/start'
+require 'big_keeper/command/feature&hotfix/finish'
+require 'big_keeper/command/feature&hotfix/switch'
+require 'big_keeper/command/feature&hotfix/update'
+require 'big_keeper/command/feature&hotfix/pull'
+require 'big_keeper/command/feature&hotfix/push'
+require 'big_keeper/command/feature&hotfix/delete'
+require 'big_keeper/command/release/home'
+require 'big_keeper/command/release/module'
 require 'big_keeper/command/pod/podfile_lock'
 
 require 'big_keeper/service/git_service'
@@ -25,7 +26,7 @@ include GLI::App
 
 module BigKeeper
   # Your code goes here...
-  program_desc 'Efficiency improvement for iOS modular development, iOSer using this tool can make modular development easier.'
+  program_desc 'Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.'
 
   flag %i[p path], default_value: './'
   flag %i[v ver], default_value: 'Version in Bigkeeper file'
@@ -46,7 +47,7 @@ module BigKeeper
     exit
   end
 
-  desc 'Feature operations'
+  desc 'Gitflow feature operations'
   command :feature do |c|
 
     c.desc 'Start a new feature with name for given modules and main project'
@@ -56,16 +57,16 @@ module BigKeeper
         help_now!('feature name is required') if args.length < 1
         name = args[0]
         modules = args[(1...args.length)] if args.length > 1
-        feature_start(path, version, user, name, modules)
+        start(path, version, user, name, modules, GitflowType::FEATURE)
       end
     end
 
-    c.desc 'Update moduels for the feature with name'
+    c.desc 'Update modules for the feature with name'
     c.command :update do |update|
       update.action do |global_options, options, args|
         help_now!('user name is required') if user and user.empty?
         modules = args[(0...args.length)] if args.length > 0
-        feature_update(path, user, modules)
+        update(path, user, modules, GitflowType::FEATURE)
       end
     end
 
@@ -75,7 +76,7 @@ module BigKeeper
         help_now!('user name is required') if user and user.empty?
         help_now!('feature name is required') if args.length < 1
         name = args[0]
-        feature_switch(path, version, user, name)
+        switch_to(path, version, user, name, GitflowType::FEATURE)
       end
     end
 
@@ -83,7 +84,7 @@ module BigKeeper
     c.command :pull do |pull|
       pull.action do |global_options, options, args|
         help_now!('user name is required') if user and user.empty?
-        feature_pull(path, user)
+        pull(path, user, GitflowType::FEATURE)
       end
     end
 
@@ -94,7 +95,7 @@ module BigKeeper
         help_now!('comment message is required') if args.length < 1
         help_now!(%Q(comment message should be wrappered with '' or "")) if args.length > 1
         comment = args[0]
-        feature_push(path, user, comment)
+        push(path, user, comment, GitflowType::FEATURE)
       end
     end
 
@@ -102,7 +103,17 @@ module BigKeeper
     c.command :finish do |finish|
       finish.action do |global_options, options, args|
         help_now!('user name is required') if user and user.empty?
-        feature_finish(path, user)
+        finish(path, user, GitflowType::FEATURE)
+      end
+    end
+
+    c.desc 'Delete feature with name'
+    c.command :delete do |delete|
+      delete.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        help_now!('feature name is required') if args.length < 1
+        name = args[0]
+        delete(path, user, name, GitflowType::FEATURE)
       end
     end
 
@@ -117,7 +128,88 @@ module BigKeeper
     end
   end
 
-  desc 'Release operations'
+  desc 'Gitflow hotfix operations'
+  command :hotfix do |c|
+
+    c.desc 'Start a new hotfix with name for given modules and main project'
+    c.command :start do |start|
+      start.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        help_now!('hotfix name is required') if args.length < 1
+        name = args[0]
+        modules = args[(1...args.length)] if args.length > 1
+        start(path, version, user, name, modules, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Update modules for the hotfix with name'
+    c.command :update do |update|
+      update.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        modules = args[(0...args.length)] if args.length > 0
+        update(path, user, modules, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Switch to the hotfix with name'
+    c.command :switch do |switch|
+      switch.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        help_now!('hotfix name is required') if args.length < 1
+        name = args[0]
+        switch_to(path, version, user, name, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Pull remote changes for current hotfix'
+    c.command :pull do |pull|
+      pull.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        pull(path, user, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Push local changes to remote for current hotfix'
+    c.command :push do |push|
+      push.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        help_now!('comment message is required') if args.length < 1
+        help_now!(%Q(comment message should be wrappered with '' or "")) if args.length > 1
+        comment = args[0]
+        push(path, user, comment, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Finish current hotfix'
+    c.command :finish do |finish|
+      finish.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        finish(path, user, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'Delete hotfix with name'
+    c.command :delete do |delete|
+      delete.action do |global_options, options, args|
+        help_now!('user name is required') if user and user.empty?
+        help_now!('feature name is required') if args.length < 1
+        name = args[0]
+        delete(path, user, name, GitflowType::HOTFIX)
+      end
+    end
+
+    c.desc 'List all the hotfixes'
+    c.command :list do |list|
+      list.action do
+        branchs = GitService.new.branchs_with_type(File.expand_path(path), GitflowType::HOTFIX)
+        branchs.each do |branch|
+          p branch
+        end
+      end
+    end
+  end
+
+  desc 'Gitflow release operations'
   command :release do |c|
 
     c.desc 'Release home project operations'
@@ -141,14 +233,28 @@ module BigKeeper
     end
 
     c.desc 'release module'
-    c.command :module do |finish|
-      finish.action do |global_options, options, args|
-        help_now!('module name is required') if args.length != 1
-        raise Logger.error("release version is required") if version == nil
-        module_name = args[0]
-        start_module_release(path, version, user, module_name)
+    c.command :module do |m|
+      m.desc 'Start release module project'
+      m.command :start do |start|
+        start.action do |global_options, options, args|
+          help_now!('module name is required') if args.length != 1
+          raise Logger.error("release version is required") if version == nil
+          module_name = args[0]
+          release_module_start(path, version, user, module_name)
+        end
+      end
+
+      m.desc 'finish release module project'
+      m.command :finish do |finish|
+        finish.action do |global_options, options, args|
+          help_now!('module name is required') if args.length != 1
+          raise Logger.error("release version is required") if version == nil
+          module_name = args[0]
+          release_module_finish(path, version, user, module_name)
+        end
       end
     end
+
   end
 
   desc 'Podfile operation'
@@ -172,7 +278,7 @@ module BigKeeper
     end
   end
 
-  desc 'Version'
+  desc 'Show version of bigkeeper'
   command :version do |version|
     version.action do |global_options, options, args|
       p "big-keeper (#{VERSION})"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_keeper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - mmoaay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -197,7 +197,7 @@ description: Efficiency improvement for iOS modular development, iOSer using thi
 email:
 - mmoaay@sina.com
 executables:
-- big-keeper
+- bigkeeper
 - setup
 extensions: []
 extra_rdoc_files: []
@@ -213,24 +213,27 @@ files:
 - README.md
 - Rakefile
 - big_keeper.gemspec
-- bin/big-keeper
+- bin/bigkeeper
 - bin/setup
 - docs/en-US/FEATURE.md
+- docs/en-US/README.md
 - docs/zh-CN/BIGKEEPER_FILE.md
-- docs/zh-CN/FEATURE.md
+- docs/zh-CN/FEATURE&HOTFIX.md
+- docs/zh-CN/PODFILE.md
 - docs/zh-CN/README.md
+- docs/zh-CN/RECOMMEND.md
 - docs/zh-CN/RELEASE.md
 - lib/big_keeper.rb
-- lib/big_keeper/command/feature&hotfix/feature_finish.rb
-- lib/big_keeper/command/feature&hotfix/feature_pull.rb
-- lib/big_keeper/command/feature&hotfix/feature_push.rb
-- lib/big_keeper/command/feature&hotfix/feature_start.rb
-- lib/big_keeper/command/feature&hotfix/feature_switch.rb
-- lib/big_keeper/command/feature&hotfix/feature_update.rb
+- lib/big_keeper/command/feature&hotfix/delete.rb
+- lib/big_keeper/command/feature&hotfix/finish.rb
+- lib/big_keeper/command/feature&hotfix/pull.rb
+- lib/big_keeper/command/feature&hotfix/push.rb
+- lib/big_keeper/command/feature&hotfix/start.rb
+- lib/big_keeper/command/feature&hotfix/switch.rb
+- lib/big_keeper/command/feature&hotfix/update.rb
 - lib/big_keeper/command/pod/podfile_lock.rb
-- lib/big_keeper/command/release/release_home.rb
-- lib/big_keeper/command/release/release_module.rb
-- lib/big_keeper/command/release/release_module.sh
+- lib/big_keeper/command/release/home.rb
+- lib/big_keeper/command/release/module.rb
 - lib/big_keeper/model/gitflow_type.rb
 - lib/big_keeper/model/operate_type.rb
 - lib/big_keeper/model/podfile_model.rb
@@ -247,6 +250,24 @@ files:
 - lib/big_keeper/util/podfile_detector.rb
 - lib/big_keeper/util/podfile_operator.rb
 - lib/big_keeper/version.rb
+- resources/banner.png
+- resources/keynote/big-keeper-readme-example.key
+- resources/keynote/big-keeper-readme-feature.key
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.002.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.003.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.004.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.005.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.006.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.007.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.008.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.009.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.010.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.011.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.012.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.013.jpeg
+- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.014.jpeg
+- resources/keynote/big-keeper-readme-release.key
 - resources/readme/big-keeper-readme.001.png
 - resources/readme/big-keeper-readme.002.png
 - resources/readme/big-keeper-readme.003.png
@@ -254,9 +275,11 @@ files:
 - resources/readme/big-keeper-readme.005.png
 - resources/readme/big-keeper-readme.006.png
 - resources/readme/big-keeper-readme.007.png
-- resources/readme/big-keeper-readme.008.jpeg
-- resources/readme/big-keeper-readme.009.jpeg
-- resources/readme/big-keeper-readme.010.jpeg
+- resources/readme/big-keeper-readme.008.png
+- resources/readme/big-keeper-readme.009.png
+- resources/readme/big-keeper-readme.010.png
+- resources/readme/big-keeper-readme.011.png
+- resources/readme/big-keeper-readme.012.png
 homepage: https://github.com/BigKeeper/big-keeper
 licenses:
 - MIT

data/docs/zh-CN/FEATURE.md

@@ -1,88 +0,0 @@
-# feature - 功能开发流程
-
-直接在命令行执行 `big-keeper feature --help` 可以查看其提供的所有功能：
-
-```
-NAME
-    feature - Feature operations
-
-SYNOPSIS
-    big-keeper [global options] feature [command options] finish
-    big-keeper [global options] feature [command options] list
-    big-keeper [global options] feature [command options] pull
-    big-keeper [global options] feature [command options] push
-    big-keeper [global options] feature [command options] start
-    big-keeper [global options] feature [command options] switch
-    big-keeper [global options] feature [command options] update
-
-COMMAND OPTIONS
-    -u, --user=arg - (default: mmoaay)
-
-COMMANDS
-    finish - Finish current feature
-    list   - List all the features
-    pull   - Pull remote changes for current feature
-    push   - Push local changes to remote for current feature
-    start  - Start a new feature with name for given modules and main project
-    switch - Switch to the feature with name
-    update - Update moduels for the feature with name
-```
-
-全局参数如下：
-
-- -u, --user：用户名，默认是 git global config 的 user.name，会显示在命令提示信息中，比如上述提示信息中的默认用户名是 mmoaay
-
-功能列表如下：
-
-- start：
-  开始一个新的 feature，输入参数依次为：
-  - feature 的名字;
-  - 开发该 feature 需要改动的业务模块名。可以多个，用空格隔开；如果不指定，取 **Bigkeeper 文件中所有的业务模块名**。
-- finish：结束当前 feature；
-- switch：切换到一个已经存在的 feature，输入参数为 feature 名；
-- update：
-  更新一个 feature 需要改动的业务模块，输入参数依次为：
-  - feature 的名字;
-  - 开发该 feature 需要改动的业务模块名。可以多个，用空格隔开；如果不指定，取 **Bigkeeper 文件中所有的业务模块名**。
-- pull：拉取当前 feature 主项目和业务模块的远程 git 仓库更新；
-- push：提交并推送当前 feature 主项目和业务模块的本地变更到远程 git 仓库，输入参数为提交信息；
-- list：显示当前的 feature 列表。
-
-## feature 的工作区
-
-![](../../resources/readme/big-keeper-readme.001.png)
-
-feature 的工作区主要由两部分组成：
-
-- 主项目；
-- 相关业务模块，我们把 Podfile 中引用方式为 `:path => {业务模块本地路径}` 的模块做为相关业务模块。
-
-主项目和每个相关业务模块又有各自的工作区，由三个部分组成：
-
-- 当前代码区改动；
-- stash 缓存区，当用户需要切换新的 feature 时，对于用户来不及提交的改动，我们会缓存到各个项目的 stash 中，（PS：所以代码突然不见了不要担心，都在 git 的 stash 里面），而当用户切换回某个 feature 时，我们会把和该 feature 分支同名的 stash 恢复回来，从而使用户可以继续开发之前未完成的部分，因为需要通过 feature 的分支名来匹配 stash，而 git stash 又没有提供给 stash 命名的功能，所以我们实现了 [big-stash](https://github.com/BigKeeper/big-stash) 来完成这个功能；
-- git。
-
-## feature start 流程
-
-![](../../resources/readme/big-keeper-readme.002.png)
-
-## feature finish 流程
-
-![](../../resources/readme/big-keeper-readme.003.png)
-
-## feature switch 流程
-
-![](../../resources/readme/big-keeper-readme.004.png)
-
-## feature update 流程
-
-![](../../resources/readme/big-keeper-readme.005.png)
-
-## feature pull 流程
-
-![](../../resources/readme/big-keeper-readme.006.png)
-
-## feature push 流程
-
-![](../../resources/readme/big-keeper-readme.007.png)