cardigan 0.1.0 → 0.1.1

data/features/commands/set.feature

@@ -0,0 +1,31 @@
+Feature: set
+
+  In order to manage my ideas
+  As a command line junkie
+  I want to be able to bulk edit attributes of cards
+
+  Scenario: editing an attribute on multiple cards
+    When I run `cardigan` interactively
+    And I create the following cards:
+     | name   |
+     | card 1 |
+     | card 2 |
+     | card 3 |
+     | card 4 |
+    And I type "set estimate 1 4 "
+    And I type "10"
+    And I type "columns name estimate"
+    And I type "ls"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     ---------------------------
+    | index | name   | estimate |
+     ---------------------------
+    | 1     | card 1 | 10       |
+    | 2     | card 2 |          |
+    | 3     | card 3 |          |
+    | 4     | card 4 | 10       |
+     ---------------------------
+    """

data/features/commands/total.feature

@@ -0,0 +1,70 @@
+Feature: total
+
+  In order to see relevant information
+  As a command line junkie
+  I want to calculate the total of a numeric attribute of cards
+
+  Scenario: incorrect usage of total command
+    When I run `cardigan` interactively
+    And I type "total"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain "missing required numeric total field"
+
+  Scenario: calculate total without any grouping
+    When I run `cardigan` interactively
+    And I create the following cards:
+     | name   | estimate |
+     | card 1 | 3        |
+     | card 2 | 2        |
+    And I type "total estimate"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     ----------
+    | estimate |
+     ----------
+    | 5        |
+     ----------
+    """
+
+  Scenario: calculate total with some missing values
+    When I run `cardigan` interactively
+    And I create the following cards:
+     | name   | estimate |
+     | card 1 | 3        |
+     | card 2 | 2        |
+     | card 3 |          |
+    And I type "total estimate"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     ----------
+    | estimate |
+     ----------
+    | 5        |
+     ----------
+    """
+
+  Scenario: calculate total without grouping by a field
+    When I run `cardigan` interactively
+    And I create the following cards:
+     | name   | estimate | release |
+     | card 1 | 3        | ocelot  |
+     | card 2 | 2        | margay  |
+     | card 3 | 5        | margay  |
+    And I type "total estimate release"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     --------------------
+    | release | estimate |
+     --------------------
+    | margay  | 7        |
+    | ocelot  | 3        |
+    |         | 10       |
+     --------------------
+    """

data/features/commands/touch.feature

@@ -0,0 +1,33 @@
+Feature: touch
+
+  In order to manage my ideas
+  As a command line junkie
+  I want to create store these ideas on virtual cards
+
+  Scenario: a single card is added in shell
+    When I run `cardigan` interactively
+    And I type "touch today is the first day of the rest of your life"
+    And I type "ls"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     ---------------------------------------------------------
+    | index | name                                            |
+     ---------------------------------------------------------
+    | 1     | today is the first day of the rest of your life |
+     ---------------------------------------------------------
+    """
+
+  Scenario: a single card is added without shell
+    When I run `cardigan touch do some amazing stuff with my life`
+    And I run `cardigan ls`
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     --------------------------------------------
+    | index | name                               |
+     --------------------------------------------
+    | 1     | do some amazing stuff with my life |
+     --------------------------------------------
+    """

data/features/commands/unclaim.feature

@@ -0,0 +1,20 @@
+Feature: unclaim
+
+  In order to indicate to others I am no longer allocated to a card
+  As a command line junkie
+  I want to unclaim cards
+
+  Scenario: claim cards
+    When I run `cardigan touch a very interesting card`
+    And I run `cardigan unclaim 1`
+    And I run `cardigan columns name owner`
+    And I run `cardigan ls`
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     -----------------------------------------
+    | index | name                    | owner |
+     -----------------------------------------
+    | 1     | a very interesting card |       |
+     -----------------------------------------
+    """

data/features/commands/unfilter.feature

@@ -0,0 +1,26 @@
+Feature: unfilter
+
+  In order to see relevant information
+  As a command line junkie
+  I want to filter the cards that are displayed
+
+  Scenario: remove filter from cards
+    When I run `cardigan` interactively
+    And I create the following cards:
+     | name                         | release |
+     | another interesting card     | margay  |
+     | a seriously interesting card | ocelot  |
+    And I type "filter card['release'] == 'ocelot'"
+    And I type "unfilter"
+    And I type "ls"
+    And I type "exit"
+    Then the exit status should be 0
+    And the stdout should contain:
+    """
+     --------------------------------------
+    | index | name                         |
+     --------------------------------------
+    | 1     | a seriously interesting card |
+    | 2     | another interesting card     |
+     --------------------------------------
+    """

data/features/step_definitions/cardigan_steps.rb

@@ -0,0 +1,10 @@
+When /^I create the following cards:$/ do |table|
+  table.hashes.each do |hash|
+    type "cd #{hash['name']}"
+    hash.keys.each do |key|
+      type "set #{key}"
+      type hash[key]
+    end
+    type "exit"
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,32 @@
+require 'aruba/cucumber'
+require 'fileutils'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+HOME = File.expand_path '~'
+CARDIGAN_CONFIG = HOME+'/.cardigan'
+CARDIGAN_CONFIG_BKP = CARDIGAN_CONFIG+'.bkp'
+CARDIGAN_NAME = 'Ms Crazy Person'
+CARDIGAN_EMAIL = 'you@there.com'
+
+Before do
+  if File.exist? CARDIGAN_CONFIG
+    FileUtils.mv CARDIGAN_CONFIG, CARDIGAN_CONFIG_BKP 
+    File.open CARDIGAN_CONFIG, 'w' do |file|
+      file.puts <<EOF
+email
+#{CARDIGAN_EMAIL}
+<----->
+name
+#{CARDIGAN_NAME}
+EOF
+    end
+  end
+end
+
+After do
+  if File.exist? CARDIGAN_CONFIG_BKP
+    FileUtils.rm CARDIGAN_CONFIG
+    FileUtils.mv CARDIGAN_CONFIG_BKP, CARDIGAN_CONFIG
+  end
+end

data/lib/cardigan/cli.rb

@@ -4,23 +4,31 @@ require 'flat_hash/directory'
 require 'flat_hash/serialiser'
 require 'flat_hash/repository'
 require 'cardigan/workflow_repository'
+require 'cardigan/configuration'
+require 'cardigan/filtered_repository'
 
 class Cardigan::Cli
-  CONFIG_FILE = '.cardigan'
-
   def initialize io=Cardigan::Io.new
     @io = io
-    @home = FlatHash::Directory.new(FlatHash::Serialiser.new,File.expand_path('~'))
+    home_path = File.expand_path '~'
+    home = FlatHash::Directory.new FlatHash::Serialiser.new, home_path
+    @local = FlatHash::Directory.new FlatHash::Serialiser.new, '.'
+    @configuration = Cardigan::Configuration.new home, '.cardigan'
   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
+    @configuration['name'] = @io.ask('Enter your full name') unless @configuration['name']
+    @configuration['email'] = @io.ask('Enter your email address') unless @configuration['email']
+    repository = FlatHash::Repository.new FlatHash::Serialiser.new, '.cards'
+    name = "\"#{@configuration['name']}\" <#{@configuration['email']}>"
+    local_configuration = Cardigan::Configuration.new @local, '.cardigan'
+    filtered_repository = Cardigan::FilteredRepository.new repository, name, local_configuration
+    workflow_repository = Cardigan::WorkflowRepository.new @local
+    root = Cardigan::RootContext.new @io, filtered_repository, name, workflow_repository
+    if args.size == 0
+      root.push
+    else
+      root.execute args
+    end
   end
 end

data/lib/cardigan/command/count_cards.rb

@@ -22,7 +22,7 @@ class Cardigan::Command::CountCards
       end
       key = grouping_fields.map {|key| card[key] ? card[key] : ''}
       counts[key] = counts[key] ? counts[key] + 1 : 1
-      total += counts[key]
+      total += 1
     end
 
     values = counts.keys.sort.map do |key|

data/lib/cardigan/command/import_cards.rb

@@ -18,27 +18,29 @@ class Cardigan::Command::ImportCards
       return
     end
     header, id_index = nil, nil
-    CSV.open(filename, 'r') do |row|
-      if header
-        if id_index and row[id_index]
-          id = row[id_index]
-          card = @repository[id] if @repository.exist?(id)
-        end
-        if card
-          puts "updating #{id}"
+    CSV.open(filename, 'r') do |csv|
+      csv.to_a.each do |row|
+        if header
+          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 new card with id #{id}"
+          end
+          editor = Cardigan::CardEditor.new(card, @io)
+          header.each_with_index do |field, index|
+            editor.set field, row[index]
+          end
+          @repository[id] = card
         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]
+          header = row
+          id_index = header.find_index('id')
         end
-        @repository[id] = card
-      else
-        header = row
-        id_index = header.find_index('id')
       end
     end
   end

data/lib/cardigan/command/open_card.rb

@@ -12,9 +12,9 @@ class Cardigan::Command::OpenCard
 
   def execute name
     entry = @repository.cards.find { |entry| entry['name'] == name }
+    original = entry.dup if entry
     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

data/lib/cardigan/command/total_cards.rb

@@ -17,10 +17,12 @@ class Cardigan::Command::TotalCards
       return
     end
     counts = {}
+    total = 0
     @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
+      total += value
     end
 
     values = counts.keys.sort.map do |key|
@@ -29,6 +31,8 @@ class Cardigan::Command::TotalCards
       hash
     end
 
+    values << {count_field => total} unless counts.size == 1
+
     formatter = Cardigan::TextReportFormatter.new @io
     grouping_fields.each {|grouping_field| formatter.add_column(grouping_field, 0)}
     formatter.add_column(count_field, 0)

data/lib/cardigan/configuration.rb

@@ -0,0 +1,19 @@
+module Cardigan
+  class Configuration
+    def initialize directory, name
+      @directory = directory
+      @name = name
+      @config = @directory.exist?(name) ? @directory[name] : {}
+    end
+
+    def [] key
+      @config[key]
+    end
+
+    def []= key, value
+      @config[key] = value
+      @config.delete key unless value
+      @directory[@name] = @config
+    end
+  end
+end

data/lib/cardigan/filtered_repository.rb

@@ -5,13 +5,36 @@ module Cardigan
   class FilteredRepository
     include Enumerable
 
-    attr_accessor :filter, :sort_columns, :display_columns
+    attr_reader :filter, :sort_columns, :display_columns
 
     extend Forwardable
     def_delegators :@repository, :[], :[]=, :exist?, :destroy, :addremovecommit
 
-    def initialize repository, user, *columns
-      @repository, @sort_columns, @display_columns, @user = repository, columns, columns, user
+    def initialize repository, user, configuration
+      @repository, @user, @configuration = repository, user, configuration
+      @sort_columns = multi('sort') || ['name']
+      @display_columns = multi('display') || ['name']
+      @filter = @configuration['filter']
+    end
+
+    def multi key
+      return nil unless @configuration[key]
+      @configuration[key].split "\n"
+    end
+
+    def filter= filter
+      @filter = filter
+      @configuration['filter'] = filter
+    end
+
+    def sort_columns= columns
+      @sort_columns = columns
+      @configuration['sort'] = columns.join "\n"
+    end
+
+    def display_columns= columns
+      @display_columns = columns
+      @configuration['display'] = columns.join "\n"
     end
 
     def cards

data/lib/cardigan/root_context.rb

@@ -1,15 +1,14 @@
 require 'rubygems'
 require 'shell_shock/context'
 require 'cardigan/commands'
-require 'cardigan/filtered_repository'
 
 module Cardigan
   class RootContext
     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} > "
+      @io, @repository, @name, @workflow_repository = io, repository, name, workflow_repository
+      @prompt = "#{File.expand_path('.').split('/').last} > "
       @commands = {
         'claim'    => Command.load(:claim_cards, @repository, @io, @name),
         'touch'    => Command.load(:create_card, @repository),
@@ -30,5 +29,10 @@ module Cardigan
         'commit'   => Command.load(:commit_changes, @repository, @io)
       }
     end
+
+    def execute args
+      command = args.shift
+      @commands[command].execute args.join(' ')
+    end
   end
 end