twstats 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e126990ce8c73929882e7246c5a77cce582c46fd115b4241b71f12b17e1e6f6b
-  data.tar.gz: 9184395243e7c2b7305248e724027eca9c84cab170cc6b742bdb0a893e484b69
+  metadata.gz: a3332529ad2297075381d84b5deb01dd0bd0d70f87796fa13788da6be1476e54
+  data.tar.gz: 5d07d48ff3f08b8f093ee9b9167bead08559207bbfdc77a8cd0747ac893ae1b9
 SHA512:
-  metadata.gz: 97271cf581f7b696aa23be141ddc3800fe42089803ba999f32f74b0ef9e37bd0577bf55c5bf8ee4e81d1b5257e009725d20f7e9b96db33a2b6390a7d5c5c2cbc
-  data.tar.gz: 9fa944b7a95d245a9c285196893549b2d6f6f804406003d98ccac50878117160b345b31fbd07f13e8ce9473683ecf6fdc0ccc8d9d02dd66dcaaec222476a96fe
+  metadata.gz: a493425c5bb3b043f12c72f6426a92a63c3b9920fc4f092135830b1ee66d1f478f186099611cf18bef4bfc89415e375b9a3c9b32da6e6bd56a88c48c37e26530
+  data.tar.gz: c286353bf589221a812a994272cadb7b71750bbc5bfa1bcf82b44d0aab8de793ebcc3031f1f446a00b2e61d38c52423f8f0400b5c6ea6f9bc6279ed01bba41dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twstats (0.2.5)
+    twstats (0.3.0)
       descriptive-statistics (>= 2.2.0)
       rainbow (~> 3.0)
       tty-prompt (~> 0.17)

data/lib/twstats.rb

@@ -4,6 +4,7 @@ require_relative 'twstats/tw_log'
 require_relative 'twstats/csv_reader'
 require_relative 'twstats/descriptive_stats'
 require_relative 'twstats/timesheet_export'
+require_relative 'twstats/hourly_rate'
 require_relative 'twstats/runner'
 
 module Twstats
@@ -21,7 +22,8 @@ module Twstats
   ]
   MENU_CHOICES = [
       {name: 'Stats', value: :stats},
-      {name: 'TimeSheet', value: :billing},
+      {name: 'TimeSheet', value: :timesheet},
+      {name: 'Billing', value: :billing},
       {name: 'Weekly', value: :weekly},
       {name: 'Quit', value: :quit}
   ]

data/lib/twstats/csv_reader.rb

@@ -36,23 +36,23 @@ module Twstats
       billable = 0
       non_billable = 0
       case object
-        when :projects
-          billable = logs.select{|log| log.project == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-          non_billable = logs.select{|log| log.project == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-        when :tags
-          billable = logs.select{|log| log.tags.include?(element) && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-          non_billable = logs.select{|log| log.tags.include?(element) && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-        when :people
-          billable = logs.select{|log| log.who == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-          non_billable = logs.select{|log| log.who == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-        when :tasks
-          billable = logs.select{|log| log.task == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-          non_billable = logs.select{|log| log.task == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-        when :all
-          billable = logs.select{|log| log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-          non_billable = logs.select{|log| !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
-        else
-          return -99999
+      when :projects
+        billable = logs.select{|log| log.project == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+        non_billable = logs.select{|log| log.project == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+      when :tags
+        billable = logs.select{|log| log.tags.include?(element) && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+        non_billable = logs.select{|log| log.tags.include?(element) && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+      when :people
+        billable = logs.select{|log| log.who == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+        non_billable = logs.select{|log| log.who == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+      when :tasks
+        billable = logs.select{|log| log.task == element && log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+        non_billable = logs.select{|log| log.task == element && !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+      when :all
+        billable = logs.select{|log| log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+        non_billable = logs.select{|log| !log.billable}.inject(0){ |sum, l| sum + l.decimal_time}
+      else
+        return -99999
       end
       if filter_billable
         return [billable, non_billable]
@@ -66,18 +66,37 @@ module Twstats
       (sorted_logs[-1] - sorted_logs[0]).to_i <= 7
     end
 
-    def not_tagged_tasks
+    ## Filer the logs in the CSV by a given object when the element provided matches the object
+    def get_logs(object, element = nil)
+      case object
+      when :projects
+        logs.select{|log| log.project == element}
+      when :tags
+        logs.select{|log| log.tags.include?(element)}
+      when :people
+        logs.select{|log| log.who == element}
+      when :tasks
+        logs.select{|log| log.task == element}
+      when :all
+        logs
+      else
+        nil
+      end
+    end
+
+    def not_tagged_tasks(to_analize=nil)
+      to_analize = logs if to_analize.nil?
       total_time = 0
       list = []
-      logs.each do |log|
+      to_analize.each do |log|
         if log.tags.empty?
           list << log
           total_time += log.decimal_time
         end
       end
       {
-          total_time: total_time,
-          list: list
+        total_time: total_time,
+        list: list
       }
     end
   end

data/lib/twstats/descriptive_stats.rb

@@ -19,5 +19,13 @@ module Twstats
       end
       DescriptiveStatistics::Stats.new(time_per_task).mean
     end
+
+    def max
+      logs.map{|l| l.decimal_time}.max
+    end
+
+    def min
+      logs.map{|l| l.decimal_time}.min
+    end
   end
-end
+end

data/lib/twstats/hourly_rate.rb

@@ -0,0 +1,58 @@
+# This class parses the hourly rate for each employee found in the csv.
+# The first time it ask the user what the price is and saved it to a yml file with all the information needed
+# This information is retrieved
+require 'yaml'
+class HourlyRate
+
+  def initialize(csv)
+    # Read users from file
+    @config_file = "#{ENV['HOME']}/.twstats_users.yml"
+    @users = csv.people
+    @config = {}
+    if File.exists? @config_file
+      @config = YAML.load(File.read(@config_file))
+    end
+    # Set value of 0 to users that do not exist
+    csv.people.each do |user|
+      if @config[user].nil?
+        @config[user] = 0
+      end
+    end
+  end
+
+  def get_price(user,hours)
+    # Get a given price for a given user
+  end
+
+  def set_price(user,price)
+    @config[user] = price.round(2)
+  end
+
+  def save
+    file = File.new(@config_file,'w')
+    file.write YAML.dump(@config)
+    file.close
+  end
+
+  def get_billed_time(users_hours)
+    # It expects a hash with the amount of hours billed per user
+    users_hours.keys.inject(0) do |sum, user|
+      sum + @config[user]*users_hours[user]
+    end
+  end
+
+  def set_user_hourly_rate(prompt)
+    menu = @users.map{ |user| ["#{user} (#{@config[user].round(2)} €)", user]}.to_h
+    menu['Quit'] = -1
+    loop do
+      chosen = prompt.select 'What user you want to modify? Select Quit to finish.', menu
+      break if chosen == -1
+      price = prompt.ask "What is the hourly rate for #{chosen}?", convert: :float
+      puts price, chosen
+      @config[chosen] = price
+      menu = @users.map{ |user| ["#{user} (#{@config[user].round(2)} €)", user]}.to_h
+      menu['Quit'] = -1
+    end
+    save
+  end
+end

data/lib/twstats/runner.rb

@@ -14,19 +14,22 @@ module Twstats
       file = read_file file
       # Check if the file exists
       @csv = CSVReader.new(file)
+      @hourly_rate = HourlyRate.new(@csv)
       loop do
-        option = @prompt.select("Choose an option", Twstats::MENU_CHOICES, cycle: true)
+        option = @prompt.select('Choose an option', Twstats::MENU_CHOICES, cycle: true)
         case option
-          when :stats
-            show_stats_menu
-          when :billing
-            billing
-          when :weekly
-            show_weekly_report
-          when :quit
-            break
-          else
-            puts 'Option not recognized!'
+        when :stats
+          show_stats_menu
+        when :timesheet
+          timesheet
+        when :weekly
+          show_weekly_report
+        when :billing
+          billing
+        when :quit
+          break
+        else
+          puts 'Option not recognized!'
         end
       end
       @current = nil
@@ -35,13 +38,13 @@ module Twstats
     def read_file(file = nil)
       # Check if the file exsis
       unless file.nil?
-        if File.exists? file
+        if File.exist? file
           return file
         else
           file = @prompt.ask('The file you have supplied does not exsists. Try again or type .q to exit twstats.') do |input|
             input.modify :chomp
           end
-          if file == ".q"
+          if file == '.q'
             exit 0
           else
             read_file file
@@ -55,58 +58,88 @@ module Twstats
       read_file file
     end
 
-    def billing
+    def timesheet
       ## Takes care of using the current CSV file to be imported into timesheets.
       # Makes it easier to do it than manually going through all of them
       TimeSheetExport.new(@csv, @prompt).execute
     end
 
+    def billing
+      add_non_billable = @prompt.yes? 'Do you want to include non-billable time?'
+      @hourly_rate.set_user_hourly_rate(@prompt)
+      if @prompt.yes? 'Was it a closed quote?', default: true
+        quoted_price = @prompt.ask 'What was the quoted price for this project?', convert: :float
+      end
+      price = @hourly_rate.get_billed_time(user_hours_billed(add_non_billable))
+      puts ' - Billed amount '.bright.blue + ' | ' + price.round(2).to_s + ' € '
+      if quoted_price
+        diff = quoted_price - price
+        if diff >= 0
+          puts " - The project has a proffit of: #{diff.round(2)} €, #{(diff * 100 / quoted_price).round(2)}".bright.green
+        else
+          puts " - The project shows a loss: #{diff.round(2)} €, #{(diff * 100 / quoted_price).round(2)}%".bright.red
+        end
+        alltime = @csv.get_total_time(:all, nil, !add_non_billable)
+        flat_price = add_non_billable ? (alltime * 46).round(2) : (alltime[0] * 46).round(2)
+        puts alltime, flat_price
+        diff = quoted_price - flat_price
+        if diff >= 0
+          puts "The project is profitable using a flat rate of 46 €/hour by #{quoted_price - flat_price}".bright.green
+        else
+          puts "The project should have been quoted in #{flat_price} using the flat rate of 46 €/hour".bright.red
+        end
+      end
+    end
+
     def show_stats_menu
       loop do
-        option = @prompt.select("Select what time logging stats you want to see", Twstats::STATS_MENU_CHOICES, cycle: true)
+        option = @prompt.select('Select what time logging stats you want to see', Twstats::STATS_MENU_CHOICES, cycle: true)
         case option
-          when :projects, :people, :tags, :tasks
-            show_stats option
-          when :fullstats
-            show_full_stats
-          when :back
-            return
-          else
-            puts 'Option not recognized'
+        when :projects, :people, :tags, :tasks
+          show_stats option
+        when :fullstats
+          show_full_stats
+        when :back
+          return
+        else
+          puts 'Option not recognized'
         end
       end
     end
 
     def show_stats(obj, filter_billable = nil)
-      puts "Time logged vs #{obj.to_s}:" if filter_billable.nil?
+      puts "Time logged vs #{obj}:" if filter_billable.nil?
       toshow = {}
       max = 0
       filter_billable ||= @prompt.yes?('Do you want to filter billable and non-billable time?', default: true)
+      do_all = @prompt.yes? 'Do you want to analyze all the elements?', default: true
       objects = @csv.send(obj)
-      if objects.size > 1
-        list = @prompt.multi_select "Which ones of the following do you want to see? Select or unselect them with the space key\n" do |menu|
+      list = objects
+      if objects.size > 1 && !do_all
+        list = @prompt.multi_select "Which ones of the following do you want to see? Select or unselect them with the space key\n", filter: true do |menu|
           menu.choices objects
-          menu.default *[*1..objects.size]
         end
       end
+      selected_logs = []
       list.each do |element|
         toshow[element] = @csv.get_total_time(obj, element, filter_billable)
         max = element.size if max < element.size
+        selected_logs += @csv.get_logs(obj, element)
       end
-      toshow.sort_by{ |k,v| v}.reverse.to_h.each do |k,v|
+      toshow.sort_by { |_k, v| v }.reverse.to_h.each do |k, v|
         if filter_billable
           if v[0].zero?
-            puts " - #{k.ljust(max,' ').bright.blue} | #{"Non-billable:".bright} #{v[1].round(2)}"# unless v[1].zero?
+            puts " - #{k.ljust(max, ' ').bright.blue} | #{'Non-billable:'.bright} #{v[1].round(2)}" # unless v[1].zero?
           else
-            puts " - #{k.ljust(max,' ').bright.blue} | #{"Billable:".ljust(13," ").bright} #{v[0].round(2)} (#{((v[0]/(v[0]+v[1]))*100).round(2)} %)"
-            puts "   #{"".ljust(max,' ').bright.blue} | #{"Non-billable:".bright} #{v[1].round(2)}" unless v[1].zero?
+            puts " - #{k.ljust(max, ' ').bright.blue} | #{'Billable:'.ljust(13, ' ').bright} #{v[0].round(2)} (#{((v[0] / (v[0] + v[1])) * 100).round(2)} %)"
+            puts "   #{''.ljust(max, ' ').bright.blue} | #{'Non-billable:'.bright} #{v[1].round(2)}" unless v[1].zero?
           end
         else
-          puts " - #{k.ljust(max,' ').bright.blue} | #{v.round(2)}" unless v.zero?
+          puts " - #{k.ljust(max, ' ').bright.blue} | #{v.round(2)}" unless v.zero?
         end
       end
-      show_not_tagged_section false
-      # Further filtering
+      show_not_tagged_section selected_logs, false
+      show_metrics selected_logs
     end
 
     def ranking_from_not_tagged(list)
@@ -115,91 +148,83 @@ module Twstats
         result[log.who] ||= 0
         result[log.who] += log.decimal_time
       end
-      result.sort_by{|k,v| v}.reverse.to_h
+      result.sort_by { |_k, v| v }.reverse.to_h
     end
 
     def print_table(log_list)
-      167.times{print '-'}
-      puts "\n|"+'Date'.center(12,' ').bright+'|'+'Time'.center(6,' ').bright+'|'+'Who'.center(20, ' ').bright+
-               '|'+'Description'.center(78,' ').bright+'|'+'Tags'.center(24,' ').bright+'|'+'Task'.center(20, ' ').bright+'|'
-      167.times{print '-'}
-      puts ""
+      167.times { print '-' }
+      puts "\n|" + 'Date'.center(12, ' ').bright + '|' + 'Time'.center(6, ' ').bright + '|' + 'Who'.center(20, ' ').bright +
+           '|' + 'Description'.center(78, ' ').bright + '|' + 'Tags'.center(24, ' ').bright + '|' + 'Task'.center(20, ' ').bright + '|'
+      167.times { print '-' }
+      puts ''
       log_list.each do |log|
         puts table_line(log)
       end
-      167.times{print '-'}
-      puts ""
+      167.times { print '-' }
+      puts ''
     end
 
     def table_line(log)
-      "|"+"#{log.date.strftime('%d/%m/%Y')}".truncate(10).center(12,' ')+
-          '|'+"#{log.decimal_time.round(2)}".truncate(4).center(6,' ')+
-          '|'+"#{log.who}".truncate(18).center(20, ' ')+
-          '|'+"#{log.description}".truncate(76).ljust(78,' ')+
-          '|'+"#{log.tags.join(', ')}".truncate(22).center(24,' ')+
-          '|'+"#{log.task}".truncate(18).center(20, ' ')+'|'
+      '|' + log.date.strftime('%d/%m/%Y').to_s.truncate(10).center(12, ' ') +
+        '|' + log.decimal_time.round(2).to_s.truncate(4).center(6, ' ') +
+        '|' + log.who.to_s.truncate(18).center(20, ' ') +
+        '|' + log.description.to_s.truncate(76).ljust(78, ' ').tr("\n", ' ') +
+        '|' + log.tags.join(', ').to_s.truncate(22).center(24, ' ') +
+        '|' + log.task.to_s.truncate(18).center(20, ' ') + '|'
     end
 
     def show_full_stats
       billable, non_billable = @csv.get_total_time(:all, nil, true)
-      to_bill = @prompt.yes? 'Do you want to calculate the billed amount?'
-      if to_bill
-        amount_per_hour = @prompt.ask 'What is the hourly rate?', default: 46
-        if @prompt.yes? 'Was it a closed quote?', default: true
-          quoted_price = @prompt.ask 'What was the quoted price for this project?', convert: :float
-        end
-      end
-      section "Total time spent"
-      puts " - Billable      ".bright.blue + " | " + billable.round(2).to_s
-      puts " - Non-billable  ".bright.blue + " | " + non_billable.round(2).to_s
-      if to_bill
-        price = billable*amount_per_hour
-        puts " - Billed amount ".bright.blue + " | " + price.round(2).to_s + " € "
-        if quoted_price
-          diff = quoted_price-price
-          if diff >= 0
-            puts " - Project over estimated: #{diff.round(2)} €, #{diff/price}".bright.green
-          else diff < 0
-            puts " - Project under estimated: #{diff.round(2)} €, #{(diff*100/price).round(2)}%".bright.red
-          end
-        end
-      end
-      section "People involved"
+      section 'Total time spent'
+      puts ' - Billable      '.bright.blue + ' | ' + billable.round(2).to_s
+      puts ' - Non-billable  '.bright.blue + ' | ' + non_billable.round(2).to_s
+      section 'People involved'
       show_stats :people, true
-      section "Tags used"
+      section 'Tags used'
       show_stats :tags, true
-      show_not_tagged_section(true)
-      section "Usefull metrics"
+      show_not_tagged_section(@csv.logs, true)
       show_metrics
     end
 
-    def show_not_tagged_section(table)
-      not_tagged = @csv.not_tagged_tasks
+    def user_hours_billed(nonb)
+      uh = {}
+      @csv.people.each do |user|
+        val = @csv.get_total_time :people, user, !nonb
+        uh[user] = val
+        uh[user] = val[0] unless nonb
+      end
+      uh
+    end
+
+    def show_not_tagged_section(logs, table)
+      not_tagged = @csv.not_tagged_tasks logs
       unless not_tagged[:list].empty?
-        section("Logs not tagged in this report")
+        section('Logs not tagged in this report')
         puts "A total of #{not_tagged[:list].size} logs have not been tagged:"
         puts " - A total time of #{not_tagged[:total_time]} is not tagged properly."
-        puts " - Impact by employee: "
+        puts ' - Impact by employee: '
         ranking_from_not_tagged(not_tagged).each do |user, time|
-          puts "\t - #{user.ljust(30,' ').bright.blue} | #{time}"
+          puts "\t - #{user.ljust(30, ' ').bright.blue} | #{time}"
         end
         table = @prompt.yes?('Do you want to see what tasks have not been tagged?', default: true) if table.nil?
-        if table
-          print_table not_tagged[:list]
-        end
+        print_table not_tagged[:list] if table
       end
     end
 
     def section(text)
-      puts ""
-      puts (" "+text+" ").center(70,"*").bright.orange
+      puts ''
+      puts (' ' + text + ' ').center(70, '*').bright.orange
     end
 
-    def show_metrics
-      stats = LogStats.new(@csv.logs)
-      puts " - Mean time logged:   ".bright.blue + stats.mean_log_time.round(2).to_s
-      puts " - Mean time per task: ".bright.blue + stats.mean_task_time(@csv.tasks).round(2).to_s
-      puts "     - With a total of #{@csv.tasks.size} tasks"
+    def show_metrics(logs = nil)
+      logs = @csv.logs if logs.nil?
+      stats = LogStats.new(logs)
+      section 'Usefull metrics for the selected logs'
+      puts "A total of #{logs.size} time logs have been analyzed."
+      puts ' - Mean time logged:   '.bright.blue + stats.mean_log_time.round(2).to_s
+      puts ' - Mean time per task: '.bright.blue + stats.mean_task_time(@csv.tasks).round(2).to_s
+      puts ' - Maximum time logged: '.bright.blue + stats.max.to_s
+      puts ' - Minimum time logged: '.bright.blue + stats.min.to_s
     end
 
     def show_weekly_report
@@ -213,14 +238,13 @@ module Twstats
       info = {}
       @csv.people.each do |person|
         billable, non_billable = @csv.get_total_time(:people, person, true)
-        info[person] = {rate: billable * 100 / hours,
-                        not_billed: hours - billable - non_billable,
-                        billable: billable,
-                        non_billable: non_billable
-        }
-      end
-      info.sort_by{|x,v| v[:rate] }.reverse.each do |person, data|
-        puts " - " + person.bright.blue
+        info[person] = { rate: billable * 100 / hours,
+                         not_billed: hours - billable - non_billable,
+                         billable: billable,
+                         non_billable: non_billable }
+      end
+      info.sort_by { |_x, v| v[:rate] }.reverse_each do |person, data|
+        puts ' - ' + person.bright.blue
         puts "\tBillable time: ".ljust(20, ' ').bright + data[:billable].round(2).to_s
         puts "\tBillable rate: ".ljust(20, ' ').bright + data[:rate].round(2).to_s + ' % '
         puts "\tNot logged time: ".ljust(20, ' ').bright + data[:not_billed].round(2).to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twstats
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - J.P. Araque
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - lib/twstats/csv_reader.rb
 - lib/twstats/descriptive_stats.rb
 - lib/twstats/extensions.rb
+- lib/twstats/hourly_rate.rb
 - lib/twstats/runner.rb
 - lib/twstats/timesheet_export.rb
 - lib/twstats/tw_log.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Read a csv file generate by Teamwork to quickly get some stats from time