exedb 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 921bf48af155069a43bd8f50707a144f1a2501b7
-  data.tar.gz: 3bb71a327b6ef83e40495f5f6b6e0781d4f7d095
+  metadata.gz: 3a2b5ff6b9726798cbba0e04538f9b8e1b9bc3e2
+  data.tar.gz: 96b44c2dba5858cdfa11288b0fd61813235103a1
 SHA512:
-  metadata.gz: d722b3968b6654d211180277070871dc631b9a3f814c889151785021b1a3584da9e3767a178280a0f99eded7c09a4189dd0f06f7241f11c3e50e529b94e979ae
-  data.tar.gz: c2513f1e53c6b06325c0ea1b0f2371ec306ee09ea26e5248f1abc098a0926cdc2eca56d26dd6050398b1c161f4105820820a8c03f6f377fa8808bd1c14d2a8a8
+  metadata.gz: 7bacc3f2574045104054648091f6511853844eb48f4ddbd9eac6c310625d0d17803ff243ef640badfbe6bf6db2fb6c5d72d88cbb3d1c374fb3dfbba2f0fdc316
+  data.tar.gz: 7cc175baacd4b7b108eb2d00da578f5cc1ccf4106b590508513fdbf0c37069c27ed368f641d1b80648e404052809b3f13d8482a23a14e1ab9ccd3efc3f24c72c

data/lib/exedb.rb

@@ -16,13 +16,36 @@ require 'time'
 #
 # Exit code is available via 'code' method
 #
+# Example:
+#    d=Exedb.new("ls -la .")
+#    d.cache_timeout=5  # 5 seconds for cache expire
+#    list=d.get    # execute 'ls' and get list of files
+#    list=d.get    # just get list again (cached)
+#    sleep 5
+#    list=d.get    # execute 'ls' again and get result
+#    list=d.update # force 'ls' execution!
+#    d.line_transform {|l|
+#      if l =~ /^d.*(\S+)$/
+#         return "DIR: $1"   # not correct, do not use in production :)
+#      elsif l =~ /^-.*(\S+)$/
+#         return "FILE: $1"  # just transform example
+#      else
+#         return nil         # skip this line
+#      end
+#    }
+#    d.update   # get list of directories and files in special format
+#
 class Exedb
 
   SLEEP_TIME=1
   DEF_DIR='/tmp/Exedb'
   DEF_CACHE_TIMEOUT=60
 
-  attr_accessor :cache_timeout, :cache_dir
+  # directory for cache files
+  attr_accessor :cache_dir
+  # default cache timeout
+  attr_accessor :cache_timeout
+  # last cache update time
   attr_reader :update_time
 
   # Constructor
@@ -92,6 +115,10 @@ class Exedb
   # transform each line in command output
   # if nil is returned, line is skipped
   #
+  # Example:
+  #    @d.line_transform {|str|
+  #       str.downcase
+  #    }
   def line_transform(&block)
     if block
       obj = Object.new
@@ -114,6 +141,10 @@ class Exedb
   # block is called with parameters: content, return code
   # returned content replaces original output
   #
+  # Example:
+  #    @d.all_transform {|str,code|
+  #       "Total: #{str.lines.count} lines\nExit code: #{code}"
+  #    }
   def all_transform(&block)
     if block
       obj = Object.new
@@ -124,6 +155,9 @@ class Exedb
     end
   end
 
+  #
+  # cancel transformation of full output
+  #
   def no_all_transform
     @alltransform=nil
   end
@@ -175,9 +209,9 @@ class Exedb
 
   #
   # Returns symbol of cache state:
-  # - updated = actual
-  # - need_update = new command execution needed
-  # - need_reread = just cache file reread is neede
+  # - :updated = actual
+  # - :need_update = new command execution needed
+  # - :need_reread = just cache file reread is neede
   #
   def cache_state
     if File.exists? @path
@@ -217,14 +251,14 @@ protected
     f=u.tr('^qwertyuiopasdfghjklzxcvbnm_-','')
     d=Digest::SHA256.hexdigest(u)
     return f[0,60]+'..'+f[-60,60]+d if f.size>128
-#    return f+d
+    return f+d
   end
 
   def read_cache
     File.open(@path, File::RDONLY) { |file|
       file.flock(File::LOCK_EX)
       @content=file.read
-      warn "CACHE READ: #{@content}"
+#      warn "CACHE READ: #{@content}"
       begin
         File.open("#{@path}.code", File::RDONLY) { |code_file|
           c=code_file.gets

data/lib/exedb/version.rb

@@ -1,3 +1,3 @@
 class Exedb
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/exedb_spec.rb

@@ -2,6 +2,7 @@ require 'minitest/autorun'
 require "exedb"
 
 TEST_DIR='/tmp/exedb_test'
+TEST_CACHE_DIR='/tmp/exedb_test_cache'
 TEST_FILE='abc_file'
 TEST_FILE2='efg_file'
 
@@ -11,6 +12,7 @@ describe Exedb do
     FileUtils.rm_rf Exedb::DEF_DIR
 
     @db=Exedb.new
+    @db.cache_dir=TEST_CACHE_DIR
     FileUtils.rm_rf TEST_DIR
     Dir.mkdir TEST_DIR
     File.open(File.join(TEST_DIR,TEST_FILE), "w") { |io| io.puts "ok" }
@@ -46,6 +48,7 @@ describe Exedb do
   describe 'parallel istances' do
     before do
       @db2=Exedb.new
+      @db2.cache_dir=TEST_CACHE_DIR
       @db2.update_method="sleep 1;ls -la #{TEST_DIR}"
       @db.update
     end
@@ -84,6 +87,8 @@ describe Exedb do
     it 'must read cached value' do
       @db=Exedb.new('x=`cat /tmp/mytestcode`; echo ">>$x<<"; exit $x')
       @db2=Exedb.new('x=`cat /tmp/mytestcode`; echo ">>$x<<"; exit $x')
+      @db.cache_dir=TEST_CACHE_DIR
+      @db2.cache_dir=TEST_CACHE_DIR
       File.open("/tmp/mytestcode",'w'){|f| f.puts '1'}
       @db.code
       File.open("/tmp/mytestcode",'w'){|f| f.puts '2'}
@@ -98,6 +103,8 @@ describe Exedb do
       CMD4='for i in 1 2 3 4; do echo x; sleep 1; done'
       @db=Exedb.new(CMD4)
       @db2=Exedb.new(CMD4)
+      @db.cache_dir=TEST_CACHE_DIR
+      @db2.cache_dir=TEST_CACHE_DIR
       t=Thread.new {
         @db.get
       }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exedb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Sergey Zhumatiy