ego 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2250f057ded898c375e1c7007080abbddb3ddbcb
-  data.tar.gz: 05c37f206fa38f7ba8a6879d4519dba59dfd74c6
+  metadata.gz: db83be1f5d3be9a990e8990b6f10b3fabd634939
+  data.tar.gz: 2dce79d2d96a4bf49c7bcdd1c5605f79ba31df97
 SHA512:
-  metadata.gz: 3e3b434aece55fb5a6f7b0c1ce850cc2b9f41cec5b092bd59e28773ff03c16c92ae9445828981eb147129f8d6c17c3ffccd1834448396325e04661dae2bde0e3
-  data.tar.gz: 1c3d3feb0fb8d531a931c5522ce2803e32d6a82d5875bed4b3b4d12b5c632c083b1eb3657439cedb5b88b03a218ef3582c4b9911df1d6b376548684b15353f9d
+  metadata.gz: 29423bd9409d40de8a4fe31e2e1893e3ffe7742b82f309cbc21df6b80f74082996d8ec62d5a69c67de6a07c50db8ed5dff4467187ca71ffedc74d2cb89ca534e
+  data.tar.gz: 3741072a3a11271babcd8168db8cf49592f24cb3e415870f0bdf75e190132301fe7956caa3b1c3fcfec47fc36610cb566cf756ac6ee55c3129c294d42ab0e012

data/lib/ego/filesystem.rb

@@ -9,16 +9,16 @@ module Ego::Filesystem
 
   module_function
 
-  def cache path = ''
-    File.join XDG_CACHE_HOME, BASENAME, path
+  def cache(path = '')
+    File.join(XDG_CACHE_HOME, BASENAME, path)
   end
 
-  def config path = ''
-    File.join XDG_CONFIG_HOME, BASENAME, path
+  def config(path = '')
+    File.join(XDG_CONFIG_HOME, BASENAME, path)
   end
 
-  def data path = ''
-    File.join XDG_DATA_HOME, BASENAME, path
+  def data(path = '')
+    File.join(XDG_DATA_HOME, BASENAME, path)
   end
 
   def builtin_handlers

data/lib/ego/formatter.rb

@@ -3,28 +3,33 @@ require 'colorize'
 module Ego
   class Formatter
     def initialize
-      String.disable_colorization = !STDOUT.isatty
+      String.disable_colorization = !$stdout.isatty
     end
 
-    def puts message
-      STDOUT.puts message
+    def puts(message)
+      $stdout.puts message
     end
 
-    def robot_respond message
-      STDOUT.puts message.yellow
+    def robot_respond(message, *replacements)
+      message = sprintf(message, *replacements)
+      message = message[0].upcase + message[1..-1]
+
+      $stdout.puts message.yellow
     end
 
-    def robot_action message
-      STDOUT.puts "*#{message}*".magenta
+    def robot_action(message)
+      $stdout.puts "*#{message}*".magenta
     end
 
-    def debug message
-      STDERR.puts message
+    def debug(message, *replacements)
+      message = sprintf(message, *replacements)
+
+      $stderr.puts message
     end
 
-    def self.print_handlers handlers
+    def self.print_handlers(handlers)
       handlers.keys.sort.each do |key|
-        STDOUT.puts "- #{handlers[key]}"
+        $stdout.puts "- #{handlers[key]}"
       end
     end
   end

data/lib/ego/handler.rb

@@ -9,7 +9,7 @@ module Ego
     attr_reader :name
     attr_accessor :description
 
-    def initialize name
+    def initialize(name)
       @name = name
     end
 
@@ -17,14 +17,14 @@ module Ego
       "#{@description}"
     end
 
-    def listen pattern, priority: 5, &parser
+    def listen(pattern, priority: 5, &parser)
       unless block_given?
         parser = Proc.new { |matches| matches }
       end
       @@listeners << Ego::Listener.new(pattern, priority, parser, @name)
     end
 
-    def run robot = nil, params = nil, &action
+    def run(robot = nil, params = nil, &action)
       if block_given?
         @action = action
       end
@@ -38,7 +38,7 @@ module Ego
       end
     end
 
-    def self.register name: nil
+    def self.register(name: nil)
       if name.nil?
         handler_path = caller_locations(1, 1)[0].absolute_path
         name = File.basename(handler_path, '.*')
@@ -50,18 +50,18 @@ module Ego
       @@handlers[handler.name] = handler
     end
 
-    def self.has handler_name
+    def self.has(handler_name)
       @@handlers.has_key? handler_name
     end
 
-    def self.load handler_names
+    def self.load(handler_names)
       handler_names.each do |path|
         handler = File.basename(path, '.*')
         require path unless has(handler)
       end
     end
 
-    def self.dispatch robot, query
+    def self.dispatch(robot, query)
       @@listeners.sort.reverse_each do |listener|
         if params = listener.match(query)
           return @@handlers[listener.handler].run(robot, params)

data/lib/ego/listener.rb

@@ -5,7 +5,7 @@ module Ego
 
     attr_accessor :pattern, :priority, :parser, :handler
 
-    def initialize pattern, priority, parser, handler
+    def initialize(pattern, priority, parser, handler)
       @pattern = pattern
       @priority = priority
       @parser = parser
@@ -16,7 +16,7 @@ module Ego
       @priority <=> other.priority
     end
 
-    def match query
+    def match(query)
       return false unless (matches = @pattern.match(query))
 
       @parser.call matches

data/lib/ego/robot.rb

@@ -2,23 +2,23 @@ module Ego
   class Robot
     attr_reader :name, :options
 
-    def initialize options, formatter
+    def initialize(options, formatter)
       @name = options.robot_name
       @options = options
       @formatter = formatter
     end
 
-    def respond message
-      @formatter.robot_respond message
+    def respond(message, *replacements)
+      @formatter.robot_respond message, *replacements
     end
 
-    def it message
+    def it(message)
       @formatter.robot_action message
     end
 
-    def debug message
+    def debug(message, *replacements)
       return unless @options.verbose
-      @formatter.debug message
+      @formatter.debug message, *replacements
     end
   end
 end

data/lib/ego/version.rb

@@ -1,3 +1,3 @@
 module Ego
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/ego/formatter_spec.rb

@@ -0,0 +1,53 @@
+require 'ego/formatter'
+
+module Ego
+  RSpec.describe Formatter do
+    before(:example) do
+      @formatter = Formatter.new
+    end
+
+    describe '#puts' do
+      it 'prints the message to STDOUT with newline' do
+        expect { @formatter.puts('X') }.to output("X\n").to_stdout
+      end
+    end
+
+    describe '#robot_respond' do
+      it 'prints the message to STDOUT with color and newline' do
+        expect { @formatter.robot_respond('X') }.to output("\e[0;33;49mX\e[0m\n").to_stdout
+      end
+
+      it 'accepts placeholders and replacement strings' do
+        expect { @formatter.robot_respond('Hello, %s.', 'world') }.to output("\e[0;33;49mHello, world.\e[0m\n").to_stdout
+      end
+
+      it 'capitalizes the first letter of the message' do
+        expect { @formatter.robot_respond('foo') }.to output("\e[0;33;49mFoo\e[0m\n").to_stdout
+      end
+
+      it 'capitalizes the first letter of the message when it is a replacement' do
+        expect { @formatter.robot_respond('%s', 'foo') }.to output("\e[0;33;49mFoo\e[0m\n").to_stdout
+      end
+
+      it 'does not lowercase subsequent letters' do
+        expect { @formatter.robot_respond('foO') }.to output("\e[0;33;49mFoO\e[0m\n").to_stdout
+      end
+    end
+
+    describe '#robot_action' do
+      it 'prints the message to STDOUT with color and formatting' do
+        expect { @formatter.robot_action('FOO') }.to output("\e[0;35;49m*FOO*\e[0m\n").to_stdout
+      end
+    end
+
+    describe '#debug' do
+      it 'prints the message to STDERR with newline' do
+        expect { @formatter.debug('FOO') }.to output("FOO\n").to_stderr
+      end
+
+      it 'accepts placeholders and replacement strings' do
+        expect { @formatter.debug('Hello, %s.', 'world') }.to output("Hello, world.\n").to_stderr
+      end
+    end
+  end
+end

data/spec/ego/options_spec.rb

@@ -6,6 +6,11 @@ RSpec.describe Ego::Options do
     expect(opts.mode).to eq(:interpret)
   end
 
+  it 'can be set to shell-mode' do
+    opts = Ego::Options.new(['-s'])
+    expect(opts.mode).to eq(:shell)
+  end
+
   it 'can be set to version-mode' do
     opts = Ego::Options.new(['-v'])
     expect(opts.mode).to eq(:version)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ego
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Noah Frederick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/ego/robot.rb
 - lib/ego/runner.rb
 - lib/ego/version.rb
+- spec/ego/formatter_spec.rb
 - spec/ego/options_spec.rb
 - spec/ego/robot_spec.rb
 - spec/spec_helper.rb
@@ -143,6 +144,7 @@ signing_key:
 specification_version: 4
 summary: An extensible personal command-line assistant
 test_files:
+- spec/ego/formatter_spec.rb
 - spec/ego/options_spec.rb
 - spec/ego/robot_spec.rb
 - spec/spec_helper.rb