crab 0.1.9 → 0.2.0

data/bin/crab-list

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab find: find a story in Rally
+
+Usage: crab find [options] [text]
+  BANNER
+  opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+end
+
+pattern = ARGV.map(&:strip).reject(&:empty?)
+project_name = valid_project_name(cmd_opts)
+
+Crab::Rally.new do |rally|
+  project = rally.find_project(project_name)
+  Trollop::die "Project #{cmd_opts[:project].inspect} not found" if project.nil?
+
+  rally.find_stories(project, pattern).each do |story|
+    puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+  end
+end

data/bin/crab-ls

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab find: find a story in Rally
+
+Usage: crab find [options] [text]
+  BANNER
+  opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+end
+
+pattern = ARGV.map(&:strip).reject(&:empty?)
+project_name = valid_project_name(cmd_opts)
+
+Crab::Rally.new do |rally|
+  project = rally.find_project(project_name)
+  Trollop::die "Project #{cmd_opts[:project].inspect} not found" if project.nil?
+
+  rally.find_stories(project, pattern).each do |story|
+    puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+  end
+end

data/bin/crab-new

@@ -0,0 +1,18 @@
+# vim: set ft=ruby :
+require 'crab'
+
+cmd_opts = Trollop::options do
+  banner <<-BANNER
+crab create: create a new story in Rally
+
+Usage: crab create name [options]
+  BANNER
+end
+
+name = ARGV.join(" ")
+Trollop::die "Please specify a name for the story" if name.blank?
+
+Crab::Rally.new do |rally|
+  story = rally.create_story :name => name
+  puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+end

data/bin/crab-tc

@@ -1,78 +1,18 @@
-# vim: set ft=ruby :
-require 'crab'
+#!/usr/bin/env ruby
+# vim: set ft=ruby:
 
-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
+cmd = ARGV.shift # get the subcommand
 
-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}
+case cmd
+when "-h", "--help", NilClass
+  system "crab-testcase-help"
+  exit 0
 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(" ")
-
-  Crab::Rally.new do |rally|
-    tc = rally.create_test_case(story_id, name, sanitize_options(opts))
-    puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
-  end
-
-when "update"
-  opts = add_or_update_options "crab testcase update: update a test case in Rally"
-
-  tc_id = ARGV.shift
-
-  Crab::Rally.new do |rally|
-    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(" ")})"
-  end
-
-when "delete"
-  Trollop::options do
-    banner "crab testcase delete: delete a test case in Rally"
-  end
-
-  tc_id = ARGV.shift
-  Crab::Rally.new do |rally|
-    tc = rally.find_test_case(tc_id)
-    tc.delete
-    puts "Test case #{tc_id} deleted."
+unless system("crab-testcase-#{cmd}", *ARGV)
+  if $?.exitstatus == 127 # bash 'command not found'
+    $stderr.puts "Unknown subcommand \"template #{cmd}\""
+    system "crab-testcase-help"
+    exit 127
   end
-
-else
-  Trollop::die "Unknown subcommand#{' ' + sub.inspect if sub}"
 end

data/bin/crab-testcase

@@ -1,78 +1,18 @@
-# vim: set ft=ruby :
-require 'crab'
+#!/usr/bin/env ruby
+# vim: set ft=ruby:
 
-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
+cmd = ARGV.shift # get the subcommand
 
-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}
+case cmd
+when "-h", "--help", NilClass
+  system "crab-testcase-help"
+  exit 0
 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(" ")
-
-  Crab::Rally.new do |rally|
-    tc = rally.create_test_case(story_id, name, sanitize_options(opts))
-    puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
-  end
-
-when "update"
-  opts = add_or_update_options "crab testcase update: update a test case in Rally"
-
-  tc_id = ARGV.shift
-
-  Crab::Rally.new do |rally|
-    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(" ")})"
-  end
-
-when "delete"
-  Trollop::options do
-    banner "crab testcase delete: delete a test case in Rally"
-  end
-
-  tc_id = ARGV.shift
-  Crab::Rally.new do |rally|
-    tc = rally.find_test_case(tc_id)
-    tc.delete
-    puts "Test case #{tc_id} deleted."
+unless system("crab-testcase-#{cmd}", *ARGV)
+  if $?.exitstatus == 127 # bash 'command not found'
+    $stderr.puts "Unknown subcommand \"template #{cmd}\""
+    system "crab-testcase-help"
+    exit 127
   end
-
-else
-  Trollop::die "Unknown subcommand#{' ' + sub.inspect if sub}"
 end

data/bin/crab-testcase-add

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+
+story_id = ARGV.shift
+unless story_id
+  $stderr.puts "Error: Story ID not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+name = ARGV.join(" ")
+unless name
+  $stderr.puts "Error: Test case name not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  tc = rally.create_test_case(story_id, name, sanitize_options(opts))
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+end

data/bin/crab-testcase-create

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+
+story_id = ARGV.shift
+unless story_id
+  $stderr.puts "Error: Story ID not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+name = ARGV.join(" ")
+unless name
+  $stderr.puts "Error: Test case name not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  tc = rally.create_test_case(story_id, name, sanitize_options(opts))
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+end

data/bin/crab-testcase-delete

@@ -0,0 +1,13 @@
+# vim: set ft=ruby :
+require 'crab'
+
+Trollop::options do
+  banner "crab testcase delete: delete a test case in Rally"
+end
+
+tc_id = ARGV.shift
+Crab::Rally.new do |rally|
+  tc = rally.find_test_case(tc_id)
+  tc.delete
+  puts "Test case #{tc_id} deleted."
+end

data/bin/crab-testcase-help

@@ -0,0 +1,10 @@
+# vim: set ft=ruby :
+require 'crab'
+
+puts <<-HELP
+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]
+HELP

data/bin/crab-testcase-list

@@ -0,0 +1,24 @@
+# vim: set ft=ruby :
+require 'crab'
+
+opts = Trollop::options do
+  banner <<-BANNER
+crab testcase list: displays all testcases in Rally in a story as Cucumber scenarios
+
+Usage: crab testcase list <story> [options]"
+  BANNER
+  opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
+end
+
+id = ARGV.shift
+unless id
+  $stderr.puts "Error: No story ID provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  story = rally.find_story_with_id id
+
+  puts Array(story.scenarios).map {|scenario| Crab::CucumberScenario.new(opts[:language]).generate_from scenario }.join.strip
+end

data/bin/crab-testcase-ls

@@ -0,0 +1,24 @@
+# vim: set ft=ruby :
+require 'crab'
+
+opts = Trollop::options do
+  banner <<-BANNER
+crab testcase list: displays all testcases in Rally in a story as Cucumber scenarios
+
+Usage: crab testcase list <story> [options]"
+  BANNER
+  opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
+end
+
+id = ARGV.shift
+unless id
+  $stderr.puts "Error: No story ID provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  story = rally.find_story_with_id id
+
+  puts Array(story.scenarios).map {|scenario| Crab::CucumberScenario.new(opts[:language]).generate_from scenario }.join.strip
+end

data/bin/crab-testcase-new

@@ -0,0 +1,25 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options "crab testcase add: add a test case to a story in Rally"
+
+story_id = ARGV.shift
+unless story_id
+  $stderr.puts "Error: Story ID not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+name = ARGV.join(" ")
+unless name
+  $stderr.puts "Error: Test case name not provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  tc = rally.create_test_case(story_id, name, sanitize_options(opts))
+  puts "#{tc.story.formatted_id}/#{tc.formatted_id}: #{tc.name} (#{tc.tags.join(" ")})"
+end

data/bin/crab-testcase-rm

@@ -0,0 +1,13 @@
+# vim: set ft=ruby :
+require 'crab'
+
+Trollop::options do
+  banner "crab testcase delete: delete a test case in Rally"
+end
+
+tc_id = ARGV.shift
+Crab::Rally.new do |rally|
+  tc = rally.find_test_case(tc_id)
+  tc.delete
+  puts "Test case #{tc_id} deleted."
+end

data/bin/crab-testcase-show

@@ -0,0 +1,23 @@
+# vim: set ft=ruby :
+require 'crab'
+
+opts = Trollop::options do
+  banner <<-BANNER
+crab testcase show: displays a testcase in Rally as a Cucumber scenario
+
+Usage: crab testcase show <testcase> [options]"
+  BANNER
+  opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
+end
+
+id = ARGV.shift
+unless id
+  $stderr.puts "Error: No test case ID provided."
+  system "crab-testcase-help"
+  exit 1
+end
+
+Crab::Rally.new do |rally|
+  tc = rally.find_test_case id
+  puts Crab::CucumberScenario.new(opts[:language]).generate_from(tc).strip
+end

data/bin/crab-testcase-update

@@ -0,0 +1,14 @@
+# vim: set ft=ruby :
+require 'crab'
+
+include Crab::Utilities
+
+opts = add_or_update_options "crab testcase update: update a test case in Rally"
+
+tc_id = ARGV.shift
+
+Crab::Rally.new do |rally|
+  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(" ")})"
+end

data/lib/crab/utilities.rb

@@ -40,5 +40,32 @@ module Crab
       Crab::Story::VALID_STATES[i >= max ? max -1 : i]
     end
 
+    # TODO REFACTOR testcase related stuff that didn't have a good home
+    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
+
+    # TODO REFACTOR testcase related stuff that didn't have a good home
+    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
+
   end
 end

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Carlos Villela
@@ -156,9 +156,12 @@ executables:
 - crab-delete
 - crab-find
 - crab-help
+- crab-list
 - crab-login
+- crab-ls
 - crab-move
 - crab-mv
+- crab-new
 - crab-project
 - crab-pull
 - crab-remove
@@ -166,6 +169,16 @@ executables:
 - crab-show
 - crab-tc
 - crab-testcase
+- crab-testcase-add
+- crab-testcase-create
+- crab-testcase-delete
+- crab-testcase-help
+- crab-testcase-list
+- crab-testcase-ls
+- crab-testcase-new
+- crab-testcase-rm
+- crab-testcase-show
+- crab-testcase-update
 - crab-truncate
 - crab-up
 - crab-update
@@ -188,9 +201,12 @@ files:
 - bin/crab-delete
 - bin/crab-find
 - bin/crab-help
+- bin/crab-list
 - bin/crab-login
+- bin/crab-ls
 - bin/crab-move
 - bin/crab-mv
+- bin/crab-new
 - bin/crab-project
 - bin/crab-pull
 - bin/crab-remove
@@ -198,6 +214,16 @@ files:
 - bin/crab-show
 - bin/crab-tc
 - bin/crab-testcase
+- bin/crab-testcase-add
+- bin/crab-testcase-create
+- bin/crab-testcase-delete
+- bin/crab-testcase-help
+- bin/crab-testcase-list
+- bin/crab-testcase-ls
+- bin/crab-testcase-new
+- bin/crab-testcase-rm
+- bin/crab-testcase-show
+- bin/crab-testcase-update
 - bin/crab-truncate
 - bin/crab-up
 - bin/crab-update