scout-essentials 1.0.0

data/lib/scout/simple_opt/parse.rb

@@ -0,0 +1,67 @@
+module SOPT
+  def self.fix_shortcut(short, long)
+    return short unless short and shortcuts.include?(short)
+
+    current = shortcuts.select{|s,l| l == long}.collect{|s,l| s }.first
+    return current if current
+
+    chars = long.chars.to_a
+    current = [chars.shift]
+    short = current * ""
+
+    if (shortcuts.include?(short) and not shortcuts[short] == long) 
+      if long.index "-" or long.index "_"
+        parts = long.split(/[_-]/)
+        acc = parts.collect{|s| s[0] } * ""
+        return acc unless shortcuts.include? acc
+      elsif m = long.match(/(\d+)/)
+        n = m[0]
+        acc = long[0] + n
+        return acc unless shortcuts.include? acc
+      end
+    end
+
+    while shortcuts.include?(short) && shortcuts[short] != long 
+      next_letter = chars.shift
+      next_letter = chars.shift while %w(. - _).include?(next_letter)
+      return nil if next_letter.nil?
+      current << next_letter
+      short = current * ""
+    end
+
+    return nil if shortcuts.include? short
+
+    short
+  end
+
+  def self.register(short, long, asterisk, description)
+    short = fix_shortcut(short, long)
+    shortcuts[short] = long if short
+    inputs << long
+    input_shortcuts[long] = short
+    input_descriptions[long] = description
+    input_types[long] = asterisk ? :string : :boolean
+  end
+
+  def self.parse(opt_str)
+    inputs = []
+
+    if opt_str.include? "\n"
+      re = /\n+/
+    else
+      re = /:/
+    end
+
+    opt_str.split(re).each do |entry|
+      entry.strip!
+      next if entry.empty?
+      names, _sep, description = entry.partition(/\s+/)
+      short, long, asterisk = names.match(/\s*(?:-(.+))?(?:--(.+?))([*])?$/).values_at 1,2,3 
+
+      inputs << long
+      register short, long, asterisk, description
+    end
+
+    inputs
+  end
+end

data/lib/scout/simple_opt/setup.rb

@@ -0,0 +1,26 @@
+module SOPT
+
+  def self.setup(str)
+    parts = str.split(/\n\n+/)
+
+    summary = parts.shift unless parts.first =~ /^\s*\$-/
+    synopsys = parts.shift if parts.first =~ /^\s*\$/
+
+    description = []
+    while parts.first and parts.first !~ /^\s*-/
+      description << parts.shift
+    end
+    description = description * "\n\n"
+
+    options = parts.collect{|part| part.split("\n").select{|l| l=~ /^\s*-/ }  }.flatten.compact * "\n"
+
+    synopsys.sub!(/^\$\s+/,'') if synopsys
+
+    SOPT.summary = summary.strip if summary
+    SOPT.synopsys = synopsys.strip if synopsys
+    SOPT.description = description.strip if description
+    SOPT.parse options  if options
+
+    SOPT.consume
+  end
+end

data/lib/scout/simple_opt.rb

@@ -0,0 +1,5 @@
+require_relative 'simple_opt/accessor'
+require_relative 'simple_opt/parse'
+require_relative 'simple_opt/doc'
+require_relative 'simple_opt/get'
+require_relative 'simple_opt/setup'

data/lib/scout/tmpfile.rb

@@ -0,0 +1,129 @@
+require_relative 'misc'
+require_relative 'log'
+require 'fileutils'
+
+module TmpFile
+  MAX_FILE_LENGTH = 150
+
+  def self.user_tmp(subdir = nil)
+    if subdir
+      File.join(ENV["HOME"],"/tmp/scout", subdir)
+    else
+      File.join(ENV["HOME"],"/tmp/scout")
+    end
+  end
+
+  def self.tmpdir=(tmpdir)
+    @tmpdir = tmpdir
+  end
+
+  def self.tmpdir
+    @tmpdir ||= self.user_tmp('tmpfiles')
+  end
+
+  # Creates a random file name, with the given suffix and a random number
+  # up to +max+
+  def self.random_name(prefix = 'tmp-', max = 1_000_000_000)
+    n = rand(max)
+    prefix + n.to_s
+  end
+
+  # Creates a random filename in the temporary directory
+  def self.tmp_file(prefix = 'tmp-', max = 1_000_000_000, dir = nil)
+    dir ||= TmpFile.tmpdir
+    File.expand_path(File.join(dir, random_name(prefix, max)))
+  end
+
+  def self.with_file(content = nil, erase = true, options = {})
+    if content.is_a?(Hash)
+      options = content
+      content = nil
+      erase = true
+    end
+    if erase.is_a?(Hash)
+      options = erase
+      erase = true
+    end
+
+    prefix = options[:prefix] || 'tmp-'
+    tmpdir = options[:tmpdir] || TmpFile.tmpdir
+    max = options[:max] || 1_000_000_000
+    tmpfile = tmp_file prefix, max, tmpdir
+    tmpfile += ".#{options[:extension]}" if options[:extension]
+
+    FileUtils.mkdir_p tmpdir
+    if IO === content
+      File.open(tmpfile, 'wb') do |f|
+        begin
+          while c = content.readpartial(1024)
+            f << c
+          end
+        rescue EOFError
+        end
+      end
+    elsif !content.nil?
+      File.open(tmpfile, 'w') { |f| f.write content }
+    end
+
+    result = yield(tmpfile)
+
+    FileUtils.rm_rf tmpfile if File.exist?(tmpfile) && erase
+
+    result
+  end
+
+  def self.with_dir(erase = true, options = {})
+    prefix = options[:prefix] || 'tmpdir-'
+    tmpdir = tmp_file prefix
+
+    FileUtils.mkdir_p tmpdir
+
+    result = yield(tmpdir)
+
+    FileUtils.rm_rf tmpdir if File.exist?(tmpdir) && erase
+
+    result
+  end
+
+  def self.in_dir(*args)
+    with_dir(*args) do |dir|
+      Misc.in_dir dir do
+        yield dir
+      end
+    end
+  end
+
+  SLASH_REPLACE = '·'
+  def self.tmp_for_file(file, tmp_options = {}, other_options = {})
+    tmp_for_file, prefix, key, persistence_dir = IndiferentHash.process_options tmp_options, :file, :prefix, :key, :dir
+    return tmp_for_file unless tmp_for_file.nil?
+
+    if prefix.nil?
+      perfile = file.to_s.sub(/\.b?gz$/,'')
+    else
+      perfile = prefix.to_s + ":" + file.to_s.sub(/\.b?gz$/,'')
+    end
+
+    perfile += "[#{ key }]" if key
+
+    if other_options.include? :filters
+      other_options[:filters].each do |match,value|
+        perfile = perfile + "&F[#{match}=#{Misc.digest(value)}]"
+      end
+    end
+
+    persistence_dir = TmpFile.tmpdir if persistence_dir.nil?
+    Path.setup(persistence_dir) unless Path === persistence_dir
+
+    filename = perfile.gsub(/\s/,'_').gsub('/', SLASH_REPLACE)
+    clean_options = other_options.dup
+    clean_options.delete :unnamed
+    clean_options.delete "unnamed"
+
+    filename = filename[0..MAX_FILE_LENGTH] << Misc.digest(filename[MAX_FILE_LENGTH+1..-1]) if filename.length > MAX_FILE_LENGTH + 10
+
+    filename  += ":" << Misc.digest(clean_options) unless clean_options.empty?
+
+    persistence_dir[filename]
+  end
+end

data/lib/scout-essentials.rb

@@ -0,0 +1,10 @@
+require_relative 'scout/exceptions'
+require_relative 'scout/indiferent_hash'
+require_relative 'scout/tmpfile'
+require_relative 'scout/log'
+require_relative 'scout/path'
+require_relative 'scout/simple_opt'
+require_relative 'scout/resource'
+require_relative 'scout/resource/scout'
+require_relative 'scout/persist'
+require_relative 'scout/config'

data/scout-essentials.gemspec

@@ -0,0 +1,143 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: scout-essentials 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "scout-essentials".freeze
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Miguel Vazquez".freeze]
+  s.date = "2023-07-04"
+  s.description = "Things a scout can use anywhere".freeze
+  s.email = "mikisvaz@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".vimproject",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/scout-essentials.rb",
+    "lib/scout/cmd.rb",
+    "lib/scout/concurrent_stream.rb",
+    "lib/scout/config.rb",
+    "lib/scout/exceptions.rb",
+    "lib/scout/indiferent_hash.rb",
+    "lib/scout/indiferent_hash/case_insensitive.rb",
+    "lib/scout/indiferent_hash/options.rb",
+    "lib/scout/log.rb",
+    "lib/scout/log/color.rb",
+    "lib/scout/log/color_class.rb",
+    "lib/scout/log/fingerprint.rb",
+    "lib/scout/log/progress.rb",
+    "lib/scout/log/progress/report.rb",
+    "lib/scout/log/progress/util.rb",
+    "lib/scout/log/trap.rb",
+    "lib/scout/meta_extension.rb",
+    "lib/scout/misc.rb",
+    "lib/scout/misc/digest.rb",
+    "lib/scout/misc/filesystem.rb",
+    "lib/scout/misc/format.rb",
+    "lib/scout/misc/helper.rb",
+    "lib/scout/misc/insist.rb",
+    "lib/scout/misc/monitor.rb",
+    "lib/scout/misc/system.rb",
+    "lib/scout/named_array.rb",
+    "lib/scout/open.rb",
+    "lib/scout/open/lock.rb",
+    "lib/scout/open/lock/lockfile.rb",
+    "lib/scout/open/remote.rb",
+    "lib/scout/open/stream.rb",
+    "lib/scout/open/util.rb",
+    "lib/scout/path.rb",
+    "lib/scout/path/find.rb",
+    "lib/scout/path/tmpfile.rb",
+    "lib/scout/path/util.rb",
+    "lib/scout/persist.rb",
+    "lib/scout/persist/open.rb",
+    "lib/scout/persist/path.rb",
+    "lib/scout/persist/serialize.rb",
+    "lib/scout/resource.rb",
+    "lib/scout/resource/open.rb",
+    "lib/scout/resource/path.rb",
+    "lib/scout/resource/produce.rb",
+    "lib/scout/resource/produce/rake.rb",
+    "lib/scout/resource/scout.rb",
+    "lib/scout/resource/software.rb",
+    "lib/scout/resource/util.rb",
+    "lib/scout/simple_opt.rb",
+    "lib/scout/simple_opt/accessor.rb",
+    "lib/scout/simple_opt/doc.rb",
+    "lib/scout/simple_opt/get.rb",
+    "lib/scout/simple_opt/parse.rb",
+    "lib/scout/simple_opt/setup.rb",
+    "lib/scout/tmpfile.rb",
+    "scout-essentials.gemspec",
+    "share/color/color_names",
+    "share/color/diverging_colors.hex",
+    "share/software/install_helpers",
+    "test/scout/indiferent_hash/test_case_insensitive.rb",
+    "test/scout/indiferent_hash/test_options.rb",
+    "test/scout/log/test_color.rb",
+    "test/scout/log/test_progress.rb",
+    "test/scout/misc/test_digest.rb",
+    "test/scout/misc/test_filesystem.rb",
+    "test/scout/misc/test_insist.rb",
+    "test/scout/misc/test_system.rb",
+    "test/scout/open/test_lock.rb",
+    "test/scout/open/test_remote.rb",
+    "test/scout/open/test_stream.rb",
+    "test/scout/open/test_util.rb",
+    "test/scout/path/test_find.rb",
+    "test/scout/path/test_util.rb",
+    "test/scout/persist/test_open.rb",
+    "test/scout/persist/test_path.rb",
+    "test/scout/persist/test_serialize.rb",
+    "test/scout/resource/test_path.rb",
+    "test/scout/resource/test_produce.rb",
+    "test/scout/resource/test_software.rb",
+    "test/scout/resource/test_util.rb",
+    "test/scout/simple_opt/test_doc.rb",
+    "test/scout/simple_opt/test_get.rb",
+    "test/scout/simple_opt/test_parse.rb",
+    "test/scout/simple_opt/test_setup.rb",
+    "test/scout/test_cmd.rb",
+    "test/scout/test_concurrent_stream.rb",
+    "test/scout/test_config.rb",
+    "test/scout/test_indiferent_hash.rb",
+    "test/scout/test_log.rb",
+    "test/scout/test_meta_extension.rb",
+    "test/scout/test_misc.rb",
+    "test/scout/test_named_array.rb",
+    "test/scout/test_open.rb",
+    "test/scout/test_path.rb",
+    "test/scout/test_persist.rb",
+    "test/scout/test_resource.rb",
+    "test/scout/test_tmpfile.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/mikisvaz/scout-essentials".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.4.13".freeze
+  s.summary = "Scout essential tools".freeze
+
+  s.specification_version = 4
+
+  s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+  s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+  s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+  s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<term-ansicolor>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<yaml>.freeze, [">= 0"])
+end
+