goal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a273a57258b55e11c3d0f61514950efb5026ffa
-  data.tar.gz: 9e98c87c2cee48f8617f609acdf7388d6f9ede4f
+  metadata.gz: 9e6dc9f385d0532851d70b7d1d37a24cb250709f
+  data.tar.gz: 636a43dc39b232239589589602b3691f9b23ccf8
 SHA512:
-  metadata.gz: 2674f99af748b9e286bf9b04316816e6561c7f3b5599ccf466d8ecfcf7723901f4abb7ed9bd3d2634ea69991827f74523463f78f75d1e90b2e8ac0807fe26bb0
-  data.tar.gz: 964867d39e49b6d1a4a31ed4aa87fd62f9eaeedc34becd4e6ae54cc36d5110f822ed9ed86417f8f77d1409f33ed575701468b063e14a01555539ff81e0d44e1a
+  metadata.gz: 16be09eaf6287db18b6fa0e3aee7e25142b4e705baabbbc733a362e16a8ac4eab8018682637c103d449793b381364ecd0f5442e2e539d88d93ceb25197bc4b22
+  data.tar.gz: 1880eda0ab7fb3e59fd0969ed4ccc30223f725381edac0143fff21c867c8b478d85268da348e68c535ed74f1738780878578ae11135c296b142b1314397c617c

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.2.0
+
+* bug fix
+  * Fix the wrong average when in beginning or end of month, issue #1
+
+* new
+  * Add a extra option -m, it is used to calculate the current money based on
+    the current time.
+
 ### 0.1.0
 
 * bug fix

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/goal.png)](http://badge.fury.io/rb/goal)
+
 Goal
 ====
 
@@ -27,9 +29,9 @@ $ goal -u freshbooks_user -t freshbooks_token
 | 250   | 152      | 14.93   |
 | 300   | 182      | 20.48   |
 |____________________________|
-| Current:   115.66h
-| Average:   8.26h
-| Days left: 9
+| Current time: 115.66h
+| Current rate: 8.26h
+| Days left:    9
 ```
 
 or
@@ -43,8 +45,25 @@ $ goal -h 115.66
 | 250   | 152      | 14.93   |
 | 300   | 182      | 20.48   |
 |____________________________|
-| Current:   115.66h
-| Average:   8.26h
+| Current time: 115.66h
+| Current rate: 8.26h
+| Days left:    9
+```
+
+or
+
+```bash
+$ goal -h 115.66 -m 120
+
+| Goals | Expected | Average |
+| 160   | 97       | 4.93    |
+| 200   | 121      | 9.37    |
+| 250   | 152      | 14.93   |
+| 300   | 182      | 20.48   |
+|____________________________|
+| Current time:  115.66h
+| Current money: 13.879.20
+| Current rate:  8.26h
 | Days left: 9
 ```
 
@@ -56,6 +75,7 @@ Usage: goal [options]
     -t, --token=TOKEN                Freshbooks token
     -g, --goals=[GOALS]              Your goal list. Ex 160:200:300
     -h, --hours=HOURS                Worked time in hours.
+    -m, --money=MONEY                The money rate.
 ```
 
 Options `-u` and `-t` are required and specify the user and token to access the

data/bin/goal

@@ -23,6 +23,10 @@ optparse = OptionParser.new do |opts|
   opts.on("-h", "--hours=HOURS", "Worked time in hours.") do |h|
     options[:hours] = h.to_f
   end
+
+  opts.on("-m", "--money=MONEY", "The money rate.") do |m|
+    options[:money_rate] = m.to_f
+  end
 end
 
 optparse.parse!

data/lib/goal/hour_calculator.rb

@@ -31,7 +31,7 @@ module Goal
     end
 
     def days_left
-      total_days_until(end_of_month) - total_days_until
+      total_days_until(end_of_month) - total_days_until + 1
     end
 
     private

data/lib/goal/report.rb

@@ -26,10 +26,17 @@ module Goal
     end
 
     def footer
-      "|" + ('-' * ((column_width * 3) + 8)) + "|\n" +
-      "| Current time: #{data[:summary][:total_time]}\n" +
-      "| Current rate: #{data[:summary][:rate]}\n" +
-      "| Days left:    #{data[:summary][:days_left]}"
+      summary =  "|" + ('-' * ((column_width * 3) + 8)) + "|\n"
+      summary += "| Current time:  #{data[:summary][:total_time]}\n"
+
+      if data[:summary][:money]
+        summary += "| Current money: #{number_to_currency(data[:summary][:money])}\n"
+      end
+
+      summary += "| Current rate:  #{data[:summary][:rate]}\n"
+      summary += "| Days left:     #{data[:summary][:days_left]}"
+
+      summary
     end
 
     def row(columns)
@@ -43,5 +50,13 @@ module Goal
         c.to_s.ljust(column_width)
       end
     end
+
+    def number_to_currency(value)
+      val_str = ("%.2f" % [value.to_s]).gsub('.', ',')
+
+      while val_str.sub!(/(\d+)(\d\d\d)/, '\1.\2'); end
+
+      val_str
+    end
   end
 end

data/lib/goal/version.rb

@@ -1,3 +1,3 @@
 module Goal
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/goal.rb

@@ -10,6 +10,7 @@ module Goal
       @username  = options[:username]
       @token     = options[:token]
       @hours     = options[:hours]
+      @money_rate = options[:money_rate]
     end
 
     def worked_time
@@ -22,6 +23,10 @@ module Goal
       end.round(2)
     end
 
+    def total_money
+      (worked_time * money_rate).round(2)
+    end
+
     # It calculates the current hour rate
     def rate
       calculator.hour_rate(worked_time).round(2)
@@ -38,7 +43,8 @@ module Goal
 
     private
 
-    attr_reader :base, :calculator, :goal_list, :username, :token, :hours
+    attr_reader :base, :calculator, :goal_list, :username, :token, :hours,
+      :money_rate
 
     def freshbooks
       Goal::FreshbooksCalculator.new(username, token)
@@ -59,11 +65,15 @@ module Goal
     end
 
     def summary
-      {
+      data = {
         total_time: worked_time,
         rate: rate,
         days_left: calculator.days_left
       }
+
+      data[:money] = total_money if money_rate
+
+      data
     end
   end
 end

data/spec/calculator_spec.rb

@@ -53,18 +53,18 @@ describe Goal::Calculator do
           {
             goal: 160,
             expected: 97.39,
-            average: 7.78
+            average: 7.0
           },
           {
             goal: 200,
             expected: 121.74,
-            average: 12.22
+            average: 11.0
           }
         ],
         summary: {
           total_time: 90.0,
           rate: 6.43,
-          days_left: 9
+          days_left: 10
         }
       })
     end

data/spec/hour_calculator_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe Goal::HourCalculator do
   describe '#total_days_until' do
     it 'should calculate the business days from the beginning of the month until the specified day' do
+      Date.stub(today: Date.new(2013, 10, 1))
+
       expect(subject.total_days_until Date.new(2013, 10, 17)).to eq 13 # Thursday
       expect(subject.total_days_until Date.new(2013, 10, 18)).to eq 14 # Friday
       expect(subject.total_days_until Date.new(2013, 10, 19)).to eq 14 # Saturday
@@ -32,21 +34,72 @@ describe Goal::HourCalculator do
 
       expect(subject.hour_rate(95)).to eq 6.785714285714286
     end
+
+    context 'when on the last day of the month' do
+      it 'should calculate the hour rate' do
+        Date.stub(today: Date.new(2013, 10, 31))
+
+        expect(subject.hour_rate(200)).to eq 8.695652173913043
+      end
+    end
+
+    context 'when on the first day of the month' do
+      it 'should calculate the hour rate' do
+        Date.stub(today: Date.new(2013, 10, 1))
+
+        expect(subject.hour_rate(0)).to eq 0.0
+        expect(subject.hour_rate(5)).to eq 5.0
+      end
+    end
   end
 
   describe '#rate_to_goal' do
     it 'should calculate the hour per day needed to the goal from the left days of the month' do
       Date.stub(today: Date.new(2013, 10, 18))
 
-      expect(subject.rate_to_goal(200, 115.66)).to eq 9.371111111111112
+      expect(subject.rate_to_goal(200, 115.66)).to eq 8.434000000000001
+    end
+
+    context 'when on the last day of the month' do
+      it 'should calculate rate_to_goal' do
+        Date.stub(today: Date.new(2013, 10, 31))
+
+        expect(subject.rate_to_goal(200, 115.66)).to eq 84.34
+      end
+    end
+
+    context 'when on the first day of the month' do
+      it 'should calculate the rate to goal' do
+        Date.stub(today: Date.new(2013, 10, 1))
+
+        expect(subject.rate_to_goal(200, 0)).to eq 8.0
+      end
     end
   end
 
   describe '#days_left' do
-    it 'should return the days left from de month since today' do
-      Date.stub(today: Date.new(2013, 10, 18))
+    context 'when in beginning of the month' do
+      it 'should return the days left from de month since today' do
+        Date.stub(today: Date.new(2013, 10, 1))
+
+        expect(subject.days_left).to eq 23
+      end
+    end
+
+    context 'when in middle of the month' do
+      it 'should return the days left from de month since today' do
+        Date.stub(today: Date.new(2013, 10, 18))
+
+        expect(subject.days_left).to eq 10
+      end
+    end
+
+    context 'when in the end of the month' do
+      it 'should return the days left from de month since today' do
+        Date.stub(today: Date.new(2013, 10, 31))
 
-      expect(subject.days_left).to eq 9
+        expect(subject.days_left).to eq 1
+      end
     end
   end
 end

data/spec/report_spec.rb

@@ -23,21 +23,41 @@ describe Goal::Report do
     }
   end
 
+
   subject do
     described_class.new(data)
   end
 
   describe '#to_s' do
-    it 'should build the report' do
-      report  = "| Goals    | Expected | Average  |\n"
-      report += "| 160      | 97.39    | 7.78     |\n"
-      report += "| 200      | 121.74   | 12.22    |\n"
-      report += "|--------------------------------|\n"
-      report += "| Current time: 90.0\n"
-      report += "| Current rate: 6.43\n"
-      report += "| Days left:    9"
-
-      expect(subject.to_s).to eq report
+    context 'when has not money setted to summary' do
+      it 'should build the report' do
+        report  = "| Goals    | Expected | Average  |\n"
+        report += "| 160      | 97.39    | 7.78     |\n"
+        report += "| 200      | 121.74   | 12.22    |\n"
+        report += "|--------------------------------|\n"
+        report += "| Current time:  90.0\n"
+        report += "| Current rate:  6.43\n"
+        report += "| Days left:     9"
+
+        expect(subject.to_s).to eq report
+      end
+    end
+
+    context 'when has money setted to summary' do
+      it 'should build the report' do
+        data[:summary][:money] = 15000.45
+
+        report  = "| Goals    | Expected | Average  |\n"
+        report += "| 160      | 97.39    | 7.78     |\n"
+        report += "| 200      | 121.74   | 12.22    |\n"
+        report += "|--------------------------------|\n"
+        report += "| Current time:  90.0\n"
+        report += "| Current money: 15000.45\n"
+        report += "| Current rate:  6.43\n"
+        report += "| Days left:     9"
+
+        expect(subject.to_s).to eq report
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mateus Lorandi dos Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-freshbooks