cinch-yaml-keywords 1.0.0 → 1.1.0

data/README.md

@@ -1,3 +1,49 @@
 # Cinch YAML keywords plugin
 
 A Cinch plugin to define keywords and display description when keyword matches, keywords are saved in yaml file for persistence.
+
+## Installation
+
+First install the gem by running:
+
+```bash
+gem install cinch-yaml-keywords
+```
+
+Then load it in your bot:
+
+```ruby
+require "cinch"
+require "cinch/plugins/yamlkeywords"
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.plugins.plugins = [Cinch::Plugins::YamlKeywords]
+  end
+end
+
+bot.start
+```
+
+## Commands
+
+```irc
+!keywords                         # list all definitions
+!keyword <keyword>                # show single definition
+!keyword <keyword> <definition>   # define without spaces
+!keyword '<keyword>' <definition> # define with spaces
+!keyword "<keyword>" <definition> # define with spaces
+!forget <keyword>                 # remove definition
+<keyword>                         # display definition
+```
+
+## Example
+
+    <mpapis>: !keyword 'gist it' Please use https://gist.github.com for anything longer then 2 lines of text.
+    <user8549586> I get error 4838948: fkjfdlg
+    <mpapis>: gist it all so I can see the context
+    <smfbot>: Please use https://gist.github.com for anything longer then 2 lines of text.
+
+## Development
+
+Run the `./test-run.sh` script to play with results of your changes in channel listed in `example/config.yaml`

data/lib/cinch/plugins/yamlkeywords.rb

@@ -25,9 +25,9 @@ module Cinch
         end
       end
 
-      match(/keyword (\S+) (.+)$/,  method: :keyword_define)
-      match(/keyword '(.*)' (.+)$/, method: :keyword_define)
-      match(/keyword "(.*)" (.+)$/, method: :keyword_define)
+      match(/keyword '(.*)' (.+)$/, group: :define, method: :keyword_define)
+      match(/keyword "(.*)" (.+)$/, group: :define, method: :keyword_define)
+      match(/keyword (\S+) (.+)$/,  group: :define, method: :keyword_define)
       def keyword_define(m, keyword, definition)
         if @keywords[keyword]
           m.reply "Redefining '#{keyword}' from: '#{@keywords[keyword]}' to: '#{definition}'."
@@ -47,6 +47,17 @@ module Cinch
         end
       end
 
+      match(/forget (\S+)$/, method: :keyword_forget)
+      def keyword_forget(m, keyword)
+        if @keywords[keyword]
+          m.reply "'#{keyword}' was defined as: '#{@keywords[keyword]}'."
+          @keywords.delete(keyword)
+          update_store
+        else
+          m.reply "'#{keyword}' is not defined."
+        end
+      end
+
       listen_to :channel
       def listen(m)
         if keyword = @keywords.keys.find{|k| Regexp.new(k).match(m.message) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-yaml-keywords
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cinch