renogen 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f61827e5a1a1224d86a20cddecf5757ace8719f2c6e38120e859f8951289814
-  data.tar.gz: f1174f4d416402cbf025a5a05f3f2f5ca00c436cecc032c6b87399dac7422bed
+  metadata.gz: 882d9056311e5a9baba8dd05bd1ec8c2ada3e5d84d612abbb15940140e07f9ed
+  data.tar.gz: ece836f07e37055b4d84180c7c9522d32814e5c1839e2484e4cf2354acff29f2
 SHA512:
-  metadata.gz: 6683b5861e4d779967bf100a6683be6c6dccfe64e099906f6991caa266e5a976601c96a9905d8e89d91d2a958190301b3d7c54f79e7a644ff27319f8f50da926
-  data.tar.gz: aebbc3dcdf470a7882cf2c038406085d9233774f828675a7b5c0e787899c5be6ccb297419c9a82d92e9e64d172a73dcc71f2a6258aedf893c9dd8e16adbbec3e
+  metadata.gz: 0d2edd0513ee545a1b26e0f78846deb543e38ba0227e96d92b6497435916563684f61df58673650e12634e647bdae4e0cde547ee38052d6f53b5f4ea01a2d76e
+  data.tar.gz: 6395af9fc76aefa6a3f126cc633aeca9eb80330eb6ab95f59be48f04522ead09f13ab3bf70e96eb923d20c7421d26266634aa7b05f5da52d960ef4ee517477c9

data/README.md

@@ -138,6 +138,7 @@ with the following keys:
 | `changelog_path`     | The directory where the feature note files are stored. | `./change_log` | `./doc/src/changes` |
 | `default_headings`   | The headings/group names that will be printed into a feature note file created by the `new` command. Ignored when there is a rule defined for the given file name. | `%w[Summary Detailed Tasks]` | `%w[Title Description Deployment]` |
 | `allowed_values`     | Allowed values for default headings.  See [Allowed Values](#AllowedValues). | `{}` (none) |  |
+| `remove_duplicates`  | Remove duplicate items from output release notes. Not applicable when using table formats (e.g`csv` or `markdown_table`). | `false` | |
 
 <a name="AllowedValues"></a>
 ## Allowed Values

data/lib/renogen/change_log/writer.rb

@@ -50,10 +50,22 @@ module Renogen
       def output_groups(groups)
         groups.each do |group, changes|
           puts formatter.write_group(group)
-          changes.each { |change| output_change(change) }
+          deduped_changes(changes).each { |change| output_change(change) }
           puts formatter.write_group_end
         end
       end
+
+      def deduped_changes(changes)
+        return changes unless config.remove_duplicates
+
+        changes.uniq { |c| c.to_s }
+      end
+
+      private
+
+      def config
+        Config.instance
+      end
     end
   end
 end

data/lib/renogen/config.rb

@@ -8,7 +8,7 @@ module Renogen
   class Config
     include Singleton
     attr_accessor :single_line_format, :input_source, :output_format, :supported_keys, :changelog_path,
-                  :default_headings, :validations
+                  :default_headings, :validations, :remove_duplicates
 
     def initialize
       config_file = load_yaml_config
@@ -19,6 +19,7 @@ module Renogen
       self.changelog_path = config_file['changelog_path'] || './change_log'
       self.default_headings = config_file['default_headings'] || %w(Summary Detailed Tasks)
       self.validations = config_file['allowed_values']
+      self.remove_duplicates = config_file['remove_duplicates'] || false
     end
 
     # Renogen configuration extension

data/lib/renogen/version.rb

@@ -1,3 +1,3 @@
 module Renogen
-  VERSION = '1.3.1'.freeze # :nodoc:
+  VERSION = '1.4.0'.freeze # :nodoc:
 end

data/spec/lib/renogen/change_log/writer_spec.rb

@@ -36,6 +36,9 @@ describe Renogen::ChangeLog::Writer do
         expected_output.split("\n").each do |line|
           expect($stdout.gets.strip).to eq(line)
         end
+
+        # read remaining output and check we reached the end
+        expect($stdout.read.gsub("\n", '')).to be_empty
       end
     end
 
@@ -143,5 +146,60 @@ describe Renogen::ChangeLog::Writer do
 
       it_behaves_like 'a valid output format'
     end
+
+    describe 'duplicates' do
+      let(:formatter) { Renogen::Formatters::PlainText.new }
+      let(:changes_with_duplicates) do
+        [
+          renogen_change(1, 'Group 1', 'This is a Group 1 change'),
+          renogen_change(1, 'Group 2', 'This is a Group 2 change'),
+          renogen_change(2, 'Group 1', 'This is a Group 1 change'),
+          renogen_change(2, 'Group 2', 'This is a Group 2 change')
+        ]
+      end
+
+      context 'when remove duplicates is false in config (default)' do
+        it_behaves_like 'a valid output format' do
+          let(:changes) { changes_with_duplicates }
+
+          let(:expected_output) do
+            <<~EOS
+              test (2020-07-08)
+
+              Group 1
+              - This is a Group 1 change
+              - This is a Group 1 change
+
+              Group 2
+              - This is a Group 2 change
+              - This is a Group 2 change
+            EOS
+          end
+        end
+      end
+
+      context 'when remove duplicates is true in config' do
+        before do
+          allow(Renogen::Config.instance)
+            .to receive(:remove_duplicates).and_return(true)
+        end
+
+        it_behaves_like 'a valid output format' do
+          let(:changes) { changes_with_duplicates }
+
+          let(:expected_output) do
+            <<~EOS
+              test (2020-07-08)
+
+              Group 1
+              - This is a Group 1 change
+
+              Group 2
+              - This is a Group 2 change
+            EOS
+          end
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renogen
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Dave Elliott