tag-changelog 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9293d2c322efcd8fb7411c8bcb7c47d161b7a985
-  data.tar.gz: 1569037ac2782b2b24564335f6e0515f52dce1d6
+  metadata.gz: 3b55176897ce91e86571753da01176a5b0e74cee
+  data.tar.gz: aaaa4cdd9e1d79e2d0090f79947286a7f72d12c5
 SHA512:
-  metadata.gz: 364e78e00b586099fe42fb690fd0968ac0c56de31cf417d13ee07308f8619e3eeb57d20598eb1b3cad49a9f9a6dbe66b8d42f2a066b1eb032ad879bba2a581b9
-  data.tar.gz: 5ef46f7c023d99bdafc4598313782aeaf0d36cda7afd731424af110d8d28312a21ec3e7bec451f639df1c391a9f66af67ef04a8d53c9eaa4f7df7aada613a2ae
+  metadata.gz: 7f8c35d82d4109700b0216509febed7f6d27100dd5bfb605b5c8638aa389e3a49a7336c4fdd618bd6d7d6f470121efd9e530c4824574ac76ccf70a1e6bba0175
+  data.tar.gz: c5526369f596e8aeecec098a97ff03ce899989199527d1ae29e54880b969b9060085ee426c5a66ef18588e66afe6161af9de153c943f298d2496c9f61c85d242

data/CHANGELOG.md

@@ -1,5 +1,8 @@
-= changelog
+# Changelog
+
+## 1.0.0 (2018-03-12)
+#### Features
+* [F] Removes generate command flags in favor of yml config file on project
+
+## 0.1.0 (2018-02-22)
 
-Generate this with
-    changelog rdoc
-After you have described your command line interface

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tag-changelog (0.1.0)
+    tag-changelog (1.0.0)
       gli (= 2.17.1)
 
 GEM

data/README.md

@@ -1,15 +1,15 @@
 # tag-changelog
 
-Tool to generate changelog based on Parallel6 specs
+Tool to generate changelog based on Parallel6 specs, reading from git history.
 
 #### NAME
-    tag-changelog - Tool to generate changelog based on Parallel6 specs
+    tag-changelog - Tool to generate changelog based on git history.
 
 #### SYNOPSIS
     tag-changelog [global options] command [command options] [arguments...]
 
 #### VERSION
-    0.0.1
+    1.0.0
 
 #### GLOBAL OPTIONS
     --help    - Show this message
@@ -19,6 +19,11 @@ Tool to generate changelog based on Parallel6 specs
     generate - Generate changelog and write to CHANGELOG.md (default).
     help     - Shows a list of commands or help for one command
 
+## Installation
+
+```
+$ gem install tag-changelog
+```
 
 ## Usage
 
@@ -29,15 +34,17 @@ changelog and run:
 $ tag-changelog generate
 ```
 
-This will execute the `generate` command with the default params. Please see below
-for a list of options you can pass to the command.
+This will execute the `generate` command with the default params.
+Please see below for a list of options you can pass to the command.
 
 #### generate command options
-    -c, --config=file         - Configuration file to categorize commit messages in YML format. Must be an absolute path. (default: gem's own config.yml)
     -d, --dir=directory       - Git repository directory (must be an absolute path). Defaults to working directory. (default: current working directory)
-    -f, --filter=regexp       - Regexp to categorize commits from git log. (default: (\[+\s?+[cfbhrCFBHR]{1}+\s?+\]))
-    --[no-]group              - Group commit messages in categories (defined in configuration file). (default: enabled)
-    --[no-]head               - Include HEAD as a tag. Useful when new tag is not released yet (as a preview). Can be disabled. (default: enabled)
     -o, --output=file         - Output destination. (default: CHANGELOG.md)
-    --[no-]pull-requests-only - Only list merged pull requests. Can be disabled to list all commits. (default: enabled)
-    -s, --skip=tag_list       - Skip tags (may be used more than once, default: none)
+
+
+## Customizing your changelog
+All you need to do is to create a `.tag_changelog.yml` file in the root of the
+git repository directory to override the default configuration from this gem.
+
+Please take a look at the [default configuration yml file here](lib/tag_changelog/templates/config.yml) to learn more about the available options. You do not need to add all keys in your
+custom `yml` file, only those you're interested in overriding.

data/bin/tag-changelog

@@ -11,58 +11,37 @@ require 'tag_changelog'
 
 include GLI::App
 
-program_desc 'Tool to generate changelog based on Parallel6 specs'
+program_desc 'Tool to generate changelog based on git commit history.'
 
 version TagChangelog::VERSION
 
 subcommand_option_handling :normal
 arguments :strict
 
-desc 'Generate changelog and write to CHANGELOG.md (default).'
+desc 'Generate changelog and write to markdown file. (default: CHANGELOG.md).'
 command :generate do |c|
-  c.desc 'Configuration file to categorize commit messages in YML format. Must be an absolute path.'
-  c.default_value File.expand_path("../../lib/tag_changelog/templates/config.yml", __FILE__)
-  c.arg_name 'file'
-  c.flag [:c, :config]
-
   c.desc 'Git repository directory (must be an absolute path). Defaults to working directory.'
   c.default_value Dir.pwd
   c.arg_name 'directory'
   c.flag [:d, :dir]
 
   c.desc 'Output destination.'
-  c.default_value 'CHANGELOG.md'
   c.arg_name 'file'
   c.flag [:o, :output]
 
-  c.desc 'Regexp to categorize commits from git log.'
-  c.default_value '(\[+\s?+[cfbhrCFBHR]{1}+\s?+\])'
-  c.arg_name 'regexp'
-  c.flag [:f, :filter]
-
-  c.desc 'Skip tags'
-  c.arg_name 'tag_list'
-  c.flag [:s, :skip], multiple: true
-
-  c.desc 'Group commit messages in categories (defined in configuration file).'
-  c.default_value true
-  c.switch "group"
-
-  c.desc 'Include HEAD as a tag. Useful when new tag is not released yet (as a preview). Can be disabled.'
-  c.default_value true
-  c.switch "head"
-
-  c.desc 'Only list merged pull requests. Can be disabled to list all commits.'
-  c.default_value true
-  c.switch "pull-requests-only"
-
-  c.action do |global_options,options,args|
+  c.action do |global_options, options, args|
     # Your command logic here
     # If you have any errors, just raise them
     # raise "that command made no sense"
+    config_file = File.expand_path("../../lib/tag_changelog/templates/config.yml", __FILE__)
     Dir.chdir(options[:dir]) do
-      puts "Changelog will be written to: #{[options[:dir], options[:output]].join('/')}"
-      TagChangelog::Generate.run(options)
+      project_config = if File.exists?(".tag_changelog.yml")
+                         YAML.load_file(File.open(".tag_changelog.yml"))
+                       else
+                         {}
+                       end.merge("config_file" => config_file)
+      puts "Changelog will be written to: #{[options[:dir], project_config['output']].join('/')}"
+      TagChangelog::Generate.run(project_config, options)
     end
   end
 end

data/lib/tag_changelog.rb

@@ -6,4 +6,5 @@ require 'tag_changelog/version'
 require 'tag_changelog/git/git'
 require 'tag_changelog/git/tag_list'
 require 'tag_changelog/git/tag'
+require 'tag_changelog/message_list'
 require 'tag_changelog/generate'

data/lib/tag_changelog/generate.rb

@@ -1,17 +1,19 @@
 # A class to manipulate output destination of changelog and to write its contents.
 module TagChangelog
   class Generate
-    def self.run(options)
-      new(options).run
+    def self.run(project_config, options)
+      new(project_config, options).run
     end
 
-    def initialize(options = {})
+    def initialize(project_config = {}, options = {})
+      @project_config = project_config
       @options = options
+      @config = build_configuration
       @output = open_output_file
-      @tags_list = build_tags_list(options)
-      @filter = Regexp.new(options[:filter], true)
-      @commit_messages_filter = set_commits_filter(options)
-      @group = options[:group]
+      @tags_list = build_tags_list
+      @filter = Regexp.new(config["filter"], true)
+      @commit_messages_filter = set_commits_filter
+      @group = config["group"]
     end
 
     def run
@@ -32,25 +34,36 @@ module TagChangelog
                 :tags_list,
                 :filter,
                 :commit_messages_filter,
-                :group
+                :group,
+                :config
+
+    def build_configuration
+      default_config
+        .merge(@project_config)
+        .merge(@options.delete_if { |_, v| v.nil? })
+    end
+
+    def default_config
+      YAML.load_file(@project_config["config_file"])
+    end
 
     def output_file_exists?
-      File.exists?(options[:output])
+      File.exists?(config["output"])
     end
 
     def open_output_file
-      puts "#{options[:output]} doesn't exist in #{options[:dir]}... creating it" unless output_file_exists?
-      File.open(options[:output], "w+")
+      puts "#{config['output']} doesn't exist in #{options[:dir]}... creating it" unless output_file_exists?
+      File.open(config["output"], "w+")
     end
 
-    def build_tags_list(options)
-      Git::TagList.new(options[:head]).list.reject do |tag|
-        tag if options[:skip].include?(tag)
+    def build_tags_list
+      Git::TagList.new(config["head"]).list.reject do |tag|
+        tag if config["skip"].include?(tag)
       end
     end
 
-    def set_commits_filter(options)
-      options["pull-requests-only"] ? 'Merge pull request' : nil
+    def set_commits_filter
+      config["pull-requests-only"] ? 'Merge pull request' : nil
     end
 
     def get_commit_messages(previous_tag, current_tag)
@@ -58,8 +71,8 @@ module TagChangelog
                                                 current_tag,
                                                 commit_messages_filter).split("\n")
       # if not filtering merged pull requests only
-      # we need to remove the commit sha (first 9 chars in each row)
-      messages = messages.map { |msg| msg[10..-1] } unless commit_messages_filter
+      # we need to remove the commit sha1
+      messages = messages.map { |msg| msg.split(" ")[1..-1].join(" ") } unless commit_messages_filter
       messages = categorize_messages(messages, build_categories) if group
       messages = MessageList.new(messages, group)
     end
@@ -75,7 +88,7 @@ module TagChangelog
           msg = msg.gsub!(filter, matching_category["bullet"])
           matching_category["messages"].push(msg)
         else
-          uncategorized["messages"].push("* #{msg}")
+          uncategorized["messages"].push("#{msg}")
         end
       end
 
@@ -83,39 +96,10 @@ module TagChangelog
     end
 
     def build_categories
-      categories = YAML.load_file(options[:config])
+      categories = config["categories"].dup
+      categories.push({ "bullet" => "[U]", "header" => "Uncategorized" })
       categories.each { |category| category["messages"] = [] }
       categories
     end
-
-    class MessageList
-      attr_reader :messages, :grouped
-
-      def initialize(messages = [], grouped = true)
-        @messages = messages
-        @grouped = grouped
-      end
-
-      def to_text
-        if grouped
-          messages.map do |category|
-            category["messages"].any? ? print_category(category) : nil
-          end.reject(&:nil?).join("")
-        else
-          print_lines(messages).reject(&:nil?).join("")
-        end
-      end
-
-      def print_category(category)
-        [
-          "#### #{category['header']}",
-          print_lines(category["messages"]).join(""),
-        ].join("\n")
-      end
-
-      def print_lines(lines)
-        lines.map { |line| "#{line}\n" }
-      end
-    end
   end
 end

data/lib/tag_changelog/message_list.rb

@@ -0,0 +1,31 @@
+module TagChangelog
+  class MessageList
+    attr_reader :messages, :grouped
+
+    def initialize(messages = [], grouped = true)
+      @messages = messages
+      @grouped = grouped
+    end
+
+    def to_text
+      if grouped
+        messages.map do |category|
+          category["messages"].any? ? print_category(category) : nil
+        end.reject(&:nil?).join("")
+      else
+        print_lines(messages).reject(&:nil?).join("")
+      end
+    end
+
+    def print_category(category)
+      [
+        "#### #{category['header']}",
+        print_lines(category["messages"]).join(""),
+      ].join("\n")
+    end
+
+    def print_lines(lines)
+      lines.map { |line| "* #{line}\n" }
+    end
+  end
+end

data/lib/tag_changelog/templates/config.yml

@@ -1,37 +1,59 @@
-- bullet: "[F]"
-  filters:
-    - "[F]"
-    - "[ F ]"
-    - "[f]"
-    - "[ f ]"
-  header: "Features"
-- bullet: "[C]"
-  filters:
-    - "[C]"
-    - "[ C ]"
-    - "[c]"
-    - "[ c ]"
-  header: "Configuration"
-- bullet: "[B]"
-  filters:
-    - "[B]"
-    - "[ B ]"
-    - "[b]"
-    - "[ b ]"
-  header: "Bug Fixes"
-- bullet: "[H]"
-  filters:
-    - "[H]"
-    - "[ H ]"
-    - "[h]"
-    - "[ h ]"
-  header: "Hotfixes"
-- bullet: "[R]"
-  filters:
-    - "[R]"
-    - "[ R ]"
-    - "[r]"
-    - "[ r ]"
-  header: "Refactored"
-- bullet: "[U]"
-  header: "Uncategorized"
+filter: '(\[+\s?+[cfbhrCFBHR]{1}+\s?+\])'
+# Group commit messages in categories
+# (default: enabled)
+group: true
+# Include HEAD as a tag.
+# Useful when new tag is not released yet (as a preview).
+# (default: enabled)
+head: true
+# Output destination.
+output: CHANGELOG.md
+# Only list merged pull requests.
+# Can be disabled to list all commits.
+# (default: enabled)
+"pull-requests-only": true
+# Skip tags.
+# Add tag names not to list in the changelog output.
+skip:
+  - 
+# How to categorize/group commit messages.
+# An entry must include: :bullet, :header and can optionally include :filters
+# :bullet String to add to commit message
+# :header String used as header to list all matching messages
+# :filters Array of Strings used to match agains commit messages
+categories:
+  - bullet: "[F]"
+    filters:
+      - "[F]"
+      - "[ F ]"
+      - "[f]"
+      - "[ f ]"
+    header: "Features"
+  - bullet: "[C]"
+    filters:
+      - "[C]"
+      - "[ C ]"
+      - "[c]"
+      - "[ c ]"
+    header: "Configuration"
+  - bullet: "[B]"
+    filters:
+      - "[B]"
+      - "[ B ]"
+      - "[b]"
+      - "[ b ]"
+    header: "Bug Fixes"
+  - bullet: "[H]"
+    filters:
+      - "[H]"
+      - "[ H ]"
+      - "[h]"
+      - "[ h ]"
+    header: "Hotfixes"
+  - bullet: "[R]"
+    filters:
+      - "[R]"
+      - "[ R ]"
+      - "[r]"
+      - "[ r ]"
+    header: "Refactored"

data/lib/tag_changelog/version.rb

@@ -1,3 +1,3 @@
 module TagChangelog
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/tag-changelog.gemspec

@@ -6,7 +6,7 @@ spec = Gem::Specification.new do |s|
   s.license = 'MIT'
   s.author = 'Parallel6'
   s.email = 'contact@parallel6.com'
-  s.homepage = 'http://clinical6.com'
+  s.homepage = 'https://github.com/parallel-6/tag-changelog'
   s.platform = Gem::Platform::RUBY
   s.summary = 'Tool to generate changelog based on Parallel6 specs'
   s.files = `git ls-files`.split("

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tag-changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Parallel6
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -101,12 +101,13 @@ files:
 - lib/tag_changelog/git/git.rb
 - lib/tag_changelog/git/tag.rb
 - lib/tag_changelog/git/tag_list.rb
+- lib/tag_changelog/message_list.rb
 - lib/tag_changelog/templates/config.yml
 - lib/tag_changelog/version.rb
 - tag-changelog.gemspec
 - test/default_test.rb
 - test/test_helper.rb
-homepage: http://clinical6.com
+homepage: https://github.com/parallel-6/tag-changelog
 licenses:
 - MIT
 metadata: {}