trollolo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c781701661ccd9a1f161f56cd7c07c6b4b0cf7e0
-  data.tar.gz: a4615b48df363c710ff45788c9fb72c963690ed3
+  metadata.gz: 5adc2629b2f526c70851abc5ba72765860d73e2f
+  data.tar.gz: d31159f96937237011765b1df87036d90a94fede
 SHA512:
-  metadata.gz: 0772e65840bbc21aff6cd757adace1938fbca7b4094c78a550d1d7c2bb4069ff66e3af37e17b55618b259a62ee0ce7c0726415d6f2f593f813f22ece587fc528
-  data.tar.gz: 321418dcee6afb7c3283ffb13370c287367270887fd8b8a316ff2d00fc384805762b68a1cb1c4b8d3bb43bb8407a8f3df3794d84b03f5f4e42cdf5cc88d1fb16
+  metadata.gz: 7eb4de3cb4a144902d467e40471236ca54c8992228fc5b1b6531148887512609bb5e56f2b43abb646d4eca512008e9c6b7d3c228073c3f1bb2a94cd6a22532e9
+  data.tar.gz: 7df063a8b64b2e8eea6118115d1e0ab8b7653783c972abcd046b0c25b1a6951ac39147b2d4e01f4e1c1dfc7724f5554347cc85570695b5026310a6f746b9ab6f

data/.gitignore

@@ -2,3 +2,5 @@
 Gemfile.lock
 tmp
 coverage
+*.png
+*.yaml

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
+cache: bundler
+before_install:
+  - gem update --system
+  - gem --version
 rvm:
   - "2.0.0"
   - "2.1.1"
-script: bundle exec rspec spec
+script: bundle exec rspec spec/unit
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Trollolo Changelog
 
+## Version 0.0.4
+
+* Allow to story points anywhere in the card name
+* Read columns considered as not done from sprint yaml. This makes it possible
+  to configure additional work in progress columns.
+* Add `burndowns` command to update multiple charts at once
+* Add option `--no-tasks` to not show tasks part of the graph
+* Add option `--with-fast-lane` to separately plot cards which have a
+  `Fast Lane` label.
+* Store date and time when chart was updated
+* Exclude checlists named "Feedback" from the tasks calculation
+* Add commands to show organization data:
+    * The command `organization` shows basic info about the organization.
+    * The command `organization_members` lists all members.
+* Add command to get raw JSON from Trello API
+* Add handling of done tasks under the waterline at the beginning of a new
+  sprint
+* Add `--plot` option to `burndown` command to immediately show chart
+* Add `--output` option to `plot` command to specify the directory it uses
+* Save date and time of fetching burndown data
+* Optionally fetch general meta data for burndown chart from special card
+* Include list named "Blocked" in burndown calculation
+* Implement basic backup function:
+    * The command `backup` creates a backup of a board identified by its id
+    * The command `show_backup` shows the content of the backup
+    * The command `list_backups` shows the list of backups which have been made
+    * The backups are stored to the directory `~/.trollolo/backups` in JSON
+      format
+
 ## Version 0.0.3
 
 * Document burndown generation work flow

data/Gemfile

@@ -1,11 +1,16 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
 group :test do
   gem 'codeclimate-test-reporter'
-  gem 'rspec', "~>3"
+  gem 'rspec', '~> 3'
   gem 'aruba'
   gem 'webmock'
   gem 'given_filesystem'
+  gem 'byebug'
+  gem 'awesome_print'
+  gem 'pry'
+  gem 'ronn', '>=0.7.3'
+  gem 'rake'
 end

data/README.md

@@ -19,6 +19,15 @@ 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.
 
+## Installation
+
+You can install Trollolo as gem with `gem install trollolo`.
+
+For the chart generation you will need a working matplotlib installation and
+the python module to read YAML. On openSUSE you can get that with
+
+    zypper install python-matplotlib python-matplotlib-tk python-PyYAML
+
 ## Configuration
 
 Trollolo reads a configuration file `.trollolorc` in the home directory of the
@@ -85,8 +94,18 @@ To generate the actual burndown chart, go to the working directory and call:
 
     trollolo plot SPRINT_NUMBER
 
+or fetch and plot data in one step with:
+
+    trollolo burndown --plot
+
 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.
 
+Some more info can be found in the command line help with `trollolo help` and
+`trollolo help burndown`.
+
+### Example
+
+![Burndown example](https://raw.githubusercontent.com/openSUSE/trollolo/master/examples/burndown-26.png)

data/bin/trollolo

@@ -26,7 +26,7 @@ Cli.settings = Settings.new(config_path)
 ENV["THOR_DEBUG"] = "1"
 begin
   Cli.check_unknown_options!
-  result = Cli.start ARGV
+  Cli.start
 rescue Thor::Error => e
   STDERR.puts e
   exit 1

data/lib/array.rb

@@ -0,0 +1,6 @@
+class Array
+  def sum
+    return 0 if empty?
+    inject(:+)
+  end
+end

data/lib/backup.rb

@@ -0,0 +1,67 @@
+class Backup
+
+  attr_accessor :directory
+
+  def initialize settings
+    @settings = settings
+    @directory = File.expand_path("~/.trollolo/backup")
+  end
+
+  def backup(board_id)
+    backup_path = File.join(@directory, board_id)
+    FileUtils.mkdir_p(backup_path)
+
+    trello = TrelloWrapper.new(@settings)
+
+    data = trello.backup(board_id)
+
+    File.open(File.join(backup_path, "board.json"), "w") do |f|
+      f.write(data)
+    end
+  end
+
+  def list
+    Dir.entries(@directory).reject { |d| d =~ /^\./ }
+  end
+
+  def show(board_id, options = {})
+    out = options[:output] || STDOUT
+
+    backup_path = File.join(@directory, board_id)
+
+    board = JSON.parse(File.read(File.join(backup_path, "board.json")))
+
+    out.puts board["name"]
+
+    lists = {}
+    board["lists"].each do |list|
+      lists[list["id"]] = []
+    end
+    board["cards"].each do |card|
+      if lists[card["idList"]]
+        lists[card["idList"]].push(card)
+      end
+    end
+
+    board["lists"].each do |list|
+      out.puts "  #{list['name']}"
+      lists[list["id"]].each do |card|
+        out.puts "    " + card["name"]
+        if options["show-descriptions"]
+          if !card["desc"].empty?
+            out.puts "      Description"
+            out.puts "        " + card["desc"]
+          end
+        end
+        card["checklists"].each do |checklist|
+          out.puts "      " + checklist["name"]
+          checklist["checkItems"].each do |checklist_item|
+            out.puts "        " + checklist_item["name"] + " (" +
+              checklist_item["state"] + ")"
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/burndown_chart.rb

@@ -14,11 +14,10 @@
 #
 #  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
@@ -33,65 +32,63 @@ class BurndownChart
       "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)
+
+  def merge_meta_data_from_board(burndown_data)
+    if burndown_data.meta
+      m = burndown_data.meta
+      if m["sprint"] == @data["meta"]["sprint"].to_i
+        @data["meta"] = @data["meta"].merge(m)
       end
     end
-    if !replaced_entry
-      new_days.push(new_entry)
+  end
+
+  def replace_entry(date, new_entry)
+    days.each_with_index do |entry, idx|
+      days[idx] = new_entry if entry["date"] == date.to_s
+    end
+  end
+
+  def entry_exists?(date)
+    days.any? { |entry| entry["date"] == date.to_s }
+  end
+
+  def add_data(burndown_data)
+    new_entry = burndown_data.to_hash
+    if entry_exists?(burndown_data.date_time.to_date)
+      replace_entry(burndown_data.date_time.to_date, new_entry)
+    else
+      days.push(new_entry)
     end
-    @data["days"] = new_days
   end
-  
+
   def read_data filename
     @data = YAML.load_file filename
+    not_done_columns = @data["meta"]["not_done_columns"]
+    if not_done_columns
+      @settings.not_done_columns = not_done_columns
+    end
   end
-  
+
   def write_data filename
     @data["days"].each do |day|
       [ "story_points_extra", "tasks_extra" ].each do |key|
@@ -101,58 +98,90 @@ class BurndownChart
       end
     end
 
-    File.open( filename, "w" ) do |file|
-      file.write @data.to_yaml
+    begin
+      File.open( filename, "w" ) do |file|
+        file.write @data.to_yaml
+      end
+    rescue Errno::ENOENT
+      raise TrolloloError.new( "'#{filename}' not found" )
     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
+
+  class << self
+
+    def plot_helper
+      File.expand_path('../../scripts/create_burndown.py', __FILE__ )
     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" )
+
+    def plot(sprint_number, options)
+      sprint_number = sprint_number.to_s.rjust(2, '0')
+      cli_switches = process_options(options)
+      system "python #{plot_helper} #{sprint_number} #{cli_switches.join(' ')}"
     end
+
+    private
+
+    def process_options(hash)
+      return [] unless hash
+      [].tap do |cli_switches|
+        cli_switches << '--no-tasks'                 if hash['no-tasks']
+        cli_switches << '--with-fast-lane'           if hash['with-fast-lane']
+        cli_switches << "--output #{hash['output']}" if hash['output']
+        cli_switches << '--verbose'                  if hash['verbose']
+      end
+    end
+
   end
 
-  def create_next_sprint(burndown_dir)
+  def last_sprint(burndown_dir)
+    last_sprint = sprint
     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
+      if current_sprint > last_sprint
+        last_sprint = current_sprint
       end
     end
+    last_sprint
+  end
+
+  def load_last_sprint(burndown_dir)
+    self.sprint = last_sprint(burndown_dir)
     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
+    return burndown_data_path
   end
+
+  def update(options)
+    burndown_data_path = load_last_sprint(options['output'] || Dir.pwd)
+    @burndown_data.board_id = board_id
+    @burndown_data.fetch
+    add_data(@burndown_data)
+    write_data burndown_data_path
+    if options[:plot]
+      BurndownChart.plot(self.sprint, options)
+    end
+  end
+
+  def create_next_sprint(burndown_dir)
+    load_last_sprint(burndown_dir)
+    self.sprint = self.sprint + 1
+    @data["days"] = []
+    write_data File.join(burndown_dir, burndown_data_filename)
+  end
+
 end

data/lib/burndown_data.rb

@@ -20,153 +20,92 @@
 # 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
+  attr_accessor :story_points, :tasks, :extra_story_points, :extra_tasks,
+                :board_id, :fast_lane_cards, :date_time
+  attr_reader :meta
 
+  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)
+    @extra_tasks        = Result.new
+    @fast_lane_cards    = Result.new
   end
 
-  def fetch_todo_list_id
-    lists = trello.lists
-    lists.each do |l|
-      if l["name"] =~ /^Sprint Backlog$/
-        return l["id"]
-      end
+  def to_hash
+    base = {
+      "date" => date_time.to_date.to_s,
+      "updated_at" => date_time.to_s,
+      "story_points" => {
+        "total" => story_points.total,
+        "open" => story_points.open
+      },
+      "tasks" => {
+        "total" => tasks.total,
+        "open" => tasks.open
+      },
+      "story_points_extra" => {
+        "done" => extra_story_points.done
+      },
+      "tasks_extra" => {
+        "done" => extra_tasks.done
+      }
+    }
+    if fast_lane_cards.total > 0
+      base.merge("fast_lane" => {
+                     "total" => fast_lane_cards.total,
+                     "open" => fast_lane_cards.open
+                 })
+    else
+      base
     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"
+  def trello
+    @trello ||= TrelloWrapper.new(@settings)
   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
+  def board
+    trello.board(@board_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"]
+  def fetch
+    get_meta
+    @story_points.done       = board.done_story_points
+    @story_points.open       = board.open_story_points
+    @tasks.open              = board.tasks - board.closed_tasks
+    @tasks.done              = board.closed_tasks
+    @extra_story_points.done = board.extra_done_story_points
+    @extra_story_points.open = board.extra_open_story_points
+    @extra_tasks.done        = board.extra_closed_tasks
+    @extra_tasks.open        = board.extra_tasks - board.extra_closed_tasks
+    @fast_lane_cards.done    = board.done_fast_lane_cards_count
+    @fast_lane_cards.open    = board.open_fast_lane_cards_count
+    @date_time               = DateTime.now
+  end
 
-      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
+  private
 
-    @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
+  def get_meta
+    meta_cards = board.meta_cards
+    return unless meta_cards.any?
+    current_sprint_meta_card = meta_cards.max_by(&:sprint_number)
+    @meta = Card.parse_yaml_from_description(current_sprint_meta_card.desc)
+    @meta['sprint'] = current_sprint_meta_card.sprint_number
   end
 
 end