rudoo 0.0.01

data/README.md

@@ -0,0 +1,20 @@
+# Rudoo
+
+Rudoo is a command line tool written in ruby that allows you to manage local, project based todo lists.
+
+## Installation
+
+Currently, I don't have a gem available for rudoo but that will change soon! I already have the structure ready, I just want to add a few more features before releasing.
+
+## Usage
+
+TO BE ADDED
+
+## TODO LIST
+  *Items in bold are undone. Items in normal font are already completed*
+
+* **Create function to allow bulk deletion.**
+* **Think about ways to add remote hosting... Google Tasks?**
+* **Create functions to allow holding and resuming of current projects**
+* **Write tests.**
+* **Add documentation.**

data/bin/rd

@@ -0,0 +1,179 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'rudoo.rb'))
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: rd COMMAND [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     init: initialize a new rudoo file architecture"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  ## INIT SPECIFIC ##
+
+  opt.on("--reset","reset the file structure for rudoo") do |reset|
+    options[:reset] = true
+  end
+
+  opt.on("--destroy","remove the file structure for rudoo and do not initialize a new one.") do |destroy|
+    options[:destroy] = true
+  end
+
+  ## END ##
+
+  opt.on("-m", "--message MESSAGE", "message for a todo (what needs to be completed)") do |message|
+    options[:message] = message
+  end
+
+  opt.on("--id IDENTIFIER", "specify the id of a task") do |id|
+    options[:id] = id
+  end
+
+  opt.on("-p", "--priority PRIORITY", "specify the priority of a task") do |priority|
+    options[:priority] = priority
+  end
+
+  opt.on("-t", "--type TYPE", "specify the type of task (done, undone, or all)") do |type|
+    options[:type] = type
+  end
+
+  ## GIT SPECIFIC ##
+
+  opt.on("--commit", "make a new commit with the current task as the message") do |commit|
+    options[:commit] = true
+  end
+
+  ## To-MD SPECIFIC ##
+
+  opt.on("-f", "--file FILE", "destination to file you want to export .md list to") do |file|
+    options[:file] = file
+  end
+
+  ## END ##
+end
+
+opt_parser.parse!
+
+reset = options[:reset] || false
+destroy = options[:destroy] || false
+message = options[:message] || nil
+priority = options[:priority] || 0
+id = options[:id] || nil
+type = options[:type] || "undone"
+commit = options[:commit] || false
+file = options[:file] || false
+
+case ARGV[0]
+when "init"
+  Rd.new unless reset || destroy
+  Rd.reset if reset
+  Rd.destroy if destroy
+
+when "add"
+  if message.nil?
+    puts "ERROR: Message required when adding a new task!"
+    puts ""
+  else
+    added = Rd.list.add(message, priority)
+    
+    puts "Task successfully added!" if added.class == Rudoo::Task
+  end
+
+when "edit"
+  puts "ERROR: At least one modification must be specified!" if message.nil? && priority.nil?
+
+  edit = Rd.list.edit(id, message, priority)
+
+  if edit.class == Rudoo::Task
+    puts "Task successfully edited!"
+  else
+    puts "Unable to find an objective with ID: #{id}"
+  end
+
+when "list"
+  args = ARGV[1..-1] || []
+
+  Rd.list.gather(args, type)
+
+when "tags"
+  Rd.list.tags(type)
+
+when "people"
+  Rd.list.people(type)
+
+when "promote"
+  if id.nil?
+    puts "ERROR: You must specify a task id to promote!"
+  else
+    puts "Task successfully promoted!" if Rd.list.promote(id)
+  end
+
+when "demote"
+  if id.nil?
+    puts "ERROR: You must specify a task id to demote!"
+  else
+    puts "Task successfully demoted!" if Rd.list.demote(id)
+  end
+
+when "projects"
+  Rd.list.projects(type)
+
+when "complete"
+  if id.nil?
+    puts "ERROR: You must include a task id to mark as complete!"
+  else
+    puts "Task successfully marked as complete!" if Rd.list.complete(id)
+  end
+
+when "open"
+  if id.nil?
+    puts "ERROR: You must specify a task id to open it!"
+  else
+    open = Rd.list.open(id)
+
+    if open
+      puts "Task successfully opened and marked incomplete!"
+    else
+      puts "ERROR: Unable to find task with id: #{id}!"
+    end
+  end
+
+when "current"
+  if id.nil?
+    current = Rd.list.current
+
+    if current == false
+      puts "ERROR: You aren't currently working on anything!"
+    else
+      Rd.list.print_to_screen(current)
+    end
+  else
+    puts "Current task successfully changed!" if Rd.list.set_current(id)
+  end
+
+when "delete"
+  if id.nil?
+    puts "ERROR: You must specify an id for the task you would like to delete!"
+  else
+    puts "Task successfully deleted!" if Rd.list.delete(id)
+  end
+
+when "to-md"
+  if file
+    Rd.list.to_md(file, type)
+  else
+    puts "ERROR: No file specified to export to!"
+  end
+
+when "git"
+  Rd.list.commit if commit
+else
+  puts "Unknown command. See usage instructions:"
+  puts ""
+  puts opt_parser
+end

data/lib/rudoo.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "yaml"
+require "fileutils"
+require "digest/sha1"
+require "chronic"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "rudoo", "storage.rb"))
+require File.expand_path(File.join(File.dirname(__FILE__), "rudoo", "list.rb"))
+require File.expand_path(File.join(File.dirname(__FILE__), "rudoo", "task.rb"))
+
+class Rd
+  def initialize
+    Rudoo::Storage.new
+  end
+
+  def self.reset
+    Rudoo::Storage.reset
+  end
+
+  def self.destroy
+    Rudoo::Storage.destroy
+  end
+
+  def self.list
+    Rudoo::List.new
+  end
+end

data/lib/rudoo/list.rb

@@ -0,0 +1,310 @@
+module Rudoo
+  class List
+
+    # create a new list object by loading the yaml file
+    def initialize
+      @list = ".rudoo/list.yml"
+      @config = ".rudoo/config.yml"
+      @tasks = {}
+      load
+    end
+
+    # method for adding task objects to the list
+    def add(todo, priority = 0)
+      if todo.class == Rudoo::Task
+        task = todo
+      else
+        task = Rudoo::Task.new(todo, priority)
+      end
+
+      task = convert_date(task)
+      @tasks[task.id] = task
+      write
+
+      return task 
+    end
+
+    # method for deleting task objects from the list
+    def delete(task_id)
+      if @tasks.delete(task_id)
+        write
+      else
+        raise StandardError.new("ERROR: Unable to delete objective from the hash!")
+      end
+    end
+
+    # method for editing existing tasks given their id
+    def edit(task_id, message = nil, priority = nil)
+      old = @tasks[task_id]
+
+      message = old.todo if message.nil?
+      priority = old.priority if priority.nil?
+
+      if old
+        new_task = Task.new(message, priority)
+        delete(task_id)
+        add(new_task)
+      else
+        return false
+      end
+    end
+
+    # complete an existing task
+    def complete(task_id)
+      previous = @tasks[task_id]
+      previous.todo = previous.todo.gsub(" :wkng", "")
+      previous.todo = previous.todo.gsub(" :done", "")
+      
+      edit(task_id, "#{previous.todo} :done")
+
+      return true
+    end
+
+    # re-open a completed task (make it incomplete again)
+    def open(task_id)
+      previous = @tasks[task_id]
+      
+      if previous
+        edit(task_id, previous.todo.gsub(" :done", ""))
+        return true
+      else
+        return false
+      end
+    end
+
+    # check if a task is finished or not
+    def done?(task)
+      task.todo.include?(":done")
+    end
+
+    # returns a list of tasks that match the given argument criteria
+    def gather(args = [], state = "undone")
+      list = {}
+
+      if @tasks.empty?
+        list = {}
+      else
+        case args
+        when []
+          deleteThese = []
+          addThese = []
+
+          @tasks.each do |id, task|
+            if (state == "undone" && !done?(task)) || (state == "done" && done?(task)) || (state == "all")
+              if task.todo.include?("{#{Time.now.strftime('%b/%d/%Y')}}")
+                replacedTask = task.dup
+                replacedTask.todo.gsub("{#{Time.now.strftime('%b/%d/%Y')}}", "#{@tag_token}today")
+
+                addThese << replacedTask
+                deleteThese << id
+              else
+                list[task.id] = task
+              end
+            end
+        end
+          deleteThese.each do |id|
+            delete(id)
+          end
+
+          addThese.each do |task|
+            add(task)
+            list[task.id] = task
+          end
+        when @person_token, @tag_token, @project_token
+          tags = Hash.new(0)
+
+          @tasks.each do |id, task|
+            if (state == "undone" && !done?(task)) || (state == "done" && done?(task)) || (state == "all")
+              task.todo.gsub(/(#{"\\" + args}\w+)/).each do |tag|
+                tags[tag] += 1
+              end
+            end
+          end
+
+          tags.each {|tag, number| puts "#{tag} (#{number})"}
+        else
+          if args.any? {|arg| arg.downcase.include?("tomorrow")}
+            args << Chronic.parse("tomorrow").strftime('%b/%d/%Y')
+            args.delete("tomorrow")
+            args.delete("#{@tag_token}tomorrow")
+          end
+
+          @tasks.each do |id, task|
+            if (state == "undone" && !done?(task)) || (state == "done" && done?(task)) || (state == "all")
+              args.each do |term| 
+                list[task.id] = task if task.todo.downcase.include?(term.downcase)
+              end
+            end
+          end
+        end
+      end
+
+      print_to_screen list unless list == {}
+    end
+
+    # Method to increase the priority of a task
+    def promote(task_id)
+      previous = @tasks[task_id]
+      previous.priority = previous.priority.to_i + 1
+      write
+
+      return true
+    end
+
+    # Method to decrease the priority of a task
+    def demote(task_id)
+      previous = @tasks[task_id]
+      previous.priority = previous.priority.to_i - 1 unless previous.priority.to_i <= 0
+      write
+
+      return true
+    end
+
+    # returns all of the people mentioned
+    def people(type)
+      gather(@person_token, type)
+    end
+
+    # returns all of the tags
+    def tags(type)
+      gather(@tag_token, type)
+    end
+
+    # returns all of the projects 
+    def projects(type)
+      gather(@project_token, type)
+    end
+
+    # returns the task (marked with :wkng)
+    def current
+      current = @tasks.dup.select do |id, task|
+        task.todo.include?(":wkng")
+      end 
+
+      if current == {}
+        return false
+      else
+        return current
+      end
+    end
+
+    # Method to make a task current given its id
+    def set_current(task_id)
+      previous = @tasks[task_id]
+
+      previous.todo = previous.todo.gsub(" :wkng", "")
+      previous.todo = previous.todo.gsub(" :done", "")
+      
+      edit(task_id, "#{previous.todo} :wkng")
+
+      return true
+    end
+
+    def to_md(file, state="undone")
+      file = File.open(File.expand_path(file), "a")
+
+      file.puts ""
+      file.puts ""
+      file.puts "## TODO LIST"
+      file.puts "  *Items in bold are undone. Items in normal font are already completed*"
+      file.puts ""
+
+      @tasks.each do |id, task|
+        if (state == "undone" && !done?(task)) || (state == "done" && done?(task)) || (state == "all")
+          todo = strip_tags(task.todo)
+
+          if done?(task)
+            file.puts "* #{todo}"
+          else
+            file.puts "* **#{todo}**"
+          end
+        end
+      end
+    end
+
+    ## runs git commit with the current task as the
+    def commit
+      current_todo = strip_tags(current.values[0].todo)
+
+      `git commit -am "#{current_todo}"`
+    end
+
+    # method to order tasks by priority and arrange them in a table
+    def print_to_screen(init_hash)
+        priority_hash = {}
+        hash = {}
+        
+        init_hash.values.each do |task|
+          priority_hash[task] = task.priority.to_i
+        end
+
+        priority_hash = priority_hash.sort_by {|k, v| v}.reverse
+
+        priority_hash.each do |task, priority|
+          hash[task.id] = task
+        end
+
+        longest_todo = hash.values.sort_by {|x| x.todo.to_s.length}.reverse[0].todo.length
+        longest_priority = hash.values.sort_by {|x| x.priority.to_s.length}.reverse[0].priority.to_s.length
+        array_length = hash.count
+
+        ids = hash.keys
+        tasks = hash.values
+
+        ((array_length*2)+1).times do |x|
+          if x%2 == 0
+            puts "+--------+-#{"-"*longest_todo}-+-#{"-"*longest_priority}-+"
+          else
+            task = tasks[(x-1)/2]
+            puts "| #{ids[(x-1)/2]} | #{task.todo}#{" "*(longest_todo - task.todo.length)} | #{task.priority}#{" "*(longest_priority - task.priority.to_s.length)} |"
+          end
+        end
+    end
+
+    private
+
+    def strip_tags(todo)
+      todo = todo.gsub(" :done", "")
+      todo = todo.gsub(" :wkng", "")
+      todo = todo.gsub(@tag_token, "")
+      todo = todo.gsub(@person_token, "")
+      todo = todo.gsub(@project_token, "")
+
+      return todo
+    end
+
+    # change tomorrow tags into actual dates
+    def convert_date(task)
+      if task.todo.include?("#{@tag_token}tomorrow")
+        task.todo.gsub!("#{@tag_token}tomorrow", "{#{Chronic.parse("tomorrow").strftime('%b/%d/%Y')}}")
+        task.todo.gsub!(/#{@tag_token}tomorrow/, '')
+      end
+      task
+    end
+
+    # load yaml file
+    def load
+      raise StandardException.new("Unable to find rudoo list storage file.") unless File.exists?(@list)
+      raise StandardException.new("Unable to find rudoo configuration file.") unless File.exists?(@config)
+      
+      begin
+        @tasks = YAML.load_file(@list)
+      rescue 
+        @tasks = {}
+      end 
+
+      config = YAML.load_file(@config)
+
+      config.each do |name, value|
+        instance_variable_set("@#{name}",value)
+      end
+    end
+
+    # write to yaml file
+    def write
+      File.open(@list, "w") do |file|
+        file << @tasks.to_yaml
+      end
+    end
+  end
+end

data/lib/rudoo/storage.rb

@@ -0,0 +1,99 @@
+module Rudoo
+  class Storage
+    def initialize
+      if self.class.dir_initialized?(".rudoo")
+        puts "File architecture already initialized! Run 'rd init --destroy' to wipe rudoo file sysyem." if self.class.file_initialized?(".rudoo", "list.yml") && self.class.file_initialized?(".rudoo", "config.yml")
+        puts "Corrupted file architecture: Unable to find list file. Please run 'rd init --reset' to reset the file system." unless self.class.file_initialized?(".rudoo", "list.yml")
+        puts "Corrupted file architecture: Unable to find configuration file. Please run 'rd init --reset' to reset the file system." unless self.class.file_initialized?(".rudoo", "config.yml")
+      else
+        self.class.make_folder(".rudoo")
+
+        self.class.make_file(".rudoo", "list.yml")
+        self.class.make_file(".rudoo", "config.yml")
+
+        self.class.generate_config
+
+        puts "Rudoo file system successfully created! You can now run rudoo commands."
+      end
+    end
+
+    def self.reset
+      if dir_initialized?(".rudoo")
+        clear_files(".rudoo")
+
+        make_folder(".rudoo")
+
+        make_file(".rudoo", "list.yml")
+        make_file(".rudoo", "config.yml")
+
+        generate_config
+      
+        puts "Rudoo file system successfully reset! You can now run rudoo commands."
+      else
+        puts "Rudoo file structure not found. Rudoo must be initialized to reset!"
+        puts ""
+      end
+    end
+
+    def self.destroy
+      if dir_initialized?(".rudoo")
+        clear_files(".rudoo")
+      else
+        puts "Rudoo file structure not found. Rudoo must be initialized to destroy!"
+        puts ""
+      end
+    end
+
+    private
+
+    def self.write_file(contents, destination)
+      File.open(destination, "w") do |file|
+        file << contents.to_yaml
+      end
+    end
+
+    def self.generate_config
+      preferences = {
+        :person_token => "@",
+        :tag_token => "^",
+        :project_token => "*"
+      }
+
+      write_file(preferences, ".rudoo/config.yml")
+    end
+
+    def self.clear_files(dir)
+      raise StandardError.new("Unable to delete existing architechture.") unless FileUtils.rm_rf(dir)
+    end
+
+    def self.make_file(dir, file)
+      f = File.new(File.join(dir, file), "w+")
+
+      raise StandardError.new("Unable to create rudoo list storage file: #{file}") unless f
+
+      f.close
+    end
+
+    def self.make_folder(dir)
+      folder = FileUtils.mkdir(dir)
+
+      raise StandardError.new("Unable to create directory: #{dir}.") unless folder
+    end
+
+    def self.dir_initialized?(dir)
+      if File.directory?(dir)
+        return true
+      else
+        return false
+      end
+    end   
+
+    def self.file_initialized?(dir, file)
+      if File.exists?(File.join(dir, file))
+        return true
+      else
+        return false
+      end
+    end   
+  end
+end

data/lib/rudoo/task.rb

@@ -0,0 +1,15 @@
+module Rudoo
+  class Task
+    attr_accessor :todo, :priority
+    
+    def initialize(todo, priority = 0)
+      @todo = todo 
+      @priority = priority
+    end
+
+    def id
+      return Digest::SHA1.hexdigest(@todo)[0,6] unless @todo.nil?
+      return nil if @todo.nil?
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class Rudoo
+  VERSION = "0.0.01"
+end

data/rudoo.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tommy Schaefer"]
+  gem.email         = ["me@tommyschaefer.net"]
+  gem.description   = %q{A ruby program for mannaging project based todo-lists in terminal.}
+  gem.summary       = %q{Rudoo is a ruby program made primarilly for developers. It allows you to manage project based todo-lists from the command line. In addition to doing some cool things like tagging, rudoo also has a few features that optamize your workflow.}
+  gem.homepage      = "https://github.com/tommyschaefer/rudoo"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rudoo"
+  gem.version       = Rudoo::VERSION
+  gem.add_dependency "chronic"
+end

data/spec/list_spec.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper.rb"))

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "rudoo.rb"))

data/spec/storage_spec.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper.rb"))

data/spec/task_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper.rb"))
+
+describe Rudoo::Task do
+  before :each do
+    @task = Rudoo::Task.new("This is my task")
+  end
+
+  describe "#initialize" do
+    it "returns a task object" do
+      @task.should be_an_instance_of Rudoo::Task
+    end
+
+    it "assigns the todo accessor" do
+      @task.todo.should == "This is my task"
+    end
+  end
+
+  describe "#id" do
+    it "returns nil if todo is nil" do
+      task = Rudoo::Task.new
+      task.id.should == nil
+    end
+
+    it "returns a string otherwise" do
+      @task.id.should be_a String
+    end
+
+    it "returns a 6 digit string" do
+      @task.id.length.should == 6
+    end
+  end
+
+  describe "#get" do
+    it "should return a specific string" do
+      @task.get.should == "(#{@task.id}) #{@task.todo}"
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rudoo
+version: !ruby/object:Gem::Version
+  version: 0.0.01
+  prerelease: 
+platform: ruby
+authors:
+- Tommy Schaefer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby program for mannaging project based todo-lists in terminal.
+email:
+- me@tommyschaefer.net
+executables:
+- rd
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/rd
+- lib/rudoo.rb
+- lib/rudoo/list.rb
+- lib/rudoo/storage.rb
+- lib/rudoo/task.rb
+- lib/version.rb
+- rudoo.gemspec
+- spec/list_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+- spec/task_spec.rb
+homepage: https://github.com/tommyschaefer/rudoo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rudoo is a ruby program made primarilly for developers. It allows you to
+  manage project based todo-lists from the command line. In addition to doing some
+  cool things like tagging, rudoo also has a few features that optamize your workflow.
+test_files:
+- spec/list_spec.rb
+- spec/spec_helper.rb
+- spec/storage_spec.rb
+- spec/task_spec.rb