pr_changelog 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d8b03e0c652b5e8c54545bda41fc8db5892f5c4
-  data.tar.gz: 7d03c9f0832e52c65fe6cf40da38f5cf1a234622
+  metadata.gz: dab0c2b8a1d8fbd0d20075ac1bf8068b472f5abd
+  data.tar.gz: 89eb296b69a3acbc79682445a411dac2c6b9dbd8
 SHA512:
-  metadata.gz: 16911cf9a8c6e3a29d85fd0b7534f082fc1b4a229ae5ee244846466fb57aa0d8186ac925d3208eb1e03a53e368ef1ed447c28d266d7ad60a3f6aa9dddc2f66f5
-  data.tar.gz: 2abab755538b3cb4baef5d34945f84550fafdb0c4ac737ab4252a1e890bb2de09cafd5f48cfedadb12baa5b19f2022a181d55306bd5758d4f14d8736685d500d
+  metadata.gz: 11f056d478fa379d7c20e177519a9ffdf29b4d01a7aab3d9e374eff223310759217b8fafb18d4ecf247a01d5f6ed2947a329c8a51ab7430c65a7b7bca926f7b7
+  data.tar.gz: 42057d5c68c710b313f22e9d7fe8a5edaf7953e9956ea4f4da81131160017bf167504cccd6d50af05c91858f817eaf0de52c4953b067c26df3726707e0a6549d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pr_changelog (0.1.1)
+    pr_changelog (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,7 @@
 # PR Changelog
 
+[![Gem Version](https://badge.fury.io/rb/pr_changelog.svg)](https://badge.fury.io/rb/pr_changelog)
+
 A script to generate a nice list of changes given two git references, like so:
 
 ```markdown
@@ -30,6 +32,8 @@ Then a sample pull request title would be:
 
 > Feature: shake the phone to send feedback email
 
+This project itself is using this PR convention and the changelog generated with it can be found in https://github.com/schibsted/pr_changelog/releases
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -96,6 +100,32 @@ Will produce:
   - #60: 👨‍💻 Setup hockeyapp for crash reporting
 ```
 
+## Configuration
+
+Change the emojis or add your own in a `.pr_changelog.json` file:
+
+```json
+{
+  "tags": [
+    {
+      "prefix": "feature",
+      "emoji": "⭐️",
+      "title": "New features"
+    },
+    {
+      "prefix": "improvement",
+      "emoji": "💎",
+      "title": "Improvements"
+    },
+    {
+      "prefix": "unclassified",
+      "emoji": "❓",
+      "title": "Unclassified"
+    }
+  ]
+}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/schibsted/pr_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/pr_changelog/cli.rb

@@ -18,19 +18,36 @@ module PrChangelog
         $ pr_changelog
     HELP
 
+    class InvalidInputs < StandardError
+    end
+
+    class HelpWanted < StandardError
+    end
+
     attr_reader :format, :from_reference, :to_reference
 
     def initialize(args)
-      @format = 'pretty'
+      throw HelpWanted if args.include?('--help') || args.include?('-h')
+
+      @format = PrChangelog.config.default_format
       if args.include?('--format')
         next_index = args.index('--format') + 1
-        @format = args.fetch(next_index)
+        @format = args.delete_at(next_index)
+        args.delete('--format')
       end
+
       @from_reference, @to_reference = args.last(2)
+      @to_reference ||= 'master'
+
+      return if @from_reference && @to_reference
+
+      throw InvalidInputs.new
     end
 
     def run
       changes = NotReleasedChanges.new(from_reference, to_reference)
+      puts "## Changes since #{from_reference} to #{to_reference}\n\n"
+
       if format == 'pretty'
         puts changes.grouped_formatted_changelog
       else

data/lib/pr_changelog/config.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module PrChangelog
+  # Loads the configuration
+  class Config
+    DEFAULTS = {
+      format: 'plain',
+      tags: [
+        {
+          prefix: 'feature',
+          emoji: '⭐️',
+          title: 'New features'
+        },
+        {
+          prefix: 'fix',
+          emoji: '🐛',
+          title: 'Fixes'
+        },
+        {
+          prefix: 'improvement',
+          emoji: '💎',
+          title: 'Improvements'
+        },
+        {
+          prefix: 'internal',
+          emoji: '👨‍💻',
+          title: 'Internal'
+        },
+        {
+          prefix: 'unclassified',
+          emoji: '❓',
+          title: 'Unclassified'
+        }
+      ]
+    }.freeze
+
+    def initialize(file = nil)
+      @file = file || '.pr_changelog.json'
+      @loaded_data = {}
+
+      return unless File.exist?(@file)
+
+      @loaded_data = JSON.parse(File.read(@file), symbolize_names: true)
+    end
+
+    def default_format
+      loaded_data[:format] || DEFAULTS[:format]
+    end
+
+    def tags
+      loaded_data[:tags] || DEFAULTS[:tags]
+    end
+
+    private
+
+    attr_reader :loaded_data
+  end
+end

data/lib/pr_changelog/not_released_changes.rb

@@ -6,13 +6,6 @@ module PrChangelog
   class NotReleasedChanges
     MERGE_COMMIT_FORMAT = /Merge pull request (?<pr_number>#\d+) .*/.freeze
     TAGGED_TITLE = /^(?<tag>.+):\s*(?<title>.+)$/.freeze
-    EMOJI_TAGS = {
-      'feature' => Tag.new('⭐️', 'New features', 0),
-      'fix' => Tag.new('🐛', 'Fixes', 1),
-      'improvement' => Tag.new('💎', 'Improvements', 2),
-      'internal' => Tag.new('👨‍💻', 'Internal', 4),
-      'unclassified' => Tag.new('❓', 'Unclassified', 5)
-    }.freeze
 
     attr_reader :base_ref, :current_ref, :git_proxy
 
@@ -22,24 +15,38 @@ module PrChangelog
       @git_proxy   = git_proxy
     end
 
+    def emoji_tags
+      tags = {}
+
+      PrChangelog.config.tags.each_with_index do |item, index|
+        tags[item[:prefix]] = Tag.new(item[:emoji], item[:title], index)
+      end
+
+      tags
+    end
+
     def formatted_changelog
       if parsed_change_list.count.positive?
         parsed_change_list.map(&:to_s).join("\n")
       else
-        "There are no changes since #{base_ref} to #{current_ref}"
+        no_changes_found
       end
     end
 
     def grouped_formatted_changelog
       if parsed_change_list.count.positive?
-        GroupedChanges.new(parsed_change_list, EMOJI_TAGS).to_s
+        GroupedChanges.new(parsed_change_list, emoji_tags).to_s
       else
-        "There are no changes since #{base_ref} to #{current_ref}"
+        no_changes_found
       end
     end
 
     private
 
+    def no_changes_found
+      'No changes found'
+    end
+
     def parsed_change_list
       @parsed_change_list ||= parsed_merge_commits.map do |pair|
         format_merge_commit(pair.first, pair.last)

data/lib/pr_changelog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrChangelog
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/pr_changelog.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pr_changelog/version'
+require 'pr_changelog/config'
 require 'pr_changelog/extensions/string'
 require 'pr_changelog/cli'
 require 'pr_changelog/git_proxy'
@@ -11,4 +12,7 @@ require 'pr_changelog/not_released_changes'
 
 # Main module
 module PrChangelog
+  def self.config
+    @config ||= Config.new
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr_changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Felipe Espinoza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/pr_changelog.rb
 - lib/pr_changelog/change_line.rb
 - lib/pr_changelog/cli.rb
+- lib/pr_changelog/config.rb
 - lib/pr_changelog/extensions/string.rb
 - lib/pr_changelog/git_proxy.rb
 - lib/pr_changelog/grouped_changes.rb