crab 0.1.4 → 0.1.5

data/README.md

@@ -124,7 +124,6 @@ To do
 -----
 
 - Add a config command + .crab/config file to hold settings like project, etc
-- 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

data/features/find-text-in-stories.feature

@@ -1,10 +1,10 @@
 Feature: Find Text in Stories
-  
+
   In order to find the story ID
   A lazy developer
   Wants to search for arbitrary bits of text
 
-  Background: 
+  Background:
     Given I am logged in
     And I have selected my test project
 
@@ -13,7 +13,6 @@ Feature: Find Text in Stories
     Then the output should contain:
       """
       US4988: Sample Crab Story (grooming)
-      US4999: Sample Crab Parent Story (grooming)
       US5000: Sample Crab Parent Story (grooming)
       """
 

data/features/subcommand-help.feature

@@ -1,6 +1,6 @@
 @quick
 Feature: Subcommand Help
-  
+
   In order to learn how to use crab
   A newbie developer
   Wants to see a useful help message when she runs crab with the wrong arguments
@@ -11,14 +11,15 @@ 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 "  update  Update a story (name, estimate, etc)"
+    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)"
 
   Scenario: Bogus Subcommand
     When I run `crab bogus`
@@ -63,6 +64,13 @@ Feature: Subcommand Help
       Usage: crab [options] 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]"
+
   Scenario: Update Subcommand
     When I run `crab update --help`
     Then the output should contain:

data/lib/crab.rb

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

data/lib/crab/cli.rb

@@ -1,8 +1,6 @@
-require 'trollop'
-
 module Crab
 
-  SUB_COMMANDS = %w(pull login list update show find project create delete)
+  SUB_COMMANDS = %w(pull login list update show find project create delete testcase)
 
   class CLI
     def self.start
@@ -11,112 +9,24 @@ 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
-  update  Update a story (name, estimate, etc)
+  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)
         """
         stop_on SUB_COMMANDS
       end
 
       cmd = ARGV.shift # get the subcommand
-      case cmd
-      when "pull" # parse delete options
-        cmd_opts = Trollop::options do
-          banner "crab pull: pulls stories from Rally and writes them out as Cucumber features
-
-Usage: crab [options] pull story1 [story2 ...]"
-        opt :language, "Language to generate Cucumber features in (ISO code)", :default => "en", :short => "-l"
-        end
-
-        Crab::Pull.new(global_opts, cmd_opts, ARGV).run
-
-      when "show"
-        cmd_opts = Trollop::options do
-          banner "crab show: displays a story in Rally as a Cucumber feature
-
-Usage: crab [options] show story"
-        opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
-        end
-
-        Crab::Show.new(global_opts, cmd_opts, ARGV).run
-
-      when "login"
-        cmd_opts = Trollop::options do
-          banner "crab login: logs into Rally
-
-Usage: crab [options] login"
-          opt :username, "Username", :type => String, :short => "-u"
-          opt :password, "Password", :type => String, :short => "-p"
-        end
-
-        Crab::Login.new(global_opts, cmd_opts).run
-
-      when "update"
-        cmd_opts = Trollop::options do
-          banner "crab update: update a story in Rally
-
-Usage: crab [options] update story [options]"
-          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
-
-        Crab::Update.new(global_opts, cmd_opts, ARGV).run
-
-      when "find"
-        cmd_opts = Trollop::options do
-          banner "crab find: find a story in Rally
+      Trollop::die "Unknown subcommand" unless cmd
+      Trollop::die "Unknown subcommand #{cmd.inspect}" unless Crab::Commands.const_defined? cmd.capitalize
 
-Usage: crab [options] find [options] [text]"
-          opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
-        end
-
-        Crab::Find.new(global_opts, cmd_opts, ARGV).run
-
-      when "project"
-        cmd_opts = Trollop::options do
-          banner "crab project: persistently select project to work with in Rally
-
-Usage: crab [options] project name"
-        end
-
-        Crab::Project.new(global_opts, cmd_opts, ARGV).run
-
-      when "create"
-        cmd_opts = Trollop::options do
-          banner "crab create: create a new story in Rally
-
-Usage: crab [options] create name [options]"
-        end
-
-        Crab::Create.new(global_opts, cmd_opts, ARGV).run
-
-      when "delete"
-        cmd_opts = Trollop::options do
-          banner "crab delete: delete an existing story in Rally
-
-Usage: crab [options] delete story [options]"
-        end
-
-        Crab::Delete.new(global_opts, cmd_opts, ARGV).run
-
-      else
-        if cmd
-          Trollop::die "Unknown subcommand #{cmd.inspect}"
-        else
-          Trollop::die "Unknown subcommand"
-        end
-      end
+      Crab::Commands.const_get(cmd.capitalize).new(global_opts, ARGV).run
     end
   end
 end

data/lib/crab/{create.rb → commands/create.rb}

@@ -1,12 +1,16 @@
-module Crab
+module Crab::Commands
 
   class Create
 
-    def initialize(global_opts, cmd_opts, args)
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
       @args = args
-      @rally = Rally.new
+      @cmd_opts = Trollop::options do
+        banner "crab create: create a new story in Rally
+
+Usage: crab [options] create name [options]"
+      end
+      @rally = Crab::Rally.new
     end
 
     def run

data/lib/crab/{delete.rb → commands/delete.rb}

@@ -1,12 +1,18 @@
-module Crab
+module Crab::Commands
 
   class Delete
 
-    def initialize(global_opts, cmd_opts, args)
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
       @args = args
-      @rally = Rally.new
+
+      @cmd_opts = Trollop::options do
+        banner "crab delete: delete an existing story in Rally
+
+Usage: crab [options] delete story [options]"
+      end
+
+      @rally = Crab::Rally.new
     end
 
     def run

data/lib/crab/{find.rb → commands/find.rb}

@@ -1,13 +1,21 @@
-module Crab
+module Crab::Commands
+
   class Find
 
-    include Utilities
+    include Crab::Utilities
 
-    def initialize(global_opts, cmd_opts, args)
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
       @args = args
-      @rally = Rally.new
+
+      @cmd_opts = Trollop::options do
+        banner "crab find: find a story in Rally
+
+Usage: crab [options] find [options] [text]"
+        opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+      end
+
+      @rally = Crab::Rally.new
     end
 
     def run

data/lib/crab/{login.rb → commands/login.rb}

@@ -1,13 +1,18 @@
-require 'highline/import'
+module Crab::Commands
 
-module Crab
   class Login
 
-    include Utilities
+    include Crab::Utilities
 
-    def initialize(global_opts, cmd_opts)
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
+      @cmd_opts = Trollop::options do
+        banner "crab login: logs into Rally
+
+Usage: crab [options] login"
+        opt :username, "Username", :type => String, :short => "-u"
+        opt :password, "Password", :type => String, :short => "-p"
+      end
     end
 
     def run

data/lib/crab/{project.rb → commands/project.rb}

@@ -1,4 +1,4 @@
-module Crab
+module Crab::Commands
   class Project
 
     def self.current_project_name
@@ -7,11 +7,17 @@ module Crab
       end
     end
 
-    def initialize(global_opts, cmd_opts, args)
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
       @args = args
-      @rally = Rally.new
+
+      @cmd_opts = Trollop::options do
+        banner "crab project: persistently select project to work with in Rally
+
+Usage: crab [options] project name"
+      end
+
+      @rally = Crab::Rally.new
     end
 
     def run

data/lib/crab/commands/pull.rb

@@ -0,0 +1,37 @@
+module Crab::Commands
+
+  class Pull
+
+    def initialize(global_opts, args)
+      @global_opts = global_opts
+      @story_numbers = args
+
+      @cmd_opts = Trollop::options do
+        banner "crab pull: pulls stories from Rally and writes them out as Cucumber features
+
+Usage: crab [options] pull story1 [story2 ...]"
+        opt :language, "Language to generate Cucumber features in (ISO code)", :default => "en", :short => "-l"
+      end
+
+      @rally = Crab::Rally.new
+    end
+
+    def run
+      @rally.connect
+
+      @story_numbers.each do |story_number|
+        story = @rally.find_story_with_id story_number
+        Trollop::die "Could not find story with ID #{story_number}" if story.nil?
+
+        puts "#{story.formatted_id}: #{story.full_file_name}"
+
+        FileUtils.mkdir_p File.dirname(story.full_file_name)
+        FileUtils.touch story.full_file_name
+
+        File.open(story.full_file_name, "w") do |file|
+          file.write Crab::CucumberFeature.new(@cmd_opts[:language]).generate_from story
+        end
+      end
+    end
+  end
+end

data/lib/crab/commands/show.rb

@@ -0,0 +1,25 @@
+module Crab::Commands
+
+  class Show
+    def initialize(global_opts, args)
+      @global_opts = global_opts
+      @cmd_opts = Trollop::options do
+        banner "crab show: displays a story in Rally as a Cucumber feature
+
+Usage: crab [options] show story"
+        opt :language, "Language to display Cucumber features in (ISO code)", :default => "en", :short => "-l"
+      end
+
+      @story_id = args.first
+      @rally = Crab::Rally.new
+    end
+
+    def run
+      @rally.connect
+
+      story = @rally.find_story_with_id @story_id
+
+      puts Crab::CucumberFeature.new(@cmd_opts[:language]).generate_from story
+    end
+  end
+end

data/lib/crab/commands/testcase.rb

@@ -0,0 +1,20 @@
+module Crab::Commands
+
+  class Testcase
+
+    def initialize(global_opts, args)
+      @global_opts = global_opts
+      @args = args
+      @cmd_opts = Trollop::options do
+        banner "crab testcase: manage test cases in a story (add, update, delete)
+
+Usage: crab [options] testcase add story name [options]
+       crab [options] testcase update testcase [options]
+       crab [options] testcase delete testcase [options]"
+      end
+    end
+
+    def run
+    end
+  end
+end

data/lib/crab/{update.rb → commands/update.rb}

@@ -1,11 +1,26 @@
-module Crab
+module Crab::Commands
+
   class Update
-    def initialize(global_opts, cmd_opts, args)
+
+    def initialize(global_opts, args)
       @global_opts = global_opts
-      @cmd_opts = cmd_opts
       @args = args
 
-      @rally = Rally.new
+      @cmd_opts = Trollop::options do
+        banner "crab update: update a story in Rally
+
+Usage: crab [options] update story [options]"
+        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
     end
 
     def run

data/lib/crab/cucumber_feature.rb

@@ -1,6 +1,3 @@
-require 'fileutils'
-require 'gherkin/i18n'
-
 module Crab
 
   class CucumberFeature

data/lib/crab/rally.rb

@@ -1,5 +1,3 @@
-require 'rally_rest_api'
-
 module Crab
   class Rally
 

data/lib/crab/story.rb

@@ -1,5 +1,3 @@
-require 'sanitize'
-
 module Crab
 
   class Story

data/lib/crab/utilities.rb

@@ -11,7 +11,7 @@ module Crab
     end
 
     def valid_project_name(cmd_opts)
-      project_name = cmd_opts[:project_given] ? cmd_opts[:project] : Crab::Project.current_project_name
+      project_name = cmd_opts[:project_given] ? cmd_opts[:project] : Crab::Commands::Project.current_project_name
       Trollop::die :project, "must be specified" if project_name.blank?
       project_name
     end

data/lib/crab/version.rb

@@ -1,3 +1,3 @@
 module Crab
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crab
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Carlos Villela
@@ -173,19 +173,20 @@ files:
 - features/update-story-in-rally.feature
 - lib/crab.rb
 - lib/crab/cli.rb
-- lib/crab/create.rb
+- lib/crab/commands/create.rb
+- lib/crab/commands/delete.rb
+- lib/crab/commands/find.rb
+- lib/crab/commands/login.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/delete.rb
-- lib/crab/find.rb
-- lib/crab/login.rb
-- lib/crab/project.rb
-- lib/crab/pull.rb
 - lib/crab/rally.rb
 - lib/crab/scenario.rb
-- lib/crab/show.rb
 - lib/crab/story.rb
-- lib/crab/update.rb
 - lib/crab/utilities.rb
 - lib/crab/version.rb
 has_rdoc: true

data/lib/crab/pull.rb

@@ -1,32 +0,0 @@
-require 'active_support/all'
-
-module Crab
-
-  class Pull
-
-    def initialize(global_opts, cmd_opts, story_numbers)
-      @global_opts = global_opts
-      @cmd_opts = cmd_opts
-      @story_numbers = story_numbers
-      @rally = Crab::Rally.new
-    end
-
-    def run
-      @rally.connect
-
-      @story_numbers.each do |story_number|
-        story = @rally.find_story_with_id story_number
-        Trollop::die "Could not find story with ID #{story_number}" if story.nil?
-
-        puts "#{story.formatted_id}: #{story.full_file_name}"
-
-        ::FileUtils.mkdir_p File.dirname(story.full_file_name)
-        ::FileUtils.touch story.full_file_name
-
-        File.open(story.full_file_name, "w") do |file|
-          file.write CucumberFeature.new(@cmd_opts[:language]).generate_from story
-        end
-      end
-    end
-  end
-end

data/lib/crab/show.rb

@@ -1,17 +0,0 @@
-module Crab
-  class Show
-    def initialize(global_opts, cmd_opts, args)
-      @global_opts = global_opts
-      @cmd_opts = cmd_opts
-      @story_id = args.first
-      @rally = Rally.new
-    end
-
-    def run
-      @rally.connect
-
-      story = @rally.find_story_with_id @story_id
-      puts CucumberFeature.new(@cmd_opts[:language]).generate_from story
-    end
-  end
-end