work_hours_calculator 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7296652efae4aa80651a3887ac25154161d71a72f9535f527934c4d760aa7f
-  data.tar.gz: 8a469a806bc11f9c01e9adcc4877016e52e223086b94a2d80f3d4f2305ec0df3
+  metadata.gz: '01250922e8ef25f907d2c9bf9b39da140e432d3089b5f7133c3c63de063bd7e5'
+  data.tar.gz: e1e29fa8dddf4d95c4c64a558dd9ba932f1180adaa65b5bfcee98636bb0f024d
 SHA512:
-  metadata.gz: 8ce0a70e34578886ed9db9cc90f2106a79a600f82513ba2ffc6ebd3313f37b88c0d7977162379e8b31dbf29f4e50d49d7d7f9813a05cca440e2822bc748ae748
-  data.tar.gz: cb636ced3ad71141105816df20d7a1e902129750c29d7d0d58ccf2f6b99af120db63f941d6a600f912d6b69d0bb99f7d67b6951945667ed43bf02be0b0c41aab
+  metadata.gz: bdadeee003eeee6c5ae9a4bf44519119805e306c61391bbfba1da1ec4e3a5177c1d0d9c5513a9f822fb012435967e22deaff218886624972cdbae71c137f1679
+  data.tar.gz: 644efc89b85c8bc878e720a00e3d1b50eb9031603f64aa91ec68b6d78c257228cb4d315a1f6511f514aa95aed0692e0fc8a18ba0516eef7f11b3baa4046abf10

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/logger.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "csv"
+require "date"
+require "time"
+module WorkHoursCalculator
+  class InvalidFile < StandardError; end
+
+  class InvalidDir < StandardError; end
+
+  class InvalidRecord < StandardError; end
+
+  class MissingRecord < StandardError; end
+
+  class Logger
+    DEFAULT_LOG_DIR = File.join(Dir.home, "work_hours_logs")
+    LOG_DIR = ENV["WORK_HOURS_LOG_DIR"] || DEFAULT_LOG_DIR
+
+    def self.log_work(description, log_dir = LOG_DIR)
+      raise InvalidRecord, "Description cannot be empty" if description.nil? || description.strip.empty?
+
+      begin
+        Dir.mkdir(log_dir) unless Dir.exist?(log_dir)
+      rescue SystemCallError => e
+        raise InvalidDir, "Failed to create log directory: #{e.message}"
+      end
+
+      log_file = File.join(log_dir, "#{Date.today}.csv")
+
+      begin
+        CSV.open(log_file, "a") do |csv|
+          time = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+          csv << [time, description]
+        end
+      rescue SystemCallError => e
+        raise InvalidFile, "Failed to write to log file: #{e.message}"
+      end
+
+      puts "Logged work: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")} - #{description}"
+    end
+
+    def self.get_hours_from_log(date, log_dir = DEFAULT_LOG_DIR)
+      raise InvalidRecord, "Date cannot be nil" if date.nil?
+
+      log_file = File.join(log_dir, "#{date}.csv")
+      unless File.exist?(log_file)
+        puts "Log file for #{date} not found."
+        exit 1
+      end
+
+      entries = CSV.read(log_file, headers: false).map do |row|
+        {time: Time.parse(row[0]), description: row[1].strip}
+      end
+
+      work_start = entries.find { |entry| entry[:description].downcase != "break" && entry[:description].downcase != "end" }
+      work_end = entries.reverse.find { |entry| entry[:description].downcase == "end" }
+
+      raise MissingRecord, "Work start record not found" if work_start.nil?
+      raise MissingRecord, "Work end record not found" if work_end.nil?
+
+      work_start_time = work_start[:time]
+      work_end_time = work_end[:time]
+
+      breaks = []
+      break_start = nil
+
+      entries.each do |entry|
+        if entry[:description].downcase == "break" || entry[:description].downcase == "end"
+          break_start ||= entry[:time]
+        elsif break_start
+          breaks << [break_start, entry[:time]]
+          break_start = nil
+        end
+      end
+
+      {
+        work_start: work_start_time.strftime("%I:%M:%S %p"),
+        work_end: work_end_time.strftime("%I:%M:%S %p"),
+        breaks: breaks.map { |start, end_time| [start.strftime("%I:%M:%S %p"), end_time.strftime("%I:%M:%S %p")] }
+      }
+    end
+  end
+end

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.4"
+  VERSION = "0.3.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.4
+  version: 0.3.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
@@ -68,6 +68,7 @@ files:
 - lib/work_hours_calculator.rb
 - lib/work_hours_calculator/calculate.rb
 - lib/work_hours_calculator/csv_handler.rb
+- lib/work_hours_calculator/logger.rb
 - lib/work_hours_calculator/parser.rb
 - lib/work_hours_calculator/version.rb
 homepage: https://github.com/gerdadecio/work-hours-calculator-ruby
@@ -79,7 +80,15 @@ metadata:
   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