Module: Philiprehberger::ChangelogParser

Defined in:

lib/philiprehberger/changelog_parser.rb,
lib/philiprehberger/changelog_parser/parser.rb,
lib/philiprehberger/changelog_parser/version.rb,
lib/philiprehberger/changelog_parser/changelog.rb,
lib/philiprehberger/changelog_parser/version_entry.rb

Defined Under Namespace

Classes: Changelog, Error, Parser, VersionEntry

Constant Summary

VERSION =

'0.6.0'

Class Method Summary

• .from_json(json_string) ⇒ Changelog

  Deserialize a changelog from a JSON string.

• .parse(input) ⇒ Changelog

  Parse a changelog from a file path or string.

Class Method Details

.from_json(json_string) ⇒ Changelog

Deserialize a changelog from a JSON string

Parameters:

• json_string (String) —

  JSON produced by Changelog#to_json

Returns:

• (Changelog) —

  the deserialized changelog

# File 'lib/philiprehberger/changelog_parser.rb', line 22

def self.from_json(json_string)
  Changelog.from_json(json_string)
end

.parse(input) ⇒ Changelog

Parse a changelog from a file path or string

Parameters:

• input (String) —

  file path or markdown string

Returns:

• (Changelog) —

  the parsed changelog

# File 'lib/philiprehberger/changelog_parser.rb', line 14

def self.parse(input)
  Parser.call(input)
end