json_store 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b77ef3a7d0a66c2d77dd27125f3cdb2099f69835
-  data.tar.gz: d20ae02567719e9685dd1b85b7d600bdede5ef12
+  metadata.gz: 5aff085a13c5db3917ffb78d77faecd80f31e7f8
+  data.tar.gz: 462c05300901e67a8fc86a9fc0c798c460a28631
 SHA512:
-  metadata.gz: 508a228e2c509a08906fcd5db9c8425200efa314a8967cc3ca8969ec748c2ea0d68f432cc0d6be9a9a7ff5a37e7a3f39ae0ce7975b133c5df52b230c36e98c77
-  data.tar.gz: a2e576228c8ee7df9023324f1e55556fdafea6bd45444b14413a8f883fdb83d78786d937a063ec96a21b5a7262a2a0f35877d5ebb3cd954a32464c7df67e3969
+  metadata.gz: ae1b6f3ad3f482a6e0fb078bdf8fe689c5217ac83dd57dee780fff25d9df6234db5ba072b9b2ca7224c182b8c4333219993f15f04df7ae612cf8c6fa6c1256c7
+  data.tar.gz: 088095aa91ad6508563ba5f8342a42820c8320a71b383ce040691a6ce76b0b5ef4370b0c811d4cf34b2460269a047d0c93d0540bc41346cd4297d22ac9dcd8d1

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/kingsleyh/json_store.svg?branch=master)](https://travis-ci.org/kingsleyh/json_store)
 [![Gem Version](https://badge.fury.io/rb/json_store.svg)](http://badge.fury.io/rb/json_store)
-[![json_store Downloads](http://www.gemetric.me/images/json_store.gif)](https://rubygems.org/gems/json_store)
+[![json_store downloads](http://www.gemetric.me/images/json_store.gif?1)](https://rubygems.org/gems/json_store)
 
 
 Very simple key/value in memory database using json

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/json_store.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: json_store 0.1.3 ruby lib
+# stub: json_store 0.1.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "json_store"
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kingsley Hendrickse"]
-  s.date = "2014-06-23"
+  s.date = "2014-06-26"
   s.description = "A simple in memory key/value database using json that writes to file"
   s.email = "kingsleyhendrickse@me.com"
   s.extra_rdoc_files = [

data/lib/json_store.rb

@@ -2,50 +2,75 @@ require 'oj'
 require 'lock_method'
 require 'json_select'
 
+
+# JsonStore is a simple key/value database in which key/values are stored in json format
+# The basic concept is to pull data into an in memory map and then set or get data and push the data to file.
+# You can also merge in 2 different ways to decide how you want to use the data coming from file or the map
+# file locking is handled by the lock_method gem to prevent concurrent access when reading and writing
 class JsonStore
 
+  # Creates a new store at the path/filename provided to the constructor
+  # e.g. db = JsonStore.new('path/to/some/file.json')
   def initialize(db)
     @db = db
     @map = {}
     @json_opts = Oj.default_options
   end
 
+  # Sets data into the memory map by key/value
+  # e.g db.set('name','Kingsley')
   def set(key, value)
     @map[key] = value
   end
 
+  # Gets data from the memory map by key
+  # e.g. db.get('name')
   def get(key)
     @map[key]
   end
 
+  # Returns the whole memory map
   def all
     @map
   end
 
+  # Replaces the memory map with some json directly
+  def set_json(json)
+    @map = Oj.load(json)
+  end
+
+  # Sets the Oj json parser options by overriding defaults. See Oj josn parser docs for more details.
   def set_json_opts(options)
    @json_opts.merge!(options)
   end
 
+  # Lists the Oj json parser options that have been set
   def get_json_opts
     @json_opts
   end
 
+  #�Clears the memory map
   def clear
     @map = {}
   end
 
+  # Returns the whole memory map as a json string
   def all_as_json
     Oj.dump(@map,@json_opts)
   end
 
+  # Uses the ruby gem for JSONSelect to search basic json. (doesn't work on ruby objects stored as json by Oj :object mode)
+  # See the JSONSelect website / json_select ruby gem docs for more details
   def search(selector, kind=:matches)
     JSONSelect(selector).send(kind, @map)
   end
 
+  # Gets data from the memory map by key but as a json string
   def get_as_json(key)
     Oj.dump(@map[key],@json_opts)
   end
 
+  # Pulls data from file into the memory map - replacing the memory map with the data from file.
   def pull
     begin
       @map = read_data
@@ -55,6 +80,7 @@ class JsonStore
     end
   end
 
+  # Pushes the data in the memory map to file
   def push
     begin
       write_data
@@ -64,6 +90,11 @@ class JsonStore
     end
   end
 
+  # Merges the data in 2 ways
+  # 1. db.merge(:into_remote) is the default and will merge data from the memory map into data from file and assign the result to the memory map
+  # 2. db.merge(:into_local) will merge data from file into the memory map and assign the result to the memory map.
+  # into_remote will essentially load the memory map data into the file data thus overwriting the file data with the memory map data where the keys match
+  # into_local will essentially merge the file data into the memory map thus overwriting the memory map data with the file data where the keys match
   def merge(direction=:into_remote)
     begin
       @map = direction == :into_local ? @map.merge(read_data) : read_data.merge(@map)
@@ -73,6 +104,7 @@ class JsonStore
     end
   end
 
+  # Get the path to the datastore json file
   def db_path
     @db
   end
@@ -86,8 +118,12 @@ class JsonStore
   def read_data
     data = {}
     if File.exists?(@db)
-      f = File.read(@db)
-      data = Oj.load(f) unless f.empty?
+      f = File.open(@db)
+      begin
+      data = Oj.load(f)
+      rescue => e
+       puts "WARNING: #{e}"
+      end
     end
     data
   end

data/spec/json_store_spec.rb

@@ -132,6 +132,12 @@ describe JsonStore do
     expect(db.get_json_opts[:mode]).to eq(:compat)
   end
 
+  it 'should set the map directly with json' do
+    db = JsonStore.new('test')
+    db.set_json('{"name":{"first":"Kingsley"}}')
+    expect(db.get('name')).to eq({'first' =>'Kingsley'})
+  end
+
   private
 
   def create_new_db(path, content={name: 'Kingsley'})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_store
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Kingsley Hendrickse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj