trello_lead_time 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a25cde3ef1f75314cce048dcb11f087905d8f9c1
+  data.tar.gz: 616f613d0eb115cf779a7aff107f88186fd33019
+SHA512:
+  metadata.gz: dd7741923539d8c0b86fd10c95c9cd9858e04ad78a7abab39d6d61f9d740e21d921d5c855ba1f558410490fe9c623968b8ef3efaccaeacae9ce8be042df9bc50
+  data.tar.gz: 4ba87e3d671cfb5a6ac9324809ad49c9eab3d83dee0d8e51d5c9eb3fa6d958a74283e52a021df63a39b88cafcd865a9b6a335e55dc3a7bf278ccaf649e0da039

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+run.rb

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+trello_lead_time

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trello_lead_time.gemspec
+gemspec
+gem "rspec"
+gem 'pry'
+gem 'pry-debugger'
+gem 'ruby-trello'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    trello_lead_time (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    method_source (0.8.2)
+    mime-types (2.2)
+    minitest (5.3.2)
+    oauth (0.4.7)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rake (10.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    ruby-trello (1.1.1)
+      activemodel (>= 3.2.0)
+      addressable (~> 2.3)
+      json
+      oauth (~> 0.4.5)
+      rest-client (~> 1.6.7)
+    safe_yaml (1.0.2)
+    slop (3.5.0)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+    webmock (1.17.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  pry
+  pry-debugger
+  rake
+  rspec
+  ruby-trello
+  trello_lead_time!
+  webmock

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scott Baldwin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+trello_lead_time
+=====
+
+Trello is awesome for lightweight task/process management. It's so lightweight that you have to figure out your own way to gather analytics about your process.
+
+*trello_lead_time* is a Ruby gem to calculate the lead time, queue time, and cycle time of cards in a Trello list.
+
+**Queue time** - the time a Trello card spends waiting to be started.
+
+**Cycle time** - the time a Trello card spends in progress.
+
+**Lead time** - the time it takes a Trello card to get started and completed, e.g. queue time + cycle time.
+
+Requirements
+-----
+
+1. Currently, only lists belonging to a Trello organization are supported
+1. Uses the 'ruby-trello' gem (see https://github.com/jeremytregunna/ruby-trello/)
+
+Usage
+-----
+
+Because *trello_lead_time* depends on *ruby-trello*, there is some configuration required.
+
+First, load up the gem in your script.
+
+    require 'trello_lead_time'
+    
+Establish your Trello credentials.
+
+    developer_public_key = 'YOUR TRELLO PUBLIC KEY'
+    member_token         = 'YOUR TRELLO MEMBER TOKEN'
+
+Decide where to find the data. `organization_name` is the URL name that can be used to find your board by URL. You can find this organization name by navigating to your organization's page in Trello. 
+
+The `board_url` is the URL to the actual board. Why do we need the organization name if we have the board's URL? Well, the Trello API doesn't allow us to directly find a board by its URL, so we have to go through the organization. (Finding a board's internal ID to use with the API isn't possible without first using the API to get a list of the boards!)
+
+    organization_name    = 'fogcreek'
+    board_url            = 'https://trello.com/b/nC8QJJoZ/trello-development'
+
+Now, configure how you will calculate the metrics.
+
+`source_lists` is an array of Trello list names (can be open or archived) that contain cards you want to analyze. This gem will compute the lead time, queue time, and cycle time for each of these lists.
+
+`queue_time_lists` is an array of lists that represent the phase of the Trello card's life when it was waiting to start.
+
+`cycle_time_lists` is an array of lists that represent the phase of the Trello card's life when it was actively being worked, or in progress.
+
+    source_lists         = ['Live (4/8)', 'Live (3/17)', 'Live (3/3)', 'Live (2/11)', 'Live (1/14)']
+    queue_time_lists     = ['Next Up']
+    cycle_time_lists     = ['In Progress', 'Testing']
+
+When analyzing the timeline of each Trello card, the gem has to find out when it was moved into a "Done" state. This usually is the event when the card is placed in the one of the `source_lists`, e.g. "Live (4/8)". 
+
+You must provide a regular expression that will be compared to the names of lists a Trello card was in (at some point of its life) to identify when it was marked done.
+
+    list_name_matcher_for_done = /^Live/
+    
+Now that all those variables are set, you can configure the gem!
+
+    TrelloLeadTime.configure do |cfg|
+      cfg.organization_name = organization_name
+      cfg.set_trello_key_and_token(developer_public_key, member_token)
+      cfg.queue_time_lists = queue_time_lists
+      cfg.cycle_time_lists = cycle_time_lists
+      cfg.list_name_matcher_for_done = /^Live/
+    end
+
+Easy right? Now let's put it to use!
+
+    puts "-" * 40
+    puts "Calculating metrics for:"
+    puts "#{board_url}"
+    puts "-" * 40
+
+    board = TrelloLeadTime::Board.from_url board_url
+    source_lists.each do |source_list|
+      puts "Using cards in list: #{source_list}"
+      puts "Average Card Age:    #{TrelloLeadTime::TimeHumanizer.humanize_seconds(board.average_age(source_list))}"
+      puts "Average Lead Time:   #{TrelloLeadTime::TimeHumanizer.humanize_seconds(board.average_lead_time(source_list))}"
+      puts "Average Queue Time:  #{TrelloLeadTime::TimeHumanizer.humanize_seconds(board.average_queue_time(source_list))}"
+      puts "Average Cycle Time:  #{TrelloLeadTime::TimeHumanizer.humanize_seconds(board.average_cycle_time(source_list))}"
+      puts ""
+    end
+
+For each of the source lists, the cards are analyzed and aggregate (average) metrics are displayed. This takes some time because the Trello API must be hit for each card being analyzed. Therefore, the longer the lists in Trello, the longer it takes to process.
+
+See [sample.rb](sample.rb) for an entire listing of the explanation above.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/trello_lead_time.rb

@@ -0,0 +1,10 @@
+require 'trello'
+Dir["#{File.dirname(__FILE__)}/trello_lead_time/**/*.rb"].each { |f| require f }
+
+module TrelloLeadTime
+  extend self
+
+  def configure
+    yield Config
+  end
+end

data/lib/trello_lead_time/action.rb

@@ -0,0 +1,23 @@
+module TrelloLeadTime
+  class Action
+    def self.from_trello_action(trello_action)
+      Action.new(trello_action)
+    end
+
+    def initialize(trello_action)
+      @trello_action = trello_action
+    end
+
+    def type
+      @trello_action.type
+    end
+
+    def data
+      @trello_action.data
+    end
+
+    def date
+      @trello_action.date
+    end
+  end
+end

data/lib/trello_lead_time/board.rb

@@ -0,0 +1,58 @@
+module TrelloLeadTime
+  class Board
+
+    def self.from_url(url)
+      @org = Trello::Organization.find(TrelloLeadTime::Config.organization_name)
+      if @org
+        @boards = @org.boards
+        @board = @boards.detect { |b| b.url == url }
+        return Board.new(@board) if @board
+      end
+      nil
+    end
+
+    def initialize(trello_board)
+      @trello_board = trello_board
+      @_lists = {}
+    end
+
+    def name
+      @trello_board.name
+    end
+
+    def average_age(name_of_list_with_done_cards)
+      list = find_list_by_name(name_of_list_with_done_cards)
+      return 0 if list.nil?
+      list.average_age
+    end
+
+    def average_lead_time(name_of_list_with_done_cards)
+      list = find_list_by_name(name_of_list_with_done_cards)
+      return 0 if list.nil?
+      list.average_lead_time
+    end
+
+    def average_queue_time(name_of_list_with_done_cards)
+      list = find_list_by_name(name_of_list_with_done_cards)
+      return 0 if list.nil?
+      list.average_queue_time
+    end
+
+    def average_cycle_time(name_of_list_with_done_cards)
+      list = find_list_by_name(name_of_list_with_done_cards)
+      return 0 if list.nil?
+      list.average_cycle_time
+    end
+
+    private
+
+    def find_list_by_name(name)
+      if !@_lists.has_key?(name)
+        trello_list = @trello_board.lists({filter: 'all'}).detect { |l| l.name == name }
+        @_lists[name] = TrelloLeadTime::List.from_trello_list(trello_list) if trello_list
+      end
+      @_lists[name]
+    end
+
+  end
+end

data/lib/trello_lead_time/card.rb

@@ -0,0 +1,47 @@
+module TrelloLeadTime
+  class Card
+    def self.from_trello_card(trello_card)
+      Card.new(trello_card)
+    end
+
+    def initialize(trello_card)
+      @trello_card = trello_card
+      @timeline = Timeline.for_trello_card(trello_card)
+    end
+
+    def name
+      @trello_card.name
+    end
+
+    def done?
+      @timeline.done?
+    end
+
+    def closed?
+      @trello_card.closed
+    end
+
+    def age_in_seconds
+      @timeline.age_in_seconds
+    end
+
+    def lead_time
+      @_lead_time ||= queue_time + cycle_time
+    end
+
+    def queue_time
+      @_queue_time ||= sum_of_times_in_lists(Config.queue_time_lists)
+    end
+
+    def cycle_time
+      @_cycle_time ||= sum_of_times_in_lists(Config.cycle_time_lists)
+    end
+
+    private
+
+    def sum_of_times_in_lists(lists)
+      lists.inject(0) { |sum, list_name| sum + @timeline.seconds_in_list(list_name) }
+    end
+
+  end
+end

data/lib/trello_lead_time/config.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+require 'trello'
+
+module TrelloLeadTime
+  module Config
+    extend self
+
+    attr_accessor :organization_name, :queue_time_lists, :cycle_time_lists, :list_name_matcher_for_done
+
+    def configure
+      yield self
+    end
+
+    def set_trello_key_and_token(key, token)
+      Trello.configure do |cfg|
+        cfg.developer_public_key = key
+        cfg.member_token         = token
+      end
+    end
+
+    def queue_time_lists
+      @queue_time_lists = [] if !@queue_time_lists
+      @queue_time_lists
+    end
+
+    def cycle_time_lists
+      @cycle_time_lists = [] if !@cycle_time_lists
+      @cycle_time_lists
+    end
+
+    def list_name_matcher_for_done
+      @list_name_matcher_for_done = /^Done/i if !@list_name_matcher_for_done
+      @list_name_matcher_for_done
+    end
+  end
+end

data/lib/trello_lead_time/list.rb

@@ -0,0 +1,69 @@
+module TrelloLeadTime
+  class List
+    def self.from_trello_list(list)
+      List.new(list)
+    end
+
+    def initialize(list)
+      @trello_list = list
+    end
+
+    def name
+      @trello_list.name
+    end
+
+    def average_age
+      calculate_average_age_of_cards
+    end
+
+    def average_lead_time
+      calculate_average_lead_time_of_cards
+    end
+
+    def average_queue_time
+      calculate_average_queue_time_of_cards
+    end
+
+    def average_cycle_time
+      calculate_average_cycle_time_of_cards
+    end
+
+    private
+
+    def done_or_closed_cards
+      @_done_or_closed_cards ||= cards.select { |c| c.done? || c.closed? }
+    end
+
+    def cards
+      @_cards ||= @trello_list.cards.map { |c| TrelloLeadTime::Card.from_trello_card(c) }
+    end
+
+    def calculate_average_age_of_cards
+      times = done_or_closed_cards.map { |c| c.age_in_seconds }
+      average(times)
+    end
+
+    def calculate_average_lead_time_of_cards
+      times = done_or_closed_cards.map { |c| c.lead_time }
+      average(times)
+    end
+
+    def calculate_average_queue_time_of_cards
+      times = done_or_closed_cards.map { |c| c.queue_time }
+      average(times)
+    end
+
+    def calculate_average_cycle_time_of_cards
+      times = done_or_closed_cards.map { |c| c.cycle_time }
+      average(times)
+    end
+
+    def average(times)
+      avg = 0.0
+      if times.size > 0
+        avg = (times.inject(0.0) { |sum, el| sum + el } / times.size).round(0)
+      end
+      avg
+    end
+  end
+end