jiragit 0.5.0

data/lib/jiragit/jira_store.rb

@@ -0,0 +1,48 @@
+require 'set'
+
+module Jiragit
+
+  class JiraStore
+
+    def initialize(location = "#{Dir.home}/.jira_store")
+      self.location = location
+    end
+
+    def relate(params)
+      tags = extract_tags(params).compact
+      vault.relate(*tags)
+      vault.save
+    end
+
+    def relations(params)
+      jira, branch, commit = extract_tags(params).compact.first
+      tag = [jira, branch, commit].detect { |tag| !tag.nil? }
+      return Set.new unless tag
+      vault.load
+      vault.relations(tag)
+    end
+
+    def reload
+      vault.load
+    end
+
+    private
+
+      attr_accessor :location
+      attr_reader :vault
+
+      def vault
+        @vault ||= Vault.new(location)
+      end
+
+      def extract_tags(params)
+        jira = branch = commit = nil
+        jira = Tag.new(jira: params[:jira]) if params.include?(:jira)
+        branch = Tag.new(branch: params[:branch]) if params.include?(:branch)
+        commit = Tag.new(commit: params[:commit]) if params.include?(:commit)
+        [jira, branch, commit]
+      end
+
+  end
+
+end

data/lib/jiragit/logger.rb

@@ -0,0 +1,32 @@
+require 'logger'
+require 'fileutils'
+
+module Jiragit
+
+  class Logger < ::Logger
+
+    attr_accessor :hook
+
+    def initialize(path = nil)
+      if path
+        @path = path
+      else
+        @path = ".git/jiragit/jiragit.log"
+      end
+      FileUtils.mkdir_p directory
+      super(@path)
+    end
+
+    def format_message(severity, datetime, progname, msg)
+      "#{datetime} #{@hook}: #{msg}\n"
+    end
+
+    def directory
+      dir = @path.gsub(/(^|\/)[^\/]*?$/,'')
+      dir = "." if dir == ''
+      dir
+    end
+
+  end
+
+end

data/lib/jiragit/tag.rb

@@ -0,0 +1,30 @@
+module Jiragit
+
+  class Tag
+
+    attr_accessor :type, :label
+
+    def initialize(hashtag)
+      @type = hashtag.first.first.to_sym
+      @label = hashtag.first.last.to_s
+    end
+
+    def to_s
+      "#{type}: #{label}"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def hash
+      to_s.hash
+    end
+
+    def eql?(other)
+      other.to_s.hash == to_s.hash
+    end
+
+  end
+
+end

data/lib/jiragit/vault.rb

@@ -0,0 +1,113 @@
+module Jiragit
+
+  class Vault
+
+    def initialize(location)
+      self.location = location
+      load_or_create
+    end
+
+    def load_or_create
+      self.vault = load || create
+    end
+
+    def load
+      return false unless File.exists?(location)
+      self.vault = Marshal.load(File.read(location))
+    end
+
+    def create
+      self.vault = {}
+      save
+      vault
+    end
+
+    def save
+      File.open(location, 'w+') { |file| file.write Marshal.dump(vault) }
+    end
+
+    def add(item)
+      vault[item] = vault[item]
+    end
+
+    def include?(item)
+      vault.keys.include?(item)
+    end
+
+    def relate(*items)
+      items.each do |item|
+        add(item) unless include?(item)
+        items.each do |related_item|
+          add(related_item) unless include?(related_item)
+          update_relation(item, related_item) unless item == related_item
+        end
+      end
+    end
+
+    def relations(item)
+      vault[item] || Set.new
+    end
+
+    def related?(*items)
+      items.inject(true) do |related, item|
+        related && items.inject(true) do |related, related_item|
+          related && related_items?(item, related_item)
+        end
+      end
+    end
+
+    def distally_related?(item, related_item)
+      !!relation_chain(item, related_item)
+    end
+
+    def relation_chain(item, related_item)
+      visited = Set.new
+      visited << item
+      to_visit = [ [ [item] , relations(item).to_a ] ]
+      loop do
+        break unless to_visit.any?
+        chain, items = to_visit.first
+        if items.any?
+          item = items.shift
+          if !visited.include?(item)
+            visited << item
+            relations = relations(item)
+            to_visit << [chain + [item], relations.to_a] if relations.any?
+            return chain + [item] if item == related_item
+          end
+        else
+          to_visit.shift
+        end
+      end
+      false
+    end
+
+    private
+
+      attr_accessor :vault
+      attr_accessor :location
+
+      def related_items?(item, related_item)
+        case
+        when item == related_item
+          true
+        when relations(item).include?(related_item)
+          true
+        else
+          false
+        end
+      end
+
+      def update_relation(item, related_item)
+        relations = relations(item)
+        relations << related_item
+        vault[item] = relations if relations_empty?(item)
+      end
+
+      def relations_empty?(item)
+        self.include?(item) || vault[item].nil?
+      end
+
+  end
+
+end

data/lib/jiragit/version.rb

@@ -0,0 +1,3 @@
+module Jiragit
+  VERSION = "0.5.0"
+end

data/spec/branch_spec.rb

@@ -0,0 +1,105 @@
+require './spec/spec_helper'
+require 'expect'
+
+describe "Repository Branching Behaviors" do
+
+  include_context "Test Repository"
+
+  context "when checking out a new branch" do
+
+    it "asks for a jira number" do
+      checkout_a_new_branch('new_branch', 'PA-12345')
+    end
+
+    it "runs the post-checkout hook" do
+      checkout_a_new_branch('new_branch', 'PA-12345')
+      assert_log_contains(/post-checkout/)
+    end
+
+    it "records a jira_branch relation" do
+      checkout_a_new_branch('new_branch', 'PA-12345')
+      assert_relation({jira: 'PA-12345'}, {branch: 'new_branch'})
+    end
+
+    it "records multiple jira_branch relations" do
+      checkout_a_new_branch('new_branch', 'PA-12345, PA-54321')
+      assert_relation({jira: 'PA-12345'}, {branch: 'new_branch'})
+      assert_relation({jira: 'PA-54321'}, {branch: 'new_branch'})
+    end
+
+    context "previous branch has associated jiras" do
+
+      before do
+        checkout_a_new_branch('parent_branch', 'PA-12345')
+        @repo.make_a_commit
+      end
+
+      it "should provide and accept defaults" do
+        assert_relation({jira: 'PA-12345'}, {branch: 'parent_branch'})
+        checkout_a_new_branch_with_default('child_branch')
+        assert_relation({jira: 'PA-12345'}, {branch: 'child_branch'})
+      end
+
+    end
+
+  end
+
+  context "when checking out an existing branch" do
+
+    context "without an associated jira" do
+
+      before do
+        checkout_a_new_branch('new_branch')
+        @repo.make_a_commit
+        checkout_an_existing_branch('master')
+      end
+
+      it "asks for a jira number" do
+        checkout_an_existing_branch('new_branch', 'PA-12345')
+      end
+
+      it "runs the post-checkout hook" do
+        checkout_an_existing_branch('new_branch', 'PA-12345')
+        assert_log_contains(/post-checkout/)
+      end
+
+      it "has no prexisting jira_branch relation" do
+        assert_no_relation({jira: 'PA-12345'}, {branch: 'new_branch'})
+      end
+
+      it "records a jira_branch relation" do
+        checkout_an_existing_branch('new_branch', 'PA-12345')
+        assert_relation({jira: 'PA-12345'}, {branch: 'new_branch'})
+      end
+
+    end
+
+    context "with an associated jira" do
+
+      before do
+        checkout_a_new_branch('new_branch', 'PA-12345')
+        @repo.make_a_commit
+        checkout_an_existing_branch('master')
+      end
+
+      it "does not ask for a jira number" do
+        @repo.checkout_branch('new_branch') do |output, input|
+          output.expect("What is the JIRA Number?", 5) do |message|
+            expect(message).to be nil
+          end
+        end
+      end
+
+      it "lists associated jira numbers" do
+        @repo.checkout_branch('new_branch') do |output, input|
+          output.expect("PA-12345", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/cli_context.rb

@@ -0,0 +1,13 @@
+RSpec.shared_context "CLI input/output" do
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after(:all) do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+
+end

data/spec/cli_spec.rb

@@ -0,0 +1,149 @@
+require './spec/spec_helper'
+
+module Jiragit
+
+  describe Cli do
+
+    include_context "CLI input/output"
+
+    it "should provide help with no command line options" do
+      Cli.new([])
+      expect($stdout.string).to match(/Commands/)
+    end
+
+    context "in an empty repository" do
+
+      before do
+        @current_directory = Dir.pwd
+        @directory = "/tmp/test_directory"
+        Dir.mkdir(@directory) unless Dir.exists?(@directory)
+        Dir.chdir(@directory)
+      end
+
+      after do
+        Dir.chdir(@current_directory)
+        Dir.rmdir(@directory)
+      end
+
+      it "provides an error message when calling commands that require a repository" do
+        Cli.new([:install])
+        expect($stderr.string).to match(/No valid Git repository/)
+      end
+
+    end
+
+    context "in an empty repository" do
+
+      before do
+        @current_directory = Dir.pwd
+        repository = "test_repository"
+        Jiragit::Git::Repository.create(repository)
+        Dir.chdir repository
+      end
+
+      after do
+        Dir.chdir(@current_directory)
+      end
+
+      it "should not have hooks installed" do
+        cli = Cli.new([])
+        expect(Dir.exists?(".git")).to be true
+        expect(Dir.exists?(".git/hooks")).to be true
+        cli.send(:gem_hook_files).each do |hook|
+          expect(File.exists?(".git/hooks/#{hook}")).to be false
+        end
+      end
+
+      it "should install hooks" do
+        cli = Cli.new([:install])
+        cli.send(:gem_hook_files).each do |hook|
+          expect(File.exists?(".git/hooks/#{hook}")).to be true
+        end
+      end
+
+      it "should uninstalled hooks" do
+        cli = Cli.new([:install])
+        cli = Cli.new([:uninstall])
+        cli.send(:gem_hook_files).each do |hook|
+          expect(File.exists?(".git/hooks/#{hook}")).to be false
+        end
+      end
+
+    end
+
+    context "in a test repository" do
+
+      include_context "Test Repository"
+
+      context "in a new feature branch" do
+
+        before do
+          @repo.create('a_file', 'The quick fox jumped over the fence')
+          @repo.add('a_file')
+          @repo.commit('initial commit')
+          checkout_a_new_branch('feature_branch', 'PA-12345')
+          @repo.create('a_file', 'The brown fox jumped over the fence')
+          @repo.add('a_file')
+          @repo.commit('feature commit')
+          Dir.chdir @repository
+        end
+
+        after do
+          Dir.chdir '..'
+        end
+
+        it "browses to the current branch by default" do
+          expect_any_instance_of(Cli).to receive(:run) do |instance, arg|
+            expect(arg).to match(/open/)
+            expect(arg).to match(/feature_branch/)
+          end
+          cli = Cli.new([:browse])
+        end
+
+        it "browses to the current jira" do
+          expect_any_instance_of(Cli).to receive(:run) do |instance, arg|
+            expect(arg).to match(/open/)
+            expect(arg).to match(/PA-12345/)
+          end
+          cli = Cli.new([:browse, 'jira'])
+        end
+
+        it "browses to the current branch" do
+          expect_any_instance_of(Cli).to receive(:run) do |instance, arg|
+            expect(arg).to match(/open/)
+            expect(arg).to match(/feature_branch/)
+          end
+          cli = Cli.new([:browse, 'branch'])
+        end
+
+      end
+
+      context "in a new feature branch without a jira" do
+
+        before do
+          @repo.create('a_file', 'The quick fox jumped over the fence')
+          @repo.add('a_file')
+          @repo.commit('initial commit')
+          checkout_a_new_branch_with_default('feature_branch')
+          @repo.create('a_file', 'The brown fox jumped over the fence')
+          @repo.add('a_file')
+          @repo.commit('feature commit')
+          Dir.chdir @repository
+        end
+
+        after do
+          Dir.chdir '..'
+        end
+
+        it "does not browse to an unspecified jira" do
+          expect_any_instance_of(Cli).to_not receive(:run)
+          cli = Cli.new([:browse, 'jira'])
+        end
+
+      end
+
+    end
+
+  end
+
+end