kvj 0.0.3 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05ff9c7e30c82506812d379073f6d00de58d37c6
-  data.tar.gz: a19ad513e5513dfb4d7af19a05ad5f99a4a7f5ca
+  metadata.gz: b2698731d96db2800bf47ef4edba0f1dee71916b
+  data.tar.gz: d092ffd4c571fbc3f7613afb5c737be77bd4f721
 SHA512:
-  metadata.gz: caf5f3baf60c37d94d19721250307337e08b6f47004943c8580cbe74f3941f5423739890e52fbcec414d652c148cf39f39b7ac46087e5d93317764eed81f8b3d
-  data.tar.gz: df224a20c4c42ee7fa453ac5c53bc49892573f3e18242eceba38c1eb39a34f681890f9c57b4b75308c240f3c1b1b15127f27d791279fcb58d0b1ff65ae413ae7
+  metadata.gz: 140e4618e0b24760306528f7e0c030ddb2d7ddd15349718e88134f8b1f4c89bf8a76195a6e104cd8fd344a86145ddbce2120d277e875c3afab5288a8aba040fd
+  data.tar.gz: 10ab1a26b0d0deefb643fb234a7dc554e5357cfaaed051fef882be3914c26b2f6464150a311e08907b5f5599a3f1428ad45114ea02d7e99d884883d80d7e0dcc

data/lib/{base_manager.rb → base_methods.rb}

@@ -1,14 +1,14 @@
 
-module BaseManager
+module BaseMethods
   def list
-    base_directory = CONFIG['base_directory']
+    base_directory = KVJ_CONFIG['base_directory']
     databases = Dir.entries(base_directory)
     databases.delete_if { |database| database =~ /^\./ }
     databases.map { |file_name| file_name.chomp('.json') }
   end
 
   def drop(database)
-    base_directory = CONFIG['base_directory']
+    base_directory = KVJ_CONFIG['base_directory']
     File.delete(base_directory + database + '.json')
   end
 end

data/lib/kvj.rb

@@ -1,77 +1,44 @@
 require_relative 'file_connector'
-require_relative 'base_manager'
+require_relative 'base_methods'
+require_relative 'meta_hash_methods'
 require 'pry'
 require 'yaml'
 
-CONFIG = YAML.load_file('config/kvj_config.yml')
+# load config file from user defined constant of from default path
+KVJ_CONFIG_PATH ||= 'config/kvj_config.yml'.freeze
+KVJ_CONFIG = YAML.load_file(KVJ_CONFIG_PATH)
 
 class KVJ
-  extend BaseManager
+  extend BaseMethods
+  extend MetaHashMethods
+
+  def self.connect_or_create(database)
+    directory = KVJ_CONFIG['base_directory']
+    new(database, directory)
+  end
 
   def self.create(database)
-    directory = CONFIG['base_directory']
+    directory = KVJ_CONFIG['base_directory']
     return new(database, directory) unless FileConnector.exist(database, directory)
     STDERR.puts "Request to initialize a new database : #{database} but alread exists. "
     false
   end
 
   def self.connect(database)
-    directory = CONFIG['base_directory']
+    directory = KVJ_CONFIG['base_directory']
     return new(database, directory) if FileConnector.exist(database, directory)
     STDERR.puts "Request to connect to database : #{database} but does not exists. "
     false
   end
 
-  def write(key, value)
-    @file_connector.grab_ex_lock
-    hash = @file_connector.read
-    hash[key] = value
-    @file_connector.write(hash)
-    return true
-  ensure
-    @file_connector.release_lock
-  end
-
-  def read(key)
-    @file_connector.grab_sh_lock
-    data = @file_connector.read
-    return false unless key_exist(data, key, 'read')
-    return data[key]
-  ensure
-    @file_connector.release_lock
-  end
-
-  def inspect_keys
-    @file_connector.grab_sh_lock
-    @file_connector.read.keys
-  ensure
-    @file_connector.release_lock
-  end
-
-  def delete(key)
-    @file_connector.grab_ex_lock
-    data = @file_connector.read
-    return false unless key_exist(data, key, 'delete')
-    data.delete(key)
-    @file_connector.write(hash)
-  ensure
-    @file_connector.release_lock
-  end
-
-  alias []= write
-  alias [] read
-
-  def key_exist(data, key, action)
-    return true if data.key?(key)
-    STDERR.puts "Request to #{action} key : '#{key}' does not exist in database : '#{@database}' "
-    false
-  end
-
+  # the new constructor is hidden from user
+  # please use connect_or_create, create or connect instead
   def initialize(database, directory)
     @database = database
     @file_connector = FileConnector.new(database, directory)
   end
 
-  private :key_exist
-  private_class_method :new
+  # create dynamic methods for all Hash object native method
+  generate_hash_functions
+  private_class_method :new, :inheritage_hash_method, :generate_hash_functions
 end

data/lib/meta_hash_methods.rb

@@ -0,0 +1,33 @@
+module MetaHashMethods
+  def inheritage_hash_method(method, level)
+    define_method(method) do |*arg, &block|
+      begin
+        if level == :write
+          @file_connector.grab_ex_lock
+        else
+          @file_connector.grab_sh_lock
+        end
+        hash = @file_connector.read
+        return_value = hash.send(method, *arg, &block)
+        @file_connector.write(hash) if level == :write
+        return return_value
+      ensure
+        @file_connector.release_lock
+      end
+    end
+  end
+
+  def generate_hash_functions
+    methods = Hash.instance_methods - KVJ.instance_methods
+    write_methods = methods.select { |method| method =~ /=|!|delete/ }
+    read_only_methods = methods - write_methods
+
+    read_only_methods.each do |method|
+      inheritage_hash_method(method, :read)
+    end
+
+    write_methods.each do |method|
+      inheritage_hash_method(method, :write)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kvj
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.9
 platform: ruby
 authors:
 - RundongGao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,17 +24,17 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A supper light connectionless key-value storage database provides ACID
-  transcations for multiple programs.
+description: Using your key-value data just like using Ruby Hash.
 email: asphinx423@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/base_manager.rb
+- lib/base_methods.rb
 - lib/file_connector.rb
 - lib/kvj.rb
 - lib/lock_manager.rb
+- lib/meta_hash_methods.rb
 homepage: https://github.com/RundongGao/kvj
 licenses:
 - MIT
@@ -58,5 +58,6 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A supper light connectionless key-value storage database.
+summary: A supper light connectionless key-value storage database provides ACID transcations
+  for multiple programs.
 test_files: []