cardigan 0.0.3 → 0.0.4

data/README.rdoc

@@ -16,7 +16,7 @@ A simple command line project task tracking tool.
 
   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.
+This will prompt for your name and email address (and store them in ~/.cardigan), create a folder called .cards in the current directory and enter a shell.  The idea is that you will run this at the root of a git/hg/svn/whatever repository and manage the cards in the same way you manage your source code.
 
   cardigan >
 
@@ -29,21 +29,36 @@ You start in listing mode.
 The commands available are (with the awesome power of tab completion):
 
 * quit or exit or ctrl-d - exit
-* list - shows all cards
+* list - shows all cards with an index
 * filter <filter> - sets the filter for cards - this is ruby code such as card[:name].start_with?('a')
-* claim <numbers> - sets the owner of the specified cards (by index number from the list view)
-* unclaim <numbers> - removes the owner from the specified cards (by index number from the list view)
+* claim <numbers> - sets the owner of the specified cards (by index from the list)
+* unclaim <numbers> - removes the owner from the specified cards (by index from the list)
 * create <name> - creates a card with the specified name
 * open <name> - creates or opens the card and enters edit mode
 * columns - lists or changes the columns to be displayed by the list command
-* destroy <numbers> - deletes the specified cards (by index number from the list view)
+* destroy <numbers> - deletes the specified cards (by index from the list)
+* set <key> <numbers> - prompts for a field value and sets it on all specified cards (by index from the list)
+* workflow - enters workflow editing mode
 
 == Editing mode
 
 * quit or exit or ctrl-d - exit
 * show - dumps the values of all card field values
 * set <key> - creates a new field and prompts for the new value
+* to <status> - changes the status of the card to the given status (the tab completion will be populated with the valid subsequent statuses from the current status)
+
+== Workflow mode
+
+Workflow is pretty simple - it is just for convenience in specifiying the set of valid statuses for cards with a specific status.
+
+The only purpose is to populate tab completion in editing mode for a card.
+
+* quit or exit or ctrl-d - exit
+* show - dumps the current workflow (statuses with their valid subsequent statuses)
+* create <status> - creates a new status
+* add <status> <statuses> - add the specified statuses as valid transitions from status
+* remove <status> <statuses> - remove the specified statuses as valid transitions from status
 
 == Future plans
 
-Refer to the .cards for detailed story breakdown but mostly simple worflow, importing, exporting and generating pretty html reports/charts.
+Refer to the .cards for detailed story breakdown but importing, exporting and generating pretty html reports/charts.

data/lib/cardigan/cli.rb

@@ -1,6 +1,7 @@
 require 'cardigan/io'
 require 'cardigan/root_context'
 require 'cardigan/repository'
+require 'cardigan/workflow_repository'
 
 module Cardigan
   class Cli
@@ -21,7 +22,7 @@ module Cardigan
         @home.store CONFIG_FILE, config 
       end
       name = "\"#{config[:name]}\" <#{config[:email]}>"
-      RootContext.new(@io, Repository.new('.cards'), name).push
+      RootContext.new(@io, Repository.new('.cards'), name, WorkflowRepository.new('.')).push
     end
   end
 end

data/lib/cardigan/command/batch_update_cards.rb

@@ -0,0 +1,24 @@
+module Cardigan
+  module Command
+    class BatchUpdateCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute text
+        key, *rest = text.scan(/\w+/)
+        value = @io.ask("Enter the new value for #{key}")
+        @repository.each_card_from_indices(rest.join(' ')) do |card|
+          if value.empty?
+            @io.say "removing #{key} from '#{card['name']}'"
+            card.delete key
+          else
+            @io.say "setting #{key} to '#{value}' for '#{card['name']}'"
+            card[key] = value
+          end
+          @repository.save card
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/claim_cards.rb

@@ -0,0 +1,17 @@
+module Cardigan
+  module Command
+    class ClaimCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute numbers
+        @repository.each_card_from_indices(numbers) do |card|
+          @io.say "claiming \"#{card['name']}\""
+          card['owner'] = @name
+          @repository.save card
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/create_card.rb

@@ -0,0 +1,13 @@
+module Cardigan
+  module Command
+    class CreateCard
+      def initialize repository
+        @repository = repository
+      end
+
+      def execute name
+        @repository.save @repository.find_or_create(name)
+      end
+    end
+  end
+end

data/lib/cardigan/command/destroy_cards.rb

@@ -0,0 +1,16 @@
+module Cardigan
+  module Command
+    class DestroyCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute numbers
+        @repository.each_card_from_indices(numbers) do |card|
+          @io.say "destroying \"#{card['name']}\""
+          @repository.destroy card
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/filter_cards.rb

@@ -0,0 +1,19 @@
+module Cardigan
+  module Command
+    class FilterCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute filter
+        @repository.filter = filter
+        begin
+          @io.say "#{@repository.cards.length} cards match filter"
+        rescue Exception => e
+          @io.say "Invalid expression:\n#{e.message}"
+          @repository.filter = nil
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/list_cards.rb

@@ -0,0 +1,21 @@
+require 'cardigan/text_report_formatter'
+
+module Cardigan
+  module Command
+    class ListCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute name
+        cards = @repository.cards
+        formatter = TextReportFormatter.new @io
+        a = 0
+        @repository.columns.each do |column|
+          formatter.add_column(column, @repository.max_field_length(column))
+        end
+        formatter.output cards
+      end
+    end
+  end
+end

data/lib/cardigan/command/open_card.rb

@@ -0,0 +1,17 @@
+require 'cardigan/entry_context'
+
+module Cardigan
+  module Command
+    class OpenCard
+      def initialize repository, workflow_repository, io
+        @repository, @workflow_repository, @io = repository, workflow_repository, io
+      end
+
+      def execute name
+        card = @repository.find_or_create(name)
+        EntryContext.new(@io, @workflow_repository, card).push
+        @repository.save card
+      end
+    end
+  end
+end

data/lib/cardigan/command/open_workflow.rb

@@ -0,0 +1,17 @@
+require 'cardigan/workflow_context'
+
+module Cardigan
+  module Command
+    class OpenWorkflow
+      def initialize workflow_repository, io
+        @workflow_repository, @io = workflow_repository, io
+      end
+
+      def execute name
+        workflow = @workflow_repository.load
+        WorkflowContext.new(@io, workflow).push
+        @workflow_repository.save workflow
+      end
+    end
+  end
+end

data/lib/cardigan/command/select_columns.rb

@@ -0,0 +1,20 @@
+module Cardigan
+  module Command
+    class SelectColumns
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute text
+        if text
+          @repository.columns = text.scan(/\w+/) 
+        else
+          @io.say "current columns: #{@repository.columns.join(',')}"
+          columns = Set.new
+          @repository.cards.each {|card| columns += card.keys }
+          @io.say "available columns: #{columns.sort.join(',')}"
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/unclaim_cards.rb

@@ -0,0 +1,17 @@
+module Cardigan
+  module Command
+    class UnclaimCards
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute numbers
+        @repository.each_card_from_indices(numbers) do |card|
+          @io.say "unclaiming \"#{card['name']}\""
+          card.delete('owner')
+          @repository.save card
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/unfilter_cards.rb

@@ -0,0 +1,13 @@
+module Cardigan
+  module Command
+    class UnfilterCards
+      def initialize repository
+        @repository = repository
+      end
+
+      def execute ignored
+        @repository.filter = nil
+      end
+    end
+  end
+end

data/lib/cardigan/context.rb

@@ -3,9 +3,9 @@ require 'readline'
 module Cardigan
   module Context
     def refresh
-      refresh_commands if respond_to?(:refresh_commands)
+      commands = respond_to?(:refresh_commands) ? refresh_commands : []
       Readline.completion_proc = lambda do |text|
-        (@commands + ['quit', 'exit']).grep( /^#{Regexp.escape(text)}/ ).sort
+        (commands + @commands.keys + ['quit', 'exit']).grep( /^#{Regexp.escape(text)}/ ).sort
       end
       Readline.completer_word_break_characters = ''
     end
@@ -33,11 +33,15 @@ module Cardigan
       end
       puts
     end
-    
+
     def process_command name, parameter=nil
       m = "#{name}_command".to_sym
       if respond_to?(m)
-        send(m, parameter) 
+        send(m, parameter)
+        return
+      end 
+      if @commands[name]
+        @commands[name].execute parameter
       else
         @io.say 'unknown command'
       end

data/lib/cardigan/entry_context.rb

@@ -3,17 +3,30 @@ require 'cardigan/context'
 module Cardigan
   class EntryContext
     include Context
-    
-    def initialize io, entry
-      @io, @entry = io, entry
+
+    def initialize io, workflow_repository, entry
+      @io, @workflow_repository, @entry = io, workflow_repository, entry
       @prompt_text = "#{File.expand_path('.').split('/').last.slice(0..0)}/#{entry['name']} > "
-      @commands = ['set', 'show']
+      @commands = {}
+    end
+
+    def refresh_commands
+      commands = ['set', 'show']
+      status = @entry['status'] || 'none'
+      @workflow_repository.load[status].each do |s|
+        commands << "now #{s}"
+      end
+      commands
+    end
+
+    def now_command status
+      @entry['status'] = status
     end
 
     def set_command key
       @entry[key] = @io.ask("Enter the new value for #{key}")
     end
-    
+
     def show_command ignored=nil
       @entry.keys.sort.each do |key|
         @io.say "#{key}: #{@entry[key]}"

data/lib/cardigan/filtered_repository.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+
+module Cardigan
+  class FilteredRepository
+    attr_accessor :filter, :columns, :sort
+
+    extend Forwardable
+
+    def_delegators :@repository, :refresh, :save, :destroy, :find_or_create
+
+    def initialize repository, sort, *columns
+      @repository, @sort, @columns = repository, sort, columns
+    end
+
+    def cards
+      cards = @filter ? @repository.cards.select {|card| eval @filter } : @repository.cards
+      cards.sort {|a,b| a[sort] <=> b[sort] }
+    end
+
+    def max_field_length name
+      cards.map {|card| card[name] ? card[name].length : 0 }.max
+    end
+
+    def each_card_from_indices numbers
+      c = cards
+      numbers.scan(/\d+/).each do |n|
+        yield c[n.to_i - 1]
+      end
+    end
+  end
+end

data/lib/cardigan/repository.rb

@@ -12,11 +12,11 @@ module Cardigan
     def refresh
       @cards = @directory.find('*.card')
     end
-    
+
     def find_card name
       @cards.find {|card| card['name'] == name}
     end
-    
+
     def save card
       @directory.store "#{card['id']}.card", card
     end

data/lib/cardigan/root_context.rb

@@ -2,112 +2,44 @@ require 'rubygems'
 require 'uuidtools'
 require 'set'
 require 'cardigan/context'
-require 'cardigan/entry_context'
-require 'cardigan/text_report_formatter'
+require 'cardigan/filtered_repository'
+require 'cardigan/command/batch_update_cards'
+require 'cardigan/command/claim_cards'
+require 'cardigan/command/create_card'
+require 'cardigan/command/destroy_cards'
+require 'cardigan/command/filter_cards'
+require 'cardigan/command/list_cards'
+require 'cardigan/command/open_card'
+require 'cardigan/command/open_workflow'
+require 'cardigan/command/select_columns'
+require 'cardigan/command/unclaim_cards'
+require 'cardigan/command/unfilter_cards'
 
 module Cardigan
   class RootContext
     include Context
 
-    def initialize io, repository, name
-      @io, @repository, @name = io, repository, name
+    def initialize io, repository, name, workflow_repository
+      @io, @repository, @name, @workflow_repository = io, FilteredRepository.new(repository, 'name', 'name'), name, workflow_repository
       @prompt_text = "#{File.expand_path('.').split('/').last} > "
-      @columns = ['name']
+      @commands = {
+        'claim' => Command::ClaimCards.new(@repository, @io),
+        'columns' => Command::SelectColumns.new(@repository, @io),
+        'create' => Command::CreateCard.new(@repository),
+        'destroy' => Command::DestroyCards.new(@repository, @io),
+        'filter' => Command::FilterCards.new(@repository, @io),
+        'list' => Command::ListCards.new(@repository, @io),
+        'open' => Command::OpenCard.new(@repository, @workflow_repository, @io),
+        'set' => Command::BatchUpdateCards.new(@repository, @io),
+        'unclaim' => Command::UnclaimCards.new(@repository, @io),
+        'unfilter' => Command::UnfilterCards.new(@repository),
+        'workflow' => Command::OpenWorkflow.new(@workflow_repository, @io)
+      }
     end
 
     def refresh_commands
       @repository.refresh
-      @commands = ['create', 'list', 'filter', 'unfilter', 'columns', 'claim', 'unclaim', 'destroy']
-      @repository.cards.each do |card|
-        @commands << "open #{card['name']}"
-      end
-    end
-
-    def create_command name
-      @repository.save @repository.find_or_create(name)
-    end
-
-    def open_command name
-      card = @repository.find_or_create(name)
-      EntryContext.new(@io, card).push
-      @repository.save card
-    end
-
-    def destroy_command numbers
-      each_card_from_indices(numbers) do |card|
-        @io.say "destroying \"#{card['name']}\""
-        @repository.destroy card
-      end
-    end
-
-    def list_command ignored
-      cards = sorted_selection
-      formatter = TextReportFormatter.new @io
-      a = 0
-      @columns.each do |column|
-        formatter.add_column(column, max_field_length(cards, column))
-      end
-      formatter.output cards
-    end
-    
-    def unfilter_command ignored
-      @filter = nil
-    end
-    
-    def columns_command text
-      if text
-        @columns = text.scan(/\w+/) 
-      else
-        @io.say "current columns: #{@columns.join(',')}"
-        columns = Set.new
-        sorted_selection.each do |card|
-          columns += card.keys
-        end
-        @io.say "available columns: #{columns.sort.join(',')}"
-      end
-    end
-    
-    def filter_command code
-      @filter = code
-      begin
-        cards = @repository.cards.select {|card| eval @filter }
-        @io.say "#{cards.count} cards match filter"
-      rescue Exception => e
-        @io.say "Invalid expression:\n#{e.message}"
-        @filter = nil
-      end
-    end
-    
-    def claim_command numbers
-      each_card_from_indices(numbers) do |card|
-        @io.say "claiming \"#{card['name']}\""
-        card['owner'] = @name
-        @repository.save card
-      end
-    end
-    
-    def unclaim_command numbers
-      each_card_from_indices(numbers) do |card|
-        @io.say "claiming \"#{card['name']}\""
-        card.delete('owner')
-        @repository.save card
-      end
-    end
-private
-    def each_card_from_indices numbers
-      cards = sorted_selection
-      numbers.scan(/\d+/).each do |n|
-        yield cards[n.to_i - 1]
-      end
-    end
-
-    def max_field_length cards, name
-      cards.map {|card| card[name] ? card[name].length : 0 }.max
-    end
- 
-    def sorted_selection
-      cards = @filter ? @repository.cards.select {|card| eval @filter } : @repository.cards
-      cards.sort {|a,b| a['name'] <=> b['name'] }
+      @repository.cards.map {|card| "open #{card['name']}" }
     end
   end
-end
+end

data/lib/cardigan/text_report_formatter.rb

@@ -18,7 +18,9 @@ module Cardigan
       row 'index', @columns.map {|tuple| tuple.first }
       hline
       hashes.each_with_index do |h,i|
-        row (i+1).to_s, @columns.map {|tuple| h[tuple.first]}
+        first = (i+1).to_s
+        values = @columns.map {|tuple| h[tuple.first]}
+        row first, values 
       end
       hline
     end
@@ -26,7 +28,7 @@ private
     def hline
       @io.say ' ' + '-' * @width
     end
-    
+
     def row first, values
       a = "| #{first.ljust(@heading.length)} | "      
       @columns.each_with_index do |tuple, index|

data/lib/cardigan/workflow_context.rb

@@ -0,0 +1,37 @@
+require 'cardigan/context'
+
+module Cardigan
+  class WorkflowContext
+    include Context
+
+    def initialize io, entry
+      @io, @entry = io, entry
+      @prompt_text = "#{File.expand_path('.').split('/').last.slice(0..0)}/workflow > "
+      @commands = {}
+    end
+
+    def refresh_commands
+      ['create', 'add', 'remove', 'show']
+    end
+
+    def create_command key
+      @entry[key] = []
+    end
+
+    def add_command text
+      name, *states = text.scan(/\w+/)
+      @entry[name] += states
+    end
+
+    def remove_command text
+      name, *states = text.scan(/\w+/)
+      @entry[name] -= states
+    end
+
+    def show_command ignored=nil
+      @entry.keys.sort.each do |key|
+        @io.say "#{key}: #{@entry[key].join(',')}"
+      end
+    end
+  end
+end

data/lib/cardigan/workflow_repository.rb

@@ -0,0 +1,16 @@
+module Cardigan
+  class WorkflowRepository
+    def initialize path
+      @directory = Directory.new(path)
+      @path = '.card_workflow'
+    end
+
+    def save workflow
+      @directory.store @path, workflow
+    end
+
+    def load
+      @directory.has_file?(@path) ? @directory.load(@path) : {}
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cardigan
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Mark Ryall
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-13 00:00:00 +11:00
+date: 2010-03-14 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,13 +34,27 @@ extra_rdoc_files: []
 
 files: 
 - lib/cardigan/cli.rb
+- lib/cardigan/command/batch_update_cards.rb
+- lib/cardigan/command/claim_cards.rb
+- lib/cardigan/command/create_card.rb
+- lib/cardigan/command/destroy_cards.rb
+- lib/cardigan/command/filter_cards.rb
+- lib/cardigan/command/list_cards.rb
+- lib/cardigan/command/open_card.rb
+- lib/cardigan/command/open_workflow.rb
+- lib/cardigan/command/select_columns.rb
+- lib/cardigan/command/unclaim_cards.rb
+- lib/cardigan/command/unfilter_cards.rb
 - lib/cardigan/context.rb
 - lib/cardigan/directory.rb
 - lib/cardigan/entry_context.rb
+- lib/cardigan/filtered_repository.rb
 - lib/cardigan/io.rb
 - lib/cardigan/repository.rb
 - lib/cardigan/root_context.rb
 - lib/cardigan/text_report_formatter.rb
+- lib/cardigan/workflow_context.rb
+- lib/cardigan/workflow_repository.rb
 - bin/cardigan
 - README.rdoc
 - MIT-LICENSE