trollolo 0.0.3 → 0.0.4

data/lib/card.rb

@@ -16,49 +16,93 @@
 #  you may find current contact information at www.suse.com
 
 class Card
+  # Assuming we have card titles as follows '(8) This is the card name'
+  ESTIMATED_REGEX     = /\(([\d.]+)\)/
+  SPRINT_NUMBER_REGEX = /\ASprint (\d+)/
 
-  attr_accessor :sp, :tasks, :tasks_done
+  def initialize(board_data, card_id)
+    init_data(board_data, card_id)
+  end
 
-  def self.name_to_points(card_name)
-    card_name =~ /^\(([\d.]+)\)/
-    return nil if $1.nil?
-    $1.to_f
+  def init_data(board_data, card_id)
+    @board_data = board_data
+    @card_data = @board_data["cards"].select{|c| c["id"] == card_id}.first
   end
 
-  def initialize
-    @sp = nil
-    @extra = false
+  def estimated?
+    name =~ ESTIMATED_REGEX
   end
-  
-  def has_sp?
-    @sp != nil
+
+  def story_points
+    return 0.0 unless estimated?
+    name.match(ESTIMATED_REGEX).captures.first.to_f
   end
-  
-  def extra?
-    @extra
+
+  def done_tasks
+    count = 0
+    @card_data["checklists"].each do |checklist|
+      if checklist["name"] != "Feedback"
+        checklist["checkItems"].each do |checklist_item|
+          if checklist_item["state"] == "complete"
+            count += 1
+          end
+        end
+      end
+    end
+    count
   end
-  
-  def set_extra
-    @extra = true
+
+  def tasks
+    count = 0
+    @card_data["checklists"].each do |checklist|
+      if checklist["name"] != "Feedback"
+        count += checklist["checkItems"].count
+      end
+    end
+    count
   end
-  
-  def self.parse json
-    card = Card.new
 
-    title = json["name"]
-    card.sp = name_to_points(title)
+  def card_labels
+    @card_data["labels"]
+  end
 
-    labels = json["labels"]
-    labels.each do |label|
-      if label["name"] == "Under waterline"
-        card.set_extra
-      end
+  def desc
+    @card_data["desc"]
+  end
+
+  def extra?
+    self.card_labels.any? do |label|
+      label['name'].include?('BelowWaterline') ||
+          label['name'].include?('Under waterline')
     end
+  end
 
-    card.tasks = json["badges"]["checkItems"]
-    card.tasks_done = json["badges"]["checkItemsChecked"]
+  def meta_card?
+    name =~ SPRINT_NUMBER_REGEX
+  end
 
-    card
+  def sprint_number
+    raise ArgumentError unless meta_card?
+    name.match(SPRINT_NUMBER_REGEX).captures.first.to_i
   end
 
+  def fast_lane?
+    # TODO: move to settings
+    self.card_labels.map{|l| l['name']}.include?('FastLane')
+  end
+
+  #TODO: rethink storage for meta data for sprint
+  def self.parse_yaml_from_description(description)
+    description =~ /```(yaml)?\n(.*)```/m
+    yaml = $2
+    if yaml
+      return YAML.load(yaml) # throws an exception for invalid yaml
+    else
+      return nil
+    end
+  end
+
+  def name
+    @card_data["name"]
+  end
 end

data/lib/cli.rb

@@ -37,6 +37,36 @@ class Cli < Thor
     end
   end
 
+  desc "get-raw [URL-FRAGMENT]", "Get raw JSON from Trello API"
+  long_desc <<EOT
+Get raw JSON from Trello using the given URL fragment. Trollolo adds the server
+part and API version as well as the credentials from the Trollolo configuration.
+
+As example, the command
+
+  trollolo get-raw lists/53186e8391ef8671265eba9f/cards?filter=open
+
+evaluates to the access of
+
+  https://api.trello.com/1/lists/53186e8391ef8671265eba9f/cards?filter=open&key=xxx&token=yyy
+EOT
+  def get_raw(url_fragment)
+    process_global_options options
+    require_trello_credentials
+
+    url = "https://api.trello.com/1/#{url_fragment}"
+    if url_fragment =~ /\?/
+      url += "&"
+    else
+      url += "?"
+    end
+    url += "key=#{@@settings.developer_public_key}&token=#{@@settings.member_token}"
+    STDERR.puts "Calling #{url}"
+
+    response = Net::HTTP.get_response(URI.parse(url))
+    print JSON.pretty_generate(JSON.parse(response.body))
+  end
+
   desc "get-lists", "Get lists"
   option "board-id", :desc => "Id of Trello board", :required => true
   def get_lists
@@ -162,22 +192,53 @@ class Cli < Thor
     puts "Story points:"
     puts "   Open: #{burndown.story_points.open}"
     puts "   Done: #{burndown.story_points.done}"
-    puts "  Total: #{burndown.story_points.total}"    
+    puts "   Total: #{burndown.story_points.total}"
+    puts
     puts "Tasks:"
     puts "   Open: #{burndown.tasks.open}"
     puts "   Done: #{burndown.tasks.done}"
-    puts "  Total: #{burndown.tasks.total}"    
+    puts "   Total: #{burndown.tasks.total}"
     puts
     puts "Extra story points:"
     puts "   Open: #{burndown.extra_story_points.open}"
     puts "   Done: #{burndown.extra_story_points.done}"
-    puts "  Total: #{burndown.extra_story_points.total}"    
+    puts "   Total: #{burndown.extra_story_points.total}"
     puts "Extra tasks:"
     puts "   Open: #{burndown.extra_tasks.open}"
     puts "   Done: #{burndown.extra_tasks.done}"
-    puts "  Total: #{burndown.extra_tasks.total}"
+    puts "   Total: #{burndown.extra_tasks.total}"
+    puts
+    puts "FastLane Cards:"
+    puts "   Open: #{burndown.fast_lane_cards.open}"
+    puts "   Done: #{burndown.fast_lane_cards.done}"
+    puts "   Total: #{burndown.fast_lane_cards.total}"
   end
   
+  desc "burndowns", "run multiple burndowns"
+  option "board-list", :desc => "path to board-list.yaml", :required => true
+  option :plot, :type => :boolean, :desc => "also plot the new data"
+  option :output, :aliases => :o, :desc => "Output directory"
+  def burndowns
+    process_global_options options
+    board_list = YAML.load_file(options["board-list"])
+    board_list.keys.each do |name|
+      if name =~ /[^[:alnum:]. _]/ # sanitize
+        raise "invalid character in team name"
+      end
+      board = board_list[name]
+      if options['output']
+        destdir = File.join(options['output'], name)
+      else
+        destdir = name
+      end
+      chart = BurndownChart.new @@settings
+      if ! File.directory?(destdir)
+        chart.setup(destdir, board["boardid"])
+      end
+      chart.update({'output' => destdir, plot: options[:plot]})
+    end
+  end
+
   desc "burndown-init", "Initialize burndown chart"
   option :output, :aliases => :o, :desc => "Output directory", :required => true
   option "board-id", :desc => "Id of Trello board", :required => true
@@ -193,6 +254,9 @@ class Cli < Thor
   desc "burndown", "Update burndown chart"
   option :output, :aliases => :o, :desc => "Output directory", :required => false
   option :new_sprint, :aliases => :n, :desc => "Create new sprint"
+  option :plot, :type => :boolean, :desc => "also plot the new data"
+  option 'with-fast-lane', :desc => "Plot Fast Lane with new cards bars", :required => false, :type => :boolean
+  option 'no-tasks', :desc => "Do not plot tasks line", :required => false, :type => :boolean
   def burndown
     process_global_options options
     require_trello_credentials
@@ -202,19 +266,77 @@ class Cli < Thor
       if options[:new_sprint]
         chart.create_next_sprint(options[:output] || Dir.pwd)
       end
-      chart.update(options[:output] || Dir.pwd)
+      chart.update(options)
+      puts "Updated data for sprint #{chart.sprint}"
     rescue TrolloloError => e
       STDERR.puts e
       exit 1
     end
   end
-  
-  desc "plot", "Plot burndown chart"
+
+  desc "plot SPRINT-NUMBER [--output] [--no-tasks] [--with-fast-lane]", "Plot burndown chart for given sprint"
+  option :output, :aliases => :o, :desc => "Output directory", :required => false
+  option 'with-fast-lane', :desc => "Plot Fast Lane with new cards bars", :required => false, :type => :boolean
+  option 'no-tasks', :desc => "Do not plot tasks line", :required => false, :type => :boolean
   def plot(sprint_number)
     process_global_options options
+    BurndownChart.plot(sprint_number, options)
+  end
+
+  desc "backup", "Create backup of board"
+  option "board-id", :desc => "Id of Trello board", :required => true
+  def backup
+    process_global_options options
+    require_trello_credentials
 
-    plot_helper = File.expand_path("../../scripts/create_burndown.py", __FILE__ )
-    system "python #{plot_helper} #{sprint_number}"
+    b = Backup.new @@settings
+    b.backup(options["board-id"])
+  end
+
+  desc "list_backups", "List all backups"
+  def list_backups
+    b = Backup.new @@settings
+    b.list.each do |backup|
+      puts backup
+    end
+  end
+
+  desc "show_backup", "Show backup of board"
+  option "board-id", :desc => "Id of Trello board", :required => true
+  option "show-descriptions", :desc => "Show descriptions of cards", :required => false, :type => :boolean
+  def show_backup
+    b = Backup.new @@settings
+    b.show(options["board-id"], options)
+  end
+
+  desc "organization", "Show organization info"
+  option "org-name", :desc => "Name of organization", :required => true
+  def organization
+    process_global_options options
+    require_trello_credentials
+
+    trello = TrelloWrapper.new(@@settings)
+
+    o = trello.organization(options["org-name"])
+
+    puts "Display Name: #{o.display_name}"
+    puts "Home page: #{o.url}"
+  end
+
+  desc "organization_members", "Show organization members"
+  option "org-name", :desc => "Name of organization", :required => true
+  def organization_members
+    process_global_options options
+    require_trello_credentials
+
+    trello = TrelloWrapper.new(@@settings)
+
+    members = trello.organization(options["org-name"]).members
+    members.sort! { |a,b| a.username <=> b.username }
+
+    members.each do |member|
+      puts "#{member.username} (#{member.full_name})"
+    end
   end
 
   private

data/lib/column.rb

@@ -0,0 +1,61 @@
+#  Copyright (c) 2013-2015 SUSE LLC
+#
+#  This program is free software; you can redistribute it and/or
+#  modify it under the terms of version 3 of the GNU General Public License as
+#  published by the Free Software Foundation.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, contact SUSE LLC.
+#
+#  To contact SUSE about this file by physical or electronic mail,
+#  you may find current contact information at www.suse.com
+class Column
+  def initialize(board_data, list_id)
+    @board_data = board_data
+    @list_data = @board_data["lists"].select{|l| l["id"] == list_id}.first
+  end
+
+  def name
+    @list_data["name"]
+  end
+
+  def estimated_cards
+    cards.select{|x| x.estimated? }
+  end
+
+  def sum
+    estimated_cards.map{|x| x.story_points}.sum
+  end
+
+  def tasks
+    cards.map(&:tasks).sum
+  end
+
+  def done_tasks
+    cards.map(&:done_tasks).sum
+  end
+
+  def extra_cards
+    cards.select{|c| c.extra?}
+  end
+
+  def committed_cards
+    cards.select{|c| !c.extra?}
+  end
+
+  def fast_lane_cards
+    cards.select{|c| c.fast_lane?}
+  end
+
+  def cards
+    return @cards if @cards
+
+    cards = @board_data["cards"].select{|c| c["idList"] == @list_data["id"]}
+    @cards = cards.map{|c| Card.new(@board_data, c["id"])}
+  end
+end

data/lib/scrum_board.rb

@@ -0,0 +1,104 @@
+class ScrumBoard
+
+  class DoneColumnNotFoundError < StandardError; end
+
+  def initialize(board_data, settings)
+    @settings = settings
+    @board_data = board_data
+  end
+
+  def columns
+    @columns ||= @board_data["lists"].map{|x| Column.new(@board_data, x["id"])}
+  end
+
+  def done_column
+    begin
+      done_columns = columns.select{|c| c.name =~ @settings.done_column_name_regex }
+      if done_columns.empty?
+        raise DoneColumnNotFoundError, "can't find done column by name regex #{@settings.done_column_name_regex}"
+      else
+        done_columns.max_by{|c| c.name.match(@settings.done_column_name_regex).captures.first.to_i }
+      end
+    end
+  end
+
+  def done_cards
+    done_column.committed_cards
+  end
+
+  def open_columns
+    columns.select{ |col| @settings.not_done_columns.include?(col.name) }
+  end
+
+  def open_cards
+    open_columns.map{|col| col.committed_cards}.flatten
+  end
+
+  def committed_cards
+    open_cards + done_cards
+  end
+
+  def done_story_points
+    done_cards.map(&:story_points).sum
+  end
+
+  def open_story_points
+    open_cards.map(&:story_points).sum
+  end
+
+  def closed_tasks
+    committed_cards.map(&:done_tasks).sum
+  end
+
+  def tasks
+    committed_cards.map(&:tasks).sum
+  end
+
+  def extra_cards
+    (done_column.extra_cards + open_columns.map(&:extra_cards)).flatten(1)
+  end
+
+  def extra_done_cards
+    done_column.extra_cards
+  end
+
+  def extra_done_story_points
+    extra_done_cards.map(&:story_points).sum
+  end
+
+  def extra_open_cards
+    open_columns.map{|col| col.cards.select{|c| c.extra?}}.flatten
+  end
+
+  def extra_open_story_points
+    extra_open_cards.map(&:story_points).sum
+  end
+
+  def extra_tasks
+    extra_cards.map(&:tasks).sum
+  end
+
+  def extra_closed_tasks
+    extra_cards.map(&:done_tasks).sum
+  end
+
+  def open_fast_lane_cards_count
+    open_columns.map(&:fast_lane_cards).flatten(1).count
+  end
+
+  def done_fast_lane_cards_count
+    done_column.fast_lane_cards.count
+  end
+
+  def scrum_cards
+    open_columns.map(&:fast_lane_cards).flatten(1) + done_column.cards
+  end
+
+  def meta_cards
+    scrum_cards.select{|c| c.meta_card? }
+  end
+
+  def id
+    @board_data["id"]
+  end
+end