wip-runner 0.3.4 → 0.4.0

data/lib/wip/runner/spec/helpers/matchers.rb

@@ -1,17 +1,19 @@
 module WIP
   module Runner::Spec
     module Helpers::Matchers
+      # TODO: fix the following message:
+      # expected block to not STDCOMBINED to receive the following content (partial match):, but output "- VARIABLE:  |value from ENV|\n\necho $VARIABLE\n\n> value from user"
       def show(expected, options = {})
-        output = options[:output] || :highline
-        match  = options[:match]  || :full # :match => [:full | :partial]
-        ShowMatcher.new(self, strip_heredoc(expected).strip, output, match).send(:"to_#{output}")
+        stream = options[:to]    || :combined # :to    => [:out | :err]
+        match  = options[:match] || :full     # :match => [:full | :partial]
+        ShowMatcher.new(self, strip_heredoc(expected).strip, stream, match)
       end
 
       class ShowMatcher < RSpec::Matchers::BuiltIn::Output
-        def initialize(example, expected, output, match)
+        def initialize(example, expected, stream, match)
           super(expected)
           @example = example
-          @output  = output
+          @stream  = stream
           @match   = match
         end
 
@@ -20,13 +22,8 @@ module WIP
           return false unless Proc === block
 
           @expected = @expected.strip
-
-          if @output == :highline
-            @actual = @stream_capturer.capture(@example.io, block)
-            @actual = @example.strip_heredoc(@actual).strip
-          else
-            @actual = @stream_capturer.capture(block).strip
-          end
+          @actual = Capturer.capture(@example.ui, @stream, block)
+          @actual = @example.strip_heredoc(@actual).strip
 
           if @match == :partial
             values_match?(/#{Regexp.escape(@expected)}/, @actual)
@@ -36,7 +33,7 @@ module WIP
         end
 
         def description
-          "#{@stream_capturer.name} to receive the following content (#{@match} match):"
+          "STD#{@stream.upcase} to receive the following content (#{@match} match):"
         end
 
         def failure_message
@@ -49,28 +46,33 @@ module WIP
           ].join("\n\n")
         end
 
-        def to_highline
-          @stream_capturer = CaptureHighline
-          self
-        end
-
         # @private
-        module CaptureHighline
-          def self.name
-            'highline'
-          end
+        module Capturer
+          def self.capture(ui, stream, block)
+            captured = StringIO.new
 
-          def self.capture(io, block)
-            captured_stream = StringIO.new
+            mappings = {}.tap do |h|
+              if stream == :combined
+                out = ui.send(:out)
+                err = ui.send(:err)
+                h[out] = out.instance_variable_get(:'@output')
+                h[err] = err.instance_variable_get(:'@output')
+              else
+                io = ui.send(stream)
+                h[io] = io.instance_variable_get(:'@output')
+              end
+            end
 
-            original_stream = io.instance_variable_get(:'@output')
-            io.instance_variable_set(:'@output', captured_stream)
+            mappings.each do |io, original|
+              io.instance_variable_set(:'@output', captured)
+            end
 
             block.call
-
-            captured_stream.string
+            captured.string
           ensure
-            io.instance_variable_set(:'@output', captured_stream)
+            mappings.each do |io, original|
+              io.instance_variable_set(:'@output', original)
+            end
           end
         end
       end

data/lib/wip/runner/spec/helpers/string_helpers.rb

@@ -2,7 +2,7 @@ module WIP
   module Runner::Spec
     module Helpers::StringHelpers
       def strip_heredoc(string)
-        indent = string.scan(/^[ \t]*(?=\S)/).min.size || 0
+        indent = (string.scan(/^[ \t]*(?=\S)/).min || '').size || 0
         string.gsub(/^[ \t]{#{indent}}/, '')
       end
     end

data/lib/wip/runner/spec/helpers/ui_helpers.rb

@@ -0,0 +1,93 @@
+module WIP
+  module Runner::Spec
+    module Helpers::UIHelpers
+      def ui
+        @ui ||= CustomUI.new($stdin, StringIO.new, StringIO.new)
+      end
+
+      def simulate(pairs = nil)
+        unless pairs.nil?
+          @simulated = pairs.inject(@simulated || []) do |memo, pair|
+            memo << pair ; memo
+          end
+        end
+
+        if block_given?
+          highline = ui.err
+          original = highline.instance_variable_get(:@input)
+
+          begin
+            if @simulated
+              keys      = @simulated.map { |pair| pair[0] }
+              values    = @simulated.map { |pair| pair[1] }
+              simulator = Simulator.new(values, (@simulated[0][0] == '*'))
+              highline.instance_variable_set(:@input, simulator)
+
+              keys.each do |question|
+                # NOTE: the "|default|" is stripped because that is added
+                # later by the Question instance, in time for a call to #say.
+                if question.is_a?(Array)
+                  expect(highline).to receive(:ask)
+                    .with(*question)
+                    .and_call_original
+                else
+                  question = question.sub(/:\s\|.*\Z/, ': ')
+                  expect(highline).to receive(:ask)
+                    .with(question)
+                    .and_call_original
+                end unless question == '*'
+              end
+            end
+
+            yield
+          ensure
+            highline.instance_variable_set(:@input, original)
+          end
+        end
+      end
+
+      private
+
+      class CustomUI < WIP::Runner::UI
+        def initialize(input, out, err)
+          @out = CustomLine.new(input, out, nil, nil, 2, 0)
+          @err = CustomLine.new(input, err, nil, nil, 2, 0)
+        end
+      end
+
+      class CustomLine < HighLine
+        # Strips the same-line indicating, trailing space from questions in order
+        # to print the newline in specs (that would come from user input).
+        def ask(question, answer_type = String, &block)
+          super("#{question.rstrip}", answer_type, &block)
+        end
+
+        # Strips double spaces between question and default.
+        def say(statement)
+          super(statement.to_s.gsub(/:\s{2,}\|/, ': |'))
+        end
+
+        # Strips formatting for specs.
+        def color(string, *colors)
+          string
+        end
+      end
+
+      # adapted from https://gist.github.com/194554
+      class Simulator
+        def initialize(values, all = false)
+          @values = values.map { |s| s.nil? ? '' : s }
+          @all    = all
+        end
+
+        def gets
+          @all ? @values.first : @values.shift
+        end
+
+        def eof?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/wip/runner/spec/helpers.rb

@@ -10,6 +10,6 @@ Dir[File.expand_path('../helpers/*.rb', __FILE__)].each { |f| require(f) }
 RSpec.configure do |config|
   config.include WIP::Runner::Spec::Helpers::Matchers
   config.include WIP::Runner::Spec::Helpers::CommandHelpers
-  config.include WIP::Runner::Spec::Helpers::IOHelpers
+  config.include WIP::Runner::Spec::Helpers::UIHelpers
   config.include WIP::Runner::Spec::Helpers::StringHelpers
 end

data/lib/wip/runner/ui.rb

@@ -0,0 +1,65 @@
+require 'highline'
+
+module WIP
+  module Runner
+    class UI
+      def initialize(input = $stdin, out = $stdout, err = $stderr)
+        @out    = HighLine.new(input, out, nil, nil, 2, 0)
+        @err    = HighLine.new(input, err, nil, nil, 2, 0)
+        @output = @out
+      end
+
+      def err
+        if block_given?
+          current = @output
+          @output = @err
+          result  = yield
+          @output = current
+          result
+        else
+          @err
+        end
+      end
+
+      def out
+        if block_given?
+          current = @output
+          @output = @out
+          result  = yield
+          @output = current
+          result
+        else
+          @out
+        end
+      end
+
+      def indent(*args, &block)
+        increase = args.shift || 1
+        @out.indent_level += increase
+        @err.indent_level += increase
+        @output.indent(0, *args, &block)
+        @out.indent_level -= increase
+        @err.indent_level -= increase
+      end
+
+      def indent_level=(level)
+        @out.indent_level = level
+        @err.indent_level = level
+      end
+
+      protected
+
+      def method_missing(method_name, *args, &block)
+        if @output.respond_to?(method_name)
+          @output.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @output.respond_to?(method_name) || super
+      end
+    end
+  end
+end

data/lib/wip/runner/version.rb

@@ -1,5 +1,5 @@
 module WIP
   module Runner
-    VERSION = "0.3.4"
+    VERSION = "0.4.0"
   end
 end