timr 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b190f08b68a3b332d9e275c9773cd75187d88fa
-  data.tar.gz: c6c3941e0d5afd7352e4c4187161e14d5909a3d7
+  metadata.gz: f79b6ea230b0bb324476f5cb65f5f8905c8f0eac
+  data.tar.gz: 2f85343c2c7ee84c052067f40d263a76ffffc832
 SHA512:
-  metadata.gz: f19bb6ba4f42fd18390ecd08030f58a4ac5158cf3067703b02cf8b023e5b5d5ad47fe4f1c076e0641db3485e7753a4273346e39a9103df8364af692d83de1761
-  data.tar.gz: 9d8557cb636b962b1062f8f4619a8a86cc7f44eb7cc91ea16e74ec1d877f7c4c1f626121f7f88a287971cb3af68cd74ed5eedce73eb856cdf3aa8147e52fe02a
+  metadata.gz: 374a2459ee630217d4cafa343150690d0729c1ef6a93c1221569e85ae79ea4a8be48919e2ccb43810ba95a354446d6a9bde388229bf6e7e53b6dfccd7a9a7cd8
+  data.tar.gz: c1bdc85bc01a15f9f5cc827c3c2dff82ba0fbfe8c3e3d68a2987b8c61a1d0d590037ab0d841dde8a8041f332a7c28ae833de57d7f8afdc7e308823960fbe65f3

data/.ackrc

@@ -0,0 +1,9 @@
+
+--type=ruby
+--type=yaml
+
+--ignore-dir=.bundle
+--ignore-dir=releases
+--ignore-dir=tmp
+--ignore-dir=lib1
+--ignore-dir=test1

data/.editorconfig

@@ -4,6 +4,7 @@ root = true
 
 [*]
 indent_style = tab
+indent_size = 4
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = false

data/.env.example

@@ -0,0 +1,7 @@
+GEM_NAME=timr
+GEMSPEC_FILE=timr.gemspec
+RSYNC_HOST=
+RSYNC_USER=
+RSYNC_REMOTE_PATH_MASTER=''
+RSYNC_REMOTE_PATH_DEVELOP=''
+RSYNC_OPTIONS='-vurtc --chmod=Du=rwx,Dgo=rx,Fu=rw,Fog=r'

data/.github/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+In the spirit of :free: [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions. :floppy_disk: :cd: :egg:
+* by reporting bugs. :scream: :laughing:
+* by suggesting new features. :nose: :bulb: :new: :pizza:
+* by writing or editing documentation. :clipboard: :orange_book: :books:
+* by writing code (**no patch is too small**: fix typos, add comments). :wink: :confused: :tired_face: :smirk: :white_check_mark:
+* by refactoring code. :open_mouth: :speak_no_evil:
+* by closing [issues](https://github.com/TheFox/timr/issues). :hash:
+* by reviewing patches. :+1: :-1:
+* by writing blog posts. :memo: :newspaper:
+
+## Submitting an Issue
+
+We use the :octocat: [GitHub issue tracker](https://github.com/TheFox/timr/issues) to track :beetle: bugs and :bomb: features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. Otherwise feel free to create a :hash: [new issue](https://github.com/TheFox/timr/issues/mew).
+
+## Submitting a Pull Request
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the official repository. :fearful:  
+  Run `./bin/dev_setup.sh` to get started with development.
+2. Create a [topic branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). :frowning:
+3. Implement your feature or bugfix. :smile:
+4. Add, commit, and push your changes. :sunglasses:
+5. Submit a [pull request](https://help.github.com/articles/about-pull-requests/). :smirk:
+
+---
+
+Inspired by https://github.com/jfelchner/ruby-progressbar/blob/b837c09ea1e34923d984ab47bd47ef095fcb5a92/CONTRIBUTING.md

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!-- Describe your issue here. -->
+
+
+### Emotional State
+
+My emotional state right now is:
+
+- [ ] Excited :smile:
+- [ ] Confused :confused:
+- [ ] Worried :worried:
+- [ ] Upset :angry:
+- [ ] Panicked :scream:
+- [ ] Angry :rage:

data/.gitignore

@@ -1,8 +1,14 @@
 /.bundle/
+.env
 .setup
-/bin/dev
+/api/
 CHANGELOG-*.txt
+/coverage/
 Gemfile.lock
-/releases/
 README.html
 /tmp/
+*.log
+*.yml
+*.txt
+*.csv
+*.html

data/.rdoc_options

@@ -0,0 +1,21 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include: []
+charset: UTF-8
+exclude: []
+hyperlink_all: false
+line_numbers: true
+locale: en
+locale_dir: locale
+locale_name: 
+main_page: README.md
+markup: markdown
+output_decoration: true
+page_dir: 
+show_hash: false
+tab_width: 4
+template_stylesheets: []
+title: Timr
+visibility: :protected
+webcvs: 

data/.travis.yml

@@ -2,19 +2,22 @@ language: ruby
 rvm:
     - 2.1
     - 2.2
+    - 2.3
+    - 2.4.0
+    - ruby-head
 sudo: required
 before_install:
-    - gem update --system
     - gem --version
-    - gem install bundler -v '~>1.12'
+    - gem update --system
+    - gem install bundler -v '~>1.13'
     - bundler --version
 install:
-    - make
-    - gem build timr.gemspec
-    - gem install timr-*.gem
-    - gem list -l timr
+    - bundler install
+    - 'gem build "${GEMSPEC_FILE}"'
+    - 'gem install "${GEM_NAME}"-*.gem'
+    - 'gem list -l "${GEM_NAME}"'
 script:
-    - make test
+    - ./bin/test.sh
     - cd
     - which -a timr
     - timr --version

data/Gemfile

@@ -1,3 +1,11 @@
 
 source 'https://rubygems.org'
+
+group(:development) do
+	if ENV['SIMPLECOV_PHPUNIT_LOAD_PATH']
+		# Load SimpleCov PHPUnit Formatter from a local path.
+		gem 'simplecov-phpunit', :path => ENV['SIMPLECOV_PHPUNIT_LOAD_PATH']
+	end
+end
+
 gemspec

data/README.md

@@ -1,15 +1,228 @@
 # Timr
 
-Time Tracking for Hackers.
+Timr is a time tracking tool for the [Command-line](https://en.wikipedia.org/wiki/Command-line_interface), written in [Ruby](https://www.ruby-lang.org/). You can track your time spent for a specific project. I know, there are (too) many time tracking tools and such blabla you can use. The main focus of this tool is to use it on the Command-line and make automatic reports. I love the Command-line, so I want the terminal to handle as much as possible. I don't want programms with fancy UIs. Text-based is good enough. All data are stored in YAML files. So editing can also be done by using your favorite editor.
+
+## Install
+
+You can either install Timr via [RubyGems.org](https://rubygems.org/gems/timr) or from [source](https://github.com/TheFox/timr).
+
+## Install via RubyGems.org
+
+The preferred method of installation is via RubyGems.org:  
+<https://rubygems.org/gems/timr>
+
+	gem install timr
+
+## Install from Source
+
+1. Clone `git clone https://github.com/TheFox/timr.git && cd timr`.
+2. Run `./bin/install.sh`. This creates the `timr` gem local and installs it.
+
+## Get Started
+
+The simplest thing you can do after installation is start a new Task:
+
+	$ timr start
+
+And after some time you probably want to stop:
+
+	$ timr stop
+
+To show the current status:
+
+	$ timr status
+
+## Task
+
+A Task can have a name, a description, an estimation and many more. A Task can have multiple Tracks. One Track can have only one Task as parent. So a Task represents a collection of Tracks.
+
+## Track
+
+A Track is atomic. It's the smallest time unit. This is where the time comes from. It's a time span presented by a begin date time and end date time. All date times are stored as UTC and converted temporary to your local timezone.
+
+## Stack
+
+The Stack holds Tracks. If you know [Git Stashing](https://git-scm.com/book/en/v1/Git-Tools-Stashing) it's very similar. Just for Tracks. The most recent Track is sometimes called the *Top Track*. It's either the current running Track or on `pause` the latest ran Track.
+
+When first starting a new Task, a new Track will be created and pushed to the Stack. When running the Stop command this Task will be removed from the Stack.
+
+You can push another Track to the Stack by running the Push command. It is like the Start command but without removing the previous Track from the Stack. The Push and Pop command is helpful when you need to work temporary on another Task. When running the Pop command the Top Track will be stopped and removed from the Stack. Further, the next Track on the Stack will continue immediately.
+
+## Clients
+
+It's recommended to put each client in a separate directory.
+
+	$HOME/.timr/client1
+	$HOME/.timr/client2
+	$HOME/.timr/client3
+
+Use `-C` to change the directory in which Timr should operate:
+
+	timr -C "$HOME/.timr/client1"
+
+Default:
+
+	$HOME/.timr/defaultc
+
+## Commands
+
+See `timr <command> --help` to read details about a specific command, or `timr help <command>` to open the man page for this command.
+
+The man pages are also available online: <https://timr.fox21.at/man/timr.1.html>
+
+### Start Command
+
+The Start command always removes all Tracks from the Stack. If there is another current running Task this Task will be stopped and removed from the Stack.
+
+	timr start [<options>] [<task_id> [<track_id>]]
+
+See more informations on the [timr-start(1)](https://timr.fox21.at/man/timr-start.1.html) man page.
+
+### Stop Command
+
+Stopps the current running Track and removes it from the Stack.
+
+	timr stop [<options>]
+
+See more informations on the [timr-stop(1)](https://timr.fox21.at/man/timr-stop.1.html) man page.
+
+### Pause Command
+
+Pause the current running Track.
+
+	timr pause [<options>]
+
+See more informations on the [timr-pause(1)](https://timr.fox21.at/man/timr-pause.1.html) man page.
+
+### Continue Command
+
+Continue the previous paused Track. When a Track will be continued (or *restarted*) it's actual a copy using the same message.
+
+	timr continue [<options>]
+
+See more informations on the [timr-continue(1)](https://timr.fox21.at/man/timr-continue.1.html) man page.
+
+### Push Command
+
+Sometimes you need to work on a Task only temporary. You want to track the time for this as well. For example fixing a bug. When you fixed the bug you want to continue your actual work. Here comes `timr push` and `timr pop` into the game. It modifies the Stack. When you push a new Task the below Task will be paused. On pop the Top Task will be stopped and the next below will continue.
+
+	timr push [<options>] [<task_id> [<track_id>]]
+
+See more informations on the [timr-push(1)](https://timr.fox21.at/man/timr-push.1.html) man page.
+
+### Pop Command
+
+Stop and pop the current running Track from the Stack.
+
+	timr pop [<options>]
+
+See more informations on the [timr-pop(1)](https://timr.fox21.at/man/timr-pop.1.html) man page.
+
+### Status Command
+
+Print the current Stack status.
+
+	timr status [<options>]
+
+See more informations on the [timr-status(1)](https://timr.fox21.at/man/timr-status.1.html) man page.
+
+### Log Command
+
+Show recent Tracks.
+
+	timr log [<options>]
+
+See more informations on the [timr-log(1)](https://timr.fox21.at/man/timr-log.1.html) man page.
+
+### Task Command
+
+Show, add, edit, or remove a Task.
+
+	timr task <subcommand> [<options>] [<task_id>]
+
+See more informations on the [timr-task(1)](https://timr.fox21.at/man/timr-task.1.html) man page.
+
+### Track Command
+
+Show, add, edit, move, or remove a Track.
+
+	timr track <subcommand> [<options>] [<track_id>]
+
+See more informations on the [timr-track(1)](https://timr.fox21.at/man/timr-track.1.html) man page.
+
+### Report Command
+
+Export Tasks and Tracks.
+
+	timr report [<options>]
+
+See more informations on the [timr-report(1)](https://timr.fox21.at/man/timr-report.1.html) man page.
+
+## Workflow Example
+
+Here is an example as shell commands how your workflow could look like while using Timr.
+
+Before starting to work on a Task:
+
+	timr start
+
+Do your work.
+
+After finished your Task:
+
+	timr stop
+
+But you like to name your Task at the beginning to know on what you worked:
+
+	timr start --name 'Refactor Star Wars'
+
+In case you need to do several things on your Task provide a more specific message:
+
+	timr start --name 'Refactor Star Wars' --message 'This is what I am going to do.'
+
+But maybe you have not set `--message` on `start`. So you can also set it on `stop`:
+
+	timr stop --message 'This is what I have done.'
+
+## Bash Completion
+
+Timr comes with a completion for Bash: `bin/timr_bash_completion.sh` file is included to the Timr gem. To get the full path to `bin/timr_bash_completion.sh` run:
+
+	echo $(timr --install-basepath)/bin/timr_bash_completion.sh
+
+In the following examples replace `/path/to/bin/timr_bash_completion.sh` with the output of the executed `echo` command.
+
+Create a link to this file in your `bash_completion.d` directory. Unter Linux the path is `/etc/bash_completion.d`. Under macOS the path is `/usr/local/etc/bash_completion.d`. In this example we will use the path for macOS:
+
+	ln -s /path/to/bin/timr_bash_completion.sh /usr/local/etc/bash_completion.d
+
+Alternatively you can direct source from your `~/.bashrc` file:
+
+```bash
+if [ -f /path/to/bin/timr_bash_completion.sh ]; then
+	source /path/to/bin/timr_bash_completion.sh
+fi
+```
+
+Do not forget to remove all links when deinstalling Timr.
 
 ## Project Links
 
-- [Timr Gem](https://rubygems.org/gems/timr)
+- [Homepage](https://timr.fox21.at/)
+- [API Reference Mainpage](https://timr.fox21.at/api/)
+- [Man pages](https://timr.fox21.at/man/timr.1.html)
+- [Code Coverage](https://timr.fox21.at/coverage/)
+- [GitHub Page](https://github.com/TheFox/timr)
+- [RubyGems Page](https://rubygems.org/gems/timr)
 - [Travis CI Repository](https://travis-ci.org/TheFox/timr)
 
+## Contributing
+
+See [Contributing](.github/CONTRIBUTING.md) page.
+
 ## License
 
-Copyright (C) 2016 Christian Mayer <http://fox21.at>
+Copyright (C) 2016 Christian Mayer <https://fox21.at>
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

data/bin/.gitignore

@@ -0,0 +1,2 @@
+dev
+dev_clean.sh

data/bin/README.md

@@ -0,0 +1,17 @@
+# bin/ Directory Overview
+
+| File | Description |
+|------|-------------|
+| build_api.sh | Build API documentation pages for <https://timr.fox21.at/api/>. |
+| build_coverage.sh | Build code coverage for <https://timr.fox21.at/coverage/>. |
+| build_info.sh | Build build.txt file for <https://timr.fox21.at/build.txt>. |
+| build_man.sh | Build manual pages. |
+| clean.sh | Clean up development files. |
+| dev_setup.sh | Development setup. |
+| install.sh | Install Timr Gem from source. |
+| publish | Upload files to <https://timr.fox21.at>. |
+| release.sh | Release gem to <https://rubygems.org/gems/timr>. |
+| test.sh | Run Unit Tests. |
+| timr | Timr Main Executable for end user. |
+| timr_bash_completion.sh | Bash Completion |
+| uninstall.sh | Uninstall Timr Gem. |

data/bin/build.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# Run all build scripts.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+cd "${SCRIPT_BASEDIR}/.."
+
+./bin/build_coverage.sh
+./bin/build_api.sh
+./bin/build_man.sh
+./bin/build_info.sh > build.txt

data/bin/build_api.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# Build API documentation pages for https://timr.fox21.at/api/.
+# Former https://timr.fox21.at/doc/.
+
+SCRIPT_BASEDIR=$(dirname "$0")
+
+
+set -e
+which rdoc &> /dev/null || { echo 'ERROR: rdoc not found in PATH'; exit 1; }
+
+cd "${SCRIPT_BASEDIR}/.."
+
+rdoc --op api README.md lib/timr