cardigan 0.0.9 → 0.1.0

data/lib/cardigan/command/unclaim_cards.rb

@@ -1,17 +1,17 @@
-module Cardigan
-  module Command
-    class UnclaimCards
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+class Cardigan::Command::UnclaimCards
+  attr_reader :usage, :help
 
-      def execute numbers
-        @repository.each_card_from_indices(numbers) do |card|
-          @io.say "unclaiming \"#{card['name']}\""
-          card.delete('owner')
-          @repository.save card
-        end
-      end
+  def initialize repository, io
+    @repository, @io = repository, io
+    @usage = '<number> [<number]*'
+    @help = 'Removes the owner of the specified cards'
+  end
+
+  def execute numbers
+    @repository.each_card_from_indices(numbers || '') do |card|
+      @io.say "unclaiming \"#{card['name']}\""
+      card.delete('owner')
+      @repository[card.id] = card
     end
   end
 end

data/lib/cardigan/command/unfilter_cards.rb

@@ -1,6 +1,12 @@
 require 'cardigan/command/list_cards'
 
 class Cardigan::Command::UnfilterCards < Cardigan::Command::ListCards
+  def initialize repository, io
+    super
+    @usage = ''
+    @help = 'Removes the current filter (or does nothing if no filter has been specified)'
+  end
+
   def execute filter
     @repository.filter = nil
     super

data/lib/cardigan/commands.rb

@@ -0,0 +1,10 @@
+require 'active_support/inflector'
+
+module Cardigan
+  module Command
+    def self.load name, *args
+      require "cardigan/command/#{name}"
+      Command.const_get(name.to_s.camelize).new(*args)
+    end
+  end
+end

data/lib/cardigan/entry_context.rb

@@ -1,24 +1,19 @@
-require 'cardigan/context'
+require 'shell_shock/context'
+require 'cardigan/commands'
 
 module Cardigan
   class EntryContext
-    include Context
+    include ShellShock::Context
 
     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 = {
-        'now' => command(:change_status, @entry),
-        'set' => command(:change_value, @entry, @io),
-        'edit' => command(:edit_value, @entry, @io),
-        'list' => command(:show_entry, @entry, @io)
+        'now'  => Command.load(:change_status, @entry, @workflow_repository),
+        'set'  => Command.load(:change_value, @entry, @io),
+        'edit' => Command.load(:edit_value, @entry, @io),
+        'ls' => Command.load(:show_entry, @entry, @io)
       }
     end
-
-    def refresh_commands
-      status = @entry['status'] || 'none'
-      next_statuses = @workflow_repository.load[status]
-      next_statuses ? next_statuses.map { |s| "now #{s}" } : []
-    end
   end
 end

data/lib/cardigan/filtered_repository.rb

@@ -1,12 +1,14 @@
 require 'forwardable'
+require 'set'
 
 module Cardigan
   class FilteredRepository
+    include Enumerable
+
     attr_accessor :filter, :sort_columns, :display_columns
 
     extend Forwardable
-
-    def_delegators :@repository, :refresh, :save, :destroy, :find_or_create, :columns, :load, :create
+    def_delegators :@repository, :[], :[]=, :exist?, :destroy, :addremovecommit
 
     def initialize repository, user, *columns
       @repository, @sort_columns, @display_columns, @user = repository, columns, columns, user
@@ -14,7 +16,7 @@ module Cardigan
 
     def cards
       me = @user
-      cards = @filter ? @repository.cards.select {|card| eval @filter } : @repository.cards
+      cards = @filter ? @repository.select {|card| eval @filter } : @repository.to_a
       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] : '' }
@@ -22,8 +24,10 @@ module Cardigan
       end
     end
 
-    def each
-      cards.each {|card| yield card }
+    def columns
+      columns = Set.new
+      @repository.each {|card| columns += card.keys }
+      columns.to_a
     end
 
     def max_field_length name

data/lib/cardigan/io.rb

@@ -9,7 +9,7 @@ module Cardigan
       @in_io.gets.chomp
     end
     
-    def say message
+    def say message=''
       @out_io.puts message
     end
   end

data/lib/cardigan/root_context.rb

@@ -1,36 +1,34 @@
-require 'cardigan/context'
+require 'rubygems'
+require 'shell_shock/context'
+require 'cardigan/commands'
 require 'cardigan/filtered_repository'
 
 module Cardigan
   class RootContext
-    include Context
+    include ShellShock::Context
 
     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} > "
       @commands = {
-        'claim' => command(:claim_cards, @repository, @io, @name),
-        'create' => command(:create_card, @repository),
-        'destroy' => command(:destroy_cards, @repository, @io),
-        'display' => command(:specify_display_columns, @repository, @io),
-        'filter' => command(:filter_cards, @repository, @io),
-        'list' => command(:list_cards, @repository, @io),
-        'open' => command(:open_card, @repository, @workflow_repository, @io),
-        'set' => command(:batch_update_cards, @repository, @io),
-        'sort' => command(:specify_sort_columns, @repository, @io),
-        'unclaim' => command(:unclaim_cards, @repository, @io),
-        'unfilter' => command(:unfilter_cards, @repository, @io),
-        'workflow' => command(:open_workflow, @workflow_repository, @io),
-        'count' => command(:count_cards, @repository, @io),
-        'total' => command(:total_cards, @repository, @io),
-        'export' => command(:export_cards, @repository),
-        'import' => command(:import_cards, @repository, @io)
+        'claim'    => Command.load(:claim_cards, @repository, @io, @name),
+        'touch'    => Command.load(:create_card, @repository),
+        'rm'       => Command.load(:destroy_cards, @repository, @io),
+        'columns'  => Command.load(:specify_display_columns, @repository, @io),
+        'filter'   => Command.load(:filter_cards, @repository, @io),
+        'ls'       => Command.load(:list_cards, @repository, @io),
+        'cd'       => Command.load(:open_card, @repository, @workflow_repository, @io),
+        'set'      => Command.load(:batch_update_cards, @repository, @io),
+        'sort'     => Command.load(:specify_sort_columns, @repository, @io),
+        'unclaim'  => Command.load(:unclaim_cards, @repository, @io),
+        'unfilter' => Command.load(:unfilter_cards, @repository, @io),
+        'workflow' => Command.load(:open_workflow, @workflow_repository, @io),
+        'count'    => Command.load(:count_cards, @repository, @io),
+        'total'    => Command.load(:total_cards, @repository, @io),
+        'export'   => Command.load(:export_cards, @repository),
+        'import'   => Command.load(:import_cards, @repository, @io),
+        'commit'   => Command.load(:commit_changes, @repository, @io)
       }
     end
-
-    def refresh_commands
-      @repository.refresh
-      @repository.cards.map {|card| "open #{card['name']}" }
-    end
   end
 end

data/lib/cardigan/workflow_context.rb

@@ -1,33 +1,16 @@
-require 'cardigan/context'
+require 'shell_shock/context'
+require 'cardigan/commands'
 
-module Cardigan
-  class WorkflowContext
-    include Context
+class Cardigan::WorkflowContext
+  include ShellShock::Context
 
-    def initialize io, entry
-      @io, @entry = io, entry
-      @prompt_text = "#{File.expand_path('.').split('/').last.slice(0..0)}/workflow > "
-      @commands = {
-        'list' => command(:show_entry, @entry, @io)
-      }
-    end
-
-    def refresh_commands
-      ['create', 'add', 'remove']
-    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 initialize io, entry
+    @io, @entry = io, entry
+    @prompt_text = "#{File.expand_path('.').split('/').last.slice(0..0)}/workflow > "
+    @commands = {
+      'ls'     => Cardigan::Command.load(:show_entry, @entry, @io),
+      'add'    => Cardigan::Command.load(:add_transitions, @entry, @io),
+      'rm'     => Cardigan::Command.load(:remove_transitions, @entry, @io),
+    }
   end
 end

data/lib/cardigan/workflow_repository.rb

@@ -1,16 +1,24 @@
-module Cardigan
-  class WorkflowRepository
-    def initialize path
-      @directory = Directory.new(path)
-      @path = '.card_workflow'
-    end
+require 'flat_hash/serialiser'
+require 'flat_hash/repository'
+
+class Cardigan::WorkflowRepository
+  def initialize path
+    @directory = FlatHash::Directory.new(FlatHash::Serialiser.new,'.')
+    @key = '.card_workflow'
+  end
 
-    def save workflow
-      @directory.store @path, workflow
+  def save workflow
+    workflow.keys.each do |key|
+      workflow[key] = workflow[key].join("\n")
     end
+    @directory[@key] = workflow
+  end
 
-    def load
-      @directory.has_file?(@path) ? @directory.load(@path) : {}
+  def load
+    workflow = @directory[@key]
+    workflow.keys.each do |key|
+      workflow[key] = workflow[key].split("\n") unless workflow[key].instance_of?(Array)
     end
+    workflow
   end
 end

data/spec/command/add_transitions_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/add_transitions'
+
+describe Cardigan::Command::AddTransitions do
+  with_usage '<start status> [<subsequent status>]+'
+  with_help 'Creates transitions from a starting status to a number of subsequent statuses'
+
+  before do
+    @entry = {}
+    @io = MockPrompt.new
+    @command = Cardigan::Command::AddTransitions.new @entry, @io
+  end
+
+  [nil, ''].each do |parameter|
+    it "should report error when called with #{parameter.inspect}" do
+      @command.execute
+      @io.should have_received "missing required start status"
+    end
+  end
+
+  it 'should report error when called with a single parameter' do
+    @command.execute 'none'
+    @io.should have_received "missing required subsequent status"
+  end
+
+  it 'should append status when called with single' do
+    @command.execute 'none started'
+    @entry['none'].should == ['started']
+  end
+
+  it 'should ignore duplicate subsequent statuses' do
+    @command.execute 'none started started'
+    @entry['none'].should == ['started']
+  end
+end

data/spec/command/batch_update_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/batch_update_cards'
+
+describe Cardigan::Command::BatchUpdateCards do
+  with_usage '<field> <number>*'
+  with_help 'Sets the specified field to a new value for the specified cards (by index in the list)'
+
+  before { @command = Cardigan::Command::BatchUpdateCards.new(nil,nil) }
+end

data/spec/command/change_status_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/change_status'
+
+describe Cardigan::Command::ChangeStatus do
+  with_usage '<new status>'
+  with_help 'Changes the status of the current entry'
+
+  before { @command = Cardigan::Command::ChangeStatus.new(nil,nil) }
+end

data/spec/command/change_value_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/change_value'
+
+describe Cardigan::Command::ChangeValue do
+  with_usage '<key>'
+  with_help 'Prompt for a new value to associate with the specified key'
+
+  before { @command = Cardigan::Command::ChangeValue.new(nil,nil) }
+end

data/spec/command/claim_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/claim_cards'
+
+describe Cardigan::Command::ClaimCards do
+  with_usage '<number>*'
+  with_help 'Sets you as the owner of the specified cards (by index in the list)'
+
+  before { @command = Cardigan::Command::ClaimCards.new(nil,nil,nil) }
+end

data/spec/command/commit_changes_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/commit_changes'
+
+describe Cardigan::Command::CommitChanges do
+  with_usage '<commit message>'
+  with_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."
+
+  before { @command = Cardigan::Command::CommitChanges.new(nil,nil) }
+end

data/spec/command/count_cards_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/count_cards'
+
+describe Cardigan::Command::CountCards do
+  with_usage '<grouping field>*'
+  with_help 'Counts cards aggregated across the specified grouping fields'
+
+  before do
+    @repository, @prompt = stub(:repository), MockPrompt.new
+    @command = Cardigan::Command::CountCards.new @repository, @prompt
+  end
+
+  [nil, ''].each do |parameter|
+    it "should count single row when called with #{parameter}" do
+      @repository.stub!(:cards).and_return []
+      @command.execute parameter
+
+      @prompt.messages.should == [
+' -------',
+'| count |',
+' -------',
+'| 0     |',
+' -------'
+]
+    end
+  end
+
+  it 'should count single row when no grouping fields are provided' do
+    @repository.stub!(:cards).and_return [{'points' => 1}]
+    @command.execute
+
+    @prompt.messages.should == [
+' -------',
+'| count |',
+' -------',
+'| 1     |',
+' -------'
+]
+  end
+
+  it 'should count single row when a single grouping fields are provided' do
+    @repository.stub!(:cards).and_return [{'type' => 'bug'}]
+    @command.execute 'type'
+
+    @prompt.messages.should == [
+' --------------',
+'| type | count |',
+' --------------',
+'| bug  | 1     |',
+' --------------'
+]
+  end
+
+  it 'should count single row when a single grouping fields are provided' do
+    @repository.stub!(:cards).and_return [{'type' => 'bug'},{'type' => 'feature'}]
+    @command.execute 'type'
+
+    @prompt.messages.should == [
+' -----------------',
+'| type    | count |',
+' -----------------',
+'| bug     | 1     |',
+'| feature | 1     |',
+'|         | 2     |',
+' -----------------'
+]
+  end
+end

data/spec/command/create_card_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/create_card'
+
+describe Cardigan::Command::CreateCard do
+  with_usage '<name>'
+  with_help 'Creates a new card with the specified name (without opening it for editing)'
+
+  before { @command = Cardigan::Command::CreateCard.new(nil) }
+end

data/spec/command/destroy_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/destroy_cards'
+
+describe Cardigan::Command::DestroyCards do
+  with_usage '<number>*'
+  with_help 'Destroys the specified cards (by index in the list)'
+
+  before { @command = Cardigan::Command::DestroyCards.new(nil,nil) }
+end

data/spec/command/edit_value_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/edit_value'
+
+describe Cardigan::Command::EditValue do
+  with_usage '<key>'
+  with_help 'Launch default editor to specify a new value to associate with the specified key'
+
+  before { @command = Cardigan::Command::EditValue.new(nil,nil) }
+end

data/spec/command/export_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/export_cards'
+
+describe Cardigan::Command::ExportCards do
+  with_usage '<filename>'
+  with_help 'Exports all cards according to the current filter'
+
+  before { @command = Cardigan::Command::ExportCards.new(nil) }
+end

data/spec/command/filter_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/filter_cards'
+
+describe Cardigan::Command::FilterCards do
+  with_usage '<ruby expression>'
+  with_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)"
+
+  before { @command = Cardigan::Command::FilterCards.new(nil,nil) }
+end

data/spec/command/import_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/import_cards'
+
+describe Cardigan::Command::ImportCards do
+  with_usage '<filename>'
+  with_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."
+
+  before { @command = Cardigan::Command::ImportCards.new(nil,nil) }
+end

data/spec/command/list_cards_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/list_cards'
+
+describe Cardigan::Command::ListCards do
+  with_usage ''
+  with_help 'Lists all cards that match the current filter'
+
+  before { @command = Cardigan::Command::ListCards.new(nil,nil) }
+end

data/spec/command/open_card_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/open_card'
+
+describe Cardigan::Command::OpenCard do
+  with_usage '<card name>'
+  with_help 'Opens the specified card for editing'
+
+  before { @command = Cardigan::Command::OpenCard.new(nil,nil,nil) }
+end

data/spec/command/open_workflow_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/open_workflow'
+
+describe Cardigan::Command::OpenWorkflow do
+  with_usage ''
+  with_help 'Opens the current workflow for editing'
+
+  before { @command = Cardigan::Command::OpenWorkflow.new(nil,nil) }
+end

data/spec/command/remove_transitions_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/remove_transitions'
+
+describe Cardigan::Command::RemoveTransitions do
+  with_usage '<start status> [<subsequent status>]+'
+  with_help 'Removes transitions from a starting status to a number of subsequent statuses'
+
+  before do
+    @entry = {}
+    @io = MockPrompt.new
+    @command = Cardigan::Command::RemoveTransitions.new @entry, @io
+  end
+
+  [nil, ''].each do |parameter|
+    it "should report error when called with #{parameter.inspect}" do
+      @command.execute
+      @io.should have_received "missing required start status"
+    end
+  end
+
+  it 'should report error when called with a single parameter' do
+    @command.execute 'none'
+    @io.should have_received "missing required subsequent status"
+  end
+end

data/spec/command/show_entry_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/show_entry'
+
+describe Cardigan::Command::ShowEntry do
+  with_usage ''
+  with_help 'Shows the entire content of the entry'
+
+  before { @command = Cardigan::Command::ShowEntry.new(nil, nil) }
+end

data/spec/command/specify_display_columns_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/specify_display_columns'
+
+describe Cardigan::Command::SpecifyDisplayColumns do
+  with_usage '<column>*'
+  with_help 'Specify the list of columns to display'
+
+  before { @command = Cardigan::Command::SpecifyDisplayColumns.new(nil,nil) }
+end

data/spec/command/specify_sort_columns_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__)+'/../spec_helper'
+require 'cardigan/command/specify_sort_columns'
+
+describe Cardigan::Command::SpecifySortColumns do
+  with_usage '<column>*'
+  with_help 'Specify the list of columns to sort by'
+
+  before { @command = Cardigan::Command::SpecifySortColumns.new(nil,nil) }
+end