sunstore 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59db6ff883ba656d379fd8324c7fc07b65d20e72
+  data.tar.gz: 5008ae2b94ac5e06ed9ced93942a76b0f0711910
+SHA512:
+  metadata.gz: 06ab62f5cdec528ce9ff2e458d812d4cc8fc4d6a1fec9c1a397f432cebea2c13765401ad743897d27a08d5dc703360e6edc13199d26587e41f5ae63f12af9873
+  data.tar.gz: 8d0a5b79632060ec385544b0092b21afd2325ceae9c1e85e5febed849b3a005eb0a733409d1adc301d89077bceb24953fe92545e8bb66dc2e0444b102d0dd10d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sunstore.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 etcetc
+
+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,64 @@
+# Sunstore
+
+SunStore is a Simple UNscalable storage mechanism for saving very simple key value pairs like preferences, config parameters, etc.  It's really just a wrapper for JSON or YAML.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sunstore'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunstore
+
+## Usage
+
+The simplest way is to say:
+
+```ruby
+Sustore.put("myKey",someSerializableObject)
+```
+
+and to later retrieve it as
+
+```ruby
+Sunstore.get("myKey")
+```
+
+## Configuration
+
+There are a couple of configuration parameters invoked via the config message *prior* to using:
+
+```ruby
+Sunstore.config(params)
+```
+
+where the params can be:
+
+    :format: :json or :yaml (default)
+    :basename: the basename for the storage file (sunstore by default)
+    :basedir: the default location to put the file (Rails/tmp if used in Rails context, else current working directory)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/etcetc/sunstore.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sunstore"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sunstore.rb

@@ -0,0 +1,30 @@
+require "sunstore/version"
+require "sunstore/store"
+
+module Sunstore
+
+  def self.config(params)
+    Store.instance.config(params)
+  end
+
+  def self.get(key)
+    Store.instance.get(key)
+  end
+
+  def self.put(key,value)
+    Store.instance.put(key,value)
+  end  
+
+  def self.delete(key)
+    Store.instance.delete(key)
+  end
+
+  def self.keys
+    Store.instance.keys
+  end
+
+  def self.clear
+    Store.instance.clear
+  end
+
+end

data/lib/sunstore/handler.rb

@@ -0,0 +1,15 @@
+
+module Sunstore::Handler
+
+  require_relative 'handlers/json'
+  require_relative 'handlers/yaml'
+
+  def self.for(protocol)
+    case protocol
+    when :yaml then YAML.new
+    when :json then JSON.new
+    else
+      raise "Only :yaml and :json currently supported"
+    end
+  end
+end

data/lib/sunstore/handlers/json.rb

@@ -0,0 +1,16 @@
+class Sunstore::Handler::JSON 
+
+  require 'JSON'
+
+  def serialize(h)
+      h.to_json
+  end
+
+  def deserialize(txt)
+    JSON.parse(txt)
+  end
+
+  def type
+    "json"
+  end
+end

data/lib/sunstore/handlers/yaml.rb

@@ -0,0 +1,15 @@
+class Sunstore::Handler::YAML
+  require 'Psych'
+
+  def serialize(h)
+      h.to_yaml
+  end
+
+  def deserialize(txt)
+    Psych.load(txt)
+  end
+
+  def type
+    "yaml"
+  end
+end

data/lib/sunstore/store.rb

@@ -0,0 +1,80 @@
+require_relative 'handler'
+
+class Sunstore::Store
+
+  @@instance = nil
+
+  attr_reader :format, :basename, :handler, :store_file
+
+  def self.instance
+    @@instance ||= new
+  end
+
+  def self.reset
+    @@instance = nil
+  end
+
+  def initialize
+    config  
+  end
+
+  def config(params={})
+    @format = [:yaml,:json,nil].include?(params[:format]) ? params[:format] || :yaml : raise("Only yaml and json currently supported")
+    @basename = params[:basename] || "sunstore"
+    @basedir = params[:basedir] ||  (defined?(Rails) ? Rails.root.to_s : Dir.getwd)
+    create_dir_structure(@basedir)
+    @handler = Sunstore::Handler.for(format)
+    @store_file = File.join(@basedir,"#{@basename}.#{@handler.type}")
+  end
+
+  def get(key)
+    data[key]
+  end
+
+  def put(key,value)
+    data[key] = value
+    save_data
+  end
+
+  def delete(key)
+    data.delete(key)
+    save_data
+  end
+
+  def keys
+    data.keys  
+  end
+
+  def clear
+    data.clear
+    save_data  
+  end
+
+  private
+
+  def save_data
+    File.open(store_file,"w") do |f|
+      f.write @handler.serialize(@data)
+    end
+  end
+
+  def data
+    unless @data 
+      if File.exist?(store_file)
+        @data = @handler.deserialize(File.read(store_file)) || {}
+      else
+        @data = {}
+      end
+    end
+    @data
+  end
+
+  def create_dir_structure(target_dir)
+    curdir = ''
+    target_dir.split('/').each do |dir|
+      curdir = File.join(curdir,dir)
+      Dir.exist?(curdir) or Dir.mkdir(curdir)
+    end
+  end
+
+end

data/lib/sunstore/version.rb

@@ -0,0 +1,3 @@
+module Sunstore
+  VERSION = "0.1.1"
+end

data/sunstore.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sunstore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sunstore"
+  spec.version       = Sunstore::VERSION
+  spec.authors       = ["etcetc"]
+  spec.email         = ["ff@onebeat.com"]
+
+  spec.summary       = %q{Very simple, unscalable model for saving key-value stores, for exmaple, preferences}
+  spec.description   = %q{Sometimes you just want to quickly save something and retrieve it. This is a lightweight gem for doing so using YAML or JSON serialization}
+  spec.homepage      = "https://github.com/etcetc/sunstore.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+end

data/sunstore.json

@@ -0,0 +1 @@
+{"x":{"x":10,"y":"test"},"y":["test",22.4,{"x":[1,2,3],"y":{"f":20,"z":"test"}}]}

data/sunstore.yaml

@@ -0,0 +1,14 @@
+---
+x:
+  :x: 10
+  :y: test
+y:
+- test
+- 22.4
+- :x:
+  - 1
+  - 2
+  - 3
+  :y:
+    :f: 20
+    :z: test

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sunstore
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- etcetc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sometimes you just want to quickly save something and retrieve it. This
+  is a lightweight gem for doing so using YAML or JSON serialization
+email:
+- ff@onebeat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sunstore.rb
+- lib/sunstore/handler.rb
+- lib/sunstore/handlers/json.rb
+- lib/sunstore/handlers/yaml.rb
+- lib/sunstore/store.rb
+- lib/sunstore/version.rb
+- sunstore.gemspec
+- sunstore.json
+- sunstore.yaml
+homepage: https://github.com/etcetc/sunstore.git
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Very simple, unscalable model for saving key-value stores, for exmaple, preferences
+test_files: []