tracco 0.0.9

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'bundler'
+require 'tracco'
+
+Bundler::GemHelper.install_tasks
+
+import 'lib/tasks/tasks.rake'
+import 'lib/tasks/rspec.rake'

data/config/config.template.yml

@@ -0,0 +1,6 @@
+trello:
+  developer_public_key: <here put the key taken from https://trello.com/1/appKey/generate>
+  access_token_key: <here put the token taken in the 'Reading Private Data' section from https://trello.com/1/appKey/generate>
+
+tracker_username: <here put the Trello member used as recipient of the tracking notifications>
+google_docs_username: <here put your Google Docs username>

data/config/config.yml.trackinguser_for_test

@@ -0,0 +1,7 @@
+# read-only access to @trackinguser_for_test/testinguser! boards
+trello:
+  developer_public_key: ef7c400e711057d7ba5e00be20139a33
+  access_token_key: 9047d8fdbfdc960d41910673e300516cc8630dd4967e9b418fc27e410516362e
+
+tracker_username: trackinguser_for_test
+google_docs_username: pietro.dibello@xpeppers.com

data/config/mongoid.template.yml

@@ -0,0 +1,24 @@
+development:
+  sessions:
+    default:
+      database: tracco_dev
+      hosts:
+        - localhost:27017
+
+test:
+  sessions:
+    default:
+      database: tracco_test
+      hosts:
+        - localhost:27017
+
+
+production:
+  autocreate_indexes: true
+  persist_in_safe_mode: true
+
+  sessions:
+    default:
+      database: tracco_production
+      hosts:
+        - localhost:27017

data/lib/patches/trello/card.rb

@@ -0,0 +1,19 @@
+module Trello
+
+  class Card
+    # Reopening the Trello::Card class to add a method detecting a card moved in a DONE column
+    def in_done_column?
+      list_name = ""
+      begin
+        list_name = list.name.strip
+      rescue Trello::Error => e
+        Trello::Logger.error("Cannot find column for card #{name}")
+      end
+
+      !!(list_name =~ /^DONE/i)
+    end
+  end
+
+end
+
+

data/lib/patches/trello/member.rb

@@ -0,0 +1,20 @@
+module Trello
+  class Member
+    # Reopening the Trello::Member class to add a notifications helper method
+    def notifications_from(starting_date)
+      notifications(limit:1000).select(&greater_than_or_equal_to(starting_date)).select(&tracking_notification?)
+    end
+    
+    private
+
+    def greater_than_or_equal_to(starting_date)
+      lambda { |notification| Chronic.parse(notification.date) >= starting_date }
+    end
+
+    def tracking_notification?
+      lambda { |notification| notification.type == "mentionedOnCard" }
+    end
+    
+  end
+
+end

data/lib/startup_trello.rb

@@ -0,0 +1,2 @@
+include TrelloAuthorize
+authorize_on_trello

data/lib/tasks/rspec.rake

@@ -0,0 +1,17 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :specs   => :spec
+
+namespace :spec do
+  desc "Run fast specs"
+  RSpec::Core::RakeTask.new(:fast) do |t|
+    t.rspec_opts = '--tag ~needs_valid_configuration'
+  end
+
+  desc "Run slow specs"
+  RSpec::Core::RakeTask.new(:slow) do |t|
+    t.rspec_opts = '--tag needs_valid_configuration'
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,55 @@
+desc "Open an irb session preloaded with this library, e.g. rake 'console[production]' will open a irb session with the production db env"
+task :console, [:db_env] do |t, args|
+  args.with_defaults(db_env: "development")
+  sh "export MONGOID_ENV=#{args.db_env}; irb -rubygems -I lib -r tracco.rb -r startup_trello.rb"
+end
+
+task :c, [:db_env] do |t, args|
+  Rake::Task[:console].invoke(args.db_env)
+end
+
+namespace :run do
+  include TrelloConfiguration
+
+  desc "Run on the cards tracked starting from a given day, e.g. rake 'run:from_day[2012-11-1]'"
+  task :from_day, [:starting_date, :db_env] => [:ensure_environment] do |t, args|
+    args.with_defaults(starting_date: Date.today.to_s, db_env: "development")
+    TrelloConfiguration::Database.load_env(args.db_env)
+
+    tracker = TrelloTracker.new
+    tracker.track(Date.parse(args.starting_date))
+  end
+
+  desc "Run on the cards tracked today, #{Date.today}"
+  task :today, [:db_env] => [:ensure_environment] do |t, args|
+    args.with_defaults(db_env: "development")
+    Rake.application.invoke_task("run:from_day[#{Date.today.to_s}, #{args.db_env}]")
+  end
+end
+
+namespace :export do
+  desc "Export all cards to a google docs spreadsheet, e.g. rake \"export:google_docs[my_sheet,tracking,production]\""
+  task :google_docs, [:spreadsheet, :worksheet, :db_env] => [:ensure_environment] do |t, args|
+    args.with_defaults(db_env: "development")
+    TrelloConfiguration::Database.load_env(args.db_env)
+
+    exporter = GoogleDocsExporter.new(args.spreadsheet, args.worksheet)
+    spreadsheet_url = exporter.export
+
+    puts "[DONE]".color(:green)
+    puts "Go to #{spreadsheet_url}"
+  end
+end
+
+task :ensure_environment do
+  %w{developer_public_key access_token_key}.each do |each_name|
+    unless ENV[each_name] || authorization_params_from_config_file[each_name]
+      puts "ERROR: Missing <#{each_name}> configuration parameter: set it as environment variable or in the config/config.yml file."
+      exit 1
+    end
+  end
+  unless tracker_username
+    puts "ERROR: Missing <tracker_username> configuration parameter: set it as environment variable or in the config/config.yml file."
+    exit 1
+  end
+end

data/lib/tracco.rb

@@ -0,0 +1,30 @@
+require 'trello'
+require 'rainbow'
+require 'set'
+require 'yaml'
+require 'chronic'
+require 'mongoid'
+require 'forwardable'
+
+require 'tracco/mongoid_helper'
+require 'tracco/trello_configuration'
+require 'tracco/trello_authorize'
+require 'tracco/tracked_card'
+require 'tracco/member'
+require 'tracco/estimate'
+require 'tracco/effort'
+require 'tracco/tracking/base'
+require 'tracco/tracking/estimate_tracking'
+require 'tracco/tracking/effort_tracking'
+require 'tracco/tracking/card_done_tracking'
+require 'tracco/tracking/invalid_tracking'
+require 'tracco/tracking_factory'
+require 'tracco/trello_tracker'
+require 'tracco/google_docs_exporter'
+
+require 'patches/trello/member'
+require 'patches/trello/card'
+
+TrelloConfiguration::Database.load_env(ENV['MONGOID_ENV'] || "development", ENV['MONGOID_CONFIG_PATH'])
+
+Trello.logger.level = Logger::DEBUG

data/lib/tracco/effort.rb

@@ -0,0 +1,35 @@
+class Effort
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :amount,  type: BigDecimal
+  field :date,    type: Date
+  field :tracking_notification_id
+
+  embeds_many :members
+  embedded_in :tracked_card
+
+  default_scope asc(:date)
+
+  validates_presence_of :amount, :date, :members
+
+  def amount_per_member
+    amount / members.size
+  end
+
+  def include?(member)
+    members.include?(member)
+  end
+
+  def ==(other)
+    return true if other.equal?(self)
+    return false unless other.kind_of?(self.class)
+
+    amount == other.amount && date == other.date && Set.new(members) == Set.new(other.members)
+  end
+
+  def to_s
+    "[#{date}] spent #{amount} hours by #{members.map(&:at_username).join(", ")}"
+  end
+
+end

data/lib/tracco/estimate.rb

@@ -0,0 +1,25 @@
+class Estimate
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :amount,  type: BigDecimal
+  field :date,    type: Date
+  field :tracking_notification_id
+
+  embedded_in :tracked_card
+
+  default_scope asc(:date)
+
+  validates_presence_of :amount, :date
+
+  def ==(other)
+    return true if other.equal?(self)
+    return false unless other.kind_of?(self.class)
+
+    amount == other.amount && date == other.date
+  end
+
+  def to_s
+    "[#{date}] estimated #{amount} hours"
+  end
+end

data/lib/tracco/google_docs_exporter.rb

@@ -0,0 +1,67 @@
+require "google_drive"
+require 'highline/import'
+
+class GoogleDocsExporter
+  include TrelloConfiguration
+
+  def initialize(spreadsheet_name, worksheet_name)
+    @spreadsheet_name = spreadsheet_name || "trello effort tracking"
+    @worksheet_name   = worksheet_name || "tracking"
+  end
+
+  def export
+    Trello.logger.info "Running exporter from db env '#{db_environment}' to google docs '#{@spreadsheet_name.color(:green)}##{@worksheet_name.color(:green)}'..."
+
+    spreadsheet = google_docs_session.spreadsheet_by_title(@spreadsheet_name) || google_docs_session.create_spreadsheet(@spreadsheet_name)
+    worksheet = spreadsheet.worksheet_by_title(@worksheet_name) || spreadsheet.add_worksheet(@worksheet_name)
+
+    create_header(worksheet)
+    index = 2 # skip the header
+
+    cards = TrackedCard.all.reject(&:no_tracking?).sort_by(&:first_activity_date).reverse
+    cards.each do |card|
+      print ".".color(:green)
+      worksheet[index, columns[:user_story_id]] = card.short_id
+      worksheet[index, columns[:user_story_name]] = card.name
+      worksheet[index, columns[:start_date]] = card.working_start_date
+      worksheet[index, columns[:total_effort]] = card.total_effort
+      worksheet[index, columns[:last_estimate_error]] = card.last_estimate_error
+      card.estimates.each_with_index do |estimate, i|
+        worksheet[index, columns[:estimate]+i] = estimate.amount
+      end
+      index += 1
+    end
+
+    saved = worksheet.save
+    spreadsheet.human_url if saved
+  end
+
+  private
+
+  def google_docs_session(email=configuration["google_docs_username"])
+    @session ||= login(email)
+  end
+
+  def login(email)
+    username = ask("Enter your google docs username: ") { |q| q.default = email }
+    password = ask("Enter your google docs password: ") { |q| q.echo = false }
+
+    GoogleDrive.login(username, password)
+  end
+
+  def columns
+    @columns ||= {
+      user_story_id:        1,
+      user_story_name:      2,
+      start_date:           3,
+      total_effort:         4,
+      last_estimate_error:  5,
+      estimate:             6,
+    }
+  end
+
+  def create_header(worksheet)
+    worksheet.update_cells(1,1, [["ID", "Story Name", "Start Date", "Total Effort (hours)", "Last estimate error (%)", "First Estimate", "2nd estimate", "3rd estimate"]])
+  end
+
+end

data/lib/tracco/member.rb

@@ -0,0 +1,61 @@
+class Member
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :trello_id
+  field :username
+  field :full_name
+  field :avatar_id
+  field :bio
+  field :url
+
+  embedded_in :effort
+
+  validates_presence_of :username
+
+  def self.build_from(trello_member)
+    trello_member_id = trello_member.id
+    trello_member.attributes.delete(:id)
+    new(trello_member.attributes.merge(trello_id: trello_member_id))
+  end
+
+  def at_username
+    "@#{username}"
+  end
+
+  def avatar_url
+    trello_member.avatar_url(size: :small)
+  end
+
+  def effort_spent(from_date=nil)
+    cards = TrackedCard.where("efforts.members.username" => username)
+    efforts = cards.map(&:efforts).compact.flatten
+    efforts = efforts.select {|e| e.date >= from_date} if from_date
+    efforts.select { |effort| effort.include?(self) }.inject(0) { |total, effort| total + effort.amount_per_member }
+  end
+  alias_method :effort_spent_since, :effort_spent
+
+  def ==(other)
+    return true if other.equal?(self)
+    return false unless other.kind_of?(self.class)
+
+    username == other.username
+  end
+
+  def eql?(other)
+    return false unless other.instance_of?(self.class)
+    username == other.username
+  end
+
+  def hash
+    username.hash
+  end
+
+  private
+
+  def trello_member
+    @trello_member ||= Trello::Member.new("id" => trello_id, "fullName" => full_name, "username" => username,
+                                           "avatarHash" => avatar_id, "bio" => bio, "url" => url)
+  end
+
+end

data/lib/tracco/mongoid_helper.rb

@@ -0,0 +1,13 @@
+module MongoidHelper
+  
+  def without_mongo_raising_errors(&block)
+    original_value = Mongoid.raise_not_found_error
+    Mongoid.raise_not_found_error = false
+    begin
+      block.call if block
+    ensure
+      Mongoid.raise_not_found_error = original_value
+    end
+  end
+  
+end

data/lib/tracco/tracked_card.rb

@@ -0,0 +1,121 @@
+class TrackedCard
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  extend MongoidHelper
+
+  field :name
+  field :description
+  field :short_id,    type: Integer
+  field :trello_id
+  field :done,        type: Boolean
+  field :due,         type: Date
+  field :closed,      type: Boolean
+  field :url
+  field :pos
+
+  embeds_many :estimates
+  embeds_many :efforts
+
+  validates_presence_of :name, :short_id, :trello_id
+  validates_numericality_of :short_id
+
+  def self.find_by_trello_id(trello_id)
+    without_mongo_raising_errors do
+      find_by(trello_id: trello_id)
+    end
+  end
+
+  def self.update_or_create_with(trello_card)
+    tracked_card = find_or_create_by(trello_id: trello_card.id)
+    trello_card.attributes.delete(:id)
+    tracked_card_attributes = trello_card.attributes.merge(done: trello_card.in_done_column?)
+    updated_successfully = tracked_card.update_attributes(tracked_card_attributes)
+    return tracked_card if updated_successfully
+  end
+
+  def status
+    if done?
+      :done
+    elsif efforts.empty?
+      :todo
+    else
+      :in_progress
+    end
+  end
+
+  def self.build_from(trello_card)
+    trello_card_id = trello_card.id
+    trello_card.attributes.delete(:id)
+    new(trello_card.attributes.merge(trello_id: trello_card_id))
+  end
+
+  def add(tracking)
+    tracking.add_to(self)
+  end
+
+  def add!(tracking)
+    add(tracking) && save!
+  end
+
+  def contains_effort?(effort)
+    efforts.any? { |e| e.tracking_notification_id == effort.tracking_notification_id }
+  end
+
+  def contains_estimate?(estimate)
+    estimates.any? { |e| e.tracking_notification_id == estimate.tracking_notification_id }
+  end
+
+  def no_tracking?
+    first_activity_date.nil?
+  end
+
+  def first_activity_date
+    [working_start_date, first_estimate_date].compact.min
+  end
+
+  def working_start_date
+    efforts.sort_by(&:date).first.date if efforts.present?
+  end
+
+  def first_estimate_date
+    estimates.sort_by(&:date).first.date if estimates.present?
+  end
+
+  def last_estimate_date
+    estimates.sort_by(&:date).last.date if estimates.present?
+  end
+
+  def total_effort
+    efforts.map(&:amount).inject(0, &:+)
+  end
+
+  def members
+    efforts.map(&:members).flatten.uniq
+  end
+
+  def last_estimate_error
+    estimate_errors.last
+  end
+
+  def estimate_errors
+    return [] if estimates.empty? || efforts.empty?
+
+    estimate_errors = []
+    estimates.each do |each|
+      estimate_errors << (100 * ((total_effort - each.amount) / each.amount * 1.0)).round(2)
+    end
+
+    estimate_errors
+  end
+
+  def to_s
+    "[#{name}]. Total effort: #{total_effort}h. Estimates #{estimates.map(&:to_s)}. Efforts: #{efforts.map(&:to_s)}"
+  end
+
+  def ==(other)
+    return true if other.equal?(self)
+    return false unless other.kind_of?(self.class)
+    trello_id == other.trello_id
+  end
+
+end