dev_flow 0.0.4

data/lib/dev_flow/girc.rb

@@ -0,0 +1,161 @@
+module DevFlow
+  class Girc
+    attr_accessor :git
+
+    def initialize cmd = 'git', v = true
+      @git = cmd
+      @v = v
+    end
+
+    def info msg
+      return unless @v
+      puts "[GITC] #{msg}" if msg.size > 0
+    end
+
+    # general informations
+    # -----------------------
+    # return modified files (without additions/deletions)
+    def modified_files
+      files = Array.new
+      `#{@git} status`.split("\n").each do |line|
+        if /modified\:\s+(?<file_>.+)/ =~ line
+          files << File.expand_path(file_)
+        end
+      end
+      files
+    end
+
+    # return config list as a hash
+    def config
+      h = Hash.new
+      `#{@git} config --list`.split("\n").each do |line|
+        key, value = line.split("=")
+        h[key] = value
+      end
+      h
+    end
+    
+    # return the value of user.name in configuration
+    def me
+      config["user.name"] || "?"
+    end
+
+    # all branches include remote branches
+    def branches
+      branch_list = Array.new
+      `#{@git} branch -a`.split("\n").each do |line|
+        line.gsub!('* ', '')
+        line.gsub!(/\s/, '')
+        branch_list << line unless branch_list.include? line
+      end
+      branch_list
+    end
+
+    # the branch currently working on
+    def current_branch
+      `#{@git} branch`.split("\n").each do |line|
+        if /\*/.match line
+          return line.gsub('* ', '')
+        end
+      end
+      nil
+    end
+
+    def remote_list
+      lst = Array.new
+      `#{@git} remote -v`.split("\n").each do |line|
+        rn = line.split(/\s+/)[0]
+        lst << rn unless lst.include? rn
+      end
+      lst
+    end
+
+    # is the working directory has modified file
+    def wd_clean?
+      clean = true
+      `#{@git} status`.split("\n").each do |line|
+        clean = false if /Changes/.match line
+      end
+      clean
+    end
+
+    # whether the current directory is a git working directory
+    def in_git_dir?
+      `#{@git} status` =~ /fatal/ ? false : true
+    end
+
+    # modifications
+    # --------------------
+    
+    # pull from the remote use fetch/merge
+    def pull! remote = 'origin'
+      cb = self.current_branch
+      info "Fetch from #{remote}"
+      rslt = `#{@git} fetch #{remote}`
+      raise "fetch failed with message: #{rslt}" unless $?.success?
+      info rslt
+      info `#{@git} merge #{remote}/#{cb}`
+    end
+
+    # create a new branch, if remote set, push it to remote too
+    # then switch to that branch
+    def new_branch! branch, remote=nil
+      raise "You need clean up you working directory" unless wd_clean?
+      raise "Branch #{branch} already exists" if self.branches.include? branch
+      `#{@git} checkout -b #{branch}`
+      `#{@git} push #{remote} #{branch}` if remote
+    end
+
+    # delete a branch
+    def del_branch! branch, remote=nil
+      rslt = `#{@git} branch -d #{branch}`
+      raise "Cat not delete branch #{branch}: #{rslt}" unless $?.success?
+      `#{@git} push #{remote} :#{branch}` if remote
+    end
+
+    def stash!
+      unless wd_clean?
+        info "Save you change to stash"
+        `#{@git} add .`
+        `#{@git} stash`
+      end
+    end
+
+    def stash_pop!
+      raise "You may clean up you work directroy first before pop out from the stash" unless wd_clean?
+      info "Pop out from you last stash"
+      `#{@git} stash pop`
+    end
+
+    # remote from a specified remote ref
+    def rebase! remote = 'origin', branch = 'develop'
+      cb = self.current_branch
+      stashed = false
+      unless self.wd_clean?
+        self.stash!
+        stashed = true
+      end
+
+      if branch == self.current_branch
+        info "Rebase pull from remote"
+        `#{@git} pull --rebase #{remote} #{branch}`
+      else
+        info "Switch to branch #{branch}"
+        `#{@git} fetch #{remote}`
+        rslt = `#{@git} checkout #{branch}`
+        raise "Checkout failed: #{rslt}" unless $?.success?
+        info "Update (rabase) branch"
+        rslt = `#{@git} pull --rebase #{remote} #{branch}`
+        raise "Rebase pull for #{branch} failed: #{rslt}" unless $?.success?
+        info "Switch back to branch #{cb}"
+        `#{@git} checkout #{cb}`
+        info "Rebase from #{branch}"
+        rslt = `#{@git} rebase #{branch}`
+        raise "Rebase with #{branch} failed: #{rslt}" unless $?.success?
+      end
+
+      self.stash_pop! if stashed
+    end
+
+  end
+end

data/lib/dev_flow/member.rb

@@ -0,0 +1,10 @@
+module DevFlow
+  class Member
+    attr_accessor :name, :display_name, :email
+
+    def initialize name, display_name, email
+      @name, @display_name, @email = name, display_name, email
+    end
+
+  end
+end

data/lib/dev_flow/roadmap.rb

@@ -0,0 +1,132 @@
+module DevFlow
+  ## a road map represents a list of tasks
+  class RoadMap
+    attr_accessor :file, :config, :tasks,
+      :branch_tasks, # branch name to task hash
+      :ln_tasks, # line number to task hash, used for rewrite
+      :top_tasks # level 1 task list (used for id calculation)
+
+    def initialize file, config
+      @file, @config = file, config
+      @tasks = Array.new
+      @branch_tasks = Hash.new
+      @ln_tasks = Hash.new
+      @top_tasks = Array.new
+    end
+
+    def last_task
+      @tasks.last
+    end
+    
+    def title
+      @config[:title]
+    end
+
+    def parse file = nil
+      self.file = file if file
+      fh = File.open(self.file, "r:utf-8")
+      head_part = ""
+      in_header = 0
+      fh.each do |line|
+        if /^\%\s*\-\-\-+/ =~ line
+          in_header += 1
+          next
+        end
+        
+        # before any task defined, parse line begin with % as head field:
+        if in_header == 1 and @tasks.size == 0
+          head_part += line
+        end
+
+        if /^\s*\[(?<plus_>[\+\s]+)\]\s(?<contents_>.+)/ =~ line
+          if @tasks.size == 0 and head_part.size > 0
+            hhash = YAML.load(head_part) 
+            members =  @config["members"] || {}
+            members.merge!(hhash["members"]) if hhash["members"]
+            @config = @config.merge hhash
+            @config["members"] = members
+          end
+          line.chomp!
+          task = Task.new(plus_.to_s.count("+"), self.file, $.).parse(contents_, @config)
+          task.validate! # raise for format errors
+          raise "branch name #{task.branch_name} already used on #{self.file}:#{self.branch_tasks[task.branch_name].ln}" if self.branch_tasks[task.branch_name]
+          if task.is_a?(Task)
+            # find perant for the task:
+            parent = self.find_parent task.level
+            if parent
+              parent.children << task
+              task.parent = parent
+              # task.id = (sprintf "%d%d", parent.id, parent.child_number).to_i
+            end
+            @tasks << task
+            @branch_tasks[task.branch_name] = task
+            @ln_tasks[task.ln] = task
+            @top_tasks << task if task.level == 1
+          end
+        end
+      end
+      fh.close
+
+      # check and set dependencies
+      self.tasks.each do |task|
+        task.dependencie_names.each do |branch|
+          d_task = @branch_tasks[branch]
+          raise "task #{task.branch_name} (#{task.file}:#{task.ln}) has dependency #{branch} not found on the file" unless d_task
+          task.dependencies << d_task
+        end
+      end
+      self
+    end
+
+    ## the last task in row that less than the given level is parent task
+    def find_parent level
+      self.tasks.reverse.each { |t| return t if t.level < level }
+      nil
+    end
+
+    def rewrite! task_hash
+      # task_hash: {task_line_as_integer => progress_as_integer}
+      task_hash.each do |ln, progress|
+        raise "invalid line number #{ln}" unless ln.to_s =~ /^\d+$/ and ln > 0
+        raise "invalid progress #{progress}" unless progress.to_s =~ /^\d+$/ and progress > 0 and progress <= 100
+      end
+
+      file = self.file
+      tmp_file = self.file + ".tmp"
+
+      # backup the file to tmp_file
+      FileUtils.mv file, tmp_file
+      tfh = File.open(tmp_file, "r:utf-8")
+      wfh = File.open(file, "w:utf-8")
+
+      tfh.each do |line|
+        if task_hash[$.]
+          progress = task_hash[$.]
+          task = @ln_tasks[$.]
+
+          if progress == 100
+            com_date = DateTime.now.strftime("%Y/%m/%d")
+            com_date = DateTime.now.strftime("%m/%d") if DateTime.now.year == @config["year"]
+            progress = com_date
+          end
+          
+          new_line = line
+          if /(?<resource_>\@[a-z\@\;]+)(\:[PD\d\/]+)?/ =~ line
+            new_line.gsub!(/(?<resource_>\@[a-z\@\;]+)(\:[PD\d\/]+)?/, resource_ + ":" + progress.to_s)
+          elsif /(?<dep_>\-\>.+)$/ =~ line
+            new_line.gsub!(/\s*\-\>.+$/, '@' + self.headers["leader"] + ":" + progress.to_s + " " + dep_)
+          else
+            new_line += '@' + self.headers["leader"] + ":" + progress.to_s
+          end
+          wfh.puts new_line
+        else
+          wfh.puts line
+        end
+      end
+      tfh.close
+      wfh.close
+
+      FileUtils.rm tmp_file
+    end
+  end
+end

data/lib/dev_flow/task.rb

@@ -0,0 +1,174 @@
+# representations for a task in roadmap and in Gantt chart.
+# ==========================================================
+#
+# @author: Huang Wei <huangw@pe-po.com>
+# version 1.0a
+
+module DevFlow
+  ## Task object represent a single line on the Gantt chart
+  class Task
+    attr_accessor :file, :ln, # which line of file defined the task
+      :level, :branch_name, :display_name, :resources, :resource_names,
+      :progress, :completed_at, # complete date time
+      :dependencies, # depends on those tasks (list of branch_names)
+      :dependencie_names, # denpendencies in branch names (for display)
+      :start_date, :end_date,
+      :parent, :children, # all in branch_names first
+      :is_pending, :is_deleted
+  
+    # initialize with level, file and line number
+    def initialize level,file="-",ln=0
+      @level = level.to_i
+      raise "invalid level #{level}" unless level.to_i > 0
+      @file, @ln = file, ln
+      @children = Array.new
+      @dependencies = Array.new
+      @dependencie_names = Array.new
+      @progress = 0
+      @resources = Array.new
+      @resource_names = Array.new
+    end
+
+    # filter methods
+    def is_milestone?
+      self.branch_name =~ /^(milestone|release)\_/ ? true : false
+    end
+
+    def is_release?
+      self.branch_name =~ /^release\_/ ? true : false
+    end
+
+    def is_completed?
+      self.progress == 100
+    end
+
+    def is_pending?
+      self.is_pending ? true :false
+    end
+
+    def is_deleted?
+      self.is_deleted ? true : false
+    end
+
+    def is_parent?
+      self.children.size > 0 ? true : false
+    end
+
+    def is_urgent?  # usually orange
+      today = DateTime.now.strftime("%Y%m%d").to_i 
+      start_day = self.start_date.strftime("%Y%m%d").to_i 
+      end_day = self.end_date.strftime("%Y%m%d").to_i
+      
+      return true if start_day == today and progress == 0
+      return true if end_day == today and self.progress < 100
+      false
+    end
+
+    def is_delayed? # usually red
+      today = DateTime.now.strftime("%Y%m%d").to_i 
+      start_day = self.start_date.strftime("%Y%m%d").to_i 
+      end_day = self.end_date.strftime("%Y%m%d").to_i
+      return true if self.progress < 100 and today > end_day
+      return true if self.progress == 0 and today > start_day
+      false
+    end
+
+    ## check whether the task is well defined, raise error otherwise.
+    def validate!
+      if self.is_milestone?
+        unless self.level == 1
+          raise "you can only tag a top level task as a release, on #{self.file}:#{self.ln}" if self.branch_name =~ /^release\_/
+        end
+      end
+      raise "resource not found on #{self.file}:#{self.ln}" unless self.resources.size > 0
+      raise "display_name not found on #{self.file}:#{self.ln}" unless self.display_name
+      raise "valid start_date not found on #{self.file}:#{self.ln}" unless self.start_date
+      raise "wrong date on #{self.file}:#{self.ln}" unless self.start_date and self.end_date and self.start_date <= self.end_date
+
+      self
+    end
+
+    ## parse the line from file:ln (line number), initialize the
+    # task object
+    def parse line, headers = {}
+      line = line.strip # delete head/trailing spaces
+
+      /^((?<branch_name_>[a-zA-Z0-9_\-\#\.\/]+):)?\s*(?<display_name_>.+)\s+(?<start_date_>(\d\d\d\d\/)?\d\d?\/\d\d?)(-(?<end_date_>(\d\d\d\d\/)?\d\d?\/\d\d?))?(\s+\@(?<resource_>[a-z\@\;]+))?(\:(?<status_>(P|D))?(?<progress_>[\d\/]+)?)?(\s+\-\>\s*(?<dependencies_>.+))?$/ =~ line
+
+      # assign branch name and display name
+      self.branch_name = branch_name_
+
+      self.display_name = display_name_
+
+      # assign start and end date
+      end_date_ = start_date_ unless end_date_
+      raise "no valid start date found on #{self.file}:#{self.ln}" unless start_date_ and start_date_.size > 0
+      if headers["year"]
+        start_date_ = headers["year"].to_s + "/" + start_date_ unless start_date_ =~ /^\d\d\d\d/
+        end_date_ = headers["year"].to_s + "/" + end_date_ unless end_date_ =~ /^\d\d\d\d/
+      end
+
+      begin
+        self.start_date = DateTime.parse(start_date_)
+        self.end_date = DateTime.parse(end_date_)
+      rescue Exception => e
+        raise "invalid date on #{self.file}:#{self.ln}"  
+      end
+      
+      # assign for the resources (user name)
+      unless resource_
+        if headers["leader"]
+          resource_ = headers["leader"]
+        else
+          raise "no resource defined on #{self.file}:#{self.ln}"
+        end
+      end
+
+      resource_.gsub!("\@", "") # @ for other user is optional
+      resource_.split(";").each do |r|
+        self.resources << r
+        # if the user is listed on known members
+        rname = r
+        if headers["members"] and headers["members"][r] and headers["members"][r][0]
+          rname = headers["members"][r][0]
+        end
+        self.resource_names << rname
+      end
+
+      if dependencies_
+        dependencies_.strip!
+        dependencies_.gsub!(/;$/, "")
+        self.dependencie_names = dependencies_.split(/;/)
+      end
+
+      # pending or deleted status
+      if status_
+        if status_ == "P"
+          self.is_pending = true
+        elsif status_ == "D"
+          self.is_deleted = true
+        end
+      end
+
+      # progress
+      if progress_
+        if progress_ =~ /^\d\d?$/ and progress_.to_i > 0 and progress_.to_i < 100
+          self.progress = progress_.to_i
+        elsif progress_ =~ /^\d\d\d\d\/\d\d?\/\d\d?$/
+          self.progress = 100
+          self.completed_at = DateTime.parse(progress_)
+        elsif progress_ =~ /^\d\d?\/\d\d?$/ and headers["year"]
+          self.progress = 100
+          self.completed_at = DateTime.parse(headers["year"].to_s + "/" + progress_.to_s)
+        else
+          msg = "worng format around progress parameter '#{progress_}', on #{self.file}:#{self.ln}"
+          msg += " (HINT: use date to complete a task, not 100)" if progress_.to_i == 100
+          raise msg
+        end
+      end
+
+      self
+    end
+
+  end # class Task
+end

data/lib/dev_flow/task_console.rb

@@ -0,0 +1,46 @@
+module DevFlow
+  class Task
+
+    def as_title header = ' '
+      name = self.display_name
+      name = self.display_name.bold if self.is_workable?
+      name = self.display_name.blue if self.progress > 0
+      name = self.display_name.green if self.is_completed?
+      name = self.display_name.magenta if self.is_urgent?
+      name = self.display_name.red if self.is_delayed?
+
+      if self.progress > 0 and self.progress < 100
+        on_branch = sprintf "(=> %s, %02d%%)", self.branch_name.bold, self.progress
+      end
+
+      title = sprintf("%s[%s]%s%s", '  '*(self.level-1), header, name, on_branch)
+    end
+
+    ## a task is completable if all children complated
+    def is_completable?
+      return false if self.is_completed? 
+      self.children.each do |child|
+        return false unless child.is_completed?
+      end
+      true
+    end
+
+    ## a task is workable (can be started) if all children
+    # task and dependent task are completed
+    def is_workable?
+      # trivial: if already completed, do not start again
+      return false if self.is_completed?
+      return false if self.is_pending or self.is_deleted
+
+      self.dependencies.each do |t|
+        return false unless t.is_completed?
+      end
+
+      self.children.each do |t|
+        return false unless t.is_completed?
+      end
+      true
+    end
+    
+  end
+end

data/lib/dev_flow/version.rb

@@ -0,0 +1,3 @@
+module DevFlow
+  VERSION = '0.0.4'
+end

data/lib/dev_flow.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+require 'logger'
+require 'fileutils'
+
+# model layer
+require 'dev_flow/task'
+require 'dev_flow/roadmap'
+require 'dev_flow/member'
+
+# presenter
+require 'dev_flow/task_console'
+
+# application and commands
+require 'dev_flow/app'
+require 'dev_flow/version'
+
+# other helper and libraries
+require 'dev_flow/girc'
+
+module DevFlow
+  def self.invoke! config, command
+    require "dev_flow/commands/#{command}"
+    klass = command.to_s.capitalize
+    eval(klass).new(config, command).process!
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe DevFlow::App do
+  describe "#all_member_names" do
+    subject (:app) do
+      DevFlow::App.new({members_file:"examples/members.yml", roadmap:"examples/ROADMAP"}, "info")
+    end
+
+    it "should read 7 members" do
+      app.all_member_names.size.should eq(7)
+      app.all_member_names.include?("huangw").should be_true
+      app.all_member_names.include?("wangqh").should be_true
+      app.all_member_names.include?("sunyr").should be_true
+    end
+  end
+end

data/spec/roadmap_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe DevFlow::RoadMap do
+  describe "#parse" do
+    context "valid file" do
+      subject (:roadmap) do
+        DevFlow::RoadMap.new('examples/ROADMAP', {}).parse
+      end
+
+      it "should be a Roadmap object" do
+        roadmap.is_a?(DevFlow::RoadMap).should be_true
+      end
+
+      it "should assign parents well" do
+        roadmap.ln_tasks[28].parent.is_a?(DevFlow::Task)
+        roadmap.ln_tasks[28].level.should eq(2)
+        roadmap.ln_tasks[28].parent.branch_name.should eq("scope")
+        roadmap.ln_tasks[28].parent.level.should eq(1)
+      end
+
+      it "should assign dependencies well" do
+        roadmap.ln_tasks[70].dependencies.size.should eq(2)
+        roadmap.ln_tasks[70].dependencies[0].branch_name.should eq("release_api_design_0.1")
+        roadmap.ln_tasks[70].dependencies[1].branch_name.should eq("model_spec")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'dev_flow'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end