cognition 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8d86f234aca4e8b72043f630090f7708e67edb2
-  data.tar.gz: 688bf3eb7f504c65735e1b9a72c2622e3d2ddeda
+  metadata.gz: 0c351675cea9e838d9bc3af6a197ea43e204e5a4
+  data.tar.gz: 6136d88fc7e55bd093459ff2f7f9d58ceb81973f
 SHA512:
-  metadata.gz: 8baa3a9b470d6e10b6ff86fa106fb1add6581e81b5a27b6175c144393e1602725b607b121b83481cb98777ab31187b1a3132b7f9ef27768532a9e72d18270883
-  data.tar.gz: 24ac9d126b4332d6f9a42db3b0e38fd48370de3c545f1709205072010b12ccdd83a52f2f7fd0e839524d8e110b4f0e2cde311a66db91ca339acf779067ba10f6
+  metadata.gz: d4919b519fdd119a480fe0944bd95a9d95237bf3f6c9ef7cf6eb5c913934d9dd5d537767a8e710cc2c2bc10892b3f6562040384a91c01f633e8b2f51d9997a85
+  data.tar.gz: cbade8a82a96f76504c0c44d0444e8601be9ccd6533164653fa475d70ffffdfda0133ad332d50e411cdb25ba661672bfec7ffe2890f39cea359b9957331766fa

data/README.md

@@ -33,15 +33,26 @@ result = Cognition.process('another command', {user_id: 15, name: 'Bob'})
 ```
 
 Internally, `Cognition` will turn your values into a `Cognition::Message` so
-the metadata will be passed along with the message, and the keys will be made
-into methods that return the value. The raw metadata is also made available:
+the metadata will be passed along with the message, and arbitrary metadata
+is available in the #metadata Hash:
 ```ruby
 msg = Cognition::Message('another command', {user_id: 15, name: 'Bob'})
-msg.user_id    # Returns 15
-msg.name       # Returns 'Bob'
 msg.metadata   # Returns { user_id: 15, name: 'Bob' }
 ```
 
+## Creating a Plugin
+Creating plugins is easy. Subclass `Cognition::Plugins::Base` and setup your
+matches and logic that should be run:
+```ruby
+class Hello < Cognition::Plugins::Base
+  match 'hello', 'hello: Returns Hello World', :hello
+
+  def hello(*)
+    'Hello World'
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/anoldguy/cognition/fork )

data/lib/cognition/matcher.rb

@@ -21,12 +21,12 @@ module Cognition
     end
 
     def matches?(msg)
-      if trigger.is_a? String
-        return true if trigger == msg.command
-      elsif trigger.is_a? Regexp
-        return true if (@match = trigger.match msg.command)
+      case trigger
+      when String
+        trigger == msg.command
+      when Regexp
+        trigger.match msg.command
       end
-      false
     end
   end
 end

data/lib/cognition/message.rb

@@ -5,11 +5,6 @@ module Cognition
     def initialize(command, metadata = {})
       @command = command
       @metadata = metadata
-      metadata.each do |arg, value|
-        define_singleton_method arg do
-          value
-        end
-      end
     end
   end
 end

data/lib/cognition/plugins/ping.rb

@@ -1,11 +1,11 @@
 module Cognition
   module Plugins
     class Ping < Cognition::Plugins::Base
-      def pong(_msg)
+      match(/ping/i, 'ping: Returns "PONG"', :pong)
+
+      def pong(*)
         'PONG'
       end
-
-      match(/ping/i, 'ping: Returns "PONG"', :pong)
     end
   end
 end

data/lib/cognition/version.rb

@@ -1,3 +1,3 @@
 module Cognition
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/cognition.rb

@@ -10,28 +10,13 @@ module Cognition
   attr_accessor :plugins, :matchers
 
   def process(msg, metadata = {})
-    if msg.is_a? Cognition::Message
+    if msg.respond_to? :command
       process_msg(msg)
     else
       process_string(msg.to_s, metadata)
     end
   end
 
-  def process_msg(msg)
-    response = false
-    matchers.each do |matcher|
-      if matcher.attempt(msg)
-        response = matcher.response
-        break
-      end
-    end
-    response ? response : help
-  end
-
-  def process_string(message, metadata = {})
-    process_msg(Cognition::Message.new(message, metadata))
-  end
-
   def register(klass)
     return false if plugin_names.include? klass.to_s
     plugins << klass.new
@@ -43,21 +28,42 @@ module Cognition
     register(Cognition::Plugins::Ping)
   end
 
-  def help
-    "No such command:\n\n #{matchers.map(&:help).join('\n')}"
-  end
-
-  def matchers
-    plugins.collect(&:matchers).flatten.compact
-  end
-
   def plugin_names
     plugins.map { |p| p.class.name }
   end
 
-  def plugins
-    @plugins ||= []
+  def help
+    matchers.map(&:help).join('\n')
   end
+
+  private
+
+    def process_msg(msg)
+      response = false
+      matchers.each do |matcher|
+        if matcher.attempt(msg)
+          response = matcher.response
+          break
+        end
+      end
+      response ? response : not_found(msg.command)
+    end
+
+    def process_string(message, metadata = {})
+      process_msg(Cognition::Message.new(message, metadata))
+    end
+
+    def matchers
+      plugins.flat_map(&:matchers).compact
+    end
+
+    def plugins
+      @plugins ||= []
+    end
+
+    def not_found(message)
+      "No such command: #{message}\nUse 'help' for available commands!"
+    end
 end
 
 # Default plugin, responds to 'ping' with 'PONG'

data/test/fixtures/hello.rb

@@ -1,7 +1,7 @@
 class Hello < Cognition::Plugins::Base
   match 'hello', 'hello: Returns Hello World', :hello
 
-  def hello(_msg)
+  def hello(*)
     'Hello World'
   end
 end

data/test/test_cognition.rb

@@ -10,8 +10,14 @@ class CognitionTest < Minitest::Test
   def test_registers_plugins
     Cognition.register(Hello)
 
-    assert_equal 2, Cognition.plugins.count
-    assert_instance_of Hello, Cognition.plugins.last
+    assert_equal 2, Cognition.plugin_names.count
+  end
+
+  def test_does_not_register_duplicate_plugins
+    Cognition.register(Hello)
+    Cognition.register(Hello)
+
+    assert_equal 2, Cognition.plugin_names.count
   end
 
   def test_processes_messages
@@ -31,8 +37,6 @@ class CognitionTest < Minitest::Test
     Cognition.register(Hello)
     msg = Cognition::Message.new('pong')
     output = Cognition.process(msg)
-    assert_match 'No such command:', output
-    assert_match 'ping: Returns "PONG"', output
-    assert_match 'hello: Returns Hello World', output
+    assert_match "No such command: pong\nUse 'help' for available commands!", output
   end
 end

data/test/test_message.rb

@@ -4,7 +4,7 @@ require 'cognition'
 class CognitionTest < Minitest::Test
   def test_sets_metadata
     msg = Cognition::Message.new('test', user_id: 15, foo: 'bar')
-    assert_equal 15, msg.user_id
-    assert_equal 'bar', msg.foo
+    assert_equal 15, msg.metadata[:user_id]
+    assert_equal 'bar', msg.metadata[:foo]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler