dev_flow 0.0.4

data/README.md

@@ -0,0 +1,200 @@
+DevFlow: ROADMAP/git based develop flow control
+===================================================
+
+WARNING: Pre-alpha implementation for internal use only.
+
+Pre-Requirement
+-----------------
+
+- A Bash command line console (cygwin is supported)
+- A workable git installation and `git` command in the path
+- Ruby 1.9.x
+
+Install
+-----------
+
+    $ [sudo] gem install dev_flow 
+
+Work Flow
+-------------
+
+Under you development working directory:
+
+1. Write a `ROADMAP` file in a specified format
+2. (Optional) create `members.yml` file define known developers
+2. Run `dw` command 
+
+Sub-commands for typical work flow jobs are:
+
+    $ dw [info]            # show task information
+
+    $ dw progress 80       # mark the task as completed at 80 percent
+    $ dw pg 80             # same as progress
+
+    $ dw complete          # mark that the implemention is completed
+
+    $ dw close             # this command is for project leader only, it will close the current task,
+                           # merge it into `develop` trunk and delete the git branch both 
+                           # locally and remotely.
+
+    $ dw release           # like close but for release branch only. 
+                           # the change will be merged into both `develop` and `master` branch.
+
+More commands may plug in later.
+
+ROADMAP File Format
+--------------------
+
+The default task control file is `ROADMAP`, unless you specify an other file using 
+
+    $ dw --roadmap OTHER_FILE
+
+See more options by issue
+
+    $ dw -h 
+
+or
+
+    $ dw --help
+
+### Information Header
+
+Contents between two
+
+    % ---
+
+(with a head `%` and at least 3 dashes) lines and before any definition of task will be
+treated as information header. Which should be in YAML format and should at least contains
+`title`, `leader`, and `team`, like:
+
+    % ---
+    title: A Sample Project
+    status: producing
+    members:
+      qsh: [Qin Shihuang, 'qsh@qinchao.com']
+    leader: sunyr
+    team: [huangw xuyc]
+    year: 2013
+    % ---
+
+If you define `year` in the header, you can write date in `mm/dd` format instead 
+of `yyyy/mm/dd`. Usually you should define developers in a separate `members.yml` file,
+but you can define extra members in the header area too (usually for who only join to
+one or few projects).
+
+### Team and Leader
+
+Leader has a higher priority than team members, only leader can edit roadmap, 
+close a task branch, and make a release, etc.
+
+If you also defines `supervisor`, `moderator`, they can update the roadmap too,
+but can not close or release a branch.
+
+IMPORTANT: those kind of permission is just introduced for avoid miss operation,
+NOT intended as a security mechanism. You still needs setup permissions on your
+remote git server if security is a concern.
+
+Generally you are encouraged to use short names in team members to save typings, 
+by define a `members.yml` file in the following format:
+
+    members:
+      short_name: [Display Name, 'email@address.com']
+
+This is also a way to avoid typos in ROADMAP definitions.
+
+### The Task Tree
+
+Every line start with a `[+]` (or `[++]`, `[+++]` ...) will be treated as a task definition. 
+
+A typical task definition line should following the format:
+
+    [+] branch_name: taskname date/to/start[-date/to/stop] @resource[;resource] [-> dependent_on;dependent_on]
+
+- `[+]` one or more + in bracket is the indicator of task definition, 
+one + represent a 1st degree (level) task, ++ represent a second degree task, .... 
+Task degree with smaller number may contains several tasks with higher degree number.
+
+- `branch_name` must contains only a-z, 0-9, dot and underscore, which is used as git branch name,
+and also serves as a id for that task within the same ROADMAP file.
+
+- `taskname` could use any characters provide not contains 'date like' parts (see the next description).
+
+- `date/to/start` should in format 2013/03/03 or 03/03 if you defined `year` in the 
+header (so you can specify only the `mm/dd` part). Use `mm/dd-mm/dd` (`yyyy/mm/dd-yyyy/mm/dd`) 
+to specify a period.
+
+If the task duration is within one day, date/to/stop part can be omitted.
+
+- `@resource`: resource should correspond to leader or one of the team member. 
+If the task need more than one resources use ; to separate them.
+
+- If the task depends on other task, puts their id after `->`.
+
+### Git Branching Models
+
+- `master`, `develop`, `staging` and `production` branches are **trunks**. Code implementation 
+and modification should be done in non-trunk branches and merged into trunks according the following roles.
+
+- The `master` trunk is a production ready branch, `develop` is the **integration** branch
+that contains latest code of completed feature that passed all integration test.
+
+- Development branches (**task branch**) should stem from `develop` often, and merged
+back into `develop` trunk as soon as the implementation complete and passed all unit and 
+integration tests.
+
+- Release branches is purely for code review, test and necessary bug fix, after pass all of that, 
+they will be merged into both `develop` and `master` trunk, and a `release-xxx` tag will be attached.
+
+### Semantic Versioning and Special Tasks
+
+Tasks with branch name starts with `release_`, `hotfix_` ... 
+will affect the version number. 
+
+You use `release_` branch to manually manage major and minor versioning, 
+e.g. `release_v0.1` will create a tag `version-0.1`, and hotfix branches 
+will add-up fix numbers after it such as: `version-0.1.28`. All those 
+branches will merged into `master` trunk.
+
+`milestone_` is a special type of task that corresponding to important event 
+in the development flow (for example event for team code review, 
+customer acceptance review, etc.), but do not affect version numbers, so do other tasks.
+
+Sometimes you may want to use 'prepare releases' such as `release_v0.1a`, `release_v0.1b`, 
+avoid sandwich tasks between prepare releases and releases.
+
+Local Configuration
+---------------------
+
+Default is stored in `.dev_flow` file and will be set to `git`'s ignore list (`.gitignore`) 
+(so these settings only affect your local working directory).
+
+Without this file `dw` will go into the initialization mode (by asking you some questions).
+
+You can use `--local-config FILE` to store those information in an other file name.
+
+`.dev_flow` is also in yaml format and the most important key are `whoami` and `git_remote`,
+`whoami` specifies who is currently working on the local working directory, 
+and `git_remote` defines witch git remote server to use (default is `origin`).
+With out `git_remote` the `dw` command will not try to communicate to remote git server.
+
+Command Details
+-------------------
+
+- `dw init` default command if no `.dev_flow` file found.
+
+- `dw [info]` or `dw` without command will list the tasks and if the working directory 
+is clean, let user chose to switch to working for known tasks.
+
+- `dw progress 0-98` set task progress. `dw pg` is an alias of `dw progress`. You are
+encouraged to frequently use this command to store you changes to remote servers (typically 
+several times a day).
+
+- `dw complete` set task progress to 99 (complete a task), urge the leader to review/test and
+close it.
+
+- `dw close`/`dw release` close the task by the leader, or release it (to master trunk).
+
+- `dw update-roadmap` or `dw ur` used for update the roadmap (should only be used on `devleop` trunk).
+
+- `dw cleanup` will delete local branches corresponding completed tasks (TODO).
+

data/ROADMAP

@@ -0,0 +1,15 @@
+ROADMAP for dev_flow Development
+==================================
+
+% -----
+title: dev_flow development tools
+status: producing
+members:
+  huangw: [Huang Wei, "huangw@pe-po.com"]
+leader: huangw
+year: 2013
+% -----
+
+[+] release_v0.3: with version number handling 03/25 @huangw:03/25
+[+] hotfix_taginfo: put tag situation on info screen 03/25 @huangw:03/25
+[+] release_v0.4: with cleanup closed local task branches 03/25 @huangw:03/25

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+

data/bin/dw

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# vim: syn=ruby
+
+$: << 'lib'
+
+require "optparse"
+require "term/ansicolor"
+class String; include Term::ANSIColor end
+require "dev_flow"
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: dw [options] [command]"
+
+  options[:roadmap] = 'ROADMAP' # the roadmap file
+  opts.on('-r ROADMAP_FILE', '--roadmap ROADMAP_FILE', 'use an other roadmap file') do |roadmap|
+    options[:roadmap] = roadmap
+  end
+
+  options[:local_config] = '.dev_flow'
+  opts.on('-l LOCAL_CONFIG', '--local-config LOCAL_CONFIG', 'use an other local configuration file') do |lc|
+    options[:local_config] = lc
+  end
+
+  options[:members_file] = 'members.yml'
+  opts.on('-m MEMBERS_FILE', '--members_file MEMBERS_FILE', 'use an other members file') do |mf|
+    options[:members_file] = mf
+    raise "the specified members file #{mf} is not exists." unless File.exists? mf
+  end
+
+  opts.on('-i', '--filter-tasks', 'show only tasks assigned to me') do
+    options[:filter_tasks] = true
+  end
+
+  opts.on('-o', '--offline', 'do not use remote git server') do 
+    options[:offline] = true
+  end
+
+  opts.on('-v', '--verbose', 'print more messages') do
+    options[:verbose] = true
+  end
+
+  opts.on_tail('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!(ARGV)
+
+# determine the command
+command = ARGV[0] || 'info'
+cmd_alias = {'pg' => 'progress', 'update-roadmap' => 'ur', 'clean' => 'cleanup'}
+command = cmd_alias[command] if cmd_alias[command]
+
+if %w[info init complete progress close release ur update-roadmap cleanup clean].include? command
+  options[:command] = command
+else
+  puts "unknown command #{command}".red
+  exit
+end
+
+unless File.exists? (options[:roadmap])
+  puts "No roadmap file (#{options[:roadmap]}) found, can not continue.".red
+  exit
+end
+
+# switch to init mode unless .dev_flow file exists
+unless command == 'init'
+  unless File.exists? (options[:local_config])
+    puts "Initializing your environment ... "
+    DevFlow.invoke!(options, 'init')
+  end
+end
+
+if command == 'release'
+  options[:release] = true
+  command = 'close'
+end
+
+DevFlow.invoke!(options, command)

data/dev_flow.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'dev_flow/version'
+
+Gem::Specification.new 'dev_flow', DevFlow::VERSION do |s|
+  s.description       = "dev_flow is a bundle of tools for ROADMAP/git based development flow control."
+  s.summary           = "a bundle of tools for ROADMAP/git based development flow control."
+  s.authors           = ["Huang Wei"]
+  s.email             = "huangw@pe-po.com"
+  s.homepage          = "https://github.com/huangw/dev_flow-gem"
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore]
+  s.executables       << "dw"
+  s.test_files        = Dir.glob("{spec,test}/**/*.rb")
+  s.rdoc_options      = %w[--line-numbers --inline-source --title DevFlow --main README.rdoc --encoding=UTF-8]
+
+  s.add_dependency 'term-ansicolor'    # for colorful command line display
+  s.add_development_dependency 'rspec', '~> 2.5'
+end
+

data/examples/ROADMAP

@@ -0,0 +1,75 @@
+ROADMAP for Dulcinea-Syobu Phase
+====================================
+Created at 2013-02-25
+
+% ----
+title: Dulcinea P.R.T 客户端（syobu阶段）
+status: prototyping
+description: "
+PixPlus.Me的移动客户端，基于corona SDK，涵盖iOS/Android的手机和Tablet设备（P.R.T.三种情况）。Syobu Phase以phone为主，实现主要软件功能的内测版本。
+"
+members:
+  lizh: [Li Zhonghua, lizh@pe-po.com]
+  sunyr: [Sun Yunrui, sunyr@pe-po.com]
+  liudx: [Liu Dongxu, liudx@pe-po.com]
+  cuibg: [Cui Baoguo, cuibg@pe-po.com]
+  wangqh: [Wang Qinghua, wangqh@pe-po.com]
+supervisor: huangw
+leader: xuyc
+moderator: cuibg
+team: [huangw, xuyc, liudx, cuibg, wangqh]
+year: 2013
+% ----
+
+[+] scope: 确定开发范围，拆分单元开发模块 02/25-03/15 @huangw;xuyc
+  [++] mod_scope: 开发范围和开发框架概述 02/26-03/15 @huangw;xuyc:40
+  [++] unit_tree_tool: 单元构件树状图工具 02/26-03/03 @huangw:03/04
+  [++] ui_unit: 用树状图描述UI单元结构 03/04-03/06 @xuyc;huangw:03/06
+  [++] rewrite_unit_tree: 重构单元构件树状图及制图工具 03/06-03/18 @huangw:10
+  [++] unit_spec: 单元开发部件的式样书草图 02/27-03/20 @xuyc;liudx:10
+  [++] frame: 单元-测试-结合的开发框架 03/03-03/20 @huangw;xuyc:10
+[+] proto: 制作移动客户端原型 03/07-03/25 @huangw;xuyc;wangqh;cuibg
+  [++] research: 调查开发环境的限制 03/07-03/20 @xuyc
+
+[+] model: 人、组、pixplus和clip的基础模型 02/26-03/15 @huangw
+  [++] open_search: 调查weibo,facebook等开放服务平台的API 02/26-03/10 @lizh;huangw;cuibg;wangqh:02/28
+    [+++] s_sina_tencent: 调查新浪weibo和腾讯微博、QQ的用户、分组和post模型 02/26-03/01 @cuibg:02/28
+    [+++] s_renren_douban: 调查人人网，豆瓣网的用户、分组和post模型 02/26-03/01 @wangqh:02/28
+    [+++] s_twitter_facebook: 调查Twitter和Facebook的用户、分组和post模型 02/26-03/01 @lizh:02/28
+    [+++] s_gplus_pin_tumblr: 调查GooglePlus，Tumblr和Pinterest的用户、分组和post模型 02/26-03/01 @xuyc:02/28
+  [++] models_prime: 初步建模 02/28-03/06 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/07
+    [+++] tables_struct: 生成模型表的基本结构 03/01 @huangw:03/01
+    [+++] refine_ts: 详细调整模型表的基本结构 03/02-03/03 @huangw:03/04
+    [+++] pic_pix_prime_m: picture和pix模型 02/28-03/06 @sunyr;cuibg:03/04
+    [+++] modify_pix_prime_m: 修改picture模型 03/05 @sunyr:03/05
+    [+++] user_group_prime_m: 用户和组的模型 02/28-03/06 @lizh;wangqh:03/06
+    [+++] fo_clip_prime_m: follower和clip模型 02/28-03/06 @huangw;xuyc:03/07
+    [+++] action_prime_m: action和comment相关的模型 03/04-03/06 @huangw:03/07
+  [++] milestone_model_0.1: Review Model 0.1 03/06 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/14
+  [++] models_second: 建模第二步 03/06-03/11 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/14
+    [+++] pic_pix_second_m: picture和pix模型 03/06-03/11 @sunyr;cuibg:03/12
+    [+++] user_group_second_m: 用户和组的模型 03/06-03/11 @lizh;wangqh:03/13
+    [+++] fo_clip_second_m: follower和clip模型 03/06-03/11 @huangw;xuyc:03/14
+    [+++] action_second_m: action和comment相关的模型 03/06-03/11 @huangw:03/10	
+  [++] milestone_model_0.2: Review Model 0.2 03/21 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] app_server: 基于sinatra和rabl的rack服务器架构 03/05-03/25 @huangw:03/10 
+  [++] rabl: 调查测试rabl（速度、documentation tool） 03/05-03/10 @huangw:03/10
+  [++] sinatra: 搭建sinatra基础结构 03/09 @huangw:03/10
+  [++] api_test: 使用cucumber或者bunny-carrot（luobo）搭建测试环境 03/09-03/15 @huangw;lizh:03/10
+[+] app_server_revise: 重构新的sinatra rack服务器架构 03/14-03/18 @huangw:03/15
+[+] api_design_prime: 初步设计基本的API结构 03/15-03/30 @xuyc;huangw;sunyr:36
+[+] model_spec: 设计model的测试框架，开始书写spec 03/13-03/30 @huangw;lizh:10
+
+[+] release_api_design_0.1: Review API Design 0.1 03/30 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] api_design_second: 设计基本的API结构第二步 03/30-04/10 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+  [++] api_dsgn_pix_pic_sec: picture和pix的API结构 03/30-04/10 @sunyr;cuibg
+  [++] api_dsgn_usr_grp_sec: 用户和组的API结构  03/30-04/10 @lizh;wangqh
+  [++] api_dsgn_fo_clip_sec: follower和clip的API结构  03/30-04/10 @huangw;xuyc
+  [++] api_dsgn_action_sec: action和comment相关的API结构  03/30-04/10 @huangw
+[+] release_api_design_0.2: Review API Design 0.2 04/10 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] release_0.1: 搭建完开发环境后发布到测试用服务器 04/10 @sunyr;huangw -> release_api_design_0.1;model_spec
+
+[+] implementation: 实现API功能 03/30-04/30 @huangw;sunyr
+[+] test: API功能同步测试 03/30-04/30 @huangw;lizh
+[+] release_0.2: 第一个可以与dulcinea结合的版本 04/30 @sunyr;huangw
+

data/examples/ROADMAP_SPEC

@@ -0,0 +1,75 @@
+ROADMAP for Dulcinea-Syobu Phase
+====================================
+Created at 2013-02-25
+
+% ----
+title: Dulcinea P.R.T 客户端（syobu阶段）
+status: prototyping
+description: "
+PixPlus.Me的移动客户端，基于corona SDK，涵盖iOS/Android的手机和Tablet设备（P.R.T.三种情况）。Syobu Phase以phone为主，实现主要软件功能的内测版本。
+"
+members:
+  lizh: [Li Zhonghua, lizh@pe-po.com]
+  sunyr: [Sun Yunrui, sunyr@pe-po.com]
+  liudx: [Liu Dongxu, liudx@pe-po.com]
+  cuibg: [Cui Baoguo, cuibg@pe-po.com]
+  wangqh: [Wang Qinghua, wangqh@pe-po.com]
+supervisor: huangw
+leader: xuyc
+moderator: cuibg
+team: [huangw, xuyc, liudx, cuibg, wangqh]
+year: 2013
+% ----
+
+[+] scope: 确定开发范围，拆分单元开发模块 02/25-03/15 @huangw;xuyc
+  [++] mod_scope: 开发范围和开发框架概述 02/26-03/15 @huangw;xuyc:40
+  [++] unit_tree_tool: 单元构件树状图工具 02/26-03/03 @huangw:03/04
+  [++] ui_unit: 用树状图描述UI单元结构 03/04-03/06 @xuyc;huangw:03/06
+  [++] rewrite_unit_tree: 重构单元构件树状图及制图工具 03/06-03/18 @huangw:10
+  [++] unit_spec: 单元开发部件的式样书草图 02/27-03/20 @xuyc;liudx:10
+  [++] frame: 单元-测试-结合的开发框架 03/03-03/20 @huangw;xuyc:10
+[+] proto: 制作移动客户端原型 03/07-03/25 @huangw;xuyc;wangqh;cuibg
+  [++] research: 调查开发环境的限制 03/07-03/20 @xuyc
+
+[+] model: 人、组、pixplus和clip的基础模型 02/26-03/15 @huangw
+  [++] open_search: 调查weibo,facebook等开放服务平台的API 02/26-03/10 @lizh;huangw;cuibg;wangqh:02/28
+    [+++] s_sina_tencent: 调查新浪weibo和腾讯微博、QQ的用户、分组和post模型 02/26-03/01 @cuibg:02/28
+    [+++] s_renren_douban: 调查人人网，豆瓣网的用户、分组和post模型 02/26-03/01 @wangqh:02/28
+    [+++] s_twitter_facebook: 调查Twitter和Facebook的用户、分组和post模型 02/26-03/01 @lizh:02/28
+    [+++] s_gplus_pin_tumblr: 调查GooglePlus，Tumblr和Pinterest的用户、分组和post模型 02/26-03/01 @xuyc:02/28
+  [++] models_prime: 初步建模 02/28-03/06 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/07
+    [+++] tables_struct: 生成模型表的基本结构 03/01 @huangw:03/01
+    [+++] refine_ts: 详细调整模型表的基本结构 03/02-03/03 @huangw:03/04
+    [+++] pic_pix_prime_m: picture和pix模型 02/28-03/06 @sunyr;cuibg:03/04
+    [+++] modify_pix_prime_m: 修改picture模型 03/05 @sunyr:03/05
+    [+++] user_group_prime_m: 用户和组的模型 02/28-03/06 @lizh;wangqh:03/06
+    [+++] fo_clip_prime_m: follower和clip模型 02/28-03/06 @huangw;xuyc:03/07
+    [+++] action_prime_m: action和comment相关的模型 03/04-03/06 @huangw:03/07
+  [++] milestone_model_0.1: Review Model 0.1 03/06 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/14
+  [++] models_second: 建模第二步 03/06-03/11 @huangw;sunyr;xuyc;cuibg;wangqh;lizh:03/14
+    [+++] pic_pix_second_m: picture和pix模型 03/06-03/11 @sunyr;cuibg:03/12
+    [+++] user_group_second_m: 用户和组的模型 03/06-03/11 @lizh;wangqh:03/13
+    [+++] fo_clip_second_m: follower和clip模型 03/06-03/11 @huangw;xuyc:03/14
+    [+++] action_second_m: action和comment相关的模型 03/06-03/11 @huangw:03/10	
+  [++] milestone_model_0.2: Review Model 0.2 03/21 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] app_server: 基于sinatra和rabl的rack服务器架构 03/05-03/25 @huangw:03/10 
+  [++] rabl: 调查测试rabl（速度、documentation tool） 03/05-03/10 @huangw:03/10
+  [++] sinatra: 搭建sinatra基础结构 03/09 @huangw:03/10
+  [++] api_test: 使用cucumber或者bunny-carrot（luobo）搭建测试环境 03/09-03/15 @huangw;lizh:03/10
+[+] app_server_revise: 重构新的sinatra rack服务器架构 03/14-03/18 @huangw:03/15
+[+] api_design_prime: 初步设计基本的API结构 03/15-03/30 @xuyc;huangw;sunyr:36
+[+] model_spec: 设计model的测试框架，开始书写spec 03/13-03/30 @huangw;lizh:10
+
+[+] release_api_design_0.1: Review API Design 0.1 03/30 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] api_design_second: 设计基本的API结构第二步 03/30-04/10 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+  [++] api_dsgn_pix_pic_sec: picture和pix的API结构 03/30-04/10 @sunyr;cuibg
+  [++] api_dsgn_usr_grp_sec: 用户和组的API结构  03/30-04/10 @lizh;wangqh
+  [++] api_dsgn_fo_clip_sec: follower和clip的API结构  03/30-04/10 @huangw;xuyc
+  [++] api_dsgn_action_sec: action和comment相关的API结构  03/30-04/10 @huangw
+[+] release_api_design_0.2: Review API Design 0.2 04/10 @huangw;sunyr;xuyc;cuibg;wangqh;lizh
+[+] release_0.1: 搭建完开发环境后发布到测试用服务器 04/10 @sunyr;huangw -> release_api_design_0.1;model_spec
+
+[+] implementation: 实现API功能 03/30-04/30 @huangw;sunyr
+[+] test: API功能同步测试 03/30-04/30 @huangw;lizh
+[+] release_0.2: 第一个可以与dulcinea结合的版本 04/30 @sunyr;huangw
+

data/examples/members.yml

@@ -0,0 +1,4 @@
+members:
+  huangw: [Huang Wei, huangw@pe-po.com]
+  xuyc: [Xu Yichen, xuyc@pe-po.com]
+  sunyr: [Sun Yunrui, sunyr@pe-po.com]