tracco 0.0.14 → 0.0.15

data/lib/tracco/tracking/effort_tracking.rb

@@ -1,42 +1,45 @@
-module Tracking
-  class EffortTracking
-    include Base
+module Tracco
+  module Tracking
+    class EffortTracking
+      include Base
 
-    def add_to(card)
-      card.efforts << effort unless card.contains_effort?(effort)
-    end
+      def add_to(card)
+        card.efforts << effort unless card.contains_effort?(effort)
+      end
 
-    def effort
-      @effort ||= Effort.new(amount: total_effort_from(raw_effort), date: date, members: effort_members, tracking_notification_id: tracking_notification.id)
-    end
+      def effort
+        @effort ||= Effort.new(amount: total_effort_from(raw_effort), date: date, members: effort_members, tracking_notification_id: tracking_notification.id)
+      end
 
-    private
+      private
 
-    def total_effort_from(raw_effort)
-      effort_amount = convert_to_hours(raw_effort)
-      total_effort = effort_amount * effort_members.size
-    end
+      def total_effort_from(raw_effort)
+        effort_amount = convert_to_hours(raw_effort)
+        total_effort = effort_amount * effort_members.size
+      end
 
-    def raw_effort
-      extract_match_from_raw_tracking(/\+#{DURATION_REGEXP}/)
-    end
+      def raw_effort
+        extract_match_from_raw_tracking(/\+#{DURATION_REGEXP}/)
+      end
 
-    def effort_members
-      @effort_members ||= members_involved_in_the_effort.map do |username|
-        Member.build_from(Trello::Member.find(username))
+      def effort_members
+        @effort_members ||= members_involved_in_the_effort.map do |username|
+          Member.build_from(Trello::Member.find(username))
+        end
       end
-    end
 
-    def members_involved_in_the_effort
-      members_involved_in_the_effort = raw_tracking.scan(/@(\w+)/).flatten
-      members_involved_in_the_effort << notifier.username unless should_count_only_listed_members?
+      def members_involved_in_the_effort
+        members_involved_in_the_effort = raw_tracking.scan(/@(\w+)/).flatten
+        members_involved_in_the_effort << notifier.username unless should_count_only_listed_members?
 
-      members_involved_in_the_effort
-    end
+        members_involved_in_the_effort
+      end
 
-    def should_count_only_listed_members?
-      raw_tracking =~ /\((@\w+\W*\s*)+\)/
-    end
+      def should_count_only_listed_members?
+        raw_tracking =~ /\((@\w+\W*\s*)+\)/
+      end
 
+    end
   end
+
 end

data/lib/tracco/tracking/estimate_tracking.rb

@@ -1,20 +1,23 @@
-module Tracking
-  class EstimateTracking
-    include Base
+module Tracco
+  module Tracking
+    class EstimateTracking
+      include Base
 
-    def estimate
-      @estimate ||= Estimate.new(amount: convert_to_hours(raw_estimate), date: date, tracking_notification_id: tracking_notification.id)
-    end
+      def estimate
+        @estimate ||= Estimate.new(amount: convert_to_hours(raw_estimate), date: date, tracking_notification_id: tracking_notification.id)
+      end
 
-    def add_to(card)
-      card.estimates << estimate unless card.contains_estimate?(estimate)
-    end
+      def add_to(card)
+        card.estimates << estimate unless card.contains_estimate?(estimate)
+      end
 
-    private
+      private
 
-    def raw_estimate
-      extract_match_from_raw_tracking(/\[#{DURATION_REGEXP}\]/)
-    end
+      def raw_estimate
+        extract_match_from_raw_tracking(/\[#{DURATION_REGEXP}\]/)
+      end
 
+    end
   end
+
 end

data/lib/tracco/tracking/factory.rb

@@ -1,26 +1,28 @@
-module Tracking
-  class Factory
+module Tracco
+  module Tracking
+    class Factory
 
-    DURATION_REGEXP = '(\d+\.?\d*[phdg])'
+      DURATION_REGEXP = '(\d+\.?\d*[phdg])'
 
-    @match_pairs = {}
+      @match_pairs = {}
 
-    def self.build_from(tracking_notification)
-      matching_pair = @match_pairs.find { |regexp, tracking_class| tracking_notification.data['text'] =~ regexp }
+      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
+        tracking_class = matching_pair ? matching_pair.last : Tracking::InvalidTracking
+        tracking_class.new(tracking_notification)
+      end
 
-    private
+      private
 
-    def self.match(match_pair)
-      @match_pairs.merge!(match_pair)
-    end
+      def self.match(match_pair)
+        @match_pairs.merge!(match_pair)
+      end
 
-    match /\[#{DURATION_REGEXP}\]/ => Tracking::EstimateTracking
-             match /\+#{DURATION_REGEXP}/   => Tracking::EffortTracking
-             match /DONE/ => Tracking::CardDoneTracking
+      match /\[#{DURATION_REGEXP}\]/ => Tracking::EstimateTracking
+      match /\+#{DURATION_REGEXP}/   => Tracking::EffortTracking
+      match /DONE/ => Tracking::CardDoneTracking
 
+    end
   end
 end

data/lib/tracco/tracking/invalid_tracking.rb

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

data/lib/tracco/trello_tracker.rb

@@ -1,44 +1,48 @@
-class TrelloTracker
-  include TrelloAuthorize
-  include Trello
+module Tracco
 
-  trap("SIGINT") { exit! }
+  class TrelloTracker
+    include TrelloAuthorize
+    include Trello
 
-  def initialize(custom_config_params = {})
-    authorize_on_trello(custom_config_params)
-    tracker_username(custom_config_params[:tracker_username])
-  end
+    trap("SIGINT") { exit! }
+
+    def initialize(custom_config_params = {})
+      authorize_on_trello(custom_config_params)
+      tracker_username(custom_config_params[:tracker_username])
+    end
 
-  def track(starting_date=Date.today)
-    notifications = tracker.notifications_since(starting_date)
+    def track(starting_date=Date.today)
+      tracking_notifications = tracker.tracking_notifications_since(starting_date)
 
-    oldest, latest = boundary_dates_in(notifications)
-    Trello.logger.info "Processing #{notifications.size} tracking notifications (from #{oldest} to #{latest}) starting from #{starting_date}..."
+      oldest, latest = boundary_dates_in(tracking_notifications)
+      Trello.logger.info "Processing #{tracking_notifications.size} tracking events (from #{oldest} to #{latest}) starting from #{starting_date}..."
 
-    notifications.each do |notification|
-      tracking = Tracking::Factory.build_from(notification)
-      begin
-        tracked_card = TrackedCard.update_or_create_with(notification.card)
-        tracked_card.add!(tracking)
-        Trello.logger.info tracking
+      tracking_notifications.each do |tracking_notification|
+        tracking = Tracking::Factory.build_from(tracking_notification)
+        begin
+          tracked_card = TrackedCard.update_or_create_with(tracking_notification.card)
+          tracked_card.add!(tracking)
+          Trello.logger.info tracking
 
-      rescue StandardError => e
-        Trello.logger.warn "skipping tracking: #{e.message}".color(:magenta)
-        Trello.logger.debug "#{e.backtrace}"
+        rescue StandardError => e
+          Trello.logger.warn "skipping tracking: #{e.message}".color(:magenta)
+          Trello.logger.debug "#{e.backtrace}"
+        end
       end
+      Trello.logger.info "Done tracking cards!".color(:green)
     end
-    Trello.logger.info "Done tracking cards!".color(:green)
-  end
 
-  private
+    private
 
-  def tracker
-    @tracker ||= Member.find(tracker_username)
-  end
+    def tracker
+      @tracker ||= Trello::Member.find(tracker_username)
+    end
+
+    def boundary_dates_in(tracking_notifications)
+      dates = tracking_notifications.map { |each_tracking_notification| Chronic.parse(each_tracking_notification.date) }
+      [dates.min, dates.max]
+    end
 
-  def boundary_dates_in(notifications)
-    dates = notifications.map { |each_notification| Chronic.parse(each_notification.date) }
-    [dates.min, dates.max]
   end
 
 end

data/lib/tracco/version.rb

@@ -1,3 +1,3 @@
-class TrelloEffortTracker
-  VERSION = '0.0.14'
+module Tracco
+  VERSION = '0.0.15'
 end

data/lib/tracco.rb

@@ -9,10 +9,10 @@ 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/models/tracked_card'
+require 'tracco/models/member'
+require 'tracco/models/estimate'
+require 'tracco/models/effort'
 require 'tracco/tracking/base'
 require 'tracco/tracking/estimate_tracking'
 require 'tracco/tracking/effort_tracking'

data/spec/factories/effort_factory.rb

@@ -1,9 +1,9 @@
 FactoryGirl.define do
 
-  factory :effort do
+  factory :effort, :class => Tracco::Effort do
     amount 4
     date Date.today
-    members [Member.new(username: "any_name")]
+    members [Tracco::Member.new(username: "any_name")]
     sequence(:tracking_notification_id, 1000)
     muted false
   end

data/spec/factories/estimate_factory.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
 
-  factory :estimate do
+  factory :estimate, :class => Tracco::Estimate do
     amount 42
     date Date.today
     sequence(:tracking_notification_id, 1000)

data/spec/factories/tracked_card_factory.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
 
-  factory :tracked_card do
+  factory :tracked_card, :class => Tracco::TrackedCard do
     sequence(:short_id, 1000)
     sequence(:trello_id, 100000) { |n| "xyz#{n}" }
     sequence(:name)              { |n| "any_card_#{n}" }

data/spec/integration/trello_tracker_spec.rb

@@ -1,66 +1,68 @@
 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
+module Tracco
+  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"
+    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")
-  }
+    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
+    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)
+      # 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
+      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)
+      # 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
+      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
+      # 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
+      # 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
+    private
 
-  def without_logging(&block)
-    original_error_level = Trello.logger.level
+    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
+      begin
+        Trello.logger.level = Logger::WARN
+        block.call unless block.nil?
+      ensure
+        Trello.logger.level = original_error_level
+      end
     end
   end
 end

data/spec/models/effort_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+module Tracco
+  describe Effort do
+
+    it { should have_fields(:amount, :date, :muted, :tracking_notification_id) }
+    it { should be_embedded_in(:tracked_card) }
+    it { should embed_many(:members) }
+
+    describe "validation" do
+      it { should validate_presence_of(:amount) }
+      it { should validate_presence_of(:date) }
+      it { should validate_presence_of(:members) }
+    end
+
+    %w{piero tommaso tom ugo}.each do |username|
+      let(username.to_sym) { Member.new(username: username) }
+    end
+
+    describe "#amount_per_member" do
+      it "counts the amount spent per single member" do
+        effort = Effort.new(amount: 6, members: [piero, tommaso], date: Date.parse("2012-11-09"), )
+        effort.amount_per_member.should == 3
+      end
+    end
+
+    describe "equality" do
+      it "is equal to another effort with same amount, date and members" do
+        effort          = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [piero, tommaso])
+        same_effort     = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [piero, tommaso])
+        yet_same_effort = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [tommaso, piero])
+
+        effort.should == same_effort
+        effort.should == yet_same_effort
+      end
+
+      it "is not equal when amount differs" do
+        effort          = Effort.new(amount: 3, date: Date.today, members: [tom, ugo])
+        another_effort  = Effort.new(amount: 1, date: Date.today, members: [tom, ugo])
+
+        effort.should_not == another_effort
+      end
+
+      it "is not equal when date differs" do
+        effort          = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [tom, ugo])
+        another_effort  = Effort.new(amount: 3, date: Date.parse("2011-10-08"), members: [tom, ugo])
+
+        effort.should_not == another_effort
+      end
+
+      it "is not equal when members differ" do
+        effort         = Effort.new(amount: 3, date: Date.today, members: [tom, ugo])
+        another_effort = Effort.new(amount: 3, date: Date.today, members: [piero, ugo])
+
+        effort.should_not == another_effort
+      end
+
+    end
+  end
+end

data/spec/models/estimate_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+module Tracco
+  describe Estimate do
+
+    it { should have_fields(:amount, :date) }
+    it { should be_embedded_in(:tracked_card) }
+
+    describe "validation" do
+      it { should validate_presence_of(:amount) }
+      it { should validate_presence_of(:date) }
+    end
+
+    describe "equality" do
+
+      it "is equal to another estimate with same amount and date" do
+        estimate          = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+        same_estimate     = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+
+        estimate.should == same_estimate
+      end
+
+      it "is not equal when amount differs" do
+        estimate          = Estimate.new(amount: 3, date: Date.today)
+        another_estimate  = Estimate.new(amount: 1, date: Date.today)
+
+        estimate.should_not == another_estimate
+      end
+
+      it "is not equal when date differs" do
+        estimate          = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+        another_estimate  = Estimate.new(amount: 3, date: Date.parse("2011-10-08"))
+
+        estimate.should_not == another_estimate
+      end
+
+    end
+  end
+end

data/spec/models/member_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+module Tracco
+  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
+end