cognition 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b556dd703f6cedceb65c61a882701d00470e75c
-  data.tar.gz: 7290e4591bf836a68d124e7c2655a2b10fdff48c
+  metadata.gz: f8d86f234aca4e8b72043f630090f7708e67edb2
+  data.tar.gz: 688bf3eb7f504c65735e1b9a72c2622e3d2ddeda
 SHA512:
-  metadata.gz: 46abe2f2530cc77c9e36004ff1821d9af9031a4f06107125e66687ab178014bdcc3a69b9eca8038bd2794b8e6ec7da5a5880d880ac1fe2a975da426bbb3d2825
-  data.tar.gz: d8c46b14fefa4d54e44e2afeed0f4d3eee41a50d0171296adde5540e40fdd8f083769fc424ada51a33ebd3affa965ac77002bc1b8c347c160b5e0f72308c5c73
+  metadata.gz: 8baa3a9b470d6e10b6ff86fa106fb1add6581e81b5a27b6175c144393e1602725b607b121b83481cb98777ab31187b1a3132b7f9ef27768532a9e72d18270883
+  data.tar.gz: 24ac9d126b4332d6f9a42db3b0e38fd48370de3c545f1709205072010b12ccdd83a52f2f7fd0e839524d8e110b4f0e2cde311a66db91ca339acf779067ba10f6

data/README.md

@@ -1,8 +1,8 @@
 # Cognition
 
 This is a gem that parses a message, and compares it to various matchers.
-When it finds a match, it executes an associated block of code or method,
-returning the output of whatever was run.
+When it finds the **first match**, it executes an associated block of code or
+method, returning the output of whatever was run.
 
 ## Installation
 
@@ -22,7 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-Coming Soon!
+Process your message:
+```ruby
+result = Cognition.process('command I need to process')
+```
+
+You can also include metadata with your message, like user info, or whatever:
+```ruby
+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:
+```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' }
+```
 
 ## Contributing
 

data/lib/cognition.rb

@@ -9,18 +9,15 @@ module Cognition
 
   attr_accessor :plugins, :matchers
 
-  def reset
-    @matchers = []
-    @plugins = []
-    register(Cognition::Plugins::Ping)
-  end
-
-  def register(klass)
-    return false if plugin_names.include? klass.to_s
-    plugins << klass.new
+  def process(msg, metadata = {})
+    if msg.is_a? Cognition::Message
+      process_msg(msg)
+    else
+      process_string(msg.to_s, metadata)
+    end
   end
 
-  def process_message(msg)
+  def process_msg(msg)
     response = false
     matchers.each do |matcher|
       if matcher.attempt(msg)
@@ -31,6 +28,21 @@ module Cognition
     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
+  end
+
+  def reset
+    @matchers = []
+    @plugins = []
+    register(Cognition::Plugins::Ping)
+  end
+
   def help
     "No such command:\n\n #{matchers.map(&:help).join('\n')}"
   end

data/lib/cognition/message.rb

@@ -1,6 +1,6 @@
 module Cognition
   class Message
-    attr_reader :match, :command, :metadata
+    attr_reader :command, :metadata
 
     def initialize(command, metadata = {})
       @command = command

data/lib/cognition/version.rb

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

data/test/test_cognition.rb

@@ -16,13 +16,21 @@ class CognitionTest < Minitest::Test
 
   def test_processes_messages
     msg = Cognition::Message.new('ping')
-    assert_equal 'PONG', Cognition.process_message(msg)
+    assert_equal 'PONG', Cognition.process(msg)
+  end
+
+  def test_processes_strings
+    assert_equal 'PONG', Cognition.process('ping')
+  end
+
+  def test_processes_strings_with_metadata
+    assert_equal 'PONG', Cognition.process('ping', foo: 'bar')
   end
 
   def test_shows_help_if_no_matches
     Cognition.register(Hello)
     msg = Cognition::Message.new('pong')
-    output = Cognition.process_message(msg)
+    output = Cognition.process(msg)
     assert_match 'No such command:', output
     assert_match 'ping: Returns "PONG"', output
     assert_match 'hello: Returns Hello World', output

data/test/test_message.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+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
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Anderson
@@ -74,6 +74,7 @@ files:
 - test/fixtures/hello.rb
 - test/test_cognition.rb
 - test/test_matcher.rb
+- test/test_message.rb
 - test/test_plugin.rb
 homepage: https://github.com/anoldguy/Cognition
 licenses:
@@ -103,4 +104,5 @@ test_files:
 - test/fixtures/hello.rb
 - test/test_cognition.rb
 - test/test_matcher.rb
+- test/test_message.rb
 - test/test_plugin.rb