crab 0.1.0

data/lib/crab.rb

@@ -0,0 +1,19 @@
+require "crab/version"
+
+require "crab/utilities"
+require "crab/rally"
+require "crab/story"
+require "crab/cli"
+require "crab/pull"
+require "crab/login"
+require "crab/list"
+require "crab/find"
+require "crab/update"
+require "crab/show"
+require "crab/scenario"
+require "crab/project"
+require "crab/cucumber_feature"
+require "crab/cucumber_scenario"
+
+module Crab
+end

data/lib/crab/cli.rb

@@ -0,0 +1,112 @@
+require 'trollop'
+
+module Crab
+
+  SUB_COMMANDS = %w(pull login list update show find project)
+
+  class CLI
+    def self.start
+      global_opts = Trollop::options do
+        version "crab version #{Crab::VERSION}"
+        banner """
+crab version #{Crab::VERSION}: A Cucumber-Rally bridge
+
+  login   Persistently authenticate user with Rally
+  project Persistently select project to work with in Rally
+  list    Lists stories
+  update  Update a story (name, estimate, etc)
+  show    Show a story (and its test cases) as a Cucumber feature
+  pull    Downloads stories (and its test cases) as Cucumber feature files
+  find    Find stories by text in name, description or notes
+        """
+        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 ...]"
+        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"
+        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 "list"
+        cmd_opts = Trollop::options do
+          banner "crab list: lists stories in Rally
+
+Usage: crab [options] list"
+          opt :pagesize, "Number of items to fetch per page", :short => "-s", :default => 100
+          opt :project, "Project to use (required unless set by 'crab project')", :short => "-p", :type => String
+        end
+
+        Crab::List.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
+
+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
+
+      else
+        if cmd
+          Trollop::die "Unknown subcommand #{cmd.inspect}"
+        else
+          Trollop::die "Unknown subcommand"
+        end
+      end
+    end
+  end
+end

data/lib/crab/cucumber_feature.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+
+module Crab
+
+  class CucumberFeature
+    def generate_from(story)
+      text = <<-FEATURE
+Feature: [#{story.formatted_id}] #{story.name}
+
+#{story.description}
+
+#{Array(story.scenarios).map {|scenario| CucumberScenario.new.generate_from scenario }}
+FEATURE
+      text.strip
+    end
+  end
+end

data/lib/crab/cucumber_scenario.rb

@@ -0,0 +1,11 @@
+module Crab
+  class CucumberScenario
+    def generate_from(scenario)
+      return <<-SCENARIO
+
+Scenario: [#{scenario.formatted_id}] #{scenario.name}
+  #{scenario.steps.join("\n  ")}
+      SCENARIO
+    end
+  end
+end

data/lib/crab/find.rb

@@ -0,0 +1,30 @@
+module Crab
+  class Find
+
+    include Utilities
+
+    def initialize(global_opts, cmd_opts, args)
+      @global_opts = global_opts
+      @cmd_opts = cmd_opts
+      @args = args
+      @rally = Rally.new
+    end
+
+    def run
+      pattern = @args.map(&:strip).reject(&:empty?)
+      Trollop::die "No search pattern given" if pattern.empty?
+
+      project_name = valid_project_name(@cmd_opts)
+
+      @rally.connect
+
+      project = @rally.find_project(project_name)
+
+      Trollop::die "Project #{@cmd_opts[:project].inspect} not found" if project.nil?
+
+      @rally.find_story(project, pattern).each do |story|
+        puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+      end
+    end
+  end
+end

data/lib/crab/list.rb

@@ -0,0 +1,29 @@
+module Crab
+  class List
+
+    include Utilities
+
+    def initialize(global_opts, cmd_opts)
+      @global_opts = global_opts
+      @cmd_opts = cmd_opts
+      @rally = Rally.new
+    end
+
+    def run
+      @rally.connect
+
+      project_name = valid_project_name(@cmd_opts)
+
+      opts = {
+        :pagesize => @cmd_opts[:pagesize],
+        :project  => @rally.find_project(project_name),
+      }
+
+      Trollop::die "Project #{@cmd_opts[:project].inspect} not found" if opts[:project].nil?
+
+      @rally.find_all_stories(opts).each do |story|
+        puts "#{story.formatted_id}: #{story.name} (#{story.state})"
+      end
+    end
+  end
+end

data/lib/crab/login.rb

@@ -0,0 +1,25 @@
+require 'highline/import'
+
+module Crab
+  class Login
+
+    include Utilities
+
+    def initialize(global_opts, cmd_opts)
+      @global_opts = global_opts
+      @cmd_opts = cmd_opts
+    end
+
+    def run
+      username = @cmd_opts[:username_given] ? @cmd_opts[:username] : ask("Username: ")
+      password = @cmd_opts[:password_given] ? @cmd_opts[:password] : ask("Password: ") {|q| q.echo = false }
+
+      File.open(credentials_file, 'w') do |file|
+        file.puts username
+        file.puts password
+      end
+
+      puts "Logged in as #{username}"
+    end
+  end
+end

data/lib/crab/project.rb

@@ -0,0 +1,39 @@
+module Crab
+  class Project
+
+    def self.current_project_name
+      if File.exists? ".rally_project"
+        File.read(".rally_project").strip
+      end
+    end
+
+    def initialize(global_opts, cmd_opts, args)
+      @global_opts = global_opts
+      @cmd_opts = cmd_opts
+      @args = args
+      @rally = Rally.new
+    end
+
+    def run
+      current_project_name = self.class.current_project_name
+      if current_project_name.present?
+        puts current_project_name
+
+      elsif @args.reject {|arg| arg.blank? }.empty?
+        puts "No project currently selected."
+
+      else
+        name = @args.join(" ").strip
+
+        @rally.connect
+
+        project = @rally.find_project name
+        Trollop::die "#{name.inspect} is not a valid project" if project.nil?
+
+        File.open(".rally_project", "w") do |file|
+          file.puts project.name
+        end
+      end
+    end
+  end
+end

data/lib/crab/pull.rb

@@ -0,0 +1,32 @@
+require 'active_support/all'
+
+module Crab
+
+  class Pull
+
+    def initialize(global_options, pull_options, story_numbers)
+      @global_options = global_options
+      @pull_options = pull_options
+      @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.generate_from story
+        end
+      end
+    end
+  end
+end

data/lib/crab/rally.rb

@@ -0,0 +1,50 @@
+require 'rally_rest_api'
+
+module Crab
+  class Rally
+
+    include Utilities
+
+    def connect
+      get_credentials
+      @rally = ::RallyRestAPI.new :username => @username, :password => @password
+    end
+
+    def get_credentials
+      @username, @password = File.read(valid_credentials_file).split /\n/
+    end
+
+    def find_story_with_id story_id
+      Crab::Story.new @rally.find(:hierarchical_requirement) { equal :formatted_i_d, story_id }.first
+    end
+
+    def find_all_stories(opts={})
+      @rally.find_all(:hierarchical_requirement, {:fetch => true}.merge(opts)).map {|s| Crab::Story.new s }
+    end
+
+    def find_story(project, pattern)
+      @rally.find(:hierarchical_requirement, :fetch => true, :project => project) {
+        pattern.each do |word|
+          _or_ {
+            contains :name, word
+            contains :description, word
+            contains :notes, word
+          }
+        end
+      }.map {|s| Crab::Story.new s }
+    end
+
+    def find_project(name)
+      @rally.find(:project, :fetch => true) { equal :name, name }.first
+    end
+
+    def find_iteration_by_name(name)
+      @rally.find(:iteration) { equal :name, name }.first
+    end
+
+    def find_release_by_name(name)
+      @rally.find(:release) { equal :name, name }.first
+    end
+
+  end
+end

data/lib/crab/scenario.rb

@@ -0,0 +1,23 @@
+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
+
+  end
+
+end

data/lib/crab/show.rb

@@ -0,0 +1,17 @@
+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.generate_from story
+    end
+  end
+end

data/lib/crab/story.rb

@@ -0,0 +1,63 @@
+require 'sanitize'
+
+module Crab
+
+  class Story
+
+    VALID_STATES = %w{Grooming Defined In-Progress Completed Accepted Released}
+
+    def initialize(rally_story)
+      @rally_story = rally_story
+    end
+
+    def name
+      @rally_story.name
+    end
+
+    def file_name
+      "#{formatted_id}-#{name.parameterize.dasherize}.feature"
+    end
+
+    def full_file_name
+      "features/#{state}/#{file_name}"
+    end
+
+    def formatted_id
+      @rally_story.formatted_i_d
+    end
+
+    def state
+      (@rally_story.schedule_state || "unknown").parameterize.underscore
+    end
+
+    def description
+      # this could use a lot of rethinking :(
+      # biggest problem is that Cucumber breaks if text in description looks like something
+      # it might know how to parse, but doesn't
+      # our feature descriptions are quite like that, so I was being ultra-conservative
+      sanitize(@rally_story.description || '').gsub(/  +/, "\n").gsub(/\n\n/, "\n").gsub(/\n/, "\n  ")
+    end
+
+    def scenarios
+      Array(@rally_story.test_cases).map {|tc| Scenario.new tc }
+    end
+
+    def update(opts)
+      @rally_story.update opts
+    end
+
+    def rally_object
+      @rally_story
+    end
+
+    private
+
+    # took a while to figure out that we need to remove the CSS from inside embedded <style> tags!
+    # Rally uses some crazy rich text editor that I'd be soooooo happy to disable, somehow. Chrome Extension, perhaps?
+    def sanitize(source)
+      Sanitize.clean source, :remove_contents => %w{style}
+    end
+
+  end
+
+end