cardigan 0.0.5 → 0.0.6

data/README.rdoc

@@ -40,11 +40,15 @@ The commands available are (with the awesome power of tab completion):
 * 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
+* count <grouping fields> - counts the number of cards for each combination of the grouping fields
+* total <numeric field> <grouping fields> - calculates the total of the specified numeric field for each combination of the grouping fields
+* export <filename> - writes all columns for current filtered cards to <filename>.csv
+* import <filename> - imports all cards from <filename>.csv - cards will be updated with a matching id, otherwise new cards will be created.
 
 == Editing mode
 
 * quit or exit or ctrl-d - exit
-* show - dumps the values of all card field values
+* list - dumps the values of all card field values
 * set <key> - creates a new field and prompts for the new value
 * 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)
 
@@ -55,7 +59,7 @@ Workflow is pretty simple - it is just for convenience in specifiying the set of
 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)
+* list - 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

data/lib/cardigan/card_editor.rb

@@ -0,0 +1,23 @@
+module Cardigan
+  class CardEditor
+    def initialize card, io
+      @card, @io = card, io
+    end
+
+    def set key, value
+      return if key == 'id'
+      value = '' unless value
+      if value.empty?
+        if @card[key]
+          @io.say "removing #{key} from '#{@card['id']}'"
+          @card.delete key
+        end
+      else
+        unless @card[key] == value
+          @io.say "changing #{key} from '#{@card[key]}' to '#{value}' for '#{@card['id']}'"
+          @card[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/cardigan/command/batch_update_cards.rb

@@ -1,3 +1,5 @@
+require 'cardigan/card_editor'
+
 module Cardigan
   module Command
     class BatchUpdateCards
@@ -9,13 +11,7 @@ module Cardigan
         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
+          Cardigan::CardEditor.new(card, @io).set key, value
           @repository.save card
         end
       end

data/lib/cardigan/command/change_status.rb

@@ -0,0 +1,13 @@
+module Cardigan
+  module Command
+    class ChangeStatus
+      def initialize entry
+        @entry = entry
+      end
+
+      def execute status
+        @entry['status'] = status
+      end
+    end
+  end
+end

data/lib/cardigan/command/change_value.rb

@@ -0,0 +1,15 @@
+require 'cardigan/card_editor'
+
+module Cardigan
+  module Command
+    class ChangeValue
+      def initialize entry, io
+        @entry, @io = entry, io
+      end
+
+      def execute key
+        Cardigan::CardEditor.new(@entry, @io).set key, @io.ask("Enter the new value for #{key}")
+      end
+    end
+  end
+end

data/lib/cardigan/command/claim_cards.rb

@@ -1,8 +1,8 @@
 module Cardigan
   module Command
     class ClaimCards
-      def initialize repository, io
-        @repository, @io = repository, io
+      def initialize repository, io, name
+        @repository, @io, @name = repository, io, name
       end
 
       def execute numbers

data/lib/cardigan/command/count_cards.rb

@@ -0,0 +1,15 @@
+class Cardigan::Command::CountCards
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute text
+    grouping_fields = text.scan(/\w+/)
+    counts = {}
+    @repository.cards.each do |card|
+      key = grouping_fields.map {|key| card[key] ? card[key] : ''}
+      counts[key] = counts[key] ? counts[key] + 1 : 1
+    end
+    counts.keys.sort.each {|key| @io.say "#{counts[key]} #{key.inspect}"}
+  end
+end

data/lib/cardigan/command/display_cards.rb

@@ -0,0 +1,14 @@
+module Cardigan::Command::DisplayCards
+  def display_cards
+    cards = @repository.cards
+    if cards.empty?
+      @io.say "There are no cards to display"
+      return
+    end
+    formatter = Cardigan::TextReportFormatter.new @io
+    @repository.display_columns.each do |column|
+      formatter.add_column(column, @repository.max_field_length(column))
+    end
+    formatter.output cards
+  end
+end

data/lib/cardigan/command/export_cards.rb

@@ -0,0 +1,18 @@
+require 'csv'
+
+class Cardigan::Command::ExportCards
+  def initialize repository
+    @repository = repository
+  end
+
+  def execute filename
+    filename += ".csv"
+    columns = @repository.columns
+    CSV.open(filename, 'w') do |writer|
+      writer << columns
+      @repository.each do |card|
+        writer << columns.map {|column| card[column] ? card[column] : ''}
+      end
+    end
+  end
+end

data/lib/cardigan/command/import_cards.rb

@@ -0,0 +1,31 @@
+require 'csv'
+
+class Cardigan::Command::ImportCards
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute filename
+    filename += ".csv"
+    unless File.exist?(filename)
+      @io.say "#{filename} does not exist"
+      return
+    end
+    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
+        editor = Cardigan::CardEditor.new(card, @io)
+        header.each_with_index do |field, index|
+          editor.set field, row[index]
+        end
+        @repository.save card
+      else
+        header = row
+        id_index = header.find_index('id')
+      end
+    end
+  end
+end

data/lib/cardigan/command/list_cards.rb

@@ -1,20 +1,14 @@
 require 'cardigan/text_report_formatter'
+require 'cardigan/command/display_cards'
 
-module Cardigan
-  module Command
-    class ListCards
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+class Cardigan::Command::ListCards
+  include Cardigan::Command::DisplayCards
 
-      def execute text
-        cards = @repository.cards
-        formatter = TextReportFormatter.new @io
-        @repository.display_columns.each do |column|
-          formatter.add_column(column, @repository.max_field_length(column))
-        end
-        formatter.output cards
-      end
-    end
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute text
+    display_cards
   end
 end

data/lib/cardigan/command/show_entry.rb

@@ -0,0 +1,13 @@
+module Cardigan
+  module Command
+    class ShowEntry
+      def initialize entry, io
+        @entry, @io = entry, io
+      end
+
+      def execute ignored=nil
+        @entry.keys.sort.each { |key| @io.say "#{key}: #{@entry[key].inspect}" }
+      end
+    end
+  end
+end

data/lib/cardigan/command/specify_display_columns.rb

@@ -1,20 +1,19 @@
-module Cardigan
-  module Command
-    class SpecifyDisplayColumns
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+require 'cardigan/command/display_cards'
 
-      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
+class Cardigan::Command::SpecifyDisplayColumns
+  include Cardigan::Command::DisplayCards
+
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute text
+    if text
+      @repository.display_columns = text.scan(/\w+/)
+      display_cards
+    else
+      @io.say "current columns: #{@repository.display_columns.join(',')}"
+      @io.say "available columns: #{@repository.columns.sort.join(',')}"
     end
   end
 end

data/lib/cardigan/command/specify_sort_columns.rb

@@ -1,20 +1,19 @@
-module Cardigan
-  module Command
-    class SpecifySortColumns
-      def initialize repository, io
-        @repository, @io = repository, io
-      end
+require 'cardigan/command/display_cards'
 
-      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
+class Cardigan::Command::SpecifySortColumns
+  include Cardigan::Command::DisplayCards
+
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute text
+    if text
+      @repository.sort_columns = text.scan(/\w+/)
+      display_cards
+    else
+      @io.say "current columns: #{@repository.sort_columns.join(',')}"
+      @io.say "available columns: #{@repository.columns.sort.join(',')}"
     end
   end
 end

data/lib/cardigan/command/total_cards.rb

@@ -0,0 +1,16 @@
+class Cardigan::Command::TotalCards
+  def initialize repository, io
+    @repository, @io = repository, io
+  end
+
+  def execute text
+    count_field, *grouping_fields = text.scan(/\w+/)
+    counts = {}
+    @repository.cards.each do |card|
+      key = grouping_fields.map {|key| card[key] ? card[key] : ''}
+      value = card[count_field].to_i
+      counts[key] = counts[key] ? counts[key] + value : value
+    end
+    counts.keys.sort.each {|key| @io.say "#{counts[key]} #{key.inspect}"}
+  end
+end

data/lib/cardigan/context.rb

@@ -1,7 +1,17 @@
 require 'readline'
+require 'rubygems'
+require 'active_support/inflector'
 
 module Cardigan
+  module Command
+  end
+
   module Context
+    def command name, *args
+      require "cardigan/command/#{name}"
+      Command.const_get(name.to_s.camelize).new(*args)
+    end
+
     def refresh
       commands = respond_to?(:refresh_commands) ? refresh_commands : []
       Readline.completion_proc = lambda do |text|

data/lib/cardigan/entry_context.rb

@@ -7,30 +7,16 @@ module Cardigan
     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 = {}
+      @commands = {
+        'now' => command(:change_status, @entry),
+        'set' => command(:change_value, @entry, @io),
+        'list' => command(:show_entry, @entry, @io)
+      }
     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]}"
-      end
+      @workflow_repository.load[status].map { |s| "now #{s}" }
     end
   end
 end

data/lib/cardigan/filtered_repository.rb

@@ -6,7 +6,7 @@ module Cardigan
 
     extend Forwardable
 
-    def_delegators :@repository, :refresh, :save, :destroy, :find_or_create
+    def_delegators :@repository, :refresh, :save, :destroy, :find_or_create, :columns, :load, :create
 
     def initialize repository, user, *columns
       @repository, @sort_columns, @display_columns, @user = repository, columns, columns, user
@@ -22,6 +22,10 @@ module Cardigan
       end
     end
 
+    def each
+      cards.each {|card| yield card }
+    end
+
     def max_field_length name
       cards.map {|card| card[name] ? card[name].length : 0 }.max
     end

data/lib/cardigan/repository.rb

@@ -1,3 +1,6 @@
+require 'rubygems'
+require 'uuidtools'
+require 'set'
 require 'cardigan/directory'
 
 module Cardigan
@@ -26,10 +29,26 @@ module Cardigan
     end
 
     def find_or_create name
-      card = find_card(name)
-      card or { 'id' => UUIDTools::UUID.random_create.to_s,
-        'name' => name
-      }
+      find_card(name) or create('name' => name)
+    end
+
+    def each
+      @cards.each {|card| yield card}
+    end
+
+    def columns
+      columns = Set.new
+      each {|card| columns += card.keys }
+      columns.to_a
+    end
+
+    def load id
+      file = "#{id}.card"
+      @directory.has_file?(file) ? @directory.load(file) : nil
+    end
+    
+    def create hash={}
+      { 'id' => UUIDTools::UUID.random_create.to_s }.merge hash
     end
   end
 end

data/lib/cardigan/root_context.rb

@@ -1,20 +1,5 @@
-require 'rubygems'
-require 'uuidtools'
-require 'set'
 require 'cardigan/context'
 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/specify_display_columns'
-require 'cardigan/command/specify_sort_columns'
-require 'cardigan/command/unclaim_cards'
-require 'cardigan/command/unfilter_cards'
 
 module Cardigan
   class RootContext
@@ -24,18 +9,22 @@ module Cardigan
       @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),
-        '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)
+        '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),
+        '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)
       }
     end
 

data/lib/cardigan/symbol_extensions.rb

@@ -0,0 +1,3 @@
+class Symbol
+  def 
+end

data/lib/cardigan/workflow_context.rb

@@ -7,11 +7,13 @@ module Cardigan
     def initialize io, entry
       @io, @entry = io, entry
       @prompt_text = "#{File.expand_path('.').split('/').last.slice(0..0)}/workflow > "
-      @commands = {}
+      @commands = {
+        'list' => command(:show_entry, @entry, @io)
+      }
     end
 
     def refresh_commands
-      ['create', 'add', 'remove', 'show']
+      ['create', 'add', 'remove']
     end
 
     def create_command key
@@ -27,11 +29,5 @@ module Cardigan
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cardigan
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Mark Ryall
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-14 00:00:00 +11:00
+date: 2010-03-16 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.1.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
 description: |
   A command line utility that manages cards as individual files so that they can be added to a version control system
 
@@ -33,18 +43,27 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/cardigan/card_editor.rb
 - lib/cardigan/cli.rb
 - lib/cardigan/command/batch_update_cards.rb
+- lib/cardigan/command/change_status.rb
+- lib/cardigan/command/change_value.rb
 - lib/cardigan/command/claim_cards.rb
+- lib/cardigan/command/count_cards.rb
 - lib/cardigan/command/create_card.rb
 - lib/cardigan/command/destroy_cards.rb
+- lib/cardigan/command/display_cards.rb
+- lib/cardigan/command/export_cards.rb
 - lib/cardigan/command/filter_cards.rb
+- lib/cardigan/command/import_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/show_entry.rb
 - lib/cardigan/command/specify_display_columns.rb
 - lib/cardigan/command/specify_sort_columns.rb
+- lib/cardigan/command/total_cards.rb
 - lib/cardigan/command/unclaim_cards.rb
 - lib/cardigan/command/unfilter_cards.rb
 - lib/cardigan/context.rb
@@ -54,6 +73,7 @@ files:
 - lib/cardigan/io.rb
 - lib/cardigan/repository.rb
 - lib/cardigan/root_context.rb
+- lib/cardigan/symbol_extensions.rb
 - lib/cardigan/text_report_formatter.rb
 - lib/cardigan/workflow_context.rb
 - lib/cardigan/workflow_repository.rb