work_hours_calculator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7f54c5c074ce375984a55c820573bb50bf06bf1275ee078e810a8983d680f1d
+  data.tar.gz: bb457aeee5bd2ccd9cfe5e04cdb87463156eb0539c00db8aeb3b8f77712bbc10
+SHA512:
+  metadata.gz: 27e180417ba87b78e8942cdb6ba130fbe6838ad082bcd926ac2c051cad42c3913c216c5816f43b14bc47f729246fd1d9d9531f7b1d0645a226b0fe10d2edcaac
+  data.tar.gz: 9d06704b2219d71ca478e6b9c031a6a442bc31d2a35587ae8e4ffa1274ecd012613a89d87be1f2027c923b1087021035301bd11784fdf13f9c352ec01e37ff01

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gerda Decio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Work Hours Calculator CLI
+
+Manually calculating work hours, breaks, and net hours in a spreadsheet can be tedious and prone to errors. To streamline the process and ensure accuracy, I created this CLI tool to handle the calculations quickly and easily.
+
+## Description
+This is a Ruby command-line tool for calculating the total work hours, break hours, and net work hours (after subtracting breaks) based on provided work start time, end time, and break periods.
+
+## Features
+- Calculate total work hours between start and end times.
+- Account for multiple break periods.
+- Return net work hours after subtracting break times.
+
+## Installation
+
+```bash
+gem install work_hours_calculator
+```
+
+# Example
+To calculate your work hours, run the following command:
+```bash
+work_hours_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"
+```
+
+## Using CSV Input
+You can also use a CSV file to provide the input data. The CSV file should have the following format:
+```text
+work_start,work_end,breaks
+9:00 AM,5:00 PM,"12:00 PM-12:30 PM,3:00 PM-3:15 PM"
+```
+To calculate your work hours using a CSV file, run the following command:
+```bash
+ruby ./bin/work_calculator.rb --csv-input path/to/your/input.csv
+```
+## Exporting Results to CSV
+You can export the results to a CSV file by specifying the --csv-output option:
+ruby ./bin/work_calculator.rb -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
+```
+
+# 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
+```
+
+## Usage
+Run the script from the command line with the required options for start time, end time, and break periods.
+
+### Command Line Options
+| Option | Description | Example |
+| -------- | ------- | ------- |
+| -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` |
+| -h or --help | Displays help instructions | `-h` |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/work_hours_calculator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/work_hours_calculator/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the WorkHoursCalculator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/work_hours_calculator/blob/main/CODE_OF_CONDUCT.md).

data/bin/work_calculator.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/work_hours_calculator'
+require_relative '../lib/work_hours_calculator/parser'
+require_relative '../lib/work_hours_calculator/csv_handler'
+
+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])
+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"
+end

data/lib/work_hours_calculator/calculate.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "time"
+require "optparse"
+
+module WorkHoursCalculator
+  class Error < 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
+    def initialize(work_start, work_end, breaks)
+      @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)] }
+    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) }
+      net_work_time = total_work_time - total_break_time
+
+      {
+        total_work_decimal_hours: to_hours(total_work_time),
+        total_break_decimal_hours: to_hours(total_break_time),
+        total_break_hours: to_hour_and_minutes(to_hours(total_break_time)),
+        net_work_decimal_hours: to_hours(net_work_time)
+      }
+    end
+
+    private
+
+    def parse_time(time_str)
+      Time.parse(time_str)
+    end
+
+    def to_hours(seconds)
+      seconds / 3600.0
+    end
+
+    def to_hour_and_minutes(hours)
+      total_minutes = (hours * 60).round
+      hours = total_minutes / 60
+      minutes = total_minutes % 60
+      format("%d:%02d", hours, minutes)
+    end
+  end
+end

data/lib/work_hours_calculator/csv_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module WorkHoursCalculator
+  require "csv"
+
+  # Class to handle CSV import and export
+  class CSVHandler
+    def self.import(file_path)
+      data = CSV.read(file_path, headers: true)
+      work_start = data["work_start"].first
+      work_end = data["work_end"].first
+      breaks = data["breaks"].first.split(",").map { |b| b.split("-") }
+      {work_start: work_start, work_end: work_end, breaks: breaks}
+    end
+
+    def self.export(file_path, results)
+      CSV.open(file_path, "w") do |csv|
+        csv << ["total_work_decimal_hours", "total_break_decimal_hours", "total_break_hours", "net_work_decimal_hours"]
+        csv << [results[:total_work_decimal_hours], results[:total_break_decimal_hours], results[:total_break_hours], results[:net_work_decimal_hours]]
+      end
+    end
+  end
+end

data/lib/work_hours_calculator/parser.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+# Parses command-line options for the work calculator.
+module WorkHoursCalculator
+  class Parser
+    def self.parse_options(args = ARGV)
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: work_calculator.rb [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("-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?)
+        puts "Please provide start time, end time, and break times, or a CSV input file."
+        exit
+      end
+
+      options
+    end
+  end
+end

data/lib/work_hours_calculator/version.rb

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

data/lib/work_hours_calculator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "work_hours_calculator/version"
+require_relative "work_hours_calculator/calculate"
+
+module WorkHoursCalculator
+  class Error < StandardError; end
+
+  def self.calculate(work_start, work_end, breaks)
+    WorkHoursCalculator::Calculate.new(work_start, work_end, breaks).execute
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: work_hours_calculator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerda Decio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+description: This gem provides a command-line tool to calculate total work hours,
+  total break hours, and net work hours based on input times. It supports CSV input
+  and output, including Google Sheets integration.
+email:
+- contact@gerdadecio.com
+executables:
+- work_calculator.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE
+- README.md
+- bin/work_calculator.rb
+- lib/work_hours_calculator.rb
+- lib/work_hours_calculator/calculate.rb
+- lib/work_hours_calculator/csv_handler.rb
+- lib/work_hours_calculator/parser.rb
+- lib/work_hours_calculator/version.rb
+homepage: https://github.com/gerdadecio/work-hours-calculator-ruby
+licenses:
+- MIT
+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
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: A tool to calculate work hours, break hours, and net work hours.
+test_files: []