wip-runner 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8f7fdd233900ac935e1492c5ef16ef340d756fe
-  data.tar.gz: 756bd8a5e381d1f900a84fd55d73938dfe3af8d8
+  metadata.gz: c64b6f78c5e647a9466ebd60985ac716ded1bf9f
+  data.tar.gz: ef987404e179109f39e0d70bef78b7926428b21f
 SHA512:
-  metadata.gz: 37196795a5842d7ce08156966f06ec70a7bc1ce58f24ea63fc0a71c395d6785f28b1c793f255bae6710c22712c6b7951242bb10619b347d9dedd39fb5a037079
-  data.tar.gz: 68888b0d5f1219e261b5f7665a9f77d4af3f0796ac3b74f4695f5598678be3ca6c3a1da0626e2e9f40b999f76457b2ab97deb8e92eb9ed360d9b5d3429887593
+  metadata.gz: 289d7586526bc1634e9303ddd1d9dde0b4110f1434fd270e059b1a7ab35af9c4407efef24bc14739bc598d5d13a806c79bc355cefd3f8d896cf7b36dd5333235
+  data.tar.gz: df6f588f1eac45e2e11567812981b36e96162cc3c1b5e95cd68a4a3eeed741980d1a27250fa5fe14021a12362d42fd56fdc2925f81214088a5c2e30b3d162ef8

data/lib/wip/runner/renderers/erb.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module WIP
+  module Runner
+    module Renderers
+      module ERB
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def render(template, context)
+          if (file = File.join("#{self.class.templates}/#{template}.erb")) && File.exist?(file)
+            template = File.read(file)
+          end
+          ::ERB.new(clean(template)).result(context)
+        end
+
+        def clean(string)
+          return if string.nil?
+
+          indent = (string.scan(/^[ \t]*(?=\S)/).min || '').size
+          string.gsub(/^[ \t]{#{indent}}/, '').strip
+        end
+
+        module ClassMethods
+          def templates(value = nil)
+            @templates = value unless value.nil?
+            @templates
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wip/runner/renderers.rb

@@ -0,0 +1,7 @@
+module WIP
+  module Runner
+    module Renderers ; end
+  end
+end
+
+Dir[File.expand_path('../renderers/*.rb', __FILE__)].each { |f| require(f) }

data/lib/wip/runner/shell/handlers/script.rb

@@ -15,9 +15,13 @@ module WIP
             super
           end
 
-          def description
-            @description ||= "```\n#{@content}\n```"
-            # @description ||= @content
+          def description(format = :text)
+            case format
+            when :markdown
+              "```\n#{@content}\n```"
+            else
+              @content
+            end
           end
 
           def execute(io, env, &block)

data/lib/wip/runner/shell/runner.rb

@@ -17,7 +17,13 @@ module WIP
           @arguments = arguments
           @options   = options
 
-          @io.indent do
+          if markdown?
+            @io.indent do
+              @tasks.each do |task|
+                evaluate(task)
+              end
+            end
+          else
             @tasks.each do |task|
               evaluate(task)
             end
@@ -41,8 +47,8 @@ module WIP
 
           task.shells.each do |shell|
             section("Shell #{shell.type.downcase}") do
-              @io.newline
               send(:"#{prefix}_shell", shell)
+              @io.newline
             end
           end
 
@@ -108,8 +114,20 @@ module WIP
         # ---
 
         def section(heading, &block)
-          @io.say "- [ ] #{heading}..."
-          @io.indent(&block)
+          if markdown?
+            @io.say "- [ ] #{heading}..."
+            @io.indent(&block)
+          else
+            yield
+          end
+        end
+
+        def format
+          @options.format ? @options.format.intern : :text
+        end
+
+        def markdown?
+          format == :markdown
         end
 
         # $ wip-runner x --format=markdown

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

@@ -0,0 +1,65 @@
+module WIP
+  module Runner::Spec
+    module Helpers::CommandHelpers
+      def define_command(&block)
+        klass = Class.new(WIP::Runner::Command)
+        klass.instance_exec do
+          def name
+            'Command'
+          end
+        end
+        klass.class_exec(&block)
+        klass
+      end
+
+      def example_command(implementation)
+        ExampleCommands.const_get(implementation).new(io)
+      end
+
+      module ExampleCommands
+        class Simple < WIP::Runner::Command
+          def execute(args, options)
+            @executed = true
+          end
+
+          def executed?
+            !! @executed
+          end
+        end
+
+        class WithOptions < Simple
+          options do |parser, config|
+            config.flagged = false
+
+            parser.on('-f', '--flag', 'Option 1') do
+              config.flagged = true
+            end
+          end
+
+          attr_reader :flagged
+
+          def execute(args, options)
+            super
+            @flagged = options.flagged
+          end
+        end
+
+        class WithArguments < Simple
+          argument :arg_01, { overview: 'Argument 1' }
+          argument :arg_02, { overview: 'Argument 2' }
+        end
+
+        class WithNested < Simple ; end
+
+        class WithNested::Nested < Simple
+          overview 'A nested command'
+
+          def execute(args, options)
+            super
+            @io.say 'running nested command...'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+module WIP
+  module Runner::Spec
+    module Helpers::IOHelpers
+      def io
+        @io ||= CustomHighLine.new
+      end
+
+      def simulate(pairs = nil)
+        unless pairs.nil?
+          @simulated = pairs.inject(@simulated || {}) do |memo, (q, a)|
+            memo[q] = a ; memo
+          end
+        end
+
+        if block_given?
+          begin
+            originput = io.instance_variable_get(:@input)
+            simulator = Simulator.new(@simulated.values, (@simulated.keys == ['*']))
+            io.instance_variable_set(:@input, simulator)
+
+            @simulated.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(io).to receive(:ask)
+                  .with(*question)
+                  .and_call_original
+              else
+                question = question.sub(/:\s\|.*\Z/, ': ')
+                expect(io).to receive(:ask)
+                  .with(question)
+                  .and_call_original
+              end unless question == '*'
+            end
+
+            yield
+          ensure
+            io.instance_variable_set(:@input, originput)
+          end
+        end
+      end
+
+      private
+
+      class CustomHighLine < 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)
+          # puts statement.to_s.inspect
+          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/matchers.rb

@@ -0,0 +1,79 @@
+module WIP
+  module Runner::Spec
+    module Helpers::Matchers
+      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}")
+      end
+
+      class ShowMatcher < RSpec::Matchers::BuiltIn::Output
+        def initialize(example, expected, output, match)
+          super(expected)
+          @example = example
+          @output  = output
+          @match   = match
+        end
+
+        def matches?(block)
+          @block = block
+          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
+
+          if @match == :partial
+            values_match?(/#{Regexp.escape(@expected)}/, @actual)
+          else
+            values_match?(@expected, @actual)
+          end
+        end
+
+        def description
+          "#{@stream_capturer.name} to receive the following content (#{@match} match):"
+        end
+
+        def failure_message
+          [
+            "expected #{description}",
+            "Expected:",
+            "#{@expected}\n",
+            "Actual:",
+            "#{@actual}\n\n"
+          ].join("\n\n")
+        end
+
+        def to_highline
+          @stream_capturer = CaptureHighline
+          self
+        end
+
+        # @private
+        module CaptureHighline
+          def self.name
+            'highline'
+          end
+
+          def self.capture(io, block)
+            captured_stream = StringIO.new
+
+            original_stream = io.instance_variable_get(:'@output')
+            io.instance_variable_set(:'@output', captured_stream)
+
+            block.call
+
+            captured_stream.string
+          ensure
+            io.instance_variable_set(:'@output', captured_stream)
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+module WIP
+  module Runner
+    module Spec
+      module Helpers ; end
+    end
+  end
+end
+
+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::StringHelpers
+end

data/lib/wip/runner/version.rb

@@ -1,5 +1,5 @@
 module WIP
   module Runner
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/wip/runner.rb

@@ -11,6 +11,7 @@ require 'wip/runner/cli/version'
 require 'wip/runner/shell'
 require 'wip/runner/workflow'
 require 'wip/runner/commands'
+require 'wip/runner/renderers'
 
 module WIP
   module Runner ; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wip-runner
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Corey Innis
@@ -95,6 +95,8 @@ files:
 - lib/wip/runner/errors.rb
 - lib/wip/runner/options.rb
 - lib/wip/runner/parser.rb
+- lib/wip/runner/renderers.rb
+- lib/wip/runner/renderers/erb.rb
 - lib/wip/runner/shell.rb
 - lib/wip/runner/shell/handlers.rb
 - lib/wip/runner/shell/handlers/base.rb
@@ -102,6 +104,11 @@ files:
 - lib/wip/runner/shell/handlers/system.rb
 - lib/wip/runner/shell/runner.rb
 - lib/wip/runner/shell/task.rb
+- lib/wip/runner/spec/helpers.rb
+- lib/wip/runner/spec/helpers/command_helpers.rb
+- lib/wip/runner/spec/helpers/io_helpers.rb
+- lib/wip/runner/spec/helpers/matchers.rb
+- lib/wip/runner/spec/helpers/string_helpers.rb
 - lib/wip/runner/version.rb
 - lib/wip/runner/workflow.rb
 - lib/wip/runner/workflow/builder.rb