exedb 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sergey Zhumatiy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+Exedb
+-----
+
+This is simple Ruby class, which implements
+database-like interface for executables.
+
+For example:
+
+```ruby
+e=Exedb.new("my_long_working_exe arg1 arg2")
+e.cache_timeout=10 # 10 seconds timeout
+
+e.get # run and return exe output
+e.get # just return exe output again!
+sleep 10
+e.get # run exe again (cache is timed out)
+e.update # run exe and update cache NOW!
+```
+
+If another program is running another instance on the
+same Exedb it will wait for first one finish.
+
+
+Methods and constants
+---------------------
+
+- ::new(str=nil) - create new instance, str=exec line
+- ::DEF_DIR - default dir for cache files
+- ::DEF_CACHE_TIMEOUT - default cache timeout
+
+- \#get - get exe output
+- \#update - run exe anyway, return output
+
+Accessors
+--------
+
+- cache_timeout
+- cache_dir
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+    t.pattern = "spec/*_spec.rb"
+end
+require "bundler/gem_tasks"

data/exedb.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exedb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exedb"
+  spec.version       = Exedb::VERSION
+  spec.authors       = ["Sergey Zhumatiy"]
+  spec.email         = ["serg@parallel.ru"]
+  spec.summary       = %q{Quazi-database for executables.}
+  spec.description   = %q{Database-like interface to execute long tasks. With caching.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/exedb/version.rb

@@ -0,0 +1,3 @@
+class Exedb
+  VERSION = "0.0.1"
+end

data/lib/exedb.rb

@@ -0,0 +1,101 @@
+require 'digest'
+require 'time'
+
+class Exedb
+
+  SLEEP_TIME=1
+  DEF_DIR='/tmp/Exedb'
+  DEF_CACHE_TIMEOUT=60
+
+  attr_accessor :cache_timeout, :cache_dir
+  attr_reader :update_time
+
+  def initialize(str=nil)
+    @update_time=Time.parse("1970-01-01")
+    @cache_timeout=DEF_CACHE_TIMEOUT
+    @cache_dir=DEF_DIR
+    Dir.mkdir DEF_DIR unless File.directory? DEF_DIR
+    update_method=str
+  end
+
+  def generate_key u
+    return Digest::SHA256.hexdigest u
+  end
+
+  def update
+    File.open(@path, File::RDWR|File::CREAT, 0644) { |file|
+      if file.flock(File::LOCK_EX|File::LOCK_NB)
+        @content=`#{@update_method}`
+        file.write @content
+        file.flush
+        file.flock(File::LOCK_UN)
+      else
+        read_cache
+      end
+      @update_time=Time.now
+    }
+    #!!!warn "UPDATED!'"
+    @content
+  end
+
+  def update_method= str
+    @update_method=str
+    @key=generate_key str
+    @path=File.join DEF_DIR, @key
+  end
+
+  def read_cache
+    File.open(@path, File::RDONLY) { |file|
+      file.flock(File::LOCK_EX)
+      @content=file.read
+      file.flock(File::LOCK_UN)
+    }
+  end
+
+  def get
+    state=cache_state
+    #warn "CACHED: #{state}"
+    case state
+    when :need_update
+      update
+    when :need_reread
+      #!!!warn "read cached"
+      read_cache
+    end
+    @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
+
+  def cache_state
+    if File.exists? @path
+      mtime=File.mtime(@path)
+      return :need_update if mtime+@cache_timeout<Time.now
+      return :need_reread if @update_time<mtime
+      return :updated
+    end
+    :need_update
+  end
+
+  def update_in_progress?
+    if File.exists? @path
+      File.open(@path, File::RDONLY) { |file|
+        if file.flock(File::LOCK_EX|File::LOCK_NB)
+          file.flock(File::LOCK_UN)
+          return false
+        end
+      }
+      return true
+    end
+    return false
+  end
+end

data/spec/exedb_spec.rb

@@ -0,0 +1,76 @@
+require 'minitest/autorun'
+require "exedb"
+
+TEST_DIR='/tmp/exedb_test'
+TEST_FILE='abc_file'
+TEST_FILE2='efg_file'
+
+describe Exedb do
+  before do
+    # clean up...
+    FileUtils.rm_rf Exedb::DEF_DIR
+
+    @db=Exedb.new
+    FileUtils.rm_rf TEST_DIR
+    Dir.mkdir TEST_DIR
+    File.open(File.join(TEST_DIR,TEST_FILE), "w") { |io| io.puts "ok" }
+
+    @db.update_method="sleep 1;ls -la #{TEST_DIR}"
+  end
+
+  it 'do update by default' do
+    @db.get.must_match TEST_FILE
+  end
+
+  it 'updates state' do
+    File.open(File.join(TEST_DIR,TEST_FILE2), "w") { |io| io.puts "ok" }
+    @db.update
+    @db.get.must_match TEST_FILE2
+  end
+
+  describe 'cache' do
+    before do
+      @db.update
+      File.open(File.join(TEST_DIR,TEST_FILE2), "w") { |io| io.puts "ok" }
+    end
+    it 'caches last result' do
+      @db.get.wont_match TEST_FILE2
+    end
+
+    it 'updates cache' do
+      @db.update
+      @db.get.must_match TEST_FILE2
+    end
+  end
+
+  describe 'parallel istances' do
+    before do
+      #!!!warn "BEFORE 2>>>>>>>"
+      @db2=Exedb.new
+      @db2.update_method="sleep 1;ls -la #{TEST_DIR}"
+      @db.update
+    end
+
+    it 'reads last cached result' do
+      sleep 2;
+      #!!!warn ">>>>>>>>>>>>>>>>>>"
+      @db2.get.must_match TEST_FILE
+    end
+
+    it 'not updates cache second time' do
+      sleep 2;
+      @time=Time.now
+      @db2.get
+      (Time.now-@time).must_be :<, 0.1
+    end
+
+    it 'updates cache after timeout' do
+      @db2.cache_timeout=3
+      sleep 4;
+      @time=Time.now
+      @db2.get
+      (Time.now-@time).must_be :>, 1
+    end
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: exedb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Zhumatiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Database-like interface to execute long tasks. With caching.
+email:
+- serg@parallel.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exedb.gemspec
+- lib/exedb.rb
+- lib/exedb/version.rb
+- spec/exedb_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Quazi-database for executables.
+test_files:
+- spec/exedb_spec.rb
+has_rdoc: