vete 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c68c30f1f9ce2177fb7c5a83ac8fa9f402b387203e2e1de2321a04ec3effa0c
+  data.tar.gz: 246eed50879a2fd260d1f0b18aab85d3ffe953cd6980d9bb5cca1311a789b202
+SHA512:
+  metadata.gz: 55b4b6dd945930575cf37a814ce1c9d7b7dbfbab6e8a306887841d48dd49331f6b302cfbac0d1741e409fd6bac57153fa52d5bbabe5fab4110f736f3e7660136
+  data.tar.gz: 992cd2007a936f4f7ef53b0741011c916aa3b90802a8794c31a48577fb551fadb50adbcb98e6521d0f5e2716a29e74ca650b5b0dd01c0b023585ecabf89696bc

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Steve Shreeve
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# vete
+
+Ruby CLI to spawn processes to get work done
+
+The phrase "¡véte!" in Spanish means, basically, "Get out!". This tool helps to clear out work in a hurry, using a simple approach of spawning a set number of concurrent processes to handle each job. Jobs are defined as files in a directory, so there is no need for a database or any other complexity.
+
+### Example
+
+Running the `test/example.rb` script with 10 workers:
+
+![Example](https://raw.githubusercontent.com/shreeve/vete/main/test/vete.gif)

data/lib/vete.rb

@@ -0,0 +1,182 @@
+# ============================================================================
+# vete - Ruby CLI to spawn processes to get work done
+#
+# Author: Steve Shreeve (steve.shreeve@gmail.com)
+#   Date: Mar 21, 2023
+# ============================================================================
+
+STDOUT.sync = true
+
+# ==[ Command line ]==========================================================
+
+require "fileutils"
+require "optparse"
+require "thread"
+
+trap("INT" ) { print clear + go; abort "\n" }
+
+OptionParser.new.instance_eval do
+  @version = "0.1.0"
+  @banner  = "usage: #{program_name} [options]"
+
+  on "-b", "--bar <width>"            , "Progress bar width, in characters", Integer
+  on "-c", "--char <character>"       , "Character to use for progress bar", String
+  on "-r", "--reset"                  , "Remove directory used for job processing and quit"
+  on "-h", "--help"                   , "Show help and command usage" do Kernel.abort to_s; end
+  on "-v", "--version"                , "Show version number" do Kernel.abort "#{program_name} #{@version}"; end
+  on "-w", "--workers <count>"        , "Set the number of workers (default is 1)", Integer
+
+  self
+end.parse!(into: opts={}) rescue abort($!.message)
+
+# populate CLI options
+@bar = opts[:bar    ] || 20
+@chr = opts[:char   ] || "•"; @chr = @chr[0]
+@rmf = opts[:reset  ]
+@wrk = opts[:workers] || 1
+
+# define job directories
+@vete = File.expand_path(".vete")
+@todo = File.join(@vete, "todo")
+@live = File.join(@vete, "live")
+@done = File.join(@vete, "done")
+@bomb = File.join(@vete, "bomb")
+
+if @rmf
+  FileUtils.rm_rf @vete
+  exit
+end
+
+def move(path, dest)
+  dest = File.join(dest, File.basename(path))
+  FileUtils.mv(path, dest)
+end
+
+# ==[ Drawing ]===============================================================
+
+# https://www.cse.psu.edu/~kxc104/class/cmpen472/16f/hw/hw8/vt100ansi.htm
+
+def clear      ; "\e[2J"                        ; end
+def cursor(on) ; print on ? "\e[?25h": "\e[?25l"; end
+def go(r=1,c=1); "\e[#{r};#{c}H"                ; end
+def go!(...)   ; print go(...)                  ; end
+
+def fg(rgb=nil); rgb ? "\e[38;2;#{hx(rgb)}m" : "\e[39m"; end
+def bg(rgb=nil); rgb ? "\e[48;2;#{hx(rgb)}m" : "\e[49m"; end
+def hx(str=nil); str =~ /\A#?(?:(\h\h)(\h\h)(\h\h)|(\h)(\h)(\h))\z/ or return
+  r, g, b = $1 ? [$1, $2, $3] : [$4*2, $5*2, $6*2]
+  [r.hex, g.hex, b.hex] * ";"
+end
+
+def draw(rows, done=0, live=0, bomb=0, jobs=0, info=nil)
+
+  # outer box
+  unless info
+    print [
+      clear,
+      go(2 + rows, @len + 3) + "└" + "─" * (@bar + 2) + "┘\n",
+      go(1       , @len + 3) + "┌" + "─" * (@bar + 2) + "┐\n",
+    ].join
+    rows.times {|i| print " %*d │ %*s │\n" % [@len, i + 1, @bar, ""] }
+    return
+  end
+
+  # worker bars
+  dpct = done.to_f / jobs
+  lpct = live.to_f / jobs
+  most = info.values.max
+  info.each do |slot, this|
+    tpct = this.to_f / most
+    cols = dpct * tpct * @bar
+    print go(slot + 1, @len + 5) + bg("5383ec") + @chr * cols
+  end
+
+  # summary bar
+  gcol = dpct * @bar
+  ycol = lpct * @bar
+  print [
+    go(rows + 3, @len + 5),
+    fg("fff"),
+    bg("58a65c") + @chr * (       gcol       )     , #  green (done)
+    bg("f1bf42") + @chr * (              ycol)     , # yellow (live) <= Add live
+    bg("d85140") + " "  * (@bar - gcol - ycol).ceil, #    red (left)
+    go(rows + 3, @len + 5 + @bar + 3) + " %.1f%% done " % [dpct * 100],
+    bomb == 0 ? nil : (bg + " " + bg("f1bf42") + " #{bomb} bombed "),
+  ].join
+
+  # clear colors
+  print fg + bg
+end
+
+# ==[ Simulate job creation, add helpers so vete makes this easy ]============
+
+FileUtils.rm_rf   @vete
+FileUtils.mkdir_p @todo
+FileUtils.mkdir_p @live
+FileUtils.mkdir_p @done
+FileUtils.mkdir_p @bomb
+
+1.upto(100) {|i| FileUtils.touch(File.join(@todo, i.to_s)) }
+
+# ==[ Configure workers ]=====================================================
+
+@len = @wrk.to_s.size
+@mtx = Mutex.new
+@que = Thread::Queue.new; @wrk.times {|slot| @que << (slot + 1) }
+
+begin
+  list = Dir[File.join(@todo, "*")]
+  jobs = list.size
+  info = Hash.new(0)
+
+  setup
+
+  cursor(false)
+  draw(@wrk)
+
+  time = Time.now
+  done = 0
+  live = 0
+  bomb = 0
+  Thread.new do
+    list.each do |path|
+      slot = @que.pop
+      @mtx.synchronize {
+        live += 1
+      }
+      show = "Working on task " + File.basename(path)
+      print go(slot + 1, @len + 5 + @bar + 3) + show
+      if chld = fork # parent
+        Thread.new do
+          okay = Process.waitpid2(chld)[1] == 0
+          move(path, okay ? @done : @bomb)
+          @que.push(slot)
+          @mtx.synchronize {
+            done += 1
+            live -= 1
+            bomb += 1 unless okay
+            info[slot] += 1
+          }
+        end
+        draw(@wrk, done, live, bomb, jobs, info.dup)
+      else
+        perform(slot, path)
+        exit
+      end
+    end
+  end.join
+  draw(@wrk, done, live, bomb, jobs, info)
+  secs = Time.now.to_f - time.to_f
+
+  # summary
+  print [
+    go(@wrk + 5, 1),
+    "%.2f secs" % secs,
+    " for #{jobs} jobs",
+    " by #{@wrk} workers",
+    " @ %.2f jobs/sec" % [jobs / secs]
+  ].join + "\n\n"
+
+ensure
+  cursor(true)
+end

data/test/example.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+def setup
+  @time = Time.now
+end
+
+def perform(slot, task)
+  sleep rand
+  secs = Time.now - @time
+  exit 4 if rand < 0.02
+end
+
+require_relative "../lib/vete"

data/vete.gemspec

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "vete"
+  s.version     = `grep -m 1 '^\s*@version' lib/vete.rb | cut -f 2 -d '"'`
+  s.author      = "Steve Shreeve"
+  s.email       = "steve.shreeve@gmail.com"
+  s.summary     =
+  s.description = "Ruby CLI to spawn processes to get work done"
+  s.homepage    = "https://github.com/shreeve/vete"
+  s.license     = "MIT"
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+# s.executables = `cd bin && git ls-files .`.split("\n")
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: vete
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Shreeve
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-21 00:00:00.000000000 Z
+dependencies: []
+description: Ruby CLI to spawn processes to get work done
+email: steve.shreeve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/vete.rb
+- test/example.rb
+- test/vete.gif
+- vete.gemspec
+homepage: https://github.com/shreeve/vete
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: Ruby CLI to spawn processes to get work done
+test_files: []