sheep-a-changelog 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 041f2db4fdd1e1b435a9702d4746d603a67205e69d5b715abc2864182eefd4d4
+  data.tar.gz: 263e3379126dbbbed82eeb94bef04c0ca5256cc46d347b3e498ab723db1e2088
+SHA512:
+  metadata.gz: a077f385b659c543cbf3349a2a9cc54cece15582ea2b3e93cf5106ae71b14c7600dd4f83358644b4e95e9b2f011d481c5fe2c8c8110153ce4a4264429eda6338
+  data.tar.gz: 869112435098cde9c8b3d130feb2b47257f7cf8e7d7184b91d416b10e2a0236143360edbdd926241a78936bc55ead88e06751940429f7eb017346de2f8f11cb9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jaroslav Šmolík
+
+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

@@ -0,0 +1,16 @@
+<p align="center">
+  <img src="https://upload.wikimedia.org/wikipedia/commons/b/b9/Sheep%2C_Stodmarsh_6.jpg" height="170" width="170"/>
+</p>
+
+# Sheep a changelog
+
+[![Build Status](https://img.shields.io/travis/com/grissius/sheep-a-changelog/master.svg?style=flat-square)](https://travis-ci.com/grissius/sheep-a-changelog)
+[![Coverage Status](https://img.shields.io/coveralls/github/grissius/sheep-a-changelog.svg?style=flat-square)](https://coveralls.io/github/grissius/sheep-a-changelog?branch=master)
+[![Gem](https://img.shields.io/gem/v/sheep-a-changelog.svg?style=flat-square)](https://rubygems.org/gems/sheep-a-changelog)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/grissius/sheep-a-changelog.svg?style=flat-square)](https://codeclimate.com/github/grissius/sheep-a-changelog)
+[![License](https://img.shields.io/github/license/grissius/sheep-a-changelog.svg?style=flat-square)](https://github.com/grissius/sheep-a-changelog/blob/master/LICENSE)
+
+:sheep: Simple, particular, example driven parser of keep-a-changelog format.
+
+
+Parse a markdown changelog in [keep-a-changelog](https://keepachangelog.com) format to the optimal resolution depth to perform semantic tasks.

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/lib/sheep-a-changelog.rb

@@ -0,0 +1,2 @@
+module SheepAChangelog
+end

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

@@ -0,0 +1,39 @@
+module SheepAChangelog
+  module Meta
+    def self.name
+      'sheep-a-changelog'.freeze
+    end
+
+    def self.version
+      File.read(File.expand_path('../../VERSION', __dir__)).strip
+    end
+
+    def self.summary
+      'Simple, particular, example driven parser of keep-a-changelog format.'
+        .freeze
+    end
+
+    def self.description
+      text = <<-DESCRIPTION
+        #{summary}
+      DESCRIPTION
+      text.strip
+    end
+
+    def self.homepage
+      'https://github.com/grissius/keep-a-changelog'.freeze
+    end
+
+    def self.license
+      'MIT'.freeze
+    end
+
+    def self.author
+      'Jaroslav Šmolík'.freeze
+    end
+
+    def self.email
+      'grissius@gmail.com'.freeze
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module SheepAChangelog
+  class Node
+    attr_accessor :lines, :nodes
+    def self.parse(string)
+      new(string.split("\n"))
+    end
+
+    def hashes(n = @level)
+      '#' * n
+    end
+
+    def h_regexp(level)
+      Regexp.new('^' + hashes(level) + '\s+([\S\s]+)$')
+    end
+
+    # Contruct nodes for current node from all lines
+    def build_nodes(lines, next_level) # rubocop:disable Metrics/MethodLength
+      last = nil
+      line_buff = []
+      (lines + [:last]).each_with_object([]) do |line, nodes|
+        heading = line[h_regexp(next_level), 1] if line.is_a? String
+        if heading || line == :last
+          if last.nil?
+            @lines = line_buff
+          else
+            nodes << Node.new(line_buff, last, next_level)
+          end
+          last = heading
+          line_buff = []
+        else
+          line_buff << line
+        end
+      end
+    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
+      end
+      [content_lines, anchor_lines]
+    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)
+      @title = title
+      @anchor_lines = anchor_lines
+      @nodes = build_nodes(content_lines, level + 1)
+      @level = level
+    end
+
+    # Format your node's title
+    def format_heading
+      "#{hashes} #{@title}"
+    end
+
+    # Get lines from
+    # 1. your title
+    # 2. your immidiate lines
+    # 3. recursively from your direct nodes
+    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
+    end
+
+    # Print the markdown output
+    def to_s
+      all_lines.join("\n")
+    end
+
+    # Serialize tree to the hashes
+    def build_tree
+      { title: @title,
+        lines: @lines,
+        anchor_nodes: @anchor_lines,
+        nodes: @nodes.map(&:build_tree) }
+    end
+  end
+end

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

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

data/sheep-a-changelog.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/sheep-a-changelog/meta'
+
+Gem::Specification.new do |s|
+  s.name        = SheepAChangelog::Meta.name
+  s.version     = SheepAChangelog::Meta.version
+  s.homepage    = SheepAChangelog::Meta.homepage
+  s.license     = SheepAChangelog::Meta.license
+  s.author      = SheepAChangelog::Meta.author
+  s.email       = SheepAChangelog::Meta.email
+
+  s.summary     = SheepAChangelog::Meta.summary
+  s.description = SheepAChangelog::Meta.description
+
+  s.files = Dir['lib/**/*',
+                '*.gemspec',
+                'LICENSE*',
+                'README*',
+                'VERSION']
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rspec-cheki', '~> 0.1'
+  s.add_development_dependency 'rubocop', '~> 0.61.1'
+  s.add_development_dependency 'simplecov', '~> 0.12'
+  s.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: sheep-a-changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Jaroslav Šmolík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-cheki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Simple, particular, example driven parser of keep-a-changelog format.
+email: grissius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- lib/sheep-a-changelog.rb
+- lib/sheep-a-changelog/meta.rb
+- lib/sheep-a-changelog/node.rb
+- lib/sheep-a-changelog/parser.rb
+- sheep-a-changelog.gemspec
+homepage: https://github.com/grissius/keep-a-changelog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Simple, particular, example driven parser of keep-a-changelog format.
+test_files: []