trollolo 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1b0bc626175dfcdffe5dffa8942ec7469797ec4
-  data.tar.gz: a8feeb3163223a858044f9d2c9be8bb66e350699
+  metadata.gz: edecf120a728ec76d245cb2e64669fd8c075e34c
+  data.tar.gz: ada5a9fc6e5691786b28297662fdf8f7f5d42f83
 SHA512:
-  metadata.gz: cf9922a6a5d5ec348be19bde09f391115f6022e1fb0e2a2fc5b5f0c83cae7ee1b3de95037d3964b0fcbb54db1fb16c106a0f85df118f0928aed9f8f1424b7286
-  data.tar.gz: f5345fe994f6db7343aece171c5e57782264f493c454e742aba148f6e58c8d111eb714986ec3f2b2aa99d8bfd3c968b4644f2b16adb67a060b1ece658effa1f7
+  metadata.gz: e9365f00bb685300806a0663cc84d075fcb92cea09eba9e04acfd328aa21a82e8ebe694db6c3d0ef731b3f6971a3d0698af7bc70cdf538116a9adad841716eba
+  data.tar.gz: 170c8a25882e6ee7f70fdfa634a7e7b75ac7e4f2d573b830556f8d3428afbe88b5dcb1d468302489fadb0cdda4478070d3021ab73517a29c476eed55214f0a5c

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Trollolo Changelog
 
+## Version 0.0.10
+
+* Rename `sprint-cleanup` to `cleanup-sprint`.
+* Configure board, list and label names to trollolorc. The commands
+  `cleanup-sprint`, `move-backlog`, `set-priorities` and `setup-scrum` will use
+  these names. You will still need to provide board IDs, or their aliases, as
+  several boards can share the same name.
+* Add `setup-scrum` command to create all necessary elements of our scrumb board
+  as configured in trollolorc or using the defaults. A sample configuration can
+  be found in `spec/data/trollolorc`. Fixes #57
+* Add option for backlog list name in `set-priorities`.
+* Add `move-backlog` command for moving a backlog from a planning to a sprint board
+* Handle boards which have an "Accepted" column in addition to a "Done" column
+
 ## Version 0.0.9
 
 * Add `sprint-cleanup` command to move cards back from the sprint board to the

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter'
+  gem 'codeclimate-test-reporter', '>= 1.0.0'
   gem 'rspec', '~> 3.5'
   gem 'cli_tester'
   gem 'webmock'

data/README.md

@@ -57,6 +57,24 @@ To create a member token for the `set-priority` command use this URL instead:
 
 The board id is the cryptic string in the URL of your board.
 
+The `.trollolorc` file can also be used to set aliases for board ids. When set,
+you will be able to use the alias instead of the board-id in the various
+commands. E.g.
+
+With the following configuration
+
+```
+board_aliases:
+  MyTrelloBoard: 53186e8391ef8671265ebf9e
+
+```
+
+You can issue the command:
+
+```
+  trollolo get-cards --board-id=MyTrelloBoard
+```
+
 ## Creating burndown charts
 
 Trollolo implements a simple work flow for creating burndown charts from the
@@ -129,3 +147,82 @@ Some more info can be found in the command line help with `trollolo help` and
 ### Example
 
 ![Burndown example](https://raw.githubusercontent.com/openSUSE/trollolo/master/examples/burndown-26.png)
+
+## Other SCRUM commands
+
+Trollolo supports SCRUM on Trello by using one board for the sprint and another one for planning.
+On these boards several lists are used to organize stories.
+
+The `setup-scrum` command creates the necessary elements. The names are taken from the configuration.
+If you change the names in Trello, you need to update theconfiguration in `trollolorc`.
+
+At the end of a sprint, after the review meeting, remaining cards can be moved back to the planning
+board with `cleanup-sprint`.
+Once the sprint backlog is ready, priorities can be added to the card titles with `prioritize`.
+Move the planning backlog to the sprint board with `move-backlog`.
+
+### Labels
+
+* `sticky`: used to mark cards which are not moved, like the goal card
+* `waterline`: for cards which are under the waterline
+
+### Lists
+
+* `sprint_backlog`: this list contains the stories of the current sprint
+* `sprint_qa`: any cards in the current sprint which need QA
+* `sprint_doing`: cards currently being worked on
+* `planning_backlog`: used to plan the next sprint, these cards will be prioritized
+* `planning_ready`: contains cards which are not yet estimated and therefore not in the backlog
+
+### Default Configuration
+
+These are the default names, add this to `trollolorc` and change as necessary.
+
+    scrum:
+      board_names:
+        planning: Planning Board
+        sprint: Sprint Board
+      label_names:
+        sticky: Sticky
+        waterline: Waterline
+      list_names:
+        sprint_backlog: Sprint Backlog
+        sprint_qa: QA
+        sprint_doing: Doing
+        planning_backlog: Backlog
+        planning_ready: Ready for Estimation
+
+The board names are not used to find the boards on trello.
+Since several boards can share the same name, they are only used when creating the SCRUM setup.
+
+### Examples
+
+Create the boards and lists:
+
+    trollolo setup-scrum
+
+Lookup the ID of the created boards and use them as arguments:
+
+    # https://trello.com/b/123abC/sprint-board
+    # https://trello.com/b/GHi456/planning-board
+
+    trollolo cleanup-sprint --board-id=123abC --target-board-id=GHi456
+    trollolo set-priorities --board-id=GHi456
+    trollolo move-backlog --planning-board-id=GHi456 --sprint-board-id=123abC
+
+You can use aliases, as described in the configuration section, instead of IDs.
+
+## Updating VCR specs
+
+Some specs use VCR to reply with stored Trello API replies. The specs are annotated with `vcr:` and `vcr_record:`. To
+re-record the stored replies, set `vcr_record:` to true and replace `dummy_settings` with `real_settings`.
+
+    describe Scrum::BacklogMover do
+      subject { described_class.new(real_settings) }
+
+      it "fails without moving if backlog list is missing waterline or seabed", vcr: "move_backlog_missing_waterbed", vcr_record: true do
+        expect { subject.move("neUHHzDo", "NzGCbEeN") }.to raise_error
+      end
+    end
+
+The VCR support methods will replace your Trello token and key with dummy values, before saving the replies.

data/lib/card.rb

@@ -18,7 +18,6 @@
 class Card
   # Assuming we have card titles as follows '(8) This is the card name'
   ESTIMATED_REGEX     = /\(([\d.]+)\)/
-  PRIORITY_REGEX      = /^(?:\([\d.]+\) )?P(\d+): /
   SPRINT_NUMBER_REGEX = /\ASprint (\d+)/
 
   def initialize(board_data, card_id)
@@ -43,19 +42,6 @@ class Card
     name.match(ESTIMATED_REGEX).captures.first.to_f
   end
 
-  def priority
-    return unless m = name.match(PRIORITY_REGEX)
-    m.captures.first.to_i
-  end
-
-  def priority=(n)
-    if priority
-      @card_data["name"].sub!(/P\d+: /, "P#{n}: ")
-    else
-      @card_data["name"] = "P#{n}: #{name}"
-    end
-  end
-
   def done_tasks
     count = 0
     @card_data["checklists"].each do |checklist|

data/lib/cli.rb

@@ -74,7 +74,7 @@ EOT
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(options["board-id"])
+    board = trello.board(board_id(options["board-id"]))
     lists = board.columns
 
     if @@settings.raw
@@ -93,7 +93,7 @@ EOT
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(options["board-id"])
+    board = trello.board(board_id(options["board-id"]))
     cards = board.cards
 
     if @@settings.raw
@@ -118,7 +118,7 @@ EOT
     require_trello_credentials
 
     trello = TrelloWrapper.new(@@settings)
-    board = trello.board(options["board-id"])
+    board = trello.board(board_id(options["board-id"]))
     board.cards.each do |card|
       card.checklists.each do |checklist|
         puts checklist.name
@@ -160,7 +160,7 @@ EOT
 
     chart = BurndownChart.new @@settings
     puts "Preparing directory..."
-    chart.setup(options[:output],options["board-id"])
+    chart.setup(options[:output],board_id(options["board-id"]))
   end
 
   desc "burndown", "Update burndown chart"
@@ -203,7 +203,7 @@ EOT
     require_trello_credentials
 
     b = Backup.new @@settings
-    b.backup(options["board-id"])
+    b.backup(board_id(options["board-id"]))
   end
 
   desc "list-backups", "List all backups"
@@ -219,7 +219,7 @@ EOT
   option "show-descriptions", :desc => "Show descriptions of cards", :required => false, :type => :boolean
   def show_backup
     b = Backup.new @@settings
-    b.show(options["board-id"], options)
+    b.show(board_id(options["board-id"]), options)
   end
 
   desc "organization", "Show organization info"
@@ -293,21 +293,6 @@ EOT
     trello.make_cover(options["card-id"], filename)
   end
 
-  desc "set-priorities", "Set priority text into card titles"
-  long_desc <<EOT
-  Add 'P<n>: ' to the beginning of every cards title, replace where
-  already present. n is the current position of the list on the card.
-EOT
-  option "board-id", :desc => "Id of the board", :required => true
-  option "list-name", :desc => "Name of the list", :required => true
-  def set_priorities
-    process_global_options options
-    require_trello_credentials
-
-    p = Prioritizer.new(@@settings)
-    p.prioritize(options["board-id"], options["list-name"])
-  end
-
   desc "list-member-boards", "List name and id of all boards"
   option "member-id", :desc => "Id of the member", :required => true
   def list_member_boards
@@ -322,19 +307,66 @@ EOT
     }
   end
 
-  desc "sprint-cleanup", "Move remaining cards to backlog"
+  desc "setup-scrum", "Create necessary elements of our SCRUM setup"
+  long_desc <<-EOT
+  Will create board, lists and labels with names as configured in trollolorc,
+  or use the defaults.
+  EOT
+  def setup_scrum
+    process_global_options options
+    require_trello_credentials
+
+    c = Scrum::Creator.new(@@settings)
+    c.create
+  end
+
+  desc "set-priorities", "Set priority text into card titles"
+  long_desc <<EOT
+  Add 'P<n>: ' to the beginning of every cards title in the 'Backlog' list,
+  replace where already present. n is the current position of the list on
+  the card.
+EOT
+  option "board-id", :desc => "Id of the board", :required => true
+  option "backlog-list-name", :desc => "Name of backlog list", :required => false
+  def set_priorities
+    process_global_options options
+    require_trello_credentials
+
+    p = Scrum::Prioritizer.new(@@settings)
+    p.prioritize(board_id(options["board-id"]), options["backlog-list-name"])
+  end
+
+  desc "cleanup-sprint", "Move remaining cards to the planning board"
   long_desc <<EOT
-  After the sprint, move remaining cards from 'Sprint Backlog' and 'Doing'
-  back to the planning board into the 'Ready' list.
+  After the sprint, move remaining cards from 'Sprint Backlog', 'Doing'
+  and 'QA' lists back to the planning board into the 'Ready' list.
 EOT
   option "board-id", :desc => "Id of the board", :required => true
   option "target-board-id", :desc => "Id of the target board", :required => true
-  def sprint_cleanup
+  def cleanup_sprint
+    process_global_options options
+    require_trello_credentials
+
+    s = Scrum::SprintCleaner.new(@@settings)
+    s.cleanup(board_id(options["board-id"]),
+              board_id(options["target-board-id"]))
+  end
+
+  desc "move-backlog", "Move the planning backlog to the sprint board"
+  long_desc <<-EOT
+  Two separate boards are used, a planning board and a sprint board for the
+  current sprint.
+  After each planning meeting the cards are moved from the planning boards
+  'Backlog' list to the sprint boards 'Sprint Backlog' list.
+  EOT
+  option "planning-board-id", desc: "Id of the planning board", required: true
+  option "sprint-board-id", desc: "Id of the sprint board", required: true
+  def move_backlog
     process_global_options options
     require_trello_credentials
 
-    s = SprintCleanup.new(@@settings)
-    s.cleanup(options["board-id"], options["target-board-id"])
+    m = Scrum::BacklogMover.new(@@settings)
+    m.move(board_id(options["planning-board-id"]), board_id(options["sprint-board-id"]))
   end
 
   private
@@ -368,4 +400,11 @@ EOT
       exit 1
     end
   end
+
+  # Returns the board_id using id_or_alias. If id_or_alias matches a mapping
+  # from trollolorc then the mapped id is returned or else the id_or_alias
+  # is returned.
+  def board_id(id_or_alias)
+    @@settings.board_aliases[id_or_alias] || id_or_alias
+  end
 end

data/lib/empty_column.rb

@@ -0,0 +1,5 @@
+class EmptyColumn < Column
+  def initialize
+    super({"lists" => [], "cards" => []}, nil)
+  end
+end

data/lib/scrum/backlog_mover.rb

@@ -0,0 +1,47 @@
+module Scrum
+  class BacklogMover < TrelloService
+    include ScrumBoards
+
+    def move(planning_board_id, sprint_board_id)
+      setup(planning_board_id, sprint_board_id)
+      inspect_backlog
+      @sprint_board.place_seabed(@seabed_card)
+    end
+
+    private
+
+    def setup(planning_board_id, sprint_board_id)
+      @sprint_board = sprint_board(sprint_board_id)
+      fail "sprint board is missing #{@sprint_board.backlog_list_name} list" unless @sprint_board.backlog_list
+
+      @planning_board = planning_board(planning_board_id)
+      fail "backlog list not found on planning board" unless @planning_board.backlog_list
+
+      @waterline_card = @planning_board.waterline_card
+      fail "backlog list on planning board is missing waterline or seabed card"  unless @waterline_card
+
+      @seabed_card = @planning_board.seabed_card
+      fail "backlog list on planning board is missing waterline or seabed card"  unless @seabed_card
+    end
+
+    def inspect_backlog
+      @planning_board.backlog_cards.each do |card|
+        if card == @seabed_card
+          break
+
+        elsif card == @waterline_card
+          @sprint_board.place_waterline(@waterline_card)
+          puts "under the waterline"
+
+        else
+          move_sprint_card(card) unless @planning_board.sticky?(card)
+        end
+      end
+    end
+
+    def move_sprint_card(card)
+      puts %(moving card "#{card.name}")
+      @sprint_board.receive(card)
+    end
+  end
+end

data/lib/scrum/card_type_detection.rb

@@ -0,0 +1,23 @@
+module Scrum
+  module CardTypeDetection
+    def sticky?(card)
+      card.labels.any? { |l| l.name == @settings.label_names["sticky"] }
+    end
+
+    def waterline?(card)
+      card.name =~ /w.?a.?t.?e.?r.?l.?i.?n.?e/i
+    end
+
+    def seabed?(card)
+      card.name =~ /s.?e.?a.?b.?e.?d/i
+    end
+
+    def waterline_card
+      @backlog_list.cards.find { |card| waterline?(card) }
+    end
+
+    def seabed_card
+      @backlog_list.cards.find { |card| seabed?(card) }
+    end
+  end
+end

data/lib/scrum/creator.rb

@@ -0,0 +1,30 @@
+module Scrum
+  class Creator < TrelloService
+    def create
+      @scrum = @settings.scrum
+      create_sprint_board
+      create_planning_board
+    end
+
+    private
+
+    def create_labels(board_id)
+      @scrum.label_names.each { |_, name| Trello::Label.create(name: name, board_id: board_id) }
+    end
+
+    def create_sprint_board
+      board = Trello::Board.create(name: @scrum.board_names["sprint"])
+      Trello::List.create(board_id: board.id, name: @scrum.list_names["sprint_backlog"])
+      Trello::List.create(board_id: board.id, name: @scrum.list_names["sprint_qa"])
+      Trello::List.create(board_id: board.id, name: @scrum.list_names["sprint_doing"])
+      create_labels(board.id)
+    end
+
+    def create_planning_board
+      board = Trello::Board.create(name: @scrum.board_names["planning"])
+      Trello::List.create(board_id: board.id, name: @scrum.list_names["planning_backlog"])
+      Trello::List.create(board_id: board.id, name: @scrum.list_names["planning_ready"])
+      create_labels(board.id)
+    end
+  end
+end

data/lib/scrum/prioritizer.rb

@@ -0,0 +1,24 @@
+module Scrum
+  class Prioritizer < TrelloService
+    include ScrumBoards
+
+    def prioritize(board_id, list_name = nil)
+      @board = planning_board(board_id, list_name)
+      fail "list named '#{@board.backlog_list_name}' not found on board" unless @board.backlog_list
+      update_priorities
+    end
+
+    private
+
+    def update_priorities
+      n = 1
+      @board.backlog_cards.each do |card|
+        next if @board.sticky?(card) || @board.waterline?(card)
+        puts %(set priority to #{n} for "#{card.name}")
+        card.name = PriorityName.build(card.name, n)
+        card.save
+        n += 1
+      end
+    end
+  end
+end

data/lib/scrum/priority_name.rb

@@ -0,0 +1,15 @@
+module Scrum
+  class PriorityName
+    PRIORITY_REGEX      = /^(?:\([\d.]+\) )?P(\d+): /
+
+    def self.priority(name)
+      return unless m = name.match(PRIORITY_REGEX)
+      m.captures.first.to_i
+    end
+
+    def self.build(name, n)
+      return name.sub(/P\d+: /, "P#{n}: ") if priority(name)
+      "P#{n}: #{name}"
+    end
+  end
+end

data/lib/scrum/scrum_boards.rb

@@ -0,0 +1,11 @@
+module Scrum
+  module ScrumBoards
+    def sprint_board(board_id)
+      Scrum::SprintBoard.new(@settings.scrum).setup(board_id)
+    end
+
+    def planning_board(board_id, list_name = nil)
+      Scrum::SprintPlanningBoard.new(@settings.scrum).setup(board_id, list_name)
+    end
+  end
+end

data/lib/scrum/sprint_board.rb

@@ -0,0 +1,82 @@
+module Scrum
+  class SprintBoard
+    include CardTypeDetection
+
+    def initialize(settings)
+      @under_waterline = false
+      @settings = settings
+    end
+    attr_reader :backlog_list
+
+    def setup(id)
+      @board, @backlog_list = TrelloService.find_list(id, backlog_list_name)
+      self
+    end
+
+    def backlog_list_name
+      @settings.list_names["sprint_backlog"]
+    end
+
+    def doing_list
+      @doing_list ||= @board.lists.find { |l| l.name == doing_list_name }
+    end
+
+    def qa_list
+      @qa_list ||= @board.lists.find { |l| l.name == qa_list_name }
+    end
+
+    def receive(card)
+      card.move_to_board(@board, @backlog_list)
+      add_waterline_label(card) if @under_waterline
+    end
+
+    def place_waterline(planning_waterline_card)
+      place_card_at_bottom(waterline_card, planning_waterline_card)
+      @under_waterline = true
+    end
+
+    def place_seabed(planning_seabed_card)
+      place_card_at_bottom(seabed_card, planning_seabed_card)
+    end
+
+    def find_waterline_label(labels)
+      labels.find do |label|
+        label.name == waterline_label_name ||
+          label.name =~ /waterline/i
+      end
+    end
+
+    private
+
+    def under_waterline_label
+      @label ||= find_waterline_label(@board.labels)
+      @label ||= Trello::Label.create(name: waterline_label_name)
+    end
+
+    def add_waterline_label(original_card)
+      new_card = @backlog_list.cards.find { |card| card.name == original_card.name }
+      new_card.card_labels << under_waterline_label
+    end
+
+    def place_card_at_bottom(existing_card, planning_card)
+      if existing_card
+        existing_card.pos = 'bottom'
+        existing_card.save
+      else
+        planning_card.move_to_board(@board, @backlog_list)
+      end
+    end
+
+    def waterline_label_name
+      @settings.label_names["waterline"]
+    end
+
+    def qa_list_name
+      @settings.list_names["sprint_qa"]
+    end
+
+    def doing_list_name
+      @settings.list_names["sprint_doing"]
+    end
+  end
+end

data/lib/scrum/sprint_cleaner.rb

@@ -0,0 +1,41 @@
+module Scrum
+  class SprintCleaner < TrelloService
+    include ScrumBoards
+
+    def cleanup(board_id, target_board_id)
+      @board = sprint_board(board_id)
+      fail "backlog list '#{@board.backlog_list_name}' not found on sprint board" unless @board.backlog_list
+      @target_board = Trello::Board.find(target_board_id)
+      fail "ready list '#{@settings.scrum.list_names["planning_ready"]}' not found on planning board" unless target_list
+
+      move_cards(@board.backlog_list)
+      move_cards(@board.doing_list) if @board.doing_list
+      move_cards(@board.qa_list) if @board.qa_list
+    end
+
+    private
+
+    def target_list
+      @target_list ||= @target_board.lists.find { |l| l.name == @settings.scrum.list_names["planning_ready"] }
+    end
+
+    def waterline_label(card)
+      @board.find_waterline_label(card.labels)
+    end
+
+    def remove_waterline_label(card)
+      label = waterline_label(card)
+      card.remove_label(label) if label
+    end
+
+    def move_cards(source_list)
+      source_list.cards.each do |card|
+        next if @board.sticky?(card)
+        puts %(moving card "#{card.name}" to list "#{target_list.name}")
+        card.members.each { |member| card.remove_member(member) }
+        remove_waterline_label(card)
+        card.move_to_board(@target_board, target_list)
+      end
+    end
+  end
+end

data/lib/scrum/sprint_planning_board.rb

@@ -0,0 +1,26 @@
+module Scrum
+  class SprintPlanningBoard
+    include CardTypeDetection
+
+    attr_reader :backlog_list_name
+
+    def initialize(settings)
+      @settings = settings
+      @backlog_list_name = settings.list_names["planning_backlog"]
+    end
+
+    attr_accessor :backlog_list
+
+    def setup(id, list_name = nil)
+      if list_name
+        @backlog_list_name = list_name
+      end
+      @board, @backlog_list = TrelloService.find_list(id, @backlog_list_name)
+      self
+    end
+
+    def backlog_cards
+      @backlog_list.cards
+    end
+  end
+end

data/lib/scrum.rb

@@ -0,0 +1,13 @@
+module Scrum
+end
+
+require_relative 'scrum/card_type_detection'
+require_relative 'scrum/sprint_board'
+require_relative 'scrum/sprint_planning_board'
+require_relative 'scrum/scrum_boards'
+
+require_relative 'scrum/priority_name'
+require_relative 'scrum/prioritizer'
+require_relative 'scrum/sprint_cleaner'
+require_relative 'scrum/backlog_mover'
+require_relative 'scrum/creator'