scout-gear 1.1.1 → 2.0.0

data/lib/scout/simple_opt/doc.rb

@@ -0,0 +1,120 @@
+require_relative '../log'
+module SOPT
+
+  class << self
+    attr_accessor :command, :summary, :synopsys, :description
+  end
+
+  def self.command
+    @command ||= File.basename($0)
+  end
+
+  def self.summary
+    @summary ||= ""
+  end
+
+  def self.synopsys
+    @synopsys ||= begin
+                    "#{command} " <<
+                    inputs.collect{|name|
+                      "[" << input_format(name, input_types[name] || :string, input_defaults[name], input_shortcuts[name]).sub(/:$/,'') << "]"
+                    } * " "
+                  end
+  end
+
+  def self.description
+    @description ||= "Missing"
+  end
+
+  def self.input_format(name, type = nil, default = nil, short = nil)
+    input_str = (short.nil? or short.empty?) ? "--#{name}" : "-#{short},--#{name}"
+    input_str = Log.color(:blue, input_str)
+    extra = case type
+    when nil
+      ""
+    when :boolean
+      "[=false]" 
+    when :tsv, :text
+      "=<file|->"
+    when :array
+      "=<list|file|->"
+    else
+      "=<#{ type }>"
+    end
+    #extra << " (default: #{Array === default ? (default.length > 3 ? default[0..2]*", " + ', ...' : default*", " ): default})" if default != nil
+    extra << " (default: #{Misc.fingerprint(default)})" if default != nil
+    input_str << Log.color(:green, extra)
+  end
+
+  def self.input_doc(inputs, input_types = nil, input_descriptions = nil, input_defaults = nil, input_shortcuts = nil)
+    type = description = default = nil
+    shortcut = ""
+    seen = []
+    inputs.collect do |name|
+      next if seen.include? name
+      seen << name
+
+      type = input_types[name] unless input_types.nil?
+      description = input_descriptions[name] unless input_descriptions.nil?
+      default = input_defaults[name] unless input_defaults.nil?
+
+      name = name.to_s
+
+      case input_shortcuts
+      when nil, FalseClass
+        shortcut = nil
+      when Hash
+        shortcut = input_shortcuts[name] 
+      when TrueClass
+        shortcut = fix_shortcut(name[0], name)
+      end
+
+      type = :string if type.nil?
+      register(shortcut, name, type, description) unless self.inputs.include? name
+
+      name  = SOPT.input_format(name, type.to_sym, default, shortcut) 
+      description 
+      Misc.format_definition_list_item(name, description, 80, 31, nil)
+    end * "\n"
+  end
+
+  def self.doc
+    doc = <<-EOF
+#{Log.color :magenta}#{command}(1) -- #{summary}
+#{"=" * (command.length + summary.length + 7)}#{Log.color :reset}
+
+#{ Log.color :magenta, "## SYNOPSYS"}
+
+#{Log.color :blue, synopsys}
+
+#{ Log.color :magenta, "## DESCRIPTION"}
+
+#{Misc.format_paragraph description}
+
+#{ Log.color :magenta, "## OPTIONS"}
+
+#{input_doc(inputs, input_types, input_descriptions, input_defaults, input_shortcuts)}
+    EOF
+  end
+
+  def self.doc
+    doc = <<-EOF
+#{Log.color :magenta}#{command}(1) -- #{summary}
+#{"=" * (command.length + summary.length + 7)}#{Log.color :reset}
+
+    EOF
+
+    if synopsys and not synopsys.empty?
+      doc << Log.color(:magenta, "## SYNOPSYS") << "\n\n"
+      doc << Log.color(:blue, synopsys) << "\n\n"
+    end
+
+    if description and not description.empty?
+      doc << Log.color(:magenta, "## DESCRIPTION") << "\n\n"
+      doc << Misc.format_paragraph(description) << "\n\n"
+    end
+
+    doc << Log.color(:magenta, "## OPTIONS") << "\n\n"
+    doc << input_doc(inputs, input_types, input_descriptions, input_defaults, input_shortcuts)
+  end
+end

data/lib/scout/simple_opt/get.rb

@@ -0,0 +1,57 @@
+module SOPT
+  GOT_OPTIONS= IndiferentHash.setup({})
+  def self.current_options=(options)
+    @@current_options = options
+  end
+  def self.consume(args = ARGV)
+    i = 0
+    @@current_options ||= {}
+    while i < args.length do
+      current = args[i]
+      break if current == "--"
+      if m = current.match(/--?(.+?)(?:=(.+))?$/)
+        key = $1
+        value = $2
+
+        input = inputs.include?(key)? key : shortcuts[key]
+
+        if input.nil?
+          i += 1
+          next
+        else
+          args.delete_at i
+        end
+      else
+        i += 1
+        next
+      end
+
+      if input_types[input] == :string
+        value = args.delete_at(i) if value.nil?
+        @@current_options[input] = value
+      else
+        if value.nil? and %w(F false FALSE no).include?(args[i])
+          Log.warn "Boolean values are best specified as #{current}=[true|false], not #{ current } [true|false]. Token '#{args[i]}' following '#{current}' automatically assigned as value" 
+          value = args.delete_at(i)
+        end
+        @@current_options[input] = %w(F false FALSE no).include?(value)? false : true
+      end
+    end
+
+    IndiferentHash.setup @@current_options
+    GOT_OPTIONS.merge! @@current_options
+
+    @@current_options
+  end
+  
+  def self.get(opt_str)
+    SOPT.parse(opt_str)
+    SOPT.consume(ARGV)
+  end
+
+  def self.require(options, *parameters)
+    parameters.flatten.each do |parameter|
+      raise ParameterException, "Parameter '#{ Log.color :blue, parameter }' not given" if options[parameter].nil?
+    end
+  end
+end

data/lib/scout/simple_opt/parse.rb

@@ -0,0 +1,66 @@
+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)
+    info = {}
+
+    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

@@ -1,4 +1,5 @@
 require 'fileutils'
+require_relative 'misc'
 
 module TmpFile
   def self.user_tmp(subdir = nil)
@@ -83,13 +84,8 @@ module TmpFile
 
   def self.in_dir(*args)
     with_dir(*args) do |dir|
-      old_pwd = FileUtils.pwd
-      begin
-        FileUtils.mkdir_p dir unless File.exist?(dir)
-        FileUtils.cd dir
+      Misc.in_dir dir do
         yield dir
-      ensure
-        FileUtils.cd old_pwd
       end
     end
   end

data/lib/scout-gear.rb

@@ -1,3 +1,5 @@
 require_relative 'scout/indiferent_hash'
 require_relative 'scout/tmpfile'
 require_relative 'scout/log'
+require_relative 'scout/path'
+require_relative 'scout/simple_opt'

data/scout-gear.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: scout-gear 1.1.1 ruby lib
+# stub: scout-gear 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "scout-gear".freeze
-  s.version = "1.1.1"
+  s.version = "2.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-03-24"
+  s.date = "2023-03-30"
   s.description = "Temporary files, logs, etc.".freeze
   s.email = "mikisvaz@gmail.com".freeze
   s.executables = ["scout".freeze]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".gitmodules",
     ".vimproject",
     "LICENSE.txt",
     "README.rdoc",
@@ -40,16 +41,31 @@ Gem::Specification.new do |s|
     "lib/scout/log/progress/report.rb",
     "lib/scout/log/progress/util.rb",
     "lib/scout/meta_extension.rb",
+    "lib/scout/misc.rb",
+    "lib/scout/misc/format.rb",
     "lib/scout/path.rb",
     "lib/scout/path/find.rb",
+    "lib/scout/path/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-gear.gemspec",
+    "test/scout/indiferent_hash/test_case_insensitive.rb",
     "test/scout/indiferent_hash/test_options.rb",
     "test/scout/log/test_progress.rb",
     "test/scout/path/test_find.rb",
+    "test/scout/path/test_util.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_indiferent_hash.rb",
     "test/scout/test_log.rb",
     "test/scout/test_meta_extension.rb",
+    "test/scout/test_misc.rb",
     "test/scout/test_path.rb",
     "test/scout/test_tmpfile.rb",
     "test/test_helper.rb"

data/test/scout/indiferent_hash/test_case_insensitive.rb

@@ -0,0 +1,16 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestCaseInsensitiveHash < Test::Unit::TestCase
+  def test_case_insensitive_hash
+    a = {:a => 1, "b" => 2}
+    a.extend CaseInsensitiveHash
+
+    assert_equal 1, a[:a]
+    assert_equal 1, a["A"]
+    assert_equal 1, a[:A]
+    assert_equal 2, a["B"]
+    assert_equal 2, a[:b]
+  end
+end
+

data/test/scout/path/test_find.rb

@@ -1,6 +1,8 @@
 require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
 require 'scout/path'
+require 'scout/misc'
 require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
 class TestPathFind < Test::Unit::TestCase
   def test_parts
     path = Path.setup("share/data/some_file", 'scout')
@@ -8,7 +10,7 @@ class TestPathFind < Test::Unit::TestCase
     assert_equal "data/some_file", path._subpath
 
     path = Path.setup("data", 'scout')
-    assert_equal nil, path._toplevel
+    assert_equal "", path._toplevel
     assert_equal "data", path._subpath
   end
 
@@ -30,5 +32,44 @@ class TestPathFind < Test::Unit::TestCase
       assert_equal File.join(tmpdir,"share/data/some_file"),  path.find(:current)
     end
   end
+
+  def test_current_find
+    path = Path.setup("share/data/some_file", 'scout')
+    TmpFile.in_dir do |tmpdir|
+      FileUtils.mkdir_p(File.dirname(File.join(tmpdir, path)))
+      File.write(File.join(tmpdir, path), 'string')
+      assert_equal File.join(tmpdir,"share/data/some_file"),  path.find
+      assert_equal :current,  path.find.where
+      assert_equal "share/data/some_file",  path.find.original
+    end
+  end
+
+  def test_current_find_all
+    path = Path.setup("share/data/some_file", 'scout')
+    TmpFile.with_dir do |tmpdir|
+      Path.setup tmpdir
+
+      FileUtils.mkdir_p(tmpdir.lib)
+      FileUtils.mkdir_p(tmpdir.share.data)
+      File.write(tmpdir.share.data.some_file, 'string')
+
+      FileUtils.mkdir_p(tmpdir.subdir.share.data)
+      File.write(tmpdir.subdir.share.data.some_file, 'string')
+
+      path.libdir = tmpdir
+      Misc.in_dir tmpdir.subdir do
+        assert_equal 2, path.find_all.length
+      end
+    end
+  end
+
+  def test_located?
+
+    p = Path.setup("/tmp/foo/bar")
+    assert p.located?
+    assert_equal p, p.find
+    
+  end
+
 end
 

data/test/scout/path/test_util.rb

@@ -0,0 +1,22 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require 'scout/path'
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestPathUtil < Test::Unit::TestCase
+  def test_dirname
+    p = Path.setup("/usr/share/scout/data")
+
+    assert_equal "/usr/share/scout", p.dirname
+  end
+
+  def test_glob
+    TmpFile.in_dir :erase => false do |tmpdir|
+      Path.setup tmpdir
+      File.write(tmpdir.foo, 'foo')
+      File.write(tmpdir.bar, 'bar')
+      assert_equal 2, tmpdir.glob.length
+      assert_equal %w(foo bar).sort, tmpdir.glob.collect{|p| p.basename }.sort
+    end
+  end
+end
+

data/test/scout/simple_opt/test_get.rb

@@ -0,0 +1,11 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require 'scout/simple_opt'
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestSOPTParse < Test::Unit::TestCase
+  def test_consume
+    SOPT.parse("-f--first* first arg:-f--fun")
+    args = "-f myfile --fun".split(" ")
+    assert_equal "myfile", SOPT.consume(args)[:first]
+  end
+end

data/test/scout/simple_opt/test_parse.rb

@@ -0,0 +1,10 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require 'scout/path'
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestSOPTParse < Test::Unit::TestCase
+  def test_parse
+    SOPT.parse("-f--first* first arg:-f--fun")
+    assert_equal "fun", SOPT.shortcuts["fu"]
+  end
+end

data/test/scout/simple_opt/test_setup.rb

@@ -0,0 +1,77 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require 'scout/simple_opt'
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestSOPTSetup < Test::Unit::TestCase
+  def setup
+    SOPT.inputs = nil
+    SOPT.input_types = nil
+    SOPT.input_descriptions = nil
+    SOPT.input_shortcuts = nil
+  end
+
+  def test_setup
+    SOPT.setup <<-EOF
+Test application
+
+$ test cmd -arg 1
+
+It does some imaginary stuff
+
+-a--arg* Argument
+-a2--arg2* Argument
+
+    EOF
+
+    assert_equal "test cmd -arg 1", SOPT.synopsys
+    assert SOPT.inputs.include? "arg"
+    assert SOPT.inputs.include? "arg2"
+  end
+
+  def test_setup_alt
+    SOPT.setup <<-EOF
+Test application
+
+It does some imaginary stuff
+
+-a--arg* Argument
+-a2--arg2* Argument
+
+    EOF
+
+    assert SOPT.inputs.include? "arg"
+    assert SOPT.inputs.include? "arg2"
+  end
+
+  def test_setup_alt2
+    SOPT.setup <<-EOF
+Test application
+
+-a--arg* Argument
+-a2--arg2* Argument
+
+    EOF
+
+    assert SOPT.inputs.include? "arg"
+    assert SOPT.inputs.include? "arg2"
+  end
+
+  def test_setup_alt3
+    SOPT.setup <<-EOF
+Pulls the values from a tsv colum
+
+$ rbbt tsv values [options] <filename.tsv|->
+
+Use - to read from STDIN
+
+-tch--tokyocabinet File is a tokyocabinet hash database
+-tcb--tokyocabinet_bd File is a tokyocabinet B database
+-h--help Print this help
+    EOF
+
+    assert SOPT.inputs.include? "tokyocabinet"
+  end
+
+end
+
+

data/test/scout/test_meta_extension.rb

@@ -5,10 +5,10 @@ class TestMetaExtension < Test::Unit::TestCase
   module ExtensionClass
     extend MetaExtension
 
-    extension_attr :code
+    extension_attr :code, :code2
   end
 
-  def test_setup
+  def test_setup_annotate
     str = "String"
     ExtensionClass.setup(str, :code)
     assert ExtensionClass === str
@@ -18,5 +18,19 @@ class TestMetaExtension < Test::Unit::TestCase
     str.annotate(str2)
     assert_equal :code, str2.code
   end
+
+  def test_setup_alternatives
+    str = "String"
+
+    ExtensionClass.setup(str, :code2 => :code)
+    assert_equal :code, str.code2
+
+    ExtensionClass.setup(str, code2: :code)
+    assert_equal :code, str.code2
+
+    ExtensionClass.setup(str, "code2" => :code)
+    assert_equal :code, str.code2
+
+  end
 end
 

data/test/scout/test_misc.rb

@@ -0,0 +1,13 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestMisc < Test::Unit::TestCase
+  def test_in_dir
+    TmpFile.with_file do |tmpdir|
+      Misc.in_dir tmpdir do
+        assert_equal tmpdir, FileUtils.pwd
+      end
+    end
+  end
+end
+

data/test/scout/test_path.rb

@@ -32,5 +32,21 @@ class TestPath < Test::Unit::TestCase
     assert_equal 'scout', path.pkgdir
     assert path.libdir.end_with?("scout-gear")
   end
+
+  def test_lib_dir
+    TmpFile.with_file do |tmpdir|
+      Path.setup tmpdir
+      FileUtils.mkdir_p tmpdir.lib
+      File.write tmpdir.lib.file, <<-EOR 
+require '#{File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')}'
+a = "1"
+Path.setup(a)
+print a.libdir
+      EOR
+      Misc.in_dir tmpdir.tmp do
+        assert_equal tmpdir, `ruby #{tmpdir.lib.file}`
+      end
+    end
+  end
 end