time_crunch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43a865302f70babe1bf27a25235a5723f247bede
+  data.tar.gz: d7b159b74d7e24127686dd8f3b8fc5e3ca0be42d
+SHA512:
+  metadata.gz: f803bba2fb55269e6f7ce83ca6af866929d9360ce69c2bfcfe22d27df1e5b1f729493480b61d5a3d5fe95ec6bcffd43f5fea47fc8ef54363946c0bbc0d73e173
+  data.tar.gz: 7079ee7d5bed30103425dc1345cea46fc1c6323b0d6c3c3b7d63dbd265ab1989b036ad5672f7e2515a4c87900315100637fcf1e6af4f695dec2f4f0183815360

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Stephen Kiningham
+
+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,26 @@
+# time_crunch
+
+Convert a TPD file from a digital timeclock into an Excel workbook. A few caveats:
+* The TPD format is, as far as I know, not a standard format.
+* The TPD format is already CSV. This gem cleans up the CSV and adds it as a worksheet to the workbook. It also adds a summary worksheet with each employee's total time.
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'time_crunch'
+```
+
+## TPD Format
+
+The accepted format looks like this:
+
+```
+3,0001,2017-12-16,08:00
+3,0002,2017-12-16,08:01
+2,0002,2017-12-16,12:03
+2,0001,2017-12-16,12:05
+```
+
+In this format, `3` means `In` and `2` means `Out`. The second column references the employee. A mapping between ID and name is accepted by this gem to output names in the worksheets. The third column is the date, and the fourth column is the 24-hour time (physical clock's timezone). Ideally each `In` should pair with an `Out`, but since this is not always the case, each day with an odd number of entries has the oddity discarded for purposes of the summary calculation. In the future, the worksheets may be updated to include formulas so that the manual addition of time entries on one worksheet would update the summary worksheet.

data/lib/time_crunch.rb

@@ -0,0 +1,12 @@
+module TimeCrunch
+  require 'time_crunch/conversion'
+  require 'time_crunch/time_entry'
+  require 'time_crunch/time_card'
+  require 'time'
+  require 'csv'
+  require 'rubyXL'
+
+  def self.process(input_file_path, output_file_path, employee_map: {})
+    TimeCrunch::Conversion.new(input_file_path, employee_map: employee_map).write_xlsx(output_file_path)
+  end
+end

data/lib/time_crunch/conversion.rb

@@ -0,0 +1,23 @@
+module TimeCrunch
+  class Conversion
+    def initialize(file_path, employee_map: {})
+      @time_entries = CSV.read(file_path).collect { |row| TimeEntry.new(row, employee_map) }.sort
+    end
+
+    def write_xlsx(file_path)
+      workbook = RubyXL::Workbook.new
+      summary_sheet = workbook['Sheet1']
+      summary_sheet.sheet_name = 'Summary'
+      # TODO: Add data to summary
+
+      entries_sheet = workbook.add_worksheet('Time Entries')
+      @time_entries.each_with_index do |time_entry, i|
+        3.times do |j|
+          entries_sheet.add_cell(i, j, time_entry.value_by_index(j))
+        end
+      end
+
+      workbook.write(file_path)
+    end
+  end
+end

data/lib/time_crunch/time_card.rb

@@ -0,0 +1,20 @@
+module TimeCrunch
+  class TimeCard
+    attr_accessor :time_entries
+    attr_reader :employee
+
+    def initialize(time_entries)
+      raise 'All time entries must belong to same employee' unless time_entries.uniq(&:employee).one?
+      @employee = time_entries.first.employee
+      @time_entries = time_entries.sort
+    end
+
+    def valid?
+      # TODO
+    end
+
+    def total
+      # TODO
+    end
+  end
+end

data/lib/time_crunch/time_entry.rb

@@ -0,0 +1,46 @@
+module TimeCrunch
+  class TimeEntry
+    include Enumerable
+    attr_reader :employee, :timestamp
+
+    def initialize(csv_row, employee_map)
+      raise 'Row does not have four columns' unless csv_row.size == 4
+
+      @clock_in = csv_row[0] == '3'
+      @employee = employee_map.key?(csv_row[1]) ? employee_map[csv_row[1]] : csv_row[1]
+      @timestamp = Time.parse("#{csv_row[2]} #{csv_row[3]}")
+    end
+
+    def clock_in?
+      @clock_in
+    end
+
+    def clock_out?
+      !clock_in?
+    end
+
+    def direction
+      clock_in? ? 'IN' : 'OUT'
+    end
+
+    def value_by_index(ind)
+      raise IndexError if ind > 2 || ind < 0
+      case ind
+      when 0
+        direction
+      when 1
+        employee
+      when 2
+        timestamp.strftime('%Y-%m-%d %H:%M:%S')
+      end
+    end
+
+    def <=>(other)
+      timestamp <=> other.timestamp
+    end
+
+    def to_s
+      "<direction: #{direction}, employee: #{employee}, timestamp: #{timestamp.strftime('%Y-%m-%d %H:%M:%S')}>"
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: time_crunch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stephen Kiningham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: time_crunch@kiningham.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/time_crunch.rb
+- lib/time_crunch/conversion.rb
+- lib/time_crunch/time_card.rb
+- lib/time_crunch/time_entry.rb
+homepage: https://github.com/skiningham/time_crunch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Convert TPD timeclock data to XLSX
+test_files: []