work_hours_calculator 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01250922e8ef25f907d2c9bf9b39da140e432d3089b5f7133c3c63de063bd7e5'
-  data.tar.gz: e1e29fa8dddf4d95c4c64a558dd9ba932f1180adaa65b5bfcee98636bb0f024d
+  metadata.gz: 7c56f600afa7dec0462adc0dcaa24efef4ac176e27bd1d3ff1c4de08ebc48abc
+  data.tar.gz: c810213e848ae289894099780852ef9db710b7cfdd2e6fcec654fe80a6226bbf
 SHA512:
-  metadata.gz: bdadeee003eeee6c5ae9a4bf44519119805e306c61391bbfba1da1ec4e3a5177c1d0d9c5513a9f822fb012435967e22deaff218886624972cdbae71c137f1679
-  data.tar.gz: 644efc89b85c8bc878e720a00e3d1b50eb9031603f64aa91ec68b6d78c257228cb4d315a1f6511f514aa95aed0692e0fc8a18ba0516eef7f11b3baa4046abf10
+  metadata.gz: 52a84c43725e1173f59cd9bdb6ecd6220a057fb048423395bcb8b8015efbaf3046166b7bb6c8ff8bcf4993aebd74d8d20637076db065259b7d5f2409a4e16cb7
+  data.tar.gz: cb8924d6cf5e184acddd776d886bc99fa8dbbe55963b8937f747a5a84fc6a09e9d1771bd54d75d09db21ab9b12b50aaf7d6402824f81df05ef8e56f67338a60d

data/README.md

@@ -87,11 +87,11 @@ Run the script from the command line with the required options for start time, e
 | -s or --start-time | Specifies the work start time | `-s "9:30:00 AM"` |
 | -e or --end-time | Specifies the work end time | `-e "6:00:00 PM"` |
 | -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` |
+| -i, --csv-input | Specifies the CSV input file | `--csv-input path/to/your/input.csv`s |
+| -o, --csv-output | Specifies the CSV output file | `--csv-output path/to/your/output.csv` |
+| -l, --log DESCRIPTION | Log work with description | `--log "working on a project"` |
+| -dir, --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"`|
+| -t, --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` |
 
 

data/lib/work_hours_calculator/parser.rb

@@ -4,43 +4,75 @@ require "optparse"
 
 # Parses command-line options for the work calculator.
 module WorkHoursCalculator
+  class ParserError < StandardError; end
+
+  class MissingOptionError < ParserError; end
+
+  class InvalidOptionError < ParserError; end
+
   class Parser
     def self.parse_options(args = ARGV)
       options = {}
       OptionParser.new do |opts|
-        opts.banner = "Usage: work_calculator.rb [options]"
+        opts.banner = "Usage: work_calculator [options] arg"
 
+        opts.separator ""
+        opts.separator "General Options:"
         opts.on("-s", "--start-time START", "Work start time (e.g., '9:30:00 AM')") { |v| options[:start_time] = v }
         opts.on("-e", "--end-time END", "Work end time (e.g., '6:00:00 PM')") { |v| options[:end_time] = v }
         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|
+
+        opts.separator ""
+        opts.separator "CSV File Options:"
+        opts.on("-i", "--csv-input FILE", "CSV input file") { |v| options[:csv_input] = v }
+        opts.on("-o", "--csv-output FILE", "CSV output file") { |v| options[:csv_output] = v }
+
+        opts.separator ""
+        opts.separator "Work hour logging Options:"
+        opts.on("-l", "--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|
+        opts.on("--dir DIRECTORY", "Directory to store log files") { |v| options[:log_dir] = v }
+        opts.on("-t", "--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.separator ""
+        opts.separator "Setup your log directory via environment variable:"
+        opts.separator ""
+        opts.separator "export WORK_HOURS_LOG_DIR='/some/path'"
+
+        opts.separator ""
+        opts.separator ""
+        opts.separator "For more information:"
         opts.on("-h", "--help", "Show help") {
           puts opts
           exit
         }
+
+        opts.separator ""
+        opts.separator "=============================================="
+        opts.separator ""
+        opts.separator "Thank you for supporting open source projects."
+        opts.separator "For bugs or feature requests, visit https://github.com/gerdadecio/work-hours-calculator-ruby"
+        opts.separator "Author: Gerda Decio, https://github.com/gerdadecio"
       end.parse!(args, into: options)
 
       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
+        raise MissingOptionError, "Please provide start time, end time, and break times, or a CSV input file."
       end
 
       if options[:log] && options[:description].nil?
-        puts "Error: Description is required when logging work hours."
-        exit 1
+        raise MissingOptionError, "Description is required when logging work hours."
       end
 
       options
+    rescue OptionParser::MissingArgument, WorkHoursCalculator::MissingOptionError => e
+      puts e.message
+      puts "\nfor more information: work_calculator --help"
+      exit
     end
   end
 end

data/lib/work_hours_calculator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: work_hours_calculator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerda Decio