goal 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a84abf9125ab94f0ab2cf6eebf7efdf4490198d
-  data.tar.gz: 5561546fb4f5db03c667c5131b4ce0e9340bf377
+  metadata.gz: 3a273a57258b55e11c3d0f61514950efb5026ffa
+  data.tar.gz: 9e98c87c2cee48f8617f609acdf7388d6f9ede4f
 SHA512:
-  metadata.gz: 7594268927070c99251e58107215c3e552f1f3ef136d994f32ac741e3213031317fc21a9dd1ef3c16eaa05c6b817f502f4f4449fd4761eacf036da27519a2845
-  data.tar.gz: 553291d1fdab8f007e69368a7eee93aec75f1f6dbab323c0d5f42441d51f0de63cb69918c80d655e4cc5b94514fca8209b8f0d8f292fb020a6a18f6852118c88
+  metadata.gz: 2674f99af748b9e286bf9b04316816e6561c7f3b5599ccf466d8ecfcf7723901f4abb7ed9bd3d2634ea69991827f74523463f78f75d1e90b2e8ac0807fe26bb0
+  data.tar.gz: 964867d39e49b6d1a4a31ed4aa87fd62f9eaeedc34becd4e6ae54cc36d5110f822ed9ed86417f8f77d1409f33ed575701468b063e14a01555539ff81e0d44e1a

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 0.1.0
+
+* bug fix
+  * Fix typo "Left days" => "Days left" on report
+  * Now -h or -u and -t are required options for the binary file
+
+* new
+  * Removes the Base class, now there is a Calculator class reponsible to make
+    the main calculations and generate data to the report
+  * Add a report class to print the report
+  * Add a new option -h(--hours)
+
+
 ### 0.0.3
 
 * bug fix

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    goal (0.0.3)
+    goal (0.1.0)
       colorize (~> 0.6.0)
       ruby-freshbooks (~> 0.4.1)
 

data/README.md

@@ -8,28 +8,44 @@ Goal
    the month that have 23 business days.
 
 ```ruby
-g = Goal.new
+calculator = Goal::HourCalculator.new
 
-g.calculate_goal(160) # => 97.39130434782608
+calculator.estimated_for(160) # => 97.39130434782608
 ```
 
 So I need to have 97.39 hours to be within my goal.
 
 
-## Using the bin
+## Using the binary file
 
 ```bash
 $ goal -u freshbooks_user -t freshbooks_token
 
-| Goals | Estimate | Avg. to Goal |
-| 160   | 97       | 4.93         |
-| 200   | 121      | 9.37         |
-| 250   | 152      | 14.93        |
-| 300   | 182      | 20.48        |
-|_________________________________|
+| Goals | Expected | Average |
+| 160   | 97       | 4.93    |
+| 200   | 121      | 9.37    |
+| 250   | 152      | 14.93   |
+| 300   | 182      | 20.48   |
+|____________________________|
 | Current:   115.66h
 | Average:   8.26h
-| Left days: 9
+| Days left: 9
+```
+
+or
+
+```bash
+$ goal -h 115.66
+
+| Goals | Expected | Average |
+| 160   | 97       | 4.93    |
+| 200   | 121      | 9.37    |
+| 250   | 152      | 14.93   |
+| 300   | 182      | 20.48   |
+|____________________________|
+| Current:   115.66h
+| Average:   8.26h
+| Days left: 9
 ```
 
 ### Available options
@@ -39,9 +55,10 @@ Usage: goal [options]
     -u, --username=USERNAME          Freshbooks username
     -t, --token=TOKEN                Freshbooks token
     -g, --goals=[GOALS]              Your goal list. Ex 160:200:300
+    -h, --hours=HOURS                Worked time in hours.
 ```
 
 Options `-u` and `-t` are required and specify the user and token to access the
-Freshbooks hours.
+Freshbooks hours. But you can use the -h option to specify manually the hours.
 
 The `-g` is optional, by default it has the following value `160:200:250:300`

data/bin/goal

@@ -1,85 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'goal'
-require 'colorize'
 require 'optparse'
 
-class MyGoals
-  def initialize(options = {})
-    @base = Goal::Base.new
-    @calculator = Goal::HourCalculator.new
-    @goal_list = options.fetch(:goal_list, [160, 200, 250, 300])
-    @username  = options[:username]
-    @token     = options[:token]
-  end
-
-  def print
-    puts
-    print_header
-    print_data
-    print_footer
-    puts
-  end
-
-  private
-
-  attr_reader :base, :calculator, :goal_list, :username, :token
-
-  def print_header
-    puts '| Goals | Estimate | Avg. to Goal |'
-  end
-
-  def print_data
-    goals.each do |goal|
-      avg = calculator.rate_to_goal(goal[:goal], current_time).round(2)
-
-      puts '| ' + goal[:goal].to_s.ljust(5) + ' | ' + goal[:expected].to_i.to_s.ljust(8) + ' | ' + avg.to_s.ljust(12).colorize(average_color(avg)) + ' |'
-    end
-  end
-
-  def print_footer
-    puts '|_________________________________|'
-    puts "| Current:   " + "#{current_time}h".colorize(current_color)
-    puts "| Average:   " + "#{rate}h".colorize(current_color)
-    puts "| Left days: #{calculator.days_left}"
-  end
-
-  def current_time
-    @current_time ||= base.worked_time(username, token).round(2)
-  end
-
-  def rate
-    @rate ||= calculator.hour_rate(current_time).round(2)
-  end
-
-  def goals
-    base.calculate_goals goal_list
-  end
-
-  def current_color
-    if rate < 8
-      :red
-    elsif rate >= 8 && rate < 9
-      :yellow
-    else
-      :green
-    end
-  end
-
-  def average_color(avg)
-    if avg < 8
-      :green
-    elsif avg >= 8 && avg < 9
-      :yellow
-    else
-      :red
-    end
-  end
-end
-
 options = {}
 
-OptionParser.new do |opts|
+optparse = OptionParser.new do |opts|
   opts.banner = "Usage: goal [options]"
 
   opts.on("-u", "--username=USERNAME", "Freshbooks username") do |u|
@@ -93,6 +19,20 @@ OptionParser.new do |opts|
   opts.on("-g", "--goals=[GOALS]", "Your goal list. Ex 160:200:300") do |g|
     options[:goal_list] = g.split(':').map(&:to_i)
   end
-end.parse!
 
-MyGoals.new(options).print
+  opts.on("-h", "--hours=HOURS", "Worked time in hours.") do |h|
+    options[:hours] = h.to_f
+  end
+end
+
+optparse.parse!
+
+unless options[:hours] || (options[:username] && options[:token])
+  puts 'Arguments -h or -u and -t are required.'
+  puts optparse
+  exit
+end
+
+calculator = Goal::Calculator.new(options)
+puts Goal::Report.new(calculator.generate_data)
+

data/lib/goal/report.rb

@@ -0,0 +1,47 @@
+module Goal
+  class Report
+    def initialize(data, options = {})
+      @data = data
+      @column_width = options.fetch(:column_width, 8)
+    end
+
+    def to_s
+      output = row(header) + "\n"
+
+      data[:rows].each do |r|
+        output += row([r[:goal], r[:expected], r[:average]]) + "\n"
+      end
+
+      output += footer
+
+      output
+    end
+
+    private
+
+    attr_reader :data, :column_width
+
+    def header
+      %w(Goals Expected Average)
+    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]}"
+    end
+
+    def row(columns)
+      prepared_columns = prepare_columns(columns)
+
+      "| #{prepared_columns.join(' | ')} |"
+    end
+
+    def prepare_columns(columns)
+      columns.map do |c|
+        c.to_s.ljust(column_width)
+      end
+    end
+  end
+end

data/lib/goal/version.rb

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

data/lib/goal.rb

@@ -1,6 +1,69 @@
 require 'goal/hour_calculator'
 require 'goal/freshbooks_calculator'
-require 'goal/base'
+require 'goal/report'
 
 module Goal
+  class Calculator
+    def initialize(options = {})
+      @calculator = Goal::HourCalculator.new
+      @goal_list = options.fetch(:goal_list, [160, 200, 250, 300])
+      @username  = options[:username]
+      @token     = options[:token]
+      @hours     = options[:hours]
+    end
+
+    def worked_time
+      if hours
+        hours
+      elsif username && token
+        freshbooks.hours
+      else
+        0
+      end.round(2)
+    end
+
+    # It calculates the current hour rate
+    def rate
+      calculator.hour_rate(worked_time).round(2)
+    end
+
+    def generate_data
+      data = {}
+
+      data[:rows] = goals
+      data[:summary] = summary
+
+      data
+    end
+
+    private
+
+    attr_reader :base, :calculator, :goal_list, :username, :token, :hours
+
+    def freshbooks
+      Goal::FreshbooksCalculator.new(username, token)
+    end
+
+    def goals
+      calculated_goals = []
+
+      goal_list.each do |goal|
+        calculated_goals.push({
+          goal: goal,
+          expected: calculator.estimated_for(goal).round(2),
+          average: calculator.rate_to_goal(goal, worked_time).round(2)
+        })
+      end
+
+      calculated_goals
+    end
+
+    def summary
+      {
+        total_time: worked_time,
+        rate: rate,
+        days_left: calculator.days_left
+      }
+    end
+  end
 end

data/spec/calculator_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Goal::Calculator do
+  describe '#worked_time' do
+    context 'with hours' do
+      subject do
+        described_class.new(hours: 90)
+      end
+
+      it 'should return hours' do
+        expect(subject.worked_time).to eq 90
+      end
+    end
+
+    context 'with hours' do
+      subject do
+        described_class.new(username: 'username', token: 'token')
+      end
+
+      it 'should return the freshbooks hours' do
+        instance = double(:instance)
+
+        Goal::FreshbooksCalculator.should_receive(:new).with('username', 'token').and_return(instance)
+        instance.should_receive(:hours).and_return 55.55
+
+        expect(subject.worked_time).to eq 55.55
+      end
+    end
+  end
+
+  describe '#rate' do
+    subject do
+      described_class.new(hours: 90)
+    end
+
+    it 'should return calculate the rate' do
+      Date.stub(today: Date.new(2013, 10, 20))
+
+      expect(subject.rate).to eq 6.43
+    end
+  end
+
+  describe '#generate_data' do
+    subject do
+      described_class.new(hours: 90, goal_list: [160, 200])
+    end
+
+    it 'should return the generated data' do
+      Date.stub(today: Date.new(2013, 10, 20))
+
+      expect(subject.generate_data).to eq({
+        rows: [
+          {
+            goal: 160,
+            expected: 97.39,
+            average: 7.78
+          },
+          {
+            goal: 200,
+            expected: 121.74,
+            average: 12.22
+          }
+        ],
+        summary: {
+          total_time: 90.0,
+          rate: 6.43,
+          days_left: 9
+        }
+      })
+    end
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Goal::Report do
+  let(:data) do
+    {
+      rows: [
+        {
+          goal: 160,
+          expected: 97.39,
+          average: 7.78
+        },
+        {
+          goal: 200,
+          expected: 121.74,
+          average: 12.22
+        }
+      ],
+      summary: {
+        total_time: 90.0,
+        rate: 6.43,
+        days_left: 9
+      }
+    }
+  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
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Mateus Lorandi dos Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-freshbooks
@@ -83,13 +83,14 @@ files:
 - bin/goal
 - goal.gemspec
 - lib/goal.rb
-- lib/goal/base.rb
 - lib/goal/freshbooks_calculator.rb
 - lib/goal/hour_calculator.rb
+- lib/goal/report.rb
 - lib/goal/version.rb
-- spec/base_spec.rb
+- spec/calculator_spec.rb
 - spec/freshbooks_calculator_spec.rb
 - spec/hour_calculator_spec.rb
+- spec/report_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/comogo/goal
 licenses:
@@ -111,9 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Keep track of your hour goals
 test_files: []
-has_rdoc: 

data/lib/goal/base.rb

@@ -1,32 +0,0 @@
-module Goal
-  class Base
-    def initialize
-      @calculator = HourCalculator.new
-    end
-
-    def worked_time(username, token)
-      FreshbooksCalculator.new(username, token).hours
-    end
-
-    def calculate_goal(goal)
-      calculator.estimated_for(goal)
-    end
-
-    def calculate_goals(goals)
-      calculated_goals = []
-
-      goals.each do |goal|
-        calculated_goals.push({
-          goal: goal,
-          expected: calculate_goal(goal)
-        })
-      end
-
-      calculated_goals
-    end
-
-    private
-
-    attr_reader :calculator
-  end
-end

data/spec/base_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Goal::Base do
-  describe '#worked_time' do
-    it 'should get the worked_time from freshbooks' do
-      freshbooks_instance = double(:freshbooks_instance)
-
-      Goal::FreshbooksCalculator.should_receive(:new).with('username', 'token').and_return(freshbooks_instance)
-      freshbooks_instance.should_receive(:hours).and_return(30)
-
-      expect(subject.worked_time('username', 'token')).to eq 30
-    end
-  end
-
-  describe '#calculate_goal' do
-    it 'should calculate goal using the hour calculator' do
-      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(200).and_return 10
-
-      expect(subject.calculate_goal(200)).to eq 10
-    end
-  end
-
-  describe '#calculate_goals' do
-    it 'should calculate goals using the hour calculator' do
-      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(160).and_return 10
-      Goal::HourCalculator.any_instance.should_receive(:estimated_for).with(200).and_return 20
-
-      expect(subject.calculate_goals([160, 200])).to eq([
-        {
-          goal: 160,
-          expected: 10
-        },
-        {
-          goal: 200,
-          expected: 20
-        }
-      ])
-    end
-  end
-end