Add output option to adapter/out, and update document strings.

liquidz · May 7, 2015 · 5c7e255 · 5c7e255
1 parent fbfb435
commit 5c7e255
Show file tree

Hide file tree

Showing 12 changed files with 101 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ Handler is a function to process user input.
   (if (= "ping" text) "pong"))
 ```
  * Arguments
-  * `:username`: User name
+  * `:user`: User name
   * `:text`: Input string.
   * `:to`: Address username.
   * `:message-for-me?`: Is inputted message addredded to bot or not.

diff --git a/dev/dev.clj b/dev/dev.clj
@@ -20,6 +20,11 @@
       #"^set (.+?) (.+?)$" (fn [{[_ k v] :match}] (jb/set k v))
       #"^get (.+?)$"       (fn [{[_ k]   :match}] (jb/get k)))))
 
+(defn hear-handler
+  [{:keys [text user]}]
+  (when (re-find #"hello" text)
+    (ja/out (str "hello " user) :as "world")))
+
 ;(def dev-schedule
 ;  (js/schedules
 ;    "/5 * * * * * *" #(str "Hey!")))

diff --git a/doc/api/jubot.adapter.html b/doc/api/jubot.adapter.html
@@ -3,14 +3,17 @@
 </pre></div><div class="public anchor" id="var-create-adapter"><h3>create-adapter</h3><div class="usage"><code>(create-adapter {:keys [adapter], :as config-option})</code></div><div class="doc"><pre class="plaintext">Create the specified adapter.
 
 Params
-  :adapter - a adapter name
+  config-option
+    :adapter - A adapter name.
 Return
-  adapter component
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter.clj#L8">view source</a></div></div><div class="public anchor" id="var-out"><h3>out</h3><div class="usage"><code>(out s)</code></div><div class="doc"><pre class="plaintext">Call output function in system adapter.
+  Adapter component.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter.clj#L8">view source</a></div></div><div class="public anchor" id="var-out"><h3>out</h3><div class="usage"><code>(out s &amp; option)</code></div><div class="doc"><pre class="plaintext">Call output function in system adapter.
 Before using this function, jubot.system should be started.
 
 Params
-  s - a message string
+  s      - A message string.
+  option - Output option map.
+           See REPL or Slack adapter documents.
 Return
-  nil
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter.clj#L21">view source</a></div></div></div></body></html>
+  nil.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter.clj#L22">view source</a></div></div></div></body></html>
diff --git a/doc/api/jubot.adapter.repl.html b/doc/api/jubot.adapter.repl.html
@@ -1,18 +1,21 @@
 <!DOCTYPE html>
 <html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>jubot.adapter.repl documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Jubot 0.1.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jubot</span></div></div></li><li class="depth-2"><a href="jubot.adapter.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adapter</span></div></a></li><li class="depth-3 branch current"><a href="jubot.adapter.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li><li class="depth-3 branch"><a href="jubot.adapter.slack.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>slack</span></div></a></li><li class="depth-3"><a href="jubot.adapter.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-2"><a href="jubot.brain.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>brain</span></div></a></li><li class="depth-3 branch"><a href="jubot.brain.memory.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>memory</span></div></a></li><li class="depth-3"><a href="jubot.brain.redis.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>redis</span></div></a></li><li class="depth-2 branch"><a href="jubot.core.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="jubot.handler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-2 branch"><a href="jubot.redef.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>redef</span></div></a></li><li class="depth-2 branch"><a href="jubot.require.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>require</span></div></a></li><li class="depth-2"><a href="jubot.scheduler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scheduler</span></div></a></li><li class="depth-3"><a href="jubot.scheduler.keep-awake.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>keep-awake</span></div></a></li><li class="depth-2 branch"><a href="jubot.system.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>system</span></div></a></li><li class="depth-2"><a href="jubot.test.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>test</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="jubot.adapter.repl.html#var--.3EReplAdapter"><div class="inner"><span>-&gt;ReplAdapter</span></div></a></li><li class="depth-1"><a href="jubot.adapter.repl.html#var-map-.3EReplAdapter"><div class="inner"><span>map-&gt;ReplAdapter</span></div></a></li><li class="depth-1"><a href="jubot.adapter.repl.html#var-process-input"><div class="inner"><span>process-input</span></div></a></li><li class="depth-1"><a href="jubot.adapter.repl.html#var-process-output"><div class="inner"><span>process-output</span></div></a></li><li class="depth-1"><a href="jubot.adapter.repl.html#var-username"><div class="inner"><span>username</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">jubot.adapter.repl</h2><div class="doc"><pre class="plaintext">Jubot adapter for REPL.
 </pre></div><div class="public anchor" id="var--.3EReplAdapter"><h3>-&gt;ReplAdapter</h3><div class="usage"><code>(-&gt;ReplAdapter name handler in out)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class jubot.adapter.repl.ReplAdapter.
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L38">view source</a></div></div><div class="public anchor" id="var-map-.3EReplAdapter"><h3>map-&gt;ReplAdapter</h3><div class="usage"><code>(map-&gt;ReplAdapter m__5869__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class jubot.adapter.repl.ReplAdapter, taking a map of keywords to field values.
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L38">view source</a></div></div><div class="public anchor" id="var-process-input"><h3>process-input</h3><div class="usage"><code>(process-input {:keys [name handler], :as this} s)</code></div><div class="doc"><pre class="plaintext">Process input from REPL.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L42">view source</a></div></div><div class="public anchor" id="var-map-.3EReplAdapter"><h3>map-&gt;ReplAdapter</h3><div class="usage"><code>(map-&gt;ReplAdapter m__5869__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class jubot.adapter.repl.ReplAdapter, taking a map of keywords to field values.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L42">view source</a></div></div><div class="public anchor" id="var-process-input"><h3>process-input</h3><div class="usage"><code>(process-input {:keys [name handler], :as this} s)</code></div><div class="doc"><pre class="plaintext">Process input from REPL.
 
 Params
   this       - REPL adapter.
     :name    - Bot&apos;s name.
     :handler - A handler function.
   s          - Input text from REPL.
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L21">view source</a></div></div><div class="public anchor" id="var-process-output"><h3>process-output</h3><div class="usage"><code>(process-output {:keys [name]} s)</code></div><div class="doc"><pre class="plaintext">Process output to REPL.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L25">view source</a></div></div><div class="public anchor" id="var-process-output"><h3>process-output</h3><div class="usage"><code>(process-output this s &amp; {:keys [as], :as option})</code></div><div class="doc"><pre class="plaintext">Process output to REPL.
 
 Params
-  :name - Bot&apos;s name.
-  s     - Output text to REPL.
-</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L11">view source</a></div></div><div class="public anchor" id="var-username"><h3>username</h3><div class="usage"></div><div class="doc"><pre class="plaintext">User name. (default is &quot;nobody&quot;)
+  this    - REPL adapter.
+    :name - Bot&apos;s name.
+  s       - Output text to REPL.
+  option
+    :as   - Overwrite bot&apos;s name if you specify this option.
+</pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L11">view source</a></div></div><div class="public anchor" id="var-username"><h3>username</h3><div class="usage"></div><div class="doc"><pre class="plaintext">User name. (default value is &quot;nobody&quot;)
 </pre></div><div class="src-link"><a href="http://github.com/liquidz/jubot/blob/master/src/jubot/adapter/repl.clj#L8">view source</a></div></div></div></body></html>