keepachangelog 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dc54a0dff5d2fcdcf446cf7923e74d75ca9d9c0
-  data.tar.gz: da7a230310786b66f7fc22bb92ce1e6e295f3f68
+  metadata.gz: ba8c6c289a59b43d4162e7dcbaa0ba5e8aaee9fb
+  data.tar.gz: 717fc1d7b2b6c500b120437e15b629c60091f385
 SHA512:
-  metadata.gz: c7f1bf4377bcb59b655f9270abef718c6b0ac96b6fffaa7e1f22286831b3863544703371646163b0cd7956bea8a67bf6cccba1db472fbbecb41982990eae9a44
-  data.tar.gz: 69379accbc187d49c993c11357951b7c2d782293099cbc52678350cf93174ceb0a1096b5f8a4253e44182f1a2e555cf2f4987ef54d8a8475637b17c221ec9891
+  metadata.gz: 5a04b57cf6d2cce3295f14fbbfe0c88753b2aa0c9990d84e0ffa2cd33a1ae8392df08b9a607224e1c420d77936847d388042229e0dfa3f1ef707098f76f6933a
+  data.tar.gz: d5821bf9d3ba88cbafd5d6780ab50be991b982ccae2249ebde9a687388674e978ef7afe80ff038539efb3bc297509d94bdca9d7637d64b0af66296f3794eabe8

data/CHANGELOG.md

@@ -1,25 +1,42 @@
-# Change Log
-Alla ändringar till detta projekt dokumenteras i denna fil.
+# Change log
+All notable changes to this project will be documented in this file.
 
-Formatet är baserat på [Keep a Changelog](http://keepachangelog.com/)
-och detta projekt följer [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Fixed
+- YAML parser can now read multiple changes in a version. (#2)
+- Do not display anchors when URL is missing. (#3)
+
+### New
+- Documentation on how to add metadata. (#4)
+
+## [0.3.0]
+### Fixed
+- YAML parser can now read multiple changes in a version. (#2)
+- Do not display anchors when URL is missing. (#3)
+
+### New
+- Documentation on how to add metadata. (#4)
 
 ## [0.2.1] - 2017-03-27
-### Fixat
-- Korrigera dokumentation för YAML-parser.
+### Fixed
+- Fix documentation formatting for YAML parser.
 
 ## [0.2.0] - 2017-03-27
-### Nytt
-- Förmåga att läsa in Changelog i YAML-format.
-- Förmåga att skriva till Markdown-format.
+### New
+- Ability to print in Markdown.
+- Ability to read YAML files.
 
 ## [0.1.0] - 2017-03-27
-### Nytt
-- Ruby gem som exponerar verktyget via Ruby och CLI.
-- Förmåga att konvertera Changelog till JSON.
-- Förmåga att konvertera Changelog till YAML.
+### New
+- Ability to convert Changelog to JSON.
+- Tool for reading Changelog in Markdown format.
+- Ability to convert Changelog to YAML.
 
-[Unreleased]: https://git.basalt.se/chbr/keepachangelog/compare/0.2.1...HEAD
+[Unreleased]: https://git.basalt.se/chbr/keepachangelog/compare/0.3.0...HEAD
+[0.3.0]: https://git.basalt.se/chbr/keepachangelog/compare/0.2.1...0.3.0
 [0.2.1]: https://git.basalt.se/chbr/keepachangelog/compare/0.2.0...0.2.1
 [0.2.0]: https://git.basalt.se/chbr/keepachangelog/compare/0.1.0...0.2.0
 [0.1.0]: https://git.basalt.se/chbr/keepachangelog/compare/77986bc...0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keepachangelog (0.2.1)
+    keepachangelog (0.3.0)
       json (~> 2.0)
       thor (~> 0.19)
 
@@ -84,4 +84,4 @@ DEPENDENCIES
   simplecov (~> 0.14)
 
 BUNDLED WITH
-   1.14.6
+   1.14.3

data/README.md

@@ -1,7 +1,12 @@
-# Keepachangelog
+# Changelog parser and transformer
 
 Ruby gem for parsing Changelogs based on the format described at
-keepachangelog.com. The output can be either JSON or YAML.
+[keepachangelog.com](http://keepachangelog.com).
+
+The parser can read either a Markdown file or a folder structure with
+YAML-files.
+
+The output can be Markdown, YAML or JSON.
 
 ## Installation
 
@@ -21,15 +26,75 @@ Or install it yourself as:
 
 ## Usage
 
+### Command line
+
+#### Markdown input
 To dump a Changelog to JSON run the following command:
 
-    keepachangelog --path=CHANGELOG.md --format=json
+    keepachangelog --path CHANGELOG.md --format json
+
+#### YAML input
+You can also express your changelog in YAML files inside a folder structure
+where each version is its own folder containing each change in a YAML-file.
+
+Here's an example of a folder structure:
+```
+changelog
+├── 0.1.0
+│   └── 1-first-merge-request.yaml
+├── 0.2.0
+│   └── 3-another-cool-mr.yaml
+├── 0.3.0
+│   ├── 8-fixing-some-stuff.yaml
+│   └── 9-add-new-feature.yaml
+└── unreleased
+    └── 11-minor-patch.yaml
+```
+
+Each YAML-file should be in the following format:
+
+```yaml
+---
+title: The ability to perform Foo while Bar is active
+merge_request: 11
+issue: 42
+author: "@chbr"
+type: New
+```
+
+
+- `title`: A single sentence without punctiation that describes the change
+- `merge_request`: The ID of the MR or PR (optional)
+- `issue`: The ID of the issue (optional)
+- `author`: The author of the change (optional)
+- `type`: The type of change, for example *New*, *Changed*, *Fixed*,
+  *Removed* or *Security*.
+
+To turn this into a Markdown document, simply run `keepachangelog yaml -f md`
+
+You can add meta data to your changelog in the file `meta.yaml`, placed inside
+the changelog folder, like so:
+
+```yaml
+---
+title: My Change Log
+intro: This is my change log and I am using a cool gem to generate it.
+url: https://git.example.com/group/project
+```
+
+The following meta data is read:
+- `title`: The title at the top of the Change log
+- `intro`: A text shown directly below the title
+- `url`: A URL to the git repository, used to generate links for versions
+  that follows the format *<url>/compare/FROM..TO*
+
+### From Ruby code
 
 If you want to use the API from your own Ruby code:
 
 ```ruby
 require 'keepachangelog'
-parser = Keepachangelog::Parser.load('CHANGELOG.md')
+parser = Keepachangelog::MarkdownParser.load('CHANGELOG.md')
 puts parser.to_json
 ```
 

data/changelog/0.1.0/json.yaml

@@ -0,0 +1,3 @@
+---
+title: Ability to convert Changelog to JSON
+type: New

data/changelog/0.1.0/tool.yaml

@@ -0,0 +1,3 @@
+---
+title: Tool for reading Changelog in Markdown format
+type: New

data/changelog/0.1.0/yaml.yaml

@@ -0,0 +1,3 @@
+---
+title: Ability to convert Changelog to YAML
+type: New

data/changelog/0.2.0/markdown-output.yaml

@@ -0,0 +1,3 @@
+---
+title: Ability to print in Markdown
+type: New

data/changelog/0.2.0/yaml-input.yaml

@@ -0,0 +1,3 @@
+---
+title: Ability to read YAML files
+type: New

data/changelog/0.2.1/fix-documentation.yaml

@@ -0,0 +1,3 @@
+---
+title: Fix documentation formatting for YAML parser
+type: Fixed

data/changelog/0.3.0/2-multiple-changes.yaml

@@ -0,0 +1,4 @@
+---
+title: YAML parser can now read multiple changes in a version
+issue: 2
+type: Fixed

data/changelog/0.3.0/3-anchors-without-url.yaml

@@ -0,0 +1,4 @@
+---
+title: Do not display anchors when URL is missing
+issue: 3
+type: Fixed

data/changelog/0.3.0/4-document-meta.yaml

@@ -0,0 +1,4 @@
+---
+title: Documentation on how to add metadata
+issue: 4
+type: New

data/changelog/Unreleased/2-multiple-changes.yaml

@@ -0,0 +1,4 @@
+---
+title: YAML parser can now read multiple changes in a version
+issue: 2
+type: Fixed

data/changelog/Unreleased/3-anchors-without-url.yaml

@@ -0,0 +1,4 @@
+---
+title: Do not display anchors when URL is missing
+issue: 3
+type: Fixed

data/changelog/Unreleased/4-document-meta.yaml

@@ -0,0 +1,4 @@
+---
+title: Documentation on how to add metadata
+issue: 4
+type: New

data/changelog/meta.yaml

@@ -0,0 +1,2 @@
+---
+url: https://git.basalt.se/chbr/keepachangelog

data/features/yaml.feature

@@ -13,5 +13,5 @@ Feature: List transformators
     When I successfully run `keepachangelog yaml`
     Then the output should contain:
       """
-      {"versions":{"1.0.0":{"changes":{"New":["Feature A"]}}}}
+      {"versions":{"1.0.0":{"changes":{"New":["Feature A."]}}}}
       """

data/lib/keepachangelog/cli.rb

@@ -38,7 +38,7 @@ module Keepachangelog
     option :format, type: :string,
                     desc: 'The output format',
                     default: 'json',
-                    banner: 'json|yaml',
+                    banner: 'json|yaml|md',
                     aliases: '-f'
     option :path, type: :string,
                   desc: 'Path to the yaml folder',

data/lib/keepachangelog/markdown_printer.rb

@@ -23,6 +23,7 @@ module Keepachangelog
     private
 
     def clean_intro(text)
+      return nil unless text
       text.to_s.strip.gsub("\n", "\n\n")
     end
 
@@ -42,6 +43,7 @@ module Keepachangelog
     end
 
     def anchors
+      return nil unless options[:url]
       v = versions.keys.sort.reverse
       (0..v.length - 1).map { |i| anchor(v, i) }
     end
@@ -49,7 +51,7 @@ module Keepachangelog
     def anchor(v, i)
       from_v = i == v.length - 1 ? first_commit : v[i + 1]
       to_v = v[i] == 'Unreleased' ? 'HEAD' : v[i]
-      "[#{v[i]}]: #{options[:url]}/compare/#{from_v}..#{to_v}"
+      "[#{v[i]}]: #{options[:url]}/compare/#{from_v}...#{to_v}"
     end
 
     def change(content)

data/lib/keepachangelog/parser/markdown.rb

@@ -8,16 +8,19 @@ module Keepachangelog
 
     # Parse a file with markdown content
     def self.load(filename = 'CHANGELOG.md')
-      parse File.open(filename, &:read)
+      p = new
+      p.parse File.open(filename, &:read)
+      p
     end
 
     def parse(content)
       content = "\n" + clean(content).strip + "\n"
       anchors = extract_anchors! content
       versions = content.split(/\n\s*## /)[1..-1]
-      {
-        'versions' => versions.map { |v| parse_version v, anchors }.to_h
-      }
+      parsed_content['versions'] = versions.map do |v|
+        parse_version v, anchors
+      end.to_h
+      parsed_content
     end
 
     private

data/lib/keepachangelog/parser/yaml.rb

@@ -22,7 +22,7 @@ module Keepachangelog
   #     title: The ability to perform Foo while Bar is active
   #     merge_request: 11
   #     issue: 42
-  #     author: @chbr
+  #     author: "@chbr"
   #     type: New
   #
   # - `title` is a single sentence without punctiation that describes the
@@ -92,7 +92,7 @@ module Keepachangelog
     end
 
     def generate_line(yaml)
-      line = yaml['title']
+      line = yaml['title'] + '.'
       line += " (!#{yaml['merge_request']})" if yaml['merge_request']
       line += " (##{yaml['issue']})" if yaml['issue']
       line += " (#{yaml['author']})" if yaml['author']
@@ -100,6 +100,7 @@ module Keepachangelog
     end
 
     def initialize_version(version)
+      return if parsed_content['versions'][version]
       parsed_content['versions'][version] = { 'changes' => {} }
     end
   end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keepachangelog",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Parser for changelogs based on keepachangelog.com",
   "main": "index.js",
   "scripts": {

data/spec/parser/markdown_spec.rb

@@ -92,7 +92,7 @@ module Keepachangelog
         allow(File).to receive(:open).and_call_original
         expect(File).to receive(:open).with('test.md')
           .and_yield(StringIO.new(content))
-        expect(MarkdownParser).to receive(:parse).with(content)
+        expect_any_instance_of(MarkdownParser).to receive(:parse).with(content)
         MarkdownParser.load('test.md')
       end
 

data/spec/parser/yaml_spec.rb

@@ -19,7 +19,7 @@ type: New
           'versions' => {
             '1.2.3' => {
               'changes' => {
-                'New' => ['Feature A']
+                'New' => ['Feature A.']
               }
             }
           }

data/spec/parser_spec.rb

@@ -25,5 +25,13 @@ module Keepachangelog
         p.to_s
       end
     end
+
+    describe '.to_md' do
+      it 'should cast parsed content into a Markdown document' do
+        p = Parser.new
+        expect_any_instance_of(MarkdownPrinter).to receive(:to_s)
+        p.to_md
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keepachangelog
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Basalt AB
@@ -142,6 +142,19 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- changelog/0.1.0/json.yaml
+- changelog/0.1.0/tool.yaml
+- changelog/0.1.0/yaml.yaml
+- changelog/0.2.0/markdown-output.yaml
+- changelog/0.2.0/yaml-input.yaml
+- changelog/0.2.1/fix-documentation.yaml
+- changelog/0.3.0/2-multiple-changes.yaml
+- changelog/0.3.0/3-anchors-without-url.yaml
+- changelog/0.3.0/4-document-meta.yaml
+- changelog/Unreleased/2-multiple-changes.yaml
+- changelog/Unreleased/3-anchors-without-url.yaml
+- changelog/Unreleased/4-document-meta.yaml
+- changelog/meta.yaml
 - exe/keepachangelog
 - features/help.feature
 - features/markdown.feature