Create public repository

Author: cornelius

.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+tmp

.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+Contributions are welcome.
+
+To report bugs please open GitHub issues.
+
+To contribute code please open pull requests.
+
+To discuss anything please [contact me](mailto:[email protected]).

COPYING

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'aruba'
+  gem 'webmock'
+  gem 'given_filesystem'
+end

Gemfile

@@ -0,0 +1,40 @@
+# 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.

README.md

@@ -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

Rakefile

@@ -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

bin/trollolo

@@ -0,0 +1,132 @@
+#  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" => 9,
+        "weekend_lines" => [ 3.5, 7.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
+    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)
+    FileUtils.cp(File.expand_path("../../templates/create_burndown",__FILE__),
+      burndown_dir)
+  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
+    rescue Errno::ENOENT
+      raise TrolloloError.new( "'#{burndown_data_path}' not found" )
+    end
+  end
+end