trollolo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 561041c5f8420e41a174b2c3f54b493454b1a220
-  data.tar.gz: fcdcb4abeab34f5e6e3b1b823851a5a1fd9d7081
+SHA256:
+  metadata.gz: 39645441651332bd9aa763b5eea9827f46681b85569482dd8a5f69aae5a54f6f
+  data.tar.gz: 638a3a09670e1515faf53a02a8e8fc849ef46156c27509d4f8799a21c19cc25b
 SHA512:
-  metadata.gz: 7322aef84f271b3cb8d457ffb6af4c9f7c46b302966e96403ca7f17753007602c31dd11d06ba739554fb8914b3e44017cefe5613ab72a2844a1e0e8bbdf6738a
-  data.tar.gz: dd8f8af43466dd9663eee33df0fba9a8559c0ea26fcf6e40a81108a396c3177a5bf606e84a7ac0994cf01e93db8dd27dd39fe3a5fe32b2cca96b8de6e79d40a6
+  metadata.gz: 19fe728b12ab77109ad83310ab46e781be3bdf24c6388a5bf403b783043e327d7cbe6119b836c503995c4fe66db37cb5e2229c20969b95446e29d9fc6a9f6e97
+  data.tar.gz: 9983169a36878297fdbd4fc10bb46f4c97b030b24308a95abd96cd9ca6f013bbe5f73a55ededfa0a0fb7cb8a9b9deec5b1fdb6e7199e0d0ec87896d1c5f7a205

data/.gitignore

@@ -2,3 +2,4 @@
 Gemfile.lock
 tmp
 coverage
+.vscode

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+# This probably rather should be EnforcedStyle: brackets
+Style/WordArray:
+  Enabled: false
+
 #################### Metrics ###############################
 
 Metrics/AbcSize:

data/.rubocop_todo.yml

@@ -6,14 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 7
-# Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: Include, TreatCommentsAsGroupSeparators.
@@ -29,15 +21,6 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'trollolo.gemspec'
 
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/DotPosition:
-  Exclude:
-    - 'spec/integration/create_burndown_spec.rb'
-    - 'spec/unit/trello_wrapper_spec.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Layout/EmptyLineAfterMagicComment:
@@ -158,6 +141,9 @@ Layout/MultilineMethodCallIndentation:
   Exclude:
     - 'lib/burndown_chart.rb'
     - 'spec/unit/trello_wrapper_spec.rb'
+    - 'spec/unit/board_mock_spec.rb' # Indendation is used to express structure of board
+    - 'spec/unit/burndown_data_spec.rb' # Indendation is used to express structure of board
+    - 'spec/unit/scrum_board_spec.rb' # Indendation is used to express structure of board
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -308,14 +294,6 @@ Naming/UncommunicativeMethodArgName:
     - 'lib/scrum/sprint_board.rb'
     - 'lib/scrum/sprint_planning_board.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect.
-Performance/HashEachMethods:
-  Exclude:
-    - 'lib/cli.rb'
-    - 'lib/scrum/creator.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Security/YAMLLoad:
@@ -416,6 +394,3 @@ Style/PercentLiteralDelimiters:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'trollolo.gemspec'

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 cache: bundler
 before_install:
-  - gem --version
   - gem list bundler
 rvm:
   - "2.2.3"
   - "2.3.1"
+  - "2.4.3"
+  - "2.5.0"
 script:
   - 'bundle exec rubocop -D'
   - 'bundle exec rspec spec/unit'

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Trollolo Changelog
 
-## Master (unreleased)
+## Version 0.3.0
 
+* Support for Ruby >= 2.2, including Ruby 2.5
+* Add support for swimlanes, used for cards which are not part of the normal
+  sprint.
 
 ## Version 0.2.0
 

data/CONTRIBUTING.md

@@ -10,7 +10,7 @@ To discuss anything please [contact Cornelius](mailto:cschum@suse.de).
 
 ## Contribute code
 
-To contribute code please open pull requests.
+To contribute code fork the repository and open pull requests with your changes.
 
 Ensure that rspec and rubocop pass locally before sending your PR and always that you add new changes.
 
@@ -18,9 +18,9 @@ If your changes include important new features or bug fixes please add them to t
 
 ### To run rspec test
 
-To run all the rspec test:
+To run all the unit tests:
 
-`bundle exec rspec`
+`bundle exec rspec spec/unit`
 
 To run all the test in one spec file, for example `spec/unit/burndown_chart_spec.rb`:
 
@@ -30,8 +30,22 @@ To only run the test in the line 415 of the file:
 
 `bundle exec rspec spec/unit/burndown_chart_spec.rb:415`
 
+### To try your changes
+
+Build the gem: 
+
+`bundle exec rake gem:build`
+
+Install the gem: 
+
+`gem install trollolo-<version>.gem`
+
 ### To run rubocop
 
 To run Rubocop displaying cop names in offense messages:
 
 `bundle exec rubocop -D`
+
+## Code of Conduct
+
+Trollolo is part of the openSUSE project. We follow all the [openSUSE Guiding Principles](https://en.opensuse.org/openSUSE:Guiding_principles)!

data/Gemfile

@@ -3,17 +3,17 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', '>= 1.0.0'
-  gem 'rspec', '~> 3.5'
+  gem 'awesome_print'
+  gem 'byebug'
   gem 'cli_tester'
-  gem 'webmock'
-  gem 'vcr'
+  gem 'codeclimate-test-reporter', '>= 1.0.0'
   gem 'given_filesystem'
-  gem 'byebug'
-  gem 'awesome_print'
   gem 'pry'
-  gem 'ronn', '>=0.7.3'
   gem 'rake'
-  gem 'rubocop', '0.52.1'
+  gem 'ronn', '>=0.7.3'
+  gem 'rspec', '~> 3.5'
   gem 'rspec-mocks'
+  gem 'rubocop', '0.52.1'
+  gem 'vcr'
+  gem 'webmock'
 end

data/README.md

@@ -21,7 +21,7 @@ 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 need to have Ruby install. Trollolo works with Ruby >= 2.2.
 
 You can install Trollolo as gem with `gem install trollolo`.
 
@@ -139,7 +139,6 @@ The specified `URL` can contain placeholders which will be replaced:
      :board  => Board ID
 
 
-
 To generate the actual burndown chart, go to the working directory and call:
 
     trollolo plot SPRINT_NUMBER
@@ -156,6 +155,45 @@ Trello board.
 Some more info can be found in the command line help with `trollolo help` and
 `trollolo help burndown`.
 
+### Swimlanes
+
+You can define swimlanes to exclude certain cards from the normal burndown
+data. This can be useful when you track work of multiple projects on the same
+board and you don't want to apply the full Scrum framework to all of them. An
+example would be a side project which you limit to one card in process.
+
+Swimlanes are defined by putting a label with the name of the swimlane on all
+cards which belong to this swimlane. It does not matter in which column they
+are. To make Trollolo aware of the swimlane, you need to add an entry in the
+meta section of the burndown YAML such as:
+
+    meta:
+      swimlanes:
+        - My Side Project
+
+This lets Trollolo exclude all cards which have the label with the name
+`My Side Project` from the burndown chart.
+
+The data for swimlane cards is collected separately in the burndown YAML
+separated in `todo`, `doing`, and `done` values. This can be used to generate
+statistics for the swimlanes. Trollolo currently only writes the raw data
+but doesn't support any statistics such as generating graphs.
+
+### Column names
+
+Trollolo by default looks for columns named such as `Sprint Backlog`, `Doing`,
+or `Done`. If you need more or other names you can configure that in the burndown
+YAML. Here is an example:
+
+    meta:
+      todo_columns:
+        - Main Backlog
+        - Swimlane Backlog
+      doing_columns:
+        - Doing
+        - Review
+        - QA
+
 ### Example
 
 ![Burndown example](https://raw.githubusercontent.com/openSUSE/trollolo/master/examples/burndown-26.png)

data/lib/burndown_chart.rb

@@ -84,8 +84,17 @@ class BurndownChart
 
   def read_data(filename)
     @data = YAML.load_file filename
+
+    todo_columns = @data['meta']['todo_columns']
+    @settings.todo_columns = todo_columns if todo_columns
+
+    doing_columns = @data['meta']['doing_columns']
+    @settings.doing_columns = doing_columns if doing_columns
+
     not_done_columns = @data['meta']['not_done_columns']
     @settings.not_done_columns = not_done_columns if not_done_columns
+
+    @settings.swimlanes = @data['meta']['swimlanes'] || []
   end
 
   def write_data(filename)

data/lib/burndown_data.rb

@@ -33,9 +33,31 @@ class BurndownData
     end
   end
 
+  class SwimlaneResult
+    attr_accessor :todo, :doing, :done
+
+    def add_todo(story_points)
+      @todo += story_points
+    end
+
+    def add_doing(story_points)
+      @doing += story_points
+    end
+
+    def add_done(story_points)
+      @done += story_points
+    end
+
+    def initialize
+      @todo = 0
+      @doing = 0
+      @done = 0
+    end
+  end
+
   attr_accessor :story_points, :tasks, :extra_story_points, :extra_tasks,
                 :unplanned_story_points, :unplanned_tasks,
-                :board_id, :fast_lane_cards, :date_time
+                :board_id, :fast_lane_cards, :date_time, :swimlanes
   attr_reader :meta
 
   def initialize(settings)
@@ -48,6 +70,11 @@ class BurndownData
     @unplanned_tasks        = Result.new
     @fast_lane_cards        = Result.new
     @date_time              = Time.now
+
+    @swimlanes              = {}
+    settings.swimlanes.each do |swimlane|
+      @swimlanes[swimlane] = SwimlaneResult.new
+    end
   end
 
   def to_hash
@@ -69,12 +96,9 @@ class BurndownData
         'done' => extra_tasks.done
       }
     }
-    if fast_lane_cards.total > 0
-      base['fast_lane'] = {
-        'total' => fast_lane_cards.total,
-        'open' => fast_lane_cards.open
-      }
-    end
+
+    base['fast_lane'] = fast_lane_to_hash if fast_lane_cards.total > 0
+
     if unplanned_story_points.total > 0
       base['unplanned_story_points'] = {
         'total' => unplanned_story_points.total,
@@ -85,9 +109,31 @@ class BurndownData
         'open' => unplanned_tasks.open
       }
     end
+
+    base['swimlanes'] = swimlanes_to_hash unless swimlanes.empty?
+
     base
   end
 
+  def fast_lane_to_hash
+    {
+      'total' => fast_lane_cards.total,
+      'open' => fast_lane_cards.open
+    }
+  end
+
+  def swimlanes_to_hash
+    swimlanes_element = {}
+    swimlanes.each do |name, swimlane_result|
+      swimlanes_element[name] = {
+        'todo' => swimlane_result.todo,
+        'doing' => swimlane_result.doing,
+        'done' => swimlane_result.done
+      }
+    end
+    swimlanes_element
+  end
+
   def trello
     @trello ||= TrelloWrapper.new(@settings)
   end
@@ -113,6 +159,33 @@ class BurndownData
     @fast_lane_cards.done    = board.done_fast_lane_cards_count
     @fast_lane_cards.open    = board.open_fast_lane_cards_count
     @date_time               = DateTime.now
+
+    fetch_swimlanes
+  end
+
+  def fetch_swimlanes
+    @settings.swimlanes.each do |swimlane|
+      board.todo_columns.each do |column|
+        column.cards.each do |card|
+          @swimlanes[swimlane].add_todo(card.story_points) if card.label?(swimlane)
+        end
+      end
+
+      board.doing_columns.each do |column|
+        column.cards.each do |card|
+          @swimlanes[swimlane].add_doing(card.story_points) if card.label?(swimlane)
+        end
+      end
+
+      board.done_column.cards.each do |card|
+        @swimlanes[swimlane].add_done(card.story_points) if card.label?(swimlane)
+      end
+      board.accepted_columns.each do |column|
+        column.cards.each do |card|
+          @swimlanes[swimlane].add_done(card.story_points) if card.label?(swimlane)
+        end
+      end
+    end
   end
 
   private

data/lib/card.rb

@@ -52,10 +52,17 @@ class Card
   end
 
   def card_labels
-    @card_data['labels']
+    @card_data['labels'] || []
+  end
+
+  def label?(label_name)
+    card_labels.any? do |label|
+      label['name'].include?(label_name)
+    end
   end
 
   def checklists
+    return [] unless @card_data['checklists']
     @card_data['checklists'].map do |checklist|
       Checklist.new(checklist)
     end
@@ -84,6 +91,15 @@ class Card
     end
   end
 
+  def swimlane?
+    card_labels.each do |label|
+      @settings.swimlanes.each do |swimlane|
+        return true if label['name'].include?(swimlane)
+      end
+    end
+    false
+  end
+
   def meta_card?
     name =~ SPRINT_NUMBER_REGEX
   end

data/lib/cli.rb

@@ -134,7 +134,7 @@ EOT
   def burndowns
     process_global_options options
     board_list = YAML.load_file(options['board-list'])
-    board_list.keys.each do |name|
+    board_list.each_key do |name|
       raise 'invalid character in team name' if name =~ /[^[:alnum:]. _]/ # sanitize
       board = board_list[name]
       if options['output']

data/lib/column.rb

@@ -50,7 +50,7 @@ class Column
   end
 
   def committed_cards
-    cards.select{|c| !c.extra? && !c.unplanned?}
+    cards.select{|c| !c.extra? && !c.unplanned? && !c.swimlane?}
   end
 
   def fast_lane_cards