cardigan 0.0.9 → 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+desc 'execute specifications'
+task :test do
+  sh 'bundle exec rspec spec'
+end

data/bin/cardigan

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+
 $:.unshift File.dirname(__FILE__)+'/../lib'
 
 require 'cardigan/cli'

data/lib/cardigan/cli.rb

@@ -1,28 +1,26 @@
 require 'cardigan/io'
 require 'cardigan/root_context'
-require 'cardigan/repository'
+require 'flat_hash/directory'
+require 'flat_hash/serialiser'
+require 'flat_hash/repository'
 require 'cardigan/workflow_repository'
 
-module Cardigan
-  class Cli
-    CONFIG_FILE = '.cardigan'
+class Cardigan::Cli
+  CONFIG_FILE = '.cardigan'
 
-    def initialize io=Io.new
-      @io = io
-      @home = Directory.new('~')
-    end
+  def initialize io=Cardigan::Io.new
+    @io = io
+    @home = FlatHash::Directory.new(FlatHash::Serialiser.new,File.expand_path('~'))
+  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
-      name = "\"#{config[:name]}\" <#{config[:email]}>"
-      RootContext.new(@io, Repository.new('.cards'), name, WorkflowRepository.new('.')).push
-    end
+  def execute *args
+    config = @home.exist?(CONFIG_FILE) ? @home[CONFIG_FILE] : {}
+    config['name'] = @io.ask('Enter your full name') unless config['name']
+    config['email'] = @io.ask('Enter your email address') unless config['email']
+    @home[CONFIG_FILE] = config
+    repository = FlatHash::Repository.new(FlatHash::Serialiser.new,'.cards')
+    name = "\"#{config['name']}\" <#{config['email']}>"
+    workflow_repository = Cardigan::WorkflowRepository.new('.')
+    Cardigan::RootContext.new(@io, repository, name, workflow_repository).push
   end
 end

data/lib/cardigan/command/add_transitions.rb

@@ -0,0 +1,27 @@
+require 'cardigan/commands'
+
+class Cardigan::Command::AddTransitions
+  attr_reader :usage, :help
+
+  def initialize entry, io
+    @entry, @io = entry, io
+    @usage = '<start status> [<subsequent status>]+'
+    @help = 'Creates transitions from a starting status to a number of subsequent statuses'
+  end
+
+  def execute text=nil
+    unless text and !text.empty?
+      @io.say 'missing required start status'
+      return
+    end
+    name, *states = text.scan(/\w+/)
+    if states.empty?
+      @io.say 'missing required subsequent status'
+      return
+    end
+    @entry[name] ||= []
+    states = states.uniq
+    @entry[name] += states
+    states.each {|state| @entry[state] ||= [] }
+  end
+end

data/lib/cardigan/command/batch_update_cards.rb

@@ -1,20 +1,21 @@
+require 'cardigan/commands'
 require 'cardigan/card_editor'
 
-module Cardigan
-  module Command
-    class BatchUpdateCards
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+class Cardigan::Command::BatchUpdateCards
+  attr_reader :usage, :help
 
-      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|
-          Cardigan::CardEditor.new(card, @io).set key, value
-          @repository.save card
-        end
-      end
+  def initialize repository, io
+    @repository, @io = repository, io
+    @usage = '<field> <number>*'
+    @help = 'Sets the specified field to a new value for the specified cards (by index in the list)'
+  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|
+      Cardigan::CardEditor.new(card, @io).set key, value
+      @repository[card.id] = card
     end
   end
 end

data/lib/cardigan/command/change_status.rb

@@ -1,13 +1,20 @@
-module Cardigan
-  module Command
-    class ChangeStatus
-      def initialize entry
-        @entry = entry
-      end
-
-      def execute status
-        @entry['status'] = status
-      end
-    end
+require 'cardigan/commands'
+
+class Cardigan::Command::ChangeStatus
+  attr_reader :usage, :help
+
+  def initialize entry, workflow_repository
+    @entry, @workflow_repository = entry, workflow_repository
+    @usage = '<new status>'
+    @help = 'Changes the status of the current entry'
+  end
+
+  def completion text
+    status = @entry['status'] || 'none'
+    @workflow_repository.load[status].grep(/^#{text}/).sort || []
+  end
+
+  def execute status
+    @entry['status'] = status
   end
 end

data/lib/cardigan/command/change_value.rb

@@ -1,15 +1,16 @@
+require 'cardigan/commands'
 require 'cardigan/card_editor'
 
-module Cardigan
-  module Command
-    class ChangeValue
-      def initialize entry, io
-        @entry, @io = entry, io
-      end
+class Cardigan::Command::ChangeValue
+  attr_reader :usage, :help
 
-      def execute key
-        Cardigan::CardEditor.new(@entry, @io).set key, @io.ask("Enter the new value for #{key}")
-      end
-    end
+  def initialize entry, io
+    @entry, @io = entry, io
+    @usage = '<key>'
+    @help = 'Prompt for a new value to associate with the specified key'
+  end
+
+  def execute key
+    Cardigan::CardEditor.new(@entry, @io).set key, @io.ask("Enter the new value for #{key}")
   end
 end

data/lib/cardigan/command/claim_cards.rb

@@ -1,17 +1,19 @@
-module Cardigan
-  module Command
-    class ClaimCards
-      def initialize repository, io, name
-        @repository, @io, @name = repository, io, name
-      end
+require 'cardigan/commands'
 
-      def execute numbers
-        @repository.each_card_from_indices(numbers) do |card|
-          @io.say "claiming \"#{card['name']}\""
-          card['owner'] = @name
-          @repository.save card
-        end
-      end
+class Cardigan::Command::ClaimCards
+  attr_reader :usage, :help
+
+  def initialize repository, io, name
+    @repository, @io, @name = repository, io, name
+    @usage = '<number>*'
+    @help = 'Sets you as the owner of the specified cards (by index in the list)'
+  end
+
+  def execute numbers
+    @repository.each_card_from_indices(numbers || '') do |card|
+      @io.say "claiming \"#{card['name']}\""
+      card['owner'] = @name
+      @repository[card.id] = card
     end
   end
 end

data/lib/cardigan/command/commit_changes.rb

@@ -0,0 +1,15 @@
+require 'cardigan/commands'
+
+class Cardigan::Command::CommitChanges
+  attr_reader :usage, :help
+
+  def initialize repository, io
+    @io, @repository = io, repository
+    @usage = "<commit message>"
+    @help = "Commits _all_ changes (adds, removes and modifications) to the source control system\nWarning: Use with caution. This will not only commit changes to cards - all modifications will be committed."
+  end
+
+  def execute text=nil
+    @repository.addremovecommit text
+  end
+end

data/lib/cardigan/command/count_cards.rb

@@ -1,9 +1,13 @@
-require 'cardigan/context'
+require 'cardigan/commands'
 require 'cardigan/text_report_formatter'
 
 class Cardigan::Command::CountCards
+  attr_reader :usage, :help
+
   def initialize repository, io
     @repository, @io = repository, io
+    @usage = "<grouping field>*"
+    @help = "Counts cards aggregated across the specified grouping fields"
   end
 
   def execute text=nil
@@ -12,7 +16,7 @@ class Cardigan::Command::CountCards
     lengths = Array.new(grouping_fields.size, 0)
     counts = {}
     total = 0
-    @repository.each do |card|
+    @repository.cards.each do |card|
       grouping_fields.each_with_index do |grouping_field,index|
         lengths[index] = card[grouping_field].size if card[grouping_field] and card[grouping_field].size > lengths[index]
       end

data/lib/cardigan/command/create_card.rb

@@ -1,13 +1,16 @@
-module Cardigan
-  module Command
-    class CreateCard
-      def initialize repository
-        @repository = repository
-      end
+require 'cardigan/commands'
+require 'uuidtools'
 
-      def execute name
-        @repository.save @repository.find_or_create(name)
-      end
-    end
+class Cardigan::Command::CreateCard
+  attr_reader :usage, :help
+
+  def initialize repository
+    @repository = repository
+    @usage = '<name>'
+    @help = 'Creates a new card with the specified name (without opening it for editing)'
+  end
+
+  def execute name
+    @repository[UUIDTools::UUID.random_create.to_s] = {'name' => name }
   end
-end
+end 

data/lib/cardigan/command/destroy_cards.rb

@@ -1,16 +1,18 @@
-module Cardigan
-  module Command
-    class DestroyCards
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+require 'cardigan/commands'
 
-      def execute numbers
-        @repository.each_card_from_indices(numbers) do |card|
-          @io.say "destroying \"#{card['name']}\""
-          @repository.destroy card
-        end
-      end
+class Cardigan::Command::DestroyCards
+  attr_reader :usage, :help
+
+  def initialize repository, io
+    @repository, @io = repository, io
+    @usage = '<number>*'
+    @help = 'Destroys the specified cards (by index in the list)'
+  end
+
+  def execute numbers
+    @repository.each_card_from_indices(numbers) do |card|
+      @io.say "destroying \"#{card['name']}\""
+      @repository.destroy card.id
     end
   end
-end
+end

data/lib/cardigan/command/edit_value.rb

@@ -1,17 +1,18 @@
+require 'cardigan/commands'
 require 'splat'
 require 'cardigan/card_editor'
 
-module Cardigan
-  module Command
-    class EditValue
-      def initialize entry, io
-        @entry, @io = entry, io
-      end
+class Cardigan::Command::EditValue
+  attr_reader :usage, :help
 
-      def execute key
-        value = @entry[key] ? @entry[key] : ''
-        Cardigan::CardEditor.new(@entry, @io).set key, value.to_editor
-      end
-    end
+  def initialize entry, io
+    @entry, @io = entry, io
+    @usage = '<key>'
+    @help = 'Launch default editor to specify a new value to associate with the specified key'
+  end
+
+  def execute key
+    value = @entry[key] ? @entry[key] : ''
+    Cardigan::CardEditor.new(@entry, @io).set key, value.to_editor
   end
 end

data/lib/cardigan/command/export_cards.rb

@@ -1,17 +1,22 @@
+require 'cardigan/commands'
 require 'csv'
 
 class Cardigan::Command::ExportCards
+  attr_reader :usage, :help
+
   def initialize repository
     @repository = repository
+    @usage = '<filename>'
+    @help = 'Exports all cards according to the current filter'
   end
 
   def execute filename
     filename += ".csv"
-    columns = @repository.columns
+    columns = @repository.columns - ['id']
     CSV.open(filename, 'w') do |writer|
-      writer << columns
-      @repository.each do |card|
-        writer << columns.map {|column| card[column] ? card[column] : ''}
+      writer << (['id'] + columns)
+      @repository.cards.each do |card|
+        writer << ([card.id] + columns.map {|column| card[column] ? card[column] : ''})
       end
     end
   end

data/lib/cardigan/command/filter_cards.rb

@@ -1,6 +1,12 @@
 require 'cardigan/command/list_cards'
 
 class Cardigan::Command::FilterCards < Cardigan::Command::ListCards
+  def initialize repository, io
+    super
+    @usage = '<ruby expression>'
+    @help = "Sets the filter on cards to be displayed\nThis filter is a ruby expression that must return a boolean.\nBound variables are card (a hash) and me (a string)"
+  end
+
   def execute filter
     @repository.filter = filter
     begin

data/lib/cardigan/command/import_cards.rb

@@ -1,8 +1,14 @@
+require 'cardigan/commands'
 require 'csv'
+require 'uuidtools'
 
 class Cardigan::Command::ImportCards
+  attr_reader :usage, :help
+
   def initialize repository, io
     @repository, @io = repository, io
+    @usage = '<filename>'
+    @help = "Imports cards from the specific csv file.\nNote that if the file does not contain an id column, all new cards will be created.\nOtherwise, existing cards with a matching id will be updated."
   end
 
   def execute filename
@@ -14,14 +20,22 @@ class Cardigan::Command::ImportCards
     header, id_index = nil, nil
     CSV.open(filename, 'r') do |row|
       if header
-        card = @repository.load(row[id_index]) if id_index and row[id_index]
-        @io.say card ? "updating #{card['id']}" : "creating new card"
-        card = @repository.create unless card
+        if id_index and row[id_index]
+          id = row[id_index]
+          card = @repository[id] if @repository.exist?(id)
+        end
+        if card
+          puts "updating #{id}"
+        else
+          id = UUIDTools::UUID.random_create.to_s
+          card = {}
+          puts "creating card #{id}"
+        end
         editor = Cardigan::CardEditor.new(card, @io)
         header.each_with_index do |field, index|
           editor.set field, row[index]
         end
-        @repository.save card
+        @repository[id] = card
       else
         header = row
         id_index = header.find_index('id')

data/lib/cardigan/command/list_cards.rb

@@ -1,8 +1,13 @@
+require 'cardigan/commands'
 require 'cardigan/text_report_formatter'
 
 class Cardigan::Command::ListCards
+  attr_reader :usage, :help
+
   def initialize repository, io
     @repository, @io = repository, io
+    @usage = ''
+    @help = 'Lists all cards that match the current filter'
   end
 
   def execute text

data/lib/cardigan/command/open_card.rb

@@ -1,17 +1,25 @@
 require 'cardigan/entry_context'
+require 'uuidtools'
 
-module Cardigan
-  module Command
-    class OpenCard
-      def initialize repository, workflow_repository, io
-        @repository, @workflow_repository, @io = repository, workflow_repository, io
-      end
+class Cardigan::Command::OpenCard
+  attr_reader :usage, :help
 
-      def execute name
-        card = @repository.find_or_create(name)
-        EntryContext.new(@io, @workflow_repository, card).push
-        @repository.save card
-      end
-    end
+  def initialize repository, workflow_repository, io
+    @repository, @workflow_repository, @io = repository, workflow_repository, io
+    @usage = '<card name>'
+    @help = 'Opens the specified card for editing'
+  end
+
+  def execute name
+    entry = @repository.cards.find { |entry| entry['name'] == name }
+    id = entry ? entry.id : UUIDTools::UUID.random_create.to_s
+    entry ||= {'name' => name}
+    original = entry.dup
+    Cardigan::EntryContext.new(@io, @workflow_repository, entry).push
+    @repository[id] = entry unless original == entry
+  end
+
+  def completion text
+    @repository.cards.map {|card| card['name'] }.grep(/^#{Regexp.escape(text)}/).sort
   end
 end

data/lib/cardigan/command/open_workflow.rb

@@ -1,17 +1,19 @@
+require 'cardigan/commands'
 require 'cardigan/workflow_context'
 
-module Cardigan
-  module Command
-    class OpenWorkflow
-      def initialize workflow_repository, io
-        @workflow_repository, @io = workflow_repository, io
-      end
+class Cardigan::Command::OpenWorkflow
+  attr_reader :usage, :help
 
-      def execute name
-        workflow = @workflow_repository.load
-        WorkflowContext.new(@io, workflow).push
-        @workflow_repository.save workflow
-      end
-    end
+  def initialize workflow_repository, io
+    @workflow_repository, @io = workflow_repository, io
+    @usage = ''
+    @help = 'Opens the current workflow for editing'
+  end
+
+  def execute name
+    workflow = @workflow_repository.load
+    original = workflow.dup
+    Cardigan::WorkflowContext.new(@io, workflow).push
+    @workflow_repository.save workflow unless workflow == original
   end
 end

data/lib/cardigan/command/remove_transitions.rb

@@ -0,0 +1,25 @@
+require 'cardigan/commands'
+
+class Cardigan::Command::RemoveTransitions
+  attr_reader :usage, :help
+
+  def initialize entry, io
+    @entry, @io = entry, io
+    @usage = '<start status> [<subsequent status>]+'
+    @help = 'Removes transitions from a starting status to a number of subsequent statuses'
+  end
+
+  def execute text=nil
+    unless text and !text.empty?
+      @io.say 'missing required start status'
+      return
+    end
+    name, *states = text.scan(/\w+/)
+    if states.empty?
+      @io.say 'missing required subsequent status'
+      return
+    end
+    name, *states = text.scan(/\w+/)
+    @entry[name] -= states
+  end
+end

data/lib/cardigan/command/show_entry.rb

@@ -1,13 +1,15 @@
-module Cardigan
-  module Command
-    class ShowEntry
-      def initialize entry, io
-        @entry, @io = entry, io
-      end
+require 'cardigan/commands'
 
-      def execute ignored=nil
-        @entry.keys.sort.each { |key| @io.say "#{key}: #{@entry[key].inspect}" }
-      end
-    end
+class Cardigan::Command::ShowEntry
+  attr_reader :usage, :help
+
+  def initialize entry, io
+    @entry, @io = entry, io
+    @usage = ''
+    @help = 'Shows the entire content of the entry'
+  end
+
+  def execute ignored=nil
+    @entry.keys.sort.each { |key| @io.say "#{key}: #{@entry[key].inspect}" }
   end
 end

data/lib/cardigan/command/specify_display_columns.rb

@@ -1,6 +1,12 @@
 require 'cardigan/command/list_cards'
 
 class Cardigan::Command::SpecifyDisplayColumns < Cardigan::Command::ListCards
+  def initialize repository, io
+    super
+    @usage = '<column>*'
+    @help = 'Specify the list of columns to display'
+  end
+
   def execute text
     if text
       @repository.display_columns = text.scan(/\w+/)

data/lib/cardigan/command/specify_sort_columns.rb

@@ -1,6 +1,12 @@
 require 'cardigan/command/list_cards'
 
 class Cardigan::Command::SpecifySortColumns < Cardigan::Command::ListCards
+  def initialize repository, io
+    super
+    @usage = '<column>*'
+    @help = 'Specify the list of columns to sort by'
+  end
+
   def execute text
     if text
       @repository.sort_columns = text.scan(/\w+/)

data/lib/cardigan/command/total_cards.rb

@@ -1,9 +1,13 @@
-require 'cardigan/context'
+require 'cardigan/commands'
 require 'cardigan/text_report_formatter'
 
 class Cardigan::Command::TotalCards
+  attr_reader :usage, :help
+
   def initialize repository, io
     @repository, @io = repository, io
+    @usage = '<numeric field> <grouping field>*'
+    @help = 'Calculates totals for the specified numeric field aggregated across the specified grouping fields'
   end
 
   def execute text=nil    
@@ -13,7 +17,7 @@ class Cardigan::Command::TotalCards
       return
     end
     counts = {}
-    @repository.each do |card|
+    @repository.cards.each do |card|
       key = grouping_fields.map {|grouping_field| card[grouping_field] ? card[grouping_field] : ''}
       value = card[count_field].to_i
       counts[key] = counts[key] ? counts[key] + value : value