tempo-cli 0.1.0

data/bin/tempo

@@ -0,0 +1,477 @@
+#!/usr/bin/env ruby
+
+# In development, you need to use `bundle exec bin/tempo` to run this app
+require 'gli'
+require 'tempo'
+require 'pry'
+include GLI::App
+# to preserve all the args in ARGV:
+# preserve_argv
+
+program_desc 'Command line time tracking by project'
+
+version Tempo::VERSION
+
+# == GLOBAL OPTIONS ==
+
+desc 'verbose output'
+long_desc 'include verbose reporting in the command output'
+switch [:v, :verbose]
+
+desc 'output id'
+long_desc 'include id reporting in the command output'
+switch [:i, :id]
+
+# desc 'Describe some flag here'
+# default_value 'the default'
+# arg_name 'The name of the argument'
+# flag [:f,:flagname]
+
+# COMMAND: PROJECT
+
+desc 'Manage the Projects that timed tasks are assigned to'
+long_desc "Manage the Projects that timed tasks are assigned to.
+
+Manage the Projects that timed tasks are assigned to.
+By default, lists the current project, or with --list tag, lists all projects.
+The active project will be marked by an asterisk.
+
+If supplied with arguments and no command options,
+a new project will be added.
+
+Arguments supplied to --list, --delete, and --[un]tag
+will use fuzzy matching unless you:
+
+ - Use the --exact flag to match the arguments exactly
+
+ - Use the --id tag to match by id
+
+examples:
+
+# list current project
+
+$ tempo project
+
+# list all projects
+
+$ tempo project --list
+
+# adding a new project titled 'star gazing'
+
+$ tempo project star gazing
+
+# adding a new project with a tag
+
+$ tempo project --add star gazing --tag cellar
+
+# untagging and tagging an existing project
+
+$ tempo project star gazing --untag cellar --tag stellar"
+
+arg_name '"name of the project"'
+command [:project, :p] do |c|
+
+  c.desc 'Add a Project'
+  c.long_desc "Add a Project (default command behavior). When used with --tag adds a new project with the given tag"
+  c.switch [:a, :add], negatable: false
+
+  c.desc 'List Projects'
+  c.long_desc "Lists all projects that match the supplied argument"
+  c.switch [:l, :list], negatable: false
+
+  c.desc 'Exact Match'
+  c.long_desc "Match project with an exact title"
+  c.switch [:e, :exact]
+
+  c.desc 'List by or perform command by project id'
+  c.long_desc 'show IDs in output or perform command by matching to id'
+  c.switch [:i, :id], negatable: false
+
+  c.desc 'Delete a Project'
+  c.default_value nil
+  c.arg_name 'title'
+  c.flag [:d, :delete]
+
+  c.desc 'Tag a Project'
+  c.long_desc "Tag a project with one-word tags. Pass multiple tags in quotes to add multiple tags"
+  c.default_value nil
+  c.arg_name 'tagword'
+  c.flag [:t, :tag]
+
+  c.desc 'Untag a Project'
+  c.default_value nil
+  c.arg_name 'tagword'
+  c.flag [:u, :untag]
+
+  c.action do |global_options, options, args|
+
+    controller = Tempo::Controllers::Projects
+
+    # tag a project
+    #
+    if options[:tag]
+      controller.tag options, args
+
+    # untag a project
+    #
+    elsif options[:untag]
+      controller.tag options, args
+
+    # delete a project
+    #
+    elsif options[:delete]
+      controller.delete options, args
+
+    # add a project
+    #
+    elsif !options[:list] && !args.empty?
+      controller.add options, args
+
+    elsif !options[:list] && args.empty?
+      controller.show_active
+
+    # list projects, fiter by args
+    #
+    else
+      controller.index options, args
+    end
+  end
+end
+
+# COMMAND: CHECKOUT
+
+desc 'Checkout a project to track time against'
+long_desc "Checkout the Projects that timed tasks are assigned to.
+
+Arguments supplied will use fuzzy matching unless you:
+
+ - Use the --exact flag to match the arguments exactly
+
+ - Use the --id tag to match by id
+
+examples:
+
+# checking out an existing project titled 'star gazing'
+
+$ tempo checkout star gazing
+
+# adding and checking out a new project titled 'star gazing'
+
+$ tempo checkout -a star gazing"
+
+arg_name '"name of the project"'
+command [:checkout, :c] do |c|
+
+  c.desc 'Add and Checkout a new project'
+  c.arg_name 'title'
+  c.flag [:a, :add]
+
+  c.desc 'use an exact match for project title'
+  c.switch [:e, :exact]
+
+  c.desc 'checkout by project id'
+  c.switch [:i, :id], negatable: false
+
+  c.action do |global_options,options,args|
+
+    controller = Tempo::Controllers::Checkout
+
+    # add and checkout a project
+    #
+    if options[:add]
+      controller.add_project options, args
+
+    # checkout existing project
+    else
+      if args.empty?
+        controller.assistance
+      else
+        controller.existing_project options, args
+      end
+    end
+  end
+end
+
+
+# COMMAND: ARRANGE
+
+desc 'Arrange project hierarchy'
+long_desc "Arrange projects into a parent/child hierarchy
+
+New projects are added as root projects by default.
+
+Use the --child flag with the project command to add a new project as the child of the current project
+
+Use arrange to arrange existing projects as child or root projects.
+
+Arguments supplied will use fuzzy matching unless you:
+
+ - Use the --exact flag to match the arguments exactly
+
+ - Use the --id tag to match by id
+
+examples:
+
+# Arrange an existing project as a root project
+
+$ tempo arrange : aquascaping
+
+# Arrange an existing project as a child project
+
+$ tempo arrange aquascaping : coral pruning"
+
+arg_name '[parent project] : child project'
+command [:arrange, :a] do |c|
+
+  c.desc 'use an exact match for project title'
+  c.switch [:e, :exact]
+
+  c.desc 'checkout by project id'
+  c.switch [:i, :id]
+
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::Arrange
+    controller.parse options, args
+  end
+end
+
+# COMMAND: EDIT
+
+# COMMAND: START
+
+desc 'Start a time entry'
+long_desc "Starts a new time entry, and closes out any running time entries.
+
+You can also add a description of the time entry.
+
+To start a time entry at a time other than the current, pass it in as an argument
+to the --at flag.  This will accept a number of human readable formats, multiple
+word time formats should be enclosed in quotes.
+
+examples:
+
+# start a new time record at the current time with no description
+
+$ tempo start
+
+# start and end a previous time record with a description
+
+$ tempo start learning how to do the Hustle --at 'yesterday at 8:00 in the evening' --end 'yesterday at 11:59pm'
+"
+
+arg_name 'description'
+command [:start, :s] do |c|
+
+  c.desc 'end the entry at a given time'
+  c.arg_name 'time'
+  c.flag [:e, :end]
+
+  c.desc 'start the entry at a given time'
+  c.arg_name 'time'
+  c.flag [:a, :at]
+
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::Start
+
+    controller.start_timer options, args
+  end
+end
+
+# COMMAND: END
+
+desc 'End a time entry'
+long_desc "Closes out any running time entries.
+
+You can optionally add a description of the time entry, which will overwrite the current description.
+
+To end a time entry at a time other than the current, pass it in as an argument
+to the --at flag.  This will accept a number of human readable formats, multiple
+word time formats should be enclosed in quotes.
+
+examples:
+
+# creating an entry at 4:55pm, then ending it 5 minutes later and changing the description
+
+$ tempo start --at 16:55 practicing the human torch trick
+
+$ tempo end --at 'today at 5:00pm' learning how to stop, drop, and roll
+"
+
+
+arg_name 'time out, defaults to now'
+command [:end, :e] do |c|
+
+  c.desc 'time'
+  c.arg_name 'end the current time entry at the given time'
+  c.flag [:a, :at]
+
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::End
+
+    controller.end_timer options, args
+  end
+end
+
+# COMMAND: REPORT
+
+desc 'Report time entries'
+long_desc "Reports time entries for a day or a period of days.
+
+By default, lists the last recorded day's entries.
+
+To list a different day, supply a day as the args
+
+To list a series of records, include a --from and --to value
+
+examples:
+
+# report current day's entries
+
+$ tempo report
+
+# report a different day
+
+$ tempo report 11/24/14
+
+# report the past week
+
+$ tempo report -f 'a week ago'
+
+# report a period of days
+
+$ tempo report -f 'last monday' -t 'last friday'"
+
+arg_name '[day]'
+command [:report, :r] do |c|
+
+  c.desc 'begin time records on this date'
+  c.arg_name 'time'
+  c.default_value 'last record'
+  c.flag [:f, :from]
+
+  c.desc 'end time records on this date'
+  c.arg_name 'time'
+  c.default_value 'today'
+  c.flag [:t, :to]
+
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::Report
+
+    controller.report options, args
+  end
+end
+
+# COMMAND: UPDATE
+
+desc 'update a time entry'
+long_desc "update the project, start time, or end time for a time
+entry.
+
+Defaults to the current time entry, or most recently completed time entry
+if none are running.  Optionally, you can supply an id for a time entry on the current
+day, or a day and id to update previous time entries.
+
+The description, if passed in, will be used to replace the existing description. You can
+also change the start or end time, or delete the entire time entry.
+
+examples:
+
+# update description for the last time entry
+
+$ tempo update practicing banjo
+
+# update the description for yesterday's entry with id of 2
+
+$ tempo update --id 2 --on 'yesterday' practicing banjo
+
+# update the start time for the last time entry
+
+$ tempo update --start 7:00
+
+# update the end time and description
+
+$ tempo update --end '8:00pm' practicing banjo
+
+# delete the last time entry
+
+$ tempo update --delete
+
+# update the description, start, and end time for a previous day's entry
+
+$ tempo update --on 1/17/14 --start \"1/17/14 8am\" --end \"1/17/14 10am\" practicing banjo
+"
+
+arg_name '[description]'
+command [:update, :u] do |c|
+
+  c.desc 'Select by Id'
+  c.arg_name 'number'
+  c.flag [:i, :id]
+
+  c.desc 'Select On Date'
+  c.arg_name 'date'
+  c.flag [:o, :on]
+
+  c.desc 'Update to the active project'
+  c.switch [:p, :project], negatable: false
+
+  c.desc 'Update the Start Time'
+  c.arg_name 'time'
+  c.flag [:s, :start]
+
+  c.desc 'Update the End Time'
+  c.arg_name 'time'
+  c.flag [:e, :end]
+
+  c.desc 'Delete a Time Entry'
+  c.switch [:d, :delete], negatable: false
+
+  c.action do |global_options, options, args|
+    controller = Tempo::Controllers::Update
+
+    controller.parse options, args
+  end
+end
+
+pre do |global,command,options,args|
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+
+  # add reporting of all arguments
+  if global[:v]
+    Tempo::Views::options_report command.name, global, options, args
+  end
+
+  Tempo::Views::initialize_view_options command.name, global, options
+
+  # Load the stored records
+  Tempo::Controllers::Records.initialize_from_records options, args
+
+  # TODO: send formats in through global options, and then:
+  # Tempo::Views::Reporter.add_formats
+
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+
+  Tempo::Views::Reporter.report
+
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+
+  # remove before distribution:
+  #puts exception.backtrace
+
+  true
+end
+
+exit run(ARGV)

data/features/arrange.feature

@@ -0,0 +1,43 @@
+Feature: Arrange Command manages the hierarchy of a list of projects
+  Projects can be ordered as root projects or children of other projects
+  The arrange command manages the relationship between parentg and child projects
+
+  Scenario: Arranging a project as a root projects
+    Given an existing project file
+    When I successfully run `tempo arrange : basement mushrooms`
+    Then the stdout should contain "root project:\nbasement mushrooms"
+    And the project file should contain ":parent: :root" at line 20
+
+  Scenario: Arranging a project as a child of another project
+    Given an existing project file
+    When I successfully run `tempo arrange horticulture : nano aquarium`
+    Then the stdout should contain "parent project:\nhorticulture"
+    And the stdout should contain "child project:\nnano aquarium"
+    And the project file should contain ":parent: 1" at line 39
+    And the project file should contain "- 5" at line 7
+
+  Scenario: Attempting to arrange projects without using a colon in the args
+    Given an existing project file
+    When I run `tempo arrange horticulture aquaculture`
+    Then the stderr should contain "arrange requires a colon (:) in the arguments"
+
+  Scenario: Attempting to arrange a root project as a root project
+    Given an existing project file
+    When I run `tempo arrange : horticulture`
+    Then the stdout should contain "already a root project:\nhorticulture"
+
+  Scenario: Arranging projects by id
+    Given an existing project file
+    When I successfully run `tempo arrange -i 4 : 1`
+    Then the stdout should contain "parent project:\naquaculture"
+    And the stdout should contain "child project:\nhorticulture"
+    And the project file should contain ":parent: 4" at line 3
+    And the project file should contain "- 1" at line 31
+
+  Scenario: Arranging projects by exact match
+    Given an existing project file
+    When I successfully run `tempo arrange -e reading aquaculture digest : aquaculture`
+    Then the stdout should contain "parent project:\nreading aquaculture digest"
+    And the stdout should contain "child project:\naquaculture"
+    And the project file should contain ":parent: 6" at line 29
+    And the project file should contain "- 4" at line 47

data/features/checkout.feature

@@ -0,0 +1,63 @@
+Feature: Checkout Command manages the active project
+  A New project can be added and checked out
+  An Exiting project can be checked out
+
+  Scenario: Checkout an existing project with checkout
+    Given an existing project file
+    When I successfully run `tempo checkout "backyard bonsai"`
+    Then the stdout should contain "switched to project:\nbackyard bonsai"
+    And the project file should contain ":current: true" at line 18
+
+  Scenario: Checkout an exising project with c
+    Given an existing project file
+    When I successfully run `tempo c "backyard bonsai"`
+    Then the stdout should contain "switched to project:\nbackyard bonsai"
+    And the project file should contain ":current: true" at line 18
+
+  Scenario: Checkout an existing project by partial match
+    Given an existing project file
+    When I successfully run `tempo checkout "bonsai"`
+    Then the stdout should contain "switched to project:\nbackyard bonsai"
+    And the project file should contain ":current: true" at line 18
+
+  Scenario: Checkout a project by id
+    Given an existing project file
+    When I successfully run `tempo checkout -i 3`
+    Then the stdout should contain "switched to project:\nbasement mushrooms"
+
+  Scenario: Checkout a project by exact match
+    Given an existing project file
+    And I successfully run `tempo checkout -e aquaculture`
+    Then the stdout should contain "switched to project:\naquaculture"
+    And the stdout should not contain "switched to project:\nreading aquaculture digest"
+
+  Scenario: Attempting to Checkout an existing project by partial match with multiple possibilities
+    Given an existing project file
+    And I run `tempo checkout aquaculture`
+    Then the stdout should contain "The following projects matched your search:"
+    And the stdout should contain "aquaculture"
+    And the stdout should contain "reading aquaculture digest"
+    And the stderr should contain "error: cannot checkout multiple projects"
+
+  Scenario: Attempting to Checkout the current project
+    Given an existing project file
+    When I successfully run `tempo checkout "horticulture"`
+    Then the stdout should contain "already on project:\nhorticulture"
+
+  Scenario: Attempting to checkout a non-existant project
+    Given an existing project file
+    When I run `tempo checkout "new project"`
+    And the stdout should not contain "switched"
+    Then the stderr should contain "no projects match the request: new project"
+
+  Scenario: Adding and checking out a new project
+    Given an existing project file
+    When I successfully run `tempo checkout --add "bathtup scuba diving"`
+    Then the stdout should contain "switched to project:\nbathtup scuba diving"
+    And the project file should contain ":title: bathtup scuba diving"
+    And the project file should contain ":current: true"
+
+  Scenario: Attempting to add an exising project
+    Given an existing project file
+    When I run `tempo checkout --add "basement mushrooms"`
+    Then the stderr should contain "error: project 'basement mushrooms' already exists"

data/features/end.feature

@@ -0,0 +1,65 @@
+Feature: End Command ends the current time record
+  The end command ends the currenly running time record. It can be passed a value
+  that will end the record at a given time
+
+  Scenario: Attempting to add time before any projects exist
+    Given a clean installation
+    When I run `tempo end`
+    Then the stderr should contain "no projects exist"
+    And the project file should contain "#" at line 1
+
+  Scenario: Attempting to end a time record when none are running
+    Given an existing project file
+    When I run `tempo end`
+    Then the stderr should contain "no running time records exist"
+
+  Scenario: Ending the current time record
+    Given an existing project file
+    When I run `tempo start`
+    And I run `tempo end`
+    Then the stdout should contain "time record ended"
+    And the output should match /\d{2}:\d{2} - \d{2}:\d{2}[^\*]/
+
+  Scenario: Ending the current time record and changing the description
+    Given an existing project file
+    When I run `tempo start old description`
+    And I run `tempo end new description`
+    Then the stdout should contain "time record ended"
+    And the output should contain "new description"
+    And the output should match /\d{2}:\d{2} - \d{2}:\d{2}[^\*]/
+
+  Scenario: Attempting to add an invalid end time
+    Given an existing project file
+    When I run `tempo start`
+    When I run `tempo end --at "invalid time"`
+    Then the stderr should contain "no valid timeframe matches the request: invalid time"
+
+  Scenario: Ending a time record for a specific time
+    Given an existing project file
+    When I run `tempo start --at "1-5-2014 7:00"`
+    And I run `tempo end --at "1-5-2014 15:00"`
+    Then the stdout should contain "time record ended"
+    And the output should match /7:00 - 15:00/
+@pending
+  Scenario: Attempting to end after the beginning time
+    Given an existing project file
+    When I run `tempo start --at "1-5-2014 17:00"`
+    And I run `tempo end --at "1-5-2014 6:00"`
+    Then the stderr should contain "you cannot end a time record before the starting time"
+
+@pending
+  Scenario: Ending a time record with tags
+    Given an existing project file
+@pending
+  Scenario: Ending a time record on a previous day
+    Given an existing project file
+    When I run `tempo start --at "1-1-2014 7:00"`
+    And I run `tempo end --at "1-3-2014 10:00"`
+    Then the stdout should contain "time record ended"
+    And the time record 20140101 should contain ":end_time: 2014-01-01 23:59" at line 5
+    And the time record 20140102 should contain ":end_time: 2014-01-01 23:59" at line 5
+    And the time record 20140103 should contain ":end_time: 2014-01-01 10:00" at line 5
+
+
+
+