trollolo 0.0.3

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter'
+  gem 'rspec', "~>3"
+  gem 'aruba'
+  gem 'webmock'
+  gem 'given_filesystem'
+end

data/README.md

@@ -0,0 +1,92 @@
+# Trollolo
+
+[![Build Status](https://travis-ci.org/openSUSE/trollolo.svg?branch=master)](https://travis-ci.org/openSUSE/trollolo)
+[![Code Climate](https://codeclimate.com/github/openSUSE/trollolo/badges/gpa.svg)](https://codeclimate.com/github/openSUSE/trollolo)
+[![Test Coverage](https://codeclimate.com/github/openSUSE/trollolo/badges/coverage.svg)](https://codeclimate.com/github/openSUSE/trollolo)
+
+Command line tool to extract data from Trello, in particular for creating
+burndown charts.
+
+## Functionality
+
+A detailed description of the functionality of the tool can be found in the
+[man page](http://github.com/openSUSE/trollolo/blob/master/man/trollolo.1.md).
+
+## Expectations
+
+For expectations how the board has to be structured to make the burndown chart
+functions work see the Trollolo man page. There is an
+[example Trello board](https://trello.com/b/CRdddpdy/trollolo-testing-board)
+which demonstrates the expected structure.
+
+## Configuration
+
+Trollolo reads a configuration file `.trollolorc` in the home directory of the
+user running the command line tool. It reads the data required to authenticate
+with the Trello server from it. It's two values (the example shows random data):
+
+```yaml
+developer_public_key: 87349873487ef8732487234
+member_token: 87345897238957a29835789b2374580927f3589072398579820345
+```
+
+These values have to be set with the personal access data for the Trello API
+and the id of the board, which is processed.
+
+For creating a developer key go to the
+[Developer API Keys](https://trello.com/1/appKey/generate) page on Trello. It's
+the key in the first box.
+
+For creating a member token go follow the
+[instructions](https://trello.com/docs/gettingstarted/index.html#getting-a-token-from-a-user)
+in the Trello API documentation.
+
+The board id is the cryptic string in the URL of your board.
+
+## Creating burndown charts
+
+Trollolo implements a simple work flow for creating burndown charts from the
+data on a Trello board. It fetches the data from Trello, stores and processes
+it locally, and generates charts which can then be uploaded as graphics to
+Trello again.
+
+At the moment it only needs read-only access to the Trello board from which it
+reads the data. In the future it would be great, if it could also write back
+the generated data and results to make it even more automatic.
+
+The work flow goes as follows:
+
+Create an initial working directory for the burndown chart generation:
+
+    trollolo burndown-init --board-id=MYBOARDID --output=WORKING_DIR
+
+This will create a directory WORKING_DIR and put an initial data file there,
+which contains the meta data. The file is called `burndown-data-1.yaml`. You
+might want to keep this file in a git repository for safe storage and history.
+
+After each daily go to the working directory and call:
+
+    trollolo burndown
+
+This will get the current data from the Trello board and update the data file
+with the data from the current day. If there already was some data in the file
+for the same day it will be overridden.
+
+When the sprint is over and you want to start with the next sprint, go to the
+working directory and call:
+
+    trollolo burndown --new-sprint
+
+This will create a new data file for the next sprint number and populate it
+with initial data taken from the Trello board. You are ready to go for the
+sprint now and can continue with calling `trollolo burndown` after each daily.
+
+To generate the actual burndown chart, go to the working directory and call:
+
+    trollolo plot SPRINT_NUMBER
+
+This will take the data from the file `burndown-data-SPRINT_NUMBER.yaml` and
+create a nice chart from it. It will show the chart and also create a file
+`burndown-SPRINT_NUMBER.png` you can upload as cover graphics to a card on your
+Trello board.
+

data/Rakefile

@@ -0,0 +1,12 @@
+namespace :man_pages do
+  task :build do
+    puts "  Building man pages"
+    system "ronn man/*.md"
+  end
+end
+
+namespace :gem do
+  task :build => ["man_pages:build"] do
+    system "gem build trollolo.gemspec"
+  end
+end

data/bin/trollolo

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#  Copyright (c) 2013-2014 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
+
+require_relative '../lib/trollolo'
+
+config_path = ENV["TROLLOLO_CONFIG_PATH"] || File.expand_path("~/.trollolorc")
+
+Cli.settings = Settings.new(config_path)
+
+# Set debug flag, so thor throws exceptions on error
+ENV["THOR_DEBUG"] = "1"
+begin
+  Cli.check_unknown_options!
+  result = Cli.start ARGV
+rescue Thor::Error => e
+  STDERR.puts e
+  exit 1
+end

data/lib/burndown_chart.rb

@@ -0,0 +1,158 @@
+#  Copyright (c) 2013-2014 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 BurndownChart
+
+  attr_accessor :data
+  
+  def initialize(settings)
+    @settings = settings
+    @burndown_data = BurndownData.new settings
+
+    @data = {
+      "meta" => {
+        "board_id" => nil,
+        "sprint" => 1,
+        "total_days" => 10,
+        "weekend_lines" => [ 3.5, 8.5 ]
+      },
+      "days" => []
+    }
+  end
+  
+  def sprint
+    @data["meta"]["sprint"]
+  end
+  
+  def sprint= s
+    @data["meta"]["sprint"] = s
+  end
+  
+  def board_id
+    @data["meta"]["board_id"]
+  end
+  
+  def board_id= id
+    @data["meta"]["board_id"] = id
+  end
+  
+  def days
+    @data["days"]
+  end
+  
+  def add_data(burndown_data, date)
+    new_entry = {
+      "date" => date.to_s,
+      "story_points" => {
+        "total" => burndown_data.story_points.total,
+        "open" => burndown_data.story_points.open
+      },
+      "tasks" => {
+        "total" => burndown_data.tasks.total,
+        "open" => burndown_data.tasks.open
+      },
+      "story_points_extra" => {
+        "done" => burndown_data.extra_story_points.done
+      },
+      "tasks_extra" => {
+        "done" => burndown_data.extra_tasks.done
+      }
+    }
+    new_days = Array.new
+    replaced_entry = false
+    @data["days"].each do |entry|
+      if entry["date"] == date.to_s
+        new_days.push(new_entry)
+        replaced_entry = true
+      else
+        new_days.push(entry)
+      end
+    end
+    if !replaced_entry
+      new_days.push(new_entry)
+    end
+    @data["days"] = new_days
+  end
+  
+  def read_data filename
+    @data = YAML.load_file filename
+  end
+  
+  def write_data filename
+    @data["days"].each do |day|
+      [ "story_points_extra", "tasks_extra" ].each do |key|
+        if day[key] && day[key]["done"] == 0
+          day.delete key
+        end
+      end
+    end
+
+    File.open( filename, "w" ) do |file|
+      file.write @data.to_yaml
+    end
+  end
+  
+  def burndown_data_filename
+    "burndown-data-#{sprint.to_s.rjust(2,"0")}.yaml"
+  end
+  
+  def setup(burndown_dir, board_id)
+    self.board_id = board_id
+    FileUtils.mkdir_p burndown_dir
+    write_data File.join(burndown_dir, burndown_data_filename)
+  end
+  
+  def update(burndown_dir)
+    Dir.glob("#{burndown_dir}/burndown-data-*.yaml").each do |file|
+      file =~ /burndown-data-(.*).yaml/
+      current_sprint = $1.to_i
+      if current_sprint > sprint
+        self.sprint = current_sprint
+      end
+    end
+    burndown_data_path = File.join(burndown_dir, burndown_data_filename)
+    begin
+      read_data burndown_data_path
+      @burndown_data.board_id = board_id
+      @burndown_data.fetch
+      add_data(@burndown_data, Date.today)
+      write_data burndown_data_path
+      puts "Updated data for sprint #{self.sprint}"
+    rescue Errno::ENOENT
+      raise TrolloloError.new( "'#{burndown_data_path}' not found" )
+    end
+  end
+
+  def create_next_sprint(burndown_dir)
+    Dir.glob("#{burndown_dir}/burndown-data-*.yaml").each do |file|
+      file =~ /burndown-data-(.*).yaml/
+      current_sprint = $1.to_i
+      if current_sprint > sprint
+        self.sprint = current_sprint
+      end
+    end
+    burndown_data_path = File.join(burndown_dir, burndown_data_filename)
+    begin
+      read_data burndown_data_path
+      self.sprint = self.sprint + 1
+      @data["days"] = []
+      write_data File.join(burndown_dir, burndown_data_filename)
+    rescue Errno::ENOENT
+      raise TrolloloError.new( "'#{burndown_data_path}' not found" )
+    end
+  end
+end

data/lib/burndown_data.rb

@@ -0,0 +1,172 @@
+#  Copyright (c) 2013-2014 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
+
+# This class represents the current state of burndown data on the Trello board.
+# It encapsulates getting the data from Trello. It does not keep any history
+# or interaction with the files used to generate burndown charts.
+class BurndownData
+
+  attr_accessor :story_points, :tasks, :extra_story_points, :extra_tasks
+  attr_accessor :board_id
+  
+  class Result
+    attr_accessor :open, :done
+    
+    def initialize
+      @open = 0
+      @done = 0
+    end
+    
+    def total
+      @open + @done
+    end
+  end
+
+  def initialize settings
+    @settings = settings
+
+    @story_points = Result.new
+    @tasks = Result.new
+
+    @extra_story_points = Result.new
+    @extra_tasks = Result.new
+  end
+
+  def trello
+    Trello.new(board_id: @board_id, developer_public_key: @settings.developer_public_key, member_token: @settings.member_token)
+  end
+
+  def fetch_todo_list_id
+    lists = trello.lists
+    lists.each do |l|
+      if l["name"] =~ /^Sprint Backlog$/
+        return l["id"]
+      end
+    end
+
+    raise "Unable to find sprint backlog column on sprint board"
+  end
+
+  def fetch_doing_list_id
+    lists = trello.lists
+    lists.each do |l|
+      if l["name"] =~ /^Doing$/
+        return l["id"]
+      end
+    end
+
+    raise "Unable to find doing column on sprint board"
+  end
+
+  def fetch_done_list_id
+    lists = trello.lists
+    last_sprint = nil
+    lists.each do |l|
+      if l["name"] =~ /^Done Sprint (.*)$/
+        sprint = $1.to_i
+        if !last_sprint || sprint > last_sprint[:number]
+          last_sprint = { :number => sprint, :id => l["id"] }
+        end
+      end
+    end
+
+    id = last_sprint[:id]
+    if !id
+      raise "Unable to find done column on sprint board"
+    end
+    id
+  end
+  
+  def fetch
+    cards = trello.cards
+
+    todo_list_id = fetch_todo_list_id
+    doing_list_id = fetch_doing_list_id
+    done_list_id = fetch_done_list_id
+    
+    if @settings.verbose
+      puts "Todo list: #{todo_list_id}"
+      puts "Doing list: #{doing_list_id}"
+      puts "Done list: #{done_list_id}"
+    end
+
+    sp_total = 0
+    sp_done = 0
+    
+    extra_sp_total = 0
+    extra_sp_done = 0
+
+    tasks_total = 0
+    tasks_done = 0
+    
+    extra_tasks_total = 0
+    extra_tasks_done = 0
+    
+    cards.each do |c|
+      card = Card.parse c
+      
+      list_id = c["idList"]
+
+      if list_id == todo_list_id || list_id == doing_list_id
+        if card.has_sp?
+          if card.extra?
+            extra_sp_total += card.sp
+          else
+            sp_total += card.sp
+          end
+        end
+        if card.extra?
+          extra_tasks_total += card.tasks
+          extra_tasks_done += card.tasks_done
+        else
+          tasks_total += card.tasks
+          tasks_done += card.tasks_done
+        end
+      elsif list_id == done_list_id
+        if card.has_sp?
+          if card.extra?
+            extra_sp_total += card.sp
+            extra_sp_done += card.sp
+          else
+            sp_total += card.sp
+            sp_done += card.sp
+          end
+        end
+        if card.extra?
+          extra_tasks_total += card.tasks
+          extra_tasks_done += card.tasks_done
+        else
+          tasks_total += card.tasks
+          tasks_done += card.tasks_done
+        end
+      end
+    end
+    
+    @story_points.done = sp_done
+    @story_points.open = sp_total - sp_done
+    
+    @tasks.done = tasks_done
+    @tasks.open = tasks_total - tasks_done
+
+    @extra_story_points.done = extra_sp_done
+    @extra_story_points.open = extra_sp_total - extra_sp_done
+    
+    @extra_tasks.done = extra_tasks_done
+    @extra_tasks.open = extra_tasks_total - extra_tasks_done
+  end
+
+end