scrumninja-git-cli 0.0.2

data/lib/scrum_ninja_git_cli.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/env ruby
+require 'scrum_ninja'
+require 'git_wrapper'
+require 'pp'
+require 'forwardable'
+
+module ScrumNinjaGitCli
+  module_function
+
+  HelpText = <<-EOF
+
+  The 'story' command is used to support RF's normal release workflow.
+
+  Available commands:
+
+    [Can be run from any branch]
+      story
+      story list                        list all stories
+      story info 12345                  show only the one story
+      story xml 12345                   show full XML dump (from ScrumNinja API) for one story
+      story own 12345[, new_owner_id]   Set owner of the given story (defaults to value in .scrumninja.yml)
+      story git [any args]              Run the git command with the specified args (doesn't complain about env var)
+
+    [Must be run from master, with clean working state]
+      story start 12345                 Check out a story branch and change ownership [if not already set]
+      story join 12345                  Check out a story branch without trying to change ownership
+      story dev-task "some dev task"    Check out a dev-task branch (no ScrumNinja interaction)
+
+    [Must be run from story branch, with clean working state]
+      story push-branch                 git:  pull --rebase; push origin story_branch
+      story merge-from-master           git:  checkout master; pull; checkout story_branch; merge master
+      story deliver                     squash and merge your story branch into master, then push the result.
+                                        (DOES NOT update ScrumNinja.)
+
+  Configuration:
+
+    Information required to interact with ScrumNinja will be read from a
+    file named .scrumninja.yml.  The command will search for this file in
+    both the current dir and your home dir.  Values defined in ./.scrumninja.yml
+    will override those in ~/.scrumninja.yml.
+
+    Example YAML for this file:
+      api_key: abc123     # generate this at:  https://scrumninja.com/user/edit
+      project_id: 4493    # swipe this from the address bar
+      user_id: 4256       # edit a story card, view source, find element #story_owner_user_id
+
+  EOF
+
+  Messages = {
+    :git_version         => 'You must be running Git 1.7 or newer.',
+    :clean_working_state => 'Working state must be clean.',
+    :must_be_on_master   => "Branch 'master' must be checked out.",
+    :wrong_branch        => "Your story branch must be checked out.",
+    :rake_failure        => "Rake failed.  Aborting.",
+  }
+
+  # Simple command-line argument dispatching (see bottom of file)
+  def run_command(*args)
+    cmd = args.shift.to_s.gsub('-', '_')
+    send(cmd, *args)
+  rescue ArgumentError
+    help
+  end
+
+  # Commands
+  def help
+    output HelpText
+  end
+
+  def git(*args)
+    exec("export I_AM_A_GIT_GURU=1; git #{args.join(" ")}")
+  end
+
+  def list
+    stories = session.get_stories
+    output stories.map(&:to_s).join("\n")  # TODO: can we drop the #map?
+  end
+
+  def info(story_id)
+    output session.get_story(story_id)
+  end
+
+  def xml(story_id)
+    output session.get_story_xml(story_id)
+  end
+
+  def own(story_id, new_owner_id = nil, opts={})
+    session.update_ownership(story_id, new_owner_id, opts)
+  end
+
+
+  def join(story_id)
+    story = session.get_story(story_id)
+    start_work_on_branch story.branch_name
+  end
+
+  def start(story_id)
+    join story_id
+    own story_id, nil, :abort_if_already_owned => true
+  end
+
+  def dev_task(description)
+    start_work_on_branch('dev-' + GitWrapper.string_hyphenize(description))
+  end
+
+
+  def push_branch
+    git_wrapper.push_branch
+  rescue GitWrapper::WorkingFolderDirtyException
+    print_message :clean_working_state
+  end
+
+  def merge_from_master
+    git_wrapper.merge_from_master
+  rescue GitWrapper::WrongBranchException
+    print_message :wrong_branch
+  end
+
+  def deliver
+    if 'master' == git_wrapper.current_branch_name
+      output Messages[:wrong_branch] and return
+    end
+
+    git_wrapper.push_branch
+    git_wrapper.merge_from_master
+    return unless rake
+    git_wrapper.merge_branch_into_master
+    git_wrapper.push_master
+  end
+
+  def add(*args)
+    git_wrapper.add(args.join(" "))
+  end
+
+  def commit
+    commit_msg_parts = git_wrapper.current_branch_name \
+      .split('-').map(&:capitalize)
+    commit_msg_parts.unshift(commit_msg_parts.shift + ":") \
+      .unshift('Story')
+    commit_msg = commit_msg_parts.join(" ")
+    git_wrapper.commit(commit_msg)
+  end
+
+
+  # Support functions
+  def git_wrapper
+    GitWrapper
+  end
+
+  def session
+    @session ||= ScrumNinja::Session.new(:project_dir => RAILS_ROOT)
+  end
+
+  def print_message(message)
+    output Messages[message]
+  end
+
+  def output(*args)
+    puts *args
+    true
+  end
+
+  def rake
+    if 0 == ShellCmd.run('rake')
+      true
+    else
+      print_message :rake_failure
+      false
+    end
+  end
+
+  def start_work_on_branch(branch_name)
+    unless git_wrapper.is_git_current_enough?
+      output Messages[:git_version] and return
+    end
+
+    unless git_wrapper.is_state_clean?
+      output Messages[:clean_working_state] and return
+    end
+
+    unless 'master' == git_wrapper.current_branch_name
+      output Messages[:must_be_on_master] and return
+    end
+
+    git_wrapper.checkout(branch_name)
+  end
+end

data/lib/shell_cmd.rb

@@ -0,0 +1,16 @@
+module ShellCmd
+  module_function
+
+  # Run the command, displaying output as we get it,
+  # and return the process's result code.
+  # Used mostly to avoid http://xkcd.com/303/
+  def run(cmd)
+    IO.popen(cmd) do |output|
+      while c = output.getc do
+        print c.chr
+        STDOUT.flush
+      end
+    end
+    $?.to_i
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+
+class Test::Unit::TestCase
+  def deny(assertion, *args)
+    assert !assertion, *args
+  end
+end

data/test/scrum_ninja/test_scrum_ninja_server.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require 'scrum_ninja'
+
+
+class ScrumNinjaServerUnitTest < Test::Unit::TestCase
+  def setup
+    @api_key = 'abc123'
+  end
+
+  context "#get_story" do
+    should "call the API and return the response body" do
+      xml = "bogus XML response"
+      project_id, story_id = 23, 42
+      ScrumNinja::Server.expects(:get_page_contents) \
+                        .with("http://scrumninja.com/projects/#{project_id}/stories/#{story_id}.xml?api_key=#{@api_key}") \
+                        .returns(xml)
+      result = ScrumNinja::Server.get_story(@api_key, project_id, story_id)
+      assert_equal(xml, result)
+    end
+  end
+
+  context "#get_stories" do
+    should "call the API and return the response body" do
+      xml = "bogus XML response"
+      ScrumNinja::Server.expects(:get_page_contents) \
+                        .with("http://scrumninja.com/projects/42/stories.xml?api_key=#{@api_key}") \
+                        .returns(xml)
+      result = ScrumNinja::Server.get_stories(@api_key, 42)
+      assert_equal(xml, result)
+    end
+  end
+
+  context "#update_ownership" do
+    should "put XML to the API and (assuming success) shut up about it" do
+      project_id, story_id, xml = 23, 42, "bogus XML payload"
+      uri = "http://scrumninja.com/projects/#{project_id}/stories/#{story_id}.xml?api_key=#{@api_key}"
+      ScrumNinja::Server.expects(:post_xml).with(uri, xml).returns(true)
+      result = ScrumNinja::Server.update_story(@api_key, project_id, story_id, xml)
+      assert_equal(true, result)
+    end
+  end
+end

data/test/scrum_ninja/test_scrum_ninja_session.rb

@@ -0,0 +1,163 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require 'scrum_ninja'
+
+
+class ScrumNinjaSessionUnitTest < Test::Unit::TestCase
+  ConfigFile = '.scrumninja.yml'
+  HomePath   = File.expand_path('~')
+  ProjPath   = '~/work/pdxrails'
+
+  # Holler if we inadvertently try to touch the filesystem
+  def setup
+    ScrumNinja::Session.read_config_from_filesystem = false
+    YAML.expects(:load_file).never
+  end
+
+  context "class" do
+    should "have a #read_config_from_filesystem accessor" do
+      klass = ScrumNinja::Session
+      klass.read_config_from_filesystem = true
+      assert_equal(true, klass.read_config_from_filesystem)
+      klass.read_config_from_filesystem = false
+      assert_equal(false, klass.read_config_from_filesystem)
+    end
+  end
+
+  context 'initialization' do
+    context 'of attributes' do
+      should 'take an api key as a string and make it available via a getter' do
+        s = ScrumNinja::Session.new(:api_key => 'abc123')
+        assert_equal 'abc123', s.api_key
+      end
+
+      should 'take a project_id and make it available via a getter' do
+        s = ScrumNinja::Session.new(:project_id => 42, :api_key => 'abc123')
+        assert_equal 42, s.project_id
+      end
+
+      should 'take a user_id and make it available via a getter' do
+        s = ScrumNinja::Session.new(:user_id => 42, :api_key => 'abc123')
+        assert_equal 42, s.user_id
+      end
+    end
+
+    should "look for a config file in project dir when class's read_config_from_filesystem is truthy" do
+      ScrumNinja::Session.read_config_from_filesystem = true
+      YAML.expects(:load_file).with(File.join(HomePath, ConfigFile)).returns({})
+      ScrumNinja::Session.new(:api_key => 'abc123')
+    end
+
+    should "not look for a config file in project dir when class's read_config_from_filesystem is falsy" do
+      ScrumNinja::Session.read_config_from_filesystem = false
+      YAML.expects(:load_file).never
+      ScrumNinja::Session.new(:api_key => 'abc123')
+    end
+
+    should 'raise a nice exception if no api key can be determined' do
+      ScrumNinja::Session.read_config_from_filesystem = true
+      YAML.expects(:load_file).with(File.join(HomePath, ConfigFile)).raises(Errno::ENOENT.new)
+      assert_raise(ArgumentError) { ScrumNinja::Session.new }
+    end
+
+    should "look for configuration in opts[:project_dir] first, then the user's home dir, with the former taking precedence" do
+      ScrumNinja::Session.read_config_from_filesystem = true
+      YAML.expects(:load_file).with(File.join(HomePath, ConfigFile)).returns({
+        :foo     => 'less specific foo',
+        :api_key => "Ce n'est pas un API key",
+      }).at_least_once #(end)
+
+      YAML.expects(:load_file).with(File.join(ProjPath, ConfigFile)).returns({
+        :foo => 'more specific foo',
+        :bar => 'more specific bar',
+      }).at_least_once #(end)
+
+      session = ScrumNinja::Session.new(:project_dir => ProjPath)
+      assert_equal('more specific foo',       session.options[:foo])
+      assert_equal('more specific bar',       session.options[:bar])
+      assert_equal("Ce n'est pas un API key", session.options[:api_key])
+    end
+  end
+
+  context "get_stories" do
+    should "turn XML into Story objects" do
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => 42)
+      xml = <<-XML
+        <stories>
+          <story>
+            <id type="integer">61363</id>
+            <name>Make all vendor website links open in new window instead of lightview</name>
+            <owner-user-id type="integer">1235</owner-user-id>
+          </story>
+        </stories>
+      XML
+      ScrumNinja::Server.expects(:get_stories) \
+                        .with(session.api_key, session.project_id) \
+                        .returns(xml)
+      expected = [
+        ScrumNinja::Story.new('Story', 61363, 'Make all vendor website links open in new window instead of lightview', 1235)
+      ]
+      assert_equal expected, session.get_stories
+    end
+  end
+
+  context "get_story" do
+    should "turn XML into a Story" do
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => 42)
+      xml = <<-XML
+        <story>
+          <id type="integer">61363</id>
+          <name>Make all vendor website links open in new window instead of lightview</name>
+          <owner-user-id type="integer">1235</owner-user-id>
+        </story>
+      XML
+      ScrumNinja::Server.expects(:get_story).with(session.api_key, session.project_id, 61363) \
+        .returns(xml)
+      expected = ScrumNinja::Story.new('Story', 61363, 'Make all vendor website links open in new window instead of lightview', 1235)
+      assert_equal expected, session.get_story(61363)
+     end
+  end
+
+  context "update_ownership" do
+    should "generate the xml and pass it along to the server" do
+      project_id, story_id, new_owner_id = 13, 42, 23
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => project_id)
+      xml = <<-XML
+        <story>
+          <owner-user-id type="integer">#{new_owner_id}</owner-user-id>
+        </story>
+      XML
+      ScrumNinja::Server.expects(:update_story).with(session.api_key, project_id, story_id, xml).returns(true)
+      assert_equal true, session.update_ownership(story_id, new_owner_id)
+    end
+
+    should "not overwrite an existing owner if abort_if_already_owned is true" do
+      project_id, story_id, new_owner_id = 13, 42, 23
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => project_id)
+      session.stubs(:get_story).returns(stub_everything('story', :has_owner? => true))
+      ScrumNinja::Server.expects(:update_story).never
+      session.update_ownership(story_id, new_owner_id, :abort_if_already_owned => true)
+    end
+
+  end
+
+  # Note that this is temporarily useless; we don't appear to actually control the status.
+  context 'update_status' do
+    should 'generate the xml and pass it along to the server' do
+      project_id, story_id, new_status = 13, 42, 'in process'
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => project_id)
+      xml = <<-XML
+        <story>
+          <status>#{new_status}</status>
+        </story>
+      XML
+      ScrumNinja::Server.expects(:update_story).with(session.api_key, project_id, story_id, xml).returns(true)
+      assert_equal true, session.update_status(story_id, new_status)
+    end
+
+    should 'raise an argument error if an invalid status is passed' do
+      session = ScrumNinja::Session.new(:api_key => 'abc123', :project_id => 42)
+      ScrumNinja::Server.expects(:update_story).never
+      assert_raise(ArgumentError) { session.update_status(-99, 'bogus status') }
+    end
+  end
+end

data/test/scrum_ninja/test_scrum_ninja_story.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require 'scrum_ninja'
+
+
+class StoryUnitTest < Test::Unit::TestCase
+  def story(*args)
+    ScrumNinja::Story.new(*args)
+  end
+
+  context "Story#to_s" do
+    should "output the story number, followed by the name" do
+      s = story('Story', 12345, "Luggage combination")
+      assert_equal("Story  12345: Luggage combination", s.to_s)
+
+      s = story('Bug', 9, "It doesn't work")
+      assert_equal("Bug        9: It doesn't work", s.to_s)
+    end
+  end
+
+  context "Story#branch_name" do
+    should "return the story_number with a hyphenized name" do
+      s = story('Bug', 9, "It doesn't work")
+      assert_equal '9-it-doesnt-work', s.branch_name
+    end
+
+    should "return a probably-unique branch name if the name can't be calculated for any reason" do
+      s = story('Bug', 9, nil)
+      assert_match(/-indeterminate-branch-name-/, s.branch_name)
+    end
+  end
+end