trello_effort_tracker 0.0.3 → 0.0.4

data/lib/trello_effort_tracker/tracking/estimate_tracking.rb

@@ -0,0 +1,23 @@
+module Tracking
+  class EstimateTracking
+    include Base
+
+    #TODO: rename to 'amount' ?
+    #TODO: avoid recomputing estimate every time using a lazy instance variable
+    def estimate
+      estimate = convert_to_hours(raw_estimate)
+      Estimate.new(amount: estimate, date: date, tracking_notification_id: tracking_notification.id)
+    end
+
+    def add_to(card)
+      card.estimates << estimate unless card.contains_estimate?(estimate)
+    end
+
+    private
+
+    def raw_estimate
+      extract_match_from_raw_tracking(/\[#{DURATION_REGEXP}\]/)
+    end
+
+  end
+end

data/lib/trello_effort_tracker/tracking/invalid_tracking.rb

@@ -0,0 +1,19 @@
+module Tracking
+  class InvalidTracking
+    include Base
+
+    def add_to(card)
+      # do nothing
+      Trello.logger.warn "Ignoring tracking notification: '#{raw_text}'"
+    end
+
+    def estimate
+      nil
+    end
+
+    def effort
+      nil
+    end
+
+  end
+end

data/lib/trello_effort_tracker/tracking_factory.rb

@@ -0,0 +1,22 @@
+class TrackingFactory
+
+  DURATION_REGEXP = '(\d+\.?\d*[phdg])'
+
+  @match_pairs = {}
+
+  def self.match(match_pair)
+    @match_pairs.merge!(match_pair)
+  end
+
+  def self.build_from(tracking_notification)
+    matching_pair = @match_pairs.find { |regexp, tracking_class| tracking_notification.data['text'] =~ regexp }
+
+    tracking_class = matching_pair ? matching_pair.last : Tracking::InvalidTracking
+    tracking_class.new(tracking_notification)
+  end
+
+  match /\[#{DURATION_REGEXP}\]/ => Tracking::EstimateTracking
+  match /\+#{DURATION_REGEXP}/ => Tracking::EffortTracking
+  match /DONE/ => Tracking::CardDoneTracking
+
+end

data/lib/trello_effort_tracker/trello_authorize.rb

@@ -3,30 +3,14 @@ module TrelloAuthorize
   include Trello::Authorization
 
   def authorize_on_trello(auth_params={})
-    %w{developer_public_key access_token_key developer_secret}.each do |key|
+    %w{developer_public_key access_token_key}.each do |key|
       auth_params[key] ||= ENV[key] || authorization_params_from_config_file[key]
     end
 
-    init_trello(auth_params)
-  end
-
-  private
-
-  def init_trello(auth_params)
-    ignoring_warnings do
-      Trello::Authorization.const_set(:AuthPolicy, OAuthPolicy)
+    Trello.configure do |config|
+      config.developer_public_key = auth_params["developer_public_key"]
+      config.member_token         = auth_params["access_token_key"]
     end
-
-    OAuthPolicy.consumer_credential = OAuthCredential.new(auth_params["developer_public_key"], auth_params["developer_secret"])
-    OAuthPolicy.token = OAuthCredential.new(auth_params["access_token_key"], nil)
   end
 
-  def ignoring_warnings(&block)
-    begin
-      v, $VERBOSE = $VERBOSE, nil
-      block.call if block
-    ensure
-      $VERBOSE = v
-    end
-  end
 end

data/lib/trello_effort_tracker/trello_tracker.rb

@@ -15,19 +15,18 @@ class TrelloTracker
     Trello.logger.info "Processing #{notifications.size} tracking notifications (from #{oldest} to #{latest}) starting from #{starting_date}..."
 
     notifications.each do |notification|
-      tracking = Tracking.new(notification)
+      tracking = TrackingFactory.build_from(notification)
       begin
-        card = TrackedCard.update_or_create_with(notification.card)
-        card.add(tracking)
+        tracked_card = TrackedCard.update_or_create_with(notification.card)
+        tracked_card.add!(tracking)
         Trello.logger.info tracking
 
       rescue StandardError => e
-        Trello.logger.error "skipping tracking: #{e.message}".color(:magenta)
-        Trello.logger.error "#{e.backtrace}"
+        Trello.logger.warn "skipping tracking: #{e.message}".color(:magenta)
+        Trello.logger.debug "#{e.backtrace}"
       end
     end
     Trello.logger.info "Done tracking cards!".color(:green)
-    print_all_cards
   end
 
   private
@@ -41,8 +40,4 @@ class TrelloTracker
     [dates.min, dates.max]
   end
 
-  def print_all_cards
-    TrackedCard.all.each { |tracked_card| Trello.logger.info(tracked_card.to_s.color(:yellow)) }
-  end
-
 end

data/lib/trello_effort_tracker/version.rb

@@ -1,3 +1,3 @@
 class TrelloEffortTracker
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/trello_effort_tracker.rb

@@ -12,11 +12,17 @@ require 'trello_effort_tracker/tracked_card'
 require 'trello_effort_tracker/member'
 require 'trello_effort_tracker/estimate'
 require 'trello_effort_tracker/effort'
-require 'trello_effort_tracker/tracking'
+require 'trello_effort_tracker/tracking/base'
+require 'trello_effort_tracker/tracking/estimate_tracking'
+require 'trello_effort_tracker/tracking/effort_tracking'
+require 'trello_effort_tracker/tracking/card_done_tracking'
+require 'trello_effort_tracker/tracking/invalid_tracking'
+require 'trello_effort_tracker/tracking_factory'
 require 'trello_effort_tracker/trello_tracker'
 require 'trello_effort_tracker/google_docs_exporter'
 
 require 'patches/trello/member'
+require 'patches/trello/card'
 
 TrelloConfiguration::Database.load_env(ENV['MONGOID_ENV'] || "development")
 

data/spec/integration/trello_tracker_spec.rb

@@ -0,0 +1,69 @@
+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_username:  "trackinguser_for_test",
+                   developer_key:     "ef7c400e711057d7ba5e00be20139a33",
+                   access_token:      "9047d8fdbfdc960d41910673e300516cc8630dd4967e9b418fc27e410516362e")
+  }
+
+  it "tracks some estimates and efforts", :needs_valid_configuration => true do
+    with_trackinguser(config.tracker_username) do
+      tracker = TrelloTracker.new("developer_public_key" => config.developer_key, "access_token_key" => config.access_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 with_trackinguser(tracking_user, &block)
+    original_tracker = ENV["tracker_username"]
+    original_error_level = Trello.logger.level
+
+    begin
+      ENV["tracker_username"] = tracking_user
+      Trello.logger.level = Logger::WARN
+      block.call unless block.nil?
+    ensure
+      ENV["tracker_username"] = original_tracker
+      Trello.logger.level = original_error_level
+    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

@@ -1,5 +1,8 @@
 require 'rubygems'
 
+require 'simplecov'
+SimpleCov.start
+
 # Set up gems listed in the Gemfile.
 begin
   ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
@@ -11,7 +14,13 @@ rescue Bundler::GemNotFound => e
   exit!
 end
 
-Bundler.require
+Bundler.require(:spec)
+
+require 'trello_effort_tracker'
+
+# 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
@@ -19,3 +28,39 @@ 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

@@ -4,11 +4,6 @@ describe TrackedCard do
 
   before(:each) do
     Date.stub(:today).and_return(Date.parse("2012-11-05"))
-    TrackedCard.delete_all
-  end
-
-  after(:each) do
-    TrackedCard.delete_all
   end
 
   subject(:card) { TrackedCard.new(name: "any", short_id: 1234, trello_id: "123123") }
@@ -48,6 +43,10 @@ describe TrackedCard do
   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)
 
@@ -72,6 +71,22 @@ describe TrackedCard do
       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
@@ -121,6 +136,42 @@ describe TrackedCard do
     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

data/spec/tracking/card_done_tracking_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Tracking
+  describe CardDoneTracking do
+
+    describe "#add_to" do
+      it "marks the card as done" do
+        card = TrackedCard.new
+
+        done_tracking = TrackingFactory.build_from(notification_with_message("DONE"))
+        done_tracking.add_to(card)
+
+        card.done?.should be_true
+      end
+    end
+
+  end
+end

data/spec/tracking/effort_tracking_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+module Tracking
+  describe EffortTracking do
+
+    describe "#effort" do
+
+      %w{pietrodibello michelepangrazzi alessandrodescovi michelevincenzi}.each do |username|
+        let(username.to_sym) { Member.new(username: username) }
+      end
+
+      before(:each) do
+        Trello::Member.stub(:find).and_return(Member.new(username: "any"))
+      end
+
+      it "is nil when the notification does not contain an estimate" do
+        with(unrecognized_notification) { |tracking| tracking.effort.should be_nil }
+      end
+
+      it "does not parse effort in minutes (e.g. +30m)" do
+        with_message("@trackinguser +30m") { |tracking| tracking.effort.should be_nil }
+      end
+
+      it "is the hour-based effort when the notification contains an effort in hours" do
+        Trello::Member.should_receive(:find).with("michelepangrazzi").and_return(michelepangrazzi)
+
+        raw_data = create_notification(data: { 'text' => "@trackinguser +2h" },
+                                       date: "2012-10-28T21:06:14.801Z",
+                                       member_creator: stub(username: "michelepangrazzi"))
+
+        TrackingFactory.build_from(raw_data).effort.should == Effort.new(amount: 2.0, date: Date.parse('2012-10-28'), members: [michelepangrazzi])
+      end
+
+      it "converts the effort in hours when the notification contains an effort in days" do
+        with_message("@trackinguser +1.5d") { |t| t.effort.amount.should == 8+4 }
+        with_message("@trackinguser +1.5g") { |t| t.effort.amount.should == 8+4 }
+      end
+
+      it "converts the effort in hours when the notification contains an effort in pomodori" do
+        with_message("@trackinguser +10p") { |t| t.effort.amount.should == 5}
+      end
+
+      it "fetch the effort from a complex effort message" do
+        with_message "@trackinguser ho speso +2h e spero che stavolta possiamo rilasciarla" do |tracking|
+          tracking.effort.amount.should == 2.0
+        end
+      end
+
+      it "fetch the effort even when beween square brackets" do
+        with_message "@trackinguser [+0.5h]" do |tracking|
+          tracking.effort.amount.should == 0.5
+        end
+      end
+
+      it "computes the effort considering all the mentioned team mates in the message" do
+        with_message "@trackinguser +2h assieme a @michelepangrazzi e @alessandrodescovi" do |tracking|
+          tracking.effort.amount.should == 2.0 * 3
+        end
+      end
+
+      it "tracks all the team mates which spent that effort on the card" do
+        %w{pietrodibello michelepangrazzi alessandrodescovi}.each do |username|
+          Trello::Member.should_receive(:find).with(username).and_return(self.send(username))
+        end
+
+        notification = create_notification(data: { 'text' => "@trackinguser +2h assieme a @michelepangrazzi e @alessandrodescovi" },
+                                           member_creator: stub(username: "pietrodibello"))
+        with notification do |tracking|
+          tracking.effort.members.should == [michelepangrazzi, alessandrodescovi, pietrodibello]
+        end
+      end
+
+      it "tracks the effort only on the team members listed between round brackets" do
+        %w{michelevincenzi alessandrodescovi}.each do |username|
+          Trello::Member.should_receive(:find).with(username).and_return(self.send(username))
+        end
+
+        notification = create_notification(data: { 'text' => "@trackinguser +3p (@alessandrodescovi @michelevincenzi)" },
+                                           member_creator: stub(username: "pietrodibello"))
+
+        with notification do |tracking|
+          tracking.effort.members.should == [alessandrodescovi, michelevincenzi]
+          tracking.effort.amount.should == 1.5 * 2
+        end
+      end
+
+      it "tracks the effort with the date given in the notification text, not the actual notification date" do
+        raw_data = create_notification(data: { 'text' => "@trackinguser 22.11.2012 +6p" }, date: "2012-09-19T12:46:13.713Z")
+
+        tracking = TrackingFactory.build_from(raw_data)
+
+        tracking.effort.date.should == Date.parse('2012-11-22')
+      end
+
+      it "tracks the effort to yesterday when the keyword 'yesterday' is present before the effort amount" do
+        raw_data = create_notification(data: { 'text' => "@trackinguser yesterday +6p" }, date: "2012-09-19T12:46:13.713Z")
+
+        tracking = TrackingFactory.build_from(raw_data)
+
+        tracking.effort.date.should == Date.parse('2012-09-18')
+      end
+
+      it "tracks the effort to yesterday when the keyword 'yesterday' is present before the effort amount" do
+        raw_data = create_notification(data: { 'text' => "@trackinguser +6p yesterday" }, date: "2012-09-19T12:46:13.713Z")
+
+        tracking = TrackingFactory.build_from(raw_data)
+
+        tracking.effort.date.should == Date.parse('2012-09-18')
+      end
+
+    end
+
+  end
+end

data/spec/tracking/estimate_tracking_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Tracking
+  describe EstimateTracking do
+
+    describe "#estimate" do
+
+      it "is nil when the notification does not contain an estimate" do
+        TrackingFactory.build_from(unrecognized_notification).estimate.should be_nil
+      end
+
+      it "is the hour-based estimate when the notification contains an estimate in hours" do
+        raw_data = create_notification(data: { 'text' => "@trackinguser [2h]" }, date: "2012-10-28T21:06:14.801Z")
+
+        TrackingFactory.build_from(raw_data).estimate.should == Estimate.new(amount: 2.0, date: Date.parse('2012-10-28'))
+      end
+
+      it "converts the estimate in hours when the notification contains an estimate in days" do
+        TrackingFactory.build_from(create_notification(data: { 'text' => "@trackinguser [1.5d]" })).estimate.amount.should == 8+4
+        TrackingFactory.build_from(create_notification(data: { 'text' => "@trackinguser [1.5g]" })).estimate.amount.should == 8+4
+      end
+
+      it "converts the estimate in hours when the notification contains an estimate in pomodori" do
+        raw_data = create_notification(data: { 'text' => "@trackinguser [10p]" })
+        TrackingFactory.build_from(raw_data).estimate.amount.should == 5
+      end
+
+      it "fetch the estimate from a complex estimate message" do
+        raw_data = create_notification(data: { 'text' => "@maxmazza Dobbiamo ancora lavorarci.\n@trackinguser ristimo ancora [3h] per il fix" })
+        TrackingFactory.build_from(raw_data).estimate.amount.should == 3.0
+      end
+
+      it "tracks the effort with the date given in the notification text, not the actual notification date" do
+        raw_data = create_notification( data: { 'text' => "@trackinguser 22.11.2012 [6p]" }, date: "2012-09-19T12:46:13.713Z")
+
+        tracking = TrackingFactory.build_from(raw_data)
+
+        tracking.estimate.date.should == Date.parse('2012-11-22')
+      end
+
+    end
+  end
+
+end

data/spec/tracking_factory_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe TrackingFactory do
+
+  TIME_MEASUREMENTS = {
+    hours:    'h',
+    days:     'd',
+    giorni:   'g',
+    pomodori: 'p'
+  }
+
+  context "unknown tracking format" do
+    it "builds an invalid tracking instance" do
+      TrackingFactory.build_from(unrecognized_notification).class.should == Tracking::InvalidTracking
+
+      with_message("@trackinguser +30m") { |tracking| tracking.class.should == Tracking::InvalidTracking }
+    end
+  end
+
+  TIME_MEASUREMENTS.each_key do |time_measurement|
+
+    context "estimate tracking notification in #{time_measurement}" do
+      it "builds an estimate tracking instance" do
+        TrackingFactory.build_from(create_estimate(time_measurement)).class.should == Tracking::EstimateTracking
+      end
+    end
+
+    context "effort tracking notification in #{time_measurement}" do
+      it "builds an effort tracking instance" do
+        TrackingFactory.build_from(create_effort(time_measurement)).class.should == Tracking::EffortTracking
+      end
+    end
+
+  end
+
+  context "card done tracking notification" do
+    it "builds a card done tracking instance" do
+      with_message("@trackinguser DONE") { |tracking| tracking.class.should == Tracking::CardDoneTracking }
+    end
+  end
+
+end