crab 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp
+.rally_credentials
+tags

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ree@rally-cucumber-bridge

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in crab.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => :features
+

data/bin/crab

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'crab'
+
+Crab::CLI.start

data/crab.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "crab/version"
+
+Gem::Specification.new do |s|
+  s.name        = "crab"
+  s.version     = Crab::VERSION
+  s.authors     = ["Carlos Villela"]
+  s.email       = ["cvillela@thoughtworks.com"]
+  s.homepage    = ""
+  s.summary     = %q{Cucumber-Rally Bridge}
+  s.description = %q{CRaB is a bridge between Cucumber and Rally}
+
+  s.rubyforge_project = "crab"
+
+  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.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'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'i18n'
+  s.add_dependency 'sanitize'
+  s.add_dependency 'trollop'
+end

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

@@ -0,0 +1,31 @@
+Feature: Find Text in Stories
+
+  In order to find the story ID
+  A lazy developer
+  Wants to search for arbitrary bits of text
+
+  Background:
+    Given I am logged in
+    And I have selected the project "VEJA SP - Migração para o Alexandria"
+
+  Scenario: Matching Name
+    When I run `crab find Sample Crab`
+    Then the output should contain:
+    """
+US4988: Sample Crab Story (grooming)
+US4999: Sample Crab Parent Story (grooming)
+US5000: Sample Crab Parent Story (grooming)
+    """
+
+  @quick
+  Scenario: Project Must be Specified If Not Set
+    Given no project is selected
+    When I run `crab find pattern`
+    Then the output should contain "Error: argument --project must be specified."
+
+  Scenario: Project Must Exist
+    When I run `crab find --project "foo" pattern`
+    Then the output should contain:
+    """
+    Error: Project "foo" not found.
+    """

data/features/list-from-rally.feature

@@ -0,0 +1,27 @@
+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/features/login-and-out-of-rally.feature

@@ -0,0 +1,14 @@
+Feature: Log In and Out of Rally
+
+  In order to avoid typing his credentials all the time
+  A lazy and security-conscious developer
+  Wants to log in and out of Rally in order to perform operations
+
+  Scenario: Logged Out, Logging In
+    Given I am logged out
+    When I run `crab login` interactively
+    And I type my username
+    And I type my password
+    Then the exit status should be 0
+    And the user's home directory should have a file named ".rally_credentials"
+

data/features/project-selection.feature

@@ -0,0 +1,27 @@
+Feature: Project Selection
+
+  In order to work with the find, list etc commands more effectively
+  A lazy developer
+  Wants to set the project persistently across all commands
+
+  Background:
+    Given I am logged in
+
+  Scenario: Selecting a Project
+    Given no project is selected
+
+    When I run `crab project`
+    Then the output should contain "No project currently selected."
+
+    When I run `crab project "VEJA SP - Migração para o Alexandria"`
+    Then the exit status should be 0
+
+    When I run `crab project`
+    Then the output should contain "VEJA SP - Migração para o Alexandria"
+
+  Scenario: Selecting an Invalid Project
+    When I run `crab project "invalid"`
+    Then the output should contain:
+    """
+    Error: "invalid" is not a valid project.
+    """

data/features/pull-from-rally-into-cucumber.feature

@@ -0,0 +1,28 @@
+Feature: Pull From Rally Into Cucumber
+
+  In order to begin development of a story that was written in Rally
+  A developer who doesn't want to open a browser or click things
+  Wants the story converted into the much nicer Cucumber format
+
+  Background:
+    Given I am logged in
+
+  Scenario: Pulling a Single Story
+    Given a directory named "crab-pull"
+    And I cd to "crab-pull"
+    When I run `crab pull US4988`
+    Then the output should contain "US4988: features/grooming/US4988-sample-crab-story.feature"
+    And a directory named "features" should exist
+    And a file named "features/grooming/US4988-sample-crab-story.feature" should exist
+    And the file "features/grooming/US4988-sample-crab-story.feature" should contain exactly:
+    """
+Feature: [US4988] Sample Crab Story
+
+Sample Description
+    """
+
+  Scenario: Pulling Multiple Stories
+    When I run `crab pull US4988 US5000`
+    Then the output should contain "US4988: features/grooming/US4988-sample-crab-story.feature"
+    Then the output should contain "US5000: features/grooming/US5000-sample-crab-parent-story.feature"
+

data/features/show-from-rally.feature

@@ -0,0 +1,25 @@
+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:
+    Given I am logged in
+
+  Scenario: Show Simple Story
+    When I run `crab show US4988`
+    Then the output should contain:
+    """
+Feature: [US4988] Sample Crab Story
+
+Sample Description
+    """
+
+  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 "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"
+     And the output should contain "  Then I should be able to export them into Cucumber format"

data/features/steps/rally_steps.rb

@@ -0,0 +1,94 @@
+require 'rally_rest_api'
+
+Given /^I am logged out$/ do
+end
+
+Given /^an instance of Rally$/ do
+end
+
+Given /^Rally has a story with ID "([^"]*)"$/ do |arg1|
+end
+
+Then /^the user's home directory should have a file named "([^"]*)"$/ do |file|
+  File.exists? File.expand_path("~/#{file}")
+end
+
+def get_rally_credentials
+  username, password = File.read(File.join(File.dirname(__FILE__), '..', '..', '.rally_credentials')).split(/\n/)
+  [ username, password ]
+end
+
+When /^I type my username$/ do
+  When %Q{I type "#{get_rally_credentials.first}"}
+end
+
+When /^I type my password$/ do
+  When %Q{I type "#{get_rally_credentials.last}"}
+end
+
+Given /^I am logged in$/ do
+  username, password = get_rally_credentials
+  steps %Q{
+    Given I am logged out
+    When I run `crab login -u #{username} -p #{password}`
+    Then the output should contain "Logged in as #{username}"
+  }
+end
+
+Then /^a file named "([^"]*)" in the user's home directory should exist$/ do |arg1|
+  pending # express the regexp above with the code you wish you had
+end
+
+def get_rally
+  username, password = get_rally_credentials
+  @rally = RallyRestAPI.new :username => username, :password => password
+end
+
+def get_story(story_id)
+  get_rally.find(:hierarchical_requirement, :fetch => true) { equal :formatted_i_d, story_id }.first
+end
+
+Then /^the story ([A-Z]{2}\d+) should be blocked$/ do |story_id|
+  story = get_story(story_id)
+  story.blocked.should == "true"
+end
+
+Then /^the story ([A-Z]{2}\d+) should be unblocked$/ do |story_id|
+  story = get_story(story_id)
+  story.blocked.should == "false"
+end
+
+Then /^the story ([A-Z]{2}\d+) should be in iteration "([^"]*)"$/ do |story_id, iteration_name|
+  story = get_story story_id
+  story.iteration.name.should == iteration_name
+end
+
+Then /^the story ([A-Z]{2}\d+) should be in release "([^"]*)"$/ do |story_id, release_name|
+  story = get_story story_id
+  story.release.name.should == release_name
+end
+
+Then /^the story ([A-Z]{2}\d+) should have ([A-Z]{2}\d+) as its parent$/ do |child, parent|
+  story = get_story child
+  story.parent.should_not be_nil
+  story.parent.formatted_i_d.should == parent
+end
+
+Given /^no project is selected$/ do
+  Given 'I run `rm -rf ".rally_project"`'
+end
+
+def get_project
+  if File.exists? ".rally_project"
+    File.read(".rally_project").strip
+  end
+end
+
+Given /^I have selected the project "([^"]*)"$/ do |project|
+  unless get_project == project
+    steps %Q{
+      When I run `crab project #{project}`
+      Then the exit status should be 0
+    }
+  end
+end

data/features/subcommand-help.feature

@@ -0,0 +1,84 @@
+@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
+
+  Scenario: No Arguments
+    When I run `crab`
+    Then the output should contain "Error: Unknown subcommand."
+
+  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"
+     And the output should contain "  pull    Downloads stories (and its test cases) as Cucumber feature files"
+
+  Scenario: Bogus Subcommand
+    When I run `crab bogus`
+    Then the output should contain:
+    """
+Error: Unknown subcommand "bogus".
+    """
+
+  Scenario: Pull Subcommand
+    When I run `crab pull --help`
+    Then the output should contain:
+    """
+crab pull: pulls stories from Rally and writes them out as Cucumber features
+
+Usage: crab [options] pull story1 [story2 ...]
+    """
+
+  Scenario: Show Subcommand
+    When I run `crab show --help`
+    Then the output should contain:
+    """
+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:
+    """
+crab update: update a story in Rally
+
+Usage: crab [options] update story [options]
+    """
+
+  Scenario: Update Needs a Story Number
+    When I run `crab update`
+    Then the output should contain "Error: No story given."
+
+  Scenario: Update Needs At Least One Switch
+    When I run `crab update US4988`
+    Then the output should contain "Error: Nothing to update. Please provide some options."
+
+  Scenario: Find Subcommand
+    When I run `crab find --help`
+    Then the output should contain:
+    """
+crab find: find a story in Rally
+
+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

@@ -0,0 +1,14 @@
+require 'aruba'
+require 'aruba/cucumber'
+
+Before '@quick' do
+  @aruba_io_wait_seconds = 1
+end
+
+Before '~@quick' do
+  @aruba_io_wait_seconds = 5
+end
+
+Before '@really-slow' do
+  @aruba_io_wait_seconds = 30
+end

data/features/update-story-in-rally.feature

@@ -0,0 +1,33 @@
+Feature: Update Story in Rally
+
+  In order to change a story's fields in Rally
+  A developer who doesn't want to open a browser or click on things
+  Wants to update those fields from the command line
+
+  Background:
+    Given I am logged in
+
+  Scenario: Update Name
+    When I run `crab update US4988 --name "Sample Crab Story"`
+    Then the output should contain "US4988: Sample Crab Story (grooming)"
+
+  Scenario: Block and Unblock
+    When I run `crab update US4988 --blocked`
+    Then the output should contain "US4988: Sample Crab Story (grooming)"
+    And the story US4988 should be blocked
+
+    When I run `crab update US4988 --unblocked`
+    Then the output should contain "US4988: Sample Crab Story (grooming)"
+    And the story US4988 should be unblocked
+
+  Scenario: Setting Iteration
+    When I run `crab update US4988 --iteration "Iteration 0"`
+    Then the story US4988 should be in iteration "Iteration 0"
+
+  Scenario: Setting Release
+    When I run `crab update US4988 --release "Beta release"`
+    Then the story US4988 should be in release "Beta release"
+
+  Scenario: Setting Parent
+    When I run `crab update US4988 --parent US5000`
+    Then the story US4988 should have US5000 as its parent