lita 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffbba6c703174e7a6984339b41e1b6b3ce01e617
-  data.tar.gz: 5d30f8db3d352fd2dacf9e3fb752d434ab6230d4
+  metadata.gz: 413787eadeaaa5e58440f591d404423c90e7b95d
+  data.tar.gz: 4114e0ac515a2068a361e4f6fdfcd0103ed27e8a
 SHA512:
-  metadata.gz: e5d699a894adf21dd032822f4b3e03b1271e4f49d1330abe1cef0a99d4af9f710aa2934277474ae6a72700b16fc48abee34777f6ca9bec34fc19a7fb6c421009
-  data.tar.gz: 62e5a1586f950a4385d40c0cab802d7e9eef5dd07900657ef8640dc59ad9c4a9a3972b402c327f6cff2c83be9ad933ce2f4adc7ef4a5699093fb3b9ffcb2870d
+  metadata.gz: 58c0d8117141c1809f73422a581bc7a11693eca37f02234abddb913fc70ce631a5026320a4fdfc09f1ec772eb0501301c656fcf750d7a35a23e85415b7ce8d8d
+  data.tar.gz: bfb5bc4df0cc27e9d242e30beca7e6ae7683f3655dc29dc7ed575fde39c40e62a0a6b3b84746c826fdf5b48e65e5b1de3ac09fe9bc5ba19eb6e48d4bd23ad108

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea
+

data/README.md

@@ -20,6 +20,7 @@ Automate your business and have fun with your very own robot companion.
 * Support for outgoing HTTP requests
 * Group-based authorization
 * Configurable logging
+* Generators for creating new plugins
 
 ## Why?
 
@@ -137,6 +138,8 @@ Lita ships with one adapter for use directly in the shell. Simply type text at t
 
 An adapter is a packaged as a RubyGem. The adapter is a class that inherits from `Lita::Adapter`, implements a few required methods, and is registered by calling `Lita.register_adapter(:symbol_that_identifies_the_adapter, TheAdapterClass)`.
 
+To generate a starting template for a new adapter gem, run `lita adapter NAME`, where NAME is the name of the new gem.
+
 ### Example
 
 Here is a bare bones example of an adapter for the fictious chat service, FancyChat.
@@ -180,6 +183,8 @@ For more detailed examples, check out the built in shell adapter, [lita-hipchat]
 
 A handler is packaged as a RubyGem. A handler is a class that inherits from `Lita::Handler` and is registered by calling `Lita.register_handler(TheHandlerClass)`. There are two components to a handler: route definitions, and the methods that implement those routes. There are both chat routes and HTTP routes available to handlers.
 
+To generate a starting template for a new handler gem, run `lita handler NAME`, where NAME is the name of the new gem.
+
 ### Chat routes
 
 To define a route, use the class method `route`:

data/lib/lita.rb

@@ -1,5 +1,6 @@
 require "forwardable"
 require "logger"
+require "rbconfig"
 require "set"
 require "shellwords"
 

data/lib/lita/adapters/shell.rb

@@ -12,9 +12,14 @@ module Lita
 
         loop do
           print "#{robot.name} > "
-          input = $stdin.gets.chomp.strip
+          input = $stdin.gets
+          if input.nil?
+            puts
+            break
+          end
+          input = input.chomp.strip
           break if input == "exit" || input == "quit"
-          robot.receive(build_message(robot, input, source))
+          robot.receive(build_message(input, source))
         end
       end
 
@@ -24,6 +29,11 @@ module Lita
       # @param strings [Array<String>] An array of strings to output.
       # @return [void]
       def send_messages(target, strings)
+        strings = Array(strings)
+        strings.reject! { |string| string.empty? }
+        unless RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ || !$stdout.tty?
+          strings.map! { |string| "\e[32m#{string}\e[0m" }
+        end
         puts strings
       end
 
@@ -35,7 +45,7 @@ module Lita
 
       private
 
-      def build_message(robot, input, source)
+      def build_message(input, source)
         message = Message.new(robot, input, source)
         message.command! if Lita.config.adapter.private_chat
         message

data/lib/lita/cli.rb

@@ -1,6 +1,7 @@
 require "thor"
 
 require "lita/daemon"
+require "lita/version"
 
 module Lita
   # The command line interface for Lita.
@@ -8,46 +9,50 @@ module Lita
     include Thor::Actions
 
     def self.source_root
-      File.expand_path("../../..", __FILE__)
+      File.expand_path("../../../templates", __FILE__)
     end
 
     default_task :start
 
-    class_option :config,
+    desc "start", "Starts Lita"
+    option :config,
       aliases: "-c",
       banner: "PATH",
       default: File.expand_path("lita_config.rb", Dir.pwd),
       desc: "Path to the configuration file to use"
-
-    class_option :daemonize,
+    option :daemonize,
       aliases: "-d",
       default: false,
       desc: "Run Lita as a daemon",
       type: :boolean
-
-    class_option :log_file,
+    option :log_file,
       aliases: "-l",
       banner: "PATH",
       default: Process.euid == 0 ?
         "/var/log/lita.log" : File.expand_path("lita.log", ENV["HOME"]),
       desc: "Path where the log file should be written when daemonized"
-
-    class_option :pid_file,
+    option :pid_file,
       aliases: "-p",
       banner: "PATH",
       default: Process.euid == 0 ?
         "/var/run/lita.pid" : File.expand_path("lita.pid", ENV["HOME"]),
       desc: "Path where the PID file should be written when daemonized"
-
-    class_option :kill,
+    option :kill,
       aliases: "-k",
       default: false,
       desc: "Kill existing Lita processes when starting the daemon",
       type: :boolean
-
-    desc "start", "Starts Lita"
     def start
-      Bundler.require
+      begin
+        Bundler.require
+      rescue Bundler::GemfileNotFound
+        no_gemfile_warning = <<-WARN.chomp
+The default command "start" must be run inside a Lita project. Try running \
+`lita new` to generate a new Lita project or `lita help` to see all commands.
+WARN
+        say no_gemfile_warning, :red
+        abort
+      end
 
       if options[:daemonize]
         Daemon.new(
@@ -62,7 +67,108 @@ module Lita
 
     desc "new NAME", "Generates a new Lita project (default name: lita)"
     def new(name = "lita")
-      directory "skeleton", name
+      directory "robot", name
+    end
+
+    desc "adapter NAME", "Generates a new Lita adapter"
+    def adapter(name)
+      generate_templates(generate_config(name, "adapter"))
+    end
+
+    desc "handler NAME", "Generates a new Lita handler"
+    def handler(name)
+      generate_templates(generate_config(name, "handler"))
+    end
+
+    desc "version", "Outputs the current version of Lita"
+    def version
+      puts VERSION
+    end
+    map %w(-v --version) => :version
+
+    private
+
+    def generate_config(name, plugin_type)
+      name, gem_name = normalize_names(name)
+      constant_name = name.split(/_/).map { |p| p.capitalize }.join
+      namespace = "#{plugin_type}s"
+      constant_namespace = namespace.capitalize
+      spec_type = plugin_type == "handler" ? "lita_handler" : "lita"
+      required_lita_version = Lita::VERSION.split(/\./)[0...-1].join(".")
+
+      {
+        name: name,
+        gem_name: gem_name,
+        constant_name: constant_name,
+        plugin_type: plugin_type,
+        namespace: namespace,
+        constant_namespace: constant_namespace,
+        spec_type: spec_type,
+        required_lita_version: required_lita_version
+      }.merge(generate_user_config).merge(optional_content)
+    end
+
+    def generate_user_config
+      git_user = `git config user.name`.chomp
+      git_user = "TODO: Write your name" if git_user.empty?
+      git_email = `git config user.email`.chomp
+      git_email = "TODO: Write your email address" if git_email.empty?
+
+      {
+        author: git_user,
+        email: git_email
+      }
+    end
+
+    def generate_templates(config)
+      name = config[:name]
+      gem_name = config[:gem_name]
+      namespace = config[:namespace]
+      travis = config[:travis]
+
+      target = File.join(Dir.pwd, gem_name)
+
+      template(
+        "plugin/lib/lita/plugin_type/plugin.tt",
+        "#{target}/lib/lita/#{namespace}/#{name}.rb",
+        config
+      )
+      template("plugin/lib/plugin.tt", "#{target}/lib/#{gem_name}.rb", config)
+      template(
+        "plugin/spec/lita/plugin_type/plugin_spec.tt",
+        "#{target}/spec/lita/#{namespace}/#{name}_spec.rb",
+        config
+      )
+      template(
+        "plugin/spec/spec_helper.tt",
+        "#{target}/spec/spec_helper.rb",
+        config
+      )
+      copy_file("plugin/Gemfile", "#{target}/Gemfile")
+      template("plugin/gemspec.tt", "#{target}/#{gem_name}.gemspec", config)
+      copy_file("plugin/gitignore", "#{target}/.gitignore")
+      copy_file("plugin/travis.yml", "#{target}/.travis.yml") if travis
+      template("plugin/LICENSE.tt", "#{target}/LICENSE", config)
+      copy_file("plugin/Rakefile", "#{target}/Rakefile")
+      template("plugin/README.tt", "#{target}/README.md", config)
+    end
+
+    def normalize_names(name)
+      name = name.downcase.sub(/^lita[_-]/, "")
+      gem_name = "lita-#{name}"
+      name = name.tr("-", "_")
+      [name, gem_name]
+    end
+
+    def optional_content
+      coveralls_question = <<-Q.chomp
+Do you want to generate code coverage information with SimpleCov \
+and Coveralls.io?
+Q
+      {
+        travis: yes?("Do you want to test your plugin on Travis CI?"),
+        coveralls: yes?(coveralls_question)
+      }
     end
   end
 end

data/lib/lita/handler.rb

@@ -102,15 +102,15 @@ module Lita
 
       # Determines whether or not an incoming messages should trigger a route.
       def route_applies?(route, message, robot)
-        # Message must match the pattern
-        return unless route.pattern === message.body
-
         # Message must be a command if the route requires a command
         return if route.command? && !message.command?
 
         # Messages from self should be ignored to prevent infinite loops
         return if message.user.name == robot.name
 
+        # Message must match the pattern
+        return unless route.pattern === message.body
+
         # User must be in auth group if route is restricted
         return unless authorized?(message.user, route.required_groups)
 

data/lib/lita/response.rb

@@ -18,7 +18,7 @@ module Lita
     #   @see Lita::Message#reply
     # @!method user
     #   @see Lita::Message#user
-    def_delegators :message, :args, :reply, :user
+    def_delegators :message, :args, :reply, :user, :command?
 
     # @param message [Lita::Message] The incoming message.
     # @param matches [Array<String>, Array<Array<String>>] The Regexp matches.

data/lib/lita/version.rb

@@ -1,4 +1,4 @@
 module Lita
   # The current version of Lita.
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

data/spec/lita/adapters/shell_spec.rb

@@ -26,9 +26,16 @@ describe Lita::Adapters::Shell do
 
   describe "#send_message" do
     it "prints its input" do
-      expect(subject).to receive(:puts).with("bar")
+      expect(subject).to receive(:puts) do |messages|
+        expect(messages.first).to include("bar")
+      end
       subject.send_messages(double("target"), "bar")
     end
+
+    it "doesn't output empty messages" do
+      expect(subject).to receive(:puts).with([])
+      subject.send_messages(double("target"), "")
+    end
   end
 
   describe "#shut_down" do

data/spec/lita/response_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Lita::Response do
+  subject { described_class.new(message) }
+
+  let(:message) { double("Lita::Message").as_null_object }
+
+  [:args, :reply, :user, :command?].each do |method|
+    it "delegates :#{method} to #message" do
+      expect(message).to receive(method)
+      subject.public_send(method)
+    end
+  end
+end

data/templates/plugin/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/templates/plugin/LICENSE.tt

@@ -0,0 +1,19 @@
+Copyright (c) <%= Time.now.year %> <%= config[:author] %>
+
+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/templates/plugin/README.tt

@@ -0,0 +1,23 @@
+# <%= config[:gem_name] %>
+
+TODO: Add a description of the plugin.
+
+## Installation
+
+Add <%= config[:gem_name] %> to your Lita instance's Gemfile:
+
+``` ruby
+gem "<%= config[:gem_name] %>"
+```
+
+## Configuration
+
+TODO: Describe any configuration attributes the plugin exposes.
+
+## Usage
+
+TODO: Describe the plugin's features and how to use them.
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/templates/plugin/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/templates/plugin/gemspec.tt

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "<%= config[:gem_name] %>"
+  spec.version       = "0.0.1"
+  spec.authors       = ["<%= config[:author] %>"]
+  spec.email         = ["<%= config[:email] %>"]
+  spec.description   = %q{TODO: Add a description}
+  spec.summary       = %q{TODO: Add a summary}
+  spec.homepage      = "TODO: Add a homepage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", "~> <%= config[:required_lita_version] %>"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+  <%- if config[:coveralls] -%>
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  <%- end -%>
+end

data/templates/plugin/gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/templates/plugin/lib/lita/plugin_type/plugin.tt

@@ -0,0 +1,14 @@
+require "lita"
+
+module Lita
+  module <%= config[:constant_namespace] %>
+    class <%= config[:constant_name] %> < <%= config[:plugin_type].capitalize %>
+    end
+
+    <%- if config[:plugin_type] == "adapter" -%>
+    Lita.register_adapter(:<%= config[:name] %>, <%= config[:constant_name] %>)
+    <%- else -%>
+    Lita.register_handler(<%= config[:constant_name] %>)
+    <%- end -%>
+  end
+end

data/templates/plugin/lib/plugin.tt

@@ -0,0 +1 @@
+require "lita/<%= config[:namespace] %>/<%= config[:name] %>"

data/templates/plugin/spec/lita/plugin_type/plugin_spec.tt

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::<%= config[:constant_namespace] %>::<%= config[:constant_name] %>, <%= config[:spec_type] %>: true do
+end

data/templates/plugin/spec/spec_helper.tt

@@ -0,0 +1,12 @@
+<%- if config[:coveralls] -%>
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+<%- end -%>
+require "<%= config[:gem_name] %>"
+require "lita/rspec"

data/templates/plugin/travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -231,8 +231,6 @@ files:
 - lib/lita/util.rb
 - lib/lita/version.rb
 - lita.gemspec
-- skeleton/Gemfile
-- skeleton/lita_config.rb
 - spec/lita/adapter_spec.rb
 - spec/lita/adapters/shell_spec.rb
 - spec/lita/authorization_spec.rb
@@ -243,6 +241,7 @@ files:
 - spec/lita/handlers/web_spec.rb
 - spec/lita/logger_spec.rb
 - spec/lita/message_spec.rb
+- spec/lita/response_spec.rb
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb
 - spec/lita/source_spec.rb
@@ -250,6 +249,19 @@ files:
 - spec/lita/util_spec.rb
 - spec/lita_spec.rb
 - spec/spec_helper.rb
+- templates/plugin/Gemfile
+- templates/plugin/LICENSE.tt
+- templates/plugin/README.tt
+- templates/plugin/Rakefile
+- templates/plugin/gemspec.tt
+- templates/plugin/gitignore
+- templates/plugin/lib/lita/plugin_type/plugin.tt
+- templates/plugin/lib/plugin.tt
+- templates/plugin/spec/lita/plugin_type/plugin_spec.tt
+- templates/plugin/spec/spec_helper.tt
+- templates/plugin/travis.yml
+- templates/robot/Gemfile
+- templates/robot/lita_config.rb
 homepage: https://github.com/jimmycuadra/lita
 licenses:
 - MIT
@@ -285,6 +297,7 @@ test_files:
 - spec/lita/handlers/web_spec.rb
 - spec/lita/logger_spec.rb
 - spec/lita/message_spec.rb
+- spec/lita/response_spec.rb
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb
 - spec/lita/source_spec.rb