ssd 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc80c8adfe5a1357a0d2db0b9d58e8b4065dbda2
-  data.tar.gz: 673878b621506e2b3c05f903e39acab7739024d8
+  metadata.gz: 0825d84e4c81d08aff287bb4ec45ad3c076b652d
+  data.tar.gz: 273829d0588557664e5afbd900ed28b38b59857b
 SHA512:
-  metadata.gz: e82b63ae8407f16a14f13d68cfd135b01c64ba81ab36239c6507445507aceb95049bcc847b3c4896b090f5c4f2ece45fd1e31cb0a7d531e80c6423db460588f4
-  data.tar.gz: 2fb4d4e1c0a42ae5f6567ee549007f12f153f6e0914114d1cdbf7256cb41ec1387809a0a4669549dac47821c81e8ee5dd6626ad093f1368082fc05ed0abb9602
+  metadata.gz: a619969e3f149af20609c169b22bfff7c74aba7c192d98a5c2aa14d4c1c1808b61b116777a628a0d46ea2da72f11ce2635cc92842a521a4cf469d4bef02fa173
+  data.tar.gz: 1f2f0d24e6bc7189cf6721df3d333a21ad006324b5f8303c981c88fa20bdda768db4ca2f619a80422f716e5c24d61367b759e7640d8dbc98dbd32a07991dea07

data/README.md

@@ -4,12 +4,11 @@ SSD is an append-only, file-based, immutable key-value store for Microservices w
 
 Key Features
 =================
-- **Scalable** file-based design (each key gets its own file).
+- **Scalable** via a schemaless, thread-safe, file-based design that easily meets your data evolution needs.
 - **Immutable Append-only** tracks data evolution over time via out-of-the-box UTC timestamped appends (*accountants don't use erasers, otherwise they go to jail*).
 - **Fault Tolerance** (out-of-the-box transactional operations).
-- **Zero External Dependencies for a Measurably Low Technical Debt** (a well-maintained consciously clean lightweight library that prioritizes the sanity of your codebase and takes measures to **NEVER** complect it).
-- **Schemaless** (easily meets your data evolution needs).
-- **Key-based Rolling-forward\Rolling-back**.
+- **Zero External Dependencies for a Measurably Low Technical Debt** (a well-maintained, consciously clean, lightweight library that prioritizes the sanity of your codebase and takes measures to **NEVER** complect it).
+- **Key-based Forward\Backward Rolling**.
 - **Super Easy to Learn and Use** (up & running in mins).
 
 TODO
@@ -28,7 +27,14 @@ SSD is carefully crafted to scale specially-well with the Microservies Architetu
 
 Usage
 ======
+```
+gem install ssd
+```
+
 ```ruby 
+require 'sinatra'
+require 'ssd'
+
 module MyApp
  class User
   include SSD

data/lib/ssd.rb

@@ -5,6 +5,8 @@ require 'pstore'
 require 'digest'
 
 require_relative "./ssd/version"
+require_relative "./ssd/instance_methods"
+require_relative "./ssd/class_methods"
 
 $log = Logger.new(STDOUT)
 
@@ -16,128 +18,4 @@ module SSD
     base.send :include, InstanceMethods
     base.extend ClassMethods
   end
-
-  module InstanceMethods
-
-    def self.included(base)
-      @@ssd_name  		= base.new.class.to_s.downcase
-    end
-
-    attr_accessor :ssd
-
-    def ssd= value
-      @ssd	= value
-      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
-      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@ssd}.ssd" 
-      @@ssd_db 			= PStore.new @@ssd_path, true
-      @@ssd_db.ultra_safe 	= true
-      @@ssd_db.transaction(true) {}
-      return @@ssd_db
-    end
-
-    def transaction
-      @@ssd_db.transaction do
-	yield @@ssd_db
-	@@ssd_db.commit
-      end
-    end
-
-    def []= 
-      begin  
-	if !@ssd.nil? then 
-	  @@ssd_db.transaction do
-	    #todo should be somthing like??? timestamp instead of ssd as a key?? and use .last while reading
-	    @@ssd_db[Time.now.utc.to_s + "_" + Random.new_seed.to_s ] = self 
-	  end
-	else
-	  raise 'ssd key can not be nil. see more (documentation url)'  
-	end
-      end  
-    end
-
-    alias append! []= 
-      alias save! []= 
-      alias store! []= 
-  end
-
-  module ClassMethods
-    def self.extended(base)
-      @@ssd_name  		= base.new.class.to_s.downcase
-      #FileUtils::mkdir_p 'DS'
-      #@@ssd_path 			= "DS/#{name}.pstore" 
-      #@@ssd_db 			= PStore.new @@ssd_path, true
-      #@@ssd_db.ultra_safe 	= true
-      #@@ssd_db.transaction(true) {}
-      #@@ssd_db
-    end 
-
-    def setup ssd 
-      @@ssd = ssd
-      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
-      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@@ssd}.ssd" 
-      @@ssd_db 			= PStore.new @@ssd_path, true
-      @@ssd_db.ultra_safe 	= true
-      @@ssd_db.transaction(true) {}
-      return @@ssd_db
-    end
-
-    def last_key ssd 
-      setup ssd
-      last_key = @@ssd_db.transaction true do
-	@@ssd_db.roots
-      end
-      last_key.last
-    end
-
-    def keys ssd
-      setup ssd
-      @@ssd_db.transaction true do
-	@@ssd_db.roots
-      end
-    end
-
-    def key? ssd 
-      setup ssd
-      @@ssd_db.transaction true do
-	@@ssd_db.root? ssd 
-      end
-    end
-
-    alias exists? key?
-
-    def [] ssd 
-      setup ssd 
-      @@ssd_db.transaction true do
-	@@ssd_db[ssd]
-      end
-    end
-
-    def ssd ssd, default = nil
-      #TODO add raise if ssd.nil?
-      last_key = (last_key ssd) 
-      @@ssd_db.transaction true do
-	@@ssd_db.fetch last_key, default
-      end
-    end
-
-    #alias get ssd 
-    #alias find ssd 
-
-    def delete *ssds
-      @@ssd_db.transaction do
-	ssds.each do |ssd|
-	  @@ssd_db.delete ssd.to_sym
-	end
-	@@ssd_db.commit
-      end
-    end
-    alias remove delete
-
-    def count ssd
-      setup ssd 
-      $log.info("count")
-      return keys(ssd).count
-    end
-  end
-
 end

data/lib/ssd/class_methods.rb

@@ -0,0 +1,81 @@
+module SSD
+  module ClassMethods
+    def self.extended(base)
+      @@ssd_name  		= base.new.class.to_s.downcase
+      #FileUtils::mkdir_p 'DS'
+      #@@ssd_path 			= "DS/#{name}.pstore" 
+      #@@ssd_db 			= PStore.new @@ssd_path, true
+      #@@ssd_db.ultra_safe 	= true
+      #@@ssd_db.transaction(true) {}
+      #@@ssd_db
+    end 
+
+    def setup ssd 
+      @@ssd = ssd
+      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@@ssd}.ssd" 
+      @@ssd_db 			= PStore.new @@ssd_path, true
+      @@ssd_db.ultra_safe 	= true
+      @@ssd_db.transaction(true) {}
+      return @@ssd_db
+    end
+
+    def last_key ssd 
+      setup ssd
+      last_key = @@ssd_db.transaction true do
+	@@ssd_db.roots
+      end
+      last_key.last
+    end
+
+    def keys ssd
+      setup ssd
+      @@ssd_db.transaction true do
+	@@ssd_db.roots
+      end
+    end
+
+    def key? ssd 
+      setup ssd
+      @@ssd_db.transaction true do
+	@@ssd_db.root? ssd 
+      end
+    end
+
+    alias exists? key?
+
+    def [] ssd 
+      setup ssd 
+      @@ssd_db.transaction true do
+	@@ssd_db[ssd]
+      end
+    end
+
+    def ssd ssd, default = nil
+      #TODO add raise if ssd.nil?
+      last_key = (last_key ssd) 
+      @@ssd_db.transaction true do
+	@@ssd_db.fetch last_key, default
+      end
+    end
+
+    #alias get ssd 
+    #alias find ssd 
+
+    def delete *ssds
+      @@ssd_db.transaction do
+	ssds.each do |ssd|
+	  @@ssd_db.delete ssd.to_sym
+	end
+	@@ssd_db.commit
+      end
+    end
+    alias remove delete
+
+    def count ssd
+      setup ssd 
+      $log.info("count")
+      return keys(ssd).count
+    end
+  end
+end

data/lib/ssd/instance_methods.rb

@@ -0,0 +1,44 @@
+module SSD
+  module InstanceMethods
+
+    def self.included(base)
+      @@ssd_name  		= base.new.class.to_s.downcase
+    end
+
+    attr_accessor :ssd
+
+    def ssd= value
+      @ssd	= value
+      FileUtils::mkdir_p ".ssd/#{@@ssd_name}"
+      @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@ssd}.ssd" 
+      @@ssd_db 			= PStore.new @@ssd_path, true
+      @@ssd_db.ultra_safe 	= true
+      @@ssd_db.transaction(true) {}
+      return @@ssd_db
+    end
+
+    def transaction
+      @@ssd_db.transaction do
+	yield @@ssd_db
+	@@ssd_db.commit
+      end
+    end
+
+    def []= 
+      begin  
+	if !@ssd.nil? then 
+	  @@ssd_db.transaction do
+	    #todo should be somthing like??? timestamp instead of ssd as a key?? and use .last while reading
+	    @@ssd_db[Time.now.utc.to_s + "_" + Random.new_seed.to_s ] = self 
+	  end
+	else
+	  raise 'ssd key can not be nil. see more (documentation url)'  
+	end
+      end  
+    end
+
+    alias append! []= 
+      alias save! []= 
+      alias store! []= 
+  end
+end

data/lib/ssd/version.rb

@@ -1,3 +1,3 @@
 module SSD
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssd
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - zotherstupidguy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,10 @@ files:
 - bin/console
 - bin/repl.rb
 - bin/setup
-- lib/encrypt.rb
 - lib/ssd.rb
+- lib/ssd/class_methods.rb
+- lib/ssd/encrypt.rb
+- lib/ssd/instance_methods.rb
 - lib/ssd/version.rb
 - logo.png
 - ssd.gemspec
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: SSD is an append-only, file-based, immutable key-value store for Microservices