syc-task 0.2.1 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWMwMWJhYWJhZGY4YTNjZGUyMmY1ODEwMTJhNzI4ZDZlZjYzOTI2NQ==
+    ZTA1MGU1ZWJhNTQwMTQ2MzczY2M0ZjcyODUwMjdjYWFhY2Y4NzE5OA==
   data.tar.gz: !binary |-
-    YTcyYzcyOThjZDFlYzQyOTgyNWI0YWZiYzNhMmE5NDMwNzFhNGE4Zg==
+    NjliNTYxODBjMTYxYTc4NjM1YTY0YjA5YmZlMDEyZDkyNDlmMjFjNg==
 SHA512:
   metadata.gz: !binary |-
-    YWYyYjM0Njk1MDM3ZGY2MTMwYWU1M2RjODZhYTE0MjAzOGIyNTc0YzkxNTVh
-    MDliMjVmODgyZDY5ZGVhMDg2ZWQyNzRiYzMyZTZmNDY5MDFmNmQwZmM3Yzdi
-    MjNjMTA0YTJiMmZlZmUxZTExMjE3YzI2MWMwNmEzMzhjNDgxMDk=
+    MGE4YzkwMWYyMjZkOWI0ZDMwYzVlZWIyY2I1NWY4YTgyODIzZmNhMjAzNThi
+    NjIzZjZlOTQ0N2IwOTU4ZjI4MTJlNjQ2YzYxOWI5NTBiMTMxMjVhMjVkNDQ5
+    N2JiYWU5MDRjNjQ0NWU0NTlmYzUwODliMWU2YWQxMjRiNTIwODI=
   data.tar.gz: !binary |-
-    ZTYyNzAyNzAzNzdiYWZjYTI3MzU0N2YzYzU1NGNiZTRiNWY5NzhjMmY3MzA5
-    ZjBkYTJjMjE5N2FjZGE0YzQ4OTgyNmM1ZTJhNTY0ZjVhNTliMmY5M2E1MGJi
-    NWQ1YzAyODc0MzRiMmQ0ZDc4YWQ3MGZjMzZhZDg2NTdjZWI5OTU=
+    YjdkMTFlMzExMjA3YjIwM2RlZTdjN2JjZTc5YWMwNTQ0YTIxZmE4ZmE0N2I1
+    NmZhMGQyMGIyZjcwMDEwMmIxMTBiZTNhZWU3MjEwODUxMzBlYWQ4ZmQwY2My
+    ODA4N2Q1NmNmMjQxZjlmZWZkOGQ1ZTU4MTc4Njg3OWQ2ODUxNWE=

data/README.rdoc

@@ -36,6 +36,60 @@ will prompt for task titles. Ctrl-D will end input.
 
 Except for --description you can also provide short forms for the options.
 
+===Create tasks by scanning from files
+When writing minutes of meetings tasks that should be followed up in syctask
+can be annotated so they will be recognized by the scan command. The following
+structure shows how to annotade tasks
+
+    Some text before
+
+    @task;
+    title;description;follow_up;due_date,prio
+    Schedule meeting;Invite all developers;2016-09-12;2016-10-12;1
+    Write letter;Practice writing letters;;;3
+
+    Some text after
+
+The above annotation will only scan the next task because of the singular 'task'
+where the task values are separated with ';'. The line after the annotation
+'@task' lists the sequence of the fields of the task. It is also possible to 
+list the tasks in a table, e.g. markdown
+
+    Some text before
+
+    @tasks|
+    title           |description               |follow_up |due_date  |prio
+    ----------------|--------------------------|----------|----------|----
+    Schedule meeting|Invite all developers     |2016-09-12|2016-10-12|1
+    Write letter    |Practice writing letters  |          |          |3
+
+    Some text after
+
+    Call partner    |Ask for project's progress|2016-09-14|          |1
+
+    Even more text 
+
+The example above scans all tasks due to the plural 'tasks'. It also scans all
+tasks that are separated with non-task text and occur after the annotation and 
+confirm to the field structure. Lines that start with '-' will be ignored. So 
+if you want to skip only a view tasks within a task list prepend them with '-'.
+If you have tasks with different fields then you have to add another annotation
+with the new field structure. 
+
+Possible fields are
+
+    title       - the title of the task
+    description - the description of the task
+    follow_up   - the follow-up date of the task in the form yyyy-mm-dd
+    due_date    - the due-date of the task in the form yyyy-mm-dd
+    prio        - the priority of the task
+    tags        - tags the task is annotated with
+    note        - a note for the task
+
+Scanning tasks from a file
+
+    $ syctask scan 2016-09-10-mom.md 2016-09-09-mom.md
+
 ===Plan tasks
 The plan command will print tasks and prompts whether to (a)dd or (s)kip the 
 task. If (q)uit is selected the tasks already added will be add to the today's 
@@ -57,9 +111,9 @@ Invoke plan with a filter
 Move tasks to another days plan
     $ syctask plan today --move tomorrow --id 3,5
 
-This will move the tasks with ID 3 and 5 from the today's plan to the tomorrow's 
-plan. The duration will be set to the remaining processing time but at least to
-30 minutes.
+This will move the tasks with ID 3 and 5 from the today's plan to the 
+tomorrow's plan. The duration will be set to the remaining processing time but 
+at least to 30 minutes.
 
 ===Prioritize tasks
 Planned tasks can be prioritized in a pair wise comparisson. So each task is
@@ -521,18 +575,26 @@ Version 0.2.1
   also define directories to be excluded. This is especially helpful to omit 
   search in large mounted directories, like from NAS servers.
 
+Version 0.3.1
+* Add csv output spearated by ';' to the list command
+* Fix bug when schedule file is empty
+* Add scan command to scan tasks from files
+
 ==Development
 Pull from Github and then run 
 
     $ bundle install 
     
+New classes have to be added to 'lib/syctask.rb'
+
 Debugging the interface can be done with GLI_DEBUG: 
 
     $ bundle exec env GLI_DEBUG=true bin/syctask
 
-Building the gemfile
+Building and pushing the gemfile to Rubygems
 
     $ gem build syctask.gemspec
+    $ gem push syc-task-0.2.1.gem
 
 ==Tests
 The test files live in the folder test and start with test_.
@@ -541,10 +603,17 @@ There is a rake file available to run all tests
 
     $ rake test
    
+The CLI is tested with Cucumber. To run the Cucumber features in verbose mode
+
+    $ cucumber
+
+or if you prefer cleaner output run
+
+    $ rake features
+
 ==License
 syc-task is released under the {MIT License}[http://opensource.org/licenses/MIT]
 
 ==Links
 * [http://www.github.com/sugaryourcoffee/syc-task] - Source code on GitHub
-* [http://syc.dyndns.org/drupal/wiki/syc-task] - Development notebook
-* [https://rubygems.org/gems/syc-backup] - RubyGems
+* [https://rubygems.org/gems/syc-task] - RubyGems

data/bin/syctask

@@ -97,7 +97,7 @@ command :info do |c|
 
   c.action do |global_options,options,args|
     dir = options[:dir]
-    dir ||= "~"
+    dir ||= ENV['HOME']
     dir = File.expand_path(dir)
     help_now! "Directory #{dir} does not exists" unless File.exists? dir
     id = options[:id]
@@ -184,7 +184,24 @@ desc 'Extract tasks from a file'
 arg_name 'TASK_FILE'
 command :scan do |c|
   c.action do |global_options,options,args|
-    puts "scan command not implemented yet"
+    help_now! "You must provide file(s) to extract tasks from" if args.empty?
+    scanner = Syctask::Scanner.new
+    task_numbers = []
+    args.each do |file|
+      scanner.scan(file).each do |title, options| 
+        task_number = @service.create(global_options[:t], options, title)
+        add_task_to_plan @service.read(global_options[:t], task_number)
+        task_numbers << task_number
+      end
+    end
+    
+    if task_numbers.empty?
+      puts
+      help_now! "#{args.join(', ')} doesn't contain tasks"
+    else
+      STDOUT.puts sprintf("%s %s", "--> created tasks with task numbers",
+                          " #{task_numbers.join(', ')}").color(:green)
+    end
   end
 end
 
@@ -225,6 +242,9 @@ command :list do |c|
   c.desc 'Print complete task'
   c.switch [:c, :complete]
 
+  c.desc 'Print as csv separated by ";"'
+  c.switch [:csv]
+
   c.desc 'Filter for ID'
   c.arg_name 'ID1,ID2,ID3|[<|=|>]ID'
   c.flag [:i, :id], :must_match => /^\d+(?:,\d+)*|^[<|=|>]\d+/ 
@@ -260,15 +280,20 @@ command :list do |c|
   c.action do |global_options,options,args|
     filter = [:id, :tags, :description, :prio, :due_date, :follow_up, 
               :note, :title]
+    csv = options[:csv]
     all = options[:all]
     complete = options[:complete]
     options.keep_if {|key, value| filter.find_index(key) and value != nil}
     count = 0
     @service.find(global_options[:t], options, all).each do |task|
-      task.print_pretty(complete)
-      count += 1
+      if csv
+        task.print_csv
+      else
+        task.print_pretty(complete)
+        count += 1
+      end
     end      
-    STDOUT.puts sprintf("--> found %d tasks", count).color(:green)
+    STDOUT.puts sprintf("--> found %d tasks", count).color(:green) unless csv
   end
 end
 

data/lib/syctask.rb

@@ -4,6 +4,7 @@ require 'syctask/task.rb'
 require 'syctask/task_service.rb'
 require 'syctask/task_scheduler.rb'
 require 'syctask/task_planner.rb'
+require 'syctask/scanner.rb'
 require 'syctask/schedule.rb'
 require 'syctask/task_tracker.rb'
 require 'syctask/environment.rb'

data/lib/syctask/environment.rb

@@ -3,7 +3,7 @@ require 'find'
 module Syctask
 
   # System directory of syctask
-  SYC_DIR = File.expand_path('~/.syc/syctask')
+  SYC_DIR = File.join(ENV['HOME'], '.syc/syctask') # expand_path('~/.syc/syctask')
   # ID file where the last issued ID is saved
   ID = SYC_DIR + "/id"
   # File that contains all issued IDs
@@ -28,7 +28,7 @@ module Syctask
   # User specified default working directory
   work_dir = dir if not dir.nil? and not dir.empty? and File.exists? dir
   # Set eather user defined work directory or default
-  WORK_DIR = work_dir.nil? ? File.expand_path('~/.tasks') : work_dir
+  WORK_DIR = work_dir.nil? ? File.join(ENV['HOME'], '.tasks') : work_dir
 
   # Logs a task regarding create, update, done, delete
   def log_task(type, task)
@@ -177,9 +177,9 @@ module Syctask
             blacklisted_dirs = gets.chomp.split(/\s+/)
                                          .map { |f| File.expand_path(f) }
           else
-            whitelisted_dir = [File.expand_path("~")]
+            whitelisted_dir = [ENV['HOME']]
             puts "Searching directories and all sub-directories starting in\n"+
-                 "#{File.expand_path("~")}"
+                 "#{ENV['HOME']}"
           end
         end
         [1, whitelisted_dirs, blacklisted_dirs]

data/lib/syctask/task.rb

@@ -13,14 +13,19 @@ module Syctask
 
     include Comparable
 
+    # The fields that can be set for a task
+    FIELDS = ["title", "description", 
+              "follow_up", "due_date", "prio", 
+              "note", "tags"]
     # Holds the options of the task. 
     # Options are
     # * description - additional information about the task
-    # * follow_up - follow-up date of the task
-    # * due - due date of the task
-    # * prio - priority of the task
-    # * note - information about the progress or state of the task
-    # * tags - can be used to search for tasks that belong to a certain category
+    # * follow_up   - follow-up date of the task
+    # * due_date    - due date of the task
+    # * prio        - priority of the task
+    # * note        - information about the progress or state of the task
+    # * tags        - can be used to search for tasks that belong to a certain 
+    #                 category
     attr_accessor :options
     # Title of the class
     attr_reader :title
@@ -285,14 +290,14 @@ module Syctask
     # id;title;description;prio;follow-up;due;note;tags;created;
     # updated|UNCHANGED;DONE|OPEN
     def csv_string
-      string = "\n#{@id};#{@title};"
-      string +" #{@options[:description]};#{@options[:prio]};"
+      string =  "#{@id};#{@title};"
+      string += "#{@options[:description]};#{@options[:prio]};"
       string += "#{@options[:follow_up]};#{@options[:due_date]};"
-      string += "#{@options[:note].gsub(/\n/, '\\n')};"
+      string += "#{@options[:note] ? @options[:note].gsub(/\n/, '\\n') : ""};"
       string += "#{@options[:tags]};"
       string += "#{@creation_date};"
       string += "#{@udpate_date ? "UPDATED" : "UNCHANGED"};"
-      string += "#{@done_date ? "DONE" : "OPEN"}\n"
+      string += "#{@done_date ? "DONE" : "OPEN"}"
       string
     end
 

data/lib/syctask/task_scheduler.rb

@@ -166,10 +166,14 @@ module Syctask
       state_file = WORK_DIR+'/'+Time.now.strftime("%Y-%m-%d_time_schedule")
       return [[], [], [], []] unless File.exists? state_file
       state = YAML.load_file(state_file)
-      [state[:work_time], 
-       state[:busy_time], 
-       state[:meetings], 
-       state[:assignments]]
+      if state
+        [state[:work_time], 
+         state[:busy_time], 
+         state[:meetings], 
+         state[:assignments]]
+      else
+        [[], [], [], []]
+      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.2.1'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syc-task
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Pierre Sugar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -126,17 +126,42 @@ description: ! "= Simple task organizer\nsyctask can be used to create, plan, pr
   --due \"2013-03-11\"\n\nSet a proirity for a task\n    $ syctask new \"My first
   task\" --prio 3\n\nPrompt for task input\n    $ syctask new\nwill prompt for task
   titles. Ctrl-D will end input.\n\nExcept for --description you can also provide
-  short forms for the options.\n\n===Plan tasks\nThe plan command will print tasks
-  and prompts whether to (a)dd or (s)kip the \ntask. If (q)uit is selected the tasks
-  already added will be add to the today's \ntask list. If (c)omplete is selected
-  the complete task will be printed and the \nuser will be prompted again for adding
-  the task.\n\nInvoke plan without filter\n    $ syctask plan\n    1 - My first task\n
-  \   (a)dd, (c)omplete, (s)kip, (q)uit? a\n    Duration (1 = 15 minutes, return 30
-  minutes): 3\n    --> 1 task(s) planned\n\nInvoke plan with a filter\n    $ syctask
-  plan --id \"1,3,5,8\"\n    1 - My first task\n    (a)dd, (c)omplete, (s)kip, (q)uit?\n\nMove
-  tasks to another days plan\n    $ syctask plan today --move tomorrow --id 3,5\n\nThis
-  will move the tasks with ID 3 and 5 from the today's plan to the tomorrow's \nplan.
-  The duration will be set to the remaining processing time but at least to\n30 minutes.\n\n===Prioritize
+  short forms for the options.\n\n===Create tasks by scanning from files\nWhen writing
+  minutes of meetings tasks that should be followed up in syctask\ncan be annotated
+  so they will be recognized by the scan command. The following\nstructure shows how
+  to annotade tasks\n\n    Some text before\n\n    @task;\n    title;description;follow_up;due_date,prio\n
+  \   Schedule meeting;Invite all developers;2016-09-12;2016-10-12;1\n    Write letter;Practice
+  writing letters;;;3\n\n    Some text after\n\nThe above annotation will only scan
+  the next task because of the singular 'task'\nwhere the task values are separated
+  with ';'. The line after the annotation\n'@task' lists the sequence of the fields
+  of the task. It is also possible to \nlist the tasks in a table, e.g. markdown\n\n
+  \   Some text before\n\n    @tasks|\n    title           |description               |follow_up
+  |due_date  |prio\n    ----------------|--------------------------|----------|----------|----\n
+  \   Schedule meeting|Invite all developers     |2016-09-12|2016-10-12|1\n    Write
+  letter    |Practice writing letters  |          |          |3\n\n    Some text after\n\n
+  \   Call partner    |Ask for project's progress|2016-09-14|          |1\n\n    Even
+  more text \n\nThe example above scans all tasks due to the plural 'tasks'. It also
+  scans all\ntasks that are separated with non-task text and occur after the annotation
+  and \nconfirm to the field structure. Lines that start with '-' will be ignored.
+  So \nif you want to skip only a view tasks within a task list prepend them with
+  '-'.\nIf you have tasks with different fields then you have to add another annotation\nwith
+  the new field structure. \n\nPossible fields are\n\n    title       - the title
+  of the task\n    description - the description of the task\n    follow_up   - the
+  follow-up date of the task in the form yyyy-mm-dd\n    due_date    - the due-date
+  of the task in the form yyyy-mm-dd\n    prio        - the priority of the task\n
+  \   tags        - tags the task is annotated with\n    note        - a note for
+  the task\n\nScanning tasks from a file\n\n    $ syctask scan 2016-09-10-mom.md 2016-09-09-mom.md\n\n===Plan
+  tasks\nThe plan command will print tasks and prompts whether to (a)dd or (s)kip
+  the \ntask. If (q)uit is selected the tasks already added will be add to the today's
+  \ntask list. If (c)omplete is selected the complete task will be printed and the
+  \nuser will be prompted again for adding the task.\n\nInvoke plan without filter\n
+  \   $ syctask plan\n    1 - My first task\n    (a)dd, (c)omplete, (s)kip, (q)uit?
+  a\n    Duration (1 = 15 minutes, return 30 minutes): 3\n    --> 1 task(s) planned\n\nInvoke
+  plan with a filter\n    $ syctask plan --id \"1,3,5,8\"\n    1 - My first task\n
+  \   (a)dd, (c)omplete, (s)kip, (q)uit?\n\nMove tasks to another days plan\n    $
+  syctask plan today --move tomorrow --id 3,5\n\nThis will move the tasks with ID
+  3 and 5 from the today's plan to the \ntomorrow's plan. The duration will be set
+  to the remaining processing time but \nat least to 30 minutes.\n\n===Prioritize
   tasks\nPlanned tasks can be prioritized in a pair wise comparisson. So each task
   is\ncompared to all other tasks. The task with the highest priority will bubble
   on\ntop followed by the task with the next highest priority and so on.\n\n    $
@@ -334,14 +359,19 @@ description: ! "= Simple task organizer\nsyctask can be used to create, plan, pr
   contains notes\n* Refactor migration from version 0.0.7 and when user has deleted
   system files.\n  The user can now specify the directories where the tasks are located
   and can\n  also define directories to be excluded. This is especially helpful to
-  omit \n  search in large mounted directories, like from NAS servers.\n\n==Development\nPull
-  from Github and then run \n\n    $ bundle install \n    \nDebugging the interface
-  can be done with GLI_DEBUG: \n\n    $ bundle exec env GLI_DEBUG=true bin/syctask\n\nBuilding
-  the gemfile\n\n    $ gem build syctask.gemspec\n\n==Tests\nThe test files live in
-  the folder test and start with test_.\n\nThere is a rake file available to run all
-  tests\n\n    $ rake test\n   \n==License\nsyc-task is released under the {MIT License}[http://opensource.org/licenses/MIT]\n\n==Links\n*
-  [http://www.github.com/sugaryourcoffee/syc-task] - Source code on GitHub\n* [http://syc.dyndns.org/drupal/wiki/syc-task]
-  - Development notebook\n* [https://rubygems.org/gems/syc-backup] - RubyGems\n"
+  omit \n  search in large mounted directories, like from NAS servers.\n\nVersion
+  0.3.1\n* Add csv output spearated by ';' to the list command\n* Fix bug when schedule
+  file is empty\n* Add scan command to scan tasks from files\n\n==Development\nPull
+  from Github and then run \n\n    $ bundle install \n    \nNew classes have to be
+  added to 'lib/syctask.rb'\n\nDebugging the interface can be done with GLI_DEBUG:
+  \n\n    $ bundle exec env GLI_DEBUG=true bin/syctask\n\nBuilding and pushing the
+  gemfile to Rubygems\n\n    $ gem build syctask.gemspec\n    $ gem push syc-task-0.2.1.gem\n\n==Tests\nThe
+  test files live in the folder test and start with test_.\n\nThere is a rake file
+  available to run all tests\n\n    $ rake test\n   \nThe CLI is tested with Cucumber.
+  To run the Cucumber features in verbose mode\n\n    $ cucumber\n\nor if you prefer
+  cleaner output run\n\n    $ rake features\n\n==License\nsyc-task is released under
+  the {MIT License}[http://opensource.org/licenses/MIT]\n\n==Links\n* [http://www.github.com/sugaryourcoffee/syc-task]
+  - Source code on GitHub\n* [https://rubygems.org/gems/syc-task] - RubyGems\n"
 email: pierre@sugaryourcoffee.de
 executables:
 - syctask