cognition 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3da7685b2dd87abbbb4700e49844520a5cc78e69
-  data.tar.gz: 16ed1c2b9b0b02544e322e65c245b1befcd62821
+  metadata.gz: 2f4da3fb15fa2cf643a7e989c81e5467cd35284d
+  data.tar.gz: 9c440ceee3f1cca18f71c0485a57723248e3f139
 SHA512:
-  metadata.gz: 276a3ef0f303cc54354a69be7b7a541d2e8e6e54a5abd7fd742538d64d5dc4fa5518b364685560c071f0116f18478dfa953cb8a34e1c06f37fe2ebfdb4ebec7a
-  data.tar.gz: eb2379fee7ea23e0f4de7a9f0f0c2ffd05378efa9a5599aba5e262987f65c4e3fc85998c387379c5846c0ca24ec6893c5177162ec1b10e3c934180a801fddb65
+  metadata.gz: 866e3d8727d945165488ed69e611ca84f1063acab94061464d5c28b41087f445a33f0d1ce3f927ba7a6cf13e6d2515668cd67179fcdef87649144ca83cadd5d2
+  data.tar.gz: 47be6d5c494c3db31744c47b72848e9b00f70fa470a8d82c2f7d57ad32255f9cd17a21cfc3aa50d099349a607aa07c97dbf1bcaf2c798bd03e792eaf7425f999

data/README.md

@@ -94,6 +94,46 @@ bot.process("hello")       # "Hello World"
 bot.process("hello foo")   # "Hello foo"
 ```
 
+### Rendering templates
+Templates are opt-in right now, you need to call `render` yourself, and it
+will return a string with the rendered contents of a template. What template,
+you ask? The default for `/path/to/hello.rb` will look for a templates in
+`/path/to/hello/views/`.
+
+Given the following plugin:
+```ruby
+class Hello < Cognition::Plugins::Base
+  # ...snipped
+
+  def hello(*)
+    render
+  end
+
+  def hi(*)
+    render(template: "/path/to/template.html.erb")
+  end
+
+  def hey(*)
+    render(type: "text", extension: "haml")
+  end
+end
+```
+
+  1. The `hello` method will look for `/path/to/hello/views/hello.html.erb`
+  2. The `hi` method will look for `/path/to/template.html.erb`
+  3. The `hey` method will look for `/path/to/hello/views/hey.text.haml`
+
+Setting instance variables or passing locals is up to the plugin creator.
+The `render` method takes a hash with the following keys:
+```ruby
+{
+  template: "full/path/to/template/file", # FULL path to template file
+  type: "type of response"                # text, html, json, etc...
+  extension: "engine file extension"      # erb, haml, etc...
+  locals: {x: "foo", y: "bar"}            # local variables, access as x & y
+}
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/anoldguy/cognition/fork )

data/cognition.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.8.1"
+  spec.add_dependency "httparty", "~> 0.8"
+  spec.add_dependency "tilt", "~> 1.4"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0.0"
-  spec.add_development_dependency "webmock", "~> 1.20.4"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "haml", "~> 4.0"
 end

data/lib/cognition/plugins/base.rb

@@ -1,6 +1,27 @@
+require 'erb'
+require 'tilt'
+
 module Cognition
   module Plugins
+    class PluginTemplateNotFound < StandardError; end
+
     class Base
+      class <<self
+        attr_accessor :view_root
+      end
+
+      RENDER_DEFAULTS = {
+        type: "html",
+        extension: "erb"
+      }
+
+      # Inherited callback to set a class-level instance variable on the
+      # subclass, since we can't use __FILE__ here, and have it use the
+      # subclass's location.
+      def self.inherited(plugin)
+        plugin.view_root = File.dirname(caller[0].split(':',2).first)
+      end
+
       attr_accessor :matchers, :bot
 
       def initialize(bot = nil)
@@ -17,6 +38,35 @@ module Cognition
       def self.definitions
         @definitions ||= []
       end
+
+      def render(opts = {})
+        options = RENDER_DEFAULTS.merge(opts)
+        calling_method = caller[0][/`([^']*)'/, 1]
+        template = options[:template] || template_file(calling_method, options[:type], options[:extension])
+        Tilt.new(template).render(self, options[:locals])
+      rescue Errno::ENOENT => e
+        raise PluginTemplateNotFound, e
+      end
+
+      private
+
+        def template_file(name, type, extension)
+          # Defaults to html ERB for now. Override when calling #render(path_to_file)
+          File.join(templates_path, "#{name}.#{type}.#{extension}")
+        end
+
+        def underscore(string)
+          word = string.to_s.gsub(/::/, '/')
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+
+        def templates_path
+          File.expand_path("#{underscore(self.class.name)}/views", self.class.view_root)
+        end
     end
   end
 end

data/lib/cognition/plugins/cognition/plugins/default/views/help.html.erb

@@ -0,0 +1,7 @@
+<table>
+<% @help.each do |text| %>
+  <tr>
+    <td><%= text %></td>
+  </tr>
+<% end %>
+</table>

data/lib/cognition/plugins/cognition/plugins/default/views/help.text.erb

@@ -0,0 +1 @@
+<%= @help.join("\n") %>

data/lib/cognition/plugins/default.rb

@@ -15,11 +15,14 @@ module Cognition
       end
 
       def help(msg, match_data = nil)
+        type = msg.metadata[:type] ||= "text"
         if match_data['command'].empty?
-          bot.help.join("\n")
+          @help = bot.help
         else
-          bot.help.find_all { |text| text.match match_data[:command] }.join("\n")
+          @help = bot.help.find_all { |text| text.match match_data[:command] }
+
         end
+        render(type: type)
       end
     end
   end

data/lib/cognition/version.rb

@@ -1,3 +1,3 @@
 module Cognition
-  VERSION = "2.0.0"
+  VERSION = "2.0.2"
 end

data/test/fixtures/hello/views/bonjour.text.erb

@@ -0,0 +1 @@
+<%= @message %> is french!

data/test/fixtures/hello/views/hey.html.haml

@@ -0,0 +1 @@
+%h1= @message

data/test/fixtures/hello/views/hi.html.erb

@@ -0,0 +1 @@
+<%= @message %> from a default template!

data/test/fixtures/hello/views/hola.haml

@@ -0,0 +1 @@
+%h1= @message

data/test/fixtures/hello/views/yo.html.erb

@@ -0,0 +1,3 @@
+<% num_yos.times do %>
+<p><%= @message %></p>
+<% end %>

data/test/fixtures/hello.rb

@@ -1,3 +1,4 @@
+require 'haml'
 class Hello < Cognition::Plugins::Base
   match 'hello', :hello, help: {
     'hello' => 'Returns Hello World'
@@ -6,4 +7,29 @@ class Hello < Cognition::Plugins::Base
   def hello(msg, match_data = nil)
     'Hello World'
   end
+
+  def hi(msg, match_data = nil)
+    @message = 'Hi'
+    render
+  end
+
+  def hola(msg, match_data = nil)
+    @message = 'Hola'
+    render(template: File.expand_path('../hello/views/hola.haml', __FILE__))
+  end
+
+  def bonjour(msg, match_data = nil)
+    @message = 'Bonjour'
+    render(type: "text")
+  end
+
+  def hey(msg, match_data = nil)
+    @message = 'Hey'
+    render(extension: "haml")
+  end
+
+  def yo(msg, match_data = nil)
+    @message = 'Yo'
+    render(locals: {num_yos: 3})
+  end
 end

data/test/test_plugin.rb

@@ -2,11 +2,38 @@ require 'minitest/autorun'
 require 'cognition'
 
 class PluginTest < Minitest::Test
-  def test_sets_matchers
+  def setup
     require_relative "fixtures/hello"
     bot = Cognition::Bot.new
-    hello = Hello.new(bot)
+    @hello = Hello.new(bot)
+  end
+
+  def test_sets_matchers
+    assert_equal 1, @hello.matchers.count
+  end
+
+  def test_renders_default_template
+    assert_equal "Hi from a default template!\n", @hello.hi("foo")
+  end
+
+  def test_renders_passed_template
+    assert_equal "<h1>Hola</h1>\n", @hello.hola("foo")
+  end
+
+  def test_renders_specified_type
+    assert_equal "Bonjour is french!\n", @hello.bonjour("foo")
+  end
+
+  def test_renders_specified_extension
+    assert_equal "<h1>Hey</h1>\n", @hello.hey("foo")
+  end
+
+  def test_renders_with_locals
+    assert_equal "<p>Yo</p>\n<p>Yo</p>\n<p>Yo</p>\n", @hello.yo("foo")
+  end
 
-    assert_equal 1, hello.matchers.count
+  def test_multiple_render_calls
+    assert_equal "<p>Yo</p>\n<p>Yo</p>\n<p>Yo</p>\n", @hello.yo("foo")
+    assert_equal "<h1>Hey</h1>\n", @hello.hey("foo")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Nathan Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: '4.0'
 description: Match text; run commands. Works great for building a chatbot!
 email:
 - andnat@gmail.com
@@ -98,10 +126,17 @@ files:
 - lib/cognition/matcher.rb
 - lib/cognition/message.rb
 - lib/cognition/plugins/base.rb
+- lib/cognition/plugins/cognition/plugins/default/views/help.html.erb
+- lib/cognition/plugins/cognition/plugins/default/views/help.text.erb
 - lib/cognition/plugins/default.rb
 - lib/cognition/responder.rb
 - lib/cognition/version.rb
 - test/fixtures/hello.rb
+- test/fixtures/hello/views/bonjour.text.erb
+- test/fixtures/hello/views/hey.html.haml
+- test/fixtures/hello/views/hi.html.erb
+- test/fixtures/hello/views/hola.haml
+- test/fixtures/hello/views/yo.html.erb
 - test/test_cognition.rb
 - test/test_default_plugin.rb
 - test/test_helper.rb
@@ -135,6 +170,11 @@ specification_version: 4
 summary: A rules engine for running commands.
 test_files:
 - test/fixtures/hello.rb
+- test/fixtures/hello/views/bonjour.text.erb
+- test/fixtures/hello/views/hey.html.haml
+- test/fixtures/hello/views/hi.html.erb
+- test/fixtures/hello/views/hola.haml
+- test/fixtures/hello/views/yo.html.erb
 - test/test_cognition.rb
 - test/test_default_plugin.rb
 - test/test_helper.rb