tracco 0.0.9

data/spec/integration/trello_tracker_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe TrelloTracker do
+  # This integration test works on a real Trello board created just for this purpose
+  # (see https://trello.com/board/testingboard/50ff225c7162123e3600074f)
+  # The board has some cards in todo, one card in progress and one done
+
+  TODO_CARD_ID        =   "51062b71df2bfec47b0039fb"
+  IN_PROGRESS_CARD_ID =   "51062b99d81a343121004046"
+  DONE_CARD_ID        =  "51062b936d2deed22100157e"
+  ANOTHER_DONE_CARD_ID = "510c46d7c7bc9ac6020007ab"
+
+  let(:config) {
+    # auth params for trackinguser_for_test/testinguser!
+    OpenStruct.new(tracker:  "trackinguser_for_test",
+                   dev_key:  "ef7c400e711057d7ba5e00be20139a33",
+                   token:    "9047d8fdbfdc960d41910673e300516cc8630dd4967e9b418fc27e410516362e")
+  }
+
+  it "tracks some estimates and efforts", :needs_valid_configuration => true do
+    without_logging do
+      tracker = TrelloTracker.new(tracker_username: config.tracker, developer_public_key: config.dev_key, access_token_key: config.token)
+      tracker.track(DateTime.parse("2013-01-28"))
+    end
+
+    # a card to do
+    todo_card = TrackedCard.find_by_trello_id(TODO_CARD_ID)
+
+    todo_card.estimates.should have(1).estimate
+    todo_card.estimates.first.amount.should == 4
+    todo_card.should_not be_done
+
+    # a card in progress
+    in_progress_card = TrackedCard.find_by_trello_id(IN_PROGRESS_CARD_ID)
+
+    in_progress_card.estimates.should have(1).estimate
+    in_progress_card.estimates.should have(1).effort
+    in_progress_card.estimates.first.amount.should == 5
+    in_progress_card.efforts.first.amount.should == 1
+    in_progress_card.should_not be_done
+
+    # a done card
+    done_card = TrackedCard.find_by_trello_id(DONE_CARD_ID)
+    done_card.total_effort.should == 2
+    done_card.should be_done
+
+    # another done card (this time for the DONE column)
+    another_done_card = TrackedCard.find_by_trello_id(ANOTHER_DONE_CARD_ID)
+    another_done_card.should be_done
+  end
+
+
+  private
+
+  def without_logging(&block)
+    original_error_level = Trello.logger.level
+
+    begin
+      Trello.logger.level = Logger::WARN
+      block.call unless block.nil?
+    ensure
+      Trello.logger.level = original_error_level
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+describe Member do
+
+  it { should have_fields(:trello_id, :username, :full_name, :avatar_id, :bio, :url) }
+  it { should be_embedded_in(:effort) }
+
+  describe "validation" do
+    it { should validate_presence_of(:username) }
+  end
+
+  describe "equality" do
+    it "is equal to another member with the same username" do
+      member            = Member.new(username: "piero")
+      same_member       = Member.new(username: "piero")
+      different_member  = Member.new(username: "tommaso")
+
+      member.should == same_member
+      member.should_not == different_member
+    end
+  end
+
+  describe ".build_from" do
+    it "builds a Member from a Trello Member" do
+      member = Member.build_from(Trello::Member.new("username" => "piero"))
+
+      member.username.should == "piero"
+    end
+
+    it "takes the Trello Member id and set it as trello_id" do
+      member = Member.build_from(Trello::Member.new("username" => "piero", "id" => "1234567abc"))
+
+      member.id.should_not    == "1234567abc"
+      member.trello_id.should == "1234567abc"
+    end
+  end
+
+  describe "#effort_spent" do
+    %w{piero tommaso}.each do |username|
+      let(username.to_sym) { Member.new(username: username) }
+    end
+
+    let(:card)         { TrackedCard.create(name: "any", short_id: 1234, trello_id: "123123") }
+    let(:another_card) { TrackedCard.create(name: "any_other", short_id: 1235, trello_id: "123125") }
+
+    it "is zero when the member did not spent effort at all" do
+      piero.effort_spent.should == 0
+    end
+
+    it "counts the effort spent on a card" do
+      card.efforts << Effort.new(amount: 4, date: Date.today, members: [piero, tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      piero.effort_spent.should == 4 / 2
+    end
+
+    it "counts the effort spent on several cards" do
+      card.efforts << Effort.new(amount: 4, date: Date.today, members: [piero, tommaso])
+      another_card.efforts << Effort.new(amount: 5, date: Date.today, members: [piero])
+
+      piero.effort_spent.should == 2 + 5
+    end
+
+    it "counts the effort spent on a card from a given date" do
+      card.efforts << Effort.new(amount: 4, date: Date.yesterday, members: [piero])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [piero])
+
+      piero.effort_spent(Date.today).should == 5
+      piero.effort_spent_since(Date.today).should == 5
+    end
+
+  end
+
+  describe "#avatar_url" do
+    it "points to the avatar thumbnail image" do
+      member = Member.new(avatar_id: "123xyz")
+      member.avatar_url.should == "https://trello-avatars.s3.amazonaws.com/123xyz/30.png"
+    end
+  end
+end

data/spec/patches/trello/card_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Trello::Card do
+
+  describe "#in_done_column?" do
+    
+    let(:trello_card) { Trello::Card.new("name" => "a name", "desc" => "any description") }
+
+    let(:todo_column) { Trello::List.new("name" => "ToDo") }
+    let(:done_column) { Trello::List.new("name" => "Done yesterday") }
+
+    it "is done when is in a DONE column" do
+      trello_card.stub(:list).and_return(done_column)
+
+      trello_card.in_done_column?.should be_true
+    end
+
+    it "is still not done when is not in DONE column" do
+      trello_card.stub(:list).and_return(todo_column)
+
+      trello_card.in_done_column?.should be_false
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+
+require 'simplecov'
+SimpleCov.start
+
+# Set up gems listed in the Gemfile.
+begin
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end
+
+Bundler.require(:spec)
+
+require 'tracco'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |configuration|
+  configuration.include Mongoid::Matchers
+end
+
+# force test env for the mongodb configuration
+TrelloConfiguration::Database.load_env("test")
+
+
+## Spec Helper Methods (TODO: should we move them in a separate file?)
+
+def unrecognized_notification
+  create_notification(data: { 'text' => '@trackinguser hi there!' })
+end
+
+def notification_with_message(message)
+  create_notification(data: { 'text' => message })
+end
+
+def create_estimate(time_measurement)
+  create_notification(data: { 'text' => "@trackinguser [1.5#{TIME_MEASUREMENTS[time_measurement]}]" })
+end
+
+def create_effort(time_measurement)
+  create_notification(data: { 'text' => "@trackinguser +4.5#{TIME_MEASUREMENTS[time_measurement]}]" })
+end
+
+def with(notification)
+  tracking = TrackingFactory.build_from(notification)
+  yield(tracking)
+end
+
+def with_message(notification_message, &block)
+  with(notification_with_message(notification_message), &block)
+end
+
+def create_notification(custom_params)
+  params = { data: { 'text' => "@trackinguser +2h" }, date: "2012-10-28T21:06:14.801Z", member_creator: stub(username: "pietrodibello") }
+  params.merge!(custom_params)
+
+  stub(data: params[:data], date: params[:date], member_creator: params[:member_creator]).as_null_object
+end
+

data/spec/support/database_cleaner.rb

@@ -0,0 +1,12 @@
+require 'database_cleaner'
+ 
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.orm = 'mongoid'
+    DatabaseCleaner.strategy = :truncation
+  end
+ 
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/tracked_card_spec.rb

@@ -0,0 +1,336 @@
+require 'spec_helper'
+
+describe TrackedCard do
+
+  before(:each) do
+    Date.stub(:today).and_return(Date.parse("2012-11-05"))
+  end
+
+  subject(:card) { TrackedCard.new(name: "any", short_id: 1234, trello_id: "123123") }
+
+  %w{piero tommaso michele}.each do |username|
+    let(username.to_sym) { Member.new(username: username) }
+  end
+
+  describe "validations" do
+    it "is not valid when a name is not given" do
+      TrackedCard.new(trello_id: "123456789", short_id: 1234).should_not be_valid
+    end
+
+    it "is not valid when a short_id is not given" do
+      TrackedCard.new(name: "any", trello_id: "123456789").should_not be_valid
+    end
+
+    it "is not valid when a trello_id is not given" do
+      TrackedCard.new(name: "any", short_id: 1234).should_not be_valid
+    end
+
+    it "is valid when has a name, a short id and a trello id" do
+      TrackedCard.new(name: "any", trello_id: "123456789", short_id: 1234).should be_valid
+    end
+  end
+
+  describe ".find_by_trello_id" do
+    it "find a card given its Trello id" do
+      card = TrackedCard.create(name: "any card", short_id: 1234, trello_id: "1")
+      another_card = TrackedCard.create(name: "another card", short_id: 3456, trello_id: "2")
+
+      TrackedCard.find_by_trello_id("1").should == card
+      TrackedCard.find_by_trello_id("3").should == nil
+    end
+  end
+
+  describe ".update_or_create_with" do
+    let(:trello_card) { Trello::Card.new("id" => "ABC123", "name" => "a name", "idShort" => 1, "desc" => "any description") }
+
+    before(:each) do
+      Trello::Card.any_instance.stub(:in_done_column?)
+    end
+
+    it "creates a tracked card on a given trello card" do
+      tracked_card = TrackedCard.update_or_create_with(trello_card)
+
+      tracked_card.name.should == "a name"
+      tracked_card.trello_id == "ABC123"
+      tracked_card.short_id == 1
+    end
+
+    it "updates an existing tracked card on a given trello card" do
+      existing_card = TrackedCard.create(name: "an old name", short_id: 1234, trello_id: trello_card.id)
+
+      updated_card = TrackedCard.update_or_create_with(trello_card)
+
+      updated_card.should == existing_card
+      updated_card.name.should == "a name"
+    end
+
+    it "is nil when the trello card is not valid" do
+      invalid_trello_card = Trello::Card.new("id" => nil, "name" => nil)
+
+      TrackedCard.update_or_create_with(invalid_trello_card).should be_nil
+      TrackedCard.all.should be_empty
+    end
+
+    it "tracks the card as done when the original trello card is moved in a DONE column" do
+      trello_card.stub(:in_done_column?).and_return(true)
+
+      tracked_card = TrackedCard.update_or_create_with(trello_card)
+
+      tracked_card.should be_done
+    end
+
+    it "tracks the card as NOT done when the original trello card is moved in a column different from DONE" do
+      trello_card.stub(:in_done_column?).and_return(false)
+
+      tracked_card = TrackedCard.update_or_create_with(trello_card)
+
+      tracked_card.should_not be_done
+    end
+
+  end
+
+  describe ".build_from" do
+    it "builds a TrackedCard from a Trello Card" do
+      tracked_card = TrackedCard.build_from(Trello::Card.new("name" => "a name", "desc" => "any description"))
+
+      tracked_card.name.should == "a name"
+      tracked_card.description.should == "any description"
+    end
+
+    it "takes the Trello Card id and set it as trello_id" do
+      tracked_card = TrackedCard.build_from(Trello::Card.new("id" => "abc123", "name" => "a name", "desc" => "any description"))
+
+      tracked_card.id.should_not    == "abc123"
+      tracked_card.trello_id.should == "abc123"
+    end
+
+  end
+
+  it "has no estimates and efforts initially" do
+    card.estimates.should be_empty
+    card.efforts.should be_empty
+  end
+
+  it "is possible to add estimates" do
+    card.estimates << Estimate.new(amount: 5, date: Date.yesterday)
+    card.estimates << Estimate.new(amount: 12, date: Date.today)
+
+    card.estimates.should have(2).estimates
+  end
+
+  it "is possible to add efforts" do
+    card.efforts << Effort.new(amount: 3, date: Date.today, members: [piero, tommaso])
+    card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+    card.efforts.should have(2).efforts
+  end
+
+  describe "equality" do
+    it "is equal to another TrelloCard when the trello id is the same" do
+      card          = TrackedCard.new(name: "a name", trello_id: "123456789")
+      same_card     = TrackedCard.new(name: "a name", trello_id: "123456789")
+      another_card  = TrackedCard.new(name: "a name", trello_id: "987654321")
+
+      card.should == same_card
+      card.should_not == another_card
+    end
+  end
+
+  describe "#add" do
+    let(:card) { TrackedCard.new(name: "a name", trello_id: "123456789") }
+    let(:estimate_tracking) { Tracking::EstimateTracking.new(create_notification(data: { 'text' => "@trackinguser [1h]" })) }
+
+    it "adds an estimate from a tracking estimate notification" do
+      card.add(estimate_tracking)
+      card.estimates.should have(1).estimate
+    end
+
+    it "adds an estimate only once" do
+      card.add(estimate_tracking)
+      card.add(estimate_tracking)
+
+      card.estimates.should have(1).estimate
+    end
+
+    it "is done when has a DONE notification" do
+      card.should_not be_done
+
+      card.add(Tracking::CardDoneTracking.new(stub(:notification)))
+      card.should be_done
+    end
+
+  end
+
+  describe "#add!" do
+    let(:card) { TrackedCard.new(name: "a name", trello_id: "123456789", short_id: "123") }
+
+    it "saves the tracked card after adding the tracking" do
+      any_tracking = Tracking::EstimateTracking.new(create_notification(data: { 'text' => "@trackinguser [1h]" }))
+
+      card.add!(any_tracking)
+      card.reload.should_not be_nil
+    end
+  end
+
+  describe "#total_effort" do
+    it "is zero when there's no effort" do
+      card.total_effort.should == 0
+    end
+
+    it "computes the total effort on the card" do
+      card.efforts << Effort.new(amount: 3, date: Date.today, members: [piero, tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.total_effort.should == 3+5
+    end
+  end
+
+  describe "#last_estimate_error" do
+    it "is nil when the card has no estimate" do
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.last_estimate_error.should be_nil
+    end
+
+    it "is nil when the card has no effort" do
+      card.efforts << Estimate.new(amount: 5, date: Date.today)
+
+      card.last_estimate_error.should be_nil
+    end
+
+    it "is zero when actual effort is equal to estimate" do
+      card.estimates << Estimate.new(amount: 5, date: Date.today)
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.last_estimate_error.should == 0.0
+    end
+
+    it "is 100 when the actual effort is twice the given estimate" do
+      card.estimates << Estimate.new(amount: 5, date: Date.today)
+      card.efforts << Effort.new(amount: 10, date: Date.today, members: [tommaso])
+
+      card.last_estimate_error.should == 100.0
+    end
+
+    it "is -50 when the actual effort is half of the given estimate" do
+      card.estimates << Estimate.new(amount: 10, date: Date.today)
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.last_estimate_error.should == -50.0
+    end
+
+    it "is rounded with two decimal digits" do
+      card.estimates << Estimate.new(amount: 3, date: Date.today)
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.last_estimate_error.should == 66.67
+    end
+
+    describe "#estimate_errors" do
+
+      it "collects all the estimate errors against the actual effort" do
+        card.estimates << Estimate.new(amount: 5, date: Date.yesterday)
+        card.efforts << Effort.new(amount: 10, date: Date.yesterday, members: [tommaso])
+
+        card.estimates << Estimate.new(amount: 10, date: Date.today)
+        card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+        card.estimate_errors.should == [200.0, 50.0]
+      end
+    end
+
+  end
+
+  describe "#members" do
+    it "lists all the members which spent some effort on the card" do
+      card.efforts << Effort.new(amount: 3, date: Date.today, members: [piero, tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso, michele])
+
+      card.members.should == [piero, tommaso, michele]
+    end
+  end
+
+  describe "#working_start_date" do
+
+    it "is the date of the first effort spent on the card" do
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+      card.efforts << Effort.new(amount: 3, date: Date.yesterday, members: [tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.tomorrow, members: [tommaso])
+
+      card.working_start_date.should == Date.yesterday
+    end
+  end
+
+  describe "#first_activity_date" do
+    it "is the date of the first effort or estimate given on the card" do
+      card.estimates << Estimate.new(amount: 5, date: Date.yesterday)
+      card.estimates << Estimate.new(amount: 12, date: Date.yesterday.prev_day)
+      card.estimates << Estimate.new(amount: 12, date: Date.tomorrow)
+
+      card.efforts << Effort.new(amount: 3, date: Date.yesterday, members: [tommaso])
+      card.efforts << Effort.new(amount: 5, date: Date.today, members: [tommaso])
+
+      card.first_activity_date.should == Date.yesterday.prev_day
+    end
+  end
+
+  describe "#first_estimate_date" do
+    it "is the date of the first estimate given on the card" do
+      card.estimates << Estimate.new(amount: 5, date: Date.tomorrow)
+      card.estimates << Estimate.new(amount: 12, date: Date.yesterday.prev_day)
+      card.estimates << Estimate.new(amount: 12, date: Date.today)
+
+      card.first_estimate_date.should == Date.yesterday.prev_day
+    end
+  end
+
+  describe "#last_estimate_date" do
+    it "is the date of the last estimate given on the card" do
+      card.estimates << Estimate.new(amount: 5, date: Date.yesterday)
+      card.estimates << Estimate.new(amount: 12, date: Date.tomorrow)
+      card.estimates << Estimate.new(amount: 12, date: Date.today)
+
+      card.last_estimate_date.should == Date.tomorrow
+    end
+  end
+
+  describe "#no_tracking?" do
+    it "is false when there's no effort or estimate tracked on the card" do
+      card.no_tracking?.should be_true
+
+      card.estimates << Estimate.new(amount: 5, date: Date.yesterday)
+      card.no_tracking?.should be_false
+    end
+  end
+
+  describe "#to_s" do
+    it "describes the card as a string" do
+      card = TrackedCard.new(name: "A Story Name")
+      card.estimates << Estimate.new(amount: 5, date: Date.today)
+      card.efforts << Effort.new(amount: 3, date: Date.today, members: [Member.new(username: "piero"), Member.new(username: "tommaso")])
+      card.efforts << Effort.new(amount: 6, date: Date.today, members: [Member.new(username: "piero"), Member.new(username: "tommaso")])
+
+      card.to_s.should == %Q{[A Story Name]. Total effort: 9.0h. Estimates ["[2012-11-05] estimated 5.0 hours"]. Efforts: ["[2012-11-05] spent 3.0 hours by @piero, @tommaso", "[2012-11-05] spent 6.0 hours by @piero, @tommaso"]}
+    end
+  end
+
+  describe "#status" do
+    it "is done when is done" do
+      done_card = TrackedCard.new(done:true)
+      done_card.status.should == :done
+
+      done_card.efforts << Effort.new(amount: 3, date: Date.today, members: [Member.new(username: "any")])
+      done_card.status.should == :done
+    end
+
+    it "is todo when no effort has been spent on the card" do
+      card = TrackedCard.new
+      card.status.should == :todo
+
+      card.efforts << Effort.new(amount: 3, date: Date.today, members: [Member.new(username: "any")])
+      card.status.should == :in_progress
+    end
+  end
+
+end