git_workflow 0.0.5

data/lib/git_workflow/logger.yaml

@@ -0,0 +1,27 @@
+log4r_config:
+  # Here we define all of the loggers that are going to be used across all of the
+  # possible configurations.
+  loggers:
+    - name: Console
+      level: DEBUG
+      outputters:
+      - normal_information
+      - verbose_information
+
+  # And here are the outputters and with their associated formatters.
+  outputters:
+  - name: normal_information
+    type: StdoutOutputter
+    only_at: 
+    - INFO
+    - FATAL
+    formatter:
+      type: PatternFormatter
+      pattern: '%l: %m'
+
+  - name: verbose_information
+    type: StderrOutputter
+    level: FATAL
+    formatter:
+      type: PatternFormatter
+      pattern: '%l: %m'

data/lib/git_workflow/logging.rb

@@ -0,0 +1,77 @@
+require 'log4r'
+require 'log4r/yamlconfigurator'
+
+module Log4r
+  class Outputter
+    def initialize_with_multiple_levels(name, hash = {})
+      initialize_without_multiple_levels(name, hash)
+      self.only_at(*hash[ :only_at ]) if hash.key?(:only_at)
+    end
+    alias_method_chain(:initialize, :multiple_levels)
+  end
+end
+
+module GitWorkflow
+  module Logging
+    # Causes the loading of the logging information before anything else is done.
+    Log4r::YamlConfigurator.load_yaml_file(File.expand_path(File.join(File.dirname(__FILE__), 'logger.yaml')))
+
+    def self.included(base)
+      base.instance_eval do
+        extend ClassMethods
+
+        [ :debug, :info, :error ].each do |level|
+          class_eval <<-END_OF_LOGGING_METHOD
+            def #{ level }(message, &block)
+              self.class.#{ level }(message, &block)
+            end
+
+            def self.#{ level }(message, &block)
+              self.log(#{ level.inspect }, message, &block)
+            end
+          END_OF_LOGGING_METHOD
+        end
+      end
+    end
+
+    class << self
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def logger
+        @logger ||= default_logger
+      end
+
+      def default_logger
+        Log4r::Logger['Console']
+      end
+    end
+
+    module ClassMethods
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def logger
+        @logger || GitWorkflow::Logging.logger
+      end
+
+      def log(level, message, &block)
+        if block_given?
+          begin
+            logger.send(level, "(start): #{ message }")
+            rc = yield
+            logger.send(level, "(finish): #{ message }")
+            rc
+          rescue => exception
+            logger.error("#{ message } (#{ exception.message })")
+            raise
+          end
+        else
+          logger.send(level, message)
+        end
+      end
+    end
+  end
+end

data/lib/git_workflow/story.rb

@@ -0,0 +1,96 @@
+require 'rest_client'
+require 'builder'
+
+# On MacOSX systems you can have a dodgy LibXML2 which Nokogiri warns about.  Hide this warning
+# by setting the following constant:
+I_KNOW_I_AM_USING_AN_OLD_AND_BUGGY_VERSION_OF_LIBXML2 = true
+require 'nokogiri'
+
+module GitWorkflow
+  class Story
+    include Logging
+
+    attr_reader :story_id
+    attr_reader :name
+    attr_reader :description
+
+    def initialize(service)
+      @service = service
+      load_story!
+    end
+
+    def branch_name
+      @local_branch_name ||= GitWorkflow::Configuration.instance.local_branch_convention.to(self)
+    end
+
+    def remote_branch_name
+      @remote_branch_name ||= GitWorkflow::Configuration.instance.remote_branch_convention.to(self)
+    end
+
+    def start_state
+      'started'
+    end
+
+    def finish_state
+      @story_type == 'chore' ? 'accepted' : 'finished'
+    end
+
+    def comment(message)
+      _service!(:post, 'notes') do |xml|
+        xml.note {
+          xml.text(message)
+        }
+      end
+    end
+
+    def service!(&block)
+      _service!(:put) do |xml|
+        xml.story {
+          xml.owned_by(GitWorkflow::Configuration.instance.username)
+          yield(xml) if block_given?
+        }
+      end
+    end
+
+  private
+
+    def _service!(action, subresource = nil, &block)
+      xml = Builder::XmlMarkup.new
+      yield(xml)
+      service = @service
+      service = service[subresource] unless subresource.nil?
+      service.send(action, xml.target!, :content_type => 'application/xml')
+    rescue RestClient::ExceptionWithResponse => exception
+      error('Cannot seem to perform operation with PT:')
+      error(exception.response)
+      raise
+    end
+
+    class XmlWrapper
+      def initialize(xml)
+        @xml = Nokogiri::XML(xml)
+      end
+
+      def required!(element)
+        value = optional(element)
+        raise MissingElement, "Missing '#{ element }' in the PT XML" if value.blank?
+        value
+      end
+
+      def optional(element)
+        values = @xml.xpath("/story/#{ element }/text()")
+        values.empty? ? nil : values.first.content
+      end
+    end
+
+    def load_story!
+      info("Retrieving story information") do
+        xml          = XmlWrapper.new(@service.get)
+        @story_id    = xml.required!(:id).to_i
+        @story_type  = xml.required!(:story_type)
+        @name        = xml.required!(:name)
+        @description = xml.optional(:description)
+      end
+    end
+  end
+end

data/spec/core_functionality/4056539_support_http_proxy_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'git_workflow/callbacks/pivotal_tracker_support'
+
+describe GitWorkflow::Callbacks::PivotalTrackerSupport::ClassMethods do
+  before(:each) do
+    @command = Object.new
+    @command.stub!(:debug).with(any_args)
+    @command.extend(GitWorkflow::Callbacks::PivotalTrackerSupport::ClassMethods)
+  end
+
+  describe '.value_of_environment_variable' do
+    before(:each) do
+      ENV['somevariable'] = 'this is the value'
+    end
+
+    after(:each) do
+      ENV['somevariable'] = nil
+    end
+
+    it 'returns the value of the environment variable' do
+      @command.value_of_environment_variable('somevariable').should == 'this is the value'
+    end
+  end
+
+  describe '.enable_http_proxy_if_present' do
+    after(:each) do
+      @command.enable_http_proxy_if_present
+    end
+
+    it 'uses the $http_proxy environment variable first' do
+      @command.stub!(:value_of_environment_variable).with('http_proxy').and_return('http_proxy value')
+      RestClient.should_receive(:proxy=).with('http_proxy value')
+    end
+
+    it 'falls back to $HTTP_PROXY' do
+      @command.stub!(:value_of_environment_variable).with('http_proxy').and_return(nil)
+      @command.stub!(:value_of_environment_variable).with('HTTP_PROXY').and_return('HTTP_PROXY value')
+      RestClient.should_receive(:proxy=).with('HTTP_PROXY value')
+    end
+
+    it 'does not set the HTTP proxy if neither is set' do
+      @command.stub!(:value_of_environment_variable).with('http_proxy').and_return(nil)
+      @command.stub!(:value_of_environment_variable).with('HTTP_PROXY').and_return(nil)
+      RestClient.should_receive(:proxy=).with(anything).never
+    end
+  end
+end
+
+describe GitWorkflow::Callbacks::PivotalTrackerSupport do
+  before(:each) do
+    @command = Class.new.new
+    @command.stub!(:debug).with(any_args)
+    @command.extend(GitWorkflow::Callbacks::PivotalTrackerSupport)
+  end
+
+  describe '#pivotal_tracker_service' do
+    it_should_behave_like 'it needs configuration'
+
+    it 'enables the HTTP proxy' do
+      @command.class.instance_eval do
+        should_receive(:enable_http_proxy_if_present).once
+        should_receive(:pivotal_tracker_url_for).with('project_id', 'story_id').and_return('url')
+      end
+      RestClient::Resource.stub!(:new).with(any_args).and_return(:ok)
+      @command.pivotal_tracker_service_for('story_id')
+    end
+  end
+end

data/spec/core_functionality/4058365_bad_request_on_story_update_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe GitWorkflow do
+  it_should_behave_like 'it needs configuration'
+  it_should_behave_like 'it needs a working Story'
+
+  describe '#service!' do
+    it 'generates valid XML' do
+      @service.should_receive(:put).with('<story><owned_by>username</owned_by></story>', anything)
+      @story.service!
+    end
+  end
+end

data/spec/core_functionality/4058394_make_commands_more_verbose_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe GitWorkflow::Logging::ClassMethods do
+  before(:each) do
+    @object = Class.new(Object).new
+    @object.class.send(:include, GitWorkflow::Logging::ClassMethods)
+
+    @logger        = mock('Logger')
+    @object.logger = @logger
+  end
+
+  describe '#log' do
+    it 'displays just the message and the level if no block given' do
+      @logger.should_receive(:debug).with('my message')
+      @object.log(:debug, 'my message')
+    end
+
+    it 'displays messages around the given block' do
+      @logger.should_receive(:debug).with('(start): my message').once
+      @logger.should_receive(:debug).with('(finish): my message').once
+
+      callback = mock('callback')
+      callback.should_receive(:called).and_return(:ok)
+      
+      @object.log(:debug, 'my message') do
+        callback.called
+      end.should == :ok
+    end
+
+    it 'displays errors when block raises' do
+      @logger.should_receive(:debug).with('(start): my message').once
+      @logger.should_receive(:error).with('my message (Broken)').once
+
+      lambda do
+        @object.log(:debug, 'my message') do
+          raise StandardError, 'Broken'
+        end
+      end.should raise_error(StandardError)
+    end
+  end
+end

data/spec/core_functionality/4058719_error_if_none_of_the_required_configuration_values_are_set_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GitWorkflow::Git do
+  before(:each) do
+    @git, @repository = Class.new, mock('Repository')
+    @git.send(:extend, GitWorkflow::Git)
+    @git.stub(:repository).and_return(@repository)
+  end
+
+  describe '.get_config_value_for!' do
+    it 'returns the value if set' do
+      @git.should_receive(:get_config_value_for).with('key').and_return('value')
+      @git.get_config_value_for!('key').should == 'value'
+    end
+
+    it 'raises an exception if the value is not set' do
+      @git.should_receive(:get_config_value_for).with('key').and_return(nil)
+      lambda { @git.get_config_value_for!('key') }.should raise_error(StandardError)
+    end
+  end
+end

data/spec/core_functionality/4058861_git_config_returns_empty_strings_which_should_be_nil_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class GitWorkflow::Git::Repository
+  def self.for_testing
+    new
+  end
+end
+
+describe GitWorkflow::Git::Repository do
+  before(:each) do
+    @repository = described_class.for_testing
+  end
+
+  describe '#config_get' do
+    it 'raises ConfigError on command failure' do
+      @repository.should_receive(:execute_command).with(anything).and_raise(Execution::CommandFailure.new('command', :failure))
+      lambda { @repository.config_get('key') }.should raise_error(GitWorkflow::Git::Repository::ConfigError)
+    end
+
+    context 'when command succeeds' do
+      after(:each) do
+        @repository.should_receive(:execute_command).with('git config key').and_return(@value)
+        @repository.config_get('key').should == @expected
+      end
+
+      it 'returns the value that is set' do
+        @value = @expected = 'value'
+      end
+
+      it 'strips whitespace from the value' do
+        @value, @expected = ' value ', 'value'
+      end
+
+      it 'returns nil if value is empty' do
+        @value, @expected = '', nil
+      end
+    end
+  end
+end
+
+describe GitWorkflow::Git do
+  before(:each) do
+    @git, @repository = Class.new, mock('Repository')
+    @git.send(:extend, GitWorkflow::Git)
+    @git.stub(:repository).and_return(@repository)
+  end
+
+  describe '#get_config_value_for' do
+    it 'returns whatever is set' do
+      @repository.should_receive(:config_get).with('key').and_return(:ok)
+      @git.get_config_value_for('key').should == :ok
+    end
+
+    it 'returns nil for failure' do
+      @repository.should_receive(:config_get).with('key').and_raise(GitWorkflow::Git::Repository::ConfigError)
+      @git.get_config_value_for('key').should == nil
+    end
+  end
+end

data/spec/core_functionality/4172431_add_git_workflow_setup_command_to_make_setup_easier_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+class GitWorkflow::Commands::Setup
+  public :set_value_through
+  public :ask
+  public :choose
+
+  public :enquire_about_name
+  public :enquire_about_token
+  public :enquire_about_project_id
+  public :enquire_about_workflow
+  public :enquire_about_branches
+  public :choose_branch_convention
+
+  public :get_config_value_for
+  public :set_config_value
+end
+
+describe GitWorkflow::Commands::Setup do
+  before(:each) do
+    @command, @highline = described_class.new([]), mock('HighLine')
+    @command.stub(:highline).and_return(@highline)
+
+    @question = mock('Question')
+    @question.stub(:question=).with(anything)
+  end
+
+  describe '#execute' do
+    it 'asks the right questions' do
+      [ :name, :token, :project_id, :workflow, :branches ].each do |query|
+        @command.should_receive(:"enquire_about_#{ query }").ordered
+      end
+      @command.execute
+    end
+  end
+
+  describe '#ask' do
+    it 'calls through to set the value' do
+      callback = mock('callback')
+      callback.should_receive(:called)
+
+      @command.should_receive(:set_value_through).with(:ask, :setting, 'Dummy', :options).and_yield
+      @command.ask(:setting, :options) { callback.called }
+    end
+  end
+
+  describe '#choose' do
+    it 'calls through to set the value' do
+      callback = mock('callback')
+      callback.should_receive(:called)
+
+      @command.should_receive(:set_value_through).with(:choose, :setting, :options).and_yield
+      @command.choose(:setting, :options) { callback.called }
+    end
+  end
+
+  describe '#set_value_through' do
+    before(:each) do
+      @question.should_receive(:default=).with(:default)
+
+      @callback = mock('callback')
+      @callback.should_receive(:called).with(@question)
+
+      @command.should_receive(:get_config_value_for).with(:setting).and_return(:default)
+    end
+
+    it 'unspecified answer type sets value' do
+      @highline.should_receive(:question_user).with(:arg1, :arg2).and_yield(@question).and_return(:ok)
+      @command.should_receive(:set_config_value).with(:setting, :ok)
+      @command.set_value_through(:question_user, :setting, :arg1, :arg2) { |question| @callback.called(question) }
+    end
+
+    context 'when answer is optional' do
+      after(:each) do
+        @command.set_value_through(:question_user, :setting, :arg1, :arg2, :optional => true) { |question| @callback.called(question) }
+      end
+
+      it 'does not set the value if answer is blank' do
+        @highline.should_receive(:question_user).with(:arg1, :arg2).and_yield(@question).and_return('')
+      end
+
+      it 'sets the value if answer is non-blank' do
+        @highline.should_receive(:question_user).with(:arg1, :arg2).and_yield(@question).and_return('OK')
+        @command.should_receive(:set_config_value).with(:setting, 'OK')
+      end
+    end
+  end
+
+  describe '#enquire_about_name' do
+    it 'optionally prompts for the user.name' do
+      @command.should_receive(:get_config_value_for).with('user.name').and_return('John Smith')
+      @command.should_receive(:ask).with('pt.username', hash_including(:optional => true))
+      @command.enquire_about_name
+    end
+  end
+
+  describe '#enquire_about_token' do
+    it 'prompts for the pt.token' do
+      @question.should_receive(:validate=).with(/^[A-Fa-f0-9]{32}$/)
+
+      @command.should_receive(:ask).with('pt.token').and_yield(@question)
+      @command.enquire_about_token
+    end
+  end
+
+  describe '#enquire_about_project_id' do
+    it 'prompts for the pt.projectid numeric' do
+      @question.should_receive(:answer_type=).with(Integer)
+
+      @command.should_receive(:ask).with('pt.projectid').and_yield(@question)
+      @command.enquire_about_project_id
+    end
+  end
+
+  describe '#enquire_about_workflow' do
+    it 'prompts for the workflow.callbacks value' do
+      @command.should_receive(:ask).with('workflow.callbacks')
+      @command.enquire_about_workflow
+    end
+  end
+
+  describe '#enquire_about_branches' do
+    it 'prompts for branch conventions' do
+      @command.should_receive(:choose_branch_convention).with(:local)
+      @command.should_receive(:choose_branch_convention).with(:remote)
+
+      @command.enquire_about_branches
+    end
+  end
+
+  describe '#choose_branch_convention' do
+    it 'works with the correct setting' do
+      @command.should_receive(:choose).with('workflow.foobarbranchconvention')
+      @command.choose_branch_convention(:foobar)
+    end
+
+    it 'sets up the menu correctly' do
+      menu = mock('menu')
+      menu.stub(:header=).with(anything)
+      menu.should_receive(:prompt=).with(/\bfoobar\b/)
+      menu.should_receive(:menu_option).with(/number\b.+title/, '${number}_${name}')
+      menu.should_receive(:menu_option).with(/title\b.+number/, '${name}_${number}')
+      @command.should_receive(:choose).with(anything).and_yield(menu)
+
+      @command.choose_branch_convention(:foobar)
+    end
+  end
+end