exedb 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5372419cdccd2512e7cce207d8a2f5b776154827
-  data.tar.gz: 6666d7b9cb0c9024fd98bf705b574a9057e3c262
+  metadata.gz: 2edd3f5d079de4f4fe759bc639c12848fdc1b384
+  data.tar.gz: ea2957752bc6856ed29bc50a1813caa977a46bf4
 SHA512:
-  metadata.gz: 926ad8b21503f804fa0103ae086cbf0f462cc042bac75d2de27085ced49b6d7a967436bb5ce030dce57e2c681d07ca056da116c66786ce61c168f4d014a9c33a
-  data.tar.gz: aed6a928cb676ad836e8075f288480aa1b887983d882e35ca7391026a6efccb07da1cefc610642ca05170cf9278f8a7964c55cf5637eab43cea0a64e3883b8d2
+  metadata.gz: fb50137af58069d48b51c058f876e268ba46913ce5c0ce1b57a39ad2892ae3919775ee21f42ad9858df3177406ffa098e8e97bc41e45db882b1273866ed39b90
+  data.tar.gz: d1dcc865f0751ed9115334b9cd6751c532a63f4c839c6b47d9747e0c5a58a93da4f1c6c2b273fb9d7a5f84eb0c5f86d1c06f62f5e80c0a9cbf83c61812123c54

data/lib/exedb/version.rb

@@ -1,3 +1,3 @@
 class Exedb
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

data/lib/exedb.rb

@@ -1,6 +1,21 @@
 require 'digest'
 require 'time'
 
+#
+# Database-like interface for long-running tasks.
+#
+# Each instance can run single command (get).
+# If two or more instances with the same command do 'get', then only first
+# will really execute command, all others will wait
+# for result (flock is used).
+#
+# Results of command execution (stdout) is cached. Next 'get'
+# will return cached results (unless cache timeout happened).
+#
+# You can force execution, calling 'update' method.
+#
+# Exit code is available via 'code' method
+#
 class Exedb
 
   SLEEP_TIME=1
@@ -10,26 +25,49 @@ class Exedb
   attr_accessor :cache_timeout, :cache_dir
   attr_reader :update_time
 
+  # Constructor
+  # @str - command to be executed
+  #
   def initialize(str='')
     @update_time=Time.parse("1970-01-01")
     @cache_timeout=DEF_CACHE_TIMEOUT
     @cache_dir=DEF_DIR
+    @code=-1
     Dir.mkdir DEF_DIR unless File.directory? DEF_DIR
     self.update_method=(str)
   end
 
-  def generate_key u
-    return Digest::SHA256.hexdigest u
-  end
-
+  # Force command execution. If another instance with
+  # the same command is in progress, no new execution
+  # will be started
   def update
+    @content=''
     File.open(@path, File::RDWR|File::CREAT, 0644) { |file|
       if file.flock(File::LOCK_EX|File::LOCK_NB)
-        @content=`#{@update_method}`
+        begin
+          IO.popen(@update_method){|pipe|
+            line=pipe.gets
+            while line
+              file.puts line
+              file.flush
+              @content = @content+line
+              line=pipe.gets
+            end
+          }
+          @code=$?.exitstatus
+          #warn "UPDATED: #{@content}/#{@code}"
+        rescue
+          @content=''
+          @code=-1
+        end
         file.write @content
         file.flush
+        File.open("#{@path}.code",File::RDWR|File::CREAT, 0644){|code_file|
+          code_file.puts @code
+        }
         file.flock(File::LOCK_UN)
       else
+        warn "CANNOT LOCK"
         read_cache
       end
       @update_time=Time.now
@@ -38,6 +76,9 @@ class Exedb
     @content
   end
 
+  #
+  # Replace executing command
+  #
   def update_method=(str)
     @update_method=str
     @key=generate_key str
@@ -45,38 +86,48 @@ class Exedb
 #    warn "key=#{@key}; path=#{@path}; u=#{str}"
   end
 
-  def read_cache
-    File.open(@path, File::RDONLY) { |file|
-      file.flock(File::LOCK_EX)
-      @content=file.read
-      file.flock(File::LOCK_UN)
-    }
+  # Just alias for update_method=
+  def put(str)
+    self.update_method=(str)
   end
 
+  #
+  # Get last execution result (stdout), or start new
+  # command execution and return result if cache is
+  # invalid.
+  #
   def get
-    state=cache_state
-    #warn "CACHED: #{state}"
-    case state
-    when :need_update
-      update
-    when :need_reread
-      #!!!warn "read cached"
-      read_cache
-    end
+    actualize
     @content
   end
 
-#  def get
-#    return get_cached
-#    #warn "Get: #{@update_time}+#{@cache_timeout}>#{Time.now}"
-#    if @update_time+@cache_timeout>Time.now
-#      # not need to update cache
-#      get_cached
-#    else
-#      update
-#    end
-#  end
+  #
+  # Get last execution return code.
+  # NOTE!!! It is also cached, even on error.
+  #
+  def code
+    actualize
+    @code
+  end
+
+  #
+  # Do not execute command - just peek in cache file...
+  # Usefull for intermediate command output peeking
+  #
+  def peek
+    begin
+      File.read(@path)      
+    rescue
+      ''
+    end
+  end
 
+  #
+  # Returns symbol of cache state:
+  # - updated = actual
+  # - need_update = new command execution needed
+  # - need_reread = just cache file reread is neede
+  #
   def cache_state
     if File.exists? @path
       mtime=File.mtime(@path)
@@ -99,4 +150,32 @@ class Exedb
     end
     return false
   end
+
+protected
+
+  def actualize
+    case cache_state
+    when :need_update
+      update
+    when :need_reread
+      read_cache
+    end
+  end
+
+  def generate_key u
+    return Digest::SHA256.hexdigest u
+  end
+
+  def read_cache
+    File.open(@path, File::RDONLY) { |file|
+      file.flock(File::LOCK_EX)
+      @content=file.read
+      File.open("#{@path}.code", File::RDONLY) { |code_file|
+        c=code_file.gets
+        c =~ /([0-9-]+)/
+        @code=$1.to_i
+      }
+      file.flock(File::LOCK_UN)
+    }
+  end
 end

data/spec/exedb_spec.rb

@@ -73,4 +73,40 @@ describe Exedb do
     end
   end
 
-end
+  describe 'return code' do
+    it 'can be read' do
+      @db.code.must_be :==, 0
+    end
+
+    it 'must be -1 if command cannnot be ran' do
+      @db=Exedb.new
+      @db.code.must_be :==, -1
+    end
+
+    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')
+      File.open("/tmp/mytestcode",'w'){|f| f.puts '1'}
+      @db.code
+      File.open("/tmp/mytestcode",'w'){|f| f.puts '2'}
+      @db2.update
+
+      @db.code.must_be :==, 2
+    end
+  end
+
+  describe 'intermediate output' do
+    it 'cam be read while command is in progress' do
+      CMD4='for i in 1 2 3 4; do echo x; sleep 1; done'
+      @db=Exedb.new(CMD4)
+      @db2=Exedb.new(CMD4)
+      t=Thread.new {
+        @db.get
+      }
+      sleep 3
+      x=@db2.peek
+      x.must_match /^x\nx(\nx?)$/m
+      t.join
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exedb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergey Zhumatiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-31 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler