crab 0.1.6 → 0.1.7

data/README.md

@@ -139,25 +139,36 @@ If you have any problems, please let us know.
 [4]: http://gembundler.com
 [5]: https://github.com/cucumber/aruba
 
-To do
------
+To do / Roadmap
+---------------
 
-- Add a config command + .crab/config file to hold settings like project, etc
-- Add a `push` subcommand which parses a Cucumber feature and adds or updates it in Rally
+### 0.2.0
+
+- Add a `move` subcommand which moves the story from one state to the next (potentially, `move --back`)
 - `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`
-- Encrypt password in generated `~/.crab/credentials`
 - 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)
+
+### 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
-- 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
-- Investigate use of other fields like Priority and Risk in Rally Test Cases
 - Make it possible to associate defects with Features (essentially treating defects like stories)
-- Test in Ruby 1.9
 - Use the Gherkin models and formatters instead of dumb string templates to generate feature files
 
+### Later / before 1.0.0
+
+- Dry-run mode
+- Encrypt password in generated `~/.crab/credentials`
+- Add a Cucumber Formatter that updates Test Runs in Rally with results from CI
+- Test in Ruby 1.9
+
+### After 1.0.0
+
+- Bash completion scripts
+
 Suggestions? Please get in touch!
 
 Authors and Contributors

data/features/show-from-rally.feature

@@ -1,10 +1,10 @@
 Feature: Show Story From Rally
-  
+
   In order to see what's in a story
   A lazy developer
   Wants to be able to do it from the command line
 
-  Background: 
+  Background:
     Given I am logged in
 
   Scenario: Show Simple Story
@@ -19,7 +19,7 @@ Feature: Show Story From Rally
   Scenario: Show Story With Test Cases
     When I run `crab show US5000`
     Then the output should contain "Feature: [US5000] Sample Crab Parent Story"
-    And the output should contain "@manual @functional"
+    And the output should contain "@important @medium @manual @acceptance"
     And the output should contain "Scenario: [TC10388] Sample Testcase"
     And the output should contain "  Given Rally behaves"
     And the output should contain "  When I look at the test case steps"

data/features/subcommand-help.feature

@@ -11,15 +11,16 @@ Feature: Subcommand Help
 
   Scenario: Help
     When I run `crab -h`
-    Then the output should contain "  create   Create a new story in Rally"
-    Then the output should contain "  delete   Delete an existing story in Rally"
-    And 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 "  testcase Manage test cases in a story (add, update, delete)"
-    And the output should contain "  update   Update a story (name, estimate, etc)"
+    Then the output should contain "create  Create a new story in Rally"
+    And the output should contain "delete  Delete an existing story in Rally"
+    And 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 "move  Move a story from one status to the next (or previous)"
+    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 "testcase  Manage test cases in a story (add, update, delete)"
+    And the output should contain "update  Update a story (name, estimate, etc)"
 
   Scenario: Bogus Subcommand
     When I run `crab bogus`
@@ -97,3 +98,12 @@ Feature: Subcommand Help
       Usage: crab [options] find [options] [text]
       """
 
+  Scenario: Move Subcommand
+    When I run `crab move --help`
+    Then the output should contain:
+      """
+      crab move: move a story from one status to the next (or previous)
+
+      Usage: crab [options] move story [options]
+      """
+

data/lib/crab.rb

@@ -1,32 +1,32 @@
 require "crab/version"
 
 # common dependencies
-require 'trollop'
+require 'active_support/all'
 require 'fileutils'
 require 'gherkin/i18n'
 require 'highline/import'
-require 'active_support/all'
 require 'rally_rest_api'
 require 'sanitize'
+require 'trollop'
 
 # internals
 require "crab/utilities"
+require "crab/cli"
 require "crab/rally"
 require "crab/story"
 require "crab/testcase"
-require "crab/cli"
-require "crab/scenario"
 
 # supported commands
-require "crab/commands/update"
-require "crab/commands/pull"
+require "crab/commands/create"
+require "crab/commands/delete"
 require "crab/commands/find"
 require "crab/commands/login"
-require "crab/commands/show"
+require "crab/commands/move"
 require "crab/commands/project"
-require "crab/commands/create"
-require "crab/commands/delete"
+require "crab/commands/pull"
+require "crab/commands/show"
 require "crab/commands/testcase"
+require "crab/commands/update"
 
 # cucumber support
 require "crab/cucumber_feature"

data/lib/crab/cli.rb

@@ -1,6 +1,17 @@
 module Crab
 
-  SUB_COMMANDS = %w(pull login list update show find project create delete testcase)
+  SUB_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",
+    "project"  => "Persistently select project to work with in Rally",
+    "pull"     => "Downloads stories (and its test cases) as Cucumber feature files",
+    "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)",
+    "move"     => "Move a story from one status to the next (or previous)",
+  }
 
   class CLI
     def self.start
@@ -9,17 +20,9 @@ module Crab
         banner """
 crab version #{Crab::VERSION}: A Cucumber-Rally bridge
 
-  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
-  project  Persistently select project to work with in Rally
-  pull     Downloads stories (and its test cases) as Cucumber feature files
-  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)
+#{SUB_COMMANDS.keys.sort.map {|k| sprintf "%10s  %s\n", k, SUB_COMMANDS[k] }.join}
         """
-        stop_on SUB_COMMANDS
+        stop_on SUB_COMMANDS.keys
       end
 
       cmd = ARGV.shift # get the subcommand

data/lib/crab/commands/move.rb

@@ -0,0 +1,46 @@
+module Crab::Commands
+
+  class Move
+
+    include Crab::Utilities
+
+    def initialize(global_opts, args)
+      @global_opts = global_opts
+      @args = args
+
+      @cmd_opts = Trollop::options do
+        banner "crab move: move a story from one status to the next (or previous)
+
+Usage: crab [options] move story [options]"
+        opt :back, "Move story backwards (from accepted to completed, for example)"
+      end
+
+      @rally = Crab::Rally.new
+    end
+
+    def run
+      story_id = @args.join(" ")
+      Trollop::die "No story given" if story_id.empty?
+
+      @rally.connect
+
+      story = @rally.find_story_with_id story_id
+      state = state_from(story.state)
+
+      story.update :schedule_state => (@cmd_opts[:back] ? state_before(state) : state_after(state))
+
+      puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+    end
+
+    def state_before(state)
+      i = (Crab::Story::VALID_STATES.index(state) || 0) - 1
+      Crab::Story::VALID_STATES[i < 0 ? 0 : i]
+    end
+
+    def state_after(state)
+      i = (Crab::Story::VALID_STATES.index(state) || 0) + 1
+      max = Crab::Story::VALID_STATES.size
+      Crab::Story::VALID_STATES[i >= max ? max -1 : i]
+    end
+  end
+end

data/lib/crab/commands/testcase.rb

@@ -76,7 +76,7 @@ Usage: crab [options] testcase add story name [options]
       @rally.connect
       tc = @rally.find_test_case(tc_id)
       tc.update(sanitize_options(opts))
-      puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")}"
+      puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
     end
 
     def delete(tc_id)

data/lib/crab/commands/update.rb

@@ -2,6 +2,8 @@ module Crab::Commands
 
   class Update
 
+    include Crab::Utilities
+
     def initialize(global_opts, args)
       @global_opts = global_opts
       @args = args
@@ -74,10 +76,5 @@ Usage: crab [options] update story [options]"
       opts
     end
 
-    def state_from(option)
-      fixed_option = option.gsub(/(^\w|[-_]\w)/) { $1.upcase.gsub(/_/, '-') }
-      Trollop::die :state, "has an invalid value" unless Crab::Story::VALID_STATES.include? fixed_option
-      fixed_option
-    end
   end
 end

data/lib/crab/cucumber_scenario.rb

@@ -6,10 +6,9 @@ module Crab
     end
 
     def generate_from(scenario)
-      tags = [scenario.method, scenario.test_type]
       return <<-SCENARIO
 
-#{tags.map {|t| " @" + t.strip }.join}
+#{scenario.tags.map {|tag| "@" + tag }.join(" ")}
 #{@language.keywords('scenario').last}: [#{scenario.formatted_id}] #{scenario.name}
   #{scenario.steps.join("\n  ")}
       SCENARIO

data/lib/crab/rally.rb

@@ -1,7 +1,7 @@
 module Crab
   class Rally
 
-    include Utilities
+    include Crab::Utilities
 
     def connect
       get_credentials

data/lib/crab/story.rb

@@ -37,7 +37,7 @@ module Crab
     end
 
     def scenarios
-      Array(@rally_story.test_cases).map {|tc| Scenario.new tc }
+      Array(@rally_story.test_cases).map {|tc| Crab::TestCase.new tc }
     end
 
     def update(opts)

data/lib/crab/testcase.rb

@@ -51,5 +51,9 @@ module Crab
       @rally_test_case.update options
     end
 
+    def steps
+      Array(@rally_test_case.steps).map {|step| step.input }
+    end
+
   end
 end

data/lib/crab/utilities.rb

@@ -1,5 +1,6 @@
 module Crab
   module Utilities
+
     def credentials_file
       FileUtils.mkdir_p File.expand_path("~/.crab")
       File.expand_path("~/.crab/credentials")
@@ -15,5 +16,12 @@ module Crab
       Trollop::die :project, "must be specified" if project_name.blank?
       project_name
     end
+
+    def state_from(option)
+      fixed_option = option.gsub(/(^\w|[-_]\w)/) { $1.upcase.gsub(/_/, '-') }
+      Trollop::die :state, "has an invalid value" unless Crab::Story::VALID_STATES.include? fixed_option
+      fixed_option
+    end
+
   end
 end

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Carlos Villela
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-27 00:00:00 -03:00
+date: 2011-09-28 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -177,6 +177,7 @@ files:
 - lib/crab/commands/delete.rb
 - lib/crab/commands/find.rb
 - lib/crab/commands/login.rb
+- lib/crab/commands/move.rb
 - lib/crab/commands/project.rb
 - lib/crab/commands/pull.rb
 - lib/crab/commands/show.rb
@@ -185,7 +186,6 @@ files:
 - lib/crab/cucumber_feature.rb
 - lib/crab/cucumber_scenario.rb
 - lib/crab/rally.rb
-- lib/crab/scenario.rb
 - lib/crab/story.rb
 - lib/crab/testcase.rb
 - lib/crab/utilities.rb

data/lib/crab/scenario.rb

@@ -1,30 +0,0 @@
-module Crab
-
-  class Scenario
-
-    def initialize(rally_test_case)
-      @rally_test_case = rally_test_case
-    end
-
-    def formatted_id
-      @rally_test_case.formatted_i_d
-    end
-
-    def name
-      @rally_test_case.name
-    end
-
-    def steps
-      Array(@rally_test_case.steps).map {|step| step.input }
-    end
-
-    def method
-      @rally_test_case.elements[:method].parameterize
-    end
-
-    def test_type
-      @rally_test_case.elements[:type].parameterize
-    end
-  end
-
-end