crab 0.2.8 → 0.2.9

data/.rvmrc

@@ -1 +1 @@
-rvm use --create ree@rally-cucumber-bridge
+rvm use --create ree@crab

data/README.md

@@ -60,8 +60,8 @@ Thankfully, that part is easy:
 
       ...
 
-If there are any test cases, their steps get converted into Cucumber
-steps:
+If there are any test cases associated with that story, they get converted
+into Cucumber scenarios:
 
     $ crab story show US1001
       ...
@@ -73,22 +73,49 @@ steps:
 
       ...
 
+To convert a bunch of stories in one go, this pipe does the trick:
+
+    $ crab story list --iteration "Iteration 7" | cut -f 1 -d : | xargs crab story pull
+
+They will be saved inside `./features/grooming`, `./features/defined`,
+etc. The reason for using subdirs named after the status is so that
+stories can be fleshed out and their scenarios added, moved around and
+completed without necessarily breaking the build for others.
+
+To see if there have been any changes to a story in Rally, try this:
+
+    $ crab story diff features/completed/US1010-safely-dispose-of-evidence.feature
+
 Some data about stories can also be edited straight from the command line.
-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:
+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.
+
+Creating:
 
     $ crab story create "Secure Access to Flying Fortress Controls"
     US1004: Secure Access to Flying Fortress Controls (grooming)
 
+Updating and moving:
+
     $ crab story update US1001 --name "Arms Rockets Upon Successful Boot" --state completed
     US1001: Arms Rockets Upon Successful Boot (completed)
 
+    $ crab story move US1002
+    US1002: Launches Rockets Upon Command from Evil Mastermind (completed)
+    $ crab story move US1002
+    US1002: Launches Rockets Upon Command from Evil Mastermind (accepted)
+    # eek, found a few problems!
+    $ crab story move US1002 --back
+    US1002: Launches Rockets Upon Command from Evil Mastermind (completed)
+
+Deleting:
+
     $ crab story delete US1004 # not in this movie :(
     Story US1004 deleted.
 
-It is also possible to create, update and delete test cases inside Rally straight
-from the command line:
+It is also possible to create, update and delete test cases inside Rally
+straight from the command line:
 
     $ crab testcase create US1001 "Rocket Silo Is Unlocked"
     US1001/TC1501: Rocket Silo Is Unlocked (important medium automated acceptance)
@@ -99,13 +126,14 @@ from the command line:
     $ crab testcase delete TC1501
     Test case TC1501 deleted.
 
-There are more switches. Try `crab --help` to find out more.
+There are many more switches. Try exploring `crab --help` to find
+out more.
 
 i18n Support
 ------------
 
-`crab` uses [Gherkin][3] internally, so all languages supported by Cucumber are also
-included:
+`crab` uses [Gherkin][3] internally, so all languages supported by
+Cucumber are also included:
 
     $ crab story show US1001 -l ja
     機能: [US1001] Arms Rockets Upon Successful Boot
@@ -114,9 +142,10 @@ included:
       Given a silo where the rockets are stored
       ...
 
-Unfortunately, we could not think of a decent way to translate the steps themselves
-(see the `Given` there?), without using Gherkin to parse each step individually and
-check that it can be used, which seemed a little overkill for now.
+Unfortunately, we could not think of a decent way to translate the steps
+themselves (see the `Given` there?), without using Gherkin to parse each
+step individually and check that it can be used, which seemed a little
+overkill for now.
 
 Hopefully this will be enough for your case, but if not please let us know!
 
@@ -125,13 +154,15 @@ Hopefully this will be enough for your case, but if not please let us know!
 Developing
 ----------
 
-To develop `crab`, you are going to need [Bundler][4], [Aruba][5] and a
-working Rally account with a project set up where you can edit things. The
-supplied `Gemfile` should take care of everything else:
+To develop `crab`, you are going to need [Bundler][4], [Aruba][5]
+and a working Rally account with a project set up where you can edit
+things. The supplied `Gemfile` and the `cucumber:setup` task should take
+care of everything else:
 
     $ git clone git@github.com:cv/crab.git
     $ cd crab
     $ bundle install
+    $ rake cucumber:setup
     $ rake
 
 If you have any problems, please let us know.
@@ -146,43 +177,55 @@ To do / Roadmap
 
 - `pull` is not very smart and could detect feature files being moved from one dir to another
 - Recursively look for a `.crab` directory like Git does with `.git`
-- Figure out how to stub or simulate Rally (tests are taking way too long already)
+- Make logging verbosity level configurable using a global command line option
+- Move more of the code away from the bin/ dir
+- More thorough automated testing of commands
 
 ### 0.3.0
 
-- Add a `push` subcommand which parses a Cucumber feature and adds or updates it in Rally
-- Add a config command + .crab/config file to hold settings like project, etc
-- Error messages are still more cryptic than we'd like
-- Make it possible to associate defects with Features (essentially treating defects like stories)
+- Do not add "default" tags to scenarios (`@important`, `@medium`, `@manual` and `@acceptance`)
+- Figure out how to stub or simulate Rally (tests are taking way too long already)
+- Make better use of Aruba to make sure generated files are OK
 - Use the Gherkin models and formatters instead of dumb string templates to generate feature files
+- Add a `push` subcommand which parses a Cucumber feature and adds or updates it (and test cases) in Rally
+- Add a config command + `.crab/config` file to hold settings like project, etc
+- A way to work in batches, or offline -- much faster!
 
-### Later / before 1.0.0
+### 0.4.0
 
-- Encrypt password in generated `~/.crab/credentials`
+- Error messages are still more cryptic than we'd like
 - Add a Cucumber Formatter that updates Test Runs in Rally with results from CI
+- Make it possible to associate defects with Features (essentially treating defects like stories)
+- Encrypt password in generated `~/.crab/credentials`
 - Test in Ruby 1.9
 
-### After 1.0.0
+### Before 1.0.0
 
 - Bash completion scripts
+- Man pages
+- Logo
+- Website
 
 Suggestions? Please get in touch!
 
 Authors and Contributors
 ------------------------
 
-- Carlos Villela <cvillela@thoughtworks.com>
-- Rodrigo Kochenburger <rkochen@thoughtworks.com>
-- Fabio Rehm <frehm@thoughtworks.com>
+- Carlos Villela <cvillela@thoughtworks.com> (@cv)
+- Rodrigo Kochenburger <rkochen@thoughtworks.com> (@divoxx)
+- Fabio Rehm <frehm@thoughtworks.com> (@fgrehm)
 
-And last but not least, Rodrigo Spohr <rspohr@thoughtworks.com> for the user testing.
+And last but not least, Rodrigo Spohr <rspohr@thoughtworks.com> and
+Camilo Ribeiro <cribeiro@thoughtworks.com> for the user testing.
 
 Disclaimers
 -----------
 
-This project and its authors have no affiliation with Rally Software Development Corp. or the Cucumber project.
+This project and its authors have no affiliation with Rally Software
+Development Corp. or the Cucumber project.
 
-It was written as necessity in a real-world project, and by no means should represent endorsement of either product.
+It was written as necessity in a real-world project, and by no means
+should represent endorsement of either product.
 
 Rally (c) 2003-2011 Rally Software Development Corp.
 

data/bin/crab-tc-find

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/bin/crab-tc-list

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/bin/crab-tc-ls

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/bin/crab-testcase-find

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/bin/crab-testcase-list

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/bin/crab-testcase-ls

@@ -33,9 +33,13 @@ Usage: crab testcase find [options*] [text]
 
         find_opts = {}
         find_opts[:story] = rally.find_story_with_id opts[:story] if opts[:story_given]
+        find_opts[:priority] = opts[:priority].capitalize if opts[:priority_given]
+        find_opts[:method]   = opts[:method].capitalize   if opts[:method_given]
+        find_opts[:type]     = opts[:type].capitalize     if opts[:type_given]
+        find_opts[:risk]     = opts[:risk].capitalize     if opts[:risk_given]
 
         rally.find_testcases(project, pattern, find_opts).each do |tc|
-          puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+          puts "#{tc.story.formatted_id if tc.story.rally_object}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
         end
       end
     end

data/lib/crab/rally.rb

@@ -47,8 +47,9 @@ module Crab
         equal :type,     opts[:type].capitalize     if opts[:type]
       end
 
-      logger.info "Found #{rally_testcases.size} test cases"
-      rally_testcases.map {|tc| Crab::TestCase.new(tc, @dry_run) }
+      rally_testcases.map {|tc| Crab::TestCase.new(tc, @dry_run) }.tap do |testcases|
+        logger.info "Found #{testcases.size} test cases"
+      end
     end
 
     def find_stories(project, pattern, opts)
@@ -65,8 +66,9 @@ module Crab
         equal :parent,    opts[:parent].rally_object if opts[:parent]
       end
 
-      logger.info "Found #{rally_stories.size} stories"
-      rally_stories.map {|story| Crab::Story.new(story, @dry_run) }
+      rally_stories.map {|story| Crab::Story.new(story, @dry_run) }.tap do |stories|
+        logger.info "Found #{stories.size} stories"
+      end
     end
 
     def find_project(name)

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Carlos Villela
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-02 00:00:00 -03:00
+date: 2011-10-03 00:00:00 -03:00
 default_executable: crab
 dependencies: 
 - !ruby/object:Gem::Dependency