.travis.yml

@@ -28,5 +28,5 @@ script:
   - mkdir tmp
   - cd tmp
   - cmake ..
-  - make -j4
+  - make
   - ../build/MaddyTests

AUTHORS

@@ -6,6 +6,3 @@ a license to everyone to use it as detailed in LICENSE.)
 
 M. Petra Baranski (info@progsource.de)
 Patrick José Pereira (patrickelectric@gmail.com)
-Martin Kopecky (martin.kopecky357@gmail.com)
-Andrew Mettlach (dmmettlach@gmail.com)
-Evan Klitzke (evan@eklitzke.org)

CHANGELOG.md

@@ -1,67 +0,0 @@
-# Changelog
-
-This file tries to follow roughly [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
-maddy uses [semver versioning](https://semver.org/).
-
-## Badges
-
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) for any bug fixes.
-* ![**SECURITY**](https://img.shields.io/badge/-SECURITY-%23c00) in case of vulnerabilities.
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) for new features.
-* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) for changes in existing functionality.
-* ![**DEPRECATED**](https://img.shields.io/badge/-DEPRECATED-%23666) for soon-to-be removed features.
-* ![**REMOVED**](https://img.shields.io/badge/-REMOVED-%23900) for now removed features.
-
-## Upcoming
-
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added Changelog
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added contribution guideline
-* ?
-
-## version 1.1.2 2020-10-04
-
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) `*`, `+` and `-` are equivalent for making unordered bullet list
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Parsing support for fully numeric ordered lists
-* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) make `Parser::Parse` accept istreams instead of stringstream
-* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) CMake is creating an interface library which you can include in your own `target_link_libraries` and the global include path is untouched from maddy.
-
-## version 1.1.1 2019-12-27
-
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) BreakLineParser
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) HTMLParser
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added optional config with the following options:
-    * en-/disable the emphasized parser
-    * wrap/not wrap HTML in markdown within a paragraph in output
-* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) Updated gtest to release-1.10.0 to fix build issues
-
-
-## version 1.1.0 2019-02-19
-
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Added missing includes to BlockParser
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Added missing dtor to BlockParser and LineParser
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) `__test__` can also be used to get `<strong>text</strong>`
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added AppVeyor CI
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added clang for CI
-* ![**CHANGED**](https://img.shields.io/badge/-CHANGED-%23e90) Single underscore `_` results in emphasized tag `<em>`, single `*` in italic tag `<i>`
-
-## version 1.0.3 2018-01-18
-
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Make sure that all parsers are finished
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) ol documentation
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added Travic-CI with gcc
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added Howto for running the tests on the README
-
-## version 1.0.2 2017-12-26
-
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Fixed inline code for directly following letters (bold, emphasized and strikethrough)
-
-## version 1.0.1 2017-12-25
-
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Fixed inline code for bold, emphasized and strikethrough
-* ![**FIXED**](https://img.shields.io/badge/-FIXED-%23090) Fixed spelling in README
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Use Gold Linker on Unix if available for faster compile time
-* ![**ADDED**](https://img.shields.io/badge/-ADDED-%23099) Added Github ISSUE_TEMPLATE
-
-## version 1.0.0 2017-12-25
-
-initial release

CMakeLists.txt

@@ -60,9 +60,10 @@ add_subdirectory(libs)
 
 # ------------------------------------------------------------------------------
 
-add_library(maddy INTERFACE)
+include_directories(
-target_include_directories(maddy INTERFACE
+  ${LIBS_INCLUDE_DIRS}
   ${MADDY_INCLUDE_DIR}
+  ${CMAKE_CURRENT_SOURCE_DIR}/tests
 )
 
 # ------------------------------------------------------------------------------
@@ -72,9 +73,5 @@ add_executable(
     ${MADDY_TESTS_FILES}
     ${CMAKE_CURRENT_SOURCE_DIR}/tests/main.cpp
 )
-target_include_directories(MaddyTests PUBLIC
+target_link_libraries(MaddyTests gmock_main)
-  ${LIBS_INCLUDE_DIRS}
-  ${CMAKE_CURRENT_SOURCE_DIR}/tests
-)
-target_link_libraries(MaddyTests maddy gmock_main)
 add_test(MaddyTests ${CMAKE_CURRENT_SOURCE_DIR}/build/MaddyTests)

CONTRIBUTING.md

@@ -1,26 +0,0 @@
-# Contribution Guideline
-
-First of all: I am thankful for any contribution this project gets.
-
-## Creating Issues
-
-You found a bug, you miss some feature in the project or have an idea how to
-improve the code? Then [create a GitHub issue](https://github.com/progsource/maddy/issues/new).
-
-## Creating Pull-Requests
-
-* Use a branch other than master.
-* Add yourself to the `AUTHORS` file.
-* Try to stick with the code style the files are having right now.
-* Write in your commit messages what/why you did something. Often times a one-liner might be enough, but if you want to write more, make an empty line in between like:
-  ```
-  Short description
-
-  More and longer text for the commit message with some more information.
-  That can go over multiple lines.
-  ```
-  Do not include Github issue ticket numbers inside commit messages.
-* Explain for what your PR is for - like providing a use-case or something similar.
-* Update documentation of the Markdown syntax if anything changed there. (`docs/definitions.md`)
-* Add a changelog entry at "Upcoming" inside of `CHANGELOG.md`
-* Make sure, that the tests are successful.

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017, 2018, 2019, 2020 M. Petra Baranski
+Copyright 2017, 2018, 2019 M. Petra Baranski
 
 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

README.md

@@ -1,3 +1,80 @@
-# qsmaddy
+# maddy
 
-Fork of [maddy](https://github.com/progsource/maddy) with some quick hacks to make it fit better for [qswiki](https://gitea.quitesimple.org/crtxcr/qswiki)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Version: 1.1.1](https://img.shields.io/badge/Version-1.1.1-brightgreen.svg)](https://semver.org/)
+[![Travis Build Status](https://travis-ci.org/progsource/maddy.svg?branch=master)](https://travis-ci.org/progsource/maddy)
+[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/04m0lg27kigv1pg8/branch/master?svg=true)](https://ci.appveyor.com/project/progsource/maddy/branch/master)
+
+maddy is a C++ Markdown to HTML **header-only** parser library.
+
+## Supported OS
+
+It actually should work on any OS, that supports the C++14 standard library.
+
+It is tested to work on:
+
+* Linux (gcc)
+* OSX (clang)
+* Windows (Visual Studio 2017)
+
+## Dependencies
+
+* C++14
+
+## Why maddy?
+
+When I was needing a Markdown parser in C++ I couldn't find any, that was
+fitting my needs. So I simply wrote my own one.
+
+## Markdown syntax
+
+The supported syntax can be found in the [definitions docs](docs/definitions.md).
+
+## How to use
+
+To use maddy in your project, simply add the include path of maddy to yours
+and in the code, you can then do the following:
+
+```c++
+#include <memory>
+#include <string>
+
+#include "maddy/parser.h"
+
+std::stringstream markdownInput("");
+
+// config is optional
+std::shared_ptr<maddy::ParserConfig> config = std::make_shared<maddy::ParserConfig>();
+config->isEmphasizedParserEnabled = true; // default
+config->isHTMLWrappedInParagraph = true; // default
+
+std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>(config);
+std::string htmlOutput = parser->Parse(markdownInput);
+```
+
+## How to run the tests
+
+*(tested on Linux with
+[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and
+[cmake](https://cmake.org/install/) installed)*
+
+Open your preferred terminal and type:
+
+```shell
+git clone https://github.com/progsource/maddy.git
+cd maddy
+git submodule update --init --recursive
+mkdir tmp
+cd tmp
+cmake ..
+make
+make test # or run the executable in ../build/MaddyTests
+```
+
+## How to contribute
+
+There are different possibilities:
+
+* [Create a GitHub issue](https://github.com/progsource/maddy/issues/new)
+* Create a pull request with an own branch (don't forget to put yourself in the
+  AUTHORS file)

docs/definitions.md

@@ -44,13 +44,11 @@ results in
 ## Lists
 
 ### unordered
-Characters "*", "+" or "-" to make an unordered "bullet" list are equivalent.
-
 ```
 
-- unordered
+* unordered
 * list
-+ items
+* items
 
 ```
 results in
@@ -68,8 +66,8 @@ results in
   * list
   * items
     * in
-    + an
+    * an
-  - hierarchy
+  * hierarchy
 
 ```
 results in
@@ -94,26 +92,6 @@ results in
 
 ```
 
-1. ordered
-2. list
-3. items
-
-```
-
-results in
-
-```html
-
-<ol>
-  <li>ordered</li>
-  <li>list</li>
-  <li>items</li>
-</ol>
-
-```
-
-```
-
 1. ordered
 * list
 * items

include/maddy/callbackreplacer.h

@@ -1,36 +0,0 @@
-/*
- * This project is licensed under the MIT license. For more information see the
- * LICENSE file.
- */
-#pragma once
-
-#include <string>
-#include <regex>
-#include <functional>
-
-namespace maddy {
-
-inline std::string regex_callback_replacer(std::regex &regex, const std::string &input,
-                                           std::function<std::string(std::smatch &)> &callback)
-{
-  std::string result;
-  auto tagsbegin = std::sregex_iterator(input.begin(), input.end(), regex);
-  auto tagsend = std::sregex_iterator();
-  auto matchbegin = 0;
-  for(std::sregex_iterator i = tagsbegin; i != tagsend; ++i)
-  {
-    std::smatch match = *i;
-
-    auto matchlength = match.length(0);
-    auto matchpos = match.position();
-
-    result += input.substr(matchbegin, matchpos - matchbegin);
-    result += callback(match);
-    matchbegin = matchpos + matchlength;
-  }
-  result += input.substr(matchbegin);
-  return result;
-}
-
-}
-

include/maddy/italicparser.h

@@ -39,7 +39,7 @@ public:
   void
   Parse(std::string& line) override
   {
-    static std::regex re("(?!.*`.*|.*<code>.*)\\*(?!.*`.*|.*<\\/code>.*)([^\\*]*)\\*(?!.*`.*|.*<\\/code>.*)");
+    std::regex re("(?!.*`.*|.*<code>.*)\\*(?!.*`.*|.*<\\/code>.*)([^\\*]*)\\*(?!.*`.*|.*<\\/code>.*)");
     static std::string replacement = "<i>$1</i>";
     line = std::regex_replace(line, re, replacement);
   }

include/maddy/linkparser.h

@@ -10,7 +10,6 @@
 #include <regex>
 
 #include "maddy/lineparser.h"
-#include "maddy/callbackreplacer.h"
 
 // -----------------------------------------------------------------------------
 
@@ -27,16 +26,6 @@ namespace maddy {
  */
 class LinkParser : public LineParser
 {
-private:
-  std::function<std::string(std::smatch &)> callback = [](std::smatch & match){
-    std::string inner = match.str(1);
-    std::string link = match.str(2);
-    return "<a href=\"" + link + "\">" + inner + "</a>";
-  };
-
-  std::regex re = std::regex("\\[([^\\]]*)\\]\\(([^\\]]*)\\)");
-
-
 public:
   /**
    * Parse
@@ -52,12 +41,10 @@ public:
   void
   Parse(std::string& line) override
   {
-    line = regex_callback_replacer(re,line,callback);
+    static std::regex re("\\[([^\\]]*)\\]\\(([^\\]]*)\\)");
-  }
+    static std::string replacement = "<a href=\"$2\">$1</a>";
 
-  void setCallback(std::function<std::string(std::smatch &)> callback)
+    line = std::regex_replace(line, re, replacement);
-  {
-    this->callback = callback;
   }
 }; // class LinkParser
 

include/maddy/orderedlistparser.h

@@ -89,9 +89,9 @@ protected:
     bool isStartOfNewListItem = this->isStartOfNewListItem(line);
     uint32_t indentation = getIndentationWidth(line);
 
-    static std::regex orderedlineRegex("^[1-9]+[0-9]*\\. ");
+    static std::regex orderedlineRegex("^1\\. ");
     line = std::regex_replace(line, orderedlineRegex, "");
-    static std::regex unorderedlineRegex("^\\* ");
+    static std::regex unorderedlineRegex("^(\\* )");
     line = std::regex_replace(line, unorderedlineRegex, "");
 
     if (!this->isStarted)
@@ -132,7 +132,7 @@ private:
   bool
   isStartOfNewListItem(const std::string& line) const
   {
-    static std::regex re("^(?:[1-9]+[0-9]*\\. |\\* ).*");
+    static std::regex re("^(?:1\\. |\\* ).*");
     return std::regex_match(line, re);
   }
 }; // class OrderedListParser

include/maddy/parser.h

@@ -73,11 +73,11 @@ public:
    * Parse
    *
    * @method
-   * @param {const std::istream&} markdown
+   * @param {const std::stringstream&} markdown
    * @return {std::string} HTML
    */
   std::string
-  Parse(std::istream& markdown) const
+  Parse(std::stringstream& markdown) const
   {
     std::string result = "";
     std::shared_ptr<BlockParser> currentBlockParser = nullptr;
@@ -116,54 +116,6 @@ public:
     return result;
   }
 
-  void
-  setBreakLineParser(std::shared_ptr<BreakLineParser> breakLineParser)
-  {
-    this->breakLineParser = breakLineParser;
-  }
-
-  void
-  setEmphasizedParser(std::shared_ptr<EmphasizedParser> emphasizedParser)
-  {
-    this->emphasizedParser = emphasizedParser;
-  }
-
-  void
-  setImageParser(std::shared_ptr<ImageParser> imageParser)
-  {
-    this->imageParser = imageParser;
-  }
-
-  void
-  setInlineCodeParser(std::shared_ptr<InlineCodeParser> inlineCodeParser)
-  {
-    this->inlineCodeParser = inlineCodeParser;
-  }
-
-  void
-  setItalicParser(std::shared_ptr<ItalicParser> italicParser)
-  {
-    this->italicParser = italicParser;
-  }
-
-  void
-  setLinkParser(std::shared_ptr<LinkParser> linkParser)
-  {
-    this->linkParser = linkParser;
-  }
-
-  void
-  setStrikeThroughParser(std::shared_ptr<StrikeThroughParser> strikeThroughParser)
-  {
-    this->strikeThroughParser = strikeThroughParser;
-  }
-
-  void
-  setStrongParser(std::shared_ptr<StrongParser> strongParser)
-  {
-    this->strongParser = strongParser;
-  }
-
 private:
   std::shared_ptr<ParserConfig> config;
   std::shared_ptr<BreakLineParser> breakLineParser;

include/maddy/unorderedlistparser.h

@@ -54,7 +54,7 @@ public:
   static bool
   IsStartingLine(const std::string& line)
   {
-    static std::regex re("^[+*-] .*");
+    static std::regex re("^\\* .*");
     return std::regex_match(line, re);
   }
 
@@ -89,7 +89,7 @@ protected:
     bool isStartOfNewListItem = IsStartingLine(line);
     uint32_t indentation = getIndentationWidth(line);
 
-    static std::regex lineRegex("^([+*-] )");
+    static std::regex lineRegex("^(\\* )");
     line = std::regex_replace(line, lineRegex, "");
 
     if (!this->isStarted)

tests/maddy/test_maddy_orderedlistparser.cpp

@@ -96,26 +96,3 @@ TEST_F(MADDY_ORDEREDLISTPARSER, ItReplacesMarkdownWithAnHierachicalHtmlList)
 
   ASSERT_EQ(expected, outputString);
 }
-
-TEST_F(MADDY_ORDEREDLISTPARSER, ItReplacesNumberedMarkdownListWithAnHtmlOrderedList)
-{
-  std::vector<std::string> markdown = {
-    "1. a"
-    , "94. b"
-    , "103. c"
-    , ""
-  };
-  std::string expected = "<ol><li>a</li><li>b</li><li>c</li></ol>";
-
-  for (std::string md : markdown)
-  {
-    olParser->AddLine(md);
-  }
-
-  ASSERT_TRUE(olParser->IsFinished());
-
-  std::stringstream& output(olParser->GetResult());
-  const std::string& outputString = output.str();
-
-  ASSERT_EQ(expected, outputString);
-}

tests/maddy/test_maddy_unorderedlistparser.cpp

@@ -55,14 +55,9 @@ TEST_F(MADDY_UNORDEREDLISTPARSER, ItReplacesMarkdownWithAnHtmlUnorderedList)
   std::vector<std::string> markdown = {
     "* a"
     , "* b"
-	, "- c"
-	, "- d"
-	, "+ e"
-	, "+ f"
-	, "* g"
     , ""
   };
-  std::string expected = "<ul><li>a</li><li>b</li><li>c</li><li>d</li><li>e</li><li>f</li><li>g</li></ul>";
+  std::string expected = "<ul><li>a</li><li>b</li></ul>";
 
   for (std::string md : markdown)
   {
@@ -85,12 +80,9 @@ TEST_F(MADDY_UNORDEREDLISTPARSER, ItReplacesMarkdownWithAnHierachicalHtmlList)
     , "  * e"
     , "* b"
     , "  * c"
-	, "  + x"
-	, "  + y"
-	, "  - z"
     , ""
   };
-  std::string expected = "<ul><li>a<ul><li>d</li><li>e</li></ul></li><li>b<ul><li>c</li><li>x</li><li>y</li><li>z</li></ul></li></ul>";
+  std::string expected = "<ul><li>a<ul><li>d</li><li>e</li></ul></li><li>b<ul><li>c</li></ul></li></ul>";
 
   for (std::string md : markdown)
   {