wip-runner 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bb36ff238b91a06e9cb2788a7c2a5339dc8d2a6
-  data.tar.gz: 4d839159e03cd18ec8e50e7f97a60b2a4adb3b25
+  metadata.gz: 43076f87b14007f06ce003584c7cbe366170e629
+  data.tar.gz: ea94ff0e8cd0384b234f6921411178d8bc781875
 SHA512:
-  metadata.gz: 14a1d7b3f7c6051b0e07b6fe29954c29cc776bc2dd2f8004eaec9020ed093b9930822d163bfab026393fa2066fa05def72c2a1ece6f0d88783df2671a9230e1c
-  data.tar.gz: 51026c6b225deac5efab13f9e2578c91aa6070c9aa3f816b9406e33d693d232ce8175f2965378283fddea821dfbb614b9b801b2e263d2b46f182f7a956c02143
+  metadata.gz: 64247802ae56cdd2c96294c402e8e6aaf7183362ef0a97fad35b5910b0640855005ad81e29d84e3c68d2345e9beb9f4d5c803b9b2d43de721381773366549b97
+  data.tar.gz: bb3b9642aef06a98c988b32504e82ee03f9c79d9e66b8e41dce35a2fbe5525669e17d267452e861a8a40cf89d98a7157cd5441e7a09b8a6b961b03abe769567d

data/lib/wip/runner/cli/help.rb

@@ -18,9 +18,9 @@ module WIP
 
       def command_parser(params)
         command    = params.command
-        return CLI::Parser.new(@io) if command.nil?
+        return CLI::Parser.new(@ui) if command.nil?
 
-        Commands.locate(command).new(@io).parser
+        Commands.locate(command).new(@ui).parser
       end
     end
   end

data/lib/wip/runner/cli/version.rb

@@ -4,7 +4,9 @@ module WIP
       overview 'Prints version information'
 
       def execute(params, options)
-        @io.say "#{WIP::Runner::CLI.signature} version #{WIP::Runner::CLI.namespace::VERSION}"
+        @ui.out {
+          @ui.say("#{WIP::Runner::CLI.signature} version #{WIP::Runner::CLI.namespace::VERSION}")
+        }
       end
     end
   end

data/lib/wip/runner/cli.rb

@@ -1,5 +1,3 @@
-require 'highline'
-
 module WIP
   module Runner
     class CLI
@@ -40,10 +38,9 @@ module WIP
         end
       end
 
-      def initialize(io = HighLine.new)
-        @io     = io
-        @parser = Parser.new(io)
-
+      def initialize(ui = UI.new)
+        @ui     = ui
+        @parser = Parser.new(ui)
         trap('INT')  { quit }
         trap('TERM') { quit }
       end
@@ -57,8 +54,10 @@ module WIP
         recipient = (command(args) || @parser)
         recipient.run(args)
       rescue InvalidCommand => e
-        @io.say(e.message)
-        @io.newline
+        @ui.err {
+          @ui.say(e.message)
+          @ui.newline
+        }
         @parser.help
       end
 
@@ -66,12 +65,12 @@ module WIP
 
       def command(args)
         handler = Commands.locate(args.shift)
-        handler.nil? ? nil : handler.new(@io)
+        handler.nil? ? nil : handler.new(@ui)
       end
 
       class Parser
-        def initialize(io)
-          @io = io
+        def initialize(ui)
+          @ui = ui
         end
 
         def run(args)
@@ -80,7 +79,9 @@ module WIP
         end
 
         def help
-          @io.say(options.help)
+          @ui.err {
+            @ui.say(options.help)
+          }
         end
 
         private
@@ -106,7 +107,9 @@ module WIP
             parser.separator 'Options:'
 
             parser.on_tail '-h', '--help', 'Prints help messages' do
-              @io.say(parser)
+              @ui.err {
+                @ui.say(parser)
+              }
             end
           end
         end

data/lib/wip/runner/command.rb

@@ -45,9 +45,9 @@ module WIP
 
       attr_reader :parser # TODO(?)... :arguments, :options
 
-      def initialize(io)
-        @io     = io
-        @parser = WIP::Runner::Parser.new(@io, self.class)
+      def initialize(ui)
+        @ui     = ui
+        @parser = WIP::Runner::Parser.new(@ui, self.class)
       end
 
       def run(argv = [])
@@ -82,7 +82,7 @@ module WIP
       def validate!(arguments)
         unless parser.arguments.empty? || parser.config.no_validate
           missing = parser.arguments.keys.inject({}) do |memo, key|
-            memo[key] = nil if arguments[key].nil?
+            memo[key] = nil if arguments[key].nil? || arguments[key].empty?
             memo
           end
           raise InvalidArguments, missing unless missing.empty?
@@ -92,13 +92,15 @@ module WIP
       private
 
       def delegate(command, argv)
-        target = Commands.locate(command, self.class).new(@io)
+        target = Commands.locate(command, self.class).new(@ui)
         target.run(argv)
       end
 
       def print_error(e)
-        @io.say(e.message)
-        @io.newline
+        @ui.err {
+          @ui.say(e.message)
+          @ui.newline
+        }
         parser.help
       end
     end

data/lib/wip/runner/options.rb

@@ -3,6 +3,10 @@ require 'ostruct'
 module WIP
   module Runner
     class Options < OpenStruct
+      def to_hash
+        self.to_h
+      end
+
       def each(&block)
         self.to_h.each(&block)
       end
@@ -14,6 +18,10 @@ module WIP
       def values
         self.to_h.values
       end
+
+      def merge(other)
+        Options.new(self.to_h.merge(other.to_h))
+      end
     end
   end
 end

data/lib/wip/runner/parser.rb

@@ -5,8 +5,8 @@ module WIP
     class Parser
       attr_reader :config
 
-      def initialize(io, command)
-        @io      = io
+      def initialize(ui, command)
+        @ui      = ui
         @command = command
         @config  = WIP::Runner::Options.new
       end
@@ -21,7 +21,12 @@ module WIP
 
           @args = WIP::Runner::Options.new.tap do |opts|
             arguments.keys.each_with_index do |key, index|
-              opts[key] = remaining[index]
+              if arguments[key].multiple
+                opts[key] = remaining[index..-1]
+                break
+              else
+                opts[key] = remaining[index]
+              end
             end
           end
 
@@ -30,7 +35,9 @@ module WIP
       end
 
       def help
-        @io.say(options.help)
+        @ui.err {
+          @ui.say(options.help)
+        }
       end
 
       def options
@@ -87,6 +94,7 @@ module WIP
           pairs.each do |name, definition|
             padding   = ' ' * (parser.summary_width - name.length + 1)
             overview  = definition[:overview]
+            overview << ' [multiple]' if definition[:multiple]
             parser.separator [parser.summary_indent, name, padding, overview].join('')
           end
         end

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

@@ -10,8 +10,13 @@ module WIP
             instance_exec(&block) if block_given?
           end
 
-          def description
-            raise NotImplementedError
+          def content(format = :text)
+            case format
+            when :markdown
+              "```\n#{@content}\n```"
+            else
+              @content
+            end
           end
 
           def execute(io, env, &block)

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

@@ -15,17 +15,8 @@ module WIP
             super
           end
 
-          def description(format = :text)
-            case format
-            when :markdown
-              "```\n#{@content}\n```"
-            else
-              @content
-            end
-          end
-
-          def execute(io, env, &block)
-            prompts.empty? ? simplex!(io, env, &block) : complex!(io, env, &block)
+          def execute(ui, env, &block)
+            prompts.empty? ? simplex!(ui, env, &block) : complex!(ui, env, &block)
           end
 
           def name(value)
@@ -46,7 +37,7 @@ module WIP
             ([@name] + @args).join(' ')
           end
 
-          def simplex!(io, env, &block)
+          def simplex!(ui, env, &block)
             Open3.popen2e(env, "#{executable} #{arguments}") do |stdin, stdoe, thread|
               while line = stdoe.gets
                 block.call(line)
@@ -56,11 +47,11 @@ module WIP
             end
           end
 
-          def complex!(io, env, &block)
+          def complex!(ui, env, &block)
             Open3.popen2e(env, "#{executable} #{arguments}") do |stdin, stdoe, thread|
               prompts.each do |term, options|
                 stdoe.expect(term) do |result|
-                  stdin.puts io.ask(term) do |q|
+                  stdin.puts ui.ask(term) do |q|
                     options.each { |k, v| q.send(:"#{k}=", v) }
                   end
                   stdoe.gets

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

@@ -3,11 +3,6 @@ module WIP
     module Shell
       module Handlers
         class System < Base
-          def description
-            # @description ||= "```\n#{@content}\n```"
-            @description ||= @content
-          end
-
           def execute(io, env, &block)
             IO.popen(env, executable, 'r') do |pipe|
               pipe.each(&block)

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

@@ -6,150 +6,155 @@ module WIP
       class Runner
         attr_reader :arguments, :options
 
-        def initialize(io, tasks, env = {})
-          @io    = io
-          @tasks = tasks
-          @env   = env
-          @io.indent_size = 2
+        # TODO: enforce env keys as String OR Symbol
+        def initialize(ui, env = {})
+          @ui  = ui
+          @env = env
         end
 
-        def run(arguments, options)
+        # TODO: custom proc for UI???
+        def run(tasks, arguments, options, &block)
           @arguments = arguments
-          @options   = options
-
-          if markdown?
-            @io.indent do
-              @tasks.each do |task|
-                evaluate(task)
-              end
-            end
+          @options   = default(:options).merge(options)
+
+          if format == :markdown
+            raise 'TODO'
+            # @ui.out {
+            #   @ui.indent do
+            #     [tasks].flatted.each do |task|
+            #       evaluate(task)
+            #     end
+            #   end
+            # }
           else
-            @tasks.each do |task|
-              evaluate(task)
+            [tasks].flatten.each do |task|
+              evaluate(task, &block)
             end
           end
         end
 
         private
 
-        def evaluate(task)
+        def default(setting)
+          @defaults ||= {
+            :options => Options.new({
+              :echo        => true,
+              :format      => :text,
+              :interactive => true,
+              :mode        => :execute
+            }),
+            :procs => {
+              :execute => Proc.new { |line| @ui.out { @ui.say("> #{line.rstrip}") } },
+              :silent  => Proc.new { |line| }
+            }
+          }
+
+          @defaults[setting]
+        end
+
+        def evaluate(task, &block)
           task.build(arguments, options)
-          prefix = options.preview ? :preview : :execute
 
-          section('Config') do
-            # @io.newline
-            # @io.say '```'
-            task.configs.each do |term, options|
-              send(:"#{prefix}_config", term, options)
+          section(task.heading) do
+            if interactive? && ! task.configs.empty?
+              task.configs.each do |term, options, b|
+                evaluate_config(term, options, &b)
+              end
+              @ui.err { @ui.newline }
             end
-            # @io.say '```'
-          end unless task.configs.empty?
 
-          task.shells.each do |shell|
-            section("Shell #{shell.type.downcase}") do
-              send(:"#{prefix}_shell", shell)
-              @io.newline
+            task.shells.each do |shell|
+              send(:"#{mode}_shell", shell, &block)
             end
-          end
 
-          # p task.children
-          task.children.each do |child|
-            section('Task') do
-              evaluate(child)
+            task.steps.each do |step|
+              evaluate(step, &block)
             end
           end
         end
 
-        # ---
-
-        # class Execute
-        # end
-        #
-        # class Preview
-        # end
+        def default_config(term, options = {})
+          options[:default] || @env[term] || ENV[term]
+        end
 
-        def execute_config(term, options = {})
+        def evaluate_config(term, options = {})
           query  = options[:required] ? "#{term} (*)" : term
-          answer = @io.ask("- #{query}: ") do |q|
-            q.default  = (options[:default] || ENV[term]) unless options[:password]
-            q.echo     = false  if options[:password]
-            q.validate = /^.+$/ if options[:required]
+          answer = @ui.err do
+            @ui.ask("- #{query}: ") do |q|
+              q.default  = default_config(term, options) unless options[:password]
+              q.echo     = false  if options[:password]
+              q.validate = /^.+$/ if options[:required]
+            end
           end
-          @env[term] = answer unless answer.empty?
-          @env[term] ||= ENV[term]
-        end
-
-        def execute_shell(shell)
-          preview_shell(shell)
 
-          if approved?
-            @io.newline
-            result = shell.execute(@io, @env) do |line|
-              # @io.say "> `#{line.rstrip}`<br>"
-              @io.say "> #{line.rstrip}"
-              # puts "#{@io.indentation}> `#{line.rstrip}`  "
-              # @io.instance_variable_get(:@output).puts "> `#{line.rstrip}`  "
-
-              # @io.send((action || :say), line)
-            end
-            @io.newline
+          if block_given?
+            yield answer
+          else
+            @env[term] = answer unless answer.empty?
+            @env[term] ||= ENV[term]
+          end
+        end
 
-            # TODO: raise instead of exit.
-            exit 1 unless result.success?
+        def display_shell(shell, &block)
+          if block_given?
+            block.call(shell.content)
           else
-            @io.newline
-            @io.say '> (skipped)'
+            @ui.out {
+              @ui.say(shell.content)
+            }
           end
         end
 
-        def preview_config(term, options = {})
-          message = options[:required] ? "#{term} (*)" : term
-          @io.say "- #{message}"
+        def execute_shell(shell, &block)
+          display_shell(shell) unless (mode == :silent) || ! echo?
+
+          @ui.out {
+            if approved?
+              if block_given?
+                result = shell.execute(@ui, @env, &block)
+              else
+                @ui.newline
+                result = shell.execute(@ui, @env, &default(:procs)[mode])
+                @ui.newline
+              end
+
+              # TODO: raise instead of exit.
+              exit 1 unless result.success?
+            else
+              if block_given?
+                block.call('> (skipped)')
+              else
+                @ui.newline
+                @ui.say('> (skipped)')
+              end
+            end
+          }
         end
 
-        def preview_shell(shell)
-          @io.say shell.description
+        def silent_shell(shell)
+          execute_shell(shell)
         end
 
         # ---
 
         def section(heading, &block)
-          if markdown?
-            @io.say "- [ ] #{heading}..."
-            @io.indent(&block)
+          if format == :markdown
+            @ui.out {
+              @ui.say("- [ ] #{heading}")
+              @ui.indent(&block)
+            }
           else
-            yield
+            @ui.err {
+              if heading
+                @ui.say(heading)
+                @ui.newline
+              end
+              yield
+              @ui.newline
+            }
           end
         end
 
-        def format
-          @options.format ? @options.format.intern : :text
-        end
-
-        def markdown?
-          format == :markdown
-        end
-
-        # $ wip-runner x --format=markdown
-        # $ wip-runner x --log=out.md       # log format determined by extension
-        #
-        # @formatter = Formatter::Markdown.new(@io)
-        #
-        # def item(text)
-        #   formatter.item(text)
-        # end
-        #
-        # class Formatter::Markdown
-        #   def item(text, check = true)
-        #     @io.say check ? "- [ ] #{text}" : "- #{text}"
-        #   end
-        # end
-        #
-        # class Formatter::Plain
-        # class Formatter::Color
-        # class Formatter::HTML
-        # class Formatter::JSON
-
         # ---
 
         def approved?
@@ -159,6 +164,22 @@ module WIP
           # when 'yes'
           # end
         end
+
+        def echo?
+          !! options.echo
+        end
+
+        def format
+          options.format
+        end
+
+        def interactive?
+          options.interactive
+        end
+
+        def mode
+          options.mode
+        end
       end
     end
   end

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

@@ -2,30 +2,35 @@ module WIP
   module Runner
     module Shell
       class Task
-        attr_reader :configs, :shells, :children
-
-        def initialize(command, &block)
-          @command  = command
-          @configs  = []
-          @shells   = []
-          @children = []
-          @block    = block
+        attr_reader :heading, :configs, :shells, :steps
+
+        def initialize(command, *args, &block)
+          @command = command
+          @configs = []
+          @shells  = []
+          @steps   = []
+          @heading = args.first unless args.empty?
+          @block   = block
         end
 
         def build(arguments, options)
           self.instance_exec(arguments, options, &@block) ; self
         end
 
-        def config(term, options = {})
-          @configs << [term.to_s, options] # Config.new(...)
+        def heading?
+          !! @heading
+        end
+
+        def config(term, options = {}, &block)
+          @configs << [term.to_s, options, block] # Config.new(...)
         end
 
         def shell(handler, content, &block)
           shells << Handlers.locate(handler).new(content, &block)
         end
 
-        def task(&block)
-          children << Task.new(@command, &block)
+        def task(*args, &block)
+          steps << Task.new(@command, *args, &block)
         end
 
         protected
@@ -34,7 +39,6 @@ module WIP
           if @command.respond_to?(method_name)
             @command.send(method_name, *args, &block)
           else
-            # super
             @command.instance_eval {
               method_missing(method_name, *args, &block)
             }

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

@@ -13,7 +13,7 @@ module WIP
       end
 
       def example_command(implementation)
-        ExampleCommands.const_get(implementation).new(io)
+        ExampleCommands.const_get(implementation).new(ui)
       end
 
       module ExampleCommands
@@ -56,7 +56,9 @@ module WIP
 
           def execute(args, options)
             super
-            @io.say 'running nested command...'
+            @ui.out {
+              @ui.say('running nested command...')
+            }
           end
         end
       end