From 4bb65c50a2a85404af6d122acc53b6fb1739652b Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sun, 30 Jul 2017 16:45:59 +0200
Subject: Transform regex match into the beginning of a plugin architecture

Take our initial experiment on the regex matcher from before and expand
it into the beginnings of a plugin architecture.

Add a new `Plugin` module. This exports a `Plugin` data type that
collects a regex and a function together. The idea will be to create a
list of plugins, and chat messages will get matched against the regexes
in that list. If the regex matches, the associated function will be run.
If the function produces output, that output should eventually be sent
back to the chat as a message.

Implemented `Show` on `Plugin` manually because the `String -> String`
function can't be derived. Decided to forego that part in the output and
only show the regex when printing.

Ended up with a little redundancy here in the functions for matching
plugins. The `realMatchPlugin` function needs to be renamed, just called
it that for now because I had started with `matchPlugin`, and only later
realised that its interface wasn't what I needed when calling it from
the `Lib` module.

Need to add some doc comments, but figured I'd commit what I have now
since it sort of works.

The `firstPlugin` function is only used by `matchPlugin`, so now I
realise it should probably be a local `where`-defined function.

Also thought the `String -> String` wasn't very descriptive. We'll want
to make a type alias for that that tells people this is a plugin
function.

Added a test plugin inline in this file for now. Eventually our plugins
should be stored in separate files in a "Plugins" directory (or
"Plugin", depending on how the module system works, will have to look
into that). For now, the program outputs the correct string created by
`gitHubCommitAction`, which is actually pretty cool. It's not actually
the really correct string, as the `match` variable is the regex instead
of the matched part of the test string, but close enough for now. We'll
go back and correct that momentarily.

Needed to add `Plugin` to the `exposed-modules` section in the `library`
build metadata in order to properly build the code. Was getting this
error about it:

    Warning: The following modules should be added to exposed-modules or other-modules in /Users/tw/Documents/Development/sorbot/sorbot/sorbot.cabal:
        - In the library component:
            Plugin

    Missing modules in the cabal file are likely to cause undefined reference errors from the linker, along with other problems.

Really liking this so far!
---
 sorbot.cabal | 1 +
 1 file changed, 1 insertion(+)

(limited to 'sorbot.cabal')

diff --git a/sorbot.cabal b/sorbot.cabal
index 758fdc5..49c21fa 100644
--- a/sorbot.cabal
+++ b/sorbot.cabal
@@ -16,6 +16,7 @@ cabal-version:       >=1.10
 library
   hs-source-dirs:      src
   exposed-modules:     Lib
+                     , Plugin
   build-depends:       base >= 4.7 && < 5
                      , regex-tdfa
   default-language:    Haskell2010
-- 
cgit v1.2.3