crab 0.1.7 → 0.1.8

data/bin/crab-testcase

@@ -0,0 +1,79 @@
+# vim: set ft=ruby :
+require 'crab'
+
+def add_or_update_options(banner)
+  Trollop::options do
+    banner banner
+    opt :priority, "Priority (one of: #{Crab::TestCase::PRIORITIES.join(" ")}", :default => "important", :short => '-p'
+    opt :risk,     "Risk (one of: #{Crab::TestCase::RISKS.join(" ")})", :default => "medium", :short => '-r'
+    opt :method,   "Method (one of: #{Crab::TestCase::METHODS.join(" ")})", :default => "automated", :short => '-m'
+    opt :type,     "Type (one of: #{Crab::TestCase::TYPES.join(" ")})", :default => "acceptance", :short => '-t'
+    opt :pre,      "Pre-conditions", :default => "N/A"
+    opt :post,     "Post-conditions", :default => "N/A"
+    opt :desc,     "Description", :default => "N/A", :short => '-d'
+  end
+end
+
+def sanitize_options(opts, creating=true)
+  result = {}
+  result[:priority] = opts[:priority].capitalize if creating || opts[:priority_given]
+  result[:risk] = opts[:risk].capitalize if creating || opts[:risk_given]
+  result[:method] = opts[:method].capitalize if creating || opts[:method_given]
+  result[:type] = opts[:type].capitalize if creating || opts[:type_given]
+  result[:pre_conditions] = opts[:pre] if creating || opts[:pre_given]
+  result[:post_conditions] = opts[:post] if creating || opts[:post_given]
+  result[:description] = opts[:desc] if creating || opts[:desc_given]
+  result
+end
+
+rally = Crab::Rally.new
+
+Trollop::options do
+  banner <<-BANNER
+crab testcase: manage test cases in a story (add, update, delete)
+
+Usage: crab testcase add story name [options]
+       crab testcase update testcase [options]
+       crab testcase delete testcase [options]
+  BANNER
+  stop_on %w{add update delete}
+end
+
+sub = ARGV.shift
+case sub
+when "add"
+  opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+
+  story_id = ARGV.shift
+  name = ARGV.join(" ")
+  add(story_id, name, opts)
+
+  rally.connect
+  tc = rally.create_test_case(story_id, name, sanitize_options(opts))
+
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+
+when "update"
+  opts = add_or_update_options "crab testcase update: update a test case in Rally"
+
+  tc_id = ARGV.shift
+
+  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(" ")})"
+
+when "delete"
+  Trollop::options do
+    banner "crab testcase delete: delete a test case in Rally"
+  end
+
+  tc_id = ARGV.shift
+  rally.connect
+  tc = rally.find_test_case(tc_id)
+  tc.delete
+  puts "Test case #{tc_id} deleted."
+
+else
+  Trollop::die "Unknown subcommand#{' ' + sub.inspect if sub}"
+end

data/bin/crab-truncate

@@ -0,0 +1,8 @@
+# vim: set ft=ruby :
+require 'crab'
+
+Trollop::options do
+  banner "crab truncate: Make spohr happy!"
+end
+
+puts "You have been truncated! Now back to work!"

data/bin/crab-up

@@ -0,0 +1,61 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab update: update a story in Rally
+
+Usage: crab update story [options]
+  BANNER
+  opt :name,      "Name (title)", :type => String, :short => "-n"
+  opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
+  opt :estimate,  "Estimate",     :type => :int,   :short => "-e"
+  opt :iteration, "Iteration",    :type => String, :short => "-i"
+  opt :release,   "Release",      :type => String, :short => "-r"
+  opt :blocked,   "Blocked",      :short => "-b"
+  opt :unblocked, "Unblocked",    :short => "-u"
+  opt :parent,    "Parent",       :type => String, :short => "-p"
+end
+
+rally = Crab::Rally.new
+
+Trollop::die "No story given" if ARGV.empty?
+Trollop::die "Nothing to update. Please provide some options" unless cmd_opts.any? {|k, v| k.to_s =~ /_given$/ }
+
+opts = {}
+opts[:name] = cmd_opts[:name] if cmd_opts[:name_given]
+opts[:schedule_state] = state_from(cmd_opts[:state]) if cmd_opts[:state_given]
+
+if cmd_opts[:estimate_given]
+  opts[:plan_estimate] = cmd_opts[:estimate] # nobody is going to remember "Plan Estimate", really
+end
+
+opts[:blocked] = cmd_opts[:blocked] if cmd_opts[:blocked_given]
+opts[:blocked] = !cmd_opts[:unblocked] if cmd_opts[:unblocked_given]
+
+rally.connect
+
+story = rally.find_story_with_id ARGV.first
+
+if cmd_opts[:iteration_given]
+  opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+  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]
+  Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
+end
+
+if cmd_opts[:parent_given]
+  opts[:parent] = rally.find_story_with_id(cmd_opts[:parent]).rally_object
+  Trollop::die "Unknown story \"#{cmd_opts[:parent]}\"" if opts[:parent].nil?
+end
+
+opts[:name] = story.name if opts[:name].blank?
+
+story.update opts
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/bin/crab-update

@@ -0,0 +1,61 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab update: update a story in Rally
+
+Usage: crab update story [options]
+  BANNER
+  opt :name,      "Name (title)", :type => String, :short => "-n"
+  opt :state,     "State (one of: #{Crab::Story::VALID_STATES.join(" ")})", :type => String, :short => "-t"
+  opt :estimate,  "Estimate",     :type => :int,   :short => "-e"
+  opt :iteration, "Iteration",    :type => String, :short => "-i"
+  opt :release,   "Release",      :type => String, :short => "-r"
+  opt :blocked,   "Blocked",      :short => "-b"
+  opt :unblocked, "Unblocked",    :short => "-u"
+  opt :parent,    "Parent",       :type => String, :short => "-p"
+end
+
+rally = Crab::Rally.new
+
+Trollop::die "No story given" if ARGV.empty?
+Trollop::die "Nothing to update. Please provide some options" unless cmd_opts.any? {|k, v| k.to_s =~ /_given$/ }
+
+opts = {}
+opts[:name] = cmd_opts[:name] if cmd_opts[:name_given]
+opts[:schedule_state] = state_from(cmd_opts[:state]) if cmd_opts[:state_given]
+
+if cmd_opts[:estimate_given]
+  opts[:plan_estimate] = cmd_opts[:estimate] # nobody is going to remember "Plan Estimate", really
+end
+
+opts[:blocked] = cmd_opts[:blocked] if cmd_opts[:blocked_given]
+opts[:blocked] = !cmd_opts[:unblocked] if cmd_opts[:unblocked_given]
+
+rally.connect
+
+story = rally.find_story_with_id ARGV.first
+
+if cmd_opts[:iteration_given]
+  opts[:iteration] = rally.find_iteration_by_name cmd_opts[:iteration]
+  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]
+  Trollop::die "Unknown release \"#{cmd_opts[:release]}\"" if opts[:release].nil?
+end
+
+if cmd_opts[:parent_given]
+  opts[:parent] = rally.find_story_with_id(cmd_opts[:parent]).rally_object
+  Trollop::die "Unknown story \"#{cmd_opts[:parent]}\"" if opts[:parent].nil?
+end
+
+opts[:name] = story.name if opts[:name].blank?
+
+story.update opts
+
+puts "#{story.formatted_id}: #{story.name} (#{story.state})"

data/crab.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.default_executable = 'crab'
+
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'aruba'

data/features/move-in-rally.feature

@@ -0,0 +1,15 @@
+Feature: Move in Rally
+
+  In order to update a story status without the hassle of figuring out 'crab update'
+  An incredibly lazy develper
+  Wants to use a simple command to move a story to the next available state
+
+  Background:
+    Given I am logged in
+
+  Scenario: Move Then Go Back
+    When I run `crab move US4988`
+    Then the output should contain "US4988: Sample Crab Story (defined)"
+
+    When I run `crab move US4988 --back`
+    Then the output should contain "US4988: Sample Crab Story (grooming)"

data/features/steps/rally_steps.rb

@@ -14,8 +14,14 @@ Then /^the user's home directory should have a file named "([^"]*)"$/ do |file|
 end
 
 def get_rally_credentials
-  username, password = File.read(File.join(File.dirname(__FILE__), '..', '..', '.crab', 'credentials')).split(/\n/)
-  [ username, password ]
+  file = File.expand_path("~/.crab/tests/credentials")
+
+  if File.exists? file
+    username, password = File.read(file).split(/\n/)
+    [ username, password ]
+  else
+    raise "Please run rake cucumber:setup first"
+  end
 end
 
 When /^I type my username$/ do
@@ -79,8 +85,10 @@ Given /^no project is selected$/ do
 end
 
 def get_project
-  if File.exists? ".crab/project"
-    File.read(".crab/project").strip
+  if File.exists? ".crab/tests/project"
+    File.read(".crab/tests/project").strip
+  else
+    raise "Please run rake cucumber:setup first"
   end
 end
 
@@ -95,7 +103,7 @@ end
 
 def get_test_project
   begin
-    test_project = File.read(File.expand_path("~/.crab/test_project"))
+    test_project = File.read(File.expand_path("~/.crab/tests/project"))
   rescue
     raise "Looks like your test project isn't set up. Please run 'rake cucumber:setup'"
   end

data/features/subcommand-help.feature

@@ -35,7 +35,7 @@ Feature: Subcommand Help
       """
       crab pull: pulls stories from Rally and writes them out as Cucumber features
 
-      Usage: crab [options] pull story1 [story2 ...]
+      Usage: crab pull [options] story1 [story2 ...]
       """
 
   Scenario: Show Subcommand
@@ -44,7 +44,7 @@ Feature: Subcommand Help
       """
       crab show: displays a story in Rally as a Cucumber feature
 
-      Usage: crab [options] show story
+      Usage: crab show story
       """
 
   Scenario: Create Subcommand
@@ -53,7 +53,7 @@ Feature: Subcommand Help
       """
       crab create: create a new story in Rally
 
-      Usage: crab [options] create name [options]
+      Usage: crab create name [options]
       """
 
   Scenario: Delete Subcommand
@@ -62,15 +62,15 @@ Feature: Subcommand Help
       """
       crab delete: delete an existing story in Rally
 
-      Usage: crab [options] delete story [options]
+      Usage: crab delete story [options]
       """
 
   Scenario: Testcase Subcommand
     When I run `crab testcase --help`
     Then the output should contain "crab testcase: manage test cases in a story (add, update, delete)"
-    And the output should contain "Usage: crab [options] testcase add story name [options]"
-    And the output should contain "crab [options] testcase update testcase [options]"
-    And the output should contain "crab [options] testcase delete testcase [options]"
+    And the output should contain "Usage: crab testcase add story name [options]"
+    And the output should contain "crab testcase update testcase [options]"
+    And the output should contain "crab testcase delete testcase [options]"
 
   Scenario: Update Subcommand
     When I run `crab update --help`
@@ -78,7 +78,7 @@ Feature: Subcommand Help
       """
       crab update: update a story in Rally
 
-      Usage: crab [options] update story [options]
+      Usage: crab update story [options]
       """
 
   Scenario: Update Needs a Story Number
@@ -95,7 +95,7 @@ Feature: Subcommand Help
       """
       crab find: find a story in Rally
 
-      Usage: crab [options] find [options] [text]
+      Usage: crab find [options] [text]
       """
 
   Scenario: Move Subcommand
@@ -104,6 +104,6 @@ Feature: Subcommand Help
       """
       crab move: move a story from one status to the next (or previous)
 
-      Usage: crab [options] move story [options]
+      Usage: crab move story [options]
       """
 

data/lib/crab.rb

@@ -16,18 +16,6 @@ require "crab/rally"
 require "crab/story"
 require "crab/testcase"
 
-# supported commands
-require "crab/commands/create"
-require "crab/commands/delete"
-require "crab/commands/find"
-require "crab/commands/login"
-require "crab/commands/move"
-require "crab/commands/project"
-require "crab/commands/pull"
-require "crab/commands/show"
-require "crab/commands/testcase"
-require "crab/commands/update"
-
 # cucumber support
 require "crab/cucumber_feature"
 require "crab/cucumber_scenario"

data/lib/crab/cli.rb

@@ -11,11 +11,12 @@ module Crab
     "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)",
+    "truncate" => "Make sphor happy!",
   }
 
   class CLI
     def self.start
-      global_opts = Trollop::options do
+      Trollop::options do
         version "crab version #{Crab::VERSION}"
         banner """
 crab version #{Crab::VERSION}: A Cucumber-Rally bridge
@@ -27,9 +28,12 @@ crab version #{Crab::VERSION}: A Cucumber-Rally bridge
 
       cmd = ARGV.shift # get the subcommand
       Trollop::die "Unknown subcommand" unless cmd
-      Trollop::die "Unknown subcommand #{cmd.inspect}" unless Crab::Commands.const_defined? cmd.capitalize
 
-      Crab::Commands.const_get(cmd.capitalize).new(global_opts, ARGV).run
+      unless system("crab-#{cmd}", *ARGV)
+        if $?.exitstatus == 127 # bash 'command not found error'
+          Trollop::die "Unknown subcommand #{cmd.inspect}"
+        end
+      end
     end
   end
 end

data/lib/crab/utilities.rb

@@ -12,16 +12,33 @@ module Crab
     end
 
     def valid_project_name(cmd_opts)
-      project_name = cmd_opts[:project_given] ? cmd_opts[:project] : Crab::Commands::Project.current_project_name
+      project_name = cmd_opts[:project_given] ? cmd_opts[:project] : current_project_name
       Trollop::die :project, "must be specified" if project_name.blank?
       project_name
     end
 
+    def current_project_name
+      if File.exists? ".crab/project"
+        File.read(".crab/project").strip
+      end
+    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
 
+    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/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Carlos Villela
@@ -16,7 +16,7 @@ bindir: bin
 cert_chain: []
 
 date: 2011-09-28 00:00:00 -03:00
-default_executable: 
+default_executable: crab
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aruba
@@ -149,6 +149,25 @@ email:
 - cvillela@thoughtworks.com
 executables: 
 - crab
+- crab-add
+- crab-change
+- crab-create
+- crab-del
+- crab-delete
+- crab-find
+- crab-login
+- crab-move
+- crab-mv
+- crab-project
+- crab-pull
+- crab-remove
+- crab-rm
+- crab-show
+- crab-tc
+- crab-testcase
+- crab-truncate
+- crab-up
+- crab-update
 extensions: []
 
 extra_rdoc_files: []
@@ -160,10 +179,30 @@ files:
 - README.md
 - Rakefile
 - bin/crab
+- bin/crab-add
+- bin/crab-change
+- bin/crab-create
+- bin/crab-del
+- bin/crab-delete
+- bin/crab-find
+- bin/crab-login
+- bin/crab-move
+- bin/crab-mv
+- bin/crab-project
+- bin/crab-pull
+- bin/crab-remove
+- bin/crab-rm
+- bin/crab-show
+- bin/crab-tc
+- bin/crab-testcase
+- bin/crab-truncate
+- bin/crab-up
+- bin/crab-update
 - crab.gemspec
 - features/create-and-delete-story.feature
 - features/find-text-in-stories.feature
 - features/login-and-out-of-rally.feature
+- features/move-in-rally.feature
 - features/project-selection.feature
 - features/pull-from-rally-into-cucumber.feature
 - features/show-from-rally.feature
@@ -173,16 +212,6 @@ files:
 - features/update-story-in-rally.feature
 - lib/crab.rb
 - lib/crab/cli.rb
-- lib/crab/commands/create.rb
-- 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
-- lib/crab/commands/testcase.rb
-- lib/crab/commands/update.rb
 - lib/crab/cucumber_feature.rb
 - lib/crab/cucumber_scenario.rb
 - lib/crab/rally.rb