ego 0.5.0 → 0.6.0

data/lib/ego/plugins/social.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'socialize'
 
@@ -13,7 +15,7 @@ Ego.plugin do |robot|
       'Hi.',
       'Hey.',
       'Ciao.',
-      'Hej.',
+      'Hej.'
     ].sample
   end
 end

data/lib/ego/plugins/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'report robot status'
 

data/lib/ego/plugins/system.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 Ego.plugin do |robot|
   robot.can 'execute system commands'
 
   robot.provide :system do |*args|
     debug 'Running system with arguments %s.', args
 
-    unless Kernel.system(*args)
+    unless Kernel.system(*args) # rubocop:disable Style/IfUnlessModifier
       alert 'Sorry, there was a problem running %s.', args.first
     end
   end
@@ -13,7 +15,7 @@ Ego.plugin do |robot|
 
   robot.on(
     /^what(?:'?s| is) my (?:user|login)? ?name/i => 5,
-    /^who am I(?: logged in as)?/i => 5,
+    /^who am I(?: logged in as)?/i => 5
   ) do
     say 'You are currently logged in as:'
     system 'who'

data/lib/ego/printer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 module Ego
@@ -16,7 +18,7 @@ module Ego
     # @param *replacements [Object, ...] `printf`-style replacements
     # @return [nil]
     def say(message, *replacements)
-      puts sprintf(message, *replacements).bold
+      puts format(message, *replacements).bold
     end
 
     # Write stylized message to `$stdout` indicating an emote.
@@ -45,7 +47,7 @@ module Ego
     # @param *replacements [Object, ...] `printf`-style replacements
     # @return [nil]
     def alert(message, *replacements)
-      errs sprintf(message, *replacements).light_red
+      errs format(message, *replacements).light_red
     end
 
     # Write stylized message to `$stderr` indicating a debugging message.
@@ -62,14 +64,16 @@ module Ego
     # @param *replacements [Object, ...] `printf`-style replacements
     # @return [nil]
     def debug(message, *replacements)
-      errs sprintf(message, *replacements) if verbose?
+      errs format(message, *replacements) if verbose?
     end
 
     # Whether to print debugging messages. Can be overridden by classes that
     # include `Printer`.
     #
     # @return [false] should print debugging messages?
-    def verbose?; false; end
+    def verbose?
+      false
+    end
 
     module_function
 
@@ -88,7 +92,7 @@ module Ego
     # @param *message [Object, ...] message(s) to write
     # @return [nil]
     def errs(*message)
-      $stderr.puts(*message)
+      warn(*message)
     end
   end
 end

data/lib/ego/robot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'capability'
 require_relative 'handler'
 require_relative 'robot_error'
@@ -17,7 +19,7 @@ module Ego
 
     attr_reader :name, :options, :capabilities
 
-    alias_method :provide, :define_singleton_method
+    alias provide define_singleton_method
 
     define_hooks :on_ready, :on_shutdown
     define_hooks :before_handle_query, :after_handle_query, :on_unhandled_query
@@ -75,6 +77,7 @@ module Ego
     # The robot will execute the given block (the "action") when the given
     # pattern (the "condition") matches. Conditions are assigned priorities,
     # which determined in what order conditions are checked against the query.
+    # A higher number is treated as higher priority.
     #
     # @example Add a handler to the robot instance
     #   robot.on(/^pattern/) do
@@ -100,14 +103,14 @@ module Ego
     #     # ...
     #   end
     #
-    # @param condition [Proc, #match] the condition that triggers the supplied action
-    # @param priority [Integer] the handler priority (higher number = higher priority)
+    # @param condition [Proc, #match] the condition that triggers the action
+    # @param priority [Integer] the handler priority
     # @param action [Proc] the block to be executed when condition is met
     # @return [void]
     #
     # @see Handler#initialize
     def on(condition, priority = 5, &action)
-      unless action
+      unless action # rubocop:disable Style/IfUnlessModifier
         raise RobotError, "Hook requires an action: robot.on #{condition.inspect}"
       end
 
@@ -152,7 +155,7 @@ module Ego
       run_hook :before_handle_query, query
 
       first_handler_for(query) do |handler, params|
-        return run_action(handler.action, params).tap do |result|
+        return run_action(handler.action, params).tap do |_result|
           run_hook :after_handle_query, query, handler
         end
       end
@@ -170,7 +173,7 @@ module Ego
     # @return [Handler] the first matching handler
     def first_handler_for(query)
       @handlers.sort.reverse_each do |handler|
-        if params = handler.handle(query)
+        if (params = handler.handle(query))
           yield(handler, params) if block_given?
           return handler
         end

data/lib/ego/robot_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ego
   # Error type raised by robot plug-in DSL.
   #

data/lib/ego/runner.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../ego'
 require_relative 'options'
+require_relative 'plugin_helper'
 
 module Ego
   # The Runner class, given an array of arguments, initializes the required
@@ -8,7 +11,7 @@ module Ego
     # Prompt to display in shell-mode
     PROMPT = 'ego, '.green.freeze
     # Pattern that triggers shell-mode to exit
-    QUIT = /^q(uit)?|exit|(good)?bye$/.freeze
+    QUIT = /^q(uit)?|exit|(good)?bye$/
 
     # Takes an array of arguments and parses them into options:
     #
@@ -27,15 +30,19 @@ module Ego
     def run
       case @options.mode
       when :help
-        if @options.usage_error
-          Printer.errs @options.usage_error, "\n"
-        end
+        Printer.errs @options.usage_error, "\n" if @options.usage_error
 
         Printer.puts @options.usage
 
         exit(-1) if @options.usage_error
       when :version
         Printer.puts "ego v#{Ego::VERSION}"
+      when :template
+        helper = PluginHelper.new(
+          query: (@options.query unless @options.query.empty?),
+          program_name: @options.usage.program_name
+        )
+        Printer.puts helper.template
       when :shell
         start_shell(robot_factory)
       else
@@ -54,9 +61,7 @@ module Ego
     def robot_factory
       Plugin.load Filesystem.builtin_plugins
 
-      if @options.plugins
-        Plugin.load Filesystem.user_plugins
-      end
+      Plugin.load Filesystem.user_plugins if @options.plugins
 
       Plugin.decorate(Robot.new(@options)).ready
     end

data/lib/ego/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Ego
   # Gem version
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/ego/acceptance/help_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego --help', type: :aruba do
+  before(:each) { run_command('bin/ego --help') }
+
+  it 'prints usage help' do
+    expect(last_command_started).to have_output an_output_string_matching('^Usage: ego')
+  end
+end

data/spec/ego/acceptance/no_args_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego', type: :aruba do
+  before(:each) { run_command('bin/ego') }
+
+  it 'prints usage help' do
+    expect(last_command_started).to have_output an_output_string_matching('^Usage: ego')
+  end
+end

data/spec/ego/acceptance/shell_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: false
+
+RSpec.describe 'bin/ego --shell', type: :aruba do
+  before(:each) { run_command('bin/ego --shell') }
+
+  it 'responds' do
+    type('echo xxx')
+    type('exit')
+    expect(last_command_started).to have_output an_output_string_including('xxx')
+  end
+end

data/spec/ego/acceptance/simple_query_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego hello', type: :aruba do
+  before(:each) { run_command('bin/ego hello') }
+
+  it 'responds with a greeting' do
+    expect(last_command_started).to have_output an_output_string_matching('^[[:upper:]].+\.$')
+  end
+end

data/spec/ego/acceptance/template_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego --template', type: :aruba do
+  context 'without a query' do
+    before(:each) { run_command('bin/ego --template') }
+
+    it 'prints the plug-in template with default query' do
+      # rubocop:disable Layout/EmptyLinesAroundArguments
+      expect(last_command_started).to have_output an_output_string_being_eq(
+        <<~TEMPLATE
+          Ego.plugin do |robot|
+            robot.can 'do something new'
+
+            robot.on(/^My new plugin$/i) do |params|
+              alert 'Not implemented yet. Go ahead and edit ~/.config/ego/plugins/my_new_plugin.rb.'
+            end
+          end
+        TEMPLATE
+      )
+      # rubocop:enable Layout/EmptyLinesAroundArguments
+    end
+  end
+
+  context 'with a query' do
+    before(:each) { run_command('bin/ego --template help me out') }
+
+    it 'prints the plug-in template with supplied query' do
+      # rubocop:disable Layout/EmptyLinesAroundArguments
+      expect(last_command_started).to have_output an_output_string_being_eq(
+        <<~TEMPLATE
+          Ego.plugin do |robot|
+            robot.can 'do something new'
+
+            robot.on(/^help me out$/i) do |params|
+              alert 'Not implemented yet. Go ahead and edit ~/.config/ego/plugins/help_me_out.rb.'
+            end
+          end
+        TEMPLATE
+      )
+      # rubocop:enable Layout/EmptyLinesAroundArguments
+    end
+  end
+end

data/spec/ego/acceptance/usage_error_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego --invalid-flag', type: :aruba do
+  before(:each) { run_command('bin/ego --invalid-flag', fail_on_error: false) }
+
+  it 'exits with a non-zero status' do
+    expect(last_command_started).not_to be_successfully_executed
+  end
+
+  it 'prints usage error' do
+    expect(last_command_started).to have_output an_output_string_matching('^invalid option:')
+  end
+
+  it 'prints usage help' do
+    expect(last_command_started).to have_output an_output_string_matching('^Usage: ego')
+  end
+end

data/spec/ego/acceptance/version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe 'bin/ego --version', type: :aruba do
+  before(:each) { run_command('bin/ego --version') }
+
+  it 'prints version message' do
+    expect(last_command_started).to have_output an_output_string_matching('^ego v\d+\.\d+\.\d+')
+  end
+end

data/spec/ego/capability_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ego/capability'
 
 RSpec.describe Ego::Capability do

data/spec/ego/handler_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'ego/handler'
 
 RSpec.describe Ego::Handler do
-  let(:condition) { ->(q) { {p: 'bar', q: 'baz'} if q == 'foo' } }
+  let(:condition) { ->(q) { { p: 'bar', q: 'baz' } if q == 'foo' } }
   let(:regexp) { /^baz/i }
   let(:action) { ->(p) { puts p } }
   let(:priority) { 2 }
@@ -68,13 +70,23 @@ RSpec.describe Ego::Handler do
       end
 
       it 'respects the order of action arguments' do
-        subject = described_class.new(condition, ->(q, p) { }, priority)
-        expect(subject.handle('foo')).to eq(['baz', 'bar'])
+        subject = described_class.new(condition, ->(q, p) {}, priority)
+        expect(subject.handle('foo')).to eq(%w[baz bar])
+      end
+
+      context 'when the condition returns a hash' do
+        it 'gracefully handles extra action arguments' do
+          subject = described_class.new(condition, ->(p, q, r) {}, priority)
+          expect { subject.handle('foo') }.not_to raise_error
+        end
       end
 
-      it 'gracefully handles extra action arguments' do
-        subject = described_class.new(condition, ->(p, q, r) { }, priority)
-        expect { subject.handle('foo') }.not_to raise_error
+      context 'when the condition returns a match object' do
+        it 'gracefully handles extra action arguments' do
+          condition = /(?<p>foo|bar)/i
+          subject = described_class.new(condition, ->(p, q) {}, priority)
+          expect { subject.handle('foo') }.not_to raise_error
+        end
       end
     end
   end

data/spec/ego/options_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ego/options'
 
 RSpec.describe Ego::Options do
@@ -11,6 +13,11 @@ RSpec.describe Ego::Options do
     expect(opts.mode).to eq(:shell)
   end
 
+  it 'can be set to template-mode' do
+    opts = described_class.new(['-t'])
+    expect(opts.mode).to eq(:template)
+  end
+
   it 'can be set to version-mode' do
     opts = described_class.new(['-v'])
     expect(opts.mode).to eq(:version)
@@ -47,7 +54,7 @@ RSpec.describe Ego::Options do
   end
 
   it 'sets the query to remaining args join with spaces' do
-    opts = described_class.new(['foo', 'bar'])
+    opts = described_class.new(%w[foo bar])
     expect(opts.query).to eq('foo bar')
   end
 

data/spec/ego/plugin_helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ego/plugin_helper'
 
 RSpec.describe Ego::PluginHelper do
@@ -13,11 +15,11 @@ RSpec.describe Ego::PluginHelper do
 
   describe '#path' do
     it 'returns a path to the plugins directory' do
-      expect(subject.path).to match(/\/plugins\//)
+      expect(subject.path).to match(%r{/plugins/})
     end
 
     it 'uses a tilde for the home directory' do
-      expect(subject.path).to match(/^~\//)
+      expect(subject.path).to match(%r{^~/})
     end
 
     it 'names the file after the slug' do

data/spec/ego/plugin_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ego/plugin'
 
 RSpec.describe Ego::Plugin do
@@ -30,7 +32,6 @@ RSpec.describe Ego::Plugin do
     end
   end
 
-
   describe '.decorate' do
     let(:obj) do
       Class.new { attr_accessor :context, :a, :b }.new
@@ -62,10 +63,10 @@ RSpec.describe Ego::Plugin do
     end
 
     it 'calls each plugin body passing the obj' do
-      expect(obj).to receive_messages({
+      expect(obj).to receive_messages(
         :a= => 'foo',
-        :b= => 'bar',
-      })
+        :b= => 'bar'
+      )
       described_class.decorate(obj)
     end