syc-task 0.0.7 → 0.1.15

data/lib/syctask/task_scheduler.rb

@@ -1,4 +1,5 @@
 require_relative 'schedule.rb'
+require_relative 'environment.rb'
 
 module Syctask
 
@@ -37,7 +38,7 @@ module Syctask
     ASSIGNMENT_PATTERN = /([a-zA-Z]):(\d+(?:,\d+|\d+;)*)/ 
 
     # Working directory
-    WORK_DIR = File.expand_path("~/.tasks")
+    WORK_DIR = Syctask::SYC_DIR #File.expand_path("~/.tasks")
 
     # Creates a new TaskScheduler. 
     def initialize
@@ -54,6 +55,7 @@ module Syctask
       unless sequential?(@work_time)
         raise Exception, "Begin time has to be before end time" 
       end
+      Syctask::log_work_time("work", @work_time)
     end
 
     # Set the busy times. Raises an exception if one begin time is after start
@@ -66,12 +68,14 @@ module Syctask
           raise Exception, "Begin time has to be before end time" 
         end
       end
+      Syctask::log_meetings("meeting", @busy_time, @meetings)
     end
 
     # Sets the titles of the meetings (busy times)
     # Invokation: set_meeting_titles("title1,title2,title3")
     def set_meeting_titles(titles)
       @meetings = titles.split(",") if titles
+      Syctask::log_meetings("meeting", @busy_time, @meetings)
     end
 
     # Sets the tasks for scheduling

data/lib/syctask/task_service.rb

@@ -1,4 +1,6 @@
+require 'csv'
 require 'yaml'
+require_relative 'environment.rb'
 
 # Syctask provides functions for managing tasks in a task list
 module Syctask
@@ -8,7 +10,7 @@ module Syctask
   class TaskService
     # Default directory where the tasks are saved to if no directory is
     # specified
-    DEFAULT_DIR = File.expand_path("~/.tasks")
+    DEFAULT_DIR = Syctask::WORK_DIR #File.expand_path("~/.tasks")
 
     # Creates a new task in the specified directory, with the specified options
     # and the specified title. If the directory doesn't exist it is created.
@@ -22,15 +24,18 @@ module Syctask
     # * tags - can be used to searching tasks that belong to a certain category
     def create(dir, options, title)
       create_dir(dir)
-      task = Task.new(options, title, create_id(dir))
+      task = Task.new(options, title, next_id(dir))
       save(dir, task)
+      Syctask::log_task("create", task)
       task.id
     end
 
     # Reads the task with given ID id located in given directory dir. If task
     # does not exist nil is returned otherwise the task is returned
     def read(dir, id)
-      task = nil
+      task = read_by_id(id)
+      return task unless task.nil?
+      #task = nil
       Dir.glob("#{dir}/*.task").each do |file|
         task = YAML.load_file(file) if File.file? file
         if not task.nil? and task.class == Syctask::Task and task.id == id.to_i
@@ -40,6 +45,16 @@ module Syctask
       nil
     end
 
+    # Reads the task identified by ID. If no task with ID is found nil is
+    # returned otherwise the task
+    def read_by_id(id)
+      return nil unless File.exists? Syctask::IDS
+      ids = File.read(Syctask::IDS)
+      entry = ids.scan(/(^#{id}),(.*\n)/)[0]
+      return YAML.load_file(entry[1].chomp) if entry
+      return nil
+    end
+
     # Finds all tasks that match the given filter. The filter can be provided
     # for :id, :title, :description, :follow_up, :due, :tags and :prio.
     # id can be eather a selection of IDs ID1,ID2,ID3 or a comparison <|=|>ID.
@@ -52,7 +67,7 @@ module Syctask
     # open tasks
     def find(dir, filter={}, all=true)
       tasks = []
-      Dir.glob("#{dir}/*").sort.each do |file|
+      Dir.glob("#{dir}/*.task").sort.each do |file|
         begin
           File.file?(file) ? task = YAML.load_file(file) : next
         rescue Exception => e
@@ -78,12 +93,16 @@ module Syctask
     # new value. If note and tags are provided these are added to the existing
     # values.
     def update(dir, id, options)
-      task_file = Dir.glob("#{dir}/#{id}.task")[0]
-      task = YAML.load_file(task_file) if task_file
+      task = read_by_id(id)
+      unless task
+        task_file = Dir.glob("#{dir}/#{id}.task")[0]
+        task = YAML.load_file(task_file) if task_file
+      end
       updated = false
       if task
         task.update(options) 
-        save(dir, task)
+        save(task.dir, task)
+        Syctask::log_task("update", task)
         updated = true
       end
       updated
@@ -94,7 +113,7 @@ module Syctask
     # returned
     def delete(dir, filter)
       deleted = 0
-      Dir.glob("#{dir}/*").each do |file|
+      Dir.glob("#{dir}/*.task").each do |file|
         begin
           File.file?(file) ? task = YAML.load_file(file) : next
         rescue Exception => e
@@ -103,6 +122,9 @@ module Syctask
         next unless not task.nil? and task.class == Syctask::Task
         if task.matches?(filter)
           deleted += File.delete(file)
+          ids = File.read(Syctask::IDS)
+          File.write(Syctask::IDS, ids.gsub("#{task.id},#{file}",""))
+          Syctask::log_task("delete", task)
         end
       end
       deleted
@@ -112,7 +134,11 @@ module Syctask
     # ~/.tasks will be set.
     def save(dir, task)
       task.dir = dir.nil? ? DEFAULT_DIR : File.expand_path(dir)
-      File.open("#{task.dir}/#{task.id}.task", 'w') {|f| YAML.dump(task, f)}
+      task_file = "#{task.dir}/#{task.id}.task"
+      unless File.exists? task_file
+        File.open(Syctask::IDS, 'a') {|f| f.puts "#{task.id},#{task_file}"}
+      end
+      File.open(task_file, 'w') {|f| YAML.dump(task, f)}
     end
 
     private
@@ -122,18 +148,32 @@ module Syctask
       FileUtils.mkdir_p dir unless File.exists? dir
     end
 
-    # Creates the task's ID based on the tasks available in the task directory.
-    # The task's file name is in the form ID.task. create_id determines
-    # the biggest number and adds one to create the task's ID.
-    def create_id(dir)
-      tasks = Dir.glob("#{dir}/*")
+    # Checks for the next possible task's ID based on the tasks available in
+    # the task directory. The task's file name is in the form ID.task. 
+    # local_ID seeks for the biggest number and adds one to determine the 
+    # next valid task ID.
+    def local_id(dir)
+      tasks = Dir.glob("#{dir}/*.task")
       ids = []
       tasks.each do |task| 
         id = File.basename(task).scan(/^\d+(?=\.task)/)[0]
         ids << id.to_i if id
       end
       ids.empty? ? 1 : ids.sort[ids.size-1] + 1
-   end
+    end
+
+    # Retrieves a new unique ID for a task. If next id is less than the next
+    # ID in the directory a warning is printed and the higher ID is taken as
+    # the next ID.
+    def next_id(dir)
+      local = local_id(dir)
+      id = File.readlines(Syctask::ID)[0] if File.exists? Syctask::ID
+      id = id ? id.to_i + 1 : 1
+      STDERR.puts "Warning: global id < local id" if id < local
+      id = [id, local].max
+      File.open(Syctask::ID, 'w') {|f| f.puts id}
+      id      
+    end
  
   end
 end

data/lib/syctask/task_tracker.rb

@@ -1,5 +1,8 @@
+require 'yaml'
+require 'fileutils'
 require_relative 'environment.rb'
 require_relative 'task_service.rb'
+#require_relative '../sycutil/console_timer.rb'
 
 module Syctask
 
@@ -14,9 +17,9 @@ module Syctask
   class TaskTracker
     
     # File name of the file where the tracked files are saved to
-    TRACKED_TASKS_FILE = Syctask::WORK_DIR + '/' + 'tracked_tasks'
+    TRACKED_TASKS_FILE = Syctask::TRACKED_TASK #Syctask::WORK_DIR + '/' + 'tracked_tasks'
     # File name of the task log file
-    TASK_LOG_FILE = Syctask::WORK_DIR + '/' + 'tasks.log'
+    TASK_LOG_FILE = Syctask::TASKS_LOG #Syctask::WORK_DIR + '/' + 'tasks.log'
 
     # Creates a new TaskTracker
     def initialize
@@ -26,19 +29,22 @@ module Syctask
 
     # When a task is started it is saved with the start time. If a task is
     # already tracked it is stopped (see #stop).  A started task will print 
-    # every 15 minutes a message to the console. 
+    # every second a message to the console if the show parameter is true.
     # start returns
     # * [false, nil ] if the task is already tracked 
     # * [true,  nil ] if the task is started and no task was running. 
     # * [true,  task] if task is started and the previously running task stopped
-    def start(task)
+    def start(task, show=true)
+      raise ArgumentError, "Error: Task without directory.\n"+
+                           "--> Update task with syctask -t <dir> update "+
+                           "#{task.id}" unless task.dir
       index = @tasks.find_index(task)
       return [false, nil] if not index.nil? and index == 0
 
       stopped_task = stop
       track = Track.new(task)
 
-      track.start
+      track.start(show)
       log_task(:start, track)
 
       @tracks.insert(0,track)
@@ -59,18 +65,15 @@ module Syctask
       return nil unless @tasks[0]
 
       task = @tasks[0]
-      if task.lead_time
-        task.lead_time += @tracks[0].stop
-      else
-        task.lead_time = @tracks[0].stop
-      end
-
+      task.update_lead_time(@tracks[0].stop)
       @service.save(task.dir, task)
+
       log_task(:stop, @tracks[0])
 
       @tracks.delete_at(0)
       @tasks.delete_at(0)
       save_tracks
+
       task
     end
 
@@ -99,7 +102,9 @@ module Syctask
       else
         @tracks ||= YAML.load_file(TRACKED_TASKS_FILE)
         @tasks = []
-        @tracks.each { |track| @tasks << @service.read(track.dir, track.id) }
+        if @tracks
+          @tracks.each { |track| @tasks << @service.read(track.dir, track.id) }
+        end
       end
     end
 
@@ -108,7 +113,7 @@ module Syctask
       FileUtils.mkdir_r Syctask::WORK_DIR unless File.exists? Syctask::WORK_DIR
       File.open(TASK_LOG_FILE, 'a') do |file|
         log_entry =  "#{type.to_s};"
-        log_entry += "#{track.id}-#{track.dir};"
+        log_entry += "#{track.id};#{track.dir};"
         log_entry += "#{track.title};"
         log_entry += "#{track.started};"
         log_entry += "#{track.stopped}" 
@@ -119,7 +124,7 @@ module Syctask
   end
 
   # A Track holds a task and stops the time the task is processed. The Track
-  # will print every 5 minutes the elapsed time and the time left to the
+  # will print every second the elapsed time and the time left to the
   # specified Task#duration. 
   class Track
 
@@ -139,17 +144,22 @@ module Syctask
       @dir = task.dir
       @id = task.id
       @title = task.title
+      @duration = task.remaining.to_i
+      @semaphore = "#{Syctask::SYC_DIR}/#{@id}.track"
     end
 
-    # Starts the tracking and a timer that will print to STDOUT every 5 minutes
+    # Starts the tracking and a timer that will print to STDOUT every second
     # the elapsed time and the time left until Task#duration
-    def start
+    def start(show)
       @started ||= Time.now
-      # start a timer that prints title and elapsed time every 5 minutes
+      # start a timer that prints id and elapsed time 
+      FileUtils.touch @semaphore
+      system "console_timer #{@duration} #{@id} #{@semaphore} &" if show
     end
     
     # Stops the task tracking and returns the lead time of the task
     def stop
+      FileUtils.rm @semaphore if @semaphore and File.exists? @semaphore
       @stopped ||= Time.now
       @stopped - @started
     end

data/lib/syctask/times.rb

@@ -20,6 +20,35 @@ module Syctask
       @m > 0 ? @h+1 : @h
     end
 
+    # Returns a Time object with the current date and the hour and minute of 
+    # this Times object
+    def time
+      now = Time.now
+      Time.local(now.year,now.mon,now.day,@h,@m,0)
+    end
+
+    # Calculates the difference between this time and the provided time. If no
+    # time is given the current time is used.
+    #     Example:
+    #     This time  =  9:35
+    #     New time   = 10:20
+    #     diff(time) =  0:45
+    # Will return [hour,min] in the example [0,45] 
+    def diff(time = Time.now)
+      diff_minutes = (time.hour - @h) * 60 + (time.min - @m)
+      signum = diff_minutes == 0 ? 0 : diff_minutes / diff_minutes.abs
+      diff_h = diff_minutes.abs / 60
+      diff_m = diff_minutes.abs % 60
+      if signum < 0
+        if diff_h > 0
+          [signum * diff_h, diff_m]
+        else
+          [diff_h, signum * diff_m]
+        end
+      else
+        [diff_h, diff_m]
+      end
+    end
   end
 
 end

data/lib/syctask/version.rb

@@ -1,5 +1,5 @@
 # Syctask provides functions for managing tasks in a task list
 module Syctask
   #Holds the version number of syctask
-  VERSION = '0.0.7'
+  VERSION = '0.1.15'
 end

data/lib/syctime/time_util.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 # Functions for time operations
 module Syctime
 
@@ -6,13 +8,13 @@ module Syctime
   def seconds_to_time(seconds)
     seconds = seconds.round
     duration = []
-    duration << seconds % 60                             # seconds
-    duration << seconds / 60 % 60                        # minutes
-    duration << seconds / 60 / 60 % 60                   # hours
-    duration << seconds / 60 / 60 / 60 % 24              # days
-    duration << seconds / 60 / 60 / 60 / 24 % 7          # weeks
-    duration << seconds / 60 / 60 / 60 / 24 / 7 % 4      # months
-    duration << seconds / 60 / 60 / 60 / 24 / 7 / 4 % 12 # years
+    duration << seconds % 60                         # seconds
+    duration << seconds / 60 % 60                    # minutes
+    duration << seconds / 60 / 60 % 24               # hours
+    duration << seconds / 60 / 60 / 24 % 7           # days
+    duration << seconds / 60 / 60 / 24 / 7 % 4       # weeks
+    duration << seconds / 60 / 60 / 24 / 7 / 4 % 12  # months
+    duration << seconds / 60 / 60 / 24 / 7 / 4 / 12  # years
   end
 
   # Translates seconds into a time string like 1 year 2 weeks 5 days 10 minutes.
@@ -27,4 +29,41 @@ module Syctime
     time_string
   end
 
+  # Creates a time string separating hours, minutes and seconds with the
+  # provided separator like 12:50:33
+  def separated_time_string(seconds, separator)
+    secs  = seconds % 60
+    mins  = seconds / 60 % 60
+    hours = seconds / 60 / 60 
+    time_string = sprintf("%02d#{separator}%02d#{separator}%02d", hours, mins, secs)
+  end
+
+  # Translates a time in the ISO 8601 schema to a time object.
+  #     2013-04-09 21:45 -200
+  def time_for_string(time)
+    time = time.scan(/\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}/)[0].sub(' ','T')
+    Time.xmlschema(time)
+  end
+  
+  # Tests whether the date is between from and to. Returns true then otherwise
+  # false. Time, from and to are Time objects as retrieved from Time.now or
+  # Time.local(2013,"apr",13,10,50,0). Alternatively time strings can be
+  # provided in the form of "2013-04-13".
+  def date_between?(date, from, to)
+    date = date.strftime("%Y-%m-%d") if date.class == Time
+    from = from.strftime("%Y-%m-%d") if from.class == Time
+    to   = to.strftime("%Y-%m-%d")   if to.class   == Time
+    time_pattern = /\d{4}-\d{2}-\d{2}/
+    raise ArgumentError if date.scan(time_pattern).empty?
+    raise ArgumentError if from.scan(time_pattern).empty?
+    raise ArgumentError if to.scan(time_pattern).empty?
+    date >= from && date <= to
+  end
+
+  # Checks whether the time is between from and to. Returns true then otherwise
+  # false. time, from and to have to be Time objects.
+  def time_between?(time, from, to)
+    time >= from && time <= to
+  end
+
 end

data/lib/sycutil/console_timer.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'rainbow'
+
+# ConsoleTimer prints a task and the lead time at the upper right corner of the
+# schreen. Invokation example:
+# * Create a semaphore like id.track
+# * Console time in a new ruby process
+#    semaphore = File.expand_path("~/.syc/syctask/#{id}.track"
+#    FileUtils.touch semaphore
+#    system "ruby lib/sycutil/console_timer.rb 60 10 semaphore"
+# This will start the ConsoleTimer with a lead time of 1 minute for task 10.
+# To stop the timer the semaphore has to be deleted
+#    FileUtils.rm semaphore
+class ConsoleTimer
+
+  # Create a new ConsoleTimer with the time to count down, the task's ID and a
+  # semaphore. The semaphore is a file named id.track where id is equal to the
+  # provided id. The semaphore is checked for existence. If the semaphore is
+  # deleted than ConsoleTimer is stopped.
+  def initialize(time, id, semaphore)
+    @time = time.to_i
+    @id = id
+    @start = Time.now
+    @semaphore = semaphore
+  end
+
+  # Starts the timer. The timer is run as long the semaphore is available
+  def start
+    track = true
+    while track
+      sleep 1
+      output
+      track = File.exists? @semaphore
+    end
+    exit 0
+  end
+
+  # Prints the id and the lead time of the currently tracked task. As long as
+  # the provided time is greater than 0 the time is printed in green, otherwise
+  # red
+  def output
+    color = :green
+    difference = @time - (Time.now - @start).round
+    if difference < 0
+      difference = difference.abs
+      color = :red
+    end
+    seconds = difference % 60
+    minutes = difference / 60 % 60
+    hours   = difference / 60 / 60 % 60 
+    count_down = sprintf("%d: %02d:%02d:%02d", @id, hours, minutes, seconds)
+    size = count_down.size
+    count_down = count_down.color(color)
+    command = "tput sc;"+
+              "tput cup 0 $(($(tput cols) - #{size}));"+
+              "echo #{count_down};tput rc"
+    system command
+  end
+
+end
+
+# Expects to receive parameters duration, id and semaphore
+if ARGV.size == 3
+  duration = ARGV.shift
+  id = ARGV.shift
+  semaphore = ARGV.shift
+  timer = ConsoleTimer.new(duration, id, semaphore)
+  timer.start
+else
+  exit -1
+end
+
+