ruboty 1.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 274074486378b9e899d7164d374f3e62c2e3fae2
-  data.tar.gz: 804452f1f34e007e568c4d91c5b408e76f3f57d2
+  metadata.gz: f8fa99671812ea3fb3ca4541c5e22e6a8fc1c4f0
+  data.tar.gz: 596a20f944f7506272dd1224c7a442521139476f
 SHA512:
-  metadata.gz: f11a4a22e2fd00e7d3da38b983989c55dc8da696445f22c6f5828bd2189e068ff23d880d1f504ce286ee406175219b96af054cfdbe1024117f1f46bff70bc410
-  data.tar.gz: 2f99b6f695c31c3c19e257d34fa72223cf1fb65ba8eafc899fc91cf75a4938db82ca1ac08cb551391350b65203808b8d0338ba2bc4dd6d2d340ab9a212d879ef
+  metadata.gz: a23023bdd0c46d0d7dfb70d14f676606918278d03f9d63c8956c99560a67e72679084e3fb1f91927bace84ac4a34af7aa81dcc508512639e9d9c33617495927e
+  data.tar.gz: 8c9a43f69e001eb4d91f732f8b8cfc91b2f65f5735d5c97800ce6d93fc67b65faacba9731982a45b9bd709367c8a218b387dc03ea6b3d38a7184051cc0637e15

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.2.0
+- Add DISABLE_DEFAULT_HANDLERS env
+- Get away from help message indentation
+- Support filter query on help handler (e.g. `@ruboty help ping`)
+
 ## 1.1.9
 - Support slop both version 3 and 4
 

data/README.md

@@ -16,6 +16,7 @@ Adapter hooks up your robot to chat services.
 ## Brain
 Brain persists your robot's memory.
 
+* [ruboty-leveldb](https://github.com/nownabe/ruboty-leveldb)
 * [ruboty-redis](https://github.com/r7kamura/ruboty-redis)
 
 ## Handler
@@ -32,6 +33,8 @@ Handler provides various behaviors to your robot.
 * [ruboty-syoboi_calendar](https://github.com/r7kamura/ruboty-syoboi_calendar)
 * [ruboty-talk](https://github.com/r7kamura/ruboty-talk)
 
+[Other plugins are hosted on Rubygems.](https://rubygems.org/search?utf8=%E2%9C%93&query=ruboty-)
+
 ## Configuration
 Store configuration value in envorinment variables.
 They are easy to change between deploys without changing any code.
@@ -48,11 +51,12 @@ gem "ruboty-redis"
 gem "ruboty-slack"
 ```
 
-## Environment
+## ENV
 ```
-LOG_LEVEL   - Log level for debug (default: 3)
-RUBOTY_NAME - Name to respond to mention (default: ruboty)
-RUBOTY_ENV  - Loaded gem group name (default: development)
+DISABLE_DEFAULT_HANDLERS - Pass 1 to disable default handlers (default: nil)
+LOG_LEVEL                - Log level for debug (default: 3)
+RUBOTY_ENV               - Loaded gem group name (default: development)
+RUBOTY_NAME              - Name to respond to mention (default: ruboty)
 ```
 
 ## Deploy

data/lib/ruboty.rb

@@ -55,10 +55,13 @@ require "ruboty/commands/generate"
 require "ruboty/commands/help"
 require "ruboty/commands/run"
 require "ruboty/handlers/base"
-require "ruboty/handlers/help"
-require "ruboty/handlers/ping"
-require "ruboty/handlers/whoami"
 require "ruboty/logger"
 require "ruboty/message"
 require "ruboty/robot"
 require "ruboty/version"
+
+if ENV["DISABLE_DEFAULT_HANDLERS"] != "1"
+  require "ruboty/handlers/help"
+  require "ruboty/handlers/ping"
+  require "ruboty/handlers/whoami"
+end

data/lib/ruboty/actions/help.rb

@@ -8,20 +8,22 @@ module Ruboty
       private
 
       def body
-        action_descriptions.join("\n")
+        descriptions = all_descriptions
+        if message[:filter]
+          descriptions.select! do |description|
+            description.include?(message[:filter])
+          end
+        end
+        descriptions.join("\n")
       end
 
-      def action_descriptions
-        Ruboty.actions.reject(&:hidden?).sort.map do |action|
+      def all_descriptions
+        _descriptions = Ruboty.actions.reject(&:hidden?).sort.map do |action|
           prefix = ""
           prefix << message.robot.name << " " unless  action.all?
-          "%-#{pattern_max_length + prefix.size}s - #{action.description}" % "#{prefix}#{action.pattern.inspect}"
+          "#{prefix}#{action.pattern.inspect} - #{action.description}"
         end
       end
-
-      def pattern_max_length
-        Ruboty.actions.map {|action| action.pattern.inspect }.map(&:size).max
-      end
     end
   end
 end

data/lib/ruboty/handlers/help.rb

@@ -1,7 +1,11 @@
 module Ruboty
   module Handlers
     class Help < Base
-      on(/help( me)?\z/i, name: "help", description: "Show this help message")
+      on(
+        /help( me)?(?: (?<filter>.+))?\z/i,
+        description: "Show this help message",
+        name: "help",
+      )
 
       def help(message)
         Ruboty::Actions::Help.new(message).call

data/lib/ruboty/version.rb

@@ -1,3 +1,3 @@
 module Ruboty
-  VERSION = "1.1.9"
+  VERSION = "1.2.0"
 end

data/spec/ruboty/handlers/help_spec.rb

@@ -14,28 +14,41 @@ describe Ruboty::Handlers::Help do
       "#general"
     end
 
-    let(:body) do
-      <<-EOS.strip_heredoc.strip
-        ruboty /help( me)?\\z/i - Show this help message
-        ruboty /ping\\z/i       - Return PONG to PING
-        ruboty /who am i\\?/i   - Answer who you are
-      EOS
+    context "with valid condition" do
+      let(:body) do
+        <<-EOS.strip_heredoc.strip
+          ruboty /help( me)?(?: (?<filter>.+))?\\z/i - Show this help message
+          ruboty /ping\\z/i - Return PONG to PING
+          ruboty /who am i\\?/i - Answer who you are
+        EOS
+      end
+
+      it "responds to `@ruboty help` and says each handler's description" do
+        robot.should_receive(:say).with(
+          body: body,
+          code: true,
+          from: to,
+          to: from,
+          original: {
+            body: "@ruboty help",
+            from: from,
+            robot: robot,
+            to: to,
+          },
+        )
+        robot.receive(body: "@ruboty help", from: from, to: to)
+      end
     end
 
-    it "responds to `@ruboty help` and says each handler's usage" do
-      robot.should_receive(:say).with(
-        body: body,
-        code: true,
-        from: to,
-        to: from,
-        original: {
-          body: "@ruboty help",
-          from: from,
-          robot: robot,
-          to: to,
-        },
-      )
-      robot.receive(body: "@ruboty help", from: from, to: to)
+    context "with filter" do
+      it "filters descriptions by given filter" do
+        robot.should_receive(:say).with(
+          hash_including(
+            body: "ruboty /ping\\z/i - Return PONG to PING",
+          ),
+        )
+        robot.receive(body: "@ruboty help ping", from: from, to: to)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport