knife-changelog 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69172c86c7b7796d3ec52bc1738688d33dcef55ccdf98d4f171cff25b9ee03a1
-  data.tar.gz: 94329ddcd6763e6d6ab8d510ce5e06850f93798e026405bf3d114fd51e13a7cf
+  metadata.gz: a8c08f818e37b6f6f8dedf0ac339c7f2630eb2274c7d8a2b4972aeb32cb0f33a
+  data.tar.gz: 8c2201411c66858acdad4549da4a4d72cb9f2b90c157b1b4fa584b597ae4eb9d
 SHA512:
-  metadata.gz: 2eef04a07df70eae15e9d5b8158c5956fb7782e5ad678545d65164b027aacf17e80c17d2efd9100644b46aed638b85f6cdd437f0877a31d7041351d7a8b3f8f6
-  data.tar.gz: 43a215deba3fae621e9c156acfbc8a0ebb8101a94c15932e355fefbfba6532457fe31f25bd277c9e054bdcd8afcd868270e78ac8155780dee75220d06069bb9a
+  metadata.gz: 3dfadbf13353ae064112f338fd037208318bf875c91007bc59bb366154677bed539066929c1b70c79b1cf572358285234b3eade84345ca09c2bc0c7b6ad8878f
+  data.tar.gz: f7c58bc018fedc0c91a1a745637036741f7990760d9632a7723c9a04f0286ede092bfa910a1d379e8cefe14f545434ff286d87626e4944d7455d724311ddb7cb

data/lib/chef/knife/changelog.rb

@@ -55,7 +55,7 @@ class Chef
       def run
         Log.info config
         if config[:policyfile] && File.exist?(config[:policyfile])
-          PolicyChangelog.new(@name_args, config[:policyfile]).generate_changelog
+          puts PolicyChangelog.new(@name_args, config[:policyfile]).generate_changelog
         else
           berksfile = Berkshelf::Berksfile.from_options({})
           puts KnifeChangelog::Changelog::Berksfile

data/lib/knife/changelog/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Changelog
-    VERSION = '1.0.7'.freeze
+    VERSION = '1.0.8'.freeze
   end
 end

data/lib/policyfile.rb

@@ -25,19 +25,13 @@ class PolicyChangelog
   #
   # @return update_dir [String] tmp directory with updated Policyfile.lock
   def update_policyfile_lock
-    update_dir = Dir.mktmpdir
-    %w[Policyfile.rb Policyfile.lock.json].each do |file|
-      FileUtils.cp(
-        File.join(@policyfile_dir, file),
-        update_dir
-      )
-    end
+    backup_dir = Dir.mktmpdir
+    FileUtils.cp(File.join(@policyfile_dir, 'Policyfile.lock.json'), backup_dir)
     updater = ChefDK::Command::Update.new
-    updater.run([
-      File.join(update_dir, 'Policyfile.rb'),
-      @cookbooks_to_update
-    ].flatten)
-    update_dir
+    updater.run([@policyfile_path, @cookbooks_to_update].flatten)
+    updated_policyfile_lock = read_policyfile_lock(@policyfile_dir)
+    FileUtils.cp(File.join(backup_dir, 'Policyfile.lock.json'), @policyfile_dir)
+    updated_policyfile_lock
   end
 
   # Parses JSON in Policyfile.lock.
@@ -153,15 +147,16 @@ class PolicyChangelog
     repo.tags.last.name[/^v/] ? 'v' : ''
   end
 
-  # Prints out commit changelog in a nicely formatted way
+  # Formats commit changelog to be more readable
   #
   # @param name [String] cookbook name
   # @param data [Hash] cookbook versions and source url data
-  def print_commit_changelog(name, data)
-    output = "\nChangelog for #{name}: #{data['current_version']}->#{data['target_version']}"
-    puts output
-    puts '=' * output.size
-    puts git_changelog(data['source_url'], data['current_version'], data['target_version'])
+  # @return [String] formatted changelog
+  def format_output(name, data)
+    output = ["\nChangelog for #{name}: #{data['current_version']}->#{data['target_version']}"]
+    output << '=' * output.first.size
+    output << git_changelog(data['source_url'], data['current_version'], data['target_version'])
+    output.join("\n")
   end
 
   # Filters out cookbooks which are not updated, are not used after update or
@@ -177,11 +172,13 @@ class PolicyChangelog
   end
 
   # Generates Policyfile changelog
+  #
+  # @return [String] formatted version changelog
   def generate_changelog
     lock_current = read_policyfile_lock(@policyfile_dir)
     current = versions(lock_current['cookbook_locks'], 'current')
 
-    lock_target = read_policyfile_lock(update_policyfile_lock)
+    lock_target = update_policyfile_lock
     target = versions(lock_target['cookbook_locks'], 'target')
 
     updated_cookbooks = current.deep_merge(target).reject { |_name, data| reject_version_filter(data) }
@@ -189,6 +186,7 @@ class PolicyChangelog
     updated_cookbooks.each_key do |name|
       sources[name] = get_source_url(lock_target['cookbook_locks'][name]['source_options'])
     end
-    updated_cookbooks.deep_merge(sources).each { |name, data| print_commit_changelog(name, data) }
+    updated_cookbooks.deep_merge(sources).map { |name, data| format_output(name, data) }.join("\n")
   end
 end
+

data/spec/unit/policyfile_spec.rb

@@ -8,8 +8,8 @@ RSpec.describe PolicyChangelog do
     File.expand_path(File.join(File.dirname(__FILE__), '../data'))
   end
 
-  let(:tmp_dir) do
-    File.join(pf_dir, 'tmp_dir')
+  let(:target_dir) do
+    File.join(pf_dir, 'updated')
   end
 
   let(:changelog) do
@@ -21,7 +21,7 @@ RSpec.describe PolicyChangelog do
   end
 
   let(:lock_target) do
-    JSON.parse(File.read(File.join(tmp_dir, 'Policyfile.lock.json')))
+    JSON.parse(File.read(File.join(target_dir, 'Policyfile.lock.json')))
   end
 
   let(:current_versions) do
@@ -249,11 +249,15 @@ RSpec.describe PolicyChangelog do
     context 'when generating a changelog' do
       it 'detects type for regular tag' do
         allow(changelog).to receive(:update_policyfile_lock)
-          .and_return(tmp_dir)
+          .and_return(changelog.read_policyfile_lock(target_dir))
         allow(changelog).to receive(:git_changelog)
           .and_return('e1b971a Add test commit message')
 
-        expect { changelog.generate_changelog }.not_to raise_error(RuntimeError)
+        output = "\nChangelog for users: 4.0.0->5.3.1\n" \
+          "==================================\n"         \
+          "e1b971a Add test commit message"
+
+        expect(changelog.generate_changelog).to eq(output)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Gregoire Seux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ files:
 - spec/data/Berksfile.lock
 - spec/data/Policyfile.lock.json
 - spec/data/Policyfile.rb
-- spec/data/tmp_dir/Policyfile.lock.json
+- spec/data/updated/Policyfile.lock.json
 - spec/spec_helper.rb
 - spec/unit/changelog_spec.rb
 - spec/unit/policyfile_spec.rb
@@ -252,7 +252,7 @@ test_files:
 - spec/data/Berksfile.lock
 - spec/data/Policyfile.lock.json
 - spec/data/Policyfile.rb
-- spec/data/tmp_dir/Policyfile.lock.json
+- spec/data/updated/Policyfile.lock.json
 - spec/spec_helper.rb
 - spec/unit/changelog_spec.rb
 - spec/unit/policyfile_spec.rb