knife-changelog 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 611393857429ed8e5091d457a902862327d2f336222629a8d1242a276c9b553f
-  data.tar.gz: 2f1d638388d31c667ae0d6c22313e53c56c42cd0ffbb8d38706c4819f83395e6
+  metadata.gz: b8a6814c2c33a531b39095d40b5a29eac42e0d1d9f9771594eab6acf5585a2c1
+  data.tar.gz: 7e0be550e063acdb2b24fd8053815ddf5c19b9599c05147761227c28d2a946be
 SHA512:
-  metadata.gz: e9ebf4ae12169de498bd4933bfa0a71579b83db669a4f7e4c8bfd2d4c19689c5b8a732db9355fc3165b215abbb7e433f330f6a9e3b802540babad50f52de0c28
-  data.tar.gz: b7d3b7140e41ee4b7b5912580913471bb16be2113aaa69675ef70c33420ff5573ebf2481c8532398d90d586db204c8878160021ff825cc05aace5337eecc16e5
+  metadata.gz: 6aa98d7ed974e17573f0ee28898f0475dc7629d1cd1f547e96152fafbe6e0c62ba5f1e6ab14228864e909bd1de7bc9be72e516dc2260cf431e4a90567f7a91c7
+  data.tar.gz: 6e40a18276224d6de4cff58176e18f3a7b2467949b6328504c0704514fc518519cdb49fa2eab7bbc5b735205e284e37f69fae6889176b5f9d73faf18b362f9e5

data/knife-changelog.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'knife-changelog'
-  spec.version       = '1.2.2'
+  spec.version       = '1.2.3'
   spec.authors       = ['Gregoire Seux']
   spec.email         = ['kamaradclimber@gmail.com']
   spec.summary       = 'Facilitate access to cookbooks changelog'

data/lib/knife/changelog/policyfile.rb

@@ -104,52 +104,31 @@ class PolicyChangelog
   def git_changelog(source_url, current, target)
     dir = Dir.mktmpdir(TMP_PREFIX)
     repo = Git.clone(source_url, dir)
-    if tag_format(repo) == 'v'
-      c_tag, t_tag = correct_tags("v#{current}", "v#{target}", repo)
-      repo.log.between(c_tag, t_tag)
-    else
-      c_tag, t_tag = correct_tags(current, target, repo)
-      repo.log.between(c_tag, t_tag)
-    end.map do |commit|
+    repo.log.between(git_ref(current, repo), git_ref(target, repo)).map do |commit|
       "#{commit.sha[0, 7]} #{commit.message.lines.first.strip}"
     end.join("\n")
   end
 
-  # Used to make #git_changelog method more readable
-  #
-  # @param current [String] current cookbook version tag
-  # @param target [String] target cookbook version tag
-  # @param repo [Git::Base] Git repository object
-  # @return [true, false]
-  def correct_tags(current, target, repo)
-    [git_tag(current, repo), git_tag(target, repo)]
-  end
-
-  # Tries to convert a supermarket tag to a git tag
+  # Tries to convert a supermarket tag to a git reference
   # if there is a difference in formatting between the two.
   # This is issue is present for the 'java' cookbook.
   # https://github.com/agileorbit-cookbooks/java/issues/450
   #
-  # @param tag [String] version tag
+  # @param ref [String] version reference
   # @param repo [Git::Base] Git repository object
   # @return [String]
-  def git_tag(tag, repo)
-    return tag if repo.checkout(tag)
-  rescue ::Git::GitExecuteError
-    begin
-      rescue_tag = tag.chomp('.0') if tag[/\.0$/]
-      return rescue_tag if repo.checkout(rescue_tag)
-    rescue ::Git::GitExecuteError
-      raise 'Difference between Git and Supermarket tags'
+  def git_ref(myref, repo)
+    possible_refs = ['v' + myref, myref]
+    possible_refs += possible_refs.map { |ref| ref.chomp('.0') } if myref[/\.0$/]
+    existing_ref = possible_refs.find do |ref|
+      begin
+        repo.checkout(ref)
+      rescue ::Git::GitExecuteError
+        false
+      end
     end
-  end
-
-  # Detects the format of a Git tag - v1.0.0 or 1.0.0
-  #
-  # @param repo [Git::Base] Git repository object
-  # @return [String] Git tag versioning type
-  def tag_format(repo)
-    sort_by_version(repo.tags).last.name[/^v/] ? 'v' : ''
+    raise "Impossible to find existing references to #{possible_refs} in #{repo.remote.url}" unless existing_ref
+    existing_ref
   end
 
   # Sort tags by version and filter out invalid version tags

data/spec/unit/policyfile_spec.rb

@@ -179,10 +179,10 @@ RSpec.describe PolicyChangelog do
 
     context 'when given two tags' do
       it 'generates a changelog between two tags' do
-        allow(changelog).to receive(:tag_format).and_return('v')
         allow(git).to receive(:clone).and_return(git_repo)
+        allow(changelog).to receive(:git_ref).with('1.0.0', any_args).and_return('v1.0.0')
+        allow(changelog).to receive(:git_ref).with('1.0.1', any_args).and_return('v1.0.1')
         allow(changelog).to receive(:correct_tags)
-          .and_return(['v1.0.0', 'v1.0.1'])
         allow(git_repo).to receive_message_chain(:log, :between)
           .with('v1.0.0', 'v1.0.1')
           .and_return([git_commit])
@@ -193,51 +193,35 @@ RSpec.describe PolicyChangelog do
     end
   end
 
-  describe '#git_tag' do
+  describe '#git_ref' do
     let(:repo) { double('repo') }
 
     context 'when tag valid' do
       it 'returns correct git tag' do
+        allow(repo).to receive(:checkout).with('v1.0.0').and_raise(::Git::GitExecuteError)
         allow(repo).to receive(:checkout).with('1.0.0').and_return(true)
 
-        expect(changelog.git_tag('1.0.0', repo)).to eq('1.0.0')
+        expect(changelog.git_ref('1.0.0', repo)).to eq('1.0.0')
       end
     end
 
     context 'when tag invalid and able to correct' do
       it 'returns correct git tag' do
+        allow(repo).to receive(:checkout).with(/v1.0/).and_raise(::Git::GitExecuteError)
         allow(repo).to receive(:checkout).with('1.0.0').and_raise(::Git::GitExecuteError)
         allow(repo).to receive(:checkout).with('1.0').and_return(true)
 
-        expect(changelog.git_tag('1.0.0', repo)).to eq('1.0')
+        expect(changelog.git_ref('1.0.0', repo)).to eq('1.0')
       end
     end
 
     context 'when tags invalid and unable to correct' do
       it 'raises exception' do
-        allow(repo).to receive(:checkout).with('1.0.0').and_raise(::Git::GitExecuteError)
-        allow(repo).to receive(:checkout).with('1.0').and_raise(::Git::GitExecuteError)
-
-        expect { changelog.git_tag('1.0.0', repo) }
-          .to raise_error(RuntimeError, 'Difference between Git and Supermarket tags')
-      end
-    end
-  end
-
-  describe '#tag_format' do
-    context 'when it receives a tag' do
-      let(:repo) { Git::Base }
-
-      it 'detects type for regular tag' do
-        allow(repo).to receive_message_chain(:tags, :last, :name).and_return('1.0.0')
-        allow(changelog).to receive(:sort_by_version).and_return(repo.tags)
-        expect(changelog.tag_format(repo)).to eq('')
-      end
+        allow(repo).to receive(:remote).and_return(double('remote', url: 'url.com'))
+        allow(repo).to receive(:checkout).with(any_args).and_raise(::Git::GitExecuteError)
 
-      it 'detects type for v-tag' do
-        allow(repo).to receive_message_chain(:tags, :last, :name).and_return('v1.0.0')
-        allow(changelog).to receive(:sort_by_version).and_return(repo.tags)
-        expect(changelog.tag_format(repo)).to eq('v')
+        expect { changelog.git_ref('1.0.0', repo) }
+          .to raise_error(RuntimeError, /Impossible to find existing/)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler