z4db 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70a2984533d083826403fd48e3e4e321e1861e39e3a89377dc89536eb5911a27
-  data.tar.gz: 243b4fd05733ac35a0be38571766696e17dd8e3c8252e895d3cb1cd55ae54d1c
+  metadata.gz: 7b1e0e7ec2f3ad482785ca8e89aeeaddda66236fae9c502f67befa2620a95333
+  data.tar.gz: d0f7542565c5cde7a7a65bb77582c2fa54ae64630bfd7c1db0969ba62609887b
 SHA512:
-  metadata.gz: 69a63148b7597521bbbeb387c487f4a2fd9bbe92a56fcfba501a01905fcbbb8abdbb63ff99f44ae586ae44f7bd9123b468821d15b90f5daccf69042e7cee3081
-  data.tar.gz: d3d3598de940c5c9c15f1d84f8d030c4636590638e430b9a953a0f97a7732bb2eec8ad8437491817d7c45ba992787ca72b7678ae1b7032d80c95c8460788e329
+  metadata.gz: 1675fc03143d446230ac7c2f6b4c2bdb5513126193349bb02107031d516ef9faa72c7479e11ced81e24ebe7ea5a2fc1b550fa3c58237c72f854fa36fef480477
+  data.tar.gz: c7d586a9d4649eba2df977a23a8e1c362d18e575843906f0017ccbf7e25d292cae9727e02ea788ef7731bebc98e38d19512c7b3ee9fd8635e2e4b2e83aac5c91

data/lib/z4db/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Z4db
-  VERSION = '0.0.0'
+  VERSION = '0.0.2'
   COMMIT = `git log --format="%H" -n 1`.strip
 end

data/lib/z4db.rb

@@ -2,9 +2,15 @@
 
 require 'pstore'
 
+require 'z4blockchain'
+
 require_relative "z4db/version"
 
-module Z4db
+if !Dir.exist? "db"
+  Dir.mkdir "db"
+end
+
+module Z4DB
   class Error < StandardError; end
   class DB
     def initialize(*k);
@@ -17,17 +23,30 @@ module Z4db
       @cal = PStore.new(%[db/#{@id}.events.pstore])
       @sub = {}
       @current = %[]
+      @bank = Z4BC[@id]
       puts %[DB: #{@id}]
     end
-    
+
+    ##
+    # blockchain backed transaction store
+    def bank
+      @bank
+    end
+    ##
+    # the database key
     def id; @id; end;
+    ##
+    # the database object type
     def type; @type; end;
+    ##
+    # the index of object type
     def index; @index; end
-    
+
+    ##
     # incr / decr by :num
     def tick(k,h={num: 1}); @db.transaction { |db| x = db[k.to_sym].to_i; db[k.to_sym] = x + h[:num] }; end
-    
-    # push i to list
+    ##
+    # push i to list and ensure uniqueness
     def add(l,i,*u);
       @db.transaction {|db|
         db[l] ||= [];
@@ -37,12 +56,14 @@ module Z4db
         end
       };
     end
-    
+    ##
+    # access subtable
     def sub(k)
       add(:subs, k, :uniq)
-      Z4db[@id, k]
+      Z4DB[@id, k]
     end
 
+    #
     # remind "date time string in some fashion.", "event info"...
     def remind k, *a
       kk = Z4.datetime(k).strftime('%Y/%m/%d AT %H:%M');
@@ -52,7 +73,8 @@ module Z4db
       File.open("reminders/#{@id}.rem", 'w') {|f| f.write(o.join("\n") + %[\n]); }
       return o.length
     end
-
+    ##
+    # add log entry
     def log *a
       kk = Time.now.strftime('%Y/%m/%d AT %H:%M');
       v = a.join(" ")
@@ -61,14 +83,16 @@ module Z4db
       File.open("reminders/#{@id}.rem", 'w') {|f| f.write(o.join("\n") + %[\n]); }
       return o.length
     end
-    
+    ##
+    # remove reminder
     def forget k
       kk = Z4.datetime(k).strftime('%Y/%m/%d AT %H:%m ');
       o = []
       @cal.transaction { |db| db.delete(kk); db.keys.each { |e| o << %[REM #{e} MSG #{db[e]}] } }
       File.open("reminders/#{@id}.rem", 'w') {|f| f.write(o.join("\n") + %[\n]); }
     end
-
+    ##
+    # pull agenda from reminders
     def agenda
       o = []
       `remind -s reminders/#{@id}.rem`.chomp.gsub(' *', '').split("\n").each { |e|
@@ -79,20 +103,29 @@ module Z4db
       return o
     end
 
+    ##
+    # generate plaintext calendar
     def calendar
       `remind -c reminders/#{@id}.rem`.chomp.gsub("\f","").split("\n")
     end
-    
+
+    ##
+    # define or execute db events
     def on(k, h={}, &b); if block_given?; @ev[k] = b; else; @db.transaction { |db| @ev[k.to_sym].call(db, h) }; end; end
-    # getter
+    ##
+    # key getter
     def [](k); @db.transaction { |db| db[k] }; end
-    # setter
+    ##
+    # key setter
     def []=(k,v); @db.transaction { |db| db[k]=v }; end
+    ##
     # transaction wrapper
     def transaction(&b); @db.transaction { |db| b.call(db) }; end
+    ##
     # defined keys
     def keys; @db.transaction { |db| db.keys }; end
-    # bulk output
+    ##
+    # db object to hash
     def to_h;
       h= {};
       @db.transaction { |db| db.keys.each { |e| h[e] = db[e]; } };
@@ -100,22 +133,12 @@ module Z4db
     end
     private
     # get remote object from local.
-    def get(k); Z4[k, to_h[k]]; end
+    def get(k); Z4DB[k, to_h[k]]; end
   end
+  ##
+  # access db object
   def self.[] *k
     DB.new(k)
   end
 end
 
-if !Dir.exist? "db"
-  Dir.mkdir "db"
-  puts "[+][z4db][#####] created 'db' directory."
-  puts " | [z4db][objects] @user = Z4db[:user, 'wxyz'];"
-  puts " | [z4db][sub-objects] @inventory = @user.sub(:inventory);"
-  puts " | [z4db][set] @user[:key] = 'value.';"
-  puts " | [z4db][get] k = @user[:key]; => { key: 'value.' }"
-  puts ' | [z4db][events][create] @user.on(:zap) { |db, h| tick(:zaps); puts %[ZAP: #{h}] }'
-  puts ' | [z4db][events][trigger] @user.on(:zap, from: "abcd");'
-  puts " | [z4db][object] h = @user.to_h;"
-  puts "[+][z4db][#####] https://github.com/xorgnak/z4db"
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: z4db
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Erik Olson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pstore