timesheet-reader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0750b6ab2c99dd8f5656d5e1f4ee2bf7cac9f335e1438e917d6e56181b321a02
+  data.tar.gz: 4038ecb7c4ec350955637912ab030a99764fbd514019cf0b50fa932d25ab88a5
+SHA512:
+  metadata.gz: a0ee5ded92b1053441e14385d7af111c3c5751a98c4571bbc03333ae0ad974cd5656de3f58b7a5647cfee65263b6914576c309abd3798918125a47b4cf3cda50
+  data.tar.gz: 8531c787e91d86379ed2524261c484ed44348e016b669b01d54055e1b225be1162fcb4c177b5ec6e1d0172520d5a9c74be291c739054fcd9d9d66d3e7236d122

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Diego Leal
+
+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 @@
+# timesheet-reader

data/bin/timesheet-reader

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'timesheet_reader'
+
+cli = TimesheetReader::CLI.new
+cli.run

data/lib/timesheet_reader.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'timesheet_reader/cli'
+require 'timesheet_reader/converter'
+require 'timesheet_reader/core'
+require 'timesheet_reader/formatter'
+require 'timesheet_reader/parser'
+require 'timesheet_reader/version'
+
+# TimesheetReader module
+module TimesheetReader
+end

data/lib/timesheet_reader/cli.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TimesheetReader
+  # CLI class
+  class CLI
+    def run
+      input = ARGV
+      timesheet_info = TimesheetReader::Core.new(input).run
+
+      TimesheetReader::Formatter.new.report(
+        timesheet_info[:timesheets],
+        timesheet_info[:total_hours],
+        timesheet_info[:total_minutes]
+      )
+    end
+  end
+end

data/lib/timesheet_reader/converter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TimesheetReader
+  # Converter class
+  class Converter
+    attr_accessor :minute_multiplier
+
+    def initialize
+      @minute_multiplier = 60
+    end
+
+    def hour_to_minutes(hours)
+      hours.to_i * minute_multiplier
+    end
+
+    def minutes_to_time(minutes)
+      hours = (minutes / @minute_multiplier)
+      hours_part = (minutes % @minute_multiplier)
+      [hours, hours_part]
+    end
+  end
+end

data/lib/timesheet_reader/core.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module TimesheetReader
+  # Core class
+  class Core
+    attr_reader :file_paths, :parser, :converter
+
+    def initialize(file_paths)
+      @file_paths = file_paths
+      @parser = TimesheetReader::Parser.new
+      @converter = TimesheetReader::Converter.new
+    end
+
+    def run
+      timesheets = transform_timesheets(
+        generate_timesheets
+      )
+
+      total_time = sum_time(timesheets)
+      total_hours, total_minutes = @converter.minutes_to_time(total_time)
+
+      {
+        total_hours: total_hours,
+        total_minutes: total_minutes,
+        timesheets: timesheets
+      }
+    end
+
+    private
+
+    def generate_timesheets
+      @file_paths.map { |path| @parser.run(path) }
+    end
+
+    def transform_timesheets(timesheets)
+      timesheets.map do |timesheet|
+        lines = map_time_to_minutes(timesheet[:lines])
+        time = calculate_time_diff(lines)
+        hours, minutes = @converter.minutes_to_time(time)
+
+        {
+          filename: timesheet[:filename],
+          time: time, hours: hours,
+          minutes: minutes
+        }
+      end
+    end
+
+    def map_time_to_minutes(timesheet_lines)
+      timesheet_lines.map do |line|
+        line[:minutes] + @converter.hour_to_minutes(line[:hours])
+      end
+    end
+
+    def calculate_time_diff(lines_in_minutes)
+      diffs = []
+
+      lines_in_minutes.each_with_index do |time, index|
+        next if index.odd?
+
+        next_time = lines_in_minutes[index + 1]
+        diff = next_time - time
+
+        diffs.push(diff)
+      end
+
+      diffs.reduce(0) { |acc, time_diff| acc + time_diff }
+    end
+
+    def sum_time(timesheets)
+      timesheets.reduce(0) { |acc, timesheet| acc + timesheet[:time] }
+    end
+  end
+end

data/lib/timesheet_reader/formatter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TimesheetReader
+  # Formatter class
+  class Formatter
+    def report(timesheets, total_hours, total_minutes)
+      timesheets.each do |timesheet|
+        filename = timesheet[:filename]
+        hours = timesheet[:hours]
+        minutes = timesheet[:minutes]
+
+        print_timesheet_line(filename, hours, minutes)
+      end
+
+      hours = format_time(total_hours)
+      minutes = format_time(total_minutes)
+      puts "Total hours: #{hours}:#{minutes}"
+    end
+
+    private
+
+    def format_time(time)
+      '%02d' % time
+    end
+
+    def print_timesheet_line(filename, hours, minutes)
+      puts "#{filename}: #{format_time(hours)}:#{format_time(minutes)} hours"
+    end
+  end
+end

data/lib/timesheet_reader/parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module TimesheetReader
+  # ParserError class
+  class ParserError < RuntimeError
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  # Parser class
+  class Parser
+    attr_accessor :keywords, :token
+
+    def initialize
+      @keyword = 'timesheet'
+      @token = '##'
+    end
+
+    def run(relative_path)
+      file = read_file(relative_path)
+      lines = build_lines(file[:lines])
+
+      { filename: file[:filename], lines: lines }
+    end
+
+    private
+
+    def read_file(relative_path)
+      absolute_path = File.expand_path(relative_path)
+      _, filename = File.split(relative_path)
+      lines = File.read(absolute_path).squeeze("\n").split("\n")
+
+      { filename: filename, lines: lines }
+    end
+
+    def parse_statements_block(lines)
+      token_index = lines.index do |line|
+        line.downcase == "#{@token} #{@keyword}"
+      end
+
+      start_of_block = token_index + 1
+
+      end_of_block = lines[start_of_block..-1].index do |line|
+        line.include?(@token.to_s)
+      end
+
+      lines[start_of_block..end_of_block]
+    end
+
+    def build_lines(lines)
+      parsed_lines = parse_statements_block(lines)
+      validate_timesheet_intervals(parsed_lines)
+
+      parsed_lines.map do |line|
+        statement, hours, minutes = line.split(':')
+        validate_time_sheet_hours(hours)
+        validate_time_sheet_minutes(minutes)
+        hours = hours.to_i.zero? ? 24 : hours.to_i
+
+        { statement: statement, hours: hours, minutes: minutes.to_i }
+      end
+    end
+
+    def validate_timesheet_intervals(lines)
+      msg = 'You should close the interval of last line'
+      raise ParserError, msg if lines.length.odd?
+    end
+
+    def validate_time_sheet_hours(hours)
+      hours = hours.to_i
+      msg = 'You should use a number between 0-23 to define hours'
+      raise ParserError, msg if hours.negative? || hours > 23
+    end
+
+    def validate_time_sheet_minutes(minutes)
+      minutes = minutes.to_i
+      msg = 'You should use a number between 0-59 to define minutes'
+      raise ParserError, msg if minutes.negative? || minutes > 59
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: timesheet-reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diego Leal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: "    A timesheet reader.\n"
+email: leal.banks@gmail.com
+executables:
+- timesheet-reader
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/timesheet-reader
+- lib/timesheet_reader.rb
+- lib/timesheet_reader/cli.rb
+- lib/timesheet_reader/converter.rb
+- lib/timesheet_reader/core.rb
+- lib/timesheet_reader/formatter.rb
+- lib/timesheet_reader/parser.rb
+homepage: https://github.com/diego-leal/timesheet-reader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/diego-leal/timesheet-reader/blob/master/README.md
+  changelog_uri: https://github.com/diego-leal/timesheet-reader/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/diego-leal/timesheet-reader/
+  documentation_uri: https://github.com/diego-leal/timesheet-reader/
+  bug_tracker_uri: https://github.com/diego-leal/timesheet-reader/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A timesheet reader.
+test_files: []