crab 0.2.2 → 0.2.3

data/README.md

@@ -38,20 +38,20 @@ Initially, there were concerns around migration of the existing data.
 Thankfully, that part is easy:
 
     $ crab login -u cv@lixo.org -p secr3t
-    Logged in as cv@lixo.org.
+    Credentials stored for cv@lixo.org.
 
     $ crab project "World Domination 3000"
-    $ crab find
+    $ crab story find
     US1001: Arms Rockets Upon Successful Boot
     US1002: Launches Rockets Upon Command from Evil Mastermind
     US1003: Transfers $0.01 From All Bank Accounts
     ...
 
-    $ crab find Rockets
+    $ crab story find Rockets
     US1001: Arms Rockets After Boot
     US1002: Launches Rockets Upon Command from Evil Mastermind
 
-    $ crab show US1001
+    $ crab story show US1001
     Feature: [US1001] Arms Rockets After Boot
 
       In order to gain bargaining power with Super Hero
@@ -63,9 +63,9 @@ Thankfully, that part is easy:
 If there are any test cases, their steps get converted into Cucumber
 steps:
 
-    $ crab show US1001
+    $ crab story show US1001
       ...
-
+      @critical @automated @high
       Scenario: [TC10001] Rocket Silo Is Unlocked
         Given a silo where the rockets are stored
         When I boot the system
@@ -78,19 +78,19 @@ In that sense, `crab` acts more like a command-line interface to Rally than a
 bridge between Rally and Cucumber, but the team thought these were *very*
 convenient features to have:
 
-    $ crab create "Secure Access to Flying Fortress Controls"
+    $ crab story create "Secure Access to Flying Fortress Controls"
     US1004: Secure Access to Flying Fortress Controls (grooming)
 
-    $ crab update US1001 --name "Arms Rockets Upon Successful Boot" --state completed
+    $ crab story update US1001 --name "Arms Rockets Upon Successful Boot" --state completed
     US1001: Arms Rockets Upon Successful Boot (completed)
 
-    $ crab delete US1004 # not in this movie :(
+    $ crab story delete US1004 # not in this movie :(
     Story US1004 deleted.
 
-It is also possible to add, update and delete test cases inside Rally straight
+It is also possible to create, update and delete test cases inside Rally straight
 from the command line:
 
-    $ crab testcase add US1001 "Rocket Silo Is Unlocked"
+    $ crab testcase create US1001 "Rocket Silo Is Unlocked"
     US1001/TC1501: Rocket Silo Is Unlocked (important medium automated acceptance)
 
     $ crab testcase update TC1501 --priority critical --risk low
@@ -107,7 +107,7 @@ i18n Support
 `crab` uses [Gherkin][3] internally, so all languages supported by Cucumber are also
 included:
 
-    $ crab show US1001 -l ja
+    $ crab story show US1001 -l ja
     機能: [US1001] Arms Rockets Upon Successful Boot
     ...
     シナリオ: [TC1501] Rocket Silo Is Unlocked

data/bin/crab-help

@@ -1,5 +1,5 @@
 # vim: set ft=ruby :
-require 'crab'
+require 'crab/version'
 
 puts <<-HELP
 Usage: crab <command> [options*]
@@ -8,18 +8,14 @@ crab version #{Crab::VERSION}: A Cucumber-Rally bridge
 
   Available commands:
 
-    create  Create a new story in Rally
-    delete  Delete an existing story in Rally
-      find  Find stories by text in name, description or notes
-     login  Persistently authenticate user with Rally
-      move  Move a story from one status to the next (or previous)
-   project  Persistently select project to work with in Rally
-      pull  Downloads stories (and its test cases) as Cucumber feature files
-    rename  Rename a story
-      show  Show a story (and its test cases) as a Cucumber feature
-  testcase  Manage test cases in a story (add, update, delete)
-    update  Update a story (name, estimate, etc)
-
+       help  Show this help text
+  iteration  Manipulate iterations
+      login  Persistently authenticate user with Rally
+     logout  Remove stored Rally credentials
+    project  Persistently select project to work with in Rally
+    release  Manipulate releases
+      story  Manipulate stories
+   testcase  Manipulate test cases
 
   --version, -v:   Print version and exit
      --help, -h:   Show this message

data/bin/crab-iteration

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby:
+
+cmd = ARGV.shift # get the subcommand
+
+case cmd
+when "-h", "--help", NilClass
+  system "crab-iteration-help"
+  exit 0
+end
+
+unless system("crab-iteration-#{cmd}", *ARGV)
+  if $?.exitstatus == 127 # bash 'command not found'
+    $stderr.puts "Unknown subcommand \"iteration #{cmd}\""
+    system "crab-iteration-help"
+    exit 127
+  end
+end

data/bin/crab-iteration-help

@@ -0,0 +1,11 @@
+# vim: set ft=ruby :
+
+puts <<-HELP
+Usage: crab iteration <command> [options*]
+
+  Available commands:
+
+  help  Show this help text
+
+     --help, -h:   Show this message
+HELP

data/bin/crab-login

@@ -5,7 +5,7 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-Usage: crab login [options]
+Usage: crab login [options*]
 
 Log into Rally. Your credentials will be written to ~/.crab/credentials.
   BANNER
@@ -22,4 +22,4 @@ File.open(credentials_file, 'w') do |file|
   file.puts password
 end
 
-puts "Logged in as #{username}"
+puts "Credentials stored for #{username}"

data/bin/crab-logout

@@ -0,0 +1,18 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = Trollop::options do
+  banner <<-BANNER
+Usage: crab logout [options*]
+
+Log out of Rally. Your credentials will be removed from ~/.crab/credentials.
+  BANNER
+  opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
+end
+
+fileutils_opts = opts[:dry] ? {:noop => true, :verbose => true} : {}
+FileUtils.rm_rf(credentials_file, fileutils_opts)
+
+puts "Credentials removed for #{username}"

data/bin/crab-project

@@ -7,7 +7,7 @@ opts = Trollop::options do
   banner <<-BANNER
 crab project: show or persistently select project to work with in Rally
 
-Usage: crab project [name]
+Usage: crab project [name] [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end

data/bin/{crab-tc → crab-release}

@@ -5,14 +5,14 @@ cmd = ARGV.shift # get the subcommand
 
 case cmd
 when "-h", "--help", NilClass
-  system "crab-testcase-help"
+  system "crab-release-help"
   exit 0
 end
 
-unless system("crab-testcase-#{cmd}", *ARGV)
+unless system("crab-release-#{cmd}", *ARGV)
   if $?.exitstatus == 127 # bash 'command not found'
-    $stderr.puts "Unknown subcommand \"template #{cmd}\""
-    system "crab-testcase-help"
+    $stderr.puts "Unknown subcommand \"release #{cmd}\""
+    system "crab-release-help"
     exit 127
   end
 end

data/bin/crab-release-help

@@ -0,0 +1,11 @@
+# vim: set ft=ruby :
+
+puts <<-HELP
+Usage: crab release <command> [options*]
+
+  Available commands:
+
+  help  Show this help text
+
+     --help, -h:   Show this message
+HELP

data/bin/crab-story

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# vim: set ft=ruby:
+
+cmd = ARGV.shift # get the subcommand
+
+case cmd
+when "-h", "--help", NilClass
+  system "crab-story-help"
+  exit 0
+end
+
+unless system("crab-story-#{cmd}", *ARGV)
+  if $?.exitstatus == 127 # bash 'command not found'
+    $stderr.puts "Unknown subcommand \"story #{cmd}\""
+    system "crab-story-help"
+    exit 127
+  end
+end

data/bin/{crab-add → crab-story-add}

@@ -3,9 +3,9 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab create: create a new story in Rally
+crab story create: create a new story in Rally
 
-Usage: crab create name [options]
+Usage: crab story create <name> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end

data/bin/{crab-change → crab-story-change}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 cmd_opts = Trollop::options do
   banner <<-BANNER
-crab update: update a story in Rally
+crab story update: update a story in Rally
 
-Usage: crab update story [options]
+Usage: crab story update <id> [options*]
   BANNER
   opt :name,      "Name (title)", :type => String, :short => "-n"
   opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
@@ -40,12 +40,12 @@ Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id ARGV.first
 
   if cmd_opts[:iteration_given]
-    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+    opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration], story.project
     Trollop::die "Unknown iteration \"#{cmd_opts[:iteration]}\"" if opts[:iteration].nil?
   end
 
   if cmd_opts[:release_given]
-    opts[:release] = rally.find_release_by_name cmd_opts[:release]
+    opts[:release] = rally.find_release_by_name cmd_opts[:release], story.project
     Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
   end
 

data/bin/{crab-new → crab-story-create}

@@ -3,9 +3,9 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab create: create a new story in Rally
+crab story create: create a new story in Rally
 
-Usage: crab create name [options]
+Usage: crab story create <name> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end

data/bin/{crab-remove → crab-story-del}

@@ -3,15 +3,15 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab delete: delete an existing story in Rally
+crab story delete: delete an existing story in Rally
 
-Usage: crab delete story [options]
+Usage: crab story delete <id> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end
 
 id = ARGV.join(" ")
-Trollop::die "Story ID must be specified" if story_id.blank?
+Trollop::die "Story ID must be specified" if id.blank?
 
 Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id id

data/bin/{crab-delete → crab-story-delete}

@@ -3,15 +3,15 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab delete: delete an existing story in Rally
+crab story delete: delete an existing story in Rally
 
-Usage: crab delete story [options]
+Usage: crab story delete <id> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end
 
 id = ARGV.join(" ")
-Trollop::die "Story ID must be specified" if story_id.blank?
+Trollop::die "Story ID must be specified" if id.blank?
 
 Crab::Rally.new(opts[:dry]) do |rally|
   story = rally.find_story_with_id id

data/bin/{crab-find → crab-story-find}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab find: find a story in Rally
+crab story find: find a story in Rally
 
-Usage: crab find [options] [text]
+Usage: crab story find [options*] [text]
   BANNER
   opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/crab-story-help

@@ -0,0 +1,11 @@
+# vim: set ft=ruby :
+
+puts <<-HELP
+Usage: crab story <command> [options*]
+
+  Available commands:
+
+  help  Show this help text
+
+     --help, -h:   Show this message
+HELP

data/bin/{crab-ls → crab-story-list}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab find: find a story in Rally
+crab story find: find a story in Rally
 
-Usage: crab find [options] [text]
+Usage: crab story find [options*] [text]
   BANNER
   opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-list → crab-story-ls}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab find: find a story in Rally
+crab story find: find a story in Rally
 
-Usage: crab find [options] [text]
+Usage: crab story find [options*] [text]
   BANNER
   opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-move → crab-story-move}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab move: move a story from one status to the next (or previous)
+crab story move: move a story from one status to the next (or previous)
 
-Usage: crab move story [options]
+Usage: crab story move <id> [options*]
   BANNER
   opt :back, "Move story backwards (from accepted to completed, for example)"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-mv → crab-story-mv}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab move: move a story from one status to the next (or previous)
+crab story move: move a story from one status to the next (or previous)
 
-Usage: crab move story [options]
+Usage: crab story move <id> [options*]
   BANNER
   opt :back, "Move story backwards (from accepted to completed, for example)"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-create → crab-story-new}

@@ -3,9 +3,9 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab create: create a new story in Rally
+crab story create: create a new story in Rally
 
-Usage: crab create name [options]
+Usage: crab story create <name> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end

data/bin/{crab-pull → crab-story-pull}

@@ -3,9 +3,9 @@ require 'crab'
 
 opts = Trollop::options do
   banner <<-BANNER
-crab pull: pulls stories from Rally and writes them out as Cucumber features
+crab story pull: pulls stories from Rally and writes them out as Cucumber features
 
-Usage: crab pull [options] story1 [story2 ...]
+Usage: crab story pull <id> [id*] [options*]
   BANNER
   opt :language, "Language to generate Cucumber features in (ISO code)", :default => "en", :short => "-l"
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false

data/bin/{crab-rename → crab-story-ren}

@@ -5,9 +5,9 @@ include Crab::Utilities
 
 opts = Trollop::options do
   banner <<-BANNER
-crab rename: rename a story
+crab story rename: rename a story
 
-Usage: crab rename <story> <new name> [options]
+Usage: crab story rename <id> <name> [options*]
   BANNER
   opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
 end

data/bin/crab-story-rename

@@ -0,0 +1,27 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = Trollop::options do
+  banner <<-BANNER
+crab story rename: rename a story
+
+Usage: crab story rename <id> <name> [options*]
+  BANNER
+  opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
+end
+
+id = ARGV.shift
+Trollop::die "No story given" if id.empty?
+
+name = ARGV.join(" ").squish
+Trollop::die "No name given" if name.empty?
+
+Crab::Rally.new(opts[:dry]) do |rally|
+  story = rally.find_story_with_id id
+
+  story.update :name => name
+
+  puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+end