tempest-time 0.5.0

data/lib/tempest_time/commands/list.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../helpers/time_helper'
+require_relative '../api/tempo_api/requests/list_worklogs'
+
+module TempestTime
+  module Commands
+    class List < TempestTime::Command
+      include TempestTime::Helpers::TimeHelper
+
+      def initialize(date, options)
+        @date = date
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        dates = parsed_date_input(@date)
+        dates.each do |start_date|
+          request = TempoAPI::Requests::ListWorklogs.new(
+            start_date,
+            @options['end_date'],
+            @options[:user]
+          )
+          request.send_request
+          puts "\nHere are your logs for #{formatted_date_range(start_date, @options['end_date'])}:\n"
+          puts request.response_message
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/report.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../settings/teams'
+require_relative '../services/generate_report'
+require_relative '../helpers/time_helper'
+
+module TempestTime
+  module Commands
+    class Report < TempestTime::Command
+      include TempestTime::Helpers::TimeHelper
+
+      def initialize(users, options)
+        @users = users || []
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        team = @options[:team]
+        @users = prompt_for_input if @users.empty? && team.nil?
+        @users.push(TempestTime::Settings::Teams.members(team)) if team
+        abort('No users specified.') unless @users.any?
+        with_spinner('Generating report...') do |spinner|
+          table = render_table
+          spinner.stop(pastel.green('Your report is ready!'))
+          date_range = "#{formatted_date(report.start_date)}"\
+                       ' to '\
+                       "#{formatted_date(report.end_date)}"
+          prompt.say("\nReport for #{pastel.green(date_range)}")
+          puts table
+        end
+      end
+
+      private
+
+      def report
+        @report ||= TempestTime::Services::GenerateReport.new(
+          @users.flatten, @options[:week]
+        )
+      end
+
+      def prompt_for_input
+        type = prompt.select(
+          "Generate a report for a #{pastel.green('user')} or #{pastel.green('team')}?",
+          ['User', 'Team']
+        )
+        return [prompt.ask('Which user would you like to analyse?')] if type == 'User'
+        teams = TempestTime::Settings::Teams
+        abort('You have no teams yet! Go make one! (tempest teams add)') unless teams.keys.any?
+        team = prompt.select(
+          "Which #{pastel.green('team')} would you like to analyse?",
+          teams.keys
+        )
+        teams.members(team)
+      end
+
+      def table_headings
+        %w[User COMP% UTIL%] + report.projects
+      end
+
+      def render_table
+        t = table.new(
+          table_headings,
+          report.reports.map { |r| row(r) } + [row(report.aggregate)]
+        )
+
+        t.render(:ascii, padding: [0, 1])
+      end
+
+      def row(r)
+        row = [
+          r.user,
+          r.total_compliance_percentage.round(2),
+          r.utilization_percentage.round(2)
+        ]
+        report.projects.each do |project|
+          row.push(r.project_compliance_percentages.to_h.fetch(project, 0).round(2))
+        end
+        row
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/submit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../api/tempo_api/requests/submit_timesheet'
+
+module TempestTime
+  module Commands
+    class Submit < TempestTime::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        # Command logic goes here ...
+        reviewer = prompt.ask('Who should review this timesheet? (username)')
+        message = "Submit this week's timesheet to " + pastel.green(reviewer) + '?'
+        abort unless prompt.yes?(message)
+        abort unless prompt.yes?('Are you sure? No edits can be made once submitted!')
+
+        with_success_fail_spinner("Submitting this week's timesheet...") do
+          TempoAPI::Requests::SubmitTimesheet.new(reviewer).send_request
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/teams.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module TempestTime
+  module Commands
+    class Teams < Thor
+
+      namespace :config
+
+      desc 'add', 'Add a team.'
+      def add(*)
+        require_relative 'teams/add'
+        TempestTime::Commands::Teams::Add.new(options).execute
+      end
+
+      desc 'edit', 'Edit a team.'
+      def edit(*)
+        require_relative 'teams/edit'
+        TempestTime::Commands::Teams::Edit.new(options).execute
+      end
+
+      desc 'delete', 'Edit a team.'
+      def delete(*)
+        require_relative 'teams/delete'
+        TempestTime::Commands::Teams::Delete.new(options).execute
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/teams/add.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/teams'
+
+module TempestTime
+  module Commands
+    class Teams
+      class Add < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          teams = TempestTime::Settings::Teams
+          message =
+            'Please enter ' + pastel.green('the members') + " of this team. "\
+            '(Comma-separated, e.g. jkirk, jpicard, bsisko, kjaneway) '
+          members = prompt.ask(message) do |q|
+            q.convert ->(input) { input.split(/,\s*/) }
+          end
+          name = prompt.ask('Please enter ' + pastel.green('the name') + ' of your new team.')
+          teams.update(name, members)
+          prompt.say(pastel.green('Success!'))
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/teams/delete.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/teams'
+
+module TempestTime
+  module Commands
+    class Teams
+      class Delete < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          teams = TempestTime::Settings::Teams
+          abort("There are no teams to delete!") unless teams.keys.any?
+          team = prompt.select(
+            "Which #{pastel.green('team')} would you like to delete?",
+            teams.keys
+          )
+          if prompt.yes?(pastel.red("Are you sure you want to delete #{team}?"))
+            teams.delete(team)
+            prompt.say("Successfully #{pastel.red("deleted #{team}!")}")
+          else
+            abort('Nothing was deleted.')
+          end
+          execute if prompt.yes?('Delete another team?')
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/teams/edit.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../settings/teams'
+
+module TempestTime
+  module Commands
+    class Teams
+      class Edit < TempestTime::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          teams = TempestTime::Settings::Teams
+          abort("There are no teams to edit!") unless teams.keys.any?
+          team = prompt.select(
+            "Which #{pastel.green('team')} would you like to edit?",
+            teams.keys
+          )
+
+          members = teams.members(team)
+          member = prompt.select(
+            "Which #{pastel.green('member')} would you like to edit?",
+            members + ['Add New Member']
+          )
+
+          replace = prompt.ask(
+            "Enter the #{pastel.green('new name')}. "\
+            "Leave blank to #{pastel.red('delete')}."
+          )
+
+          members.delete(member)
+
+          if replace.nil?
+            teams.update(team, members)
+            prompt.say("Deleted #{pastel.red(member)}!")
+          else
+            members.push(replace)
+            teams.update(team, members)
+            prompt.say("Added #{pastel.green(replace)}")
+          end
+
+          execute if prompt.yes?('Keep editing?')
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/commands/track.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../helpers/time_helper'
+
+require_relative '../api/tempo_api/requests/create_worklog'
+require_relative '../api/jira_api/requests/get_issue'
+
+module TempestTime
+  module Commands
+    class Track < TempestTime::Command
+      include TempestTime::Helpers::TimeHelper
+
+      def initialize(time, tickets, options)
+        @time = time
+        @tickets = tickets
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        time = @options[:split] ? parsed_time(@time) / @tickets.count : parsed_time(@time)
+        tickets = @tickets.any? ? @tickets.map(&:upcase) : [automatic_ticket]
+
+        prompt_message = "Track #{formatted_time(time)}, "\
+                         "#{billability(@options)}, "\
+                         "to #{tickets.join(', ')}?"
+        abort unless prompt.yes?(prompt_message, convert: :bool)
+
+        tickets.each do |ticket|
+          track_time(time, @options.merge(ticket: ticket))
+        end
+      end
+
+      private
+
+      def track_time(time, options)
+        message = "Tracking #{formatted_time(time)} to #{options['ticket']}..."
+        with_success_fail_spinner(message) do
+          options['remaining'] = if options['remaining'].nil?
+                                 remaining_estimate(options['ticket'], time)
+                               else
+                                 parsed_time(options['remaining'])
+                               end
+          TempoAPI::Requests::CreateWorklog.new(time, options).send_request
+        end
+      end
+
+      def remaining_estimate(ticket, time)
+        request = JiraAPI::Requests::GetIssue.new(ticket)
+        request.send_request
+        if request.response.failure?
+          abort("There was an issue getting this Jira ticket.\n"\
+                'Please check the ticket number and your credentials.')
+        end
+        remaining = request.response.issue.remaining_estimate || 0
+        remaining > time ? remaining - time : 0
+      end
+
+      def automatic_ticket
+        ticket = /[A-Z]+-\d+/.match(Git.open(Dir.pwd).current_branch)
+        abort('Ticket not found for this branch. Please specify.') unless ticket
+        ticket.to_s
+      end
+
+      def billability(options)
+        options['billable'] ? 'billed' : 'non-billed'
+      end
+    end
+  end
+end

data/lib/tempest_time/helpers/formatting_helper.rb

@@ -0,0 +1,16 @@
+module TempestTime
+  module Helpers
+    module FormattingHelper
+      def braced(text, length = text.length)
+        padding_amount = length - text.length
+        front_padding = ' ' * (padding_amount / 2.0).ceil
+        back_padding = ' ' * (padding_amount / 2.0).floor
+        '[' + front_padding + text + back_padding + ']'
+      end
+
+      def with_percent_sign(decimal)
+        "#{(decimal * 100).to_i}%"
+      end
+    end
+  end
+end

data/lib/tempest_time/helpers/time_helper.rb

@@ -0,0 +1,63 @@
+require 'date'
+
+module TempestTime
+  module Helpers
+    module TimeHelper
+      def parsed_time(time)
+        # Returns seconds.
+        return time if time.is_a?(Integer)
+
+        if /^\d*\.{0,1}\d{1,2}h$/.match(time)
+          return (time.chomp('h').to_f * 60 * 60).to_i
+        elsif /^\d+m$/.match(time)
+          return time.chomp('m').to_i * 60
+        end
+
+        abort("Please provide time in the correct format. e.g. 0.5h, .5h, 30m")
+      end
+
+      def formatted_time(seconds)
+        seconds < 3600 ? "#{seconds / 60} minutes" : "#{(seconds / 3600.to_f).round(2)} hours"
+      end
+
+      def formatted_date_range(start_date, end_date)
+        return formatted_date(start_date) if end_date.nil? || end_date.empty?
+        "#{formatted_date(start_date)} - #{formatted_date(end_date)}"
+      end
+
+      def formatted_date(date)
+        "#{Date::DAYNAMES[date.wday]}, #{Date::MONTHNAMES[date.month]} #{date.day}"
+      end
+
+      def parsed_date_input(date_input)
+        case date_input
+        when 'today', nil
+          [Date.today]
+        when 'yesterday'
+          [Date.today.prev_day]
+        when 'week'
+          this_week
+        else
+          [Date.parse(date_input)]
+        end
+      end
+
+      def beginning_of_this_week
+        Date.today - Date.today.wday
+      end
+
+      def beginning_of_week(week_number)
+        this_week_number = (Date.today + 1).cweek # Add one so weeks begin on Sunday.
+        return false unless week_number <= this_week_number
+        days_in_the_past = (this_week_number - week_number) * 7
+        beginning_of_this_week - days_in_the_past
+      end
+
+      def this_week
+        (0..6).map do |n|
+          beginning_of_this_week + n
+        end
+      end
+    end
+  end
+end

data/lib/tempest_time/models/report.rb

@@ -0,0 +1,58 @@
+require_relative '../helpers/formatting_helper'
+
+module TempestTime
+  module Models
+    class Report
+      include TempestTime::Helpers::FormattingHelper
+      EXPECTED_SECONDS = (37.5 * 60 * 60).to_i.freeze
+      INTERNAL_PROJECT = 'BCIT'.freeze
+
+      attr_reader :user, :worklogs, :number_of_users
+
+      def initialize(user, worklogs, number_of_users = 1)
+        @user = user
+        @worklogs = worklogs
+        @number_of_users = number_of_users
+      end
+
+      def project_total_times
+        @project_total_times ||= project_worklogs.map do |project, worklogs|
+          [project, time_logged_seconds(worklogs)]
+        end.to_h
+      end
+
+      def compliance_percentage(time)
+        (time.to_f / (EXPECTED_SECONDS * number_of_users)).round(2)
+      end
+
+      def project_compliance_percentages
+        @project_compliance_percentages ||= project_total_times.map do |project, time|
+          [project, compliance_percentage(time)]
+        end.to_h.sort
+      end
+
+      def total_compliance_percentage
+        @total_compliance_percentage ||= compliance_percentage(time_logged_seconds(worklogs))
+      end
+
+      def utilization_percentage
+        @utilization_percentage ||= project_compliance_percentages.inject(0) do |memo, (project, percentage)|
+          memo += percentage unless project == INTERNAL_PROJECT
+          memo
+        end
+      end
+
+      def time_logged_seconds(logs)
+        logs.flat_map(&:seconds).reduce(:+)
+      end
+
+      def project_worklogs
+        @project_worklogs ||= worklogs.group_by(&:project)
+      end
+
+      def projects
+        @projects ||= project_worklogs.keys.sort
+      end
+    end
+  end
+end