lita-keyword-arguments 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50b14a28465dd29840f23d773f7f0fcfb6f07202
+  data.tar.gz: 4b8146bc1102622ad055ecf62dabd5bbc5e34b61
+SHA512:
+  metadata.gz: 459b9de5fc7a45f5cb32caf220426057c1ec5fda0dcad65453fa88ee94a619420fe3bbfae194e44422cf1dc8a02e3f540c117a08b08ca513170e23e5f2ea0da2
+  data.tar.gz: 770e7093e1721832936c0820e43cca3dc0f5b91ff0fd13c6aa177b38a69c0fa4a5bc6ae75a088c33a1ea2ff3d578741c980603bd4e0b9478319ef9963832ce73

data/.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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Jimmy Cuadra
+
+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,81 @@
+# lita-keyword-arguments
+
+**lita-keyword-arguments** is an extension for [Lita](https://www.lita.io/) that extracts keyword arguments from messages in the style of command line flags.
+
+## Installation
+
+Add lita-keyword-arguments to your Lita plugin's gemspec:
+
+``` ruby
+spec.add_runtime_dependency "lita-keyword-arguments"
+```
+
+## Usage
+
+Define keyword arguments for a route using the `kwargs` option. The value should be a hash, mapping keywords to a hash detailing the rules about that keyword.
+
+When the route matches, the response object passed to the handler method will have the `:kwargs` key in its `extensions` attribute populated with the parsed keyword argument values.
+
+Example:
+
+``` ruby
+class MyHandler < Lita::Handler
+  route(
+    /^my_command/,
+    :callback
+    command: true,
+    kwargs: {
+      foo: {},
+      bar: {
+        short: "b",
+        default: "unset"
+      },
+      verbose: {
+        short: "v",
+        boolean: true
+      }
+    }
+  )
+
+  def callback(response)
+    # response.extensions[:kwargs] will be populated with a hash of keywords and their values.
+  end
+end
+```
+
+The above `:kwargs` hash would make lita-keyword-arguments recognize the following in messages:
+
+```
+[--foo VALUE] [-b | --bar VALUE] [-v | --verbose | --no-verbose]
+```
+
+The `:bar` keyword be set to the string "unset" if no value was provided in the message.
+
+
+The possible keys for each keyword argument's specification are:
+
+* `:short` - A single letter to use for the short flag. Invoked with a single preceeding dash. For example: "-f".
+* `:boolean` - The kwarg represents a boolean and does not have an argument. Set to true by providing the flag. Set to false by providing the long version of the flag, prefixing the keyword with "no-". For example: "--no-verbose".
+* `:default` - A default value to give the keyword argument if the flag is not provided in the message.
+
+The long flag (e.g. --foo) is automatically created from the key.
+
+Example messages and their resulting hashes:
+
+``` ruby
+# Lita: my_command -b hello
+{ bar: "hello" }
+
+# Lita: my_command --foo baz
+{ foo: "baz", bar: "unset" }
+
+# Lita: my_command -v
+{ bar: "unset", verbose: true }
+
+# Lita: my_command --no-verbose
+{ bar: "unset", verbose: false }
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

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

data/lib/lita-keyword-arguments.rb

@@ -0,0 +1,8 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/extensions/keyword_arguments/parser"
+require "lita/extensions/keyword_arguments"

data/lib/lita/extensions/keyword_arguments.rb

@@ -0,0 +1,17 @@
+module Lita
+  module Extensions
+    class KeywordArguments
+      def self.call(payload)
+        spec = payload[:route].extensions[:kwargs]
+
+        if spec
+          response = payload[:response]
+          kwargs = Parser.new(spec, response.message.args).parse
+          response.extensions[:kwargs] = kwargs
+        end
+      end
+    end
+
+    Lita.register_hook(:trigger_route, KeywordArguments)
+  end
+end

data/lib/lita/extensions/keyword_arguments/parser.rb

@@ -0,0 +1,41 @@
+require 'slop'
+
+module Lita
+  module Extensions
+    class KeywordArguments
+      class Parser
+        attr_reader :args, :spec
+
+        def initialize(spec, args)
+          @spec = spec
+          @args = args
+        end
+
+        def parse
+          spec.each { |name, option_spec| add_option(name, option_spec) }
+          parser.parse(args)
+          parser.to_hash
+        end
+
+        private
+
+        def add_option(name, spec)
+          opt_args = []
+          opt_options = {}
+
+          opt_args << spec[:short] if spec[:short]
+          opt_args << name
+          opt_options[:default] = spec[:default] if spec[:default]
+          opt_options[:optional_argument] = true unless spec[:boolean]
+          opt_args << opt_options
+
+          parser.on(*opt_args)
+        end
+
+        def parser
+          @parser ||= Slop.new
+        end
+      end
+    end
+  end
+end

data/lita-keyword-arguments.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-keyword-arguments"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jimmy Cuadra"]
+  spec.email         = ["jimmy@jimmycuadra.com"]
+  spec.description   = %q{A Lita extension to extract CLI-style arguments from messages.}
+  spec.summary       = %q{A Lita extension to extract CLI-style arguments from messages.}
+  spec.homepage      = "https://github.com/jimmycuadra/lita-keyword-arguments"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "extension" }
+
+  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", ">= 3.2"
+  spec.add_runtime_dependency "slop", ">= 3.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0.beta2"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    extensions:
+      keyword_arguments:

data/spec/lita/extensions/keyword_arguments/parser_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe Lita::Extensions::KeywordArguments::Parser do
+  it "parses long flags" do
+    subject = described_class.new(
+      { foo: {} },
+      "--foo bar".split
+    )
+
+    expect(subject.parse).to eq(foo: "bar")
+  end
+
+  it "sets missing arguments to nil" do
+    subject = described_class.new(
+      { foo: {} },
+      "--foo".split
+    )
+
+    expect(subject.parse).to eq(foo: nil)
+  end
+
+  it "parses short flags" do
+    subject = described_class.new(
+      { foo: { short: "f" } },
+      "-f bar".split
+    )
+
+    expect(subject.parse).to eq(foo: "bar")
+  end
+
+  it "parses long boolean flags" do
+    subject = described_class.new(
+      { foo: { boolean: true } },
+      "--foo".split
+    )
+
+    expect(subject.parse).to eq(foo: true)
+  end
+
+  it "parses inverted long boolean flags" do
+    subject = described_class.new(
+      { foo: { boolean: true, default: true } },
+      "--no-foo".split
+    )
+
+    expect(subject.parse).to eq(foo: false)
+  end
+
+  it "parses short boolean flags" do
+    subject = described_class.new(
+      { foo: { short: "f", boolean: true } },
+      "-f".split
+    )
+
+    expect(subject.parse).to eq(foo: true)
+  end
+
+  it "includes defaults" do
+    subject = described_class.new(
+      { foo: { default: "bar" } },
+      "".split
+    )
+
+    expect(subject.parse).to eq(foo: "bar")
+  end
+
+  it "overrides defaults when values are supplied" do
+    subject = described_class.new(
+      { foo: { default: "bar" } },
+      "--foo baz".split
+    )
+
+    expect(subject.parse).to eq(foo: "baz")
+  end
+
+  it "parses known options even when an unknown option is encountered first" do
+    subject = described_class.new(
+      { foo: { short: "f", boolean: true } },
+      "-x -f".split
+    )
+
+    expect(subject.parse).to eq(foo: true)
+  end
+end

data/spec/lita/extensions/keyword_arguments_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Lita::Extensions::KeywordArguments, lita: true do
+  let(:message) { instance_double("Lita::Message", args: []) }
+  let(:parser) { instance_double("Lita::Extensions::KeywordArguments::Parser", parse: {}) }
+  let(:response) { instance_double("Lita::Response", extensions: {}, message: message) }
+  let(:route) { instance_double("Lita::Handler::Route", extensions: { kwargs: {} }) }
+
+  describe ".call" do
+    before { allow(Lita::Extensions::KeywordArguments::Parser).to receive(:new).and_return(parser) }
+    it "adds kwargs to the response's extensions data" do
+      described_class.call(response: response, route: route)
+      expect(response.extensions[:kwargs]).not_to be_nil
+    end
+
+    it "does nothing if the route did not include a kwargs spec" do
+      route.extensions.delete(:kwargs)
+      described_class.call(response: response, route: route)
+      expect(response.extensions[:kwargs]).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-keyword-arguments"
+require "lita/rspec"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: lita-keyword-arguments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: A Lita extension to extract CLI-style arguments from messages.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-keyword-arguments.rb
+- lib/lita/extensions/keyword_arguments.rb
+- lib/lita/extensions/keyword_arguments/parser.rb
+- lita-keyword-arguments.gemspec
+- locales/en.yml
+- spec/lita/extensions/keyword_arguments/parser_spec.rb
+- spec/lita/extensions/keyword_arguments_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jimmycuadra/lita-keyword-arguments
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: extension
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Lita extension to extract CLI-style arguments from messages.
+test_files:
+- spec/lita/extensions/keyword_arguments/parser_spec.rb
+- spec/lita/extensions/keyword_arguments_spec.rb
+- spec/spec_helper.rb