ssd 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f412d9d7275b088771b8f1d3e27c5a5a491e9578
-  data.tar.gz: 51fbff3062486cc2afebb78809b689432a815d47
+  metadata.gz: e37a7abd30a7a3d3909b5349d64c563b37bff37c
+  data.tar.gz: c48ad95d301d47ddd0ab30cfeda48df3e3280d9a
 SHA512:
-  metadata.gz: daf9d2a958b82531af90c845b385e4b9b820e9e8351e07becce4d1dc7ca733344d418d575ad9b6979cda70caf36a0a9229c3b62e1fe7bcec491e36fdce134346
-  data.tar.gz: b9ca75641c32bafe80bce22d1a2c0660525463d5fa6982c0ef7c83d8916fc90b1a298048d224c70ad2931d5214c7f97609febff068934655ae5bb5f1aa7ffa92
+  metadata.gz: 0e254e2c2d4414f59984e08b05c01a43960b62d57f8605a8fccd49d7327153fa3633c63a733d1d293c10768645a413e4b9f55c4a8bddf189f5336803a962d4ea
+  data.tar.gz: 65f12fdc3cee272e634f3f28afc6985e9eeda20b61b606b909715d1d4fdd64d32b31958188e0dff727dd2a3a777b7597fbfeff805e4e685716320b8a32ab7e5d

data/.gitignore

@@ -4,3 +4,4 @@ SSD
 *.gem
 .ssd
 pkg
+*.ssd

data/README.md

@@ -31,27 +31,61 @@ Usage
 gem install ssd
 ```
 
+```ruby
+# Simple Usage
+  # writes to the store
+  SSD.write("company_api/microservice_name/", "special_id", "this is a big value super funny")
+
+  # returns the last value of the append-only store
+  SSD.read("company_api/microservice_name/", "special_id")
+
+  # Dumps all the store 
+  SSD.dump("company_api/microservice_name/", "special_id")
+
+end
+```
+Further more you can use ssd console commands to view the contents in a readable manner, 
+SSD can use Marshal for performance(the default is yaml) but the ssd commands views it in yaml for readability
+```bash
+ssd view ./ssd/company_api/microservice_name/special_id
+```
+
 ```ruby 
-require 'sinatra'
+# Entity Usage
+require 'sinatra/base'
 require 'ssd'
 
 module MyApp
- class User
-  include SSD
-  attr_accessor :id # ssd key
-  
-  def initialize id
-   @ssd = id                                   # Setting :ssd 
+  class User
+    include SSD::Entity
+    attr_accessor :id, :name, :bio
+    def initialize
+    end
+  end
+
+  class API < Sinatra::Base
+    get '/' do 
+      #####################  Writing  #####################  
+      @user 		= MyApp::User.new
+      @user.id	 	= "somekind_of_id_like_username_or_email"       
+
+      # Set the ssd key of the object 
+      @user.ssd 	= @user.id
+
+      # Do what you wish with your object 
+      @user.name 	= "Makki Omura"
+      @user.bio	 	= "a charming girl!"
+
+      # If you are ready to store your object to disk; Do an `append!` and viola! DONE 
+      @user.append!              
+
+      #####################  READING  #####################  
+      # If you want to get your object back from disk; Use Klass.ssd(:ssd)
+      result = MyApp::User.ssd("somekind_of_id_like_username_or_email")           
+      result.name
+    end
+    run!
   end
- end
-
- class API < Sinatra::Base
-   get '/' do 
-     @user = User.new("generated_id")		# Initialize an object form any Klass that `include SSD` and assign it a :ssd key 
-     @user.append! 				# Do an `append!` operation and viola! DONE 
-     @user = User.ssd("generated_id")  			# Afterwards read it via Klass.ssd(:ssd)
-   end
- end
 end
 ```
 

data/lib/ssd.rb

@@ -3,15 +3,78 @@ require 'logger'
 require 'securerandom'
 require 'pstore'
 require 'digest'
+require 'yaml/store'
 
 require_relative "./ssd/version"
 require_relative "./ssd/internals"
 $log = Logger.new(STDOUT)
 
 module SSD 
+  module Entity
+    def self.included(base)
+      base.send :include, SSD::Internals::Entity::InstanceMethods
+      base.extend SSD::Internals::Entity::ClassMethods
+    end
+  end
+
+  class Store
+    
+    def initialize path, key, value=nil
+      @path = path
+      @key = key
+      @value = value
+      FileUtils::mkdir_p ".ssd/#{@path}"
+      @ssd_path 		= ".ssd/#{@path}/#{@key}.ssd" 
+
+      #@ssd_db 			= PStore.new @ssd_path, true
+      @ssd_db 			= YAML::Store.new @ssd_path, true
+
+      @ssd_db.ultra_safe 	= true
+      #@ssd_db.transaction(true) {}
+    end
+
+    def write
+      p "writing"
+      @ssd_db.transaction do
+	@ssd_db[Time.now.utc.to_s + "_" + @key.to_s ] = @value 
+	#@ssd_db[@key.to_s] = @value 
+      end
+      @ssd_db
+    end
+
+    def dump
+      p "dump all"
+      # true sets it to be read-only transaction
+      @ssd_db.transaction true do
+	@ssd_db[@key.to_s]
+      end
+      @ssd_db
+    end
+
+    def read
+      #setup ssd
+      @ssd_db.transaction true do
+	@ssd_db[@ssd_db.roots.last]
+      end
+    end
+
+  end
+
+
+
+  def self.write path, key, value
+    ssd_db = Store.new path, key, value
+    ssd_db.write
+  end
+
+  def self.read path, key 
+    ssd_db = Store.new path, key
+    ssd_db.read
+  end
 
-  def self.included(base)
-    base.send :include, SSD::Internals::InstanceMethods
-    base.extend SSD::Internals::ClassMethods
+  def self.dump path, key 
+    ssd_db = Store.new path, key
+    ssd_db.dump
   end
+
 end

data/lib/ssd/class_methods.rb

@@ -1,82 +1,84 @@
 module SSD
   module Internals
-    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 
+    module Entity
+      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 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
+	def last_key ssd 
+	  setup ssd
+	  last_key = @@ssd_db.transaction true do
+	    @@ssd_db.roots
+	  end
+	  last_key.last
 	end
-	last_key.last
-      end
 
-      def keys ssd
-	setup ssd
-	@@ssd_db.transaction true do
-	  @@ssd_db.roots
+	def keys ssd
+	  setup ssd
+	  @@ssd_db.transaction true do
+	    @@ssd_db.roots
+	  end
 	end
-      end
 
-      def key? ssd 
-	setup ssd
-	@@ssd_db.transaction true do
-	  @@ssd_db.root? ssd 
+	def key? ssd 
+	  setup ssd
+	  @@ssd_db.transaction true do
+	    @@ssd_db.root? ssd 
+	  end
 	end
-      end
 
-      alias exists? key?
+	alias exists? key?
 
-      def [] ssd 
-	setup ssd 
-	@@ssd_db.transaction true do
-	  @@ssd_db[ssd]
+	def [] ssd 
+	  setup ssd 
+	  @@ssd_db.transaction true do
+	    @@ssd_db[ssd]
+	  end
 	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
+	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
-      end
 
-      #alias get ssd 
-      #alias find ssd 
+	#alias get ssd 
+	#alias find ssd 
 
-      def delete *ssds
-	@@ssd_db.transaction do
-	  ssds.each do |ssd|
-	    @@ssd_db.delete ssd.to_sym
+	def delete *ssds
+	  @@ssd_db.transaction do
+	    ssds.each do |ssd|
+	      @@ssd_db.delete ssd.to_sym
+	    end
+	    @@ssd_db.commit
 	  end
-	  @@ssd_db.commit
 	end
-      end
-      alias remove delete
+	alias remove delete
 
-      def count ssd
-	setup ssd 
-	$log.info("count")
-	return keys(ssd).count
+	def count ssd
+	  setup ssd 
+	  $log.info("count")
+	  return keys(ssd).count
+	end
       end
     end
   end

data/lib/ssd/instance_methods.rb

@@ -1,48 +1,50 @@
 module SSD
   module Internals
-    module InstanceMethods
+    module Entity
+      module InstanceMethods
 
-      def self.included(base)
-	@@ssd_name  		= base.new.class.to_s.downcase
-      end
+	def self.included(base)
+	  @@ssd_name  		= base.new.class.to_s.downcase
+	end
 
-      attr_accessor :ssd
+	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 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
+	def transaction
+	  @@ssd_db.transaction do
+	    yield @@ssd_db
+	    @@ssd_db.commit
+	  end
 	end
-      end
 
-      def []= 
-	@@ssd_path 		= ".ssd/#{@@ssd_name}/#{@ssd}.ssd" 
-	@@ssd_db 		= PStore.new @@ssd_path, true
-	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 
+	def []= 
+	  @@ssd_path 		= ".ssd/#{@@ssd_name}/#{@ssd}.ssd" 
+	  @@ssd_db 		= PStore.new @@ssd_path, true
+	  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
-	  else
-	    raise 'ssd key can not be nil. see more (documentation url)'  
-	  end
-	end  
-      end
+	  end  
+	end
 
-      alias append! []= 
-	alias save! []= 
-	alias store! []= 
+	alias append! []= 
+	  alias save! []= 
+	  alias store! []= 
+      end
     end
   end
 end

data/lib/ssd/version.rb

@@ -1,3 +1,3 @@
 module SSD
-  VERSION = "0.1.7"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssd
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - zotherstupidguy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler