flash_flow 1.0.0

data/lib/flash_flow/install.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+
+module FlashFlow
+  class Install
+    def self.install
+      FileUtils.mkdir 'config' unless Dir.exists?('config')
+      dest_file = 'config/flash_flow.yml.erb'
+
+      FileUtils.cp example_file, dest_file
+
+      puts "Flash flow config file is in #{dest_file}"
+    end
+
+    def self.example_file
+      "#{File.dirname(__FILE__)}/../../flash_flow.yml.erb.example"
+    end
+
+  end
+end

data/lib/flash_flow/issue_tracker.rb

@@ -0,0 +1,52 @@
+require 'logger'
+
+require 'flash_flow/git'
+require 'flash_flow/data'
+require 'flash_flow/data/store'
+require 'flash_flow/issue_tracker/pivotal'
+
+module FlashFlow
+  module IssueTracker
+    class Base
+      def initialize(_config=nil)
+        @config = _config
+        issue_tracker_class_name = @config && @config['class'] && @config['class']['name']
+        return unless issue_tracker_class_name
+
+        @issue_tracker_class = Object.const_get(issue_tracker_class_name)
+      end
+
+      def stories_pushed
+        issue_tracker.stories_pushed if issue_tracker.respond_to?(:stories_pushed)
+      end
+
+      def stories_delivered
+        issue_tracker.stories_delivered if issue_tracker.respond_to?(:stories_delivered)
+      end
+
+      def production_deploy
+        issue_tracker.production_deploy if issue_tracker.respond_to?(:production_deploy)
+      end
+
+      def release_notes(hours, file=STDOUT)
+        issue_tracker.release_notes(hours, file) if issue_tracker.respond_to?(:release_notes)
+      end
+
+      private
+
+      def git
+        @git ||= Git.new(Config.configuration.git, Config.configuration.logger)
+      end
+
+      def get_branches
+        branch_info_store = Data::Base.new(Config.configuration.branches, Config.configuration.branch_info_file, git, logger: Config.configuration.logger)
+
+        branch_info_store.saved_branches
+      end
+
+      def issue_tracker
+        @issue_tracker ||= @issue_tracker_class && @issue_tracker_class.new(get_branches, git, @config['class'])
+      end
+    end
+  end
+end

data/lib/flash_flow/issue_tracker/pivotal.rb

@@ -0,0 +1,160 @@
+require 'pivotal-tracker'
+require 'time'
+require 'flash_flow/time_helper'
+
+module FlashFlow
+  module IssueTracker
+    class Pivotal
+      include TimeHelper
+
+      def initialize(branches, git, opts={})
+        @branches = branches
+        @git = git
+        @timezone = opts['timezone'] || "UTC"
+
+        PivotalTracker::Client.token = opts['token']
+        PivotalTracker::Client.use_ssl = true
+        @project = PivotalTracker::Project.find(opts['project_id'])
+      end
+
+      def stories_pushed
+        if merged_working_branch
+          merged_working_branch.stories.to_a.each do |story_id|
+            finish(story_id)
+          end
+        end
+      end
+
+      def stories_delivered
+        merged_branches.each do |branch|
+          branch.stories.to_a.each do |story_id|
+            deliver(story_id)
+          end
+        end
+        removed_branches.each do |branch|
+          branch.stories.to_a.each do |story_id|
+            undeliver(story_id)
+          end
+        end
+      end
+
+      def production_deploy
+        shipped_branches.each do |branch|
+          branch.stories.to_a.each do |story_id|
+            comment(story_id)
+          end
+        end
+      end
+
+      def release_notes(hours, file=STDOUT)
+        release_stories = done_and_current_stories.map do |story|
+          shipped_text = has_shipped_text?(story)
+          format_release_data(story.id, story.name, shipped_text) if shipped_text
+        end.compact
+
+        release_notes = release_by(release_stories, hours)
+        print_release_notes(release_notes, file)
+      end
+
+      private
+
+      def undeliver(story_id)
+        story = get_story(story_id)
+
+        if story && story.current_state == 'delivered'
+          story.current_state = 'finished'
+          story.update
+        end
+      end
+
+      def deliver(story_id)
+        story = get_story(story_id)
+
+        if story && story.current_state == 'finished'
+          story.current_state = 'delivered'
+          story.update
+        end
+      end
+
+      def finish(story_id)
+        story = get_story(story_id)
+
+        if story && story.current_state == 'started'
+          story.current_state = 'finished'
+          story.update
+        end
+      end
+
+      def comment(story_id)
+        story = get_story(story_id)
+        if story
+          unless has_shipped_text?(story)
+            story.notes.create(:text => with_time_zone(@timezone) { Time.now.strftime(note_time_format) })
+          end
+        end
+      end
+
+      def note_prefix
+        'Shipped to production on'
+      end
+
+      def note_time_format
+        "#{note_prefix} %m/%d/%Y at %H:%M"
+      end
+
+      def format_release_data(story_id, story_name, shipped_text)
+        {id: story_id, title: story_name, time: Time.strptime(shipped_text, note_time_format)}
+      end
+
+      def shipped?(branch)
+        branch.sha && @git.master_branch_contains?(branch.sha)
+      end
+
+      def done_and_current_stories
+        [@project.iteration(:done).last(2).map(&:stories) + @project.iteration(:current).stories].flatten
+      end
+
+      def release_by(release_stories, hours)
+        release_stories
+          .select { |story| story[:time] >= (Time.now - hours.to_i*60*60) }
+          .sort_by {|story| story[:time] }.reverse
+      end
+
+      def print_release_notes(release_notes, file=nil)
+        file ||= STDOUT
+        release_notes.each do |story|
+          file.puts "PT##{story[:id]} #{story[:title]} (#{story[:time]})"
+        end
+      end
+
+      def get_story(story_id)
+        @project.stories.find(story_id)
+      end
+
+      def already_has_comment?(story, comment)
+        story.notes.all.map(&:text).detect { |text| text =~ comment }
+      end
+
+      def has_shipped_text?(story)
+        already_has_comment?(story, Regexp.new("^#{note_prefix}"))
+      end
+
+      def shipped_branches
+        @branches.select { |b| shipped?(b) }
+      end
+
+      def merged_branches
+        @branches.select { |b| b.success? }
+      end
+
+      def removed_branches
+        @branches.select { |b| b.removed? }
+      end
+
+      def merged_working_branch
+        merged_branches.detect { |b| b.ref == @git.working_branch }
+      end
+
+    end
+  end
+end

data/lib/flash_flow/lock.rb

@@ -0,0 +1,25 @@
+require 'flash_flow/lock/github'
+
+module FlashFlow
+  module Lock
+    class Error < RuntimeError; end
+
+    class Base
+      def initialize(config=nil)
+        lock_class_name = config && config['class'] && config['class']['name']
+        return unless lock_class_name
+
+        lock_class = Object.const_get(lock_class_name)
+        @lock = lock_class.new(config['class'])
+      end
+
+      def with_lock(&block)
+        if @lock
+          @lock.with_lock(&block)
+        else
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/flash_flow/lock/github.rb

@@ -0,0 +1,91 @@
+require 'octokit'
+
+module FlashFlow
+  module Lock
+    class Github
+
+      attr_reader :config
+      private :config
+
+      def initialize(config)
+        @config = config
+
+        verify_params!
+        initialize_connection!
+      end
+
+      def with_lock(&block)
+        if issue_open?
+          raise Lock::Error.new(error_message)
+        else
+          open_issue
+
+          begin
+            block.call
+          ensure
+            close_issue
+          end
+        end
+      end
+
+      private
+
+      def error_message
+        last_event = get_last_event
+        actor = last_event[:actor][:login]
+        time = last_event[:created_at]
+        issue_link = "https://github.com/#{repo}/issues/#{issue_id}"
+        minutes_ago = ((Time.now - time).to_i / 60) rescue 'unknown'
+
+        "#{actor} started running flash_flow #{minutes_ago} minutes ago. To manually unlock flash_flow, go here: #{issue_link} and close the issue and re-run flash_flow."
+      end
+
+      def get_last_event
+        Octokit.issue_events(repo, issue_id)
+        response = Octokit.last_response
+        pages = response.rels[:last]
+        if pages
+          return pages.get.data.last
+        else
+          response.data.last
+        end
+      end
+
+      def issue_open?
+        get_last_event.event == 'reopened'
+      end
+
+      def open_issue
+        Octokit.reopen_issue(repo, issue_id)
+      end
+
+      def close_issue
+        Octokit.close_issue(repo, issue_id)
+      end
+
+      def verify_params!
+        unless token && repo && issue_id
+          raise Lock::Error.new("Github token, repo, and issue_id must all be set to use the Github lock.")
+        end
+      end
+
+      def initialize_connection!
+        Octokit.configure do |c|
+          c.access_token = token
+        end
+      end
+
+      def token
+        config['token']
+      end
+
+      def repo
+        config['repo']
+      end
+
+      def issue_id
+        config['issue_id']
+      end
+    end
+  end
+end

data/lib/flash_flow/notifier.rb

@@ -0,0 +1,24 @@
+require 'flash_flow/data'
+require 'flash_flow/notifier/hipchat'
+
+module FlashFlow
+  module Notifier
+    class Base
+      def initialize(config=nil)
+        notifier_class_name = config && config['class'] && config['class']['name']
+        return unless notifier_class_name
+
+        @notifier_class = Object.const_get(notifier_class_name)
+        @notifier = @notifier_class.new(config['class'])
+      end
+
+      def merge_conflict(branch)
+        @notifier.merge_conflict(branch) if @notifier.respond_to?(:merge_conflict)
+      end
+
+      def deleted_branch(branch)
+        @notifier.deleted_branch(branch) if @notifier.respond_to?(:deleted_branch)
+      end
+    end
+  end
+end

data/lib/flash_flow/notifier/hipchat.rb

@@ -0,0 +1,36 @@
+require 'hipchat'
+
+module FlashFlow
+  module Notifier
+    class Hipchat
+
+      def initialize(config={})
+        @client = initialize_connection!(config['token'])
+        @room = config['room']
+      end
+
+      def merge_conflict(branch)
+        user_name = branch.metadata['user_url'].split('/').last
+        user_url_link = %{<a href="#{branch.metadata['user_url']}">#{user_name}</a>}
+        ref_link = %{<a href="#{branch.metadata['repo_url']}/tree/#{branch.ref}">#{branch.ref}</a>}
+
+        message = %{#{user_url_link}'s branch (#{ref_link}) did not merge successfully}
+        @client[@room].send("FlashFlow", message)
+      end
+
+      private
+
+      def initialize_connection!(token)
+        if token.nil?
+          raise RuntimeError.new("Hipchat token must be set in your flash flow config.")
+        end
+
+        hipchat_client.new(token, api_version: "v2")
+      end
+
+      def hipchat_client
+        HipChat::Client
+      end
+    end
+  end
+end

data/lib/flash_flow/options.rb

@@ -0,0 +1,36 @@
+require 'optparse'
+
+module FlashFlow
+  class Options
+    def self.parse
+      options = {}
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: flash_flow [options]"
+        opts.separator ""
+
+        opts.on('--install', 'Copy flash_flow.yml.erb to your repo and exit') { |v| options[:install] = true }
+        opts.on('--prod-deploy', 'Run IssueTracker#deploy_production and exit') { |v| options[:prod_deploy] = true }
+        opts.on('--review-deploy', 'Run IssueTracker#deploy_review and exit') { |v| options[:review_deploy] = true }
+        opts.on('--release-notes hours', 'Run IssueTracker#release_notes and exit') { |v| options[:release_notes] = v }
+        opts.on('-n', '--no-merge', 'Run flash flow, but do not merge this branch') { |v| options[:do_not_merge] = true }
+        opts.on('--rerere-forget', 'Delete the saved patch for this branch and let the merge fail if there is a conflict') { |v| options[:rerere_forget] = true }
+        opts.on('--story id1', 'story id for this branch') { |v| options[:stories] = [v] }
+        opts.on('--stories id1,id2', 'comma-delimited list of story ids for this branch') { |v| options[:stories] = v.split(',') }
+        opts.on('-f', '--force-push', 'Force push your branch') { |v| options[:force] = v }
+        opts.on('-c', '--config-file FILE_PATH', 'The path to your config file. Defaults to config/flash_flow.yml.erb') { |v| options[:config_file] = v }
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse!
+
+      options[:stories] ||= []
+      options[:config_file] ||= './config/flash_flow.yml.erb'
+
+      options
+    end
+  end
+end