keepachangelog 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d54eca6140fcc5088df9a25e92f0fe50b7df1a82
-  data.tar.gz: cd1981c05340bc9ec4fb1309d9e422c9cfb008a7
+  metadata.gz: 6e63e90c5940db3033ddb2f4e58e77437af51e43
+  data.tar.gz: 8f30352f336656f66229df3eba5abbb4e2924149
 SHA512:
-  metadata.gz: 721125e2778898619487ef091c5d2783bf7d01d6017721e83220547a794b32a9e13d57ae3d75852adb02c3a371d4ca37fe3ec0e8fca75326b18d768234a777a6
-  data.tar.gz: 065e781135ea1d0d1ab7dfe01666b118755b7b81aaa3db4b12746b5f1887e2982cdd4e5a4140fb6b4bc293ed941c548b1d3e129daeecf2245861994b70738c37
+  metadata.gz: 7d332fc8dc0d944376a22d7419a8e31aff436e89b18c533d5e3f1c26d8639b8c9cbb3b6a57ee5083120869d82e5628b8f2e841dedcac29c5324bf15c10fd4a20
+  data.tar.gz: 2bf95c69b9f25c988c53f193735ef3fa254a2d81dd6be3e663c77cf2e7bd3c5909cc981a06f9828572384462a0efa5fd1c508082245a5eff661e0a81c16cf3cb

data/.gitlab-ci.yml

@@ -40,10 +40,15 @@ integration:
   script:
     - "grunt test:integration"
 
-download.basalt.se:
+fileshare:
   stage: deploy
   environment: production
   script:
+    - |
+      if [[ "$SSH_KEY" == "" || "$SSH_USER" == "" || "$TARGET_HOST" == "" || "$TARGET_PATH" == "" ]]; then
+        echo "Skipping deploy due to missing credentials"
+        exit 0
+      fi
     - grunt publish
   only:
     - tags
@@ -52,6 +57,11 @@ rubygems.org:
   stage: deploy
   environment: production
   script:
+    - |
+      if [[ "$RUBYGEMS_API_KEY" == "" ]]; then
+        echo "Skipping deploy due to missing credentials"
+        exit 0
+      fi
     - mkdir -p ~/.gem
     - "echo \":rubygems_api_key: $RUBYGEMS_API_KEY\" > ~/.gem/credentials"
     - chmod 0600 /root/.gem/credentials

data/.rubocop.yml

@@ -7,6 +7,9 @@ Style/ClassAndModuleChildren:
 Style/AsciiComments:
   Enabled: false
 
+Metrics/MethodLength:
+  Max: 15
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.1]
+### Fixed
+- Deploy job in CI will no longer be skipped even though it should run. (#8)
+
+## [0.4.0] - 2017-03-30
+### New
+- Ability to output changelog to yaml file structure. (!9)
+- The code is pushed into a public repo at gitlab.com.
+
+### Fixed
+- Sort versions in reverse numerical order in Markdown output. (#7)
+
 ## [0.3.1] - 2017-03-27
 ### Fixed
 - Remove duplicates in Changelog for this project. (#6)
@@ -31,8 +43,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Tool for reading Changelog in Markdown format.
 - Ability to convert Changelog to YAML.
 
-[0.3.1]: https://git.basalt.se/chbr/keepachangelog/compare/0.3.0...0.3.1
-[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
+[0.4.1]: https://gitlab.com/ephracis/keepachangelog/compare/0.4.0...0.4.1
+[0.4.0]: https://gitlab.com/ephracis/keepachangelog/compare/0.3.1...0.4.0
+[0.3.1]: https://gitlab.com/ephracis/keepachangelog/compare/0.3.0...0.3.1
+[0.3.0]: https://gitlab.com/ephracis/keepachangelog/compare/0.2.1...0.3.0
+[0.2.1]: https://gitlab.com/ephracis/keepachangelog/compare/0.2.0...0.2.1
+[0.2.0]: https://gitlab.com/ephracis/keepachangelog/compare/0.1.0...0.2.0
+[0.1.0]: https://gitlab.com/ephracis/keepachangelog/compare/77986bc...0.1.0

data/CONTRIBUTING.md

@@ -1,2 +1,3 @@
-Se [metodanvisning utveckling](http://doc.basalt.se/docs/beans-metodanvisning-testdriven-utveckling/sv/stable/)
-för detaljer på hur man utvecklar i detta projekt.
+You can help out in several ways:
+- File or discuss issues
+- Send merge requests

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keepachangelog (0.3.1)
+    keepachangelog (0.4.1)
       json (~> 2.0)
       thor (~> 0.19)
 

data/LICENSE.md

@@ -1,3 +1,19 @@
-Copyright © 2016 Basalt
+Copyright © 2017 Basalt
 
-All rights reserved - Do Not Redistribute
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,12 +1,16 @@
+[![build status](https://gitlab.com/ephracis/keepachangelog/badges/master/build.svg)](https://gitlab.com/ephracis/keepachangelog/commits/master)
+[![coverage report](https://gitlab.com/ephracis/keepachangelog/badges/master/coverage.svg)](https://gitlab.com/ephracis/keepachangelog/commits/master)
+[![Gem Version](https://badge.fury.io/rb/keepachangelog.svg)](https://badge.fury.io/rb/keepachangelog)
+
 # Changelog parser and transformer
 
 Ruby gem for parsing Changelogs based on the format described at
 [keepachangelog.com](http://keepachangelog.com).
 
 The parser can read either a Markdown file or a folder structure with
-YAML-files.
+YAML files.
 
-The output can be Markdown, YAML or JSON.
+The output can be Markdown, YAML files or JSON.
 
 ## Installation
 
@@ -28,17 +32,26 @@ Or install it yourself as:
 
 ### Command line
 
+When using the parser there are four important options to pay attention to:
+- `from` - The input format
+- `to` - The output format
+- `in` - The input file or folder
+- `out` - The output folder (only used when output format is `yaml`)
+
+See `keepachangelog help parse` for more information.
+
 #### Markdown input
 To dump a Changelog to JSON run the following command:
 
-    keepachangelog --path CHANGELOG.md --format json
+    keepachangelog --in CHANGELOG.md --from md --to 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:
-```
+
+```shell
 changelog
 ├── 0.1.0
 │   └── 1-first-merge-request.yaml
@@ -63,14 +76,15 @@ type: New
 ```
 
 
-- `title`: A single sentence without punctiation that describes the change
+- `title`: A single sentence 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`
+To turn this into a Markdown document, simply run
+`keepachangelog --in ./changelog --from yaml --to md`
 
 You can add meta data to your changelog in the file `meta.yaml`, placed inside
 the changelog folder, like so:

data/changelog/0.4.0/5-yaml-files.yaml

@@ -0,0 +1,4 @@
+---
+title: Ability to output changelog to yaml file structure
+merge_request: 9
+type: New

data/changelog/0.4.0/7-numeric-order.yaml

@@ -0,0 +1,4 @@
+---
+title: Sort versions in reverse numerical order in Markdown output
+issue: 7
+type: Fixed

data/changelog/0.4.0/share-with-public.yaml

@@ -0,0 +1,3 @@
+---
+title: The code is pushed into a public repo at gitlab.com
+type: New

data/changelog/0.4.1/8-fix-deploy.yaml

@@ -0,0 +1,4 @@
+---
+title: Deploy job in CI will no longer be skipped even though it should run
+issue: 8
+type: Fixed

data/changelog/meta.yaml

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

data/features/help.feature

@@ -8,5 +8,5 @@ Feature: Show help
     Then the output should contain "Keepachangelog commands"
 
   Scenario: Getting help about a command
-    When I successfully run `keepachangelog help markdown`
+    When I successfully run `keepachangelog help parse`
     Then the output should contain "Usage"

data/features/parser.feature

@@ -0,0 +1,57 @@
+Feature: Parse changelogs
+
+  Parse a changelog by running `keepachangelog parse` or just simply
+  `keepachangelog`.
+
+  Scenario: Convert from Markdown to JSON
+    Given a file "CHANGELOG.md" with:
+      """
+      # My Changes
+      Some intro goes here.
+      ## [Unreleased]
+      ### New
+      - Feature A
+      """
+    When I successfully run `keepachangelog --from md --to json --in CHANGELOG.md`
+    Then the output should contain:
+      """
+      {"versions":{"Unreleased":{"url":null,"date":null,"changes":{"New":["Feature A"]}}},"intro":"Some intro goes here.","title":"My Changes"}
+      """
+
+  Scenario: Convert from YAML files to Markdown
+    Given a file "changelog/1.0.0/1.yml" with:
+      """
+      ---
+      title: Feature A
+      type: New
+      """
+    When I successfully run `keepachangelog --from yaml --to md`
+    Then the output should contain:
+      """
+      # Change log
+      All notable changes to this project will be documented in this file.
+      
+      The format is based on [Keep a Changelog](http://keepachangelog.com/)
+      and this project adheres to [Semantic Versioning](http://semver.org/).
+
+      ## 1.0.0
+      ### New
+      - Feature A.
+      """
+
+  Scenario: Convert from Markdown to YAML files
+    Given a file "CHANGELOG.md" with:
+      """
+      # My Changes
+      Some intro goes here.
+      ## [Unreleased]
+      ### New
+      - Feature A
+      """
+    When I successfully run `keepachangelog --from md --to yaml --in CHANGELOG.md --out test`
+    Then the file "test/Unreleased/feature-a.yaml" should contain:
+      """
+      ---
+      title: Feature A
+      type: New
+      """

data/keepachangelog.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
   spec.version       = Keepachangelog.version
   spec.authors       = ['Basalt AB']
   spec.email         = %w(christoffer.brodd-reijer@basalt.se)
-  spec.licenses      = ['Nonstandard']
+  spec.licenses      = ['MIT']
   spec.summary       = 'Parser for changelogs based on keepachangelog.com'
   spec.description   = 'Tool for parsing changelogs that are based on the '\
                        'keepachangelog.com standard. Changelogs can be dumped '\
                        'to JSON or YAML.'
-  spec.homepage      = 'http://www.basalt.se'
+  spec.homepage      = 'https://gitlab.com/ephracis/keepachangelog'
   spec.files         = gem_files
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/keepachangelog.rb

@@ -1,6 +1,9 @@
-# require 'active_support'
-# require 'active_support/core_ext'
 require 'keepachangelog/version'
 require 'keepachangelog/parser'
+require 'keepachangelog/parser/markdown'
+require 'keepachangelog/parser/yaml'
+require 'keepachangelog/printer'
+require 'keepachangelog/printer/markdown'
+require 'keepachangelog/printer/yaml'
 require 'json'
 require 'yaml'

data/lib/keepachangelog/cli.rb

@@ -14,42 +14,66 @@ module Keepachangelog
     desc 'version', 'Show current version'
     long_desc 'Show the version of the tool'
     def version
-      require 'keepachangelog/version'
       shell.say Keepachangelog.version
     end
 
-    desc 'markdown', 'Parse a changelog in markdown'
-    option :format, type: :string,
-                    desc: 'The output format',
-                    default: 'json',
-                    banner: 'json|yaml',
-                    aliases: '-f'
-    option :path, type: :string,
-                  desc: 'Path to the Changelog file',
-                  default: 'CHANGELOG.md',
-                  aliases: '-p'
-    def markdown
-      require 'keepachangelog/parser/markdown'
-      p = MarkdownParser.load(options[:path])
-      shell.say p.send("to_#{options[:format]}")
+    desc 'parse', 'Parse a changelog'
+    option :from, type: :string,
+                  desc: 'The input format',
+                  default: 'md',
+                  banner: 'yaml|md',
+                  aliases: '-f'
+    option :to, type: :string,
+                desc: 'The output format',
+                default: 'json',
+                banner: 'json|yaml|md',
+                aliases: '-t'
+    option :in, type: :string,
+                desc: 'Path to the input file/folder',
+                aliases: '-i'
+    option :out, type: :string,
+                 desc: 'Path to the output file/folder',
+                 aliases: '-o'
+    def parse
+      case options[:from].to_sym
+      when :md then parse_markdown
+      when :yaml then parse_yaml
+      else
+        shell.error "Unknown input format #{options[:from]}"
+        exit 1
+      end
     end
 
-    desc 'yaml', 'Parse a folder of YAML files'
-    option :format, type: :string,
-                    desc: 'The output format',
-                    default: 'json',
-                    banner: 'json|yaml|md',
-                    aliases: '-f'
-    option :path, type: :string,
-                  desc: 'Path to the yaml folder',
-                  default: 'changelog',
-                  aliases: '-p'
-    def yaml
-      require 'keepachangelog/parser/yaml'
-      p = YamlParser.load(options[:path])
-      shell.say p.send("to_#{options[:format]}")
+    default_task :parse
+
+    private
+
+    def parse_markdown
+      parser = MarkdownParser.load(options[:in])
+      print parser
     end
 
-    default_task :markdown
+    def parse_yaml
+      parser = YamlParser.load(options[:in])
+      print parser
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def print(parser)
+      case options[:to].to_sym
+      when :json
+        shell.say parser.to_json
+      when :s, :string
+        shell.say parser.to_s
+      when :md, :markdown
+        shell.say parser.to_md
+      when :yaml, :yml
+        parser.to_yaml(options[:out])
+        shell.say "Finished writing changelog to '#{options[:out]}'"
+      else
+        shell.error "Unknown output format #{options[:to]}"
+        exit 2
+      end
+    end
   end
 end

data/lib/keepachangelog/parser.rb

@@ -1,5 +1,3 @@
-require 'keepachangelog/markdown_printer'
-
 module Keepachangelog
   class Parser
     attr_accessor :parsed_content
@@ -28,8 +26,11 @@ module Keepachangelog
     #     New:
     #     - Feature A
     # ```
-    def to_yaml
-      parsed_content.to_yaml
+    def to_yaml(path = nil)
+      path ||= 'changelog'
+      require 'keepachangelog/printer/yaml'
+      p = YamlPrinter.new(parsed_content)
+      p.write(path)
     end
 
     # Changelog as a Ruby string
@@ -44,11 +45,12 @@ module Keepachangelog
 
     # Changelog as Markdown
     def to_md
-      md = MarkdownPrinter.new(parsed_content['versions'],
-                               title: parsed_content['title'],
-                               intro: parsed_content['intro'],
-                               url: parsed_content['url'])
-      md.to_s
+      require 'keepachangelog/printer/markdown'
+      p = MarkdownPrinter.new(parsed_content['versions'],
+                              title: parsed_content['title'],
+                              intro: parsed_content['intro'],
+                              url: parsed_content['url'])
+      p.to_s
     end
   end
 end

data/lib/keepachangelog/parser/markdown.rb

@@ -7,16 +7,19 @@ module Keepachangelog
     end
 
     # Parse a file with markdown content
-    def self.load(filename = 'CHANGELOG.md')
+    def self.load(filename = nil)
+      filename ||= 'CHANGELOG.md'
       p = new
       p.parse File.open(filename, &:read)
       p
     end
 
     def parse(content)
-      content = "\n" + clean(content).strip + "\n"
+      content = "\n" + content.strip + "\n"
       anchors = extract_anchors! content
-      versions = content.split(/\n\s*## /)[1..-1]
+      sections = content.split(/\n\s*## /)
+      parse_meta anchors, sections[0]
+      versions = sections[1..-1]
       parsed_content['versions'] = versions.map do |v|
         parse_version v, anchors
       end.to_h
@@ -25,26 +28,44 @@ module Keepachangelog
 
     private
 
-    def clean(content)
-      content.sub(/^.*?\n\s*## /, '## ')
+    def parse_meta(anchors, header)
+      url = get_repo_url(anchors)
+      title = extract_title!(header)
+      intro = header.strip
+      parsed_content['url'] = url if url
+      parsed_content['intro'] = intro unless intro.to_s.empty?
+      parsed_content['title'] = title if title
+    end
+
+    def extract_title!(text)
+      title_pattern = /# (?<title>.*)/
+      match = text.match(title_pattern)
+      return nil unless match && match[:title]
+      text.gsub!(title_pattern, '').strip!
+      match[:title]
     end
 
     def parse_version(content, anchors)
-      header_pattern = /\[(?<name>.*)\]( - (?<date>\d\d\d\d-\d\d-\d\d))?/
+      header_pattern = /\[?(?<name>[^\]]*)\]?( - (?<date>\d\d\d\d-\d\d-\d\d))?/
       sections = content.split(/\n\s*### /)
       header = sections[0].match header_pattern
-      [header[:name],
+      [header[:name].strip,
        {
-         'url' => get_url(header[:name], anchors),
+         'url' => get_version_url(header[:name], anchors),
          'date' => header[:date],
          'changes' => sections[1..-1].map { |s| parse_section s }.to_h
        }]
     end
 
-    def get_url(version, anchors)
+    def get_version_url(version, anchors)
       anchors.keys.include?(version) ? anchors[version] : nil
     end
 
+    def get_repo_url(anchors)
+      return nil unless anchors && anchors.values && anchors.values.first
+      anchors.values.first.gsub(%r{/compare/.*}, '')
+    end
+
     def parse_section(content)
       lines = content.split("\n")
       bullets = lines[1..-1]
@@ -54,7 +75,7 @@ module Keepachangelog
     end
 
     def clean_bullet(string)
-      string.strip.gsub(/^\s*- /, '').gsub(/\(.*#\d+\)\.?$/, '').strip
+      string.strip.gsub(/^\s*- /, '').strip
     end
 
     def extract_anchors!(content)

data/lib/keepachangelog/parser/yaml.rb

@@ -39,7 +39,8 @@ module Keepachangelog
     end
 
     # Parse a folder with YAML files
-    def self.load(path = 'changelog')
+    def self.load(path = nil)
+      path ||= 'changelog'
       p = new
       p.load(path)
       p
@@ -54,7 +55,8 @@ module Keepachangelog
     end
 
     # Parse a folder with YAML files
-    def load(path = 'changelog')
+    def load(path = nil)
+      path ||= 'changelog'
       read_meta("#{path}/meta.yaml")
       Dir.glob("#{path}/*").each { |f| parse_version(f) }
     end
@@ -92,7 +94,8 @@ module Keepachangelog
     end
 
     def generate_line(yaml)
-      line = yaml['title'] + '.'
+      line = yaml['title']
+      line += + '.' unless line =~ /[[:punct:]]$/
       line += " (!#{yaml['merge_request']})" if yaml['merge_request']
       line += " (##{yaml['issue']})" if yaml['issue']
       line += " (#{yaml['author']})" if yaml['author']

data/lib/keepachangelog/printer.rb

@@ -0,0 +1,4 @@
+module Keepachangelog
+  class Printer
+  end
+end

data/lib/keepachangelog/{markdown_printer.rb → printer/markdown.rb}

@@ -1,5 +1,5 @@
 module Keepachangelog
-  class MarkdownPrinter
+  class MarkdownPrinter < Printer
     attr_accessor :options
     attr_accessor :versions
 
@@ -13,18 +13,29 @@ module Keepachangelog
         "# #{options[:title] || default_title}",
         clean_intro(options[:intro]) || default_intro,
         '',
-        versions.reverse_each.map do |k, v|
-          version(k, v)
-        end,
+        parse_versions(versions),
         anchors
       ].flatten.join("\n")
     end
 
     private
 
+    def parse_versions(versions)
+      versions.sort { |a, b| compare_versions(a[0], b[0]) }
+              .reverse_each.map { |k, v| version(k, v) }
+    end
+
+    def compare_versions(a, b)
+      a = Gem::Version.new(a) if Gem::Version.correct?(a)
+      b = Gem::Version.new(b) if Gem::Version.correct?(b)
+      return -1 if b == 'Unreleased'
+      return 1 if a == 'Unreleased'
+      a <=> b
+    end
+
     def clean_intro(text)
       return nil unless text
-      text.to_s.strip.gsub("\n", "\n\n")
+      text.to_s.strip
     end
 
     def version(header, content)

data/lib/keepachangelog/printer/yaml.rb

@@ -0,0 +1,79 @@
+require 'fileutils'
+
+module Keepachangelog
+  class YamlPrinter < Printer
+    attr_accessor :changelog
+
+    def initialize(changelog)
+      self.changelog = changelog
+    end
+
+    def write(path)
+      FileUtils.mkdir_p(path)
+      write_meta File.join(path, 'meta.yaml')
+      write_versions path, changelog['versions']
+    end
+
+    private
+
+    def write_meta(path)
+      meta = {}
+      %w(url title intro).each do |key|
+        meta[key] = changelog[key] unless changelog[key].to_s.empty?
+      end
+      File.write(path, meta.to_yaml)
+    end
+
+    def write_versions(path, versions)
+      versions.each do |version, data|
+        folder = File.join(path, version)
+        FileUtils.mkdir_p folder
+        write_changes folder, data['changes']
+      end
+    end
+
+    def write_changes(path, changes)
+      changes.each do |section, lines|
+        lines.each do |line|
+          change = parse_line(line)
+          change['type'] = section
+          write_change path, change
+        end
+      end
+    end
+
+    def write_change(folder, change)
+      fname = change['title'].gsub(/\W/, ' ').strip.tr(' ', '-').downcase
+      fname = "#{change['issue']}-#{fname}" if change['issue']
+      fname = "#{change['merge_request']}-#{fname}" if change['merge_request']
+      path = create_unique_file(folder, fname + '.yaml')
+      File.write(path, change.to_yaml)
+    end
+
+    def parse_line(line)
+      issue = extract_field! line, /\s*\(#(?<issue>\d+)\)\s*/, :issue
+      mr = extract_field! line, /\s*\(!(?<mr>\d+)\)\s*/, :mr
+      author = extract_field! line, /\s*\((?<author>.*@.*)\)\s*/, :author
+      data = { 'title' => line }
+      data['author'] = author if author
+      data['merge_request'] = mr.to_i if mr
+      data['issue'] = issue.to_i if issue
+      data
+    end
+
+    def extract_field!(line, pattern, name)
+      match = line.match(pattern)
+      return nil unless match && match[name]
+      line.gsub!(pattern, '').strip
+      match[name]
+    end
+
+    def create_unique_file(folder, filename)
+      if File.exist? File.join(folder, filename)
+        randstr = SecureRandom.hex(3)
+        filename = "#{randstr}-#{filename}"
+      end
+      File.join(folder, filename)
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keepachangelog",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "Parser for changelogs based on keepachangelog.com",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@git.basalt.se:chbr/keepachangelog.git"
+    "url": "git@gitlab.com:ephracis/keepachangelog.git"
   },
   "author": "Christoffer Reijer",
   "license": "ISC",

data/spec/parser/markdown_spec.rb

@@ -28,7 +28,8 @@ module Keepachangelog
                 'Fixed' => ['Feature B']
               }
             }
-          }
+          },
+          'url' => 'http://test.io'
         )
       end
 
@@ -55,7 +56,8 @@ module Keepachangelog
               'date' => nil,
               'changes' => { 'Fixed' => ['Feature B'] }
             }
-          }
+          },
+          'url' => 'http://test.io'
         )
       end
 
@@ -84,6 +86,22 @@ module Keepachangelog
           }
         )
       end
+
+      it 'should parse title and intro' do
+        content = "
+        # My Title
+        My test intro.
+        ## 1.0.0
+        "
+        cl = MarkdownParser.parse(content)
+        expect(cl).to eq(
+          'versions' => {
+            '1.0.0' => { 'url' => nil, 'date' => nil, 'changes' => {} }
+          },
+          'title' => 'My Title',
+          'intro' => 'My test intro.'
+        )
+      end
     end
 
     describe '.load' do

data/spec/parser_spec.rb

@@ -11,9 +11,9 @@ module Keepachangelog
     end
 
     describe '.to_yaml' do
-      it 'should cast parsed content into yaml' do
+      it 'should cast parsed content into a yaml files' do
         p = Parser.new
-        expect(p.parsed_content).to receive(:to_yaml)
+        expect_any_instance_of(YamlPrinter).to receive(:write)
         p.to_yaml
       end
     end

data/spec/printer/markdown_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Keepachangelog
+  describe MarkdownPrinter do
+    describe '.to_s' do
+      it 'should print markdown document' do
+        versions = {
+          '1.0.0' => {
+            'changes' => { 'New' => ['Feature A'] }
+          }
+        }
+        p = MarkdownPrinter.new(versions, title: 'My Title')
+        md = p.to_s
+        expect(md).to match('# My Title')
+        expect(md).to match('## 1.0.0')
+      end
+
+      it 'should order versions numerically' do
+        versions = {
+          '0.1.0' => {
+            'changes' => { 'New' => ['Feature A'] }
+          },
+          '0.10.0' => {
+            'changes' => { 'New' => ['Feature B'] }
+          },
+          '0.2.0' => {
+            'changes' => { 'New' => ['Feature C'] }
+          }
+        }
+        p = MarkdownPrinter.new(versions)
+        md = p.to_s.delete("\n")
+        expect(md).to match(/.*0\.10\.0.*0\.2\.0.*0\.1\.0.*/)
+      end
+    end
+  end
+end

data/spec/printer/yaml_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Keepachangelog
+  describe YamlPrinter do
+    let(:changelog) do
+      {
+        'versions' => {
+          '1.0.0' => {
+            'changes' => {
+              'New' => [
+                'Feature A',
+                'Feature B'
+              ],
+              'Fixed' => ['Bug A']
+            }
+          },
+          '1.0.1' => {
+            'changes' => { 'Fixed' => ['Bug B'] }
+          }
+        },
+        'url' => 'https://git.example.com/foo/bar',
+        'title' => 'Change log',
+        'intro' => 'This is my intro'
+      }
+    end
+    let(:p) { YamlPrinter.new(changelog) }
+
+    describe '.write' do
+      before do
+        allow(FileUtils).to receive(:mkdir_p).with('test')
+        allow(FileUtils).to receive(:mkdir_p).with('test/1.0.0')
+        allow(FileUtils).to receive(:mkdir_p).with('test/1.0.1')
+        allow(File).to receive(:write).with('test/**/*.yaml', any_args)
+      end
+
+      it 'should create destination folder' do
+        allow(p).to receive(:write_meta)
+        allow(p).to receive(:write_versions)
+        expect(FileUtils).to receive(:mkdir_p).with('test')
+        p.write('test')
+      end
+
+      it 'should create meta file' do
+        meta_content = "---\nurl: https://git.example.com/foo/bar\ntitle: "\
+                       "Change log\nintro: This is my intro\n"
+        allow(p).to receive(:write_versions)
+        expect(File).to receive(:write).with('test/meta.yaml', meta_content)
+        p.write('test')
+      end
+
+      it 'should create version folders' do
+        allow(p).to receive(:write_meta)
+        allow(p).to receive(:write_changes)
+        expect(FileUtils).to receive(:mkdir_p).with('test/1.0.0')
+        expect(FileUtils).to receive(:mkdir_p).with('test/1.0.1')
+        p.write('test')
+      end
+
+      it 'should write change file' do
+        allow(p).to receive(:write_meta)
+        expect(File).to receive(:write).with(
+          'test/1.0.0/feature-a.yaml',
+          "---\ntitle: Feature A\ntype: New\n"
+        )
+        expect(File).to receive(:write).with(
+          'test/1.0.0/feature-b.yaml',
+          "---\ntitle: Feature B\ntype: New\n"
+        )
+        expect(File).to receive(:write).with(
+          'test/1.0.0/bug-a.yaml',
+          "---\ntitle: Bug A\ntype: Fixed\n"
+        )
+        expect(File).to receive(:write).with(
+          'test/1.0.1/bug-b.yaml',
+          "---\ntitle: Bug B\ntype: Fixed\n"
+        )
+        p.write('test')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
 require 'simplecov'
 SimpleCov.start
 require 'keepachangelog'
-require 'keepachangelog/parser/markdown'
-require 'keepachangelog/parser/yaml'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keepachangelog
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Basalt AB
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,31 +152,37 @@ files:
 - changelog/0.3.0/3-anchors-without-url.yaml
 - changelog/0.3.0/4-document-meta.yaml
 - changelog/0.3.1/6-clean-changelog.yaml
+- changelog/0.4.0/5-yaml-files.yaml
+- changelog/0.4.0/7-numeric-order.yaml
+- changelog/0.4.0/share-with-public.yaml
+- changelog/0.4.1/8-fix-deploy.yaml
 - changelog/meta.yaml
 - exe/keepachangelog
 - features/help.feature
-- features/markdown.feature
+- features/parser.feature
 - features/support/aruba.rb
 - features/version.feature
-- features/yaml.feature
 - keepachangelog.gemspec
 - lib/keepachangelog.rb
 - lib/keepachangelog/cli.rb
-- lib/keepachangelog/markdown_printer.rb
 - lib/keepachangelog/parser.rb
 - lib/keepachangelog/parser/markdown.rb
 - lib/keepachangelog/parser/yaml.rb
+- lib/keepachangelog/printer.rb
+- lib/keepachangelog/printer/markdown.rb
+- lib/keepachangelog/printer/yaml.rb
 - lib/keepachangelog/version.rb
 - package.json
-- spec/markdown_printer_spec.rb
 - spec/parser/markdown_spec.rb
 - spec/parser/yaml_spec.rb
 - spec/parser_spec.rb
+- spec/printer/markdown_spec.rb
+- spec/printer/yaml_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
-homepage: http://www.basalt.se
+homepage: https://gitlab.com/ephracis/keepachangelog
 licenses:
-- Nonstandard
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/features/markdown.feature

@@ -1,43 +0,0 @@
-Feature: List transformators
-
-  Parse a changelog by running `keepachangelog parse` or just simply
-  `keepachangelog`.
-
-  Scenario: Running with command
-    Given a file "CHANGELOG.md" with:
-      """
-      ## [Unreleased]
-      ### New
-      - Feature A
-      """
-    When I successfully run `keepachangelog markdown`
-    Then the output should contain:
-      """
-      {"versions":{"Unreleased":{"url":null,"date":null,"changes":{"New":["Feature A"]}}}}
-      """
-
-  Scenario: Running without command
-    Given a file "CHANGELOG.md" with:
-      """
-      ## [Unreleased]
-      ### New
-      - Feature A
-      """
-    When I successfully run `keepachangelog`
-    Then the output should contain:
-      """
-      {"versions":{"Unreleased":{"url":null,"date":null,"changes":{"New":["Feature A"]}}}}
-      """
-
-  Scenario: Changelog has a non-default filename
-    Given a file "HISTORY.md" with:
-      """
-      ## [Unreleased]
-      ### New
-      - Feature A
-      """
-    When I successfully run `keepachangelog --path=HISTORY.md`
-    Then the output should contain:
-      """
-      {"versions":{"Unreleased":{"url":null,"date":null,"changes":{"New":["Feature A"]}}}}
-      """

data/features/yaml.feature

@@ -1,17 +0,0 @@
-Feature: List transformators
-
-  Parse a changelog by running `keepachangelog parse` or just simply
-  `keepachangelog`.
-
-  Scenario: Running with command
-    Given a file "changelog/1.0.0/1.yml" with:
-      """
-      ---
-      title: Feature A
-      type: New
-      """
-    When I successfully run `keepachangelog yaml`
-    Then the output should contain:
-      """
-      {"versions":{"1.0.0":{"changes":{"New":["Feature A."]}}}}
-      """

data/spec/markdown_printer_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-module Keepachangelog
-  describe MarkdownPrinter do
-    describe '.to_s' do
-      it 'should print markdown document' do
-        versions = {
-          '1.0.0' => {
-            'changes' => { 'New' => ['Feature A'] }
-          }
-        }
-        p = MarkdownPrinter.new(versions, title: 'My Title')
-        md = p.to_s
-        expect(md).to match('# My Title')
-        expect(md).to match('## 1.0.0')
-      end
-    end
-  end
-end