sheep-a-changelog 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 041f2db4fdd1e1b435a9702d4746d603a67205e69d5b715abc2864182eefd4d4
-  data.tar.gz: 263e3379126dbbbed82eeb94bef04c0ca5256cc46d347b3e498ab723db1e2088
+  metadata.gz: 97b4d535fc2e01b02db09270df9394f32fba28ae90dbb8afdee687484e2a5bc8
+  data.tar.gz: 790a3e1a6569d44473852c6e3f23eb53229c5d75e377474938e9745253599202
 SHA512:
-  metadata.gz: a077f385b659c543cbf3349a2a9cc54cece15582ea2b3e93cf5106ae71b14c7600dd4f83358644b4e95e9b2f011d481c5fe2c8c8110153ce4a4264429eda6338
-  data.tar.gz: 869112435098cde9c8b3d130feb2b47257f7cf8e7d7184b91d416b10e2a0236143360edbdd926241a78936bc55ead88e06751940429f7eb017346de2f8f11cb9
+  metadata.gz: 54c466cde177deb6d832c62bf9be2481faa23b9e802bfb48415d41fa21bcd4bc769cbe1cdd00123bedc7468d79f52730de914e2ef8514beebc334eedd403a4b6
+  data.tar.gz: 362c51c13e2010ced70fd7524a17fd867b6cf4312b8a85c32c536bad070519661b8c828e58c3d7376dc7aeee1be767d731d7c1d222e95a24700648caf6e0142a

data/README.md

@@ -12,5 +12,128 @@
 
 :sheep: Simple, particular, example driven parser of keep-a-changelog format.
 
+## About
 
 Parse a markdown changelog in [keep-a-changelog](https://keepachangelog.com) format to the optimal resolution depth to perform semantic tasks.
+
+## Install
+
+See [RubyGems](https://rubygems.org/gems/sheep-a-changelog) for installation instructions (simply add to your Gemfile).
+
+Sheep-a-changelog requires at least ruby 2.2, and is [tested](https://travis-ci.com/grissius/sheep-a-changelog) on several minor versions up to 2.5.
+
+## Getting started
+
+```ruby
+require 'sheep-a-changelog'
+
+# Load keep-a-changelog markdown file as a string
+contents = File.read('./path/to/CHANGELOG.md')
+
+# Create an abstraction for it using the parser
+# SheepAChangelog.parse: string -> SheepAChangelog.Node
+doc = SheepAChangelog.parse(contents)
+
+# TODO temper with the structure
+# See features section
+
+# Serialize back to string
+updated = doc.to_s
+
+# Save back
+File.write('./path/to/CHANGELOG.md', updated)
+```
+
+## Features
+
+### Release
+This method performs the following actions:
+- Rename current _unreleased_ version log to _new version_
+- Add anchor for _new version_
+- Add empty _unreleased_
+- Update _unreleased_ anchor
+
+It accepts arguments
+1. `new_version` - semver format
+2. `tag_prefix` - prefix for `new_version` for git tags (used for anchors). Defaults to `v`
+3. `date` - date of the release, defaults to now
+
+```ruby
+doc.release('2.0.0', 'v', Time.utc(2017, 6, 20))
+```
+
+
+### Inspect element
+```ruby
+node.build_tree
+# :title - heading (string) or :empty for top-level node
+# :lines - string[] of contents belonging to this node, without anchors and child nodes
+# :anchors - { :v, :url } of anchor nodes
+# :nodes - child nodes
+```
+```yaml
+  :title: :empty
+  :lines: []
+  :anchors:
+  - :v: Unreleased
+    :url: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+  - :v: 1.0.0
+    :url: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
+  :nodes:
+  - :title: Changelog
+    :lines:
+    - All notable changes to this project will be documented in this file.
+    - ''
+    - The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+    - and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+    - ''
+    :anchors: []
+    :nodes:
+    - :title: "[1.0.0] - 2017-06-20"
+      :lines: []
+      :anchors: []
+      :nodes:
+      - :title: Added
+        :lines:
+        - '- "Frequently Asked Questions" section.'
+        - ''
+        :anchors: []
+        :nodes: []
+```
+
+### Latest version title
+Returns the contents of the heading for the latest version.
+```ruby
+doc.latest_version_title
+# --> "[1.0.0] - 2017-06-20"
+```
+
+### Diff prefix
+Returns URL prefix for the anchors. If multiple used, return the most frequent.
+```ruby
+doc.diff_prefix
+# --> "https://github.com/olivierlacan/keep-a-changelog/compare/"
+```
+
+### Rename version
+Rename version. Looking for exact match. This only changes the title and keeps the contents (inlcuding all children intact.)
+```ruby
+doc.rename_version('[Unreleased]', new_version)
+```
+
+### Add anchor
+```ruby
+doc.add_anchor('LABEL', 'vFROM', 'vTO')
+# adds "[LABEL]: {diff_prefix}/vFROM...vTO" as the topmost anchor
+```
+
+## Todo
+
+- :heavy_check_mark: Ensure unreleased
+- :heavy_check_mark: Release
+- :construction: Initialize
+- :construction: Sort type sections
+- :construction: Fix typos in type sections
+
+## License
+Licensed under [MIT](./LICENSE)

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/lib/sheep-a-changelog.rb

@@ -1,2 +1,7 @@
+require_relative 'sheep-a-changelog/parser'
+
 module SheepAChangelog
+  def self.parse(changelog)
+    Parser.parse(changelog)
+  end
 end

data/lib/sheep-a-changelog/document.rb

@@ -0,0 +1,63 @@
+require_relative 'node'
+
+module SheepAChangelog
+  class Document < Node
+    def initialize(lines)
+      super(lines, :empty, 0)
+    end
+
+    # Return parent node to version nodes
+    def version_root
+      nodes.first
+    end
+
+    # Return title of the latest version node
+    def latest_version_title(n = 0)
+      version_root.nodes[n].title
+    end
+
+    # Return the latest version
+    def latest_version(n = 0)
+      latest_version_title(n).match(/^\[(\S+)\].*/).to_a[1]
+    end
+
+    def add_empty_version(name)
+      version_root.nodes.unshift(Node.new([''], name, 2))
+    end
+
+    def diff_prefix
+      anchors.map { |a| a[:url].match(%r{^(.*\/)(.*\.\.\..*)$}).to_a[1] }
+             .each_with_object(Hash.new(0)) { |word, counts| counts[word] += 1 }
+             .to_a
+             .min { |a, b| b[1] <=> a[1] }
+             .first
+    end
+
+    def rename_version(from, to)
+      parent = version_root
+      parent.nodes.map! do |node|
+        if node.title == from
+          Node.new(node.all_lines_wo_heading.first, to, 2)
+        else
+          node
+        end
+      end
+    end
+
+    def add_anchor(name, from, to)
+      anchors.unshift(v: name, url: "#{diff_prefix}#{from}...#{to}")
+    end
+
+    def remove_anchor_unreleased
+      anchors.reject! { |a| a[:v] == 'Unreleased' }
+    end
+
+    def release(version, tag_prefix, t = Time.now)
+      remove_anchor_unreleased
+      rename_version('[Unreleased]', "[#{version}] - #{t.strftime('%Y-%m-%d')}")
+      add_anchor(version, tag_prefix + latest_version(1), version)
+      add_empty_version('[Unreleased]')
+      add_anchor('Unreleased', tag_prefix + version, 'HEAD')
+    end
+  end
+end

data/lib/sheep-a-changelog/node.rb

@@ -1,6 +1,7 @@
 module SheepAChangelog
   class Node
-    attr_accessor :lines, :nodes
+    attr_reader :lines, :title, :anchors
+    attr_accessor :nodes
     def self.parse(string)
       new(string.split("\n"))
     end
@@ -34,23 +35,26 @@ module SheepAChangelog
     end
 
     def self.pick_lines(lines)
-      content_lines = []
-      anchor_lines = []
-      lines.each do |line|
-        if line =~ /^\[.*\].*\s*:\s*\S+$/
-          anchor_lines << line
-        else
-          content_lines << line
-        end
+      # add matches for links
+      groups_lines = lines.inject([]) do |acc, line|
+        groups = line.match(/^\[(.*)\]\s*:\s*(\S+)\s*$/).to_a
+        acc + [[groups, line]]
       end
-      [content_lines, anchor_lines]
+      # if no matches, it is content lines
+      content_lines = groups_lines
+                      .select { |x| x.first.empty? }.map { |_, l| l }
+      # if matches, it is link
+      anchors = groups_lines
+                .reject { |x| x.first.empty? }
+                .map { |groups, _| { v: groups[1], url: groups[2] } }
+      [content_lines, anchors]
     end
 
     # Create node hierarchy from keep-a-changeloh markdown lines
-    def initialize(lines, title = :empty, level = 0)
-      content_lines, anchor_lines = Node.pick_lines(lines)
+    def initialize(lines, title, level)
+      content_lines, anchors = Node.pick_lines(lines)
       @title = title
-      @anchor_lines = anchor_lines
+      @anchors = anchors
       @nodes = build_nodes(content_lines, level + 1)
       @level = level
     end
@@ -67,9 +71,15 @@ module SheepAChangelog
     def all_lines
       res = []
       res << format_heading if @title != :empty
-      res += @lines unless @lines.empty?
-      res += @nodes.map(&:all_lines) unless @nodes.empty?
-      res += @anchor_lines unless @anchor_lines.empty?
+      res += all_lines_wo_heading
+      res
+    end
+
+    def all_lines_wo_heading
+      res = []
+      res += @lines
+      res += @nodes.map(&:all_lines)
+      res += @anchors.map { |a| "[#{a[:v]}]: #{a[:url]}" }
       res
     end
 
@@ -82,7 +92,7 @@ module SheepAChangelog
     def build_tree
       { title: @title,
         lines: @lines,
-        anchor_nodes: @anchor_lines,
+        anchors: @anchors,
         nodes: @nodes.map(&:build_tree) }
     end
   end

data/lib/sheep-a-changelog/parser.rb

@@ -1,9 +1,9 @@
-require_relative 'node'
+require_relative 'document'
 
 module SheepAChangelog
   module Parser
     def self.parse(contents)
-      doc = Node.parse(contents)
+      doc = Document.parse(contents)
       doc
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sheep-a-changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jaroslav Šmolík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -118,6 +118,7 @@ files:
 - README.md
 - VERSION
 - lib/sheep-a-changelog.rb
+- lib/sheep-a-changelog/document.rb
 - lib/sheep-a-changelog/meta.rb
 - lib/sheep-a-changelog/node.rb
 - lib/sheep-a-changelog/parser.rb
@@ -141,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Simple, particular, example driven parser of keep-a-changelog format.