ego 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8250ad3de4494ebfced808df3a5cb09de9707a38
-  data.tar.gz: 333930e6ddc866ec268016395b38061bc26aa9ab
+  metadata.gz: 0cb81d8a1088b04177d530c9e48535cf5aac9836
+  data.tar.gz: e73d083cb652574fda45ae050434c5317afa9690
 SHA512:
-  metadata.gz: de4f362f46c4347e659330f418524a4cc3ce3f3ee0f1bdd8adcd97a63fb8257b6b61f9a34e31e9a339ba0725efc02f4faa590ef6ef1edb5f56dfd5415cc77d43
-  data.tar.gz: df7fadaf3e23e57fec7634623da1a2a56135ff6c9ec8e3b5b501fd87168d5aac8dc7057f3523a2aab4991772e5c77adfc1bddd580f8ccfb17ee6a0dfe14fe00a
+  metadata.gz: e0804236f4b6316062857aeb92ab2376c7b10150b5e83588f1a57f9c9ea57ec7ded723872c25d3a557fc40eb9d0bb96656323086c722fe1fffe270f6c1fb7d4c
+  data.tar.gz: d618ba73954abebffd2eaac1b1ee71f275729b41ea12b926cc199cf525d523bb83656393216ad822ace7c925c2c980c6c0c5e77a59eaae3dab276c8e964b8a70

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*_spec.rb'
+    - 'lib/ego/options.rb'
+    - 'lib/ego/plugins/*.rb'
+
+Style/Semicolon:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-02-05 09:02:49 -0500 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 31
+
+# Offense count: 4
+Style/ClassVars:
+  Exclude:
+    - 'lib/ego/plugin.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'lib/ego.rb'
+
+# Offense count: 32
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 160

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ego.gemspec

data/Guardfile

@@ -1,5 +1,7 @@
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files
@@ -12,3 +14,8 @@ guard :rspec, cmd: "bundle exec rspec" do
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
 end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/Rakefile

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: :spec

data/bin/ego

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../lib/ego/runner'
 
 runner = Ego::Runner.new(ARGV)

data/ego.gemspec

@@ -1,35 +1,40 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ego/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ego"
+  spec.name          = 'ego'
   spec.version       = Ego::VERSION
-  spec.authors       = ["Noah Frederick"]
-  spec.email         = ["acc.rubygems@noahfrederick.com"]
-  spec.summary       = %q{An extensible personal command-line assistant}
-  spec.description   = <<-EOF
+  spec.authors       = ['Noah Frederick']
+  spec.email         = ['acc.rubygems@noahfrederick.com']
+  spec.summary       = 'An extensible personal command-line assistant'
+  spec.description   = <<-DESC
     Ego is a personal command-line assistant that provides a flexible, natural
     language interface (sort of) for interacting with other programs. Think of
     it as a single-user IRC bot that can be extended with handlers for various
     natural-language queries.
-  EOF
-  spec.homepage      = "https://github.com/noahfrederick/ego"
-  spec.license       = "GPL-3.0+"
+  DESC
+  spec.homepage      = 'https://github.com/noahfrederick/ego'
+  spec.license       = 'GPL-3.0+'
 
   spec.files         = `git ls-files -z`.split("\x0")
   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.require_paths = ['lib']
 
-  spec.required_ruby_version = "~> 2.3"
+  spec.required_ruby_version = '~> 2.3'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency 'aruba', '~> 1.0.0.pre.alpha.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
 
-  spec.add_runtime_dependency "colorize", "~> 0.7"
-  spec.add_runtime_dependency "hooks", "~> 0.4"
+  spec.add_runtime_dependency 'colorize', '~> 0.7'
+  spec.add_runtime_dependency 'hooks', '~> 0.4'
 end

data/lib/ego.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'ego/filesystem'
 require_relative 'ego/robot'
 require_relative 'ego/plugin'
@@ -12,7 +14,7 @@ module Ego
   # automatically at runtime. Each plug-in goes in it's own file with an `.rb`
   # extension (e.g., `~/.config/ego/plugins/my_plugin.rb`).
   #
-  # Be careful—ego will execute any Ruby scripts in this directory
+  # Be careful---ego will execute any Ruby scripts in this directory
   # indiscriminately.
   #
   # @example Create and register a new plug-in

data/lib/ego/capability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'plugin'
 
 module Ego

data/lib/ego/filesystem.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ego
   # Provides utility methods for getting configuration, data, and cache paths.
   module Filesystem

data/lib/ego/handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'robot_error'
 
 module Ego
@@ -58,10 +60,14 @@ module Ego
     # @return [false] if condition doesn't match
     # @return [Array] parameters to pass to the action
     def handle(query)
-      return false unless result = @condition.call(query)
+      return false unless (result = @condition.call(query))
 
       @action.parameters.each_with_object([]) do |param, arr|
-        arr << result[param.pop]
+        begin
+          arr << result[param.pop]
+        rescue IndexError
+          arr << nil # Match group isn't defined.
+        end
       end
     end
 

data/lib/ego/options.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module Ego
   # Parse command-line options and set defaults.
   class Options
-
     attr_reader :mode,
                 :plugins,
                 :robot_name,
@@ -18,7 +19,7 @@ module Ego
       @plugins = true
       @verbose = false
       parse(argv)
-      @query = argv.join(" ")
+      @query = argv.join(' ')
     end
 
     private
@@ -33,28 +34,32 @@ module Ego
         @robot_name = opts.program_name.capitalize
         opts.banner = "Usage: #{opts.program_name} [ options ] query..."
 
-        opts.on("-n", "--no-plugins", "Skip loading user plug-ins") do
+        opts.on('-n', '--no-plugins', 'Skip loading user plug-ins') do
           @plugins = false
         end
 
-        opts.on("-s", "--shell", "Start in REPL-mode") do
+        opts.on('-s', '--shell', 'Start in REPL-mode') do
           @mode = :shell
         end
 
-        opts.on("-v", "--version", "Print version number") do
+        opts.on('-t', '--template', 'Create a new plug-in') do
+          @mode = :template
+        end
+
+        opts.on('-v', '--version', 'Print version number') do
           @mode = :version
         end
 
-        opts.on("-V", "--verbose", "Include debugging info in output") do
+        opts.on('-V', '--verbose', 'Include debugging info in output') do
           @verbose = true
         end
 
-        opts.on("-h", "--help", "Show this message") do
+        opts.on('-h', '--help', 'Show this message') do
           @mode = :help
         end
 
         begin
-          argv = ["-h"] if argv.empty?
+          argv = ['-h'] if argv.empty?
           opts.parse!(argv)
         rescue OptionParser::ParseError => e
           @usage_error = e.message

data/lib/ego/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ego
   # A plug-in extends Ego with new handlers and other functionality, through a
   # domain-specific language (DSL).
@@ -47,7 +49,7 @@ module Ego
     # @param obj [Object] the object to decorate
     # @return [Object] the decorated object
     def self.decorate(obj)
-      @@plugins.each do |name, plugin|
+      @@plugins.each_value do |plugin|
         @@context = plugin
         plugin.body.call(obj)
         @@context = nil

data/lib/ego/plugin_helper.rb

@@ -1,4 +1,6 @@
-require 'ego/filesystem'
+# frozen_string_literal: true
+
+require_relative 'filesystem'
 
 module Ego
   # The PluginHelper assists the user in writing extensions by generating
@@ -8,9 +10,9 @@ module Ego
   class PluginHelper
     # @param query [String] example user query
     # @param program_name [String] the executable name
-    def initialize(query:, program_name:)
-      @query = query
-      @program_name = program_name
+    def initialize(query: nil, program_name: nil)
+      @query = query || 'My new plugin'
+      @program_name = program_name || 'ego'
     end
 
     # Derive a slug from the user query.
@@ -18,13 +20,13 @@ module Ego
     # @return [String] slug
     def slug
       @slug ||= @query
-        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-        .tr('\'', '')
-        .gsub(/\W+/, '_')
-        .gsub(/__+/, '_')
-        .sub(/_$/, '')
-        .downcase
+                .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                .tr('\'', '')
+                .gsub(/\W+/, '_')
+                .gsub(/__+/, '_')
+                .sub(/_$/, '')
+                .downcase
     end
 
     # Derive a plug-in path from the user query.
@@ -32,7 +34,7 @@ module Ego
     # @return [String] plug-in path
     def path
       @path ||= Filesystem.config("plugins/#{slug}.rb")
-        .sub(/^#{ENV['HOME']}/, '~')
+                          .sub(/^#{ENV['HOME']}/, '~')
     end
 
     # Provide a hint for initializing a new plug-in.
@@ -40,19 +42,19 @@ module Ego
     # @return [String] hint text
     def hint
       require 'shellwords'
-      @hint ||= <<~EOF
+      @hint ||= <<~HINT
         I don't understand "#{@query}".
 
         If you would like to add this capability, start by running:
           #{@program_name} #{@query.shellescape} > #{path}
-      EOF
+      HINT
     end
 
     # Provide a template for initializing a new plug-in.
     #
     # @return [String] template contents
     def template
-      @template ||= <<~EOF
+      @template ||= <<~TEMPLATE
         Ego.plugin do |robot|
           robot.can 'do something new'
 
@@ -60,7 +62,7 @@ module Ego
             alert 'Not implemented yet. Go ahead and edit #{path}.'
           end
         end
-      EOF
+      TEMPLATE
     end
   end
 end

data/lib/ego/plugins/capabilities.rb

@@ -1,17 +1,23 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'list capabilities'
 
   robot.on(
     /^(show me|show|tell me|list)\s+(handlers|what you can do|what (?:you are|you're) able to do|what you do|what (?:queries )?you (?:can )?understand)$/i => 5,
     /^what (?:can you|are you able to|do you) (?:do|handle|understand)\??$/i => 5,
-    /^help/i => 2,
+    /^help/i => 2
   ) do
     say 'I can...'
 
     @capabilities.each do |cap|
       builtin = cap.plugin.builtin ? '*' : ''
-      plugin = sprintf('(%s%s)', cap.plugin.name, builtin).magenta
-      printf("- %s %s\n", cap.to_s, plugin)
+      plugin = format('(%<name>s%<builtin>s)',
+                      name: cap.plugin.name,
+                      builtin: builtin).magenta
+      printf("- %<desc>s %<plugin>s\n",
+             desc: cap.to_s,
+             plugin: plugin)
     end
   end
 

data/lib/ego/plugins/fallback.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'help you write plug-ins'
 
   robot.on_unhandled_query do |query|
-    require 'ego/plugin_helper'
+    require_relative '../plugin_helper'
 
     helper = Ego::PluginHelper.new(
       query: query,
       program_name: options.usage.program_name
     )
 
-    if $stdout.isatty
-      alert helper.hint
-    end
+    alert helper.hint if $stdout.isatty
+
+    puts helper.template if verbose? || !$stdout.isatty
+  end
 
-    if verbose? || !$stdout.isatty
-      puts helper.template
-    end
+  robot.on(/^$/) do
+    say %w[Yes? Hello? ...?].sample
   end
 end

data/lib/ego/plugins/robot_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'output text to the terminal'