trollolo 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 ## Master (unreleased)
 
 
+## Version 0.2.0
+
+* Require Ruby to be >= 2.2.0 and < 2.4.2 until #139 is fixed.
+* `burndown-init` only requires the `--board-id` option. The `--output` option
+  is optional and defaults to the current working directory. Fix #103.
+* Allow to define checklists that should not be parsed as task lists. Such lists
+  can be added in the trollolorc as `no_task_checklists`.
+* Allow to provide a board id when calling `burndown`. Fix #100.
+* Set the attached image as cover in `burndown --plot-to-board`. Fix #124.
+
 ## Version 0.1.1
 
 * Fix the bug introduced whith always setting the burndown chart as the cover

data/CONTRIBUTING.md

@@ -1,12 +1,14 @@
+# CONTRIBUTING GUIDE
+
 Contributions are welcome! :smile:
 
-# Report bugs or suggest changes
+## Report bugs or suggest changes
 
 To report bugs, suggest changes or provide ideas please open GitHub issues.
 
 To discuss anything please [contact Cornelius](mailto:cschum@suse.de).
 
-# Contribute code
+## Contribute code
 
 To contribute code please open pull requests.
 
@@ -14,7 +16,7 @@ Ensure that rspec and rubocop pass locally before sending your PR and always tha
 
 If your changes include important new features or bug fixes please add them to the [Master (unreleased) section fo the CHANGELOG.md](https://github.com/openSUSE/trollolo/blob/master/CHANGELOG.md#master-unreleased)
 
-## To run rspec test
+### To run rspec test
 
 To run all the rspec test:
 
@@ -28,7 +30,7 @@ To only run the test in the line 415 of the file:
 
 `bundle exec rspec spec/unit/burndown_chart_spec.rb:415`
 
-## To run rubocop
+### To run rubocop
 
 To run Rubocop displaying cop names in offense messages:
 

data/Gemfile

@@ -14,6 +14,6 @@ group :test do
   gem 'pry'
   gem 'ronn', '>=0.7.3'
   gem 'rake'
-  gem 'rubocop', '~> 0.49.1'
+  gem 'rubocop', '0.52.1'
   gem 'rspec-mocks'
 end

data/README.md

@@ -21,6 +21,8 @@ which demonstrates the expected structure.
 
 ## Installation
 
+You need to have Ruby install. Trollolo works with Ruby 2.2-2.4.1, but currently it doesn't work with 2.4.2. See [#139](https://github.com/openSUSE/trollolo/issues/139) for more information.
+
 You can install Trollolo as gem with `gem install trollolo`.
 
 For the chart generation you will need a working matplotlib installation and
@@ -91,7 +93,14 @@ 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:
+Start the workflow by using the current directory as working directory and
+initialize it for the burndown chart generation:
+
+    trollolo burndown-init --board-id=MYBOARDID
+
+By default, trollolo uses the current directory as working directory, if you
+want to specify another directory as working directory, use the `--output`
+option as follows:
 
     trollolo burndown-init --board-id=MYBOARDID --output=WORKING_DIR
 

data/Rakefile

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

data/bin/trollolo

@@ -18,12 +18,12 @@
 
 require_relative '../lib/trollolo'
 
-config_path = ENV["TROLLOLO_CONFIG_PATH"] || File.expand_path("~/.trollolorc")
+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"
+ENV['THOR_DEBUG'] = '1'
 begin
   Cli.check_unknown_options!
   Cli.start

data/lib/backup.rb

@@ -4,9 +4,9 @@ class Backup
 
   attr_accessor :directory
 
-  def initialize settings
+  def initialize(settings)
     @settings = settings
-    @directory = File.expand_path("~/.trollolo/backup")
+    @directory = File.expand_path('~/.trollolo/backup')
   end
 
   def backup(board_id)
@@ -17,7 +17,7 @@ class Backup
 
     data = trello.backup(board_id)
 
-    File.open(File.join(backup_path, "board.json"), "w") do |f|
+    File.open(File.join(backup_path, 'board.json'), 'w') do |f|
       f.write(data)
     end
   end
@@ -31,35 +31,33 @@ class Backup
 
     backup_path = File.join(@directory, board_id)
 
-    board = JSON.parse(File.read(File.join(backup_path, "board.json")))
+    board = JSON.parse(File.read(File.join(backup_path, 'board.json')))
 
-    out.puts board["name"]
+    out.puts board['name']
 
     lists = {}
-    board["lists"].each do |list|
-      lists[list["id"]] = []
+    board['lists'].each do |list|
+      lists[list['id']] = []
     end
-    board["cards"].each do |card|
-      if lists[card["idList"]]
-        lists[card["idList"]].push(card)
-      end
+    board['cards'].each do |card|
+      lists[card['idList']].push(card) if lists[card['idList']]
     end
 
-    board["lists"].each do |list|
+    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"]
+      lists[list['id']].each do |card|
+        out.puts '    ' + card['name']
+        if options['show-descriptions']
+          unless 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"] + ")"
+        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

data/lib/burndown_chart.rb

@@ -24,53 +24,53 @@ class BurndownChart
     @settings = settings
 
     @data = {
-      "meta" => {
-        "board_id" => nil,
-        "sprint" => 1,
-        "total_days" => 10,
-        "weekend_lines" => [ 3.5, 8.5 ]
+      'meta' => {
+        'board_id' => nil,
+        'sprint' => 1,
+        'total_days' => 10,
+        'weekend_lines' => [ 3.5, 8.5 ]
       },
-      "days" => []
+      'days' => []
     }
   end
 
   def sprint
-    @data["meta"]["sprint"]
+    @data['meta']['sprint']
   end
 
-  def sprint= s
-    @data["meta"]["sprint"] = s
+  def sprint=(s)
+    @data['meta']['sprint'] = s
   end
 
   def board_id
-    @data["meta"]["board_id"]
+    @data['meta']['board_id']
   end
 
-  def board_id= id
-    @data["meta"]["board_id"] = id
+  def board_id=(id)
+    @data['meta']['board_id'] = id
   end
 
   def days
-    @data["days"]
+    @data['days']
   end
 
   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)
+      if m['sprint'] == @data['meta']['sprint'].to_i
+        @data['meta'] = @data['meta'].merge(m)
       end
     end
   end
 
   def replace_entry(date, new_entry)
     days.each_with_index do |entry, idx|
-      days[idx] = new_entry if entry["date"] == date.to_s
+      days[idx] = new_entry if entry['date'] == date.to_s
     end
   end
 
   def entry_exists?(date)
-    days.any? { |entry| entry["date"] == date.to_s }
+    days.any? { |entry| entry['date'] == date.to_s }
   end
 
   def add_data(burndown_data)
@@ -82,29 +82,25 @@ class BurndownChart
     end
   end
 
-  def read_data filename
+  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
+    not_done_columns = @data['meta']['not_done_columns']
+    @settings.not_done_columns = not_done_columns if not_done_columns
   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
+  def write_data(filename)
+    @data['days'].each do |day|
+      %w[story_points_extra tasks_extra].each do |key|
+        day.delete key if day[key] && day[key]['done'] == 0
       end
     end
 
     begin
-      File.open( filename, "w" ) do |file|
+      File.open( filename, 'w' ) do |file|
         file.write @data.to_yaml
       end
     rescue Errno::ENOENT
-      raise TrolloloError.new( "'#{filename}' not found" )
+      raise TrolloloError, "'#{filename}' not found"
     end
   end
 
@@ -117,7 +113,7 @@ class BurndownChart
 
     begin
       uri       = URI.parse(url)
-      push      = Net::HTTP::Post.new(uri.path, { 'Content-Type' => 'application/json' })
+      push      = Net::HTTP::Post.new(uri.path, 'Content-Type' => 'application/json')
       push.body = burndown_data.to_hash.to_json
 
       Net::HTTP.start(uri.hostname, uri.port) do |http|
@@ -127,13 +123,13 @@ class BurndownChart
       # Instead of catching 20 different exceptions which can be
       # thrown by URI and Http::, StandardError is catched.
       # Fix this if there is a better solution
-      raise TrolloloError.new("pushing to endpoint failed: #{e.message}")
+      raise TrolloloError, "pushing to endpoint failed: #{e.message}"
     end
   end
 
 
   def burndown_data_filename
-    "burndown-data-#{sprint.to_s.rjust(2, "0")}.yaml"
+    "burndown-data-#{sprint.to_s.rjust(2, '0')}.yaml"
   end
 
   def setup(burndown_dir, board_id)
@@ -172,10 +168,8 @@ class BurndownChart
     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 > last_sprint
-        last_sprint = current_sprint
-      end
+      current_sprint = Regexp.last_match(1).to_i
+      last_sprint = current_sprint if current_sprint > last_sprint
     end
     last_sprint
   end
@@ -187,14 +181,15 @@ class BurndownChart
     begin
       read_data burndown_data_path
     rescue Errno::ENOENT
-      raise TrolloloError.new( "'#{burndown_data_path}' not found" )
+      raise TrolloloError, "'#{burndown_data_path}' not found"
     end
-    return burndown_data_path
+    burndown_data_path
   end
 
   def update(options)
     burndown_data_path = load_sprint(options['output'] || Dir.pwd, options[:sprint_number])
 
+    @data['meta']['board_id'] = options['board-id'] if options.key?('board-id')
     burndown_data = BurndownData.new(@settings)
     burndown_data.board_id = board_id
     burndown_data.fetch
@@ -204,12 +199,10 @@ class BurndownChart
     write_data(burndown_data_path)
 
     if options[:plot] || options[:plot_to_board]
-      BurndownChart.plot(self.sprint, options)
+      BurndownChart.plot(sprint, options)
     end
 
-    if options.has_key?('push-to-api')
-      push_to_api(options['push-to-api'], data)
-    end
+    push_to_api(options['push-to-api'], data) if options.key?('push-to-api')
 
     if options[:plot_to_board]
       trello = TrelloWrapper.new(@settings)
@@ -217,17 +210,21 @@ class BurndownChart
       name = options['output'] ? options['output'] : '.'
       name += "/burndown-#{sprint.to_s.rjust(2, '0')}.png"
       card_id = board.burndown_card_id
-      trello.add_attachment(card_id, name)
-      trello.make_cover(card_id, "burndown-#{sprint.to_s.rjust(2, '0')}.png")
+
+      response = trello.add_attachment(card_id, name)
+
+      if /{\"id\":\"(?<attachment_id>\w+)\"/ =~ response
+        trello.make_cover_with_id(card_id, attachment_id)
+      end
     end
   end
 
   def create_next_sprint(burndown_dir, options = {})
     load_sprint(burndown_dir)
-    self.sprint = options[:sprint_number] || (self.sprint + 1)
-    @data["meta"]["total_days"] = options[:total_days] if options[:total_days]
-    @data["meta"]["weekend_lines"] = options[:weekend_lines] unless options[:weekend_lines].blank?
-    @data["days"] = []
+    self.sprint = options[:sprint_number] || (sprint + 1)
+    @data['meta']['total_days'] = options[:total_days] if options[:total_days]
+    @data['meta']['weekend_lines'] = options[:weekend_lines] unless options[:weekend_lines].blank?
+    @data['days'] = []
     write_data File.join(burndown_dir, burndown_data_filename)
   end
 

data/lib/burndown_data.rb

@@ -52,37 +52,37 @@ class BurndownData
 
   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
+      '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
+      'tasks' => {
+        'total' => tasks.total,
+        'open' => tasks.open
       },
-      "story_points_extra" => {
-        "done" => extra_story_points.done
+      'story_points_extra' => {
+        'done' => extra_story_points.done
       },
-      "tasks_extra" => {
-        "done" => extra_tasks.done
+      'tasks_extra' => {
+        'done' => extra_tasks.done
       }
     }
     if fast_lane_cards.total > 0
-      base["fast_lane"] = {
-        "total" => fast_lane_cards.total,
-        "open" => fast_lane_cards.open
+      base['fast_lane'] = {
+        'total' => fast_lane_cards.total,
+        'open' => fast_lane_cards.open
       }
     end
     if unplanned_story_points.total > 0
-      base["unplanned_story_points"] = {
-        "total" => unplanned_story_points.total,
-        "open" => unplanned_story_points.open
+      base['unplanned_story_points'] = {
+        'total' => unplanned_story_points.total,
+        'open' => unplanned_story_points.open
       }
-      base["unplanned_tasks"] = {
-        "total" => unplanned_tasks.total,
-        "open" => unplanned_tasks.open
+      base['unplanned_tasks'] = {
+        'total' => unplanned_tasks.total,
+        'open' => unplanned_tasks.open
       }
     end
     base