cardigan 0.0.4 → 0.0.5

data/README.rdoc

@@ -35,7 +35,8 @@ The commands available are (with the awesome power of tab completion):
 * 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
+* display <columns> - lists or changes the columns to be displayed by the list command
+* sort <columns> - lists or changes the columns to be used for sorting by the list command
 * 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
@@ -45,13 +46,13 @@ The commands available are (with the awesome power of tab completion):
 * 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)
+* now <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.
+Workflow is pretty simple - it is just for convenience in specifiying the set of valid transitions for cards with a specific status.
 
-The only purpose is to populate tab completion in editing mode for a card.
+The only purpose is to populate tab completion for the 'now' command in edit mode for a card.
 
 * quit or exit or ctrl-d - exit
 * show - dumps the current workflow (statuses with their valid subsequent statuses)
@@ -59,6 +60,10 @@ The only purpose is to populate tab completion in editing mode for a card.
 * add <status> <statuses> - add the specified statuses as valid transitions from status
 * remove <status> <statuses> - remove the specified statuses as valid transitions from status
 
+== Walkthroughs
+
+In case this documentation makes no sense at all, a few usage scenarios can be found here: http://gist.github.com/331647
+
 == Future plans
 
-Refer to the .cards for detailed story breakdown but importing, exporting and generating pretty html reports/charts.
+Refer to the .cards for detailed story breakdown but importing, exporting, automatic vcs interaction and generating pretty html reports/charts seem to be the most important missing features.

data/lib/cardigan/command/list_cards.rb

@@ -7,11 +7,10 @@ module Cardigan
         @repository, @io = repository, io
       end
 
-      def execute name
+      def execute text
         cards = @repository.cards
         formatter = TextReportFormatter.new @io
-        a = 0
-        @repository.columns.each do |column|
+        @repository.display_columns.each do |column|
           formatter.add_column(column, @repository.max_field_length(column))
         end
         formatter.output cards

data/lib/cardigan/command/select_columns.rb

@@ -1,6 +1,6 @@
 module Cardigan
   module Command
-    class SelectColumns
+    class SpecifyDisplayColumns
       def initialize repository, io
         @repository, @io = repository, io
       end

data/lib/cardigan/command/specify_display_columns.rb

@@ -0,0 +1,20 @@
+module Cardigan
+  module Command
+    class SpecifyDisplayColumns
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute text
+        if text
+          @repository.display_columns = text.scan(/\w+/) 
+        else
+          @io.say "current columns: #{@repository.display_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/specify_sort_columns.rb

@@ -0,0 +1,20 @@
+module Cardigan
+  module Command
+    class SpecifySortColumns
+      def initialize repository, io
+        @repository, @io = repository, io
+      end
+
+      def execute text
+        if text
+          @repository.sort_columns = text.scan(/\w+/) 
+        else
+          @io.say "current columns: #{@repository.sort_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/filtered_repository.rb

@@ -2,19 +2,24 @@ require 'forwardable'
 
 module Cardigan
   class FilteredRepository
-    attr_accessor :filter, :columns, :sort
+    attr_accessor :filter, :sort_columns, :display_columns
 
     extend Forwardable
 
     def_delegators :@repository, :refresh, :save, :destroy, :find_or_create
 
-    def initialize repository, sort, *columns
-      @repository, @sort, @columns = repository, sort, columns
+    def initialize repository, user, *columns
+      @repository, @sort_columns, @display_columns, @user = repository, columns, columns, user
     end
 
     def cards
+      me = @user
       cards = @filter ? @repository.cards.select {|card| eval @filter } : @repository.cards
-      cards.sort {|a,b| a[sort] <=> b[sort] }
+      cards.sort do |a,b|
+        a_values = sort_columns.map {|col| a[col] ? a[col] : '' }
+        b_values = sort_columns.map {|col| b[col] ? b[col] : '' }
+        a_values <=> b_values
+      end
     end
 
     def max_field_length name

data/lib/cardigan/root_context.rb

@@ -11,7 +11,8 @@ 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/specify_display_columns'
+require 'cardigan/command/specify_sort_columns'
 require 'cardigan/command/unclaim_cards'
 require 'cardigan/command/unfilter_cards'
 
@@ -20,17 +21,18 @@ module Cardigan
     include Context
 
     def initialize io, repository, name, workflow_repository
-      @io, @repository, @name, @workflow_repository = io, FilteredRepository.new(repository, 'name', 'name'), name, workflow_repository
+      @io, @repository, @name, @workflow_repository = io, FilteredRepository.new(repository, name, 'name'), name, workflow_repository
       @prompt_text = "#{File.expand_path('.').split('/').last} > "
       @commands = {
         'claim' => Command::ClaimCards.new(@repository, @io),
-        'columns' => Command::SelectColumns.new(@repository, @io),
         'create' => Command::CreateCard.new(@repository),
         'destroy' => Command::DestroyCards.new(@repository, @io),
+        'display' => Command::SpecifyDisplayColumns.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),
+        'sort' => Command::SpecifySortColumns.new(@repository, @io),
         'unclaim' => Command::UnclaimCards.new(@repository, @io),
         'unfilter' => Command::UnfilterCards.new(@repository),
         'workflow' => Command::OpenWorkflow.new(@workflow_repository, @io)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cardigan
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mark Ryall
@@ -43,6 +43,8 @@ files:
 - lib/cardigan/command/open_card.rb
 - lib/cardigan/command/open_workflow.rb
 - lib/cardigan/command/select_columns.rb
+- lib/cardigan/command/specify_display_columns.rb
+- lib/cardigan/command/specify_sort_columns.rb
 - lib/cardigan/command/unclaim_cards.rb
 - lib/cardigan/command/unfilter_cards.rb
 - lib/cardigan/context.rb