work_hours_calculator 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0baff1626d9ecb657e068cc2363518939f510b3980d77ba15f011381cbad270
-  data.tar.gz: 8221eaa1ec3c962962731868b9a980e852159e5954ef9c7fb49576d91b17f37f
+  metadata.gz: d9ea0396592df2aaeb627a551ad5483b9d30987af8a3d89056da518e3f9a5958
+  data.tar.gz: 88934a23c56ae29730857b91224132152c3a6a6aea5b3ffc59c25cbd48799991
 SHA512:
-  metadata.gz: 8fb1f9bb9bc8f161456a068fd5e4ffe2342bfadfa0e9c39013c3718670123431356ab9ebb7d1ffd1c3e9d3b8bf41a78826be4ebdab0865f89b0f841bd3362ebf
-  data.tar.gz: 5a2651adb63bb57b03855ab2e41274cd32acd649616232fe122d86d4487054e86ee9906992895186cbcee10aae6d8b550b9cad3a40620628167fe3ae796eaf57
+  metadata.gz: a72b717b72205f19a76bdeaac0ce7ab5a176f8b7588709a922491a19cc5e91531ad92c6116ac7fbb41c7819af285a4cd7b828a7ce566b367c7a1172671295ea1
+  data.tar.gz: 97691b81ce8fad9198d49fd64db685fb307fb98d39258320014054a76861cf1e4ca804168ff34fdf33c925300a63cecef70dd1bceeea5931c747a56b98122fe3

data/README.md

@@ -12,6 +12,7 @@ This is a Ruby command-line tool for calculating the total work hours, break hou
 - Return net work hours after subtracting break times.
 - Return net break hours.
 - Support for csv import or export.
+- Log your work hours for the day.
 
 ## Installation
 
@@ -25,6 +26,14 @@ To calculate your work hours, run the following command:
 work_calculator -s "9:30:00 AM" -e "7:00:00 PM" -b "12:49:00 PM-1:26:00 PM,3:42:00 PM-4:35:00 PM"
 ```
 
+### Expected Output
+```bash
+Total Work Decimal Hours: 9.5 hours
+Total Break Decimal Hours: 1.5 hours
+Total Break Hours: 1:30 minutes
+Net Work Decimal Hours: 8.0 hours
+```
+
 ## Using CSV Input
 You can also use a CSV file to provide the input data. The CSV file should have the following format:
 ```text
@@ -40,13 +49,33 @@ You can export the results to a CSV file by specifying the --csv-output option:
 ```bash
 work_calculator -s "9:30:00 AM" -e "7:00:00 PM" -b "12:49:00 PM-1:26:00 PM,3:42:00 PM-4:35:00 PM" --csv-output path/to/your/output.csv
 ```
+## Logging Work Hours for the Day
+You can log your work hours throughout the day, much like a diary of your work. To log your work, run the following command:
+```bash
+work_calculator --log some-description-goes-here
+```
+Example:
+```bash
+work_calculator --log "working on an interesting project"
+# > Logged work: 2025-02-22 19:47:24 - working on an interesting project
 
-# Expected Output
+work_calculator --log "break"
+# > Logged work: 2025-02-22 19:48:11 - break
+
+work_calculator --log "end"
+# > Logged work: 2025-02-22 19:50:01 - end
+```
+Please note of the system keywords for the description: 
+- "break" : considered the record log as a break
+- "end" : considered the record log as finished or has ended work for the day.
+
+### Calculate the hours from your work log
 ```bash
-Total Work Decimal Hours: 9.5 hours
-Total Break Decimal Hours: 1.5 hours
-Total Break Hours: 1:30 minutes
-Net Work Decimal Hours: 8.0 hours
+work_calculator --calculate-log "2025-02-22"
+# > Total Work Decimal Hours: 3.2 hours
+# > Total Break Decimal Hours: 2.15 hours
+# > Total Break Hours: 2:09 minutes
+# > Net Work Decimal Hours: 1.05 hours
 ```
 
 ## Usage
@@ -60,8 +89,13 @@ Run the script from the command line with the required options for start time, e
 | -b or --breaks | Specifies break periods in comma-separated start_time-end_time format | `-b "12:49:00 PM-1:26:00 PM,3:42:00 PM-4:35:00 PM"` |
 | --csv-input | Specifies the CSV input file | `--csv-input path/to/your/input.csv`s |
 | --csv-output | Specifies the CSV output file | `--csv-output path/to/your/output.csv` |
+| --log DESCRIPTION | Log work with description | `--log "working on a project"` |
+| --log-dir DIRECTORY | Specify a directory to store log files | `--lod-dir` <br><br>or export it as an ENV variable so you don't have to specify the directory arg everytime. <br> `export WORK_HOURS_LOG_DIR="/some/path"`|
+| --calculate-log DATE | Calculate hours from the log file for the specified date (e.g., '2023-10-01') | `--calculate-log 2025-02-01` |
 | -h or --help | Displays help instructions | `-h` |
 
+
+
 ## TODOS
 - Add support for overtimes
 - Add support for daily or weekly or monthly summary for csv inputs

data/bin/work_calculator

@@ -4,21 +4,28 @@
 require_relative '../lib/work_hours_calculator'
 require_relative '../lib/work_hours_calculator/parser'
 require_relative '../lib/work_hours_calculator/csv_handler'
+require_relative '../lib/work_hours_calculator/logger'
 
 options = WorkHoursCalculator::Parser.parse_options
 
-if options[:csv_input]
-  data = WorkHoursCalculator::CSVHandler.import(options[:csv_input])
-  results = WorkHoursCalculator.calculate(data[:work_start], data[:work_end], data[:breaks])
+if options[:log]
+  WorkHoursCalculator::Logger.log_work(options[:description])
 else
-  results = WorkHoursCalculator.calculate(options[:start_time], options[:end_time], options[:breaks])
-end
+  if options[:calculate_log]
+    results = WorkHoursCalculator.calculate_hours_from_log(options[:log_date])
+  elsif options[:csv_input]
+    data = WorkHoursCalculator::CSVHandler.import(options[:csv_input])
+    results = WorkHoursCalculator.calculate(data[:work_start], data[:work_end], data[:breaks])
+  else
+    results = WorkHoursCalculator.calculate(options[:start_time], options[:end_time], options[:breaks])
+  end
 
-if options[:csv_output]
-  WorkHoursCalculator::CSVHandler.export(options[:csv_output], results)
-else
-  puts "Total Work Decimal Hours: #{results[:total_work_decimal_hours].round(2)} hours"
-  puts "Total Break Decimal Hours: #{results[:total_break_decimal_hours].round(2)} hours"
-  puts "Total Break Hours: #{results[:total_break_hours]} minutes"
-  puts "Net Work Decimal Hours: #{results[:net_work_decimal_hours].round(2)} hours"
+  if options[:csv_output]
+    WorkHoursCalculator::CSVHandler.export(options[:csv_output], results)
+  else
+    puts "Total Work Decimal Hours: #{results[:total_work_decimal_hours].round(2)} hours"
+    puts "Total Break Decimal Hours: #{results[:total_break_decimal_hours].round(2)} hours"
+    puts "Total Break Hours: #{results[:total_break_hours]} minutes"
+    puts "Net Work Decimal Hours: #{results[:net_work_decimal_hours].round(2)} hours"
+  end
 end

data/lib/work_hours_calculator/calculate.rb

@@ -6,6 +6,8 @@ require "optparse"
 module WorkHoursCalculator
   class Error < StandardError; end
 
+  class InvalidTimeError < StandardError; end
+
   # This class takes a work_start, work_end, and breaks as input,
   # and calculates the total work hours, total break hours, and net work hours.
   class Calculate
@@ -13,11 +15,20 @@ module WorkHoursCalculator
       @work_start_time = parse_time(work_start)
       @work_end_time = parse_time(work_end)
       @breaks = breaks.map { |start, end_time| [parse_time(start), parse_time(end_time)] }
+
+      raise InvalidTimeError, "Work start time is invalid" if @work_start_time.nil?
+      raise InvalidTimeError, "Work end time is invalid" if @work_end_time.nil?
     end
 
     def execute
       total_work_time = @work_end_time - @work_start_time
-      total_break_time = @breaks.reduce(0) { |sum, (start, end_time)| sum + (end_time - start) }
+      total_break_time = @breaks.reduce(0) do |sum, (start, end_time)|
+        if start && end_time
+          sum + (end_time - start)
+        else
+          sum
+        end
+      end
       net_work_time = total_work_time - total_break_time
 
       {
@@ -32,6 +43,8 @@ module WorkHoursCalculator
 
     def parse_time(time_str)
       Time.parse(time_str)
+    rescue ArgumentError, TypeError
+      nil
     end
 
     def to_hours(seconds)

data/lib/work_hours_calculator/parser.rb

@@ -15,17 +15,31 @@ module WorkHoursCalculator
         opts.on("-b", "--breaks x,y", Array, "Break periods as comma-separated pairs (e.g., '12:49:00 PM-1:26:00 PM,3:42:00 PM-4:35:00 PM')") { |v| options[:breaks] = v.map { |pair| pair.split("-") } }
         opts.on("--csv-input FILE", "CSV input file") { |v| options[:csv_input] = v }
         opts.on("--csv-output FILE", "CSV output file") { |v| options[:csv_output] = v }
+        opts.on("--log DESCRIPTION", "Log work with description") { |v|
+          options[:log] = true
+          options[:description] = v
+        }
+        opts.on("--log-dir DIRECTORY", "Directory to store log files") { |v| options[:log_dir] = v }
+        opts.on("--calculate-log DATE", "Calculate hours from the log file for the specified date (e.g., '2023-10-01')") { |v|
+          options[:calculate_log] = true
+          options[:log_date] = v
+        }
         opts.on("-h", "--help", "Show help") {
           puts opts
           exit
         }
       end.parse!(args, into: options)
 
-      if options[:csv_input].nil? && (options[:start_time].nil? || options[:end_time].nil? || options[:breaks].nil?)
+      if (options[:csv_input].nil? && options[:log].nil? && options[:calculate_log].nil?) && (options[:start_time].nil? || options[:end_time].nil? || options[:breaks].nil?)
         puts "Please provide start time, end time, and break times, or a CSV input file."
         exit
       end
 
+      if options[:log] && options[:description].nil?
+        puts "Error: Description is required when logging work hours."
+        exit 1
+      end
+
       options
     end
   end

data/lib/work_hours_calculator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkHoursCalculator
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/work_hours_calculator.rb

@@ -2,6 +2,7 @@
 
 require_relative "work_hours_calculator/version"
 require_relative "work_hours_calculator/calculate"
+require_relative "work_hours_calculator/logger"
 
 module WorkHoursCalculator
   class Error < StandardError; end
@@ -9,4 +10,9 @@ module WorkHoursCalculator
   def self.calculate(work_start, work_end, breaks)
     WorkHoursCalculator::Calculate.new(work_start, work_end, breaks).execute
   end
+
+  def self.calculate_hours_from_log(date)
+    results = WorkHoursCalculator::Logger.get_hours_from_log(date)
+    WorkHoursCalculator::Calculate.new(results[:work_start], results[:work_end], results[:breaks]).execute
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: work_hours_calculator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerda Decio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -76,10 +76,18 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/gerdadecio/work-hours-calculator-ruby
-  source_code_uri: https://github.com/gerdadecio/work-hours-calculator-ruby
+  documentation_uri: https://github.com/gerdadecio/work-hours-calculator-ruby
   bug_tracker_uri: https://github.com/gerdadecio/work-hours-calculator-ruby/issues
   changelog_uri: https://github.com/gerdadecio/work-hours-calculator-ruby/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: |
+  Thank you for installing the Work Hours Calculator gem!
+
+  You can set the log directory using the WORK_HOURS_LOG_DIR environment variable. If this variable is not set, the default log directory will be ~/work_hours_logs.
+
+  Example:
+    export WORK_HOURS_LOG_DIR="/path/to/custom/log_directory"
+
+  For more information, please refer to the README.md file.
 rdoc_options: []
 require_paths:
 - lib