cmds 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 746aa0ec8697ab254e151c8000620c7a3a6d8c52
-  data.tar.gz: d15e1589321da1a22ad00d98cb12875d71a0ea7b
+  metadata.gz: 327a49d0895e5e91d1d35c9ab352357a4a577f65
+  data.tar.gz: f2f7bd60a0b9bcdfca5a7e50a28ac386f329d33a
 SHA512:
-  metadata.gz: 186e86b834c8d38aa58b624c394acc850848fff6faac92ff10ecd3336992beff7a6b9d3a139baaec9148b12e1fe036c04a29bf954dde6c27a14309cf69304f98
-  data.tar.gz: de1c715943e12a45f003e5e9a4b0c9b63f8443c8c42a64a35d983f6d742404d82b28eddc06ad238d1777e3aaf20bb1b95ccc4871abfce1090d3b52c822e7846b
+  metadata.gz: c22d98773434a8c16df0420d599222e00df2f5fcca68e448f889f16671d35db3ab441faa8d6194419c690f435b60e28b1992cc2cbddb0614c79f26fa378e5033
+  data.tar.gz: ca4371971382c85c6438bafac00c40f637a9e7dbeb2e232838ea9ae2e11ffdc7de5f6989ccd76560f2d09cac452d7da5438e291a29b1baa24dc64e93e8abbacb

data/Rakefile

@@ -1 +1,153 @@
+require 'thread'
+require 'pastel'
+require 'json'
+require 'pp'
+require 'tempfile'
+
 require "bundler/gem_tasks"
+
+Bundler.require
+
+def configure_logger
+  logger = Logger.new $stderr
+
+  logger.level = case ENV['log']
+  when 'debug'
+    Logger::DEBUG
+  when 'info'
+    Logger::INFO
+  when 'warn'
+    Logger::WARN
+  when 'error'
+    Logger::ERROR
+  else
+    Logger::INFO
+  end
+
+  logger.formatter = proc do |severity, datetime, progname, msg|
+    formatted = if Thread.current[:name]
+      "[rake #{ severity } - #{ Thread.current[:name ] }] #{msg}\n"
+    else
+      "[rake #{ severity }] #{msg}\n"
+    end
+
+    if severity == 'DEBUG'
+      formatted = Pastel.new.cyan(formatted)
+    end
+
+    formatted
+  end
+  logger
+end
+
+def log
+  $logger ||= configure_logger
+end
+
+namespace :debug do
+  desc "turn debug logging on"
+  task :conf do
+    ENV['log'] ||= 'debug'
+    Cmds.enable_debug
+  end
+
+  task :proxy => :conf do
+    Cmds.new("./test/questions.rb").proxy
+  end
+
+  namespace :capture do
+    desc "capture with io-like input with debugging enabled"
+    task :io_input => :conf do
+      File.open "./test/lines.txt" do |f|
+        Cmds.new("./test/echo_cmd.rb", input: f).capture
+      end
+    end
+  end # ns capture
+
+  namespace :stream do
+    input = NRSER.dedent <<-BLOCK
+      one
+      two
+      three
+    BLOCK
+
+    desc "output to blocks"
+    task :blocks => :conf do
+      Cmds.stream "ls" do |io|
+        io.on_out do |line|
+          puts "line: #{ line.inspect }"
+        end
+      end
+    end
+
+    desc "use a file as output"
+    task :file_out => :conf do
+      f = Tempfile.new "blah"
+      Cmds.stream "echo here" do |io|
+        io.out = f
+      end
+
+      f.rewind
+      puts f.read
+      f.close
+      f.unlink
+    end
+
+    desc "input block value"
+    task :value => :conf do
+      Cmds.stream "wc -l" do
+        input
+      end
+    end
+
+    desc "input block hanlder"
+    task :handler => :conf do
+      Cmds.stream "wc -l" do |io|
+        io.on_in do
+        end
+      end
+    end
+
+    desc "input io"
+    task :io => :conf do
+      File.open "./test/lines.txt" do |f|
+        Cmds.stream("wc -l") { f }
+      end
+    end
+
+    # this was a vauge idea that doesn't yet work, and may never
+    # need a better understanding probably, so gonna punt for now
+    desc "play with questions"
+    task :questions => :conf do
+      q = nil
+      a = nil
+
+      as = {
+        "what is your name?" => 'nrser',
+        "what is your quest?" => 'make this shit work somehow',
+        "what is you favorite color?" => 'blue',
+      }
+
+      Cmds.stream "./test/questions.rb" do |io|
+        io.on_out do |line|
+          puts "on_out called"
+          q = line
+          puts "questions asked: #{ q }"
+          a = as[q]
+          raise "unknown question: #{ q }" unless a
+          puts "setting answer to #{ a }..."
+        end
+
+        io.on_in do |f|
+          puts "on_in called"
+          if a
+            puts "responding with #{ a }."
+            f.write a
+          else
+            puts "no response ready."
+          end
+        end
+      end
+    end
+  end # namespace stream
+end # namespace debug

data/ansible/dev.yml

@@ -10,6 +10,11 @@
         version:  master
         dir_name: rails
 
+      - owner:    ruby
+        name:     ruby
+        version:  v2_2_2
+        dir_name: ruby-v2_2_2
+
   tasks:
 
   - name: install gems

data/cmds.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pastel"
 end

data/lib/cmds/capture.rb

@@ -0,0 +1,47 @@
+class Cmds
+  # invokes the command and returns a Result with the captured outputs
+  def capture *subs, &input_block
+    Cmds.debug "entering Cmds#capture",
+      subs: subs,
+      input_block: input_block
+
+    # merge any stored args and kwds and replace input if provided
+    options = merge_options subs, input_block
+    Cmds.debug "merged options:",
+      options: options
+
+    # build the command string
+    cmd = Cmds.sub @template, options[:args], options[:kwds]
+    Cmds.debug "built command string: #{ cmd.inspect }"
+
+    out = ''
+    err = ''
+
+    Cmds.debug "calling Cmds#really_stream..."
+    status = really_stream cmd, options do |io|
+      # send the input to stream, which sends it to spawn
+      io.in = options[:input]
+
+      # and concat the output lines as they come in
+      io.on_out do |line|
+        out += line
+      end
+
+      io.on_err do |line|
+        err += line
+      end
+    end
+    Cmds.debug "Cmds#really_stream completed",
+      status: status
+
+    # build a Result
+    # result = Cmds::Result.new cmd, status, out_reader.value, err_reader.value
+    result = Cmds::Result.new cmd, status, out, err
+
+    # tell the Result to assert if the Cmds has been told to, which will
+    # raise a SystemCallError with the exit status if it was non-zero
+    result.assert if @assert
+
+    return result
+  end # #capture
+end

data/lib/cmds/debug.rb

@@ -0,0 +1,101 @@
+require 'logger'
+
+# debug logging stuff
+class Cmds
+
+  module Debug
+    # constants
+
+    # change the color of debug output by thread name (if present)
+    THREAD_COLORS = {
+      'INPUT' => :cyan,
+      'OUTPUT' => :green,
+      'ERROR' => :red,
+    }
+    # available Pastel styles:
+    # 
+    # clear, reset, bold, dark, dim, italic, underline, underscore, inverse, hidden, strikethrough,
+    # black, red, green, yellow, blue, magenta, cyan, white, 
+    # on_black, on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, on_white, 
+    # bright_black, bright_red, bright_green, bright_yellow, bright_blue, bright_magenta, bright_cyan, bright_white,
+    # on_bright_black, on_bright_red, on_bright_green, on_bright_yellow, on_bright_blue, on_bright_magenta, on_bright_cyan, on_bright_white
+    # 
+
+    # class variables
+    @@on = false
+    @@logger = nil
+
+    # class methods
+    # =============
+
+    # get the Logger instance. may be `nil`.
+    def self.logger
+      @@logger
+    end
+
+    # test if the logger is configured.
+    def self.configured?
+      !! @@logger
+    end
+
+    # configure the Logger with optional destination
+    def self.configure dest = $stdout
+      require 'pastel'
+      @@pastel = Pastel.new
+
+      @@logger = Logger.new dest
+      @@logger.level = Logger::DEBUG
+      @@logger.formatter = proc do |severity, datetime, progname, msg|
+        if Thread.current[:name]
+          msg = "[Cmds #{ severity } - #{ Thread.current[:name ] }] #{msg}\n"
+
+          if color = THREAD_COLORS[Thread.current[:name]]
+            msg = @@pastel.method(color).call msg
+          end
+
+          msg
+        else
+          "[Cmds #{ severity }] #{msg}\n"
+        end
+      end
+    end
+
+    # turn debug logging on. if you provide a block it will turn debug logging
+    # on for that block and off at the end.
+    def self.on &block
+      configure unless configured?
+      @@on = true
+      if block
+        yield
+        off
+      end
+    end
+
+    # turn debug logging off.
+    def self.off
+      @@on = false
+    end
+
+    # test if debug logging is on.
+    def self.on?
+      @@on
+    end
+
+    # format a debug message with optional key / values to print
+    def self.format msg, values = {}
+      if values.empty?
+        msg
+      else
+        msg + "\n" + values.map {|k, v| "  #{ k }: #{ v.inspect }" }.join("\n")
+      end
+    end
+
+  end # module Debug
+
+  # log a debug message along with an optional hash of values.
+  def self.debug msg, values = {}
+    # don't even bother unless debug logging is turned on
+    return unless Debug.on?
+    Debug.logger.debug Debug.format(msg, values)
+  end
+end # class Cmds

data/lib/cmds/erb_context.rb

@@ -0,0 +1,30 @@
+class Cmds
+  class ERBContext < BasicObject
+    def initialize args, kwds
+      @args = args
+      @kwds = kwds
+      @arg_index = 0
+    end
+
+    def method_missing sym, *args, &block
+      if args.empty? && block.nil?
+        if sym.to_s[-1] == '?'
+          key = sym.to_s[0...-1].to_sym
+          @kwds[key]
+        else
+          @kwds.fetch sym
+        end
+      else
+        super
+      end
+    end
+
+    def get_binding
+      ::Kernel.send :binding
+    end
+
+    def arg
+      @args.fetch(@arg_index).tap {@arg_index += 1}
+    end
+  end # end ERBContext
+end # class Cmds

data/lib/cmds/io_handler.rb

@@ -0,0 +1,76 @@
+class Cmds
+  class IOHandler
+    attr_accessor :in, :out, :err
+
+    def initialize
+      @queue = Queue.new
+      @in = nil
+      @out = $stdout
+      @err = $stderr
+    end
+
+    def on_out &block
+      @out = block
+    end
+
+    # called in seperate thread handling process IO
+    def thread_send_out line
+      @queue << [:out, line]
+    end
+
+    def on_err &block
+      @err = block
+    end
+
+    # called in seperate thread handling process IO
+    def thread_send_err line
+      @queue << [:err, line]
+    end
+
+    def thread_send_line sym, line
+      @queue << [sym, line]
+    end
+
+    def start
+      # if out is a proc, it's not done
+      out_done = ! @out.is_a?(Proc)
+      # same for err
+      err_done = ! @err.is_a?(Proc)
+
+      until out_done && err_done
+        key, line = @queue.pop
+        
+        case key
+        when :out
+          if line.nil?
+            out_done = true
+          else
+            handle_line @out, line
+          end
+
+        when :err
+          if line.nil?
+            err_done = true
+          else
+            handle_line @err, line
+          end
+
+        else
+          raise "bad key: #{ key.inspect }"
+        end
+      end
+    end #start
+
+    private
+
+      def handle_line dest, line
+        if dest.is_a? Proc
+          dest.call line
+        else
+          dest.puts line
+        end
+      end
+
+    # end private
+  end # end IOHandler
+end # class Cmds

data/lib/cmds/pipe.rb

@@ -0,0 +1,13 @@
+class Cmds
+  # stupid little wrapper around IO.pipe that can have some extra info
+  # attached to it
+  class Pipe
+    attr_reader :name, :sym, :r, :w
+
+    def initialize name, sym
+      @name = name
+      @sym = sym
+      @r, @w = IO.pipe
+    end
+  end
+end

data/lib/cmds/result.rb

@@ -0,0 +1,34 @@
+class Cmds
+  class Result
+    attr_reader :cmd, :status, :out, :err
+
+    def initialize cmd, status, out, err
+      @cmd = cmd
+      @status = status
+      @out = out
+      @err = err
+    end
+
+    def ok?
+      @status == 0
+    end
+
+    def error?
+      ! ok?
+    end
+
+    # raises an error if there was one
+    # returns the Result so that it can be chained
+    def assert
+      if error?
+        msg = NRSER.squish <<-BLOCK
+          command `#{ @cmd }` exited with status #{ @status }
+          and stderr #{ err.inspect }
+        BLOCK
+
+        raise SystemCallError.new msg, @status
+      end
+      self
+    end # raise_error
+  end
+end # class Cmds

data/lib/cmds/shell_eruby.rb

@@ -0,0 +1,11 @@
+require 'erubis'
+
+class Cmds
+  # extension of Erubis' EscapedEruby (which auto-escapes `<%= %>` and
+  # leaves `<%== %>` raw) that calls `Cmds.expand_sub` on the value
+  class ShellEruby < Erubis::EscapedEruby
+    def escaped_expr code
+      "::Cmds.expand_sub(#{code.strip})"
+    end
+  end
+end # class Cmds