cardigan 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Ryall
+ 
+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.rdoc

@@ -0,0 +1,39 @@
+= Cardigan
+
+A simple command line project task tracking tool.
+
+== Installation
+
+  gem install cardigan
+
+== Usage
+
+  cardigan
+
+This will prompt for your name and email address (for no good reason at the moment), create a folder called .cards in the current directory and enter a shell.
+
+  cardigan >
+
+So what now?
+
+== Listing mode
+
+You are in listing mode.
+
+The commands available are (with the awesome power of tab completion):
+
+* quit
+* exit
+* list - shows all cards
+* list <filter> - shows a subset of cards. Filter is some ruby code such as card[:name].start_with?('a')
+* edit <name> - creates a card and enters edit mode
+
+== Editing mode
+
+* quit
+* exit
+* set <key> - creates a new key and prompts for the new value
+	
+== Future plans
+
+Refer to the .cards for detailed story breakdown but mostly importing, exporting and generating pretty html reports/charts.

data/bin/cardigan

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__)+'/../lib'
+
+require 'cardigan/cli'
+
+Cardigan::Cli.new.execute *ARGV

data/lib/cardigan/cli.rb

@@ -0,0 +1,26 @@
+require 'cardigan/io'
+require 'cardigan/root_context'
+require 'cardigan/directory'
+
+module Cardigan
+  class Cli
+    CONFIG_FILE = '.cardigan'
+
+    def initialize io=Io.new
+      @io = io
+      @home = Directory.new('~')
+    end
+
+    def execute *args
+      if @home.has_file?(CONFIG_FILE)
+        config = @home.load(CONFIG_FILE)
+      else
+        config = { :name => @io.ask('Enter your full name'),
+          :email => @io.ask('Enter your email address')
+        }
+        @home.store CONFIG_FILE, config 
+      end
+      RootContext.new(@io, Directory.new('.cards')).push
+    end
+  end
+end

data/lib/cardigan/context.rb

@@ -0,0 +1,46 @@
+require 'readline'
+
+module Cardigan
+  module Context
+    def refresh
+      refresh_commands if respond_to?(:refresh_commands)
+      Readline.completion_proc = lambda do |text|
+        (@commands + ['quit', 'exit']).grep( /^#{Regexp.escape(text)}/ ).sort
+      end
+      Readline.completer_word_break_characters = ''
+    end
+
+    def push
+      refresh
+      begin
+        while line = Readline.readline(@prompt_text, true)
+          line.strip!
+          case line
+            when 'quit','exit'
+              return
+            when /(\w+) (.*)/
+              process_command $1, $2
+            when /(\w+)/
+              process_command $1
+            else
+              puts 'unknown command'
+          end
+          puts
+          refresh
+        end
+      rescue Interrupt => e
+        return
+      end
+      puts
+    end
+    
+    def process_command name, parameter=nil
+      m = "#{name}_command".to_sym
+      if respond_to?(m)
+        send(m, parameter) 
+      else
+        @io.say 'unknown command'
+      end
+    end
+  end
+end

data/lib/cardigan/directory.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+require 'fileutils'
+
+module Cardigan
+  class Directory
+    def initialize path
+      @path = File.expand_path(path)
+    end
+
+    def has_file? file
+      File.exist? File.join(@path, file)
+    end
+
+    def load file
+      YAML::load File.read(File.join(@path, file))
+    end
+
+    def store file, hash
+      File.open(File.join(@path, file), 'w') {|f| f.print hash.to_yaml}
+    end
+    
+    def create
+      FileUtils.mkdir_p @path
+    end
+    
+    def find pattern
+      Dir.glob(File.join(@path, pattern)).map {|path| YAML::load File.read(path) }
+    end
+  end
+end

data/lib/cardigan/entry_context.rb

@@ -0,0 +1,17 @@
+require 'cardigan/context'
+
+module Cardigan
+  class EntryContext
+    include Context
+    
+    def initialize io, entry
+      @io, @entry = io, entry
+      @prompt_text = "c/#{entry[:name]} > "
+      @commands = ['set']
+    end
+    
+    def set_command key
+      @entry[:text] = @io.ask("Enter the new value for #{key}")
+    end
+  end
+end

data/lib/cardigan/io.rb

@@ -0,0 +1,16 @@
+module Cardigan
+  class Io
+    def initialize in_io=$stdin, out_io=$stdout
+      @in_io, @out_io = in_io, out_io
+    end
+
+    def ask prompt
+      @out_io.print "#{prompt} > "
+      @in_io.gets.chomp
+    end
+    
+    def say message
+      @out_io.puts message
+    end
+  end
+end

data/lib/cardigan/root_context.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'uuidtools'
+require 'cardigan/context'
+require 'cardigan/entry_context'
+
+module Cardigan
+  class RootContext
+    include Context
+
+    def initialize io, directory
+      @io, @directory = io, directory
+      @directory.create
+      @prompt_text = 'cardigan > '
+    end
+    
+    def refresh_commands
+      @cards = @directory.find('*.card')
+      @commands = ['edit', 'list']
+      @cards.each do |card|
+        @commands << "edit #{card[:name]}"
+      end
+    end
+
+    def edit_command text
+      card = @cards.find {|card| card[:name] == text}
+      card ||= { :id => UUIDTools::UUID.random_create.to_s,
+        :name => text
+      }
+      EntryContext.new(@io, card).push
+      @directory.store "#{card[:id]}.card", card
+    end
+
+    def list_command text=nil
+      cards = text ? @cards.select {|card| eval text } : @cards
+      @io.say "\n#{cards.count} cards"
+      cards.map {|card| card[:name] }.sort.each {|name| @io.say name }
+    end
+  end
+end
+    

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: cardigan
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Ryall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: crypt
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pathname2
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.3
+    version: 
+description: |
+  A command line utility that manages cards as individual files so that they can be added to a version control system
+
+email: mark@ryall.name
+executables: 
+- cardigan
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cardigan/cli.rb
+- lib/cardigan/context.rb
+- lib/cardigan/directory.rb
+- lib/cardigan/entry_context.rb
+- lib/cardigan/io.rb
+- lib/cardigan/root_context.rb
+- bin/cardigan
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/markryall/cardigan
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: command line utility for managing cards (tasks, bugs, stories or whatever)
+test_files: []
+