mr_bump 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjZmNTY4ODM4MjMyNzFiNmE4MDY2MWVlOWJmN2YwODhlYzcwYmQwYg==
+    MmYxMTM0MjIwMDQ3ZGFjMTI0ZGEwZGVkNmRmNjA4MWRhNTMyNGQ3OA==
   data.tar.gz: !binary |-
-    ZDZiNWQwYmJiNmJkMzMzZDYzNjZiMmQyNDJhZmQwZmM5Y2Q0ODRhMg==
+    Y2U3ZjMwNGRiZGM3NGQ1YWI2NzNkZWM3ZDZiNDEwYWE4Zjg4ZmMwMA==
 SHA512:
   metadata.gz: !binary |-
-    NGIzNTUwNDc2OTAzOTFhNWY4OGI5MWIyODczMTdkODliYTg2MmUxMWEwNzgx
-    YWE0Mzk1OTA3OWZhMDY5ZWEyZmI3MzIyYTYzMWVkZjdhYjc1NTMxMTE5ZjY3
-    NWU4M2U2ODY0OTMwNjExODRiOTFiZmIwYzkzNTRiNWM0YTJlYjA=
+    MDU1ZGQ1ZTNhMjE5OTdjODZhZTBkZmQxYjcyYjg2NDY2YmVhZWM0MzQ3YzFj
+    NzEwNjg5ZmI3NzM4OTQ2NzdlNGNlYmFmMGIxODkzMjlhODIxYmU1Yjg5NWY0
+    MTVkYjgzYWI4NjNhYmFiZmY3MDk2NTg4YjZlN2JiZDE2ZjBjMzk=
   data.tar.gz: !binary |-
-    ODg4MzE1MzZmZGQzYjJiYTk0Y2IyMWJhNDVjODFkNWQyZmMzMDA2Zjg2MzFl
-    ZTlkZjczY2Y2M2JjMmUyYTgzOGFmOWQ3YTdkNjI5OTI2MTMwMDY4ZWI3OWIw
-    MTg5MWVlNWFkYzAyMjEzZmRmNDBiZGZmZWViZTQ3ZGZjMWM0ZTE=
+    NjI1OTJlY2U4MjU2YjNiM2JmYTUyNmRkNWRhYTA5YzVlYzNkZWU2YjE4N2Ji
+    YTlhMmY2NzkzZGE3MGEzNGIxZGNhMWQxMDlmOWNlYjE4YmU3MzExMGJhODUy
+    YzYxZjNkYTI4YmIzMDIzODQ5OGIyMjNlMTliY2NhMzc3NzYzMWY=

data/bin/mr_bump

@@ -9,12 +9,12 @@ require 'optparse'
 require 'mr_bump'
 require 'mr_bump/git_api'
 
-def menu(text, valid_options, &block)
+def menu(text, valid_options)
   loop do
     print text + ': '
     choice = gets.chomp.upcase
     if valid_options.include? choice
-      block.call(choice)
+      yield(choice)
       break
     else
       puts "I'm sorry Dave; I'm afraid I can't do that."
@@ -35,8 +35,8 @@ OptionParser.new do |parser|
   end
 end.parse!
 
-release = !MrBump.current_branch[/^release/].nil?
-master = !MrBump.current_branch[/^master$/].nil?
+release = MrBump.on_release_branch?
+master = MrBump.on_master_branch?
 
 changelog = "#{`git rev-parse --show-toplevel`.strip}/CHANGELOG.md"
 
@@ -45,9 +45,9 @@ unless release || master
   exit 1
 end
 
-unless master || MrBump.current_branch.to_s == "release/#{MrBump.current_uat_major}"
+unless master || MrBump.current_branch.to_s == MrBump.uat_branch
   puts "On release branch '#{MrBump.current_branch}'. " \
-       "Expected release branch 'release/#{MrBump.current_uat_major}'"
+       "Expected release branch '#{MrBump.uat_branch}'"
   exit 1
 end
 
@@ -94,7 +94,7 @@ unless `git rev-parse @` == `git rev-parse @{u}`
 end
 
 unless MrBump.all_tagged_versions.include? MrBump.current_uat_major
-  base_sha = `git merge_base release/#{MrBump.current_uat_major} develop`
+  base_sha = `git merge-base #{MrBump.uat_branch} develop`
 
   puts "Missing tag for version #{MrBump.current_uat_major}. Suggesting commit #{base_sha[0...8]}"
   puts "\t#{`git log --format="(%ci) %cn - %s" -n 1 #{base_sha}`}"
@@ -112,10 +112,15 @@ end
 
 if release
   last_release = MrBump.current_uat
-  uat_major = MrBump.current_uat_major
-  changes = MrBump.change_log_items_for_range(last_release, "release/#{uat_major}")
+  changes = MrBump.change_log_items_for_range(last_release, MrBump.uat_branch)
 else
   last_release = MrBump.current_master
+  unless last_release
+    puts "Couldn't detect the version of the master branch. " \
+         "At least one tagged version with version less than the current release version " \
+         "(#{MrBump.current_uat_major}) needs to exist"
+    exit 1
+  end
   changes = MrBump.change_log_items_for_range(last_release, 'master')
 end
 
@@ -163,7 +168,7 @@ else
 end
 
 config_file = MrBump.config_file()
-branch_type = release ? "release" : 'master'
+branch_type = release ? 'release' : 'master'
 bump_cmd_exists = config_file.key?('post_bump') &&
                   config_file['post_bump'].key?(branch_type)
 if bump_cmd_exists

data/defaults.yml

@@ -25,3 +25,8 @@
 #   - first_commit_line: The first line of the commit comment
 #   - comment_body: The rest of the lines in the comment
 markdown_template: " * {{branch_type}} - {{dev_id}} - {{first_comment_line}}{{#comment_body}}\n   {{.}}{{/comment_body}}"
+
+# Prefix for release branches, this allows arbitrary text to be added before the version number on a release branch
+release_prefix: release/
+# Suffix for release branches, this allows arbitrary text to be added after the version number on a release branch
+release_suffix: ""

data/lib/mr_bump.rb

@@ -8,19 +8,34 @@ require 'mr_bump/config'
 require 'mr_bump/git_config'
 require 'mr_bump/change'
 
+# Add helper functions to the MrBump namespace
 module MrBump
   def self.current_branch
     @current_branch ||= `git rev-parse --abbrev-ref HEAD`
     @current_branch.strip
   end
 
+  def self.release_branch_regex
+    prefix = Regexp.escape(config_file['release_prefix'])
+    suffix = Regexp.escape(config_file['release_suffix'])
+    "#{prefix}(\\d+\\.\\d+)(\\.\\d+)?#{suffix}"
+  end
+
+  def self.on_release_branch?
+    regex = Regexp.new("^#{release_branch_regex}$")
+    !MrBump.current_branch[regex].nil?
+  end
+
+  def self.on_master_branch?
+    !MrBump.current_branch[/^master$/].nil?
+  end
+
   def self.latest_release_from_list(branches)
-    prefix = 'origin/release[-/]'
-    regex = Regexp.new("^#{prefix}(\\d+\\.\\d+)\\.\\d+$")
+    regex = Regexp.new("^origin/#{release_branch_regex}$")
     branches.map do |branch|
       matches = regex.match(branch)
       MrBump::Version.new(matches[1]) if matches
-    end.compact.max
+    end.compact.max || MrBump::Version.new('0.0.0')
   end
 
   def self.current_uat_major
@@ -28,6 +43,11 @@ module MrBump
     latest_release_from_list(branches)
   end
 
+  def self.uat_branch
+    config = MrBump.config_file
+    "#{config['release_prefix']}#{current_uat_major}#{config['release_suffix']}"
+  end
+
   def self.all_tags
     `git tag -l`.each_line.map(&:strip)
   end
@@ -53,7 +73,8 @@ module MrBump
   end
 
   def self.merge_logs(rev, head)
-    git_cmd = "git log --pretty='format:%B' --grep '(^Merge pull request | into #{current_branch}$)' --merges -E"
+    git_cmd = "git log --pretty='format:%B' --grep " \
+              "'(^Merge pull request | into #{current_branch}$)' --merges -E"
     log = `#{git_cmd} #{rev}..#{head}`
     log.each_line.map(&:strip).select { |str| !(str.nil? || str == '' || str[0] == '#') }
   end

data/lib/mr_bump/git_api.rb

@@ -6,6 +6,8 @@ require 'octokit'
 module MrBump
   # This class makes calls to the github API
   class GitApi
+    attr_accessor :client
+
     def initialize(token)
       @client = Octokit::Client.new(access_token: token)
     end

data/lib/mr_bump/git_config.rb

@@ -11,8 +11,7 @@ module MrBump
       '(?<repo_name>[\w_\-\d\.]+?)(\.git)?$'
     ).freeze
 
-    def initialize(origin, repo_name, repo_host, repo_path, username, user)
-      @origin = origin
+    def initialize(repo_name, repo_host, repo_path, username, user)
       @repo_name = repo_name
       @repo_url = repo_host + '/' + repo_path + '/'
       @host = repo_host
@@ -25,14 +24,8 @@ module MrBump
       match = GITHUB_URL_REGEX.match(origin)
       raise ArgumentError,
             "Couldn't parse needed information from remote url '#{git_url}'" unless match
-      GitConfig.new(
-        origin,
-        match['repo_name'],
-        "https://#{match['domain']}",
-        "#{match['path']}/#{match['repo_name']}",
-        match['user'],
-        user
-      )
+      GitConfig.new(match['repo_name'], "https://#{match['domain']}",
+                    "#{match['path']}/#{match['repo_name']}", match['user'], user)
     end
 
     def self.from_current_path

data/lib/mr_bump/slack.rb

@@ -11,7 +11,7 @@ module MrBump
       @webhook = opts['webhook_url']
       @username = opts['username'] || 'Mr Bump'
       @jira_url = opts['jira_url']
-      @icon = (opts['icon'].is_a? Array) ? opts['icon'].sample : opts['icon']
+      @icon = opts['icon'].is_a? Array ? opts['icon'].sample : opts['icon']
       @git = git_config
     end
 
@@ -52,10 +52,11 @@ module MrBump
       end.join
     end
 
+    # rubocop:disable Metrics/MethodLength
     def attatchment(version, changes)
       {
         fallback: changes,
-        color: "#009de4",
+        color: '#009de4',
         author_name: @git.user,
         author_icon: @git.user_icon,
         author_link: @git.user_link,
@@ -66,7 +67,7 @@ module MrBump
           jira_field(changes),
           { value: git_shas(changes), short: true }
         ],
-        mrkdwn_in: ["text", "title", "fallback", "fields"]
+        mrkdwn_in: %w(text title fallback fields)
       }
     end
   end

data/lib/mr_bump/version.rb

@@ -12,14 +12,14 @@ module MrBump
       regex = Regexp.new('^([0-9]+)(\.([0-9]+)(\.([0-9]*))?)?')
       numbers = version_str.match(regex).captures
       @major = numbers[0].to_i
-      @minor = (numbers.size > 2) ? numbers[2].to_i : 0
-      @patch = (numbers.size > 4) ? numbers[4].to_i : 0
+      @minor = numbers.size > 2 ? numbers[2].to_i : 0
+      @patch = numbers.size > 4 ? numbers[4].to_i : 0
     end
 
     def <=>(other)
       major_com = major <=> other.major
-      minor_com = (major_com == 0) ? minor <=> other.minor : major_com
-      (minor_com == 0) ? patch <=> other.patch : minor_com
+      minor_com = major_com.zero? ? minor <=> other.minor : major_com
+      minor_com.zero? ? patch <=> other.patch : minor_com
     end
 
     def to_s

data/spec/git_config_spec.rb

@@ -21,11 +21,11 @@ describe MrBump::GitConfig do
       expect(config.username.nil?)
     end
 
-    it "extracts correct host" do
+    it 'extracts correct host' do
       expect(config.host).to eq('https://github.com')
     end
 
-    it "extracts the correct path" do
+    it 'extracts the correct path' do
       expect(config.path).to eq('xulaus/mr_bump')
     end
   end
@@ -43,11 +43,11 @@ describe MrBump::GitConfig do
       expect(config.username).to eq('xulaus')
     end
 
-    it "extracts correct host" do
+    it 'extracts correct host' do
       expect(config.host).to eq('https://github.com')
     end
 
-    it "extracts the correct path" do
+    it 'extracts the correct path' do
       expect(config.path).to eq('xulaus/mr_bump')
     end
   end
@@ -65,11 +65,11 @@ describe MrBump::GitConfig do
       expect(config.username.nil?)
     end
 
-    it "extracts correct host" do
+    it 'extracts correct host' do
       expect(config.host).to eq('https://github.com')
     end
 
-    it "extracts the correct path" do
+    it 'extracts the correct path' do
       expect(config.path).to eq('xulaus/mr_bump')
     end
   end

data/spec/mr_bump_spec.rb

@@ -125,9 +125,20 @@ describe MrBump do
   end
 
   describe '#latest_release_from_list' do
+    before(:each) { allow(MrBump).to receive(:config_file).and_return(config) }
+    let(:result) { MrBump.latest_release_from_list(branch_list) }
+    let(:config) do
+      {
+        'release_prefix' => "release#{separator}",
+        'release_suffix' => suffix
+      }
+    end
+    let(:suffix) { '' }
+    let(:separator) { '/' }
+
     context 'With many release branches and using slash separator' do
-      it 'extracts the highest version' do
-        branch_list = [
+      let(:branch_list) do
+        [
           'origin/release/10.16.0',
           'origin/release/10.15.9',
           'origin/release/10.1.0',
@@ -136,25 +147,31 @@ describe MrBump do
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+
+      it 'extracts the highest version' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
       end
     end
 
     context 'With a single release branch and using slash separator' do
-      it 'extracts the version' do
-        branch_list = [
+      let(:branch_list) do
+        [
           'origin/release/10.16.9',
           'origin/rse/1.2.0',
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+
+      it 'extracts the version' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
       end
     end
 
     context 'With many release branches and minor versions and using slash separator' do
-      it 'extracts the highest version with patch version set to 0' do
-        branch_list = [
+      let(:branch_list) do
+        [
           'origin/release/10.16.0',
           'origin/release/10.15.9',
           'origin/release/10.1.0',
@@ -164,74 +181,249 @@ describe MrBump do
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+
+      it 'extracts the highest version with patch version set to 0' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
       end
     end
 
     context 'With a single release branch with a patch number and using slash separator' do
-      it 'extracts the version with patch version set to 0' do
-        branch_list = [
+      let(:branch_list) do
+        [
           'origin/release/10.16.9',
           'origin/rse/1.2.0',
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+
+      it 'extracts the version with patch version set to 0' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
       end
     end
 
-    context 'With many release branches and using dash separator' do
-      it 'extracts the highest version' do
-        branch_list = [
-          'origin/release-10.16.0',
-          'origin/release-10.15.9',
-          'origin/release-10.1.0',
-          'origin/release-10.15.0',
-          'origin/rse-10.16.0',
-          'origin/master',
-          ''
+    context 'With no release branches' do
+      let(:branch_list) do
+        [
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+
+      it 'returns 0.0.0 as the version' do
+        expect(result).to eq(MrBump::Version.new('0.0.0'))
       end
     end
 
-    context 'With a single release branch and using dash separator' do
-      it 'extracts the version' do
-        branch_list = [
-          'origin/release-10.16.9',
-          'origin/rse-1.2.0',
+    context 'With many release branches and changing the default prefix' do
+      let(:branch_list) do
+        [
+          'origin/release?10.16.0',
+          'origin/release/10.17.0',
+          'origin/release?10.15.9',
+          'origin/release/10.1.0',
+          'origin/release/10.15.0',
+          'origin/rse/10.16.0',
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+      let(:separator) { '?' }
+
+      it 'extracts the correct highest version, igoring branches with incorrect prefix' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
       end
     end
 
-    context 'With many release branches and minor versions and using dash separator' do
-      it 'extracts the highest version with patch version set to 0' do
-        branch_list = [
-          'origin/release-10.16.0',
-          'origin/release-10.15.9',
-          'origin/release-10.1.0',
-          'origin/release-10.15.0',
-          'origin/release-10.16.9',
-          'origin/rse-10.16.0',
+    context 'With many release branches and changing the default suffix' do
+      let(:branch_list) do
+        [
+          'origin/release/10.16.0.',
+          'origin/release/10.17.0.',
+          'origin/release/10.15.9.',
+          'origin/release/10.1.0.',
+          'origin/release/10.15.0',
+          'origin/release/10.18.0',
+          'origin/rse/10.16.0',
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+      let(:suffix) { '.' }
+
+      it 'extracts the correct highest version, igoring branches with incorrect suffix' do
+        expect(result).to eq(MrBump::Version.new('10.17.0'))
       end
     end
 
-    context 'With a single release branch with a patch number and using dash separator' do
-      it 'extracts the version with patch version set to 0' do
-        branch_list = [
-          'origin/release-10.16.9',
-          'origin/rse-1.2.0',
+    context 'With many release branches and changing the default prefix' do
+      let(:branch_list) do
+        [
+          'origin/release?10.16.0?',
+          'origin/release/10.17.0?',
+          'origin/release?10.15.9?',
+          'origin/release/10.1.0?',
+          'origin/release/10.15.0?',
+          'origin/release/11.1.0',
+          'origin/release/11.15.0',
+          'origin/release?12.1.0',
+          'origin/release?12.15.0',
+          'origin/rse/10.16.0?',
           'origin/master',
           ''
         ]
-        expect(MrBump.latest_release_from_list(branch_list)).to eq(MrBump::Version.new('10.16.0'))
+      end
+      let(:separator) { '?' }
+      let(:suffix) { '?' }
+
+      it 'extracts the correct highest version, igoring branches with incorrect prefix or suffix' do
+        expect(result).to eq(MrBump::Version.new('10.16.0'))
+      end
+    end
+  end
+
+  describe '#on_master_branch?' do
+    before(:each) { allow(MrBump).to receive(:current_branch).and_return(current_branch) }
+
+    context 'when on a branch called master' do
+      let(:current_branch) { 'master' }
+
+      it 'returns true' do
+        expect(MrBump.on_master_branch?).to eq(true)
+      end
+    end
+
+    context 'when on a branch called master$' do
+      let(:current_branch) { 'master$' }
+
+      it 'returns false' do
+        expect(MrBump.on_master_branch?).to eq(false)
+      end
+    end
+
+    context 'when on a branch called ^master' do
+      let(:current_branch) { '^master' }
+
+      it 'returns false' do
+        expect(MrBump.on_master_branch?).to eq(false)
+      end
+    end
+
+    context 'when on a branch called release' do
+      let(:current_branch) { 'release' }
+
+      it 'returns false' do
+        expect(MrBump.on_master_branch?).to eq(false)
+      end
+    end
+  end
+
+  describe '#on_release_branch?' do
+    before(:each) { allow(MrBump).to receive(:current_branch).and_return(current_branch) }
+    before(:each) { allow(MrBump).to receive(:config_file).and_return(config) }
+
+    context 'with default config' do
+      let(:config) do
+        {
+          'release_prefix' => 'release/',
+          'release_suffix' => ''
+        }
+      end
+      context 'when on a branch called master' do
+        let(:current_branch) { 'master' }
+
+        it 'returns false' do
+          expect(MrBump.on_release_branch?).to eq(false)
+        end
+      end
+
+      context 'when on a branch called release/' do
+        let(:current_branch) { 'release/' }
+
+        it 'returns false' do
+          expect(MrBump.on_release_branch?).to eq(false)
+        end
+      end
+
+      context 'when on a branch called release/0.0.0' do
+        let(:current_branch) { 'release/0.0.0' }
+
+        it 'returns true' do
+          expect(MrBump.on_release_branch?).to eq(true)
+        end
+      end
+
+      context 'when on a branch called release/0.0' do
+        let(:current_branch) { 'release/0.0' }
+
+        it 'returns true' do
+          expect(MrBump.on_release_branch?).to eq(true)
+        end
+      end
+    end
+
+    context 'with altered config' do
+      let(:config) do
+        {
+          'release_prefix' => '?v',
+          'release_suffix' => '+'
+        }
+      end
+
+      context 'branch with correct prefix and suffix' do
+        let(:current_branch) { '?v0.0.0+' }
+
+        it 'returns true' do
+          expect(MrBump.on_release_branch?).to eq(true)
+        end
+      end
+
+      context 'branch with correct prefix and suffix and missing patch version' do
+        let(:current_branch) { '?v0.0+' }
+
+        it 'returns true' do
+          expect(MrBump.on_release_branch?).to eq(true)
+        end
+      end
+
+      context 'on a branch which is valid  with default config' do
+        let(:current_branch) { 'release/0.0.0' }
+
+        it 'returns false' do
+          expect(MrBump.on_release_branch?).to eq(false)
+        end
+      end
+    end
+  end
+
+  describe '#uat_branch?' do
+    before(:each) do
+      allow(MrBump).to receive(:current_uat_major).and_return(MrBump::Version.new('0.0.0'))
+    end
+    before(:each) { allow(MrBump).to receive(:config_file).and_return(config) }
+
+    context 'with default config' do
+      let(:config) do
+        {
+          'release_prefix' => 'release/',
+          'release_suffix' => ''
+        }
+      end
+
+      it 'correctly constucts uat branch name' do
+        expect(MrBump.uat_branch).to eq('release/0.0.0')
+      end
+    end
+
+    context 'with altered config' do
+      let(:config) do
+        {
+          'release_prefix' => '?v',
+          'release_suffix' => '+'
+        }
+      end
+
+      it 'correctly constucts uat branch name' do
+        expect(MrBump.uat_branch).to eq('?v0.0.0+')
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mr_bump
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Fitzgerald