json_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49e14dd153040a235c67133f3df7faeb1357ae9f
+  data.tar.gz: b7f1b9de726f8f9da032f01260ee3f4365f94635
+SHA512:
+  metadata.gz: a85d3a673bbce87fc59532f65895852e76afe1c83c899a4777a72223ceb9ec9dbb072816b2f3c95cde2090a1110ba090751f490f1c1418fc5338c5f904ebdf33
+  data.tar.gz: 3246102a9104e11127f467ee7a542789c9e6812c64527827a9b700469d9e9b00da135243a329f0daeca2a40650a7eca2c0fd00fba1db138f43a45d849e008f1f

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'oj'
+gem 'lock_method'
+gem 'json_select'
+
+group :development do
+  gem 'rspec','~> 3.0.0.rc1'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    cache (0.4.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.0.0)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    json_select (0.1.4)
+      treetop
+    jwt (1.0.0)
+    lock_method (0.5.5)
+      activesupport
+      cache (>= 0.2.1)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    oj (2.9.6)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    thread_safe (0.3.4)
+    treetop (1.5.3)
+      polyglot (~> 0.3)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  json_select
+  lock_method
+  oj
+  rspec (~> 3.0.0.rc1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kingsley Hendrickse
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# json_store
+
+Very simple key/value in memory database using json
+
+## Install
+
+```ruby
+gem install json_store
+```
+
+## Usage
+
+```ruby
+require 'json_store'
+
+db = JsonStore.new('names.db')
+db.pull
+db.set(:name,'Kingsley')
+p db.get(:name)
+db.merge
+db.push
+```
+
+There are only a handful of commands:
+
+* pull
+* push
+* merge
+* set
+* get
+* get_as_json
+* search
+* all
+* all_as_json
+
+The basic concept is that you create new db with the JsonStore.new and if the db is already a valid json file you can do pull to populate the in memory map. If no file exists then
+one will be created.
+
+* When you want to add to the db - you use set(key,value)
+* When you want to push your data to file there are a couple of options - push or merge then push
+
+## Merge and Push
+
+calling push will replace the db on file with the current content of the local map. Calling merge will merge the file db with the current in memory map after which you can call push
+to store the data. If you are happy to replace the db file with the content of your local map just use push. If you think there might be changes to the db file that you want before
+overwriting the file - then call merge to get them and then ovewrite with push.
+
+Merge has 2 possibilities - :into_local and :into_remote - the default is :into_remote  e.g.
+
+```ruby
+ db.merge(:into_local)
+```
+
+* :into_local will read the file content and then merge it into the local map - overwriting local changes with ones from file where the key is the same
+* :into_remote will read the local map into the data from file - thus keeping any local changes and overwriting file items where the key is the same
+
+## Get and Search
+
+There are 2 ways to find data:
+
+* Get
+* Search
+
+Get just finds a value by key e.g.
+
+```ruby
+   db.set(:name,'Kingsley')
+   db.get(:name) # Kingsley
+```
+
+Search uses the json select gem (https://github.com/fd/json_select) and (http://jsonselect.org/#overview) to provide advanced searching capability.
+
+Read the documentation in the links above for a better idea how to use it - here is a simple example:
+
+```ruby
+  db.set(:names,[{id:1,name:'Kingsley'},{id:2,name:'Kostas'}])
+  db.search('.names .name') # ['Kingsley','Kostas']
+  db.search('.names .name',:match) # "Kingsley"
+  db.search('.names object:last-child .name',:match) # "Kostas"
+```
+
+Search takes 2 parameters:  the selector and a match kind - which is set to :matches by default. The options are:
+
+* :matches - returns an array of data - is the default
+* :match - returns only the first match
+* :test - returns true or false if there is a match
+
+
+## Contributing to json_store
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Kingsley Hendrickse. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "json_store"
+  gem.homepage = "http://github.com/kingsleyh/json_store"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple in memory key/value database using json}
+  gem.description = %Q{A simple in memory key/value database using json that writes to file}
+  gem.email = "kingsleyhendrickse@me.com"
+  gem.authors = ["Kingsley Hendrickse"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/json_store.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: json_store 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "json_store"
+  s.version = "0.1.0"
+
+  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-19"
+  s.description = "A simple in memory key/value database using json that writes to file"
+  s.email = "kingsleyhendrickse@me.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "json_store.gemspec",
+    "lib/json_store.rb"
+  ]
+  s.homepage = "http://github.com/kingsleyh/json_store"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "A simple in memory key/value database using json"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oj>, [">= 0"])
+      s.add_runtime_dependency(%q<lock_method>, [">= 0"])
+      s.add_runtime_dependency(%q<json_select>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0.0.rc1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<oj>, [">= 0"])
+      s.add_dependency(%q<lock_method>, [">= 0"])
+      s.add_dependency(%q<json_select>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3.0.0.rc1"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<oj>, [">= 0"])
+    s.add_dependency(%q<lock_method>, [">= 0"])
+    s.add_dependency(%q<json_select>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0.0.rc1"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/lib/json_store.rb

@@ -0,0 +1,90 @@
+require 'oj'
+require 'lock_method'
+require 'json_select'
+
+class JsonStore
+
+  def initialize(db)
+    @db = db
+    @map = {}
+  end
+
+  def set(key, value)
+    @map[key] = value
+  end
+
+  def get(key)
+    @map[key]
+  end
+
+  def all
+    @map
+  end
+
+  def all_as_json
+    Oj.dump(@map)
+  end
+
+  def search(selector,kind=:matches)
+    JSONSelect(selector).send(kind,@map)
+  end
+
+  def get_as_json(key)
+    Oj.dump(@map[key])
+  end
+
+  def pull
+    begin
+      @map = read
+    rescue LockMethod::Locked
+      sleep 0.5
+      pull
+    end
+  end
+
+  def push
+    begin
+      write
+    rescue LockMethod::Locked
+      sleep 0.5
+      push
+    end
+  end
+
+  def merge(direction=:into_remote)
+    begin
+      direction == :into_local ? @map.merge!(read) : read.merge!(@map)
+    rescue LockMethod::Locked
+      sleep 0.5
+      merge(direction)
+    end
+  end
+
+  def as_lock
+    'json_store'
+  end
+
+  private
+
+  def read
+    data = {}
+    if File.exists?(@db)
+      f = File.read(@db)
+      data = Oj.load(f) unless f.empty?
+    end
+    data
+  end
+
+  lock_method :read
+
+  def write
+    File.open(@db, 'w') { |f| f.write(Oj.dump(@map)) }
+  end
+
+  lock_method :write
+
+  def keep_trying
+
+  end
+
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: json_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kingsley Hendrickse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lock_method
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_select
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: A simple in memory key/value database using json that writes to file
+email: kingsleyhendrickse@me.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- json_store.gemspec
+- lib/json_store.rb
+homepage: http://github.com/kingsleyh/json_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple in memory key/value database using json
+test_files: []