ruboty-help_query 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9d64c210a295a62c8ab58fb752a2e5112db8f55
+  data.tar.gz: 4c12fd8389a3f72f2f777e5d503715c539c19ec8
+SHA512:
+  metadata.gz: 40d33681c5b44b76a84a3d18576ce7b5f568509994ab0c31dfd67d8087343c2d729785260ad117f32b8719eafd08176354c20e2558db468543594b6a9074183b
+  data.tar.gz: 2d27183bb1efad5abc8082432c300e5bbaa46eaa4745380e1f4951eedc405b71966b08b4eeb1b926b3766c98b2502ed61a244c7f8b0678427c9ad0157c8fdd03

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/FormatString:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+rvm:
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruboty-help_query.gemspec
+gemspec
+gem 'simplecov', '~> 0.8.2'
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tbpgr
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Ruboty::HelpQuery
+
+An Ruboty Handler + Actions to show all help commands that match <query>.
+
+[![Build Status](https://travis-ci.org/tbpgr/ruboty-help_query.png?branch=master)](https://travis-ci.org/tbpgr/ruboty-help_query)
+[![Coverage Status](https://coveralls.io/repos/tbpgr/ruboty-help_query/badge.png)](https://coveralls.io/r/tbpgr/ruboty-help_query)
+
+[Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-help_query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruboty-help_query
+
+
+## Commands
+
+|Command|Pattern|Description|
+|:--|:--|:--|
+|help|/help *(?<query>.*)\z/|Show all help commands that match <query>.|
+
+## Usage
+### help
+* Show all help commands that match <query>.
+
+~~~
+>ruboty help ping
+>ruboty /ping\\z/i       - Return PONG to PING
+>
+>ruboty help .*p.*
+>ruboty /help( me)?\\z/i - Show this help message
+>ruboty /ping\\z/i       - Return PONG to PING
+~~~
+
+## ENV
+
+|Name|Description|
+|:--|:--|
+|--|--|
+
+## Dependency
+
+|Name|Description|
+|:--|:--|
+|--|--|
+
+## Contributing
+
+1. Fork it ( https://github.com/tbpgr/ruboty-help_query/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+task default: [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end

data/lib/ruboty/handlers/help_query.rb

@@ -0,0 +1,18 @@
+require 'ruboty/help_query/actions/help'
+
+module Ruboty
+  module Handlers
+    # HelpQuery
+    class HelpQuery < Base
+      on(
+        /help\s*(?<query>.*)\z/,
+        name: 'help',
+        description: 'Show all help commands that match <query>.'
+      )
+
+      def help(message)
+        Ruboty::HelpQuery::Actions::Help.new(message).call
+      end
+    end
+  end
+end

data/lib/ruboty/help_query/actions/help.rb

@@ -0,0 +1,35 @@
+# rubocop:disable LineLength, MethodLength
+module Ruboty
+  module HelpQuery
+    module Actions
+      # Help
+      class Help < Ruboty::Actions::Base
+        def call
+          message.reply(help)
+        end
+
+        private
+
+        def help
+          Ruboty.actions.reject(&:hidden?)
+                        .select { |action|action.pattern.to_s =~ /#{message[:query]}/ }
+                        .sort
+                        .map do |action|
+            prefix = ''
+            prefix << message.robot.name << ' ' unless  action.all?
+            pattern_format = "%-#{pattern_max_length + prefix.size}s"
+            pattern_text = "#{prefix}#{action.pattern.inspect}"
+            "#{pattern_format} - #{action.description}" % pattern_text
+          end.join("\n")
+        rescue => e
+          "Error: #{e.message}"
+        end
+
+        def pattern_max_length
+          Ruboty.actions.map { |action| action.pattern.inspect }.map(&:size).max
+        end
+      end
+    end
+  end
+end
+# rubocop:enable LineLength, MethodLength

data/lib/ruboty/help_query/version.rb

@@ -0,0 +1,6 @@
+module Ruboty
+  # HelpQuery
+  module HelpQuery
+    VERSION = '1.0.0'
+  end
+end

data/lib/ruboty/help_query.rb

@@ -0,0 +1,10 @@
+require 'ruboty'
+require 'ruboty/help_query/version'
+require 'ruboty/handlers/help_query'
+
+module Ruboty
+  # HelpQuery
+  module HelpQuery
+    # Your code goes here...
+  end
+end

data/ruboty-help_query.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruboty/help_query/version'
+
+# rubocop:disable LineLength
+Gem::Specification.new do |spec|
+  spec.name          = 'ruboty-help_query'
+  spec.version       = Ruboty::HelpQuery::VERSION
+  spec.authors       = ['tbpgr']
+  spec.email         = ['tbpgr@tbpgr.jp']
+  spec.summary       = 'An Ruboty Handler + Actions to show all help commands that match <query>.'
+  spec.description   = 'An Ruboty Handler + Actions to show all help commands that match <query>.'
+  spec.homepage      = 'https://github.com/tbpgr/ruboty-help_query'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ruboty'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end
+# rubocop:enable LineLength

data/spec/ruboty/handlers/help_query_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'ruboty/handlers/help_query'
+require 'ruboty/help_query/actions/help'
+
+# rubocop:disable LineLength, UnusedMethodArgument
+describe Ruboty::Handlers::HelpQuery do
+  context :help do
+    let(:robot) do
+      Ruboty::Robot.new
+    end
+
+    let(:help) do
+      Ruboty::HelpQuery::Actions::Help
+    end
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'exist id case',
+        body: 'ruboty help *p*',
+        expected: 'expected message',
+        hit: true
+      },
+      {
+        case_no: 2,
+        case_title: 'not hit message case',
+        body: 'ruboty nothit *p*',
+        expected: 'expected message',
+        hit: false
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          allow_any_instance_of(help).to receive(:help).and_return(c[:expected])
+
+          # -- then --
+          if c[:hit]
+            Ruboty.logger.should_receive(:info).with(c[:expected])
+          else
+            Ruboty.logger.should_not_receive(:info)
+          end
+
+          # -- when --
+          robot.receive(body: c[:body], from: 'sender', to: 'channel')
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(_c)
+        # implement each case before
+      end
+
+      def case_after(_c)
+        # implement each case after
+      end
+    end
+  end
+end
+# rubocop:enable LineLength, UnusedMethodArgument

data/spec/ruboty/help_query/actions/help_spec.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'ruboty'
+require 'ruboty/help_query/actions/help'
+
+# rubocop:disable LineLength, UnusedMethodArgument
+describe Ruboty::HelpQuery::Actions::Help do
+  context :help do
+    let(:message) do
+      # Dummy Robot
+      class Robot
+        attr_accessor :name
+        def initialize(name)
+          @name = name
+        end
+      end
+      # Dummy Message
+      class Message < Hash
+        def robot
+          Robot.new('robot')
+        end
+
+        def reply(message)
+          message
+        end
+      end
+      Message.new
+    end
+
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'exist user case',
+        query: '.*p.*',
+        expected: <<-EOS
+robot /help\\s*(?<query>.*)\\z/ - Show all help commands that match <query>.
+robot /help( me)?\\z/i         - Show this help message
+robot /ping\\z/i               - Return PONG to PING
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'not exist user case',
+        query: 'ping',
+        expected: <<-EOS
+robot /ping\\z/i               - Return PONG to PING
+        EOS
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          message.robot.name = 'sample'
+          message[:query] = c[:query]
+          action = Ruboty::HelpQuery::Actions::Help.new(message)
+
+          # -- when --
+          actual = action.send(:help)
+
+          # -- then --
+          expect(actual).to eq(c[:expected].chomp)
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(_c)
+        # implement each case before
+      end
+
+      def case_after(_c)
+        # implement each case after
+      end
+    end
+  end
+end
+# rubocop:enable LineLength, UnusedMethodArgument

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+end
+require 'ruboty/help_query'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ruboty-help_query
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- tbpgr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruboty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An Ruboty Handler + Actions to show all help commands that match <query>.
+email:
+- tbpgr@tbpgr.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruboty/handlers/help_query.rb
+- lib/ruboty/help_query.rb
+- lib/ruboty/help_query/actions/help.rb
+- lib/ruboty/help_query/version.rb
+- ruboty-help_query.gemspec
+- spec/ruboty/handlers/help_query_spec.rb
+- spec/ruboty/help_query/actions/help_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tbpgr/ruboty-help_query
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: An Ruboty Handler + Actions to show all help commands that match <query>.
+test_files:
+- spec/ruboty/handlers/help_query_spec.rb
+- spec/ruboty/help_query/actions/help_spec.rb
+- spec/spec_helper.rb