renogen 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 441ccac5869c9d78abc7c3d163a851c4341d29b2
-  data.tar.gz: 78e083dde9bba0f04c01c9ce4fe37ac6a3c862b6
+SHA256:
+  metadata.gz: 882d9056311e5a9baba8dd05bd1ec8c2ada3e5d84d612abbb15940140e07f9ed
+  data.tar.gz: ece836f07e37055b4d84180c7c9522d32814e5c1839e2484e4cf2354acff29f2
 SHA512:
-  metadata.gz: c5851785f48aed5505e8b1506c9f5752b6c49c24dca5488110f9a28fdc0d02b33b90c399c3db571beb65d77d908892fdb30f6e8f335bd8b701ec9744f3eb7979
-  data.tar.gz: 96f6024f0e7decc226d44ce9b55d9f746aa3e2a272a0033b82d219558f1396e65207daae4330f40001b23484bc72a0182cdc48b77b237d92595798e8e9a03d25
+  metadata.gz: 0d2edd0513ee545a1b26e0f78846deb543e38ba0227e96d92b6497435916563684f61df58673650e12634e647bdae4e0cde547ee38052d6f53b5f4ea01a2d76e
+  data.tar.gz: 6395af9fc76aefa6a3f126cc633aeca9eb80330eb6ab95f59be48f04522ead09f13ab3bf70e96eb923d20c7421d26266634aa7b05f5da52d960ef4ee517477c9

data/README.md

@@ -2,42 +2,76 @@
 
 Renogen or Re(lease) No(tes) Gen(erator) is a development tool to separate feature notes from product versions.
 
-
 This renogen can not do and will have to be reviewed manually
+
 - Order the notes in the orrect order (e.g. if a task has to be run before/after something else)
 - Remove Duplicate notes that might be added (e.g. 2 tickets might want to run the same task)
 
+## Contents
 
-### Installation
+- [Installation](#Installation)
+- [Usage](#Usage)
+- [Configuration](#Configuration)
+- [Frequently Asked Questions](#FAQ)
+- [License](#License)
+
+<a name="Installation"></a>
+## Installation
 
 To install Renogen, use the following command:
 
-`$ gem install renogen`
+```
+$ gem install renogen
+```
+
+or add the following to your Gemfile when using Bundler
+
+```
+gem 'renogen', require: false, group: :development
+```
+
+and run
+
+```
+bundle install
+```
 
-or add the following to your Gemfile
+If you would prefer you can use a prebuild docker image.
 
-`gem 'renogen', :require => false, :group => :development`
+Example:
 
-`$ renogen init # optional  Creates directory for notes`
+```bash
+$ docker run --rm -v `pwd`/.renogen:/.renogen:ro -v `pwd`/change_log:/change_log/ ddazza/renogen <CMD>
+```
 
-`$ renogen --help # List available options`
+Now, you may initialize your repository with a `change_log` directory and a basic `.renogen` config file:
 
-### Usage
+```
+$ renogen init` # optional  Creates directory for notes
+```
+
+<a name="Usage"></a>
+## Usage
 
 To generate your notes run the following command
 
-`$ renogen <VERSION> # e.g v1.2.1`
+```
+$ renogen <VERSION> # e.g v1.2.1
+```
 
 Unfortunatly renogen cant write documentation for your change.
 By default renogen uses the yaml file stratagy to extract your notes
 
-`$ renogen --help # list available command options`
+```
+$ renogen --help # list available command options
+```
+
+### Adding YAML feature notes
 
-#### Adding YAML feature notes
+You can create a new file within the 'next' version folder (default: `change_log/next/`) manually:
 
-Create a new file within the 'next' version folder(default:'change_log/next/')
+Example feature note:
 
-Example feature note
 ```yaml
 # change_log/next/example.yml
 my_formatted_single_line:
@@ -59,34 +93,130 @@ my_list:
   - e.g. run this as well
 ```
 
-#### Usage Examples
+You can also use the `new` command to create a feature note YAML file in the 'next' version folder:
 
-Prepend your notes to a changelog file(TODO make command simple)
+```
+$ renogen new TICKET_NAME # creates ./change_log/next/TICKET_NAME.yml`
+```
 
-`$ renogen --format markdown v1.2.1 > CHANGELOG.md | cat - CHANGELOG > CHANGELOG.tmp && mv CHANGELOG.tmp CHANGELOG`
+### Usage Examples
+
+Prepend your notes to a changelog file (TODO make command simple)
+
+```
+$ renogen --format markdown v1.2.1 > CHANGELOG.md | cat - CHANGELOG > CHANGELOG.tmp && mv CHANGELOG.tmp CHANGELOG
+```
 
 Writes notes to html file
 
-`$ renogen --format html v1.2.1 > v1_2_1.html`
+```
+$ renogen --format html v1.2.1 > v1_2_1.html
+```
+
+Writes note to csv file
+
+`$ renogen --format csv v1.2.1 > v1_2_1.csv`
 
 Print all notes since v1.0.0 as text
 
-`$ renogen --format text -l v1.0.0 v1.2.1`
+```
+$ renogen --format text -l v1.0.0 v1.2.1
+```
+
+<a name="Configuration"></a>
+## Configuration
+
+Renogen tries to read the file `.renogen` in the working directory to load its configuration. The file is in YAML format
+with the following keys:
+
+|       key            | meaning | default value | configuration example |
+|----------------------|----------|---------------|-----------------------|
+| `single_line_format` | A template for generating a single line of text from a YAML dictionary in a feature note file. Each dictionary key in the template gets replaced by the value for that key. | `summary (see link)` | `[#ticket](https://github.com/renogen/issue/ticket): summary` |
+| `supported_keys`     | YAML dictionary keys allowed in dictionary feature notes. Ignored for dictionaries where rules apply. | `%w[identifier summary link]` | |
+| `input_source`       | The format of the feature note files. Currently, only `yaml` is supported. | `yaml` | |
+| `output_format`      | The default output format when generating release notes. | `markdown` | `html` |
+| `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
+
+Allowed values enables you to specify a range of allowed values for any default heading. This can be an array, string or
+regular expression:
+
+```yaml
+default_headings:
+  - Products
+  - Countries
+  - User Facing
+Products: !ruby/regexp '/\b(Foo|Bar)\b/'
+Countries: [UK, AUS, FR]
+User Facing: Yes
+```
+
+<a name="FAQ"></a>
+## Frequently Asked Questions
+
+### Custom formatter
+
+You can use your own formatter quite easily.
+
+For example, put this in `lib/my_project/renogen_formatter.rb`:
 
-### Configuration
+```ruby
+require 'renogen/formatters'
 
-TODO
-* How to set configuration with `.renogen` file
-* How to change formatted single line
+class MyProject::RenogenFormatter < Renogen::Formatters::Base
+  register :xml
+
+  def write_header(header)
+    "<release><header>#{header}</header>"
+  end
+
+  def write_group(group)
+    "<group><title>#{group}</title>"
+  end
+
+  def write_group_end
+    "</group>"
+  end
+
+  def write_change(change)
+    "<change>#{change}</change>"
+  end
+
+  def write_footer(*)
+    "</release>"
+  end
+end
+```
+
+You have to include that file when running renogen:
+
+```
+$ renogen -I. -Rlib/my_project/renogen_formatter 1.2.3
+```
+
+### Why does renogen not use renogen
 
-### Why does renogen not use renogen?
 The amount of activity and contributes for this project is small and so it is more practical to use a text file.
 
-### License
+### How can I run from source
+
+```
+$ git clone git@github.com:DDAZZA/renogen.git
+$ cd ./renogen/
+$ bundle install
+$ bundle exec ./bin/renogen test
+```
+
+## License
 
 Renogen is a programming tool to generate a log of source code changes
 
-Copyright (C) 2015 David Elliott
+Copyright (C) 2015-2020 David Elliott
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

data/lib/renogen/change_log.rb

@@ -5,5 +5,6 @@ module Renogen
     require_relative 'change_log/group'
     require_relative 'change_log/writer'
     require_relative 'change_log/model'
+    require_relative 'change_log/validator'
   end
 end

data/lib/renogen/change_log/item.rb

@@ -3,9 +3,10 @@ module Renogen
     # Object to represent single change item
     class Item
       attr_accessor :change
-      attr_reader :group_name
+      attr_reader :group_name, :ticket_id
 
-      def initialize(group_name, change, options={})
+      def initialize(ticket_id, group_name, change, options={})
+        @ticket_id = ticket_id
         @group_name = group_name
         @change = change
       end
@@ -15,6 +16,7 @@ module Renogen
       # @return [String]
       def to_s
         return '' unless change
+
         case change.class.to_s
         when 'String'
           format_multiline(change)
@@ -46,12 +48,12 @@ module Renogen
       end
 
       def format_array(change)
-        # TODO should return a string
+        # TODO: should return a string
         change
       end
 
       def format_oneline(change)
-        # TODO Refactor
+        # TODO: Refactor
         string = config.single_line_format.downcase.gsub('\n', '\n  ')
         config.supported_keys.each do |key|
           string = string.gsub(key, '#{change[\'' + key + '\']}')

data/lib/renogen/change_log/model.rb

@@ -5,20 +5,14 @@ module Renogen
     # Object to represent a Changelog/release notes
     class Model
       attr_reader :items
-      attr_accessor :version
+      attr_accessor :version, :date
 
       def initialize(options={})
         @version = options[:version]
+        @date = options[:date] || Date.today
         @items = []
       end
 
-      # The title for the change log output
-      #
-      # @return [String]
-      def header
-        "#{version} (#{Date.today})"
-      end
-
       # @return [Hash<group_name: change>]
       def groups
         items.inject({}) do |hash, change|
@@ -28,6 +22,15 @@ module Renogen
         end
       end
 
+      # @return [Hash<ticket id: string>]
+      def tickets
+        items.inject({}) do |hash, change|
+          hash[change.ticket_id] ||= {}
+          hash[change.ticket_id][change.group_name] = change.to_s
+          hash
+        end
+      end
+
       # Adds a change to the changelog
       #
       # @param change [Renogen::ChangeLog::Item]

data/lib/renogen/change_log/validator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Renogen
+  module ChangeLog
+    # Validates the change log
+    class Validator
+      def initialize(formatter)
+        @formatter = formatter
+        @validations = formatter.options['allowed_values']
+      end
+
+      # Validates the change log
+      #
+      # @param changelog [ChangeLog::Model]
+      def validate!(changelog)
+        validate_headings(changelog)
+      end
+
+      protected
+
+      attr_reader :formatter, :validations
+
+      def validate_headings(changelog)
+        return if validations.nil?
+        return if changelog.items.none? { |item| validations.key?(item.group_name) }
+
+        validate_properties(changelog)
+      end
+
+      private
+
+      def validate_properties(changelog)
+        invalid_items = []
+        validations.each do |heading, values|
+          items_to_select = changelog.items.select { |log| log.group_name == heading }
+          invalid_values = items_to_select.map do |i|
+            changes = changes_to_validate(i.change)
+            next changes - values if values.is_a?(Array)
+            next unless values.is_a?(Regexp)
+
+            changes.detect { |c| c !~ values } # return anything that does not match the regexp.
+          end
+
+          invalid_values = invalid_values.flatten.compact.uniq # remove duplicates and nils
+          next if invalid_values.empty?
+
+          invalid_items << { invalid_value: invalid_values, valid_values: values, group_name: heading }
+        end
+
+        invalid_items = invalid_items.flatten
+        raise(Renogen::Exceptions::InvalidItemFound, invalid_items) unless invalid_items.empty?
+      end
+
+      def changes_to_validate(change)
+        return [change] if change.is_a? String
+
+        change
+      end
+    end
+  end
+end

data/lib/renogen/change_log/writer.rb

@@ -10,9 +10,29 @@ module Renogen
       #
       # @param changelog [ChangeLog::Model]
       def write!(changelog)
-        puts formatter.write_header(changelog.header)
+        puts formatter.write_header(formatter.header(changelog)) unless formatter.write_header(formatter.header(changelog)).nil?
+        if formatter.table_formatter?
+          write_by_table!(changelog)
+        else
+          write_by_group!(changelog)
+        end
+        puts formatter.write_footer(changelog) unless formatter.write_footer(changelog).nil?
+      end
+
+      # Writes out the change log by group
+      #
+      # @param changelog [ChangeLog::Model]
+      def write_by_group!(changelog)
         output_groups(changelog.groups)
-        puts formatter.write_footer(changelog)
+      end
+
+      # Writes out the change log by item
+      #
+      # @param changelog [ChangeLog::Model]
+      def write_by_table!(changelog)
+        changelog.tickets.each do |_, ticket|
+          puts formatter.write_change(ticket)
+        end
       end
 
       protected
@@ -30,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/cli.rb

@@ -20,26 +20,28 @@ module Renogen
       source = options['source'] || config_instance.input_source
       options['changelog_path'] ||= config_instance.changelog_path
       options['old_version'] ||= config_instance.changelog_path
+      options['release_date'] ||= Date.today
+      options['allowed_values'] ||= config_instance.validations
 
       begin
         generator = Renogen::Generator.new(version, source, format, options)
         generator.generate!
       rescue Renogen::Exceptions::Base => e
         puts e.message
-        exit -1
+        exit 1
       end
     end
 
     # Initialize the current working directory with an example change
     def self.init
-      # TODO Refactor to use Config.instance.changelog_path
+      # TODO: Refactor to use Config.instance.changelog_path
       Dir.mkdir('./change_log')
       puts "Created './change_log/'"
 
       Dir.mkdir('./change_log/next')
       puts "Created './change_log/next/'"
 
-      File.open("./change_log/next/added_renogen_gem.yml", 'w') do |f|
+      File.open('./change_log/next/added_renogen_gem.yml', 'w') do |f|
         f.write("Summary:\n")
         f.write("  identifier: renogen\n")
         f.write("  link: https://github.com/DDAZZA/renogen\n")
@@ -56,7 +58,7 @@ module Renogen
 
       puts "Created './change_log/next/added_renogen_gem.yml'"
 
-      File.open(".renogen", 'w') do |f|
+      File.open('.renogen', 'w') do |f|
         f.write("changelog_path: './change_log/'\n")
       end
       puts "Created '.renogen'"
@@ -66,6 +68,8 @@ module Renogen
     #
     # @param ticket_name [String]
     def self.new_ticket(ticket_name)
+      raise 'You need to provide a ticket_name' if ticket_name.nil?
+
       file_path = File.join(Config.instance.changelog_path, 'next', "#{ticket_name}.yml")
       File.open(file_path, 'w') do |f|
         Config.instance.default_headings.each do |h|