koi 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 cloudhead
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+koi
+===
+
+minimal task management for hackers.
+
+    $ sudo gem install koi -s http://gemcutter.org
+
+_Note: this project is still under heavy development!_
+
+Synopsis
+--------
+
+Start by creating a new project folder
+
+    $ mkdir project/
+    $ cd project/
+
+**koi** uses folders as projects, in the same way as **git**. We start by initializing our project, and adding two tasks.
+
+    $ koi init
+    $ koi add "refactor spaghetti code"
+    $ koi add "find a better name"
+
+Let's see what we've got now with `list`:
+
+    $ koi list
+
+    [0] refactor spaghetti code
+    [1] find a better name
+
+Tasks can be refered to by index `1`, `2` or by name. You don't have to type in the full name though:
+
+    $ koi tag spaghetti #R
+    $ koi done 1
+
+I just went ahead and tagged my first task with `#R`, and completed my 2nd one. Here's the new list:
+
+    $ koi list
+
+    [0] refactor spaghetti code #R
+    
+    # recently completed
+    - find a better name
+
+You can also specify tags when adding new tasks:
+
+    $ koi add "make pasta" #food #yum #kitchen
+
+And remove tasks:
+
+    $ koi remove pasta
+
+**koi** creates an _.koi_ folder in the directory you initialize your project in. Inside that folder is a _database.yml_ with all your tasks for that project.
+
+
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "koi"
+    gem.summary = %Q{minimal task management for hackers}
+    gem.description = %Q{minimalist console-based task management for hackers}
+    gem.email = "self@cloudhead.net"
+    gem.homepage = "http://github.com/cloudhead/koi"
+    gem.authors = ["cloudhead"]
+    gem.add_development_dependency "rspec"
+    gem.add_dependency "mutter", ">= 0.4"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--color', '--format=specdoc']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/koi

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'koi'
+
+args = ARGV.dup
+
+options = {verbose: false, silent: false}
+
+OptionParser.new do |o|
+  o.banner = "usage: it COMMAND [ARGS]"
+  o.separator ""
+  
+  o.on_tail("-s", "--silent", "turn output off") do
+    options[:silent] = true
+  end
+  
+  o.on_tail("-v", "--verbose", "enable verbose mode") do
+    options[:verbose] = true
+  end
+end.parse!(args)
+
+Koi::Command.new(args[0] || :status, args[1] || nil, args[2] || [], options).run
+

data/koi.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{koi}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["cloudhead"]
+  s.date = %q{2009-10-20}
+  s.default_executable = %q{koi}
+  s.description = %q{minimalist console-based task management for hackers}
+  s.email = %q{self@cloudhead.net}
+  s.executables = ["koi"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/koi",
+     "koi.gemspec",
+     "lib/koi.rb",
+     "spec/koi_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/cloudhead/koi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{minimal task management for hackers}
+  s.test_files = [
+    "spec/koi_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<mutter>, [">= 0.4"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mutter>, [">= 0.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mutter>, [">= 0.4"])
+  end
+end

data/lib/koi.rb

@@ -0,0 +1,281 @@
+
+require 'yaml'
+require 'mutter'
+require 'fileutils'
+
+module Koi
+
+  Path = {root: ".koi", db: ".koi/database.yml"}
+
+  def self.init dir = Dir.pwd
+    unless init?
+      FileUtils.mkdir File.join(dir, Path[:root])
+      FileUtils.touch File.join(dir, Path[:db])
+    end
+  end
+
+  def self.init! dir = Dir.pwd
+    FileUtils.rm_rf File.join(dir, Path[:root])
+    init dir
+  end
+
+  def self.init? dir = root
+    File.exist? File.join(dir, Path[:root]) if dir
+  end
+  
+  def self.run *args
+    cmd = Command.new(*args)
+    cmd[:silent] = true
+    cmd.run
+  end
+  
+  def self.version
+    File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip
+  end
+
+  def self.root
+    path = Dir.pwd.split('/').reject {|d| d.empty? }
+    (path.size + 1).times do
+      if Koi.init? (sub = File.join('/', *path))
+        return sub
+      end
+      path.pop
+    end
+    return nil
+  end
+
+  class Command
+    Commands = [
+      :init, :add, :list, :tag,
+      :done, :did, :log, :status,
+      :remove, :float, :sink,
+      :ls, :rm
+    ]
+    Initializers = [:init, :add]
+    Special = {"!" => :done, "?" => :status}
+
+    def initialize *all
+      cmd, param, args, options = all
+      @command = Special[cmd] || cmd.to_sym
+      @args = [args || []].flatten
+      @param = param =~ /^\d+$/ ? param.to_i : param
+      @options = options || {}
+      @db = Koi.init?? Database.new(File.join(Koi.root, Path[:db])) : Database.new
+      @mut = Mutter.new(blue: '#', underline: "''", cyan: '@@', green: '!!', yellow: '^').clear(:default)
+    end
+
+    def run
+      if Commands.include? @command
+        if Koi.init? or Initializers.include? @command
+          if !@param or @command == :add or @param = @db.find(@param)
+            if send(@command, *[@param, *@args].compact.flatten)
+              save
+            else
+              err "error running #@command"
+            end
+          else
+            err "task wasn't found"
+          end
+        else
+           err "'it' is not initialized here, please run `it init`"
+        end
+      else
+        err "#{@command} is not a valid command."
+      end
+    end
+    
+    def []= key, val
+      @options[key] = val
+    end
+    
+    def [] key
+      @options[key]
+    end
+
+    def init
+      unless Koi.init
+        err "'it' has already been initialized here"
+      else
+        true
+      end
+    end
+    
+    def status
+      out "in the water (#{@db.select {|e| e.new? }.size})"
+
+      self.list 5
+
+      out "recently fished (#{@db.select {|e| e.completed? }.size})"
+
+      @db.select  {|e| e[:status] == :completed }.
+          sort_by {|e| e[:completed_at] }[0..3].reverse.each do |e|
+        out "- !!#{e[:title]}!!"
+      end
+
+      out
+      true
+    end
+
+    #
+    # List current tasks
+    #
+    def list count = 10, index = -1
+      out
+      
+      @db.select {|e| e.new? }[0..count].each do |e|
+        out "#[#{index += 1}]# ''#{e[:title]}'' @@#{e[:tags].join(' ')}@@" unless e[:status] == :removed
+      end.tap do |list|
+        out "  !!nothing left to do!!" if list.size.zero?
+      end
+
+      out
+    end
+    alias :ls list
+    
+    def float
+    end
+
+    def sink
+    end
+
+    #
+    # Show task history
+    #
+    def log
+      @db.map do |entity|
+        Entity::Status.map do |status|
+          { title: entity[:title],
+            action: status,
+            time: entity[:"#{status}_at"]
+          } if entity[:"#{status}_at"]
+        end.compact
+      end.flatten.sort_by {|e| e[:time]}.reverse.each do |entry|
+        out "##{entry[:time]}# ^#{entry[:action]}^ ''#{entry[:title]}''"
+      end
+    end
+
+    def out obj = ""
+      if obj.is_a? Hash
+        puts "#{obj[:title]} : #{obj[:status]}"
+      else
+        @mut.say obj.to_s
+      end unless @options[:silent]
+    end
+
+    def err str
+      @options[:silent] ? abort : abort(str)
+    end
+
+    def add entry, *args
+      Koi.init
+      target = args.find {|a| a.start_with? '@' }[1..-1] rescue nil
+      tags = args.select {|a| a.start_with? '#' }
+      @db << Entity.new(title: entry, tags: tags, target: target)
+    end
+
+    def tag entry, tags
+      entry[:tags] << tags
+    end
+
+    def did entry = 0
+      entry.status = :completed
+      entry[:completed_by] = ENV['USER']
+    end
+    alias :done did
+    alias :fish did
+
+    def save
+      File.open(File.join(Koi.root, Path[:db]), 'w') {|f| f.write @db.to_yaml }
+    end
+    
+    #
+    # Mark task as :removed (doesn't show up anywhere)
+    #
+    def remove entry
+      entry.status = :removed
+    end
+    alias :rm remove
+    alias :kill remove
+  end
+
+  class Database
+    include Enumerable
+
+    def initialize path = nil
+      if @path = path
+        self.load path
+      else
+        @data = []
+      end
+    end
+
+    def find key
+      if key.is_a? String
+        @data.find {|e| e[:title].include? key }
+      elsif key.is_a? Fixnum
+        @data.select {|e| e[:status] == :created}[key]
+      else
+        raise ArgumentError, "key must be a String or Fixnum, but is #{key.class}"
+      end
+    end
+    alias :[] find
+    
+    def load path = @path || Path[:db]
+      @data = if db = YAML.load_file(path)
+        db.map {|e| Entity.new(e) }
+      else
+        []
+      end
+      self
+    end
+
+    def each &blk
+      @data.each &blk
+    end
+
+    def << entry
+      @data << (entry.is_a?(Entity) ? entry : Entity.new(entry))
+    end
+
+    def to_yaml *args, &blk
+      @data.to_yaml *args, &blk
+    end
+  end
+
+  class Entity < Hash
+    Status = [:created, :completed, :removed]
+
+    def initialize data = {}
+      self.replace status:     :created,
+                   created_at: Time.now,
+                   owner:      ENV['USER'],
+                   velocity:   0,
+                   freshness:  0,
+                   depth:      0,
+                   tags:       []
+      merge!(data)
+    end
+    
+    def new?
+      self[:status] == :created
+    end
+
+    def status= st
+      self[:status] = st
+      self[:"#{st}_at"] = Time.now
+    end
+
+    #
+    # Handle things like `self.removed?`
+    #
+    def method_missing meth, *args, &blk
+      if meth.to_s.end_with?('?') && Status.include?(s = meth.to_s.chop.to_sym)
+        self[:status] == s
+      else
+        super
+      end
+    end
+  end
+end
+
+

data/spec/koi_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Koi do
+  TASK = "buy milk"
+
+  context "in a new project" do
+    before(:each) do
+      FileUtils.rm_rf(Koi::Path[:root])
+    end
+
+    it "should initialize the directory" do
+      Koi.run(:init)
+      File.exist?(Koi::Path[:root]).should be_true
+      File.exist?(Koi::Path[:db]).should be_true
+    end
+
+    it "should warn that the project isn't initialized" do
+      -> {Koi.run(:list)}.should raise_error(SystemExit)
+    end
+  end
+
+  context "in an existing project" do
+    before(:all) do
+      Koi.init!
+    end
+ 
+    context "with no tasks" do
+      it "shouldn't try to init" do
+        -> {Koi.run(:init)}.should raise_error(SystemExit)
+      end
+      
+      it "should warn about invalid commands" do
+        -> {Koi.run(:choo)}.should raise_error(SystemExit)
+      end
+
+      it "should add tasks" do
+        if Koi.run(:add, TASK)
+          e = Koi::Database.new(Koi::Path[:db]).find(TASK)
+          e.should be_a(Koi::Entity)
+          e[:status].should == :created
+          e[:tags].should == []
+        else
+          fail
+        end
+      end
+    end
+
+    context "with a couple tasks" do
+      TASKS = ["milk", "eggs", "bananas"]
+      before(:each) do
+        Koi.init!
+        TASKS.each do |t|
+          Koi.run(:add, t)
+        end
+        @db = Koi::Database.new(Koi::Path[:db])
+      end
+
+      it "should remove tasks" do
+        Koi.run(:remove, TASKS.last)
+        @db.load.find(TASKS.last)[:status].should == :removed
+      end
+
+      it "should complete tasks" do
+        Koi.run(:did, TASKS.first)
+        @db.load.find(TASKS.first)[:status].should == :completed
+      end
+
+      it "should tag tasks" do
+        Koi.run(:tag, TASKS[1], ["food"])
+        @db.load.find(TASKS[1])[:tags].should include("food")
+      end
+
+      it "should warn when the task wasn't found" do
+        -> {Koi.run(:did, "celery")}.should raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'koi'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: koi
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- cloudhead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 -04:00
+default_executable: koi
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mutter
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
+description: minimalist console-based task management for hackers
+email: self@cloudhead.net
+executables: 
+- koi
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/koi
+- koi.gemspec
+- lib/koi.rb
+- spec/koi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/cloudhead/koi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: minimal task management for hackers
+test_files: 
+- spec/koi_spec.rb
+- spec/spec_helper.rb