scout-essentials 1.3.1 → 1.5.0

data/scout-essentials.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-essentials 1.3.1 ruby lib
+# stub: scout-essentials 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "scout-essentials".freeze
-  s.version = "1.3.1"
+  s.version = "1.5.0".freeze
 
   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-11-07"
+  s.date = "2024-05-28"
   s.description = "Things a scout can use anywhere".freeze
   s.email = "mikisvaz@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -27,6 +27,10 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/scout-essentials.rb",
+    "lib/scout/annotation.rb",
+    "lib/scout/annotation/annotated_object.rb",
+    "lib/scout/annotation/annotation_module.rb",
+    "lib/scout/annotation/array.rb",
     "lib/scout/cmd.rb",
     "lib/scout/concurrent_stream.rb",
     "lib/scout/config.rb",
@@ -42,13 +46,13 @@ Gem::Specification.new do |s|
     "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/math.rb",
     "lib/scout/misc/monitor.rb",
     "lib/scout/misc/system.rb",
     "lib/scout/named_array.rb",
@@ -85,6 +89,8 @@ Gem::Specification.new do |s|
     "share/color/color_names",
     "share/color/diverging_colors.hex",
     "share/software/install_helpers",
+    "test/scout/annotation/test_annotated_object.rb",
+    "test/scout/annotation/test_array.rb",
     "test/scout/indiferent_hash/test_case_insensitive.rb",
     "test/scout/indiferent_hash/test_options.rb",
     "test/scout/log/test_color.rb",
@@ -92,7 +98,9 @@ Gem::Specification.new do |s|
     "test/scout/log/test_progress.rb",
     "test/scout/misc/test_digest.rb",
     "test/scout/misc/test_filesystem.rb",
+    "test/scout/misc/test_helper.rb",
     "test/scout/misc/test_insist.rb",
+    "test/scout/misc/test_math.rb",
     "test/scout/misc/test_system.rb",
     "test/scout/open/test_lock.rb",
     "test/scout/open/test_remote.rb",
@@ -111,12 +119,12 @@ Gem::Specification.new do |s|
     "test/scout/simple_opt/test_get.rb",
     "test/scout/simple_opt/test_parse.rb",
     "test/scout/simple_opt/test_setup.rb",
+    "test/scout/test_annotation.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",
@@ -128,17 +136,17 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/mikisvaz/scout-essentials".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.5.0.dev".freeze
+  s.rubygems_version = "3.5.10".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"])
+  s.add_development_dependency(%q<shoulda>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12".freeze])
+  s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0".freeze])
+  s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<term-ansicolor>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<yaml>.freeze, [">= 0".freeze])
 end
 

data/test/scout/annotation/test_array.rb

@@ -0,0 +1,119 @@
+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 TestAnnotationArray < Test::Unit::TestCase
+  module AnnotationClass
+    extend Annotation
+
+    annotation :code, :code2
+  end
+
+  module AnnotationClass2
+    extend Annotation
+
+    annotation :code3, :code4
+  end
+
+  def test_array
+    ary = ["string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+    assert_equal [AnnotationClass], ary.annotation_types
+    assert_equal code, ary.code
+    assert_equal code, ary[0].code
+
+    assert_equal code, ary.first.code
+    assert_equal code, ary.last.code
+  end
+
+  def test_array_first_last
+    %w(first last).each do |method|
+      ary = ["string"]
+      code = "Annotation String"
+      AnnotationClass.setup(ary, code)
+      ary.extend AnnotatedArray
+      assert_equal [AnnotationClass], ary.annotation_types
+
+      assert_equal code, ary.send(method).code
+    end
+  end
+
+  def test_array_each
+    ary = ["string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    codes = []
+    ary.each{|v| codes << v.code }
+    assert_equal [code], codes
+  end
+
+  def test_array_inject
+    ary = ["string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    codes = []
+    codes = ary.inject(codes){|acc,v| acc.push(v.code) }
+    assert_equal [code], codes
+  end
+
+  def test_array_collect
+    ary = ["string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    codes = ary.collect{|v| v.code }
+    assert_equal [code], codes
+  end
+
+  def test_array_collect_no_block
+    ary = ["string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    codes = ary.collect
+    assert_equal ["string"], codes
+  end
+
+  def test_compact
+    ary = [nil,"string"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    assert_equal code, ary.compact.first.code
+  end
+
+  def test_reverse
+    ary = ["string2", "string1"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    assert_equal code, ary.reverse.first.code
+    assert_equal "string1", ary.reverse.first
+  end
+
+  def test_purge
+    ary = ["string2", "string1"]
+    code = "Annotation String"
+    AnnotationClass.setup(ary, code)
+    ary.extend AnnotatedArray
+
+    assert Annotation.is_annotated?(ary)
+    assert Annotation.is_annotated?(ary.first)
+
+    ary = Annotation.purge(ary)
+
+    refute Annotation.is_annotated?(ary)
+    refute Annotation.is_annotated?(ary.first)
+
+  end
+end
+

data/test/scout/misc/test_digest.rb

@@ -26,5 +26,59 @@ class TestMiscDigest < Test::Unit::TestCase
       end
     end
   end
+
+  def test_file_digest
+    content1 =<<-EOF
+This is one file
+    EOF
+
+    content2 =<<-EOF
+This is another file
+    EOF
+
+    TmpFile.with_file(content1) do |file1|
+      TmpFile.with_file(content2) do |file2|
+        digest1 = Misc.digest_file(file1)
+        digest2 = Misc.digest_file(file2)
+        refute_equal digest1, digest2
+      end
+    end
+  end
+
+  def test_file_digest_fast
+    content1 =<<-EOF
+This is one file
+    EOF
+
+    content2 =<<-EOF
+This is another file
+    EOF
+
+    TmpFile.with_file(content1) do |file1|
+      TmpFile.with_file(content2) do |file2|
+        digest1 = Misc.fast_file_md5(file1, 5)
+        digest2 = Misc.fast_file_md5(file2, 5)
+        refute_equal digest1, digest2
+      end
+    end
+  end
+
+  def test_file_digest_fast_2
+    content1 =<<-EOF
+This is file 2
+    EOF
+
+    content2 =<<-EOF
+This is file 1
+    EOF
+
+    TmpFile.with_file(content1) do |file1|
+      TmpFile.with_file(content2) do |file2|
+        digest1 = Misc.fast_file_md5(file1, 5)
+        digest2 = Misc.fast_file_md5(file2, 5)
+        refute_equal digest1, digest2
+      end
+    end
+  end
 end
 

data/test/scout/misc/test_filesystem.rb

@@ -26,5 +26,33 @@ class TestFilesystem < Test::Unit::TestCase
       assert Misc.path_relative_to(File.dirname(tmpdir), File.join(tmpdir, "foo"))
     end
   end
+
+  def test_tarize
+    TmpFile.with_path do |source|
+      Open.write(source.data.file1, 'test1')
+      Open.write(source.data.file2, 'test2')
+      TmpFile.with_path extension: 'tar.gz' do |tarball|
+        Misc.tarize(source, tarball)
+        TmpFile.with_path do |dest|
+          Misc.untar(tarball, dest)
+          assert dest.data.file1.exists?
+          assert_equal 'test2', Open.read(dest.data.file2)
+        end
+      end
+    end
+  end
+
+  def test_tarize_stream
+    TmpFile.with_path do |source|
+      Open.write(source.data.file1, 'test1')
+      Open.write(source.data.file2, 'test2')
+      stream = Misc.tarize(source)
+      TmpFile.with_path do |dest|
+        Misc.untar(stream, dest)
+        assert dest.data.file1.exists?
+        assert_equal 'test2', Open.read(dest.data.file2)
+      end
+    end
+  end
 end
 

data/test/scout/misc/test_helper.rb

@@ -0,0 +1,14 @@
+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 TestMiscHelper < Test::Unit::TestCase
+  def test_divide
+    assert_equal 2, Misc.divide(%w(1 2 3 4 5 6 7 8 9),2).length
+  end
+
+  def test_ordered_divide
+    assert_equal 5, Misc.ordered_divide(%w(1 2 3 4 5 6 7 8 9),2).length
+  end
+
+end
+

data/test/scout/misc/test_math.rb

@@ -0,0 +1,9 @@
+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 TestMiscMath < Test::Unit::TestCase
+  def test_mean
+    assert_equal 4, Misc.mean([6,2])
+  end
+end
+

data/test/scout/path/test_find.rb

@@ -106,5 +106,37 @@ class TestPathFind < Test::Unit::TestCase
     end
   end
 
+  def test_plain_map
+    path = Path.setup("somefile")
+    TmpFile.with_path do |tmpdir|
+      Open.write(tmpdir.somefile, 'test')
+      path.path_maps["tmpdir"] = tmpdir
+      assert path.exists?
+    end
+  end
+
+  def test_add_path
+    TmpFile.with_path do |dir1|
+      TmpFile.with_path do |dir2|
+        TmpFile.with_path do |dir3|
+          TmpFile.with_path do |dir4|
+            Open.write(dir1.foo, "FOO1")
+            Open.write(dir2.foo, "FOO2")
+            Open.write(dir3.foo, "FOO3")
+            Open.write(dir4.foo, "FOO4")
+            file = Path.setup('foo')
+            file.append_path 'dir1', dir1
+            assert_equal "FOO1", Open.read(file)
+            file.prepend_path 'dir2', dir2
+            assert_equal "FOO2", Open.read(file)
+            file.prepend_path 'dir3', dir3
+            assert_equal "FOO3", Open.read(file)
+            file.append_path 'dir4', dir4
+            assert_equal "FOO3", Open.read(file)
+          end
+        end
+      end
+    end
+  end
 end
 

data/test/scout/test_annotation.rb

@@ -0,0 +1,169 @@
+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 TestAnnotation < Test::Unit::TestCase
+
+  module EmptyAnnotationClass
+    extend Annotation
+  end
+
+  module AnnotationClass
+    extend Annotation
+
+    annotation :code, :code2
+  end
+
+  module AnnotationClass2
+    extend Annotation
+
+    annotation :code3, :code4
+  end
+
+  module AnnotationClassInherit
+    extend Annotation
+
+    annotation :code_pre
+
+    include AnnotationClass
+    include AnnotationClass2
+
+    annotation :code5
+  end
+
+  def test_setup_annotate
+    str = "String"
+    refute Annotation.is_annotated?(str)
+    AnnotationClass.setup(str, :code)
+    assert AnnotationClass === str
+    assert Annotation.is_annotated?(str)
+    assert_equal :code, str.code
+
+    str2 = "String2"
+    str.annotate(str2)
+    assert_equal :code, str2.code
+  end
+
+  def test_inheritance
+    str = "String"
+    AnnotationClass.setup(str, :c, :c2)
+    assert_equal :c, str.code
+
+    str = "String"
+    AnnotationClassInherit.setup(str, :c_pre, :c, :c2, :c3, :c4, :c5)
+    assert_equal :c_pre, str.code_pre
+    assert_equal :c, str.code
+    assert_equal :c4, str.code4
+    assert_equal :c5, str.code5
+  end
+
+  def test_setup_annotate_double
+    str = "String"
+    AnnotationClass.setup(str, :c, :c2)
+    AnnotationClass2.setup(str, :c3, :c4)
+    assert Annotation.is_annotated?(str)
+    assert AnnotationClass === str
+    assert AnnotationClass2 === str
+    assert_equal :c, str.code
+    assert_equal :c2, str.code2
+    assert_equal :c3, str.code3
+    assert_equal :c4, str.code4
+
+    str2 = "String2"
+    str.annotate(str2)
+    assert Annotation.is_annotated?(str2)
+    assert AnnotationClass === str2
+    assert AnnotationClass2 === str2
+    assert_equal :c, str2.code
+    assert_equal :c2, str2.code2
+    assert_equal :c3, str2.code3
+    assert_equal :c4, str2.code4
+  end
+
+  def test_marshal
+    str = "String"
+    AnnotationClass.setup(str, :code)
+    assert AnnotationClass === str
+    assert_equal :code, str.code
+
+    str2 = Marshal.load(Marshal.dump(str))
+    assert_equal :code, str2.code
+  end
+
+  def test_setup_alternatives
+    str = "String"
+
+    AnnotationClass.setup(str, nil, :code)
+    assert_equal nil, str.code
+    assert_equal :code, str.code2
+
+    AnnotationClass.setup(str, :code2 => :code)
+    assert_equal :code, str.code2
+
+    AnnotationClass.setup(str, code2: :code)
+    assert_equal :code, str.code2
+
+    AnnotationClass.setup(str, "code2" => :code)
+    assert_equal :code, str.code2
+  end
+
+  def test_setup_block
+    o = AnnotationClass.setup nil, :code => :c, :code2 => :c2 do
+      puts 1
+    end
+
+    assert o.annotation_hash.include?(:code)
+    assert o.annotation_hash.include?(:code2)
+  end
+
+  def test_twice
+    str = "String"
+
+    AnnotationClass.setup(str, :code2 => :code)
+    assert_equal :code, str.code2
+    assert_include str.instance_variable_get(:@annotations), :code
+
+    str.extend AnnotationClass2
+    str.code3 = :code_alt
+    assert_equal :code, str.code2
+    assert_equal :code_alt, str.code3
+    assert_include str.instance_variable_get(:@annotations), :code
+    assert_include str.instance_variable_get(:@annotations), :code3
+
+    assert_include str.annotation_hash, :code
+    assert_include str.annotation_hash, :code3
+  end
+
+  def test_annotation_types
+    str = "String"
+    AnnotationClass.setup(str, :code)
+    assert AnnotationClass === str
+    assert_include str.annotation_types, AnnotationClass
+  end
+
+  def test_meta_setup
+    str = "String"
+    Annotation.setup(str, [AnnotationClass], code: 'Some code')
+
+    assert_equal 'Some code', str.code
+  end
+
+  def test_empty
+    refute EmptyAnnotationClass.setup("foo").nil?
+  end
+
+  def test_dump
+    a = AnnotationClass.setup("a", code: 'test1', code2: 'test2')
+    d = Marshal.dump(a)
+    a2 = Marshal.load(d)
+    assert_equal 'test1', a2.code
+  end
+
+  def test_dump_array
+    a = AnnotationClass.setup(["a"], code: 'test1', code2: 'test2')
+    a.extend AnnotatedArray
+    d = Marshal.dump(a)
+    a2 = Marshal.load(d)
+    assert_equal 'test1', a2.first.code
+  end
+end
+

data/test/scout/test_persist.rb

@@ -158,11 +158,27 @@ class TestPersist < Test::Unit::TestCase
   end
 
   def test_path_prefix
-    Persist.persist('foo', :tsv, :prefix => "TSV") do |filename|
+    Persist.persist('foo', :marshal, :prefix => "TSV") do |filename|
       assert File.basename(filename).start_with? "TSV"
     end
   end
 
+  def test_persist_with_data
+    res = Persist.persist('foo', :marshal, :prefix => "TSV", :data => {3 => 4}) do |data|
+      data[1] = 2
+    end
+    assert_equal 2, res[1]
+    assert_equal 4, res[3]
+    res2 = nil
+    assert_nothing_raised do
+      res2 = Persist.persist('foo', :marshal, :prefix => "TSV", :data => {}) do |data|
+        raise
+      end
+    end
+    assert_equal 2, res2[1]
+    assert_equal 4, res2[3]
+  end
+
   def __test_speed
     times = 100_000
     TmpFile.with_file do |tmpfile|

data/test/scout/test_resource.rb

@@ -1,6 +1,7 @@
 require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
 require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
 
+require 'scout/resource/scout'
 class TestResourceUnit < Test::Unit::TestCase
   module TestResource
     extend Resource
@@ -8,19 +9,18 @@ class TestResourceUnit < Test::Unit::TestCase
     self.subdir = Path.setup('tmp/test-resource')
   end
 
-
   def test_root
 
     p = TestResource.root.some_file
     assert p.find(:user).include?(ENV["HOME"])
   end
 
-  def __test_identify
-    assert_equal 'etc/', Rbbt.identify(File.join(ENV["HOME"], '.rbbt/etc/'))
-    assert_equal 'share/databases/', Rbbt.identify('/usr/local/share/rbbt/databases/')
-    assert_equal 'share/databases/DATABASE', Rbbt.identify('/usr/local/share/rbbt/databases/DATABASE')
-    assert_equal 'share/databases/DATABASE/FILE', Rbbt.identify('/usr/local/share/rbbt/databases/DATABASE/FILE')
-    assert_equal 'share/databases/DATABASE/FILE', Rbbt.identify(File.join(ENV["HOME"], '.rbbt/share/databases/DATABASE/FILE'))
-    assert_equal 'share/databases/DATABASE/FILE', Rbbt.identify('/usr/local/share/rbbt/databases/DATABASE/FILE')
+  def test_identify
+    assert_equal 'etc', Scout.identify(File.join(ENV["HOME"], '.scout/etc'))
+    assert_equal 'share/databases', Resource.identify('/usr/local/share/scout/databases/')
+    assert_equal 'share/databases/DATABASE', Resource.identify('/usr/local/share/scout/databases/DATABASE')
+    assert_equal 'share/databases/DATABASE/FILE', Resource.identify('/usr/local/share/scout/databases/DATABASE/FILE')
+    assert_equal 'share/databases/DATABASE/FILE', Resource.identify(File.join(ENV["HOME"], '.scout/share/databases/DATABASE/FILE'))
+    assert_equal 'share/databases/DATABASE/FILE', Resource.identify('/usr/local/share/scout/databases/DATABASE/FILE')
   end
 end