timesheets 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 241b39acbe35ef74faa2c26862450110707d6e7f
+  data.tar.gz: e8034b7b0ff1da83f69ce7a8543b4801ff4b560b
+SHA512:
+  metadata.gz: 791d4e86169ca723076c548a6e154c9267473cf5413a4ed0bf858d842706af447477a283902b16c636ce2ce5d68f461929f4b7b8588f8d157b31387e71f25737
+  data.tar.gz: e3657439a1b06d7122b2c21ebc6b1fdc51da25955e4c15bfa6e0718e37fe3ab5b58c4f8ce965859cf15b9f6ffdacf2693cf9f0e80b617d54a13353f172db8c53

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in timesheets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bradley J. Spaulding
+
+MIT License
+
+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,80 @@
+# Timesheets
+
+A CLI for managing timesheets.
+
+## Installation
+
+Install it via RubyGems:
+
+    $ gem install timesheets
+
+## Usage
+
+### Help / Commands
+
+Run `timesheets` to see a list of available commands:
+
+    $ timesheets
+    Commands:
+      timesheets edit            # Manually edit timesheet data
+      timesheets help [COMMAND]  # Describe available commands or one specific command
+      timesheets start           # Begin a work session
+      timesheets status          # Show current work status
+      timesheets stop            # End the current work session
+      timesheets summary         # See a summary table of time worked
+
+
+### Edit
+
+Opens the underlying spreadsheet (CSV) in your configured editor. Tries `$EDITOR`, then `git config core.editor`, then defaults to `vim`.
+
+    $ timesheets edit
+
+### Start
+
+Starts a session.
+
+    $ timesheets start
+    Started session at 2014-05-04 13:47:33 -0500
+
+### Status
+
+Shows the status of the current work session, if any.
+
+    $ timesheets status
+    Current work session has been active for 8 minutes
+
+### Stop
+
+Ends the current work session, if any.
+
+    $ timesheets stop
+    Ended session at 2014-05-04 14:38:42 -0500
+
+### Summary
+
+A neat ASCII table report, including total hours.
+
+    $ timesheets summary
+    +-----------+----------------+------------+----------+---------+
+    | Weekday   | Date           | Start Time | End Time | Hour(s) |
+    +-----------+----------------+------------+----------+---------+
+    |    Monday | April 28, 2014 |    12:00PM |   8:00PM |     8.0 |
+    |    Monday | April 28, 2014 |    11:00AM |   8:00PM |     9.0 |
+    |   Tuesday | April 29, 2014 |    11:00AM |   2:00PM |     3.0 |
+    |   Tuesday | April 29, 2014 |     2:30PM |   8:30PM |     6.0 |
+    | Wednesday | April 30, 2014 |    11:00AM |   7:00PM |     8.0 |
+    |  Thursday |   May  1, 2014 |    10:15AM |   6:45PM |     8.5 |
+    |    Friday |   May  2, 2014 |    10:30AM |  12:30PM |     2.0 |
+    |    Friday |   May  2, 2014 |     2:30PM |   7:15PM |    4.75 |
+    +-----------+----------------+------------+----------+---------+
+    |           |                |            |          |   49.25 |
+    +-----------+----------------+------------+----------+---------+
+
+## Contributing
+
+1. Fork it (https://github.com/bspaulding/timesheets/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new {|t|
+  t.test_files = FileList['spec/spec_helper.rb', 'spec/**/*_spec.rb']
+}
+

data/bin/timesheets

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'timesheets'
+
+Timesheets::CLI.start(ARGV)

data/lib/timesheets.rb

@@ -0,0 +1,4 @@
+module Timesheets; end
+
+require "timesheets/version"
+require "timesheets/cli"

data/lib/timesheets/cli.rb

@@ -0,0 +1,40 @@
+require 'thor'
+require 'terminal-table'
+require 'csv'
+
+require "timesheets/commands/base"
+require "timesheets/commands/edit"
+require "timesheets/commands/start"
+require "timesheets/commands/status"
+require "timesheets/commands/stop"
+require "timesheets/commands/summary"
+
+module Timesheets
+  class CLI < Thor
+    desc "edit", "Manually edit timesheet data"
+    def edit
+      Commands::Edit.run
+    end
+
+    desc "start", "Begin a work session"
+    def start
+      Commands::Start.run
+    end
+
+    desc "status", "Show current work status"
+    def status
+      Commands::Status.run
+    end
+
+    desc "stop", "End the current work session"
+    def stop
+      Commands::Stop.run
+    end
+
+    desc "summary", "See a summary table of time worked"
+    def summary
+      Commands::Summary.run
+    end
+  end
+end
+

data/lib/timesheets/commands/base.rb

@@ -0,0 +1,31 @@
+module Timesheets
+  module Commands
+    class Base
+      def self.run
+        new.run
+      end
+
+      private
+
+      def session_in_progress?
+        rows.last.last.nil?
+      end
+
+      def hours_in_entry(entry)
+        entry.map(&:to_i).reverse.reduce(:-) / 3600.0
+      end
+
+      def entries
+        @entries ||= rows.map {|row| row.map {|dt| DateTime.parse(dt || Time.now.to_s).to_time } }
+      end
+
+      def rows
+        @rows ||= CSV.read(filepath)[1..-1]
+      end
+
+      def filepath
+        File.expand_path(ENV['TIMESHEETS_FILEPATH'] || '~/.timesheets.csv')
+      end
+    end
+  end
+end

data/lib/timesheets/commands/edit.rb

@@ -0,0 +1,43 @@
+module Timesheets
+  module Commands
+    class Edit < Base
+      def run
+        exec("#{editor} #{filepath}")
+      end
+
+      private
+
+      def editor
+        env_editor || git_editor || 'vim'
+      end
+
+      def env_editor
+        env_editor_set? && env_editor_name
+      end
+
+      def env_editor_set?
+        env_editor_name.length > 0
+      end
+
+      def env_editor_name
+        ENV['EDITOR'].to_s
+      end
+
+      def git_editor
+        git? && git_editor_set? && git_editor_name
+      end
+
+      def git?
+        %x[which git].length > 0
+      end
+
+      def git_editor_set?
+        git_editor_name.length > 0
+      end
+
+      def git_editor_name
+        %x[git config core.editor]
+      end
+    end
+  end
+end

data/lib/timesheets/commands/start.rb

@@ -0,0 +1,21 @@
+module Timesheets
+  module Commands
+    class Start < Base
+      def run
+        if session_in_progress?
+          puts "Session already in progress"
+        else
+          time = Time.new
+          add_new_entry(time)
+          puts "Started session at #{time}"
+        end
+      end
+
+      private
+
+      def add_new_entry(time)
+        File.open(filepath, 'a') {|f| f.write("#{time},") }
+      end
+    end
+  end
+end

data/lib/timesheets/commands/status.rb

@@ -0,0 +1,30 @@
+module Timesheets
+  module Commands
+    class Status < Base
+      def run
+        if session_in_progress?
+          puts "Current work session has been active for #{active_time}"
+        else
+          puts "Not currently working"
+        end
+      end
+
+      private
+
+      def active_time
+        hoursf = hours_in_entry(entries.last)
+        hours = hoursf.to_i
+        mins = ((hoursf - hours) * 60).to_i
+
+        [pluralize('hour', hours), pluralize('minute', mins)]
+          .reject {|string| string[0] == "0" }
+          .join(', ')
+      end
+
+      def pluralize(word, n)
+        n == 1 && "#{n} #{word}" || "#{n} #{word}s"
+      end
+    end
+  end
+end
+

data/lib/timesheets/commands/stop.rb

@@ -0,0 +1,23 @@
+module Timesheets
+  module Commands
+    class Stop < Base
+      def run
+        if session_in_progress?
+          time = Time.new
+          close_last_entry(time)
+          puts "Ended session at #{time}"
+        else
+          puts "No session in progress"
+        end
+      end
+
+      private
+
+      def close_last_entry(time)
+        File.open(filepath, 'a') {|f| f.write("#{time}\n") }
+      end
+    end
+  end
+end
+
+

data/lib/timesheets/commands/summary.rb

@@ -0,0 +1,38 @@
+module Timesheets
+  module Commands
+    class Summary < Base
+      def run
+        puts summary_table
+      end
+
+      private
+
+      def summary_table
+        Terminal::Table.new(headings: ['Weekday', 'Date', 'Start Time', 'End Time', 'Hour(s)']) {|t|
+          formatted_entries.each {|entry| t << entry }
+          t << :separator
+          t << (formatted_entries.first.length - 1).times.map { '' } + [sprintf('%0.02f', total_hours)]
+
+          formatted_entries.first.length.times {|i| t.align_column(i, :right) }
+        }
+      end
+
+      def total_hours
+        entries.map {|entry| hours_in_entry(entry) }.reduce(:+)
+      end
+
+      def formatted_entries
+        @formatted_entries ||= entries.map {|entry|
+          [
+            entry.first.strftime('%A'),
+            entry.first.strftime('%B %e, %Y'),
+            entry.map {|time|
+              time.strftime('%l:%M%p')
+            },
+            sprintf('%0.02f', hours_in_entry(entry))
+          ].flatten
+        }
+      end
+    end
+  end
+end

data/lib/timesheets/version.rb

@@ -0,0 +1,3 @@
+module Timesheets
+  VERSION = "1.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'timesheets'
+require 'minitest/autorun'
+
+TIMESHEETS_FILEPATH='./tmp/timesheets.csv'
+FileUtils.mkdir_p('./tmp')
+File.open(TIMESHEETS_FILEPATH, 'w+') {|f| f.write('Start,End') }
+

data/timesheets.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'timesheets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "timesheets"
+  spec.version       = Timesheets::VERSION
+  spec.authors       = ["Bradley J. Spaulding"]
+  spec.email         = ["brad.spaulding@gmail.com"]
+  spec.summary       = %q{A CLI for managing timesheets.}
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "terminal-table"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: timesheets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bradley J. Spaulding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- brad.spaulding@gmail.com
+executables:
+- timesheets
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/timesheets
+- lib/timesheets.rb
+- lib/timesheets/cli.rb
+- lib/timesheets/commands/base.rb
+- lib/timesheets/commands/edit.rb
+- lib/timesheets/commands/start.rb
+- lib/timesheets/commands/status.rb
+- lib/timesheets/commands/stop.rb
+- lib/timesheets/commands/summary.rb
+- lib/timesheets/version.rb
+- spec/spec_helper.rb
+- timesheets.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A CLI for managing timesheets.
+test_files:
+- spec/spec_helper.rb