dev_flow 0.0.4

data/lib/dev_flow/app.rb

@@ -0,0 +1,252 @@
+module DevFlow
+
+  class App
+    attr_accessor :config, :roadmap, :logger, :command, :git, :members, :waiting
+
+    def initialize config, command
+      @config, @commnad = config, command
+
+      # initialize logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = config[:verbose] ? Logger::INFO : Logger::WARN
+      @logger.formatter = proc {|severity, datetime, progname, msg| "#{msg.to_s}\n"}
+
+      # initialize git console
+      @git = DevFlow::Girc.new 'git', config[:verbose]
+      error "Please use dw in a git directory" unless @git.in_git_dir?
+
+      # load configurations
+      if @config[:members_file] and File.exists? (@config[:members_file])
+        info "Load member information form #{@config[:members_file]}"
+        @config = @config.merge(YAML.load(File.open(@config[:members_file], 'r:utf-8').read))
+      else
+        warn "No member file to load"
+      end
+
+      if @config[:local_config] and File.exists? (@config[:local_config])
+        info "Load local configuration from #{@config[:local_config]}"
+        @config = @config.merge(YAML.load(File.open(@config[:local_config], 'r:utf-8').read)) 
+      end
+      
+      # load roadmap, reload config 
+      if @config[:roadmap] and File.exists? (@config[:roadmap])
+        info "Load roadmap from #{@config[:roadmap]}"
+        @roadmap = RoadMap.new(@config[:roadmap], @config).parse 
+        @config = @roadmap.config
+
+        error "No leader defined for your porject!" unless @config['leader']
+      end
+
+      # convert member list to member name=>object hash
+      @members = Hash.new
+      @config["members"].each do |name, ary|
+        @members[name] = Member.new(name, *ary)
+      end
+      error "No known members defined!" unless all_member_names.size > 0
+
+      if @config["whoami"]
+        error "You (#{user_name}) are not in the known member list. You may use 'dw init' to setup the working environment." unless all_member_names.include? @config["whoami"]
+      end
+
+      # suggest user to take those tasks
+      @waiting = Hash.new
+    end
+
+    # log message handler
+    # ------------------------------
+    def error msg
+      @logger.fatal ("[ERROR] " + msg).bold.red
+      exit
+    end
+
+    def warn msg
+      @logger.warn ("[WARN] " + msg).yellow
+    end
+
+    def info msg
+      @logger.info "[INFO] " + msg
+    end
+
+    # helper function
+    # ------------------------------
+    def all_member_names
+      @members.keys
+    end
+
+    def user_name
+      wi = @config["whoami"]
+      @members[wi] ? @members[wi].display_name : wi
+    end
+
+    def leader_name
+      @members[@config["leader"]].display_name
+    end
+
+    def task
+      @roadmap.tasks.each do |task|
+        return task if task.branch_name == @git.current_branch
+      end
+      nil
+    end
+
+    def in_trunk?
+      %w[master develop staging production].include? @git.current_branch
+    end
+
+    def in_release?
+      task and task.is_release?
+    end
+
+    def i_am_leader?
+      @config["whoami"] and @config["leader"] == @config["whoami"]
+    end
+
+    def i_am_moderator?
+      @config["whoami"] and @config["moderator"] == @config["whoami"]
+    end
+
+    def i_am_supervisor?
+      @config["whoami"] and @config["supervisor"] == @config["whoami"]
+    end
+
+    def i_have_power?
+      [@config["leader"], @config["supervisor"], @config["moderator"]].include? @config["whoami"]
+    end
+
+    def tasks_for_close 
+      @roadmap.tasks.select {|task| task.progress == 99}
+    end
+
+    # display informations
+    # -----------------------
+    def hr; "-"*76 end
+    def hrh; hr.bold end
+    def hrb; "="*76 end
+    def hrbh; hrb.bold end
+     
+    def hello
+      puts hrbh
+      puts "Hello, #{user_name.bold}."
+      puts "This is the DevFlow console, version: " + VERSION
+      puts hrh
+      puts "You are on branch #{@git.current_branch.bold.green}" if @git.current_branch
+      puts "You task is: #{self.task.display_name.bold}" if self.task
+      puts "You are the #{'leader'.bold} of the project." if self.i_am_leader?
+      puts "You are the #{'moderator'.bold} of the project." if self.i_am_moderator?
+      puts "You are the #{'supervisor'.bold} of the project." if self.i_am_supervisor?
+    end
+
+    def display_close_waiting
+      return false unless self.tasks_for_close.size > 0
+      puts "There have tasks marked completed and need you to review it:"
+      i = 0
+      self.tasks_for_close.each do |task|
+        i += 1
+        if @git.wd_clean?
+          puts task.as_title i.to_s
+          @waiting[i] = task
+        else
+          puts task.as_title " "
+        end
+      end
+    end
+
+    def display_tasks
+      i = 0
+      j = 0
+      remain = 0
+      @roadmap.tasks.each do |task|
+        next if task.parent and task.parent.is_completed?
+        next if task.is_pending? or task.is_deleted?
+        if i > 31 # only show 16 task lines at most
+          remain += 1
+          next
+        end
+        
+        header = nil
+        header = '+'.bold.green if task.is_completed? 
+        header = '-' unless header or task.is_workable?
+        unless header
+          j += 1
+          header = j.to_s.bold
+          header = ' ' unless @git.wd_clean? 
+          @waiting[j] = task if @git.wd_clean? 
+        end
+        
+        puts task.as_title(header)
+        i += 1
+      end
+      puts "There #{remain.to_s.bold} more tasks not show here." if remain > 0
+    end
+
+    # interactive methods with git remote server
+    # ------------------------------------------------------
+    def ask_rebase force = false
+      return false if @config[:offline]
+
+      unless force
+        print "Rebase your wokring directory? [Y/n]:".bold.yellow
+        ans = STDIN.gets.chomp!
+        return false if ans == 'n'
+      end
+
+      # do the rebase:
+      if @config["git_remote"]
+        info "Rebase you working directory from #{@config["git_remote"]}/devleop"
+        @git.rebase! @config["git_remote"], 'develop'
+      else
+        info "Git remote not defined, skip rebase."
+      end
+    end
+
+    # switch to other branch
+    def switch_to! branch
+      if @git.branches.include? branch
+        info "Switch to branch #{branch}"
+        `git checkout #{branch}`
+      else
+        info "Switch to new branch #{branch}"
+        `git checkout -b #{branch}`
+      end
+    end
+
+    def upload_progress! task, progress, is_complete = false
+      current_branch = @git.current_branch
+
+      switch_to! 'develop' unless current_branch == 'develop'
+      
+      info "Rewrite #{@config[:roadmap]} file"
+      @roadmap.rewrite! task.ln => progress
+
+      info "Set progress of #{task.display_name} to #{progress}"
+      `git commit -am 'update progress of task #{task.branch_name} to #{progress}'`
+      `git push #{@config[:git_remote]} develop` if @config[:git_remote]
+
+      # if this is a complete update, do not switch back
+      unless (is_complete or current_branch == 'develop')
+        switch_to! current_branch
+        `git merge develop`
+        `git push #{@config[:git_remote]} #{current_branch}` if @config[:git_remote]
+      end
+    end
+
+    def new_version branch_name
+      if branch_name =~ /^release\_v/
+        return branch_name.gsub('release_v', 'version-')
+      elsif branch_name =~ /^hotfix\_/
+        last_v = ''
+        `git tag`.split("\n").each do |t|
+          if /^version\-\d+\.\d+\.(?<nm_>\d+)$/ =~ t # with fix number
+            last_v = t.gsub(/\d+$/, (nm_.to_i + 1).to_s)
+          elsif /^version\-\d+\.\d+$/ =~ t # without fix number
+            last_v = t + '.1'
+          end
+        end
+        return last_v
+      else
+        return ''
+      end
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/cleanup.rb

@@ -0,0 +1,20 @@
+module DevFlow
+  class Cleanup < App
+
+    def process!
+      completed_branches = Array.new
+      @roadmap.tasks.each {|t| completed_branches << t.branch_name if t.is_completed?}
+      
+      @git.branches.each do |t|
+        if completed_branches.include? t
+          print "delete completed branch #{t}? [Y/n]:"
+          ans = STDIN.gets.chomp!
+          unless ans == 'n'
+            `git branch -d #{t}`
+          end
+        end
+      end
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/close.rb

@@ -0,0 +1,69 @@
+module DevFlow
+  class Close < App
+
+    def process!
+      self.hello
+
+      error "Only leader (#{leader_name.bold}) can close a branch." unless i_am_leader?
+
+      # whether I am working on a proper task branch
+      current_task = self.task
+      error "Not on a known task branch. Can not continue." unless current_task      
+
+      if current_task and (in_release? or current_task.branch_name =~ /^hotfix\_/)
+        error "Use command 'release' to close a release/hotfix branch." unless @config[:release]
+      else
+        error "Use command 'close' to close a non-release branch." if @config[:release]
+      end
+
+      if in_release? and @config[:release]
+        error "You should use release only on branches just completed." unless current_task and current_task.progress == 99 
+      end
+      
+
+      self.ask_rebase true # force rebase
+      puts hr
+
+      # commit you current branch and push
+      progress = 100
+      message = ARGV[2] || "close the branch by set progress to 100."
+      message = "[close] " + message
+
+      info "commit progress"
+      `git commit -am '#{message}'`
+      if @config[:git_remote]
+        info "push your progress to remote server"
+        `git push #{@config[:git_remote]} #{current_task.branch_name}`
+      end
+      
+      # goto develop branch and merge
+      `git checkout develop`
+      rslt = `git merge --no-ff #{current_task.branch_name}`
+      error "Not fast forward merge failed: #{rslt}" unless $?.success?
+
+      # rewrite progress in ROADMAP file under develop trunk
+      upload_progress! current_task, progress, true
+      
+      # merge into the master
+      if @config[:release]
+        info "Merge the release branch into master trunk"
+        `git checkout master`
+        `git merge --no-ff develop`
+        tag = new_version current_task.branch_name
+        if tag
+          info "Tag your release as #{tag}"
+          `git tag #{tag}`
+        end
+        info "Push your change to remote server"
+        `git push #{@config[:git_remote]} --tags master` if @config[:git_remote]
+
+        puts "Now your are on branch #{'master'.bold.red}"
+        puts "You may want to review and test the program again and then switch back to develop trunk."
+      end
+      
+      info "Delete closed branch #{current_task.branch_name}"
+      `git branch -d #{current_task.branch_name}`
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/complete.rb

@@ -0,0 +1,42 @@
+module DevFlow
+  class Complete < App
+
+    def process!
+      self.hello
+
+      # whether I am working on a proper task branch
+      current_task = self.task
+      error "Not on a known task branch. Can not continue." unless current_task
+
+      unless current_task.resources.include?(@config[:whoami]) 
+        if i_have_power?
+          role = 'supervisor' if i_am_supervisor?
+          role = 'moderator' if i_am_moderator?
+          role = 'leader' if i_am_leader?
+          warn "You are complete the task as a #{role}"
+        else
+          error "You are not in the resource list for that task."
+        end      
+      end
+
+      self.ask_rebase true # force rebase
+      puts hr
+
+      # commit you current branch and push
+      progress = 99
+      message = ARGV[2] || "complete your branch by set progress to 99."
+      message = "[complete] " + message
+
+      info "Commit your progress"
+      `git commit -am '#{message}'`
+      if @config[:git_remote]
+        info "push your progress to remote server"
+        `git push #{@config[:git_remote]} #{current_task.branch_name}`
+      end
+      
+      # rewrite progress in ROADMAP file under develop trunk
+      upload_progress! current_task, progress, true
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/info.rb

@@ -0,0 +1,103 @@
+module DevFlow
+  class Info < App
+
+    def process!
+      self.hello
+
+      current_task = self.task
+      self.ask_rebase if current_task or in_trunk?
+
+      puts hr
+
+      # if i am the leader and there are closed branches, warn:
+      if i_am_leader? and tasks_for_close.size > 0
+        display_close_waiting
+      else
+        display_tasks
+      end
+      puts hrh
+
+      if @git.wd_clean? 
+        # if work directory is clean, ready to switch
+        if i_am_leader? and in_release? # concentrate
+          puts "You are in a release branch, please release it as soon as possible."
+        else # otherwise show switch options
+          puts "You switch to other branches:".bold.yellow
+          puts "Type #{0.to_s.bold} to switch to develop trunk." unless @git.current_branch == 'develop'
+          puts "Simply press enter to keep working on the current branch."
+          print @waiting.keys.join(", ") + ":"
+
+          ans = STDIN.gets.chomp!
+          if ans == 0.to_s
+            switch_to! 'develop'
+          elsif @waiting[ans.to_i]
+            switch_to! @waiting[ans.to_i].branch_name
+
+            # if the task not started yet, update progress
+            upload_progress!(@waiting[ans.to_i], 10) unless @waiting[ans.to_i].progress > 0
+          else
+            error "Invalid input #{ans}. Can not continue." if ans and ans.size > 0
+          end
+        end
+      else # if the wd is not clean
+        
+        if current_task and in_release?
+          if i_am_leader?
+            puts "You are in a release branch, if you are ready to release it, use:"
+            puts "  $ dw release".bold.blue
+          else
+            puts "WARN: You are on a release branch, only leader can edit release branches.".yellow
+            puts "Please undo you edit. Do not push your edition to the remote server."
+          end
+          exit
+        end
+
+        if current_task and current_task.progress == 99
+          if i_am_leader
+            puts "You are in a branch marked complete. Please test and review the code, and close it by:"
+            puts "  $ dw close".bold.blue
+            puts "Or reject the branch by issue:"
+            puts "  $ dw progress 60".bold.blue
+          else
+            puts "WARN: You are on a completed branch, call the leader (#{leader_name.bold}) to close it.".yellow
+          end
+          exit
+        end
+        
+        if current_task
+          unless current_task.resources.include? @config["whoami"]
+            puts "WARN: You are editing a task not assigned to you.".yellow
+          end
+
+          puts "You are encouraged to push your progress often by:"
+          puts "  $ dw progress 40 'git commit message'".bold.blue
+          puts "Or use the short version:"
+          puts "  $ dw pg 40 'git commit message'".bold.blue
+          puts "If you fully implemented and tested the code, issue:"
+          puts "  $ dw complete"
+          puts "Then #{'do not forget'.bold.red} inform the leader (#{leader_name.bold})."
+        else
+          puts "You are not on any non-branches. You may commit all you changes and"
+          puts "switch to develop trunk before the next move:"
+          puts "  $ git commit -am 'git commit message'".bold.blue
+          puts "  $ git checkout develop".bold.blue
+        end
+
+        if in_trunk?
+          if @git.current_branch == 'develop' and i_have_power?
+            puts "You should only edit ROADMAP files on develop trunk, when you done, use:"
+            puts "  $ dw update-roadmap".bold.blue
+            puts "Or use the short version:"
+            puts "  $ dw ur".bold.blue
+          else
+            warn "Avoid directly edit files under trunk branches."
+            puts "Please undo you change and switch to work on a task branch."
+          end
+        end
+        
+      end
+      hrb
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/init.rb

@@ -0,0 +1,87 @@
+module DevFlow
+  class Init < App
+
+    def process!
+      local_configuration = {}
+      if File.exists? @config[:local_config]
+        local_configuration = YAML.load(File.open(@config[:local_config], 'r:utf-8').read) || {}
+      end
+
+      # find the current user
+      sugguest = @config["whoami"] if @config["whoami"]
+      unless all_member_names.include? sugguest
+        info "use system 'whoami' command to find user name"
+        begin
+          suggest = `whoami`
+        end
+        info "found #{suggest}" if all_member_names.include? sugguest
+      end
+
+      unless all_member_names.include? sugguest
+        info "use git config to find user name"
+        sugguest = @git.config["user.email"].gsub(/\@.+$/, '') if @git.config["user.email"]
+        info "found #{suggest}" if all_member_names.include? sugguest
+      end
+      
+      # ask the user for the user name
+      puts "Tell us who you are: ".bold.yellow
+      msg = all_member_names.join(", ")
+      if all_member_names.include? sugguest
+        msg += " [#{sugguest}]"
+      end
+
+      print msg + ":"
+      ans = STDIN.gets.chomp!
+      ans = sugguest unless ans.size > 0
+      error "Unknown member! Can not continue." unless all_member_names.include? ans
+
+      # find the default git remote server
+      @config["whoami"] = ans
+      info "Welcome #{self.user_name.bold}!"
+
+      remotes = @git.remote_list
+      error "You need to set at least one remote git server to interact with!" unless remotes.size > 0
+
+      puts "Which remote git server to use?".bold.yellow
+      msg = remotes.join ", "
+      
+      suggest = @config["git_remote"] || 'origin'
+      msg += " [#{suggest}]" if remotes.include? suggest
+      print msg + ":"
+
+      ans2 = STDIN.gets.chomp!
+      ans2 = suggest unless ans2.size > 0
+      error "You must define a valid git remote server" unless remotes.include? ans2
+
+      # write out to the local configuration file
+      info "write contents to local configuration file"
+      write_local_config(local_configuration.merge({"whoami" => ans, "git_remote" => ans2}))
+      add_to_gitignore()
+    end
+
+    def write_local_config hash
+      wh = File.open(@config[:local_config], 'w:utf-8')
+      YAML.dump(hash, wh)
+      wh.close
+    end
+
+    def add_to_gitignore
+      had = false
+      if File.exists?(".gitignore")
+        fh = File.open(".gitignore")
+        fh.each do |line|
+          had = true if line =~ /#{@config[:local_config]}/
+        end
+        fh.close
+      end
+      
+      unless had
+        info "add local configuration file to gitignore list"
+        wh = File.open(".gitignore", 'a')
+        wh.puts @config[:local_config]
+        wh.close
+      end
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/progress.rb

@@ -0,0 +1,35 @@
+module DevFlow
+  class Progress < App
+
+    def process!
+      self.hello
+
+      # whether I am working on a proper task branch
+      current_task = self.task
+      error "Not on a known task branch. Can not continue." unless current_task
+      
+      self.ask_rebase
+      puts hr
+
+      # commit you current branch and push
+      progress = ARGV[1]
+      progress = progress.to_i if progress
+      unless (progress and progress > 0 and progress < 99)
+        error "invalid progress. Use percentage between 1 to 98."
+      end
+      message = ARGV[2] || "update progress to #{progress}"
+      message = "[progress] " + message
+
+      info "commit your progress"
+      `git commit -am '#{message}'`
+      if @config[:git_remote]
+        info "push your progress to remote server"
+        `git push #{@config[:git_remote]} #{current_task.branch_name}`
+      end
+      
+      # rewrite progress in ROADMAP file under develop trunk
+      upload_progress! current_task, progress
+    end
+
+  end # class
+end

data/lib/dev_flow/commands/ur.rb

@@ -0,0 +1,17 @@
+module DevFlow
+  class Ur < App
+
+    def process!
+      error "Not on develop trunk" unless @git.current_branch == 'develop'
+      error "Only leader/moderator and supervisor can edit ROADMAP" unless i_have_power?
+      #p @git.modified_files
+      error "No change detected on #{@config[:roadmap]}" unless @git.modified_files.include? File.expand_path(@config[:roadmap])
+
+      `git add .`
+      `git commit -am 'update roadmap'`
+      info "Push your change to the remote server"
+      `git push #{@config[:git_remote]} develop` if @config[:git_remote]
+    end
+
+  end # class
+end