cliqr 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5305e3f607fd5cbf6d6c55840630671129ec96bf
-  data.tar.gz: 21995e4b7b23b3c3d29011eb9b42a614ca54d38a
+  metadata.gz: 2892f4cce1901d6018999df394a46e27d591af4b
+  data.tar.gz: 709e7b21684d0f463382e4c3b1c49fd59b874bb9
 SHA512:
-  metadata.gz: b2e59b44f6b5656afbd8e75039fbf0cd46fff0421b1923fb8b3cf04f2972ad96359dbbef31f205190476123f80b5b686b3270db6f603329f6ab2194be6771e08
-  data.tar.gz: 3b0b7571dcbf6d460e4b61fbbfee83923e2c784c450311a00060ecd828ec17ba2a70820d4f8302ac9dbd27b2ba2189f2e713a96ba78fcc8bf66b98140ebf52b2
+  metadata.gz: e11d059ede7010a84baa7dfe33ccf85b1776534c2f5b9ca87d6840519e376c46feca6c84d48ce69d9b1c86316623e548bf34f054e32521aa2344916a3b3fb588
+  data.tar.gz: 3e340c1aff3fc1a664345d08406ad8e11b1b5ab7178f9e22fe31ad743aa8da8949b88ead8eda1ed67c326e0dd7b10d06a23e76e58411acca62a428fb6a2af793

data/CHANGELOG.md

@@ -5,6 +5,33 @@ item in this nested table for further details.
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
 **Table of Contents**
 
+- [2.1.1 / 2015-07-15](#211--2015-07-15)
+    - [Bugfix](#bugfix)
+- [2.1.0 / 2015-07-15](#210--2015-07-15)
+    - [Features](#features)
+        - [Make use of `readline` lib for shell mode.](#make-use-of-readline-lib-for-shell-mode)
+    - [Bugfix](#bugfix)
+        - [Handle spaces in command arguments](#handle-spaces-in-command-arguments)
+    - [Minor improvements](#minor-improvements)
+        - [Use shortened URl for gif in README](#use-shortened-url-for-gif-in-readme)
+- [2.0.0 / 2015-07-09](#200--2015-07-09)
+    - [Features](#features)
+        - [Event handling](#event-handling)
+            - [Default events for shell](#default-events-for-shell)
+        - [Colors](#colors)
+        - [Customizable banner and prompt for shell](#customizable-banner-and-prompt-for-shell)
+    - [Backward incompatible changes](#backward-incompatible-changes)
+    - [Improvements](#improvements)
+        - [Partial templated](#partial-templated)
+        - [Improve default prompt](#improve-default-prompt)
+        - [Screen capture in README](#screen-capture-in-readme)
+    - [Minor changes](#minor-changes)
+        - [Shorten the quickstart example](#shorten-the-quickstart-example)
+        - [Re-organize code and move specs around](#re-organize-code-and-move-specs-around)
+        - [Multi OS testing suprted added to CI](#multi-os-testing-suprted-added-to-ci)
+    - [Bugfixes](#bugfixes)
+        - [Fix examples to follow new breaking shell config change](#fix-examples-to-follow-new-breaking-shell-config-change)
+        - [Do not put allow arguments in shell config](#do-not-put-allow-arguments-in-shell-config)
 - [1.2.0 / 2015-06-18](#120--2015-06-18)
     - [Features](#features)
         - [Nested actions](#nested-actions)
@@ -91,6 +118,40 @@ item in this nested table for further details.
 
 <!-- markdown-toc end -->
 
+2.1.1 / 2015-07-15
+==================
+
+## Bugfix
+
+Fix the version tag in gem
+
+2.1.0 / 2015-07-15
+==================
+
+## Features
+
+### Make use of `readline` lib for shell mode.
+
+This gives us a huge advantage by supporting command history and meta
+character handling out of the box.
+
+Some tweaks will come in smaller patches soon.
+
+## Bugfix
+
+### Handle spaces in command arguments
+
+Reported by @AlgyTaylor.
+
+We were not able to parse a argument as a continuous value if it had a
+space in it. This was fixed by using `shellwords`.
+
+## Minor improvements
+
+### Use shortened URl for gif in README
+
+This allows a little bit of analytics for the trafic to the git repo.
+
 2.0.0 / 2015-07-09
 ==================
 
@@ -100,7 +161,8 @@ Another big release!
 
 ### Event handling
 
-Added ability to invoke arbitiary events and define handlers to handle certain kind of events.
+Added ability to invoke arbitiary events and define handlers to handle
+certain kind of events.
 
 Here is an example:
 ``` ruby
@@ -142,15 +204,19 @@ Events can be chained as above example shows.
 
 #### Default events for shell
 
-When a shell starts a `shell_start` event is invoked. Upon exit, a `shell_exit` event is invoked.
+When a shell starts a `shell_start` event is invoked. Upon exit, a
+`shell_exit` event is invoked.
 
 ### Colors
 
-Enabled colors in command handlers and usage output. Just call a function with the name of the color you want. Colors can also be disabled.
+Enabled colors in command handlers and usage output. Just call a
+function with the name of the color you want. Colors can also be
+disabled.
 
-### Customizable banner and prompt for shell 
+### Customizable banner and prompt for shell
 
-The shell action now allows you to configure the banner displayed in the beginning and define a method to build the prompt.
+The shell action now allows you to configure the banner displayed in the
+beginning and define a method to build the prompt.
 
 ## Backward incompatible changes
 
@@ -160,7 +226,8 @@ The shell action can only be used in the base command config.
 
 ### Partial templated
 
-Templates are reused to build help doc by incorporation of partial erb templating.
+Templates are reused to build help doc by incorporation of partial erb
+templating.
 
 ### Improve default prompt
 

data/README.md

@@ -72,9 +72,7 @@ cli.execute(ARGV)
 ```
 
 Here is a screen capture of this script in action:
-![greet script demo]
-(https://raw.githubusercontent.com/anshulverma/cliqr/master/screenshots/greet.gif
- "Binary tree example")
+![greet script demo](https://goo.gl/sJgxFX "Binary tree example")
 
 ## Installation
 

data/lib/cliqr/command/command_context.rb

@@ -3,6 +3,8 @@
 require 'cliqr/command/color'
 require 'cliqr/command/argument_operator_context'
 require 'cliqr/events/invoker'
+require 'cliqr/command/output/standard_output_stream'
+require 'cliqr/command/output/file_output_stream'
 
 module Cliqr
   # Definition and builder for command context
@@ -53,7 +55,7 @@ module Cliqr
       # Initialize the command context (called by the CommandContextBuilder)
       #
       # @return [Cliqr::Command::CommandContext]
-      def initialize(config, options, arguments, environment, executor)
+      def initialize(config, options, arguments, environment, executor, output_stream)
         super(config)
 
         @config = config
@@ -64,6 +66,7 @@ module Cliqr
         @environment = environment
         @executor = executor
         @event_invoker = Events::Invoker.new(config, self)
+        @output_stream = output_stream
 
         # make option map from array
         @options = Hash[*options.collect { |option| [option.name, option] }.flatten]
@@ -162,7 +165,14 @@ module Cliqr
       # @return [Cliqr::Command::CommandContext]
       def root(environment_type = nil)
         environment_type = @environment if environment_type.nil?
-        CommandContext.new(@config.root, [], [], environment_type, @executor)
+        CommandContext.new(@config.root, [], [], environment_type, @executor, @output_stream)
+      end
+
+      # Override the default puts implementation to enable output buffering
+      #
+      # @return [Nothing]
+      def puts(message)
+        @output_stream.write(message)
       end
 
       private :initialize, :default
@@ -201,7 +211,22 @@ module Cliqr
                            option_contexts,
                            @parsed_input.arguments,
                            @options[:environment],
-                           @executor
+                           @executor,
+                           build_output_stream(@options)
+      end
+
+      private
+
+      # Build a output stream object to be used in the command handler
+      #
+      # @return [OutputStream]
+      def build_output_stream(options)
+        case options[:output]
+        when :file
+          Command::Output::FileOutputStream.new
+        else
+          Command::Output::StandardOutputStream.new
+        end
       end
     end
 

data/lib/cliqr/command/output/file_output_stream.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Cliqr
+  module Command
+    module Output
+      # Write output to a file
+      #
+      # @api private
+      class FileOutputStream
+        # Write to a file and flush the stream
+        #
+        # @return [Nothing]
+        def write(message)
+          puts message
+          $stdout.flush
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/command/output/standard_output_stream.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Cliqr
+  module Command
+    # Control how output is written out to the stream
+    #
+    # @api private
+    module Output
+      # Standard output stream writer
+      class StandardOutputStream
+        # Write a message directly to the output stream
+        #
+        # @return [Nothing]
+        def write(message)
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/command/shell_command.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'readline'
+
 module Cliqr
   # @api private
   module Command
@@ -20,12 +22,12 @@ module Cliqr
 
         root_context = context.root(:shell)
 
-        puts banner(root_context, build_proc(@shell_config.banner))
+        context.puts banner(root_context, build_proc(@shell_config.banner))
 
         context.invoke(:shell_start)
         exit_code = build_runner(context, root_context).run
         context.invoke(:shell_stop)
-        puts "shell exited with code #{exit_code}"
+        context.puts "shell exited with code #{exit_code}"
         exit_code
       end
 
@@ -105,20 +107,21 @@ module Cliqr
         return if command.empty?
         action_name = command.split(' ').first
         unless @context.action?(action_name)
-          puts "unknown action \"#{action_name}\""
+          @context.puts "unknown action \"#{action_name}\""
           return Cliqr::Executor::ExitCode.code(nil)
         end
         @context.forward("#{@base_command} #{command}", :environment => @context.environment)
       rescue StandardError => e
-        puts e.message
+        @context.puts e.message
       end
 
       # Show a prompt and ask for input
       #
       # @return [String]
       def prompt
-        print @context.instance_eval(&@prompt)
-        $stdin.gets.chomp
+        Readline.input = $stdin
+        Readline.output = $stdout
+        Readline.readline(@context.instance_eval(&@prompt), true)
       end
     end
   end

data/lib/cliqr/executor/command_runner_factory.rb

@@ -16,13 +16,10 @@ module Cliqr
       # @return [Cliqr::Executor::BufferedCommandRunner] If command's output needs to be buffered
       def self.get(**options)
         case options[:output]
-        when :default
-          StandardCommandRunner.new
         when :buffer
           BufferedCommandRunner.new
         else
-          fail Cliqr::Error::UnknownCommandRunnerException,
-               'cannot find a command runner for the given options'
+          StandardCommandRunner.new
         end
       end
     end

data/lib/cliqr/util.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'shellwords'
 require 'cliqr/command/shell_command'
 
 module Cliqr
@@ -137,9 +138,9 @@ module Cliqr
     def self.sanitize_args(args, config = nil)
       sanitized = []
       if args.is_a?(Array)
-        args.each { |arg| sanitized.concat(sanitize_args(arg)) }
+        sanitized = args
       elsif args.is_a?(String)
-        sanitized = args.split(' ')
+        sanitized = Shellwords.shellwords(args)
       end
       remove_base_command(sanitized, config)
     end

data/lib/cliqr/version.rb

@@ -2,5 +2,5 @@
 
 # Versioned gem
 module Cliqr
-  VERSION = '2.0.0'
+  VERSION = '2.1.1'
 end

data/spec/executor/color_executor_spec.rb

@@ -67,7 +67,7 @@ describe Cliqr::Command::Color do
         end
       end
     end
-    result = cli.execute_internal ['my-command foo'], output: :buffer
+    result = cli.execute_internal %w(my-command foo), output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 \e[31mthis should be colorized in red\e[0m
     EOS
@@ -98,7 +98,7 @@ this should not be colorized
         end
       end
     end
-    result = cli.execute_internal ['my-command foo'], output: :buffer
+    result = cli.execute_internal %w(my-command foo), output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 this should not be colorized
     EOS
@@ -117,7 +117,7 @@ this should not be colorized
         end
       end
     end
-    result = cli.execute_internal ['my-command foo bar'], output: :buffer
+    result = cli.execute_internal %w(my-command foo bar), output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 this should not be colorized
     EOS

data/spec/executor/command_runner_spec.rb

@@ -14,8 +14,7 @@ describe Cliqr::Executor::CommandRunnerFactory do
   end
 
   it 'throws error for default output type' do
-    expect { Cliqr::Executor::CommandRunnerFactory.get(output: :unknown) }.to(
-      raise_error(be_kind_of(Cliqr::Error::UnknownCommandRunnerException))
-    )
+    runner = Cliqr::Executor::CommandRunnerFactory.get(output: :unknown)
+    expect(runner).to be_kind_of(Cliqr::Executor::StandardCommandRunner)
   end
 end

data/spec/executor/event_executor_spec.rb

@@ -162,7 +162,7 @@ Time
         end
       end
     end
-    result = cli.execute_internal ['my-command my_action'], output: :buffer
+    result = cli.execute_internal 'my-command my_action', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked action
 invoked bar : my-command my_action : a : 1
@@ -198,7 +198,7 @@ action ending
         end
       end
     end
-    result = cli.execute_internal ['my-command my_action'], output: :buffer
+    result = cli.execute_internal 'my-command my_action', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked bar : my-command my_action : a : 1
 invoked foo : my-command my_action : b : 2 : {:t=>1}
@@ -256,16 +256,16 @@ bar
         end
       end
     end
-    result = cli.execute_internal ['my-command'], output: :buffer
+    result = cli.execute_internal 'my-command', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked first : my-command : a : 1
     EOS
-    result = cli.execute_internal ['my-command foo'], output: :buffer
+    result = cli.execute_internal 'my-command foo', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked second : my-command foo : b : 2
 invoked second : my-command foo : b : 2
     EOS
-    result = cli.execute_internal ['my-command foo bar'], output: :buffer
+    result = cli.execute_internal 'my-command foo bar', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked first : my-command foo bar : b : 2
 invoked first : my-command foo bar : b : 2
@@ -273,7 +273,7 @@ invoked first : my-command foo bar : b : 2
 invoked third : my-command foo bar : d : 4
 invoked third : my-command foo bar : d : 4
     EOS
-    result = cli.execute_internal ['my-command foo baz'], output: :buffer
+    result = cli.execute_internal 'my-command foo baz', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked second : my-command foo baz : e : 5
 invoked second : my-command foo baz : e : 5
@@ -298,7 +298,7 @@ invoked second : my-command foo baz : e : 5
         end
       end
     end
-    result = cli.execute_internal ['my-command foo'], output: :buffer
+    result = cli.execute_internal %w(my-command foo), output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 should be invoked
     EOS
@@ -332,7 +332,7 @@ should be invoked
         option :abc
       end
     end
-    result = cli.execute_internal ['my-command my_action --opt val'], output: :buffer
+    result = cli.execute_internal 'my-command my_action --opt val', output: :buffer
     expect(result[:stdout]).to eq <<-EOS
 invoked bar
 true

data/spec/executor/executor_spec.rb

@@ -491,6 +491,34 @@ back in action_1
     EOS
   end
 
+  it 'can forward command with space in arguments' do
+    cli = Cliqr.interface do
+      name :my_command
+
+      action :foo do
+        handler do
+          forward 'bar --opt1 "simple value" --opt2 "a question"?'
+        end
+      end
+
+      action :bar do
+        option :opt1
+        option :opt2
+
+        handler do
+          puts opt1
+          puts opt2
+        end
+      end
+    end
+
+    result = cli.execute_internal ['foo'], output: :buffer
+    expect(result[:stdout]).to eq <<-EOS
+simple value
+a question?
+    EOS
+  end
+
   describe 'error handling' do
     it 'returns 0 if no error' do
       cli = Cliqr.interface do

data/spec/shell/shell_executor_spec.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'tempfile'
+
 require 'spec_helper'
 
 require 'fixtures/test_command'
@@ -25,40 +27,40 @@ describe Cliqr::Command::ShellCommand do
       end
     end
 
-    with_input(%w(help -h)) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+    with_input_output(%w(help -h)) do |output|
+      cli.execute_internal %w(my-command shell), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ help.
-my-command -- this is a test command
-
-Available actions:
-[ Type "help [action-name]" to get more information about that action ]
-
-    foo -- the foo action
-    bar -- bar command
-    help -- The help action for command "my-command" which provides details and usage information on how to use the command.
+my-command -- this is a test command.
+.
+Available actions:.
+[ Type "help [action-name]" to get more information about that action ].
+.
+    foo -- the foo action.
+    bar -- bar command.
+    help -- The help action for command "my-command" which provides details and usage information on how to use the command..
 [my-command][2] $ -h.
-unknown action "-h"
+unknown action "-h".
 [my-command][3] $ exit.
-shell exited with code 0
+shell exited with code 0.
       EOS
     end
 
-    with_input(['help bar']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+    with_input_output(['help bar']) do |output|
+      cli.execute_internal %w(my-command shell), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][4] $ help bar.
-my-command bar -- bar command
-
-Available actions:
-[ Type "help [action-name]" to get more information about that action ]
-
-    baz
-    help -- The help action for command "my-command bar" which provides details and usage information on how to use the command.
+my-command bar -- bar command.
+.
+Available actions:.
+[ Type "help [action-name]" to get more information about that action ].
+.
+    baz.
+    help -- The help action for command "my-command bar" which provides details and usage information on how to use the command..
 [my-command][5] $ exit.
-shell exited with code 0
+shell exited with code 0.
       EOS
     end
   end
@@ -75,20 +77,20 @@ shell exited with code 0
       end
     end
 
-    with_input(%w(help)) do
-      result = cli.execute_internal %w(my-command custom-shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+    with_input_output(%w(help)) do |output|
+      cli.execute_internal %w(my-command custom-shell), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ help.
-my-command -- this is a test command
-
-Available actions:
-[ Type "help [action-name]" to get more information about that action ]
-
-    help -- The help action for command "my-command" which provides details and usage information on how to use the command.
-    custom-shell -- this is a custom shell
+my-command -- this is a test command.
+.
+Available actions:.
+[ Type "help [action-name]" to get more information about that action ].
+.
+    help -- The help action for command "my-command" which provides details and usage information on how to use the command..
+    custom-shell -- this is a custom shell.
 [my-command][2] $ exit.
-shell exited with code 0
+shell exited with code 0.
       EOS
     end
   end
@@ -118,29 +120,29 @@ shell exited with code 0
       end
     end
 
-    with_input(['', 'my-command', 'foo', 'foo bar', 'foo bar --opt yes', 'foo bar help']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+    with_input_output(['', 'my-command', 'foo', 'foo bar', 'foo bar --opt yes', 'foo bar help']) do |output|
+      cli.execute_internal %w(my-command shell), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ .
 [my-command][2] $ my-command.
-unknown action "my-command"
+unknown action "my-command".
 [my-command][3] $ foo.
-foo executed
+foo executed.
 [my-command][4] $ foo bar.
-bar executed
+bar executed.
 [my-command][5] $ foo bar --opt yes.
-bar executed
-option: yes
+bar executed.
+option: yes.
 [my-command][6] $ foo bar help.
-my-command foo bar
-
-Available actions:
-[ Type "help [action-name]" to get more information about that action ]
-
-    help -- The help action for command "my-command foo bar" which provides details and usage information on how to use the command.
+my-command foo bar.
+.
+Available actions:.
+[ Type "help [action-name]" to get more information about that action ].
+.
+    help -- The help action for command "my-command foo bar" which provides details and usage information on how to use the command..
 [my-command][7] $ exit.
-shell exited with code 0
+shell exited with code 0.
       EOS
     end
   end
@@ -170,20 +172,20 @@ shell exited with code 0
       end
     end
 
-    with_input(['unknown', '--opt-1 val', 'foo']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+    with_input_output(['unknown', '--opt-1 val', 'foo']) do |output|
+      cli.execute_internal %w(my-command shell), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ unknown.
-unknown action "unknown"
+unknown action "unknown".
 [my-command][2] $ --opt-1 val.
-unknown action "--opt-1"
+unknown action "--opt-1".
 [my-command][3] $ foo.
-command 'my-command foo' failed
-
-Cause: StandardError - I failed!
+command 'my-command foo' failed.
+.
+Cause: StandardError - I failed!.
 [my-command][4] $ exit.
-shell exited with code 0
+shell exited with code 0.
       EOS
     end
   end
@@ -249,41 +251,41 @@ shell exited with code 0
       end
     end
 
-    with_input(['']) do
-      result = cli.execute_internal %w(my-command shell -f qwerty --no-bar), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-shell started
-true
-qwerty
-true
-false
-false
-10
-base: shell started
-true
-qwerty
-true
-false
-false
-10
+    with_input_output(['']) do |output|
+      cli.execute_internal %w(my-command shell -f qwerty --no-bar), output: :file
+      expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ .
 [my-command][2] $ exit.
-shell stopped
-true
-qwerty
-true
-false
-false
-10
-base: shell stopped
-true
-qwerty
-true
-false
-false
-10
-shell exited with code 0
+shell started.
+true.
+qwerty.
+true.
+false.
+false.
+10.
+base: shell started.
+true.
+qwerty.
+true.
+false.
+false.
+10.
+shell stopped.
+true.
+qwerty.
+true.
+false.
+false.
+10.
+base: shell stopped.
+true.
+qwerty.
+true.
+false.
+false.
+10.
+shell exited with code 0.
       EOS
     end
   end
@@ -310,16 +312,16 @@ shell exited with code 0
         end
       end
 
-      with_input(['shell']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['shell']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ shell.
-command 'my-command shell' failed
-
-Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell
+command 'my-command shell' failed.
+.
+Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell.
 [my-command][2] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -338,16 +340,16 @@ shell exited with code 0
         raise_error(Cliqr::Error::CommandRuntimeError,
                     "command 'my-command foo' failed\n\nCause: Cliqr::Error::IllegalArgumentError - no arguments allowed for default help action\n"))
 
-      with_input(['foo shell']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['foo shell']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ foo shell.
-command 'my-command foo' failed
-
-Cause: Cliqr::Error::IllegalArgumentError - no arguments allowed for default help action
+command 'my-command foo' failed.
+.
+Cause: Cliqr::Error::IllegalArgumentError - no arguments allowed for default help action.
 [my-command][2] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -369,16 +371,16 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['', '', 'foo']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 test-prompt $ .
 test-prompt $ .
 test-prompt $ foo.
-foo executed
+foo executed.
 test-prompt $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -402,17 +404,17 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo', '']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['', '', 'foo', '']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 my-command [1]$ .
 my-command [2]$ .
 my-command [3]$ foo.
-foo executed
+foo executed.
 my-command [4]$ .
 my-command [5]$ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -432,17 +434,17 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo', '']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['', '', 'foo', '']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 test-prompt [1] > .
 test-prompt [2] > .
 test-prompt [3] > foo.
-foo executed
+foo executed.
 test-prompt [4] > .
 test-prompt [5] > exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -460,17 +462,17 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo', '']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+      with_input_output(['', '', 'foo', '']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ .
 [my-command][2] $ .
 [my-command][3] $ foo.
-foo executed
+foo executed.
 [my-command][4] $ .
 [my-command][5] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -490,20 +492,20 @@ shell exited with code 0
           end
         end
 
-        with_input(['unknown', '--opt-1 val', 'foo']) do
-          result = cli.execute_internal %w(my-command shell), output: :buffer
-          expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+        with_input_output(['unknown', '--opt-1 val', 'foo']) do |output|
+          cli.execute_internal %w(my-command shell), output: :file
+          expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 [my-command][1] $ unknown.
-unknown action "unknown"
+unknown action "unknown".
 [my-command][2] $ --opt-1 val.
-unknown action "--opt-1"
+unknown action "--opt-1".
 [my-command][3] $ foo.
-command 'my-command foo' failed
-
-Cause: StandardError - I failed!
+command 'my-command foo' failed.
+.
+Cause: StandardError - I failed!.
 [my-command][4] $ exit.
-shell exited with code 0
+shell exited with code 0.
           EOS
         end
       end
@@ -526,20 +528,20 @@ shell exited with code 0
           end
         end
 
-        with_input(['unknown', '--opt-1 val', 'foo']) do
-          result = cli.execute_internal %w(my-command shell), output: :buffer
-          expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+        with_input_output(['unknown', '--opt-1 val', 'foo']) do |output|
+          cli.execute_internal %w(my-command shell), output: :file
+          expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 test-prompt [1] > unknown.
-unknown action "unknown"
+unknown action "unknown".
 test-prompt [2] > --opt-1 val.
-unknown action "--opt-1"
+unknown action "--opt-1".
 test-prompt [3] > foo.
-command 'my-command foo' failed
-
-Cause: StandardError - I failed!
+command 'my-command foo' failed.
+.
+Cause: StandardError - I failed!.
 test-prompt [4] > exit.
-shell exited with code 0
+shell exited with code 0.
           EOS
         end
       end
@@ -564,20 +566,20 @@ shell exited with code 0
           end
         end
 
-        with_input(['unknown', '--opt-1 val', 'foo']) do
-          result = cli.execute_internal %w(my-command shell), output: :buffer
-          expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
+        with_input_output(['unknown', '--opt-1 val', 'foo']) do |output|
+          cli.execute_internal %w(my-command shell), output: :file
+          expect(output.call).to eq <<-EOS
+Starting shell for command "my-command".
 green prompt > unknown.
-unknown action "unknown"
+unknown action "unknown".
 green prompt > --opt-1 val.
-unknown action "--opt-1"
+unknown action "--opt-1".
 green prompt > foo.
-command 'my-command foo' failed
-
-Cause: StandardError - I failed!
+command 'my-command foo' failed.
+.
+Cause: StandardError - I failed!.
 green prompt > exit.
-shell exited with code 0
+shell exited with code 0.
           EOS
         end
       end
@@ -600,16 +602,16 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Welcome to my-command!!!
+      with_input_output(['', '', 'foo']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+Welcome to my-command!!!.
 [my-command][1] $ .
 [my-command][2] $ .
 [my-command][3] $ foo.
-foo executed
+foo executed.
 [my-command][4] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -631,17 +633,17 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo', '']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-welcome to my-command
+      with_input_output(['', '', 'foo', '']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+welcome to my-command.
 [my-command][1] $ .
 [my-command][2] $ .
 [my-command][3] $ foo.
-foo executed
+foo executed.
 [my-command][4] $ .
 [my-command][5] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
@@ -661,40 +663,43 @@ shell exited with code 0
         end
       end
 
-      with_input(['', '', 'foo', '']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-welcome to the command my-command
+      with_input_output(['', '', 'foo', '']) do |output|
+        cli.execute_internal %w(my-command shell), output: :file
+        expect(output.call).to eq <<-EOS
+welcome to the command my-command.
 [my-command][1] $ .
 [my-command][2] $ .
 [my-command][3] $ foo.
-foo executed
+foo executed.
 [my-command][4] $ .
 [my-command][5] $ exit.
-shell exited with code 0
+shell exited with code 0.
         EOS
       end
     end
   end
 end
 
-def with_input(lines, &block)
+def with_input_output(lines, &block)
   old_stdin = $stdin
-  $stdin = TestIO.new(lines)
-  block.call
-ensure
-  $stdin = old_stdin
-end
-
-# A test class for wrapping stdin
-class TestIO
-  def initialize(lines)
-    @lines = lines.reverse
+  old_stdout = $stdout
+  input_file = Tempfile.new('cliqr').tap do |file|
+    lines.push('exit').each { |line| file.write("#{line}\n") }
   end
-
-  def gets
-    input = "#{@lines.length > 0 ? @lines.pop : 'exit'}"
-    puts "#{input}."
-    "#{input}\n"
+  output_file = Tempfile.new('cliqr')
+  begin
+    $stdin = input_file.open
+    $stdout = output_file.open
+    output_getter = proc  do
+      IO.read(output_file.path).gsub(/(.*)\n/, "\\1.\n")
+    end
+    block.call(output_getter)
+  ensure
+    $stdin = old_stdin
+    $stdout = old_stdout
+    input_file.close
+    output_file.close
+    input_file.unlink
+    output_file.unlink
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliqr
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -68,6 +68,8 @@ files:
 - lib/cliqr/command/base_command.rb
 - lib/cliqr/command/color.rb
 - lib/cliqr/command/command_context.rb
+- lib/cliqr/command/output/file_output_stream.rb
+- lib/cliqr/command/output/standard_output_stream.rb
 - lib/cliqr/command/shell_banner_builder.rb
 - lib/cliqr/command/shell_command.rb
 - lib/cliqr/command/shell_prompt_builder.rb