crab 0.1.1 → 0.1.2

data/README.md

@@ -15,13 +15,14 @@ stay out of the way as much as possible.
 Installing
 ----------
 
-`crab` is distributed as a Ruby Gem. To install it, simply issue:
+`crab` is distributed as a Ruby Gem. To install it, simply issue (where
+`$` is your command prompt):
 
-    gem install crab
+    $ gem install crab
 
-And you should be good to go. To make sure everything is ok, try:
+And you should be good to go. To make sure everything is OK, try:
 
-    crab -h
+    $ crab -h
 
 If you see a help message, everything went fine.
 
@@ -36,25 +37,25 @@ writing them straight in Cucumber features would be better suited.
 Initially, there were concerns around migration of the existing data.
 Thankfully, that part is easy:
 
-    # crab login -u cv@lixo.org -p mypassword
+    $ crab login -u cv@lixo.org -p secr3t
     Logged in as cv@lixo.org.
 
-    # crab project "World Domination 3000"
-    # crab list
+    $ crab project "World Domination 3000"
+    $ crab list
     US1001: Arms Rockets Upon Successful Boot
     US1002: Launches Rockets Upon Command from Evil Mastermind
-    US1003: Transfer $0.01 From All Bank Accounts
+    US1003: Transfers $0.01 From All Bank Accounts
     ...
 
-    # crab find Rockets
-    US1001: Arms Rockets Upon Successful Boot
+    $ crab find Rockets
+    US1001: Arms Rockets After Boot
     US1002: Launches Rockets Upon Command from Evil Mastermind
 
-    # crab show US1001
+    $ crab show US1001
     Feature: [US1001] Arms Rockets After Boot
 
       In order to gain bargaining power with Super Hero
-      As an Evil Mastermind
+      An Evil Mastermind
       Wants visible evidence that the rockets have been armed
 
       ...
@@ -62,7 +63,7 @@ Thankfully, that part is easy:
 If there are any test cases, their steps get converted into Cucumber
 steps:
 
-    # crab show US1001
+    $ crab show US1001
       ...
 
       Scenario: [TC10001] Rocket Silo Is Unlocked
@@ -73,17 +74,37 @@ steps:
       ...
 
 Some data about stories can also be edited straight from the command line.
-In that sense, `crab` acts more like a CLI interface to Rally than a bridge
+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 update US1001 --name "Arms Rockets Upon Successful Boot" --state completed
+    $ crab update US1001 --name "Arms Rockets Upon Successful Boot" --state completed
 
 There are more switches. Check out `crab update --help` to find out more.
 
+Developing
+----------
+
+To develop `crab`, you are going to need [`bundler`][3], [Aruba][4] and a
+working Rally account with a project set up where you can edit things. The
+supplied `Gemfile` should take care of everything else:
+
+    $ git clone git@github.com:cv/crab.git
+    $ cd crab
+    $ bundle install
+    $ rake
+
+If you have any problems, please let us know.
+
+[3]: http://gembundler.com
+[4]: http://github.com/cucumber/aruba
+
 To do
 -----
 
+- Add a config command + .crab/config file to hold settings like project, etc
+- Remove account-specific Rally tests
+- Ability to create and delete stories with all mandatory fields from the command line
 - Add a `push` subcommand which parses a Cucumber feature and adds or updates it in Rally
 - Add a way to create, edit and delete test cases / scenarios from the command line
 - `pull` is not very smart and could detect feature files being moved from one dir to another
@@ -92,15 +113,23 @@ To do
 - Verbose logging (especially before any change or destructive operations in Rally)
 - Dry-run mode
 - Figure out how to stub or simulate Rally (tests are taking way too long already)
+- Error messages are still more cryptic than we'd like
+- Add a `move` subcommand which moves the story from one state to the next (potentially, `move --back`)
+- Add a Cucumber Formatter that updates Test Runs in Rally with results from CI
+- Add `@manual` tags to Test Cases marked as such
+- Investigate use of other fields like Priority and Risk in Rally Test Cases
+- Support i18n Cucumber Features
+- Make it possible to associate defects with Features (essentially treating defects like stories)
+- Test in Ruby 1.9
 
 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>
+- Rodrigo Kochenburger <rkochen@thoughtworks.com>
+- Fabio Rehm <frehm@thoughtworks.com>
 
 And last but not least, Rodrigo Spohr <rspohr@thoughtworks.com> for the user testing.
 
@@ -109,6 +138,7 @@ Disclaimers
 
 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.
 
 Rally (c) 2003-2011 Rally Software Development Corp.
@@ -131,5 +161,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 or implied.  See the License for the specific language governing
 permissions and limitations under the License.
-
-

data/crab.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Crab::VERSION
   s.authors     = ["Carlos Villela"]
   s.email       = ["cvillela@thoughtworks.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/cv/crab"
   s.summary     = %q{Cucumber-Rally Bridge}
   s.description = %q{CRaB is a bridge between Cucumber and Rally}
 
@@ -18,11 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.executables = 'crab'
-
   s.add_development_dependency 'aruba'
 
-  s.add_dependency 'aruba'
   s.add_dependency 'cucumber'
   s.add_dependency 'rally_rest_api'
   s.add_dependency 'highline'

data/features/subcommand-help.feature

@@ -11,11 +11,12 @@ Feature: Subcommand Help
 
   Scenario: Help
     When I run `crab -h`
-    Then the output should contain "  login   Persistently authenticate user with Rally"
-     And the output should contain "  list    Lists stories"
-     And the output should contain "  update  Update a story (name, estimate, etc)"
-     And the output should contain "  show    Show a story (and its test cases) as a Cucumber feature"
+    Then the output should contain "  find    Find stories by text in name, description or notes"
+     And the output should contain "  login   Persistently authenticate user with Rally"
+     And the output should contain "  project Persistently select project to work with in Rally"
      And the output should contain "  pull    Downloads stories (and its test cases) as Cucumber feature files"
+     And the output should contain "  show    Show a story (and its test cases) as a Cucumber feature"
+     And the output should contain "  update  Update a story (name, estimate, etc)"
 
   Scenario: Bogus Subcommand
     When I run `crab bogus`
@@ -42,15 +43,6 @@ crab show: displays a story in Rally as a Cucumber feature
 Usage: crab [options] show story
     """
 
-  Scenario: List Subcommand
-    When I run `crab list --help`
-    Then the output should contain:
-    """
-crab list: lists stories in Rally
-
-Usage: crab [options] list
-    """
-
   Scenario: Update Subcommand
     When I run `crab update --help`
     Then the output should contain:
@@ -74,11 +66,5 @@ Usage: crab [options] update story [options]
     """
 crab find: find a story in Rally
 
-Usage: crab [options] find [options] text
+Usage: crab [options] find [options] [text]
     """
-
-  Scenario: Find Needs Text
-    When I run `crab find`
-    Then the output should contain "Error: No search pattern given."
-
-

data/features/support/aruba.rb

@@ -8,7 +8,3 @@ end
 Before '~@quick' do
   @aruba_io_wait_seconds = 5
 end
-
-Before '@really-slow' do
-  @aruba_io_wait_seconds = 30
-end

data/lib/crab.rb

@@ -6,7 +6,6 @@ require "crab/story"
 require "crab/cli"
 require "crab/pull"
 require "crab/login"
-require "crab/list"
 require "crab/find"
 require "crab/update"
 require "crab/show"

data/lib/crab/cli.rb

@@ -11,13 +11,12 @@ module Crab
         banner """
 crab version #{Crab::VERSION}: A Cucumber-Rally bridge
 
+  find    Find stories by text in name, description or notes
   login   Persistently authenticate user with Rally
   project Persistently select project to work with in Rally
-  list    Lists stories
-  update  Update a story (name, estimate, etc)
-  show    Show a story (and its test cases) as a Cucumber feature
   pull    Downloads stories (and its test cases) as Cucumber feature files
-  find    Find stories by text in name, description or notes
+  show    Show a story (and its test cases) as a Cucumber feature
+  update  Update a story (name, estimate, etc)
         """
         stop_on SUB_COMMANDS
       end
@@ -53,17 +52,6 @@ Usage: crab [options] login"
 
         Crab::Login.new(global_opts, cmd_opts).run
 
-      when "list"
-        cmd_opts = Trollop::options do
-          banner "crab list: lists stories in Rally
-
-Usage: crab [options] list"
-          opt :pagesize, "Number of items to fetch per page", :short => "-s", :default => 100
-          opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
-        end
-
-        Crab::List.new(global_opts, cmd_opts).run
-
       when "update"
         cmd_opts = Trollop::options do
           banner "crab update: update a story in Rally
@@ -85,7 +73,7 @@ Usage: crab [options] update story [options]"
         cmd_opts = Trollop::options do
           banner "crab find: find a story in Rally
 
-Usage: crab [options] find [options] text"
+Usage: crab [options] find [options] [text]"
           opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
         end
 

data/lib/crab/find.rb

@@ -12,8 +12,6 @@ module Crab
 
     def run
       pattern = @args.map(&:strip).reject(&:empty?)
-      Trollop::die "No search pattern given" if pattern.empty?
-
       project_name = valid_project_name(@cmd_opts)
 
       @rally.connect
@@ -22,7 +20,7 @@ module Crab
 
       Trollop::die "Project #{@cmd_opts[:project].inspect} not found" if project.nil?
 
-      @rally.find_story(project, pattern).each do |story|
+      @rally.find_stories(project, pattern).each do |story|
         puts "#{story.formatted_id}: #{story.name} (#{story.state})"
       end
     end

data/lib/crab/rally.rb

@@ -22,7 +22,9 @@ module Crab
       @rally.find_all(:hierarchical_requirement, {:fetch => true}.merge(opts)).map {|s| Crab::Story.new s }
     end
 
-    def find_story(project, pattern)
+    def find_stories(project, pattern=[])
+      return find_all_stories :project => project if pattern.empty?
+
       @rally.find(:hierarchical_requirement, :fetch => true, :project => project) {
         pattern.each do |word|
           _or_ {

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Carlos Villela
@@ -33,7 +33,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: aruba
+  name: cucumber
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: rally_rest_api
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,7 +61,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rally_rest_api
+  name: highline
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -75,7 +75,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: highline
+  name: activesupport
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -89,7 +89,7 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: i18n
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -103,7 +103,7 @@ dependencies:
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: sanitize
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -117,7 +117,7 @@ dependencies:
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: sanitize
+  name: trollop
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -130,20 +130,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: trollop
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id009
 description: CRaB is a bridge between Cucumber and Rally
 email: 
 - cvillela@thoughtworks.com
@@ -162,7 +148,6 @@ files:
 - bin/crab
 - crab.gemspec
 - features/find-text-in-stories.feature
-- features/list-from-rally.feature
 - features/login-and-out-of-rally.feature
 - features/project-selection.feature
 - features/pull-from-rally-into-cucumber.feature
@@ -176,7 +161,6 @@ files:
 - lib/crab/cucumber_feature.rb
 - lib/crab/cucumber_scenario.rb
 - lib/crab/find.rb
-- lib/crab/list.rb
 - lib/crab/login.rb
 - lib/crab/project.rb
 - lib/crab/pull.rb
@@ -194,7 +178,7 @@ files:
 - old/templates/feature-pt.mustache
 - old/templates/feature.mustache
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/cv/crab
 licenses: []
 
 post_install_message: 

data/features/list-from-rally.feature

@@ -1,27 +0,0 @@
-Feature: List Stories in Rally
-
-  In order to figure out which stories she needs to pull
-  A developer who doesn't want to open a browser or click on things
-  Wants to list stories in Rally
-
-  Background:
-    Given I am logged in
-    And I have selected the project "VEJA SP - Migração para o Alexandria"
-
-  @really-slow
-  Scenario: Basic Invocation
-    When I run `crab list`
-    Then the output should contain "US4988: Sample Crab Story (grooming)"
-
-  @quick
-  Scenario: Project Must be Specified When Not Selected
-    Given no project is selected
-    When I run `crab list`
-    Then the output should contain "Error: argument --project must be specified."
-
-  Scenario: Project Must Exist
-    When I run `crab list -p "foo"`
-    Then the output should contain:
-    """
-    Error: Project "foo" not found.
-    """

data/lib/crab/list.rb

@@ -1,29 +0,0 @@
-module Crab
-  class List
-
-    include Utilities
-
-    def initialize(global_opts, cmd_opts)
-      @global_opts = global_opts
-      @cmd_opts = cmd_opts
-      @rally = Rally.new
-    end
-
-    def run
-      @rally.connect
-
-      project_name = valid_project_name(@cmd_opts)
-
-      opts = {
-        :pagesize => @cmd_opts[:pagesize],
-        :project  => @rally.find_project(project_name),
-      }
-
-      Trollop::die "Project #{@cmd_opts[:project].inspect} not found" if opts[:project].nil?
-
-      @rally.find_all_stories(opts).each do |story|
-        puts "#{story.formatted_id}: #{story.name} (#{story.state})"
-      end
-    end
-  end
-end