twstats 0.1.4 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c03859f83739b7704e23e9df4faba575ea6f3aa6
-  data.tar.gz: 5906375e59625f9a5ffef39dbd8905325e2ea4f4
+SHA256:
+  metadata.gz: b03a403d2eac6f0356f6e8bad78c073c93565139101566472b67d1a2901c0368
+  data.tar.gz: 44e5e4ae4cd5eff7e937882fdf01dcddb12d3130a2427ee0ea08cee0a3ed8a1e
 SHA512:
-  metadata.gz: 3a6d20cc0fe85c57ad9872e33f16237d54440725cbed8e6cc17dc155a090e96cdf970b2a56dab224e5fc403275872bb470e34128a39747ad7b3a622f3e6667ef
-  data.tar.gz: 7d25b85fb90cfc3da98763eca74f47c4f3d6377fab7075e2faf3be86912e7000c6ce585797bc5155ef9e73f555e5ee0196f198de94de18ae4b619ec4f63ee287
+  metadata.gz: f97828091ec24a7edc400dbf79a82ff4861ea9b17ee4cc937c2709c1fde0c1fae919534c1b89f39efcf22e31062dc37ea0c306e1e9f3f82dac1ef6854af7acff
+  data.tar.gz: f7aac1d4b1569fe79b5218601f59305f2b73409281f1cdeafd7eaa06c89b9ed28200d5913d915b779800cbd9aa537110509db078a41011fb72593af128ae2eff

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    twstats (0)
+    twstats (0.1.4)
+      rainbow (~> 3.0)
       tty-prompt (~> 0.17)
 
 GEM
@@ -14,6 +15,7 @@ GEM
     pastel (0.7.2)
       equatable (~> 0.5.0)
       tty-color (~> 0.4.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)

data/lib/twstats.rb

@@ -13,9 +13,8 @@ module Twstats
       {name: 'Projects', value: 0},
       {name: 'People', value: 1},
       {name: 'Tags', value: 2},
-      {name: 'Billable vs non-villable', value: 3},
-      {name: 'Full stats', value: 4},
-      {name: 'Back', value: 5}
+      {name: 'Full stats', value: 3},
+      {name: 'Back', value: 4}
   ]
   MENU_CHOICES = [
       {name: 'Stats', value: 0},

data/lib/twstats/csv_reader.rb

@@ -29,19 +29,45 @@ module Twstats
       @logs << log
     end
 
-    def get_total_time(object, element)
+    def mean_time
+      logs.inject(0) {|sum, log| sum + log.decimal_time }.to_f/logs.size
+    end
+
+    def mean_time_per_task
+      time_per_task = []
+      tasks.each do |task|
+        time_per_task << logs.select{|ll| ll.task == task}.inject(0){|sum, ll| sum + ll.decimal_time}
+      end
+      time_per_task.inject(0){|sum, x| sum + x}/time_per_task.size
+    end
+
+    def get_total_time(object, element, filter_billable)
+      billable = 0
+      non_billable = 0
       case object
         when :projects
-          logs.select{|log| log.project == element}.inject(0){ |sum, l| sum + l.decimal_time}
+          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
-          logs.select{|log| log.tags.include?(element)}.inject(0){ |sum, l| sum + l.decimal_time}
+          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
-          logs.select{|log| log.who == element}.inject(0){ |sum, l| sum + l.decimal_time}
+          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
-          logs.select{|log| log.task == element}.inject(0){ |sum, l| sum + l.decimal_time}
+          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
-          -99999
+          return -99999
+      end
+      if filter_billable
+        return billable, non_billable
+      else
+        return billable + non_billable
       end
     end
   end
-end
+end

data/lib/twstats/runner.rb

@@ -1,20 +1,22 @@
 require 'tty-prompt'
+require 'rainbow/refinement'
+using Rainbow
 
 require_relative 'csv_reader'
 
 module Twstats
   class Runner
-    def initialize
+    def initialize(file = nil)
       # Load interactive console
       @prompt = TTY::Prompt.new
-      puts WELLCOME_MESSAGE
+      puts WELLCOME_MESSAGE.bright
       # Ask for the csv file
-      file = @prompt.ask('Specify the CSV file from a Teamwork time log export', default: 'exportTimeLog.csv') do |input|
+      file ||= @prompt.ask('Specify the CSV file from a Teamwork time log export', default: 'exportTimeLog.csv') do |input|
         input.modify :chomp
       end
       @csv = CSVReader.new(file)
       loop do
-        option = @prompt.select("Choose an option", Twstats::MENU_CHOICES)
+        option = @prompt.select("Choose an option", Twstats::MENU_CHOICES, cycle: true)
         case option
           when 0
             show_stats_menu
@@ -30,7 +32,7 @@ module Twstats
 
     def show_stats_menu
       loop do
-        option = @prompt.select("Select what time logging stats you want to see", Twstats::STATS_MENU_CHOICES)
+        option = @prompt.select("Select what time logging stats you want to see", Twstats::STATS_MENU_CHOICES, cycle: true)
         case option
           when 0
             show_stats :projects
@@ -39,10 +41,8 @@ module Twstats
           when 2
             show_stats :tags
           when 3
-            show_bil_vs_non_stats
-          when 4
             show_full_stats
-          when 5
+          when 4
             return
           else
             puts 'Option not recognized'
@@ -50,16 +50,22 @@ module Twstats
       end
     end
 
-    def show_stats(obj)
-      puts "Time logged vs #{obj.to_s}:"
+    def show_stats(obj, filter_billable = nil)
+      puts "Time logged vs #{obj.to_s}:" if filter_billable.nil?
       toshow = {}
       max = 0
+      filter_billable ||= @prompt.yes?('Do you want to filter billable and non-billable time?', default: true)
       @csv.send(obj).each do |element|
-        toshow[element] = @csv.get_total_time(obj, element).round(2)
+        toshow[element] = @csv.get_total_time(obj, element, filter_billable)
         max = element.size if max < element.size
       end
       toshow.sort_by{ |k,v| v}.reverse.to_h.each do |k,v|
-        puts " - #{k.ljust(max,' ')} -> #{v}"
+        if filter_billable
+          puts " - #{k.ljust(max,' ').bright.blue} | #{"Billable:".ljust(13," ").bright} #{v[0].round(2)} (#{((v[0]/(v[0]+v[1]))*100).round(2)} %)" unless v[0].zero?
+          puts "   #{"".ljust(max,' ').bright.blue} | #{"Non-billable:".bright} #{v[1].round(2)}" unless v[1].zero?
+        else
+          puts " - #{k.ljust(max,' ').bright.blue} | #{v.round(2)}" unless v.zero?
+        end
       end
     end
 
@@ -67,5 +73,36 @@ module Twstats
 
     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 the amount billed per hour?', default: 46
+      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
+        puts " - Billed amount ".bright.blue + " | " + (billable*amount_per_hour).round(2).to_s + " € "
+      end
+      section "People involved"
+      show_stats :people, true
+      section "Tags used"
+      show_stats :tags, true
+      section "Usefull metrics"
+      show_metrics
+    end
+
+    def section(text)
+      puts ""
+      puts (" "+text+" ").center(70,"*").bright
+    end
+
+    def show_metrics
+      mean = @csv.logs.inject(0) {|sum, log| sum + log.decimal_time }.to_f/@csv.logs.size
+      mean_per_task = @csv.mean_time_per_task
+      puts " - Mean time logged:   ".bright.blue + mean.round(2).to_s
+      puts " - Mean time per task: ".bright.blue + mean_per_task.round(2).to_s
+    end
   end
-end
+end

data/lib/twstats/tw_log.rb

@@ -8,6 +8,7 @@ module Twstats
     attr_reader :tags
     attr_reader :project
     attr_reader :task
+    attr_reader :billable
 
 
     # Class use to store the information needed form a given log
@@ -20,7 +21,7 @@ module Twstats
       @tags = row["Tags"].split(',')
       @project = row["Project"]
       @task = row["Task"]
-      @billable = row["Is it Billable?"]
+      @billable = !row["Is it Billable?"].to_i.zero?
     end
   end
-end
+end

data/twstats.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_runtime_dependency "tty-prompt", "~> 0.17"
+  spec.add_runtime_dependency "rainbow", "~> 3.0"
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '~> 2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twstats
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: '0.2'
 platform: ruby
 authors:
 - J.P. Araque
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Teamwork allows to log time for all tasks within a project but the stats
   capabilities do not allow for a quick overview of time loggin stats. TWStats produces
   useful stats from a CSV file exported from Teamwork
@@ -107,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -115,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Read a csv file generate by Teamwork to quickly get some stats from time