todo-curses 0.0.3 → 0.0.4

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "TodoCurses"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/todo-curses

@@ -1,47 +1,44 @@
 #!/usr/bin/env ruby
 
-require 'todo'
-include GLI::App
-include Ncurses
-include Ncurses::Form
-
-program_desc 'A simple interface for managing todo.txt files.'
-
-subcommand_option_handling :normal
-arguments :strict
-
-desc 'Starts an interactive editor for the given todo.txt list.'
-arg_name 'Describe arguments to list here'
-command :list do |c|
-  c.action do |global_options,options,args|
-    if args.size != 1 then
-      printf("usage: #{$0} file\n");
-      exit
-    end
-
-    TodoViewer.new(ARGV[0])
+require 'optparse'
+require 'methadone'
+require 'TodoCurses'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+  include TodoCurses
+
+  main do |todo_path|
+    # your program code here
+    # You can access CLI options via
+    # the options Hash
   end
-end
 
-pre do |global,command,options,args|
-  # Pre logic here
-  # 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
-  true
-end
+  # supplemental methods here
 
-post do |global,command,options,args|
-  # Post logic here
-  # Use skips_post before a command to skip this
-  # block on that command only
-end
+  # Declare command-line interface here
 
-on_error do |exception|
-  # Error logic here
-  # return false to skip default error handling
-  true
-end
+  # description "one line description of your app"
+  #
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  # Require an argument
+  # arg :some_arg
+  #
+  # # Make an argument optional
+  # arg :optional_arg, :optional
 
-exit run(ARGV)
+  version TodoCurses::VERSION
+
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
+
+  go!
+end

data/lib/TodoCurses.rb

@@ -0,0 +1,16 @@
+require 'TodoCurses/list.rb'
+require 'TodoCurses/logger.rb'
+require 'TodoCurses/view.rb'
+require 'TodoCurses/version.rb'
+require 'TodoCurses/task.rb'
+
+module TodoCurses
+  include Logger
+
+  if ARGV.size != 1
+    printf("usage: #{$PROGRAM_NAME} file\n")
+    exit
+  end
+
+  View.new ARGV[0]
+end

data/lib/{todo-txt → TodoCurses}/list.rb

@@ -1,4 +1,5 @@
-module Todo
+module TodoCurses
+  # Handles todo.txt list files
   class List < Array
     # Initializes a Todo List object with a path to the corresponding todo.txt
     # file. For example, if your todo.txt file is located at:
@@ -7,7 +8,7 @@ module Todo
     #
     # You would initialize this object like:
     #
-    #   list = Todo::List.new "/home/sam/Dropbox/todo/todo-txt"
+    #   list = TodoCurses::List.new "/home/sam/Dropbox/todo/todo-txt"
     #
     # Alternately, you can initialize this object with an array of strings or
     # tasks. If the array is of strings, the strings will be converted into
@@ -17,10 +18,10 @@ module Todo
     #
     #   array = Array.new
     #   array.push "(A) A string task!"
-    #   array.push Todo::Task.new("(A) An actual task!")
+    #   array.push TodoCurses::Task.new("(A) An actual task!")
     #
-    #   list = Todo::List.new array
-    def initialize list
+    #   list = TodoCurses::List.new array
+    def initialize(list)
       if list.is_a? Array
         # No file path was given.
         @path = nil
@@ -29,25 +30,25 @@ module Todo
         list.each do |task|
           # If it's a string, make a new task out of it.
           if task.is_a? String
-            self.push Todo::Task.new task
+            push TodoCurses::Task.new task
           # If it's a task, just add it.
-          elsif task.is_a? Todo::Task
-            self.push task
+          elsif task.is_a? TodoCurses::Task
+            push task
           end
         end
       elsif list.is_a? String
         @path = list
 
-        # Read in lines from file, create Todo::Tasks out of them and push them
+        # Read in lines from file, create TodoCurses::Tasks out of them and push them
         # onto self.
         File.open(list) do |file|
-          file.each_line { |line| self.push Todo::Task.new line }
+          file.each_line { |line| push TodoCurses::Task.new line }
         end
       end
     end
 
     # The path to the todo.txt file that you supplied when you created the
-    # Todo::List object.
+    # TodoCurses::List object.
     def path
       @path
     end
@@ -56,32 +57,32 @@ module Todo
     #
     # Example:
     #
-    #   list = Todo::List.new "/path/to/list"
+    #   list = TodoCurses::List.new "/path/to/list"
     #   list.by_priority "A" #=> Will be a new list with only priority A tasks
-    def by_priority priority
-      Todo::List.new self.select { |task| task.priority == priority }
+    def by_priority(priority)
+      TodoCurses::List.new select { |task| task.priority == priority }
     end
 
     # Filters the list by context and returns a new list.
     #
     # Example:
     #
-    #   list = Todo::List.new "/path/to/list"
+    #   list = TodoCurses::List.new "/path/to/list"
     #   list.by_context "@context" #=> Will be a new list with only tasks
     #                                  containing "@context"
-    def by_context context
-      Todo::List.new self.select { |task| task.contexts.include? context }
+    def by_context(context)
+      TodoCurses::List.new select { |task| task.contexts.include? context }
     end
 
     # Filters the list by project and returns a new list.
     #
     # Example:
     #
-    #   list = Todo::List.new "/path/to/list"
+    #   list = TodoCurses::List.new "/path/to/list"
     #   list.by_project "+project" #=> Will be a new list with only tasks
     #                                  containing "+project"
-    def by_project project
-      Todo::List.new self.select { |task| task.projects.include? project }
+    def by_project(project)
+      TodoCurses::List.new select { |task| task.projects.include? project }
     end
   end
 end

data/lib/{todo-txt → TodoCurses}/logger.rb

@@ -1,6 +1,6 @@
 require 'logger'
 
-module Todo
+module TodoCurses
   module Logger
     def self.included base
       base.extend(self)
@@ -15,7 +15,7 @@ module Todo
     end
 
     def logger
-      Todo::Logger.logger
+      TodoCurses::Logger.logger
     end
   end
 end

data/lib/{todo-txt → TodoCurses}/task.rb

@@ -1,9 +1,9 @@
 require 'date'
 
-module Todo
+module TodoCurses
   class Task
     include Comparable
-    include Todo::Logger
+    include TodoCurses::Logger
 
     # The regular expression used to match contexts.
     def self.contexts_regex
@@ -40,7 +40,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new("(A) A high priority task!")
+    #   task = TodoCurses::Task.new("(A) A high priority task!")
     def initialize task
       @orig = task
       @completed_on = get_completed_date #orig.scan(self.class.done_regex)[1] ||= nil
@@ -54,7 +54,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) @context +project Hello!"
+    #   task = TodoCurses::Task.new "(A) @context +project Hello!"
     #   task.orig #=> "(A) @context +project Hello!"
     attr_reader :orig
 
@@ -62,7 +62,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-03-04 Task."
+    #   task = TodoCurses::Task.new "(A) 2012-03-04 Task."
     #   task.created_on
     #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
@@ -75,7 +75,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-03-04 Task."
+    #   task = TodoCurses::Task.new "x 2012-03-04 Task."
     #   task.completed_on
     #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
@@ -88,7 +88,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) This is a task. due:2012-03-04"
+    #   task = TodoCurses::Task.new "(A) This is a task. due:2012-03-04"
     #   task.due_on
     #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
@@ -101,10 +101,10 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) Some task."
+    #   task = TodoCurses::Task.new "(A) Some task."
     #   task.priority #=> "A"
     #
-    #   task = Todo::Task.new "Some task."
+    #   task = TodoCurses::Task.new "Some task."
     #   task.priority #=> nil
     attr_reader :priority
 
@@ -129,7 +129,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) @test Testing!"
+    #   task = TodoCurses::Task.new "(A) @test Testing!"
     #   task.text #=> "Testing!"
     def text
       @text ||= orig.
@@ -146,7 +146,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-03-04 Task."
+    #   task = TodoCurses::Task.new "(A) 2012-03-04 Task."
     #   task.date
     #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
     #
@@ -165,7 +165,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new("This task is overdue! due:#{Date.today - 1}")
+    #   task = TodoCurses::Task.new("This task is overdue! due:#{Date.today - 1}")
     #   task.overdue?
     #   #=> true
     def overdue?
@@ -177,11 +177,11 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 Task."
+    #   task = TodoCurses::Task.new "x 2012-12-08 Task."
     #   task.done?
     #   #=> true
     #
-    #   task = Todo::Task.new "Task."
+    #   task = TodoCurses::Task.new "Task."
     #   task.done?
     #   #=> false
     def done?
@@ -192,7 +192,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "2012-12-08 Task."
+    #   task = TodoCurses::Task.new "2012-12-08 Task."
     #   task.done?
     #   #=> false
     #
@@ -212,7 +212,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 2012-03-04 Task."
+    #   task = TodoCurses::Task.new "x 2012-12-08 2012-03-04 Task."
     #   task.done?
     #   #=> true
     #
@@ -232,7 +232,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "x 2012-12-08 Task."
+    #   task = TodoCurses::Task.new "x 2012-12-08 Task."
     #   task.done?
     #   #=> true
     #
@@ -251,7 +251,7 @@ module Todo
     #
     # Example:
     #
-    #   task = Todo::Task.new "(A) 2012-12-08 Task"
+    #   task = TodoCurses::Task.new "(A) 2012-12-08 Task"
     #   task.to_s
     #   #=> "(A) 2012-12-08 Task"
     def to_s
@@ -268,8 +268,8 @@ module Todo
     #
     # Example:
     #
-    #   task1 = Todo::Task.new "(A) Priority A."
-    #   task2 = Todo::Task.new "(B) Priority B."
+    #   task1 = TodoCurses::Task.new "(A) Priority A."
+    #   task2 = TodoCurses::Task.new "(B) Priority B."
     #
     #   task1 > task2
     #   # => true

data/lib/TodoCurses/version.rb

@@ -0,0 +1,3 @@
+module TodoCurses
+  VERSION = '0.0.4'
+end

data/lib/TodoCurses/view.rb

@@ -0,0 +1,261 @@
+require 'ncursesw'
+
+module TodoCurses
+  include Ncurses
+
+  # A curses based todo.txt file viewer
+  class View
+    # Run the ncurses application
+    def interact
+      while true
+        result = true
+        c = Ncurses.getch
+        case c
+        when 'j'.ord # Move down
+          result = scroll_down
+        when 'k'.ord # Move up
+          result = scroll_up
+        when 'J'.ord # Decrease priority
+          result = priority_down
+        when 'K'.ord # Increase priority
+          result = priority_up
+        when 'x'.ord # Toggle complete
+          toggle_item_completion
+        when 'n'.ord # New item
+          new_item
+        when 'h'.ord # Scroll to top
+          while scroll_up
+          end
+        when 'l'.ord # Scroll to bottom
+          while scroll_down
+          end
+        when 'q'.ord
+          break
+        else
+          @screen.mvprintw(0, 0, "[unknown key `#{Ncurses.keyname(c)}'=#{c}] ")
+        end
+        Ncurses.beep unless result
+      end
+      clean_done_tasks
+      close_ncurses
+    end
+
+    private
+
+    # Create a new fileviewer, and view the file.
+    def initialize(filename)
+      init_curses
+      load_file(filename)
+      interact
+    end
+
+    # Perform the curses setup
+    def init_curses
+      @screen = Ncurses.initscr
+      Ncurses.nonl
+      Ncurses.cbreak
+      Ncurses.noecho
+      @screen.scrollok(true)
+    end
+
+    # Loads the given file as a todo.txt array. Sets the view to the top
+    # and redraws the list view.
+    # @param filename [String] path to the text file to be loaded
+    def load_file(filename)
+      @done_file = File.dirname(filename) + '/done.txt'
+      @list = TodoCurses::List.new filename
+      @list.sort! { |x, y| y <=> x } # Reverse sort
+      items = []
+      last_priority = nil
+      last_selection = @menu.current_item.user_object if @menu
+      current_selection = nil
+
+      # Build the menu item list
+      @list.each do |item|
+        # Insert dividers on priority change
+        if item.priority != last_priority
+          divider_priority = item.priority.nil? ? 'N/A' : item.priority.to_s
+          divider = Ncurses::Menu::ITEM.new(divider_priority, '')
+          items << divider
+          last_priority = item.priority
+        end
+
+        # Build the todo menu item
+        menu_item = Ncurses::Menu::ITEM.new(item.to_s, '') # name, description
+        menu_item.user_object = item
+        items << menu_item
+
+        # Set the current selection
+        current_selection = menu_item if item.to_s == last_selection.to_s
+      end
+
+      # Build the final menu object
+      @menu = Ncurses::Menu::MENU.new items
+      @menu.set_menu_win(@screen)
+      @menu.set_menu_sub(@screen.derwin(@screen.getmaxx, @screen.getmaxy, 0, 0))
+      @menu.set_menu_format(@screen.getmaxy, 1)
+
+      # Set dividers to non-interactive
+      @menu.menu_items.select { |i| i.user_object.nil? }.each do |divider|
+        divider.item_opts_off Ncurses::Menu::O_SELECTABLE
+      end
+
+      # Show the menu
+      @screen.clear
+      @menu.post_menu
+
+      # Set selection position
+      @menu.set_current_item current_selection if current_selection
+      @menu.menu_driver(
+        Ncurses::Menu::REQ_DOWN_ITEM) if @menu.current_item.user_object.nil?
+
+        # Refresh
+        @screen.refresh
+    end
+
+    # Moves the current selection's priority up by one unless it is at Z.
+    def priority_up
+      item = @menu.current_item.user_object
+      item.priority_inc
+      save_list
+    end
+
+    # Moves the current selection's priority down by one unless it is at A.
+    def priority_down
+      item = @menu.current_item.user_object
+      item.priority_dec
+      save_list
+    end
+
+    # Scroll the display up by one line
+    # @return [Boolean] true if the action completed successfully.
+    def scroll_up
+      # Move to the next item if it's not the first in the list
+      unless @menu.menu_items[0].user_object.nil? &&
+        @menu.current_item.item_index < 2
+        result = @menu.menu_driver(Ncurses::Menu::REQ_UP_ITEM)
+      end
+      # Move to the next item if it's not a divider
+      result = @menu.menu_driver(
+        Ncurses::Menu::REQ_UP_ITEM) unless @menu.current_item.user_object
+        return true if result == Ncurses::Menu::E_OK
+        false
+    end
+
+    # Scroll the display down by one line
+    # @return [Boolean] true if the action completed successfully.
+    def scroll_down
+      result = @menu.menu_driver(Ncurses::Menu::REQ_DOWN_ITEM)
+      result = @menu.menu_driver(
+        Ncurses::Menu::REQ_DOWN_ITEM) unless @menu.current_item.user_object
+        return true if result == Ncurses::Menu::E_OK
+        false
+    end
+
+    # Collects a new todo item from the user and saves
+    # it to the text file.
+    def new_item
+      field = Ncurses::Form::FIELD.new(1, @screen.getmaxx - 1, 2, 1, 0, 0)
+      field.set_field_back(Ncurses::A_UNDERLINE)
+      fields = [field]
+      my_form = Ncurses::Form::FORM.new(fields)
+      my_form.user_object = 'My identifier'
+
+      # Calculate the area required for the form
+      rows = []
+      cols = []
+      my_form.scale_form(rows, cols)
+
+      # Create the window to be associated with the form
+      my_form_win = Ncurses::WINDOW.new(rows[0] + 3, cols[0] + 14, 1, 1)
+      my_form_win.keypad(TRUE)
+
+      # Set main window and sub window
+      my_form.set_form_win(my_form_win)
+      my_form.set_form_sub(my_form_win.derwin(rows[0], cols[0], 2, 12))
+
+      my_form.post_form
+
+      # Print field types
+      my_form_win.mvaddstr(4, 2, 'New item')
+      my_form_win.wrefresh
+
+      Ncurses::stdscr.refresh
+
+      new_item_text = capture_text_field_input(my_form_win, my_form, field)
+
+      # Save results
+      save_new_item(new_item_text)
+
+      # Clean up
+      my_form.unpost_form
+      my_form.free_form
+
+      field.free_field
+      # fields.each {|f| f.free_field}
+    end
+
+    # Adds a new item to the list and saves the file
+    # @param task [String] the task to be added
+    # @return [TodoCurses::List] the updated list
+    def save_new_item(task)
+      @list << TodoCurses::Task.new(task)
+      save_list
+      @list
+    end
+
+    # Saves the current state of the list. Overrides the current file.
+    # Reloads the newly saved file.
+    def save_list
+      File.open(@list.path, 'w') { |file| file << @list.join("\n") }
+      load_file @list.path
+    end
+
+    # Marks the currently selected menu item as complete and saves the list.
+    def toggle_item_completion
+      @menu.current_item.user_object.toggle!
+      save_list
+    end
+
+    # Saves done tasks to done.txt and removes them from todo.txt
+    def clean_done_tasks
+      done_tasks = @list.select { |task| !task.completed_on.nil? }
+      File.open(@done_file, 'a') do |file|
+        file << "\n"
+        file << done_tasks.join("\n")
+      end
+      remaining_tasks = @list.select { |task| task.completed_on.nil? }
+      File.open(@list.path, 'w') { |file| file << remaining_tasks.join("\n") }
+    end
+
+    # put the screen back in its normal state
+    def close_ncurses
+      Ncurses.echo
+      Ncurses.nocbreak
+      Ncurses.nl
+      Ncurses.endwin
+    end
+
+    # Captures text input into a form and returns the resulting string.
+    # @param window [Window] the form window
+    # @param form [FORM] the form to be captured
+    # @param field [FIELD] the form to be captured
+    # @return [String] the captured input
+    def capture_text_field_input(window, form, field)
+      while (ch = window.getch) != 13 # return is ascii 13
+        case ch
+        when Ncurses::KEY_LEFT
+          form.form_driver Ncurses::Form::REQ_PREV_CHAR
+        when Ncurses::KEY_RIGHT
+          form.form_driver Ncurses::Form::REQ_NEXT_CHAR
+        when Ncurses::KEY_BACKSPACE
+          form.form_driver Ncurses::Form::REQ_DEL_PREV
+        else
+          form.form_driver ch # If this is a normal character, it gets Printed
+        end
+      end
+      form.form_driver Ncurses::Form::REQ_NEXT_FIELD # Request next to set 0 buffer in field
+      Ncurses::Form.field_buffer(field, 0)
+    end
+  end
+end