todo-curses 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 364b06f70215a62401102eb261da618bb3266e55
-  data.tar.gz: c714802c916233c242d6de543b9fa23d5bb968bb
+  metadata.gz: 732f87d6a1d0039ec07cfdc464b9a81bf82ba1e3
+  data.tar.gz: f3111293b08d469ea38f092dc3a6319305a8e3f6
 SHA512:
-  metadata.gz: e7b253fd3d83971f390fa44d1d4587d63eda1496246a0a6bddc939533f393edfc1182f6cb6384db45b4538ef6cdb0f4a918b3697bae8b9d0033d4d9a6dde9a92
-  data.tar.gz: 1afe50ddf112f801d31ac13afdcff4f2bad559bf76d8a571f968fac4847e3eec1453c5d66765e611b4621c200687dec453f5da6d603c8aab4d07c5b5c1df7f36
+  metadata.gz: 133900726e93cc036678fd9cc165655ebd91daf5854ccf3db4b177f970e94eb5045041223e76ead393ca3a9f42c19c2f97bfe7ec6ce07a4c4470365c4d27066d
+  data.tar.gz: 2f1b823f7438d4cee0e8280d6623db11fd39369274cfa5348d0994c99a30f47024911a8721502f3cbc9e456f097dd1e2ac68e7177e19b6a621c17e4e5d1d5fc6

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    todo-curses (0.0.4)
+    todo-curses (0.0.5)
       methadone (~> 1.9, >= 1.9.2)
       ncursesw (~> 1.4, >= 1.4.9)
+      todo-txt (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
@@ -62,6 +63,7 @@ GEM
     test-unit (3.1.8)
       power_assert
     thor (0.19.1)
+    todo-txt (0.7)
     unicode-display_width (1.0.2)
 
 PLATFORMS

data/README.md

@@ -31,7 +31,14 @@ Grab the gem:
 Then you'll probably want to make an alias in your .\*rc file. Here's
 mine:
 
-    alias tt#"todo-curses list \~/dev/todo/todo.txt"
+    alias t="todo.sh"
+    alias tt="vim ~/dev/todo/todo.txt"
+    alias ts="cd ~/dev/todo;./save.sh;cd -;t archive"
+    alias ttt="todo-curses ~/dev/todo/todo.txt"
+
+This gives three ways to interact with the todo.txt file, depending
+on the task at hand. Because todo-curses is still in the experimental
+phase, I use Vim for my day-to-day work.
 
 ## Current features
 
@@ -44,53 +51,6 @@ mine:
 - Move priority up with `shift+k`
 - Completed tasks are archived to done.txt on exit
 
-## Planned features
-
-- Safer file handling (confirmations, errors, etc.)
-- Use ctrl instead of shift for priority change
-- Color code priorities
-- Add a spacer between priority groups
-- Priority view with `ctrl+1`
-- Project view with `ctrl+2`
-- Strip out application wrapper; not needed
-- Prep for release as a gem
-- If no argument is given, open the default file. Default tbd.
-
-## Ideas for later
-
-- Shift+J: Cycle through displays (Priority, project, etc.)
-- F: filter tasks (free-text, one filter condition per line)
-- T: append text to selected tasks
-- O or Ctrl+O: open todo.txt file
-- C or Ctrl+N: new todo.txt file
-
-## Things not included
-
-- A: archive tasks
-- Ctrl+C: copy task to clipboard
-- Ctrl+Shift+C: copy task to edit field
-- Win+Alt+T: hide/unhide windows
-- 0: clear filter
-- 1-9: apply numbered filter preset
-
-## Keyboard shortcut ideas
-
-- N: new task
-- J: next task
-- K: prev task
-- X: toggle task completion
-- D or Del or Backspace: delete task (with confirmation)
-- E or F2: update task
-- I: set priority
-- . or F5: reload tasks from file
-- ?: show help
-- Shift+K: increase priority
-- Shift+J: decrease priority
-- Alt+Left/Right: clear priority
-- Ctrl+Alt+Up: increase due date by 1 day
-- Ctrl+Alt+Down: decrease due date by 1 day
-- Ctrl+Alt+Left/Right: remove due date
-
 ## Development
 
 To release a new version, update

data/Rakefile

@@ -23,6 +23,7 @@ def dump_load_path
     puts "Found in #{path}"
   end
 end
+
 require 'bundler'
 require 'rake/clean'
 
@@ -38,12 +39,10 @@ include Rake::DSL
 
 Bundler::GemHelper.install_tasks
 
-
 Rake::TestTask.new do |t|
-  t.pattern = 'test/tc_*.rb'
+  t.pattern = 'test/*.rb'
 end
 
-
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
@@ -52,20 +51,12 @@ Cucumber::Rake::Task.new(:features) do |t|
 end
 
 Rake::RDocTask.new do |rd|
-
   rd.main = "README.rdoc"
-
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
 end
 
 task :default => [:test,:features]
 
-# Run the test application
-desc 'run'
-task :run do
-  sh 'bundle exec bin/todo-curses list todo.txt'
-end
-
 # Reset the testing todo.txt file, if you have one.
 desc 'reset'
 task :reset do
@@ -77,5 +68,3 @@ desc 'Lint Ruby'
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.patterns = ['bin/**/*.rb', 'lib/**/*.rb']
 end
-
-task default: :run

data/lib/TodoCurses/version.rb

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

data/lib/TodoCurses/view.rb

@@ -116,14 +116,14 @@ module TodoCurses
     # 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
+      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
+      item.priority_dec!
       save_list
     end
 

data/lib/TodoCurses.rb

@@ -1,11 +1,9 @@
-require 'TodoCurses/list.rb'
-require 'TodoCurses/logger.rb'
 require 'TodoCurses/view.rb'
 require 'TodoCurses/version.rb'
-require 'TodoCurses/task.rb'
+require 'todo-txt'
 
 module TodoCurses
-  include Logger
+  include Todo
 
   if ARGV.size != 1
     printf("usage: #{$PROGRAM_NAME} file\n")

data/todo-curses.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('aruba', '~> 0.14.1')
   spec.add_dependency('methadone', '~> 1.9', '>= 1.9.2')
   spec.add_dependency('ncursesw', '~> 1.4', '>= 1.4.9')
+  spec.add_dependency('todo-txt', '~> 0.7')
   spec.add_development_dependency('test-unit', '~> 3.1', '>= 3.1.8')
   spec.add_development_dependency('rubocop', '~> 0.39.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo-curses
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Loren Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.9
+- !ruby/object:Gem::Dependency
+  name: todo-txt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -162,16 +176,12 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- README.rdoc
 - Rakefile
 - bin/console
 - bin/setup
 - bin/todo-curses
 - images/todo-curses-demo.gif
 - lib/TodoCurses.rb
-- lib/TodoCurses/list.rb
-- lib/TodoCurses/logger.rb
-- lib/TodoCurses/task.rb
 - lib/TodoCurses/version.rb
 - lib/TodoCurses/view.rb
 - todo-curses.gemspec

data/README.rdoc

@@ -1,19 +0,0 @@
-= todo-curses - DESCRIBE YOUR GEM
-
-Author::  YOUR NAME (YOUR EMAIL)
-Copyright:: Copyright (c) 2016 YOUR NAME
-
-
-DESCRIBE YOUR GEM HERE
-
-== Links
-
-* {Source on Github}[LINK TO GITHUB]
-* RDoc[LINK TO RDOC.INFO]
-
-== Install
-
-== Examples
-
-== Contributing
-

data/lib/TodoCurses/list.rb

@@ -1,88 +0,0 @@
-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:
-    #
-    #   /home/sam/Dropbox/todo/todo.txt
-    #
-    # You would initialize this object like:
-    #
-    #   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
-    # tasks. You can supply a mixed list of string and tasks if you wish.
-    #
-    # Example:
-    #
-    #   array = Array.new
-    #   array.push "(A) A string task!"
-    #   array.push TodoCurses::Task.new("(A) An actual task!")
-    #
-    #   list = TodoCurses::List.new array
-    def initialize(list)
-      if list.is_a? Array
-        # No file path was given.
-        @path = nil
-
-        # If path is an array, loop over it, adding to self.
-        list.each do |task|
-          # If it's a string, make a new task out of it.
-          if task.is_a? String
-            push TodoCurses::Task.new task
-          # If it's a task, just add it.
-          elsif task.is_a? TodoCurses::Task
-            push task
-          end
-        end
-      elsif list.is_a? String
-        @path = list
-
-        # 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| push TodoCurses::Task.new line }
-        end
-      end
-    end
-
-    # The path to the todo.txt file that you supplied when you created the
-    # TodoCurses::List object.
-    def path
-      @path
-    end
-
-    # Filters the list by priority and returns a new list.
-    #
-    # Example:
-    #
-    #   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)
-      TodoCurses::List.new select { |task| task.priority == priority }
-    end
-
-    # Filters the list by context and returns a new list.
-    #
-    # Example:
-    #
-    #   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)
-      TodoCurses::List.new select { |task| task.contexts.include? context }
-    end
-
-    # Filters the list by project and returns a new list.
-    #
-    # Example:
-    #
-    #   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)
-      TodoCurses::List.new select { |task| task.projects.include? project }
-    end
-  end
-end

data/lib/TodoCurses/logger.rb

@@ -1,21 +0,0 @@
-require 'logger'
-
-module TodoCurses
-  module Logger
-    def self.included base
-      base.extend(self)
-    end
-
-    def self.logger= new_logger
-      @@logger = new_logger
-    end
-
-    def self.logger
-      @@logger ||= ::Logger.new(STDOUT)
-    end
-
-    def logger
-      TodoCurses::Logger.logger
-    end
-  end
-end

data/lib/TodoCurses/task.rb

@@ -1,339 +0,0 @@
-require 'date'
-
-module TodoCurses
-  class Task
-    include Comparable
-    include TodoCurses::Logger
-
-    # The regular expression used to match contexts.
-    def self.contexts_regex
-       /(?:\s+|^)@\w+/
-    end
-
-    # The regex used to match projects.
-    def self.projects_regex
-       /(?:\s+|^)\+\w+/
-    end
-
-    # The regex used to match priorities.
-    def self.priority_regex
-      /(?:^|\s+)\(([A-Za-z])\)\s+/
-    end
-
-    # The regex used to match creation date.
-    def self.created_on_regex
-      /(?:^|-\d{2}\s|\)\s)(\d{4}-\d{2}-\d{2})\s/
-    end
-
-    # The regex used to match completion.
-    def self.done_regex
-      /^x\s+(\d{4}-\d{2}-\d{2})\s+/
-    end
-
-    # The regex used to match due date.
-    def self.due_on_regex
-      /(?:due:)(\d{4}-\d{2}-\d{2})(?:\s+|$)/i
-    end
-
-    # Creates a new task. The argument that you pass in must be the string
-    # representation of a task.
-    #
-    # Example:
-    #
-    #   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
-      @priority, @created_on = orig_priority, orig_created_on
-      @due_on = get_due_on_date
-      @contexts ||= orig.scan(self.class.contexts_regex).map { |item| item.strip }
-      @projects ||= orig.scan(self.class.projects_regex).map { |item| item.strip }
-    end
-
-    # Returns the original content of the task.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) @context +project Hello!"
-    #   task.orig #=> "(A) @context +project Hello!"
-    attr_reader :orig
-
-    # Returns the task's creation date, if any.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) 2012-03-04 Task."
-    #   task.created_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #
-    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
-    # format. Dates in any other format will be classed as malformed and this
-    # attribute will be nil.
-    attr_reader :created_on
-
-    # Returns the task's completion date if task is done.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "x 2012-03-04 Task."
-    #   task.completed_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #
-    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
-    # format. Dates in any other format will be classed as malformed and this
-    # attribute will be nil.
-    attr_reader :completed_on
-
-    # Returns the task's due date, if any.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) This is a task. due:2012-03-04"
-    #   task.due_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #
-    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
-    # format. Dates in any other format will be classed as malformed and this
-    # attribute will be nil.
-    attr_reader :due_on
-
-    # Returns the priority, if any.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) Some task."
-    #   task.priority #=> "A"
-    #
-    #   task = TodoCurses::Task.new "Some task."
-    #   task.priority #=> nil
-    attr_reader :priority
-
-    # Returns an array of all the @context annotations.
-    #
-    # Example:
-    #
-    #   task = Todo:Task.new "(A) @context Testing!"
-    #   task.context #=> ["@context"]
-    attr_reader :contexts
-
-    # Returns an array of all the +project annotations.
-    #
-    # Example:
-    #
-    #   task = Todo:Task.new "(A) +test Testing!"
-    #   task.projects #=> ["+test"]
-    attr_reader :projects
-
-    # Gets just the text content of the todo, without the priority, contexts
-    # and projects annotations.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) @test Testing!"
-    #   task.text #=> "Testing!"
-    def text
-      @text ||= orig.
-        gsub(self.class.done_regex, '').
-        gsub(self.class.priority_regex, '').
-        gsub(self.class.created_on_regex, '').
-        gsub(self.class.contexts_regex, '').
-        gsub(self.class.projects_regex, '').
-        gsub(self.class.due_on_regex, '').
-        strip
-    end
-
-    # Returns the task's creation date, if any.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) 2012-03-04 Task."
-    #   task.date
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #
-    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
-    # format. Dates in any other format will be classed as malformed and this
-    # method will return nil.
-    #
-    # Deprecated
-    def date
-      logger.warn("Task#date is deprecated, use created_on instead.")
-
-      @created_on
-    end
-
-    # Returns whether a task's due date is in the past.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new("This task is overdue! due:#{Date.today - 1}")
-    #   task.overdue?
-    #   #=> true
-    def overdue?
-      return true if !due_on.nil? && due_on < Date.today
-      false
-    end
-
-    # Returns if the task is done.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "x 2012-12-08 Task."
-    #   task.done?
-    #   #=> true
-    #
-    #   task = TodoCurses::Task.new "Task."
-    #   task.done?
-    #   #=> false
-    def done?
-      !@completed_on.nil?
-    end
-
-    # Completes the task on the current date.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "2012-12-08 Task."
-    #   task.done?
-    #   #=> false
-    #
-    #   task.do!
-    #   task.done?
-    #   #=> true
-    #   task.created_on
-    #   #=> <Date: 2012-12-08 (4911981/2,0,2299161)>
-    #   task.completed_on
-    #   #=> # the current date
-    def do!
-      @completed_on = Date.today
-      @priority = nil
-    end
-
-    # Marks the task as incomplete and resets its original priority.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "x 2012-12-08 2012-03-04 Task."
-    #   task.done?
-    #   #=> true
-    #
-    #   task.undo!
-    #   task.done?
-    #   #=> false
-    #   task.created_on
-    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
-    #   task.completed_on
-    #   #=> nil
-    def undo!
-      @completed_on = nil
-      @priority = orig_priority
-    end
-
-    # Toggles the task from complete to incomplete or vice versa.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "x 2012-12-08 Task."
-    #   task.done?
-    #   #=> true
-    #
-    #   task.toggle!
-    #   task.done?
-    #   #=> false
-    #
-    #   task.toggle!
-    #   task.done?
-    #   #=> true
-    def toggle!
-      done? ? undo! : do!
-    end
-
-    # Returns this task as a string.
-    #
-    # Example:
-    #
-    #   task = TodoCurses::Task.new "(A) 2012-12-08 Task"
-    #   task.to_s
-    #   #=> "(A) 2012-12-08 Task"
-    def to_s
-      priority_string = priority ? "(#{priority}) " : ""
-      done_string = done? ? "x #{completed_on} " : ""
-      created_on_string = created_on ? "#{created_on} " : ""
-      contexts_string = contexts.empty? ? "" : " #{contexts.join ' '}"
-      projects_string = projects.empty? ? "" : " #{projects.join ' '}"
-      due_on_string = due_on.nil? ? "" : " due:#{due_on}"
-      "#{done_string}#{priority_string}#{created_on_string}#{text}#{contexts_string}#{projects_string}#{due_on_string}"
-    end
-
-    # Compares the priorities of two tasks.
-    #
-    # Example:
-    #
-    #   task1 = TodoCurses::Task.new "(A) Priority A."
-    #   task2 = TodoCurses::Task.new "(B) Priority B."
-    #
-    #   task1 > task2
-    #   # => true
-    #
-    #   task1 == task2
-    #   # => false
-    #
-    #   task2 > task1
-    #   # => false
-    def <=> other_task
-      if self.priority.nil? and other_task.priority.nil?
-        0
-      elsif other_task.priority.nil?
-        1
-      elsif self.priority.nil?
-        -1
-      else
-        other_task.priority <=> self.priority
-      end
-    end
-
-    # Decreases the priority until Z.
-    def priority_dec
-      return if @priority.nil?
-      @priority = @priority.next if @priority.ord < 90
-    end
-
-    # Increases the priority until A. If it's nil, it sets it to A.
-    def priority_inc
-      if @priority.nil?
-        @priority = 'A'
-      else
-        @priority = (@priority.ord-1).chr if @priority.ord > 65
-      end
-    end
-
-    private
-
-    def orig_priority
-      @orig.match(self.class.priority_regex)[1] if @orig =~ self.class.priority_regex
-    end
-
-    def orig_created_on
-      begin
-        if @orig =~ self.class.created_on_regex
-          date = @orig.match self.class.created_on_regex
-          return Date.parse(date[1]) unless date.nil?
-        end
-      rescue; end
-      nil
-    end
-
-    def get_completed_date
-      begin
-        return Date.parse(self.class.done_regex.match(@orig)[1])
-      rescue; end
-      nil
-    end
-
-    def get_due_on_date
-      begin
-        return Date.parse(self.class.due_on_regex.match(@orig)[1])
-      rescue; end
-      nil
-    end
-  end
-end