Merge pull request #82 from sportngin/reserved-branch-warning

Reserved branch warning

.ruby-version

@@ -0,0 +1 @@
+2.2.4

lib/octopolo/git.rb

@@ -6,6 +6,8 @@ class Git
     NO_BRANCH = "(no branch)"
     DEFAULT_DIRTY_MESSAGE = "Your Git index is not clean. Commit, stash, or otherwise clean up the index before continuing."
     DIRTY_CONFIRM_MESSAGE = "Your Git index is not clean. Do you want to continue?"
+    RESERVED_BRANCH_MESSAGE = "Please choose another name for your new branch."
+    RESERVED_BRANCH_CONFIRM_MESSAGE = "Your new branch may be misidentified as a reserved branch based on its name. Do you want to continue?"
     # we use date-based tags, so look for anything starting with a 4-digit year
     RELEASE_TAG_FILTER = /^\d{4}.*/
     RECENT_TAG_LIMIT = 9
@@ -17,6 +19,9 @@ class Git
     STAGING_PREFIX = "staging"
     QAREADY_PREFIX = "qaready"
 
+    # To check if the new branch's name starts with one of these
+    RESERVED_BRANCH_PREFIXES = [ DEPLOYABLE_PREFIX, STAGING_PREFIX, QAREADY_PREFIX ]
+
     @resolver_used = nil
 
     include CLIWrapper
@@ -66,8 +71,8 @@ def self.current_branch
     # Public: Determine if current_branch is reserved
     #
     # Returnsa boolean value
-    def self.reserved_branch?
-      !(current_branch =~ /^(?:#{Git::STAGING_PREFIX}|#{Git::DEPLOYABLE_PREFIX}|#{Git::QAREADY_PREFIX})/).nil?
+    def self.reserved_branch?(branch=current_branch)
+      !(branch =~ /^(?:#{Git::RESERVED_BRANCH_PREFIXES.join('|')})/).nil?
     end
 
     # Public: Check out the given branch name
@@ -129,6 +134,16 @@ def self.alert_dirty_index(message)
       raise DirtyIndex
     end
 
+    def self.alert_reserved_branch(message)
+      cli.say " "
+      cli.say message
+      cli.say " "
+      cli.say "Here's the list of the reserved branch prefixes:"
+      cli.say RESERVED_BRANCH_PREFIXES.join(" ")
+      cli.say " "
+      raise ReservedBranch
+    end    
+
     # Public: Merge the given remote branch into the current branch
     def self.merge(branch_name)
       Git.if_clean do
@@ -291,5 +306,6 @@ def self.stale_branches_to_ignore(additional_branches=[])
     MergeFailed = Class.new(StandardError)
     NoBranchOfType = Class.new(StandardError)
     DirtyIndex = Class.new(StandardError)
+    ReservedBranch = Class.new(StandardError)
   end
 end

lib/octopolo/scripts/new_branch.rb

@@ -6,6 +6,7 @@ module Scripts
     class NewBranch
       include ConfigWrapper
       include GitWrapper
+      include CLIWrapper
 
       attr_accessor :new_branch_name
       attr_accessor :source_branch_name
@@ -22,7 +23,13 @@ def initialize(new_branch_name=nil, source_branch_name=nil)
       # Public: Perform the script
       def execute
         raise ArgumentError unless new_branch_name
-        git.new_branch(new_branch_name, source_branch_name)
+        if !git.reserved_branch?(new_branch_name) || cli.ask_boolean(Git::RESERVED_BRANCH_CONFIRM_MESSAGE)
+          git.new_branch(new_branch_name, source_branch_name)
+        else
+          message = Git::RESERVED_BRANCH_MESSAGE
+          git.alert_reserved_branch message
+          exit 1
+        end
       end
 
       # Public: Provide a default value if none is given

spec/octopolo/scripts/new_branch_spec.rb

@@ -6,13 +6,14 @@ module Scripts
     describe NewBranch do
       let(:config) { stub(:config, :deploy_branch => "production") }
       let(:git) { stub(:Git) }
+      let(:cli) { stub(:Cli) }
       let(:new_branch_name) { stub(:string) }
       let(:custom_source_branch) { stub(:string) }
 
       subject { NewBranch }
 
       before do
-        NewBranch.any_instance.stub(:config => config, :git => git)
+        NewBranch.any_instance.stub(:config => config, :git => git, :cli => cli)
       end
 
       context "::execute" do
@@ -22,15 +23,36 @@ module Scripts
           end
         end
 
-        context "with a only new branch name given" do
+
+        context "with reserved new branch name" do
+          it "exits when aborted" do
+            allow(git).to receive(:reserved_branch?) { true }
+            allow(cli).to receive(:ask_boolean) { false }
+            allow(cli).to receive(:say).with(anything)
+            git.should_receive(:alert_reserved_branch)
+            expect { subject.execute(new_branch_name) }.to raise_error(SystemExit)
+          end
+
+          it "proceeds when confirmed" do
+            allow(git).to receive(:reserved_branch?) { true }
+            allow(cli).to receive(:ask_boolean) { true }
+            allow(cli).to receive(:say).with(anything)
+            git.should_receive(:new_branch).with(new_branch_name, "production")
+            subject.execute(new_branch_name)
+          end
+        end
+
+        context "with only new branch name given" do
           it "delegates to Git.new_branch" do
+            allow(git).to receive(:reserved_branch?) { false }
             git.should_receive(:new_branch).with(new_branch_name, "production")
             subject.execute(new_branch_name)
           end
         end
 
-        context "with a only new branch name given" do
+        context "with new and source branch names given" do
           it "delegates to Git.new_branch" do
+            allow(git).to receive(:reserved_branch?) { false }
             git.should_receive(:new_branch).with(new_branch_name, custom_source_branch)
             subject.execute(new_branch_name, custom_source_branch)
           end