git_workflow 0.0.5

data/lib/git_workflow.rb

@@ -0,0 +1,5 @@
+require 'git_workflow/core_ext'
+require 'git_workflow/logging'
+require 'git_workflow/configuration'
+require 'git_workflow/story'
+require 'git_workflow/commands'

data/lib/git_workflow/callbacks.rb

@@ -0,0 +1,16 @@
+# Automatically load the callbacks associated with the current settings
+module GitWorkflow
+  module Callbacks
+    module Loader
+      extend GitWorkflow::Git
+      extend GitWorkflow::Logging::ClassMethods
+
+      callbacks = get_config_value_for('workflow.callbacks', 'default')
+      log(:info, "Loading the '#{ callbacks }' hooks") do
+        callback_name = "git_workflow/callbacks/styles/#{ callbacks }"
+        require callback_name
+        callback_name.constantize.setup
+      end
+    end
+  end
+end

data/lib/git_workflow/callbacks/pivotal_tracker_support.rb

@@ -0,0 +1,64 @@
+module GitWorkflow
+  module Callbacks
+    module PivotalTrackerSupport
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    protected
+
+      def story(id, &block)
+        yield(GitWorkflow::Story.new(pivotal_tracker_service_for(id)))
+      end
+
+    private
+
+      def pivotal_tracker_service_for(story_id)
+        self.class.enable_http_proxy_if_present
+        url = self.class.pivotal_tracker_url_for(Configuration.instance.project_id, story_id)
+
+        debug("Using PT URL '#{ url }'")
+        RestClient::Resource.new(
+          url,
+          :headers => { 'X-TrackerToken' => Configuration.instance.api_token }
+        )
+      end
+
+      def start_story_on_pivotal_tracker!(story)
+        info("Marking story #{ story.story_id } as started") do
+          story.service! do |xml|
+            xml.current_state(story.start_state)
+          end
+        end
+      end
+
+      def finish_story_on_pivotal_tracker!(story)
+        info("Marking story #{ story.story_id } as finished") do
+          story.service! do |xml|
+            xml.current_state(story.finish_state)
+          end
+        end
+      end
+
+      module ClassMethods
+        def value_of_environment_variable(key)
+          ENV[key]
+        end
+
+        def enable_http_proxy_if_present
+          proxy   = value_of_environment_variable('http_proxy')
+          proxy ||= value_of_environment_variable('HTTP_PROXY')
+          unless proxy.nil?
+            debug("Enabling HTTP proxy '#{ proxy }'")
+            RestClient.proxy = proxy 
+          end
+        end
+
+        def pivotal_tracker_url_for(project_id, story_id)
+          "http://www.pivotaltracker.com/services/v3/projects/#{ project_id }/stories/#{ story_id }"
+        end
+      end
+
+    end
+  end
+end

data/lib/git_workflow/callbacks/remote_git_branch_support.rb

@@ -0,0 +1,9 @@
+module GitWorkflow
+  module Callbacks
+    module RemoteGitBranchSupport
+      def push_current_branch_to(remote_branch_name)
+        repository.push("HEAD:#{ remote_branch_name }")
+      end
+    end
+  end
+end

data/lib/git_workflow/callbacks/styles/debug.rb

@@ -0,0 +1,58 @@
+require 'git_workflow/callbacks/styles/default'
+require 'git_workflow/callbacks/pivotal_tracker_support'
+require 'git_workflow/commands/start'
+require 'git_workflow/commands/finish'
+require 'log4r'
+
+module GitWorkflow
+  module Callbacks
+    module Styles
+      module Debug
+        def self.setup(start_command = GitWorkflow::Commands::Start, finish_command = GitWorkflow::Commands::Finish)
+          Default.setup(start_command, finish_command)
+
+          start_command.send(:include, StartBehaviour)
+          finish_command.send(:include, FinishBehaviour)
+
+          require 'git_workflow/logging'
+          Log4r::Outputter['verbose_information'].level = Log4r::DEBUG
+        end
+
+        module StartBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+              extend GitWorkflow::Callbacks::Styles::Debug
+              debug_method(:start)
+              debug_method(:start_story_on_pivotal_tracker!)
+            end
+          end
+        end
+
+        module FinishBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+              extend GitWorkflow::Callbacks::Styles::Debug
+              debug_method(:finish)
+              debug_method(:finish_story_on_pivotal_tracker!)
+            end
+          end
+        end
+
+        def debug_method(method)
+          chain_methods(method, :debug) do |with_chain_method, without_chain_method|
+            class_eval <<-END_OF_DEBUG_METHOD
+              def #{ with_chain_method }(*args, &block)
+                debug("#{ method }(\#{ args.map(&:inspect).join(',') })") do
+                  #{ without_chain_method }(*args, &block)
+                end
+              end
+            END_OF_DEBUG_METHOD
+          end
+          alias_method_chain(method, :debug)
+        end
+      end
+    end
+  end
+end

data/lib/git_workflow/callbacks/styles/default.rb

@@ -0,0 +1,43 @@
+require 'git_workflow/callbacks/pivotal_tracker_support'
+require 'git_workflow/commands/start'
+require 'git_workflow/commands/finish'
+
+module GitWorkflow
+  module Callbacks
+    module Styles
+      module Default
+        def self.setup(start_class = GitWorkflow::Commands::Start, finish_class = GitWorkflow::Commands::Finish)
+          start_class.send(:include, StartBehaviour)
+          finish_class.send(:include, FinishBehaviour)
+        end
+
+        module StartBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+            end
+          end
+
+          def start(story, source)
+            checkout_or_create_branch(story.branch_name, source)
+          end
+        end
+
+        module FinishBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+            end
+          end
+
+          def finish(story, branch_name)
+            in_git_branch(branch_name) do
+              merge_branch(story.branch_name, branch_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/git_workflow/callbacks/styles/mine.rb

@@ -0,0 +1,52 @@
+require 'git_workflow/callbacks/test_code_support'
+require 'git_workflow/callbacks/remote_git_branch_support'
+require 'git_workflow/callbacks/pivotal_tracker_support'
+require 'git_workflow/commands/start'
+require 'git_workflow/commands/finish'
+
+module GitWorkflow
+  module Callbacks
+    module Styles
+      module Mine
+        def self.setup(start_class = GitWorkflow::Commands::Start, finish_class = GitWorkflow::Commands::Finish)
+          start_class.send(:include, StartBehaviour)
+          finish_class.send(:include, FinishBehaviour)
+        end
+
+        module StartBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+            end
+          end
+
+          def start(story, source)
+            checkout_or_create_branch(story.branch_name, source)
+          end
+        end
+
+        module FinishBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+              include GitWorkflow::Callbacks::TestCodeSupport
+              include GitWorkflow::Callbacks::RemoteGitBranchSupport
+            end
+          end
+
+          def finish(story, branch_name)
+            in_git_branch(story.branch_name) do
+              run_tests!(:spec, :features)
+            end
+            in_git_branch(branch_name) do
+              merge_branch(story.branch_name, branch_name)
+              run_tests_with_recovery!(:spec, :features)
+              push_current_branch_to(branch_name) if branch_name == 'master'
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/git_workflow/callbacks/styles/sanger.rb

@@ -0,0 +1,48 @@
+require 'git_workflow/callbacks/test_code_support'
+require 'git_workflow/callbacks/remote_git_branch_support'
+require 'git_workflow/callbacks/pivotal_tracker_support'
+require 'git_workflow/commands/start'
+require 'git_workflow/commands/finish'
+
+module GitWorkflow
+  module Callbacks
+    module Styles
+      module Sanger
+        def self.setup(start_command = GitWorkflow::Commands::Start, finish_command = GitWorkflow::Commands::Finish)
+          start_command.send(:include, StartBehaviour)
+          finish_command.send(:include, FinishBehaviour)
+        end
+
+        module StartBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+            end
+          end
+
+          def start(story, source)
+            checkout_or_create_branch(story.branch_name, source || 'master')
+          end
+        end
+
+        module FinishBehaviour
+          def self.included(base)
+            base.instance_eval do
+              include GitWorkflow::Callbacks::PivotalTrackerSupport
+              include GitWorkflow::Callbacks::TestCodeSupport
+              include GitWorkflow::Callbacks::RemoteGitBranchSupport
+            end
+          end
+
+          def finish(story, branch_name)
+            in_git_branch(story.branch_name) do
+              run_tests!(:test, :features)
+              push_current_branch_to(story.remote_branch_name)
+              story.comment("Fixed on #{ story.remote_branch_name }. Needs merging into master")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git_workflow/callbacks/test_code_support.rb

@@ -0,0 +1,29 @@
+module GitWorkflow
+  module Callbacks
+    module TestCodeSupport
+      Failure = Class.new(StandardError)
+
+      def run_tests!(*rake_test_tasks)
+        run_tests(*rake_test_tasks) or raise Failure, 'The tests failed, please fix and try again'
+      end
+
+      def run_tests_with_recovery!(*rake_test_tasks)
+        until run_tests(*rake_test_tasks)
+          spawn_shell_for_recovery or raise Failure, 'The tests failed. Please fix and then "git push origin master"'
+        end
+      end
+
+    private
+
+      def run_tests(*rake_test_tasks)
+        system('rake', *rake_test_tasks.map(&:to_s))
+      end
+
+      def spawn_shell_for_recovery
+        # TODO: spawn a shell with a message
+        # TODO: if the exit is complete failure return false
+        return false
+      end
+    end
+  end
+end

data/lib/git_workflow/command_line.rb

@@ -0,0 +1,46 @@
+require 'optparse'
+require 'log4r'
+require 'git_workflow/logging'
+
+module GitWorkflow
+  module CommandLine
+    InvalidCommandLine = Class.new(StandardError)
+
+  private
+
+    def parse_command_line(command_line_arguments, &block)
+      parser = create_parser
+      parser.parse!(command_line_arguments)
+      yield(command_line_arguments) if block_given?
+    rescue InvalidCommandLine => exception
+      puts parser
+      exit 1
+    end
+
+    def create_parser
+      ::OptionParser.new do |options|
+        usage_info(options)
+
+        options.separator ''
+        options.separator 'Common options:'
+
+        options.on('-V', '--verbose') do
+          Log4r::Outputter['verbose_information'].level = Log4r::DEBUG
+        end
+        options.on('-h', '--help') do
+          puts options
+          exit
+        end
+        options.on('-v', '--version') do
+          # TODO: get the version from the gem?
+          exit
+        end
+
+        options.separator ''
+        options.separator 'Command options:'
+
+        command_specific_options(options)
+      end
+    end
+  end
+end

data/lib/git_workflow/commands.rb

@@ -0,0 +1,4 @@
+require 'git_workflow/commands/base'
+require 'git_workflow/commands/start'
+require 'git_workflow/commands/finish'
+require 'git_workflow/commands/setup'

data/lib/git_workflow/commands/base.rb

@@ -0,0 +1,31 @@
+require 'git_workflow/core_ext'
+require 'git_workflow/logging'
+require 'git_workflow/configuration'
+require 'git_workflow/git'
+require 'git_workflow/story'
+require 'git_workflow/command_line'
+require 'rest_client'
+
+module GitWorkflow
+  module Commands
+    class Base
+      include Execution
+      include GitWorkflow::Logging
+      include GitWorkflow::Git
+      include GitWorkflow::CommandLine
+
+      def initialize(command_line_arguments, &block)
+        parse_command_line(command_line_arguments, &block)
+        
+        # Such a hack!  This effectively the callbacks to only be loaded after the
+        # command line arguments have been processed, injecting them into an already
+        # instantiated command.  Really should refactor that!
+        require 'git_workflow/callbacks'
+      end
+
+      def command_specific_options(options)
+        options.separator '    This command has no specific options'
+      end
+    end
+  end
+end

data/lib/git_workflow/commands/finish.rb

@@ -0,0 +1,36 @@
+require 'git_workflow/commands/base'
+require 'git_workflow/configuration'
+
+module GitWorkflow
+  module Commands
+    class Finish < Base
+      def initialize(command_line_arguments)
+        super(command_line_arguments) do |remaining_arguments|
+          @story_id, @target_branch = remaining_arguments
+          @target_branch ||= 'master'
+        end
+      end
+
+      def execute
+        story_or_current_branch(@story_id) do |story|
+          finish(story, @target_branch)
+          finish_story_on_pivotal_tracker!(story)
+        end
+      end
+
+    private
+
+      def story_or_current_branch(id, &block)
+        story(id || extract_story_from_branch(repository.current_branch), &block)
+      end
+
+      def extract_story_from_branch(branch)
+        GitWorkflow::Configuration.instance.local_branch_convention.from(branch)
+      end
+
+      def usage_info(options)
+        options.banner = 'Usage: git finish [<PT story number> [<target branch>]]'
+      end
+    end
+  end
+end